Get Azure OpenAi deployments in API

Maya Shauli 66 Microsoft Employee

Hey
How can I retrieve the list of the deployments from my azure open ai instance?

In worked with old API and seems not supported anymore.
Last working version: 2023-03-15-preview
curl "https://XXXXX.openai.azure.com/openai/deployments?api-version=2023-03-15-preview" -H "api-key: XXXXXXXXXXXXXXXXXXX"

Can you assist with the new way to do it?

AshokPeddakotla-MSFT 34,611 Reputation points

2023-09-19T13:29:59.8333333+00:00
Maya Shauli Greetings!

Can you share more details regarding the issue? Is it working with the new version? These are the
Supported versions

2022-12-01 Swagger spec

2023-03-15-preview Swagger spec

2023-05-15 Swagger spec

2023-06-01-preview Swagger spec

2023-07-01-preview Swagger spec

2023-08-01-preview Swagger spec
AshokPeddakotla-MSFT 34,611 Reputation points

2023-09-25T14:01:49.1+00:00

Maya Shauli Did you get a chance to see my response?
Do let me know if you need further help.
Venkatesan, Sangeetha 0 Reputation points

2023-12-17T04:18:58.9566667+00:00

How can I list all model deployments under the resource group in Azure Open AI service
Szabi Kisded 45 Reputation points

2024-02-02T17:18:33.2833333+00:00

Indeed, this issue is very concerning, as the 2023-03-15-preview API version will shut down in April 2024. Besides of this API version, currently there is no clear way on listing deployments. Also, the answer suggested by Travis is not optimal, as users will not know their subscription ID. All they know is API key.

I suggest this issue is raised further.
Dmitry Tretyakov 0 Reputation points

2024-06-03T11:53:25.1266667+00:00
Our use case is the following: Customer creates OpenAI models deployments in their account and then configures the following in the product configuration:

Service URL: https://XXXXX.openai.azure.com

API Key

To get access to completion models we need to receive model deployment name, which was working in "/openai/deployments" API v2023-03-15-preview, but is not available in the recent versions.

1 answer

Travis Wilson 115 Reputation points Microsoft Employee

2023-09-26T00:04:10.72+00:00
The standalone data plane API was retired in favor of the centralized management plane API for deployments.

https://learn.microsoft.com/en-us/rest/api/cognitiveservices/accountmanagement/deployments/list?tabs=HTTP

The above is consistent with what you can observe while monitoring Azure AI Studio request traffic and viewing deployments there -- the list is populated using an HTTP GET following:

https://management.azure.com/subscriptions/...subscription-id-here.../resourceGroups/...resource-group-here.../providers/Microsoft.CognitiveServices/accounts/...resource-here.../deployments?api-version=2023-05-01
Please sign in to rate this answer.

1 person found this answer helpful.
David Dellsperger 55 Reputation points

2024-01-11T20:07:21.03+00:00

So how, using the resource group we're already in would a user be expected to know the subscription-id in order to only provide an api key from the resource itself in order to know what models that api key has access to? The reason why this is a negative move is that you can't know what deployments are available to a given resource with the credentials just in that resource anymore, and that's how most users are likely to want to use those deployments.

Chrissy LeMaire 26 Reputation points MVP

2024-07-10T01:49:16.7633333+00:00

agreed @David Dellsperger

this new way is very user-unfriendly as requires more from the user than previous methods. we need a way to list deployments to provide easy-to-use tools for our end-users. this endpoint is required for magic, please give it back.

David Dellsperger 55 Reputation points

2024-07-10T02:13:09.6933333+00:00

This has come up again for us because the new models (gpt-4o for instance) are not supported in the old deployments api from 2023 (which was the last GA version that had the deployments endpoint). It would be great if we could get this old API back, or have it added back in for better discoverability. If you're not requiring the resource groups, subscription ids, etc. to access a deployment, why are we requiring it for listing deployments?
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

Get Azure OpenAi deployments in API

1 answer

Your answer