Endpoint - List

Service:

Machine Learning

API Version:

2025-07-01-preview

List All the endpoints under this workspace

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/endpoints?api-version=2025-07-01-preview&endpointType={endpointType}&includeOnlineEndpoints={includeOnlineEndpoints}&includeServerlessEndpoints={includeServerlessEndpoints}&includeConnections={includeConnections}&$skip={$skip}&$expand={$expand}

URI Parameters

Name	In	Required	Type	Description
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.
$expand	query		string	Whether the endpoint resource will be expand to include deployment information, e.g. $expand=deployments
$skip	query		string	Continuation token for pagination.
endpointType	query		endpointType	Endpoint type filter
includeConnections	query		boolean
includeOnlineEndpoints	query		boolean
includeServerlessEndpoints	query		boolean

Responses

Name	Type	Description
200 OK	EndpointResourcePropertiesBasicResourceArmPaginatedResult	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 Endpoint

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/aml-workspace-name/endpoints?api-version=2025-07-01-preview&endpointType=Azure.OpenAI&$skip=skip_string

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/aml-workspace-name/endpoints/Azure.OpenAI",
      "name": "Azure.OpenAI",
      "type": "Microsoft.MachineLearningServices/workspaces/endpoints",
      "properties": {
        "endpointType": "Azure.OpenAI",
        "name": "Azure.OpenAI",
        "associatedResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveService/account/account-1",
        "endpointUri": "https://www.contoso.com/",
        "provisioningState": "Succeeded",
        "failureReason": "some_string"
      },
      "systemData": {
        "createdAt": "2020-01-01T00:00:00Z",
        "createdBy": "some_string",
        "createdByType": "ManagedIdentity",
        "lastModifiedAt": "2020-01-01T00:00:00Z",
        "lastModifiedBy": "some_string",
        "lastModifiedByType": "User"
      }
    }
  ],
  "nextLink": "some_string"
}

Definitions

Name	Description
CognitiveServicesSku
ContentSafetyEndpointDeploymentResourceProperties
ContentSafetyEndpointResourceProperties
ContentSafetyStatus
createdByType	The type of identity that created the resource.
DefaultResourceProvisioningState
DeploymentModelVersionUpgradeOption	Deployment model version upgrade option.
EndpointAuthMode
EndpointComputeType
EndpointDeploymentModel
EndpointDeploymentResourcePropertiesBasicResource
EndpointResourcePropertiesBasicResource
EndpointResourcePropertiesBasicResourceArmPaginatedResult
endpointType	Endpoint type filter
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedOnlineEndpointDeploymentResourceProperties
ManagedOnlineEndpointResourceProperties
OpenAIEndpointDeploymentResourceProperties
OpenAIEndpointResourceProperties
ServerlessEndpointCapacityReservation
ServerlessEndpointContentSafety
ServerlessEndpointInferenceEndpoint
ServerlessEndpointModelSettings
ServerlessEndpointResourceProperties
ServerlessEndpointState
ServerlessInferenceEndpointAuthMode
ServerlessOffer
SpeechEndpointDeploymentResourceProperties
SpeechEndpointResourceProperties
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.

ContentSafetyEndpointResourceProperties

Object

Name	Type	Description
associatedResourceId	string (arm-id)	Byo resource id for creating the built-in model service endpoints.
deployments	EndpointDeploymentResourcePropertiesBasicResource[]	Deployments info.
endpointType	string: Azure.ContentSafety	Type of the endpoint.
endpointUri	string (url)	Uri of the endpoint.
failureReason	string	The failure reason if the creation failed.
location	string	Location of the endpoint. Since input dto and when parse endpoint resource share the same contract this Location field is just for parse the endpoint resource info we won't let customer specify the endpoint resource location since we will create it the same location as workspace
name	string	Name of the endpoint.
provisioningState	DefaultResourceProvisioningState	Read-only provision state status property.
shouldCreateAiServicesEndpoint	boolean	Whether the proxy (non-byo) endpoint is a regular endpoint or a OneKeyV2 AI services account endpoint.

ContentSafetyStatus

Enumeration

Value	Description
Enabled
Disabled

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

EndpointAuthMode

Enumeration

Value	Description
AMLToken
Key
AADToken

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"

EndpointResourcePropertiesBasicResource

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	EndpointResourceProperties: ContentSafetyEndpointResourceProperties ManagedOnlineEndpointResourceProperties OpenAIEndpointResourceProperties ServerlessEndpointResourceProperties SpeechEndpointResourceProperties
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"

EndpointResourcePropertiesBasicResourceArmPaginatedResult

Object

Name	Type	Description
nextLink	string
value	EndpointResourcePropertiesBasicResource[]

endpointType

Enumeration

Endpoint type filter

Value	Description
Azure.OpenAI
Azure.Speech
Azure.ContentSafety
Azure.Llama
managedOnlineEndpoint

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.

ManagedOnlineEndpointResourceProperties

Object

