Connection - List Deployments

Service:: Machine Learning

API Version:: 2025-07-01-preview

Get all the deployments under the Azure OpenAI connection.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/deployments?api-version=2025-07-01-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}/deployments?api-version=2025-07-01-preview&proxy-api-version={proxy-api-version}

URI Parameters

Name	In	Required	Type	Description
connectionName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Friendly name of the workspace connection
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Azure Machine Learning Workspace Name
api-version	query	True	string minLength: 1	The API version to use for this operation.
proxy-api-version	query		string	Api version used by proxy call

Responses

Name	Type	Description
200 OK	EndpointDeploymentResourcePropertiesBasicResourceArmPaginatedResult	The request was successful; the request was well-formed and received properly.
Other Status Codes	ErrorResponse	Error

Security

azure_auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List Azure OpenAI Connection Deployments

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/connections/testConnection/deployments?api-version=2025-07-01-preview

Sample response

Status code:: 200

{
  "value": [
    {
      "systemData": {
        "createdBy": "00000000-1111-2222-3333-444444444444",
        "createdByType": "Application",
        "lastModifiedBy": "00000000-1111-2222-3333-444444444444",
        "lastModifiedByType": "Application"
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/connections/testConnection/deployments/text-davinci-003",
      "name": "text-davinci-003",
      "type": "Microsoft.MachineLearningServices/workspaces/connections/deployments",
      "properties": {
        "type": "Azure.OpenAI",
        "model": {
          "format": "OpenAI",
          "name": "text-davinci-003",
          "version": "1",
          "source": null
        },
        "versionUpgradeOption": "OnceNewDefaultVersionAvailable",
        "raiPolicyName": "Microsoft.Default",
        "provisioningState": "Succeeded"
      }
    }
  ]
}

Definitions

Name	Description
CognitiveServicesSku
ContentSafetyEndpointDeploymentResourceProperties
createdByType	The type of identity that created the resource.
DefaultResourceProvisioningState
DeploymentModelVersionUpgradeOption	Deployment model version upgrade option.
EndpointComputeType
EndpointDeploymentModel
EndpointDeploymentResourcePropertiesBasicResource
EndpointDeploymentResourcePropertiesBasicResourceArmPaginatedResult
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedOnlineEndpointDeploymentResourceProperties
OpenAIEndpointDeploymentResourceProperties
SpeechEndpointDeploymentResourceProperties
systemData	Metadata pertaining to creation and last modification of the resource.

CognitiveServicesSku

Object

Name	Type	Description
capacity	integer (int32)
family	string
name	string
size	string
tier	string

ContentSafetyEndpointDeploymentResourceProperties

Object

Name	Type	Description
failureReason	string	The failure reason if the creation failed.
model	EndpointDeploymentModel	Model used for the endpoint deployment.
provisioningState	DefaultResourceProvisioningState	Read-only provision state status property.
raiPolicyName	string	The name of RAI policy.
sku	CognitiveServicesSku
type	string: Azure.ContentSafety minLength: 1 pattern: [a-zA-Z0-9_]	Kind of the deployment.
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Deployment model version upgrade option.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DefaultResourceProvisioningState

Enumeration

Value	Description
NotStarted
Failed
Creating
Updating
Succeeded
Deleting
Accepted
Canceled
Scaling
Disabled

DeploymentModelVersionUpgradeOption

Enumeration

Deployment model version upgrade option.

Value	Description
OnceNewDefaultVersionAvailable
OnceCurrentVersionExpired
NoAutoUpgrade

EndpointComputeType

Enumeration

Value	Description
Managed
Kubernetes
AzureMLCompute

EndpointDeploymentModel

Object

Name	Type	Description
format	string	Model format
name	string	Model name.
source	string	Optional. Deployment model source ARM resource ID.
version	string	Model version.

EndpointDeploymentResourcePropertiesBasicResource

Object

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	EndpointDeploymentResourceProperties: ContentSafetyEndpointDeploymentResourceProperties ManagedOnlineEndpointDeploymentResourceProperties OpenAIEndpointDeploymentResourceProperties SpeechEndpointDeploymentResourceProperties
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

EndpointDeploymentResourcePropertiesBasicResourceArmPaginatedResult

Object

Name	Type	Description
nextLink	string
value	EndpointDeploymentResourcePropertiesBasicResource[]

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ManagedOnlineEndpointDeploymentResourceProperties

Object

Name	Type	Description
endpointComputeType	EndpointComputeType
failureReason	string	The failure reason if the creation failed.
model	string
provisioningState	DefaultResourceProvisioningState	Read-only provision state status property.
type	string: managedOnlineEndpoint minLength: 1 pattern: [a-zA-Z0-9_]	Kind of the deployment.

OpenAIEndpointDeploymentResourceProperties

Object

Name	Type	Description
failureReason	string	The failure reason if the creation failed.
model	EndpointDeploymentModel	Model used for the endpoint deployment.
provisioningState	DefaultResourceProvisioningState	Read-only provision state status property.
raiPolicyName	string	The name of RAI policy.
sku	CognitiveServicesSku
type	string: Azure.OpenAI minLength: 1 pattern: [a-zA-Z0-9_]	Kind of the deployment.
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Deployment model version upgrade option.

SpeechEndpointDeploymentResourceProperties

Object

Name	Type	Description
failureReason	string	The failure reason if the creation failed.
model	EndpointDeploymentModel	Model used for the endpoint deployment.
provisioningState	DefaultResourceProvisioningState	Read-only provision state status property.
raiPolicyName	string	The name of RAI policy.
sku	CognitiveServicesSku
type	string: Azure.Speech minLength: 1 pattern: [a-zA-Z0-9_]	Kind of the deployment.
versionUpgradeOption	DeploymentModelVersionUpgradeOption	Deployment model version upgrade option.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Share via

Connection - List Deployments

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List Azure OpenAI Connection Deployments

Sample request

Sample response

Definitions

CognitiveServicesSku

ContentSafetyEndpointDeploymentResourceProperties

createdByType

DefaultResourceProvisioningState

DeploymentModelVersionUpgradeOption

EndpointComputeType

EndpointDeploymentModel

EndpointDeploymentResourcePropertiesBasicResource

EndpointDeploymentResourcePropertiesBasicResourceArmPaginatedResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedOnlineEndpointDeploymentResourceProperties

OpenAIEndpointDeploymentResourceProperties

SpeechEndpointDeploymentResourceProperties

systemData