Feature Request: Support for Elasticsearch CloudId Authentication

[MikeAlhayek]

Library name

Azure.AI.OpenAI

Please describe the feature.

When using the Azure OpenAI library with search on custom data, it’s currently possible to specify Elasticsearch as a data source. At the moment, the only supported authentication types are key_and_key_id and encoded_api_key.

However, a commonly used method for authenticating with Elasticsearch—especially when the service is hosted in the cloud—is via a combination of CloudId, username, and password.

---

Request:
Please add support for specifying the following authentication parameters when connecting to Elasticsearch:

• CloudId
• username
• password

This authentication method is widely used in Elastic Cloud deployments and would significantly improve compatibility and ease of use for many cloud-hosted Elasticsearch users.

---

References:

• CloudId parsing and usage in the Elastic .NET client:
  🔗 https://github.com/elastic/elastic-transport-net/blob/1242db8cdeda49e8d982b70e714815ccf29fb79f/src/Elastic.Transport/Components/NodePool/CloudNodePool.cs#L39
• How CloudId is used to construct the URL:
  🔗 https://github.com/elastic/elastic-transport-net/blob/main/src/Elastic.Transport/Components/NodePool/CloudNodePool.cs#L64-L93

---

Thank you for considering this enhancement! Let me know if you need additional context or implementation suggestions.

[github-actions]

Hi @MikeAlhayek, I'm an AI Support assistant here to help with your issue. While the Azure SDK team reviews your request, I wanted to provide some possible tips and documentation that might help you in the meantime.

• Currently, the Azure.AI.OpenAI package supports Elasticsearch authentication using only key-based methods (key_and_key_id and api_key).
• For unified authentication patterns across our SDKs, please review the Microsoft Azure Identity documentation, which outlines a broad range of authentication scenarios: Microsoft Azure Identity documentation for .NET.
• As an example of evolving authentication support, you can refer to the recent changes noted in the Azure.ResourceManager.Elastic CHANGELOG, which demonstrates how authentication mechanisms are being standardized across our SDK offerings.
• We appreciate the request and are evaluating enhancements in our unified authentication approach that may eventually include additional methods for data sources like Elasticsearch.

The Azure SDK team will respond to your issue shortly. I hope these suggestions are helpful in the meantime. If this comment helped you, please give it a 👍. If the suggestion was not helpful or incorrect, please give it a 👎. Your feedback helps us improve!

[github-actions]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @jpalvarezl @ralph-msft @trrwilson.