Name	Type	Description
associatedResourceId	string (arm-id)	Byo resource id for creating the built-in model service endpoints.
authMode	EndpointAuthMode
compute	string
deployments	EndpointDeploymentResourcePropertiesBasicResource[]	Deployments info.
description	string
endpointType	string: managedOnlineEndpoint	Type of the endpoint.
endpointUri	string (url)	Uri of the endpoint.
failureReason	string	The failure reason if the creation failed.
location	string	Location of the endpoint. Since input dto and when parse endpoint resource share the same contract this Location field is just for parse the endpoint resource info we won't let customer specify the endpoint resource location since we will create it the same location as workspace
mirrorTraffic	object
name	string	Name of the endpoint.
provisioningState	DefaultResourceProvisioningState	Read-only provision state status property.
scoringUri	string (uri)
shouldCreateAiServicesEndpoint	boolean	Whether the proxy (non-byo) endpoint is a regular endpoint or a OneKeyV2 AI services account endpoint.
traffic	object

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.

OpenAIEndpointResourceProperties

Object

Name	Type	Description
associatedResourceId	string (arm-id)	Byo resource id for creating the built-in model service endpoints.
deployments	EndpointDeploymentResourcePropertiesBasicResource[]	Deployments info.
endpointType	string: Azure.OpenAI	Type of the endpoint.
endpointUri	string (url)	Uri of the endpoint.
failureReason	string	The failure reason if the creation failed.
location	string	Location of the endpoint. Since input dto and when parse endpoint resource share the same contract this Location field is just for parse the endpoint resource info we won't let customer specify the endpoint resource location since we will create it the same location as workspace
name	string	Name of the endpoint.
provisioningState	DefaultResourceProvisioningState	Read-only provision state status property.
shouldCreateAiServicesEndpoint	boolean	Whether the proxy (non-byo) endpoint is a regular endpoint or a OneKeyV2 AI services account endpoint.

ServerlessEndpointCapacityReservation

Object

Name	Type	Description
capacityReservationGroupId	string minLength: 1 pattern: [a-zA-Z0-9_]
endpointReservedCapacity	integer (int32)

ServerlessEndpointContentSafety

Object

Name	Type	Description
contentSafetyStatus	ContentSafetyStatus

ServerlessEndpointInferenceEndpoint

Object

Name	Type	Description
headers	object
uri	string (uri)

ServerlessEndpointModelSettings

Object

Name	Type	Description
modelId	string minLength: 1 pattern: [a-zA-Z0-9_]

ServerlessEndpointResourceProperties

Object

Name	Type	Description
associatedResourceId	string (arm-id)	Byo resource id for creating the built-in model service endpoints.
authMode	ServerlessInferenceEndpointAuthMode
capacityReservation	ServerlessEndpointCapacityReservation
contentSafety	ServerlessEndpointContentSafety
deployments	EndpointDeploymentResourcePropertiesBasicResource[]	Deployments info.
endpointState	ServerlessEndpointState
endpointType	string: serverlessEndpoint	Type of the endpoint.
endpointUri	string (url)	Uri of the endpoint.
failureReason	string	The failure reason if the creation failed.
inferenceEndpoint	ServerlessEndpointInferenceEndpoint
location	string	Location of the endpoint. Since input dto and when parse endpoint resource share the same contract this Location field is just for parse the endpoint resource info we won't let customer specify the endpoint resource location since we will create it the same location as workspace
marketplaceSubscriptionId	string
metadata
modelSettings	ServerlessEndpointModelSettings
name	string	Name of the endpoint.
offer	ServerlessOffer
provisioningState	DefaultResourceProvisioningState	Read-only provision state status property.
shouldCreateAiServicesEndpoint	boolean	Whether the proxy (non-byo) endpoint is a regular endpoint or a OneKeyV2 AI services account endpoint.

ServerlessEndpointState

Enumeration

Value	Description
Unknown
Creating
Deleting
Suspending
Reinstating
Online
Suspended
CreationFailed
DeletionFailed

ServerlessInferenceEndpointAuthMode

Enumeration

Value	Description
Key
AAD

ServerlessOffer

Object

Name	Type	Description
offerName	string minLength: 1 pattern: [a-zA-Z0-9_]
publisher	string minLength: 1 pattern: [a-zA-Z0-9_]

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.

SpeechEndpointResourceProperties

Object

Name	Type	Description
associatedResourceId	string (arm-id)	Byo resource id for creating the built-in model service endpoints.
deployments	EndpointDeploymentResourcePropertiesBasicResource[]	Deployments info.
endpointType	string: Azure.Speech	Type of the endpoint.
endpointUri	string (url)	Uri of the endpoint.
failureReason	string	The failure reason if the creation failed.
location	string	Location of the endpoint. Since input dto and when parse endpoint resource share the same contract this Location field is just for parse the endpoint resource info we won't let customer specify the endpoint resource location since we will create it the same location as workspace
name	string	Name of the endpoint.
provisioningState	DefaultResourceProvisioningState	Read-only provision state status property.
shouldCreateAiServicesEndpoint	boolean	Whether the proxy (non-byo) endpoint is a regular endpoint or a OneKeyV2 AI services account endpoint.

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.