Online Endpoints - List

Reference

Service:: Machine Learning

API Version:: 2023-10-01

List Online Endpoints.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints?api-version=2023-10-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints?api-version=2023-10-01&name={name}&count={count}&computeType={computeType}&$skip={$skip}&tags={tags}&properties={properties}&orderBy={orderBy}

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	Name of Azure Machine Learning workspace. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$`
api-version	query	True	string	The API version to use for this operation.
$skip	query		string	Continuation token for pagination.
computeType	query		EndpointComputeType	EndpointComputeType to be filtered by.
count	query		integer int32	Number of endpoints to be retrieved in a page of results.
name	query		string	Name of the endpoint.
orderBy	query		OrderString	The option to order the response.
properties	query		string	A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .
tags	query		string	A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .

Responses

Name	Type	Description
200 OK	OnlineEndpointTrackedResourceArmPaginatedResult	Success
Other Status Codes	ErrorResponse	Error

Examples

List Workspace Online Endpoint.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/onlineEndpoints?api-version=2023-10-01&name=string&count=1&computeType=Managed&tags=string&properties=string&orderBy=CreatedAtDesc

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "properties": {
        "description": "string",
        "properties": {
          "string": "string"
        },
        "scoringUri": "https://www.contoso.com/example",
        "swaggerUri": "https://www.contoso.com/example",
        "authMode": "AMLToken",
        "provisioningState": "Creating",
        "compute": "string",
        "traffic": {
          "string": 1
        }
      },
      "systemData": {
        "createdAt": "2020-01-01T12:34:56.999Z",
        "createdBy": "string",
        "createdByType": "User",
        "lastModifiedAt": "2020-01-01T12:34:56.999Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User"
      },
      "tags": {},
      "location": "string",
      "kind": "string",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-1111-2222-3333-444444444444",
        "tenantId": "00000000-1111-2222-3333-444444444444",
        "userAssignedIdentities": {
          "string": {
            "principalId": "00000000-1111-2222-3333-444444444444",
            "clientId": "00000000-1111-2222-3333-444444444444"
          }
        }
      },
      "sku": {
        "name": "string",
        "tier": "Free",
        "size": "string",
        "family": "string",
        "capacity": 1
      }
    }
  ],
  "nextLink": "string"
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
EndpointAuthKeys	Keys for endpoint authentication.
EndpointAuthMode	Enum to determine endpoint authentication mode.
EndpointComputeType	Enum to determine endpoint compute type.
EndpointProvisioningState	State of endpoint provisioning.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
OnlineEndpoint	Online endpoint configuration
OnlineEndpointTrackedResource
OnlineEndpointTrackedResourceArmPaginatedResult	A paginated list of OnlineEndpoint entities.
OrderString
PublicNetworkAccessType	Enum to determine whether PublicNetworkAccess is Enabled or Disabled.
Sku	The resource model definition representing SKU
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	User assigned identity properties

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EndpointAuthKeys

Keys for endpoint authentication.

Name	Type	Description
primaryKey	string	The primary key.
secondaryKey	string	The secondary key.

EndpointAuthMode

Enum to determine endpoint authentication mode.

Name	Type	Description
AADToken	string
AMLToken	string
Key	string

EndpointComputeType

Enum to determine endpoint compute type.

Name	Type	Description
AzureMLCompute	string
Kubernetes	string
Managed	string

EndpointProvisioningState

State of endpoint provisioning.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorAdditionalInfo

The resource management error additional info.

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

ErrorDetail

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

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

OnlineEndpoint

Online endpoint configuration

Name	Type	Default Value	Description
authMode	EndpointAuthMode		[Required] Use 'Key' for key based authentication and 'AMLToken' for Azure Machine Learning token-based authentication. 'Key' doesn't expire but 'AMLToken' does.
compute	string		ARM resource ID of the compute if it exists. optional
description	string		Description of the inference endpoint.
keys	EndpointAuthKeys		EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API.
mirrorTraffic	object		Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50.
properties	object		Property dictionary. Properties can be added, but not removed or altered.
provisioningState	EndpointProvisioningState		Provisioning state for the endpoint.
publicNetworkAccess	PublicNetworkAccessType	Enabled	Set to "Enabled" for endpoints that should allow public access when Private Link is enabled.
scoringUri	string		Endpoint URI.
swaggerUri	string		Endpoint Swagger URI.
traffic	object		Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.

OnlineEndpointTrackedResource

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	OnlineEndpoint	[Required] Additional attributes of the entity.
sku	Sku	Sku details required for ARM contract for Autoscaling.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

OnlineEndpointTrackedResourceArmPaginatedResult

A paginated list of OnlineEndpoint entities.

Name	Type	Description
nextLink	string	The link to the next page of OnlineEndpoint objects. If null, there are no additional pages.
value	OnlineEndpointTrackedResource[]	An array of objects of type OnlineEndpoint.

OrderString

Name	Type	Description
CreatedAtAsc	string
CreatedAtDesc	string
UpdatedAtAsc	string
UpdatedAtDesc	string

PublicNetworkAccessType

Enum to determine whether PublicNetworkAccess is Enabled or Disabled.

Name	Type	Description
Disabled	string
Enabled	string

Sku

The resource model definition representing SKU

Name	Type	Description
capacity	integer	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family	string	If the service has different generations of hardware, for the same SKU, then that can be captured here.
name	string	The name of the SKU. Ex - P3. It is typically a letter+number code
size	string	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier	SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Name	Type	Description
Basic	string
Free	string
Premium	string
Standard	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	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	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.

UserAssignedIdentity

User assigned identity properties

Name	Type	Description
clientId	string	The client ID of the assigned identity.
principalId	string	The principal ID of the assigned identity.