Online Endpoints - Create Or Update

Reference

Service:: Machine Learning

API Version:: 2024-10-01

Create or update Online Endpoint (asynchronous).

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

URI Parameters

Name	In	Required	Type	Description
endpointName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$	Online Endpoint name.
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}$	Name of Azure Machine Learning workspace.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
properties	True	OnlineEndpoint	[Required] Additional attributes of the entity.
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.
sku		Sku	Sku details required for ARM contract for Autoscaling.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	OnlineEndpointTrackedResource	Create or update request is successful.
201 Created	OnlineEndpointTrackedResource	Created Headers x-ms-async-operation-timeout: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Error

Name

Type

Description

200 OK

OnlineEndpointTrackedResource

Create or update request is successful.

201 Created

OnlineEndpointTrackedResource

Created

Headers

x-ms-async-operation-timeout: string
Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Error

Examples

CreateOrUpdate Workspace Online Endpoint.

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.MachineLearningServices/workspaces/my-aml-workspace/onlineEndpoints/testEndpointName?api-version=2024-10-01

{
  "properties": {
    "description": "string",
    "properties": {
      "string": "string"
    },
    "authMode": "AMLToken",
    "compute": "string",
    "traffic": {
      "string": 1
    }
  },
  "tags": {},
  "location": "string",
  "kind": "string",
  "identity": {
    "type": "SystemAssigned",
    "userAssignedIdentities": {
      "string": {}
    }
  },
  "sku": {
    "name": "string",
    "tier": "Free",
    "size": "string",
    "family": "string",
    "capacity": 1
  }
}

Sample response

Status code:: 200

{
  "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
  }
}

Status code:: 201

{
  "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
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
EndpointAuthKeys	Keys for endpoint authentication.
EndpointAuthMode	Enum to determine endpoint authentication mode.
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
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

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

EndpointAuthKeys

Object

Keys for endpoint authentication.

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

EndpointAuthMode

Enumeration

Enum to determine endpoint authentication mode.

Value	Description
AADToken
AMLToken
Key

EndpointProvisioningState

Enumeration

State of endpoint provisioning.

Value	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

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.

ManagedServiceIdentity

Object

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

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	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

Enumeration

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

Value	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

OnlineEndpoint

Object

Online endpoint configuration

Name	Type	Default value	Description
authMode	EndpointAuthMode		[Required] The authentication method for invoking the endpoint (data plane operation). Use 'Key' for key-based authentication. Use 'AMLToken' for Azure Machine Learning token-based authentication. Use 'AADToken' for Microsoft Entra token-based authentication.
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 (uri)		Endpoint URI.
swaggerUri	string (uri)		Endpoint Swagger URI.
traffic	object		Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100.

OnlineEndpointTrackedResource

Object

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"

PublicNetworkAccessType

Enumeration

Enum to determine whether PublicNetworkAccess is Enabled or Disabled.

Value	Description
Disabled
Enabled

Sku

Object

The resource model definition representing SKU

Name	Type	Description
capacity	integer (int32)	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

Enumeration

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.

Value	Description
Basic
Free
Premium
Standard

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.

UserAssignedIdentity

Object

User assigned identity properties

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

Share via

Online Endpoints - Create Or Update

URI Parameters

Request Body

Responses

Examples

CreateOrUpdate Workspace Online Endpoint.

Sample request

Sample response

Definitions

createdByType

EndpointAuthKeys

EndpointAuthMode

EndpointProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

OnlineEndpoint

OnlineEndpointTrackedResource

PublicNetworkAccessType

Sku

SkuTier

systemData

UserAssignedIdentity