CLI (v2) online endpoint YAML schema
The source JSON schema can be found at https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json.
Important
This feature is currently in public preview. This preview version is provided without a service-level agreement, and it's not recommended for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see Supplemental Terms of Use for Microsoft Azure Previews.
Note
The YAML syntax detailed in this document is based on the JSON schema for the latest version of the ML CLI v2 extension. This syntax is guaranteed only to work with the latest version of the ML CLI v2 extension. You can find the schemas for older extension versions at https://azuremlschemasprod.azureedge.net/.
Note
A fully specified sample YAML for managed online endpoints is available for reference
YAML syntax
| Key | Type | Description | Allowed values | Default value |
|---|---|---|---|---|
$schema |
string | The YAML schema. If you use the Azure Machine Learning VS Code extension to author the YAML file, including $schema at the top of your file enables you to invoke schema and resource completions. |
||
name |
string | Required. Name of the endpoint. Needs to be unique at the Azure region level. Naming rules are defined under managed online endpoint limits. |
||
description |
string | Description of the endpoint. | ||
tags |
object | Dictionary of tags for the endpoint. | ||
auth_mode |
string | The authentication method for the endpoint. Key-based authentication and Azure ML token-based authentication are supported. Key-based authentication doesn't expire but Azure ML token-based authentication does. | key, aml_token |
key |
allow_public_access |
boolean | Whether to allow public access when Private Link is enabled. | true |
|
identity |
object | The managed identity configuration for accessing Azure resources for endpoint provisioning and inference. | ||
identity.type |
string | The type of managed identity. If the type is user_assigned, the identity.user_assigned_identities property must also be specified. |
system_assigned, user_assigned |
|
identity.user_assigned_identities |
array | List of fully qualified resource IDs of the user-assigned identities. |
Remarks
The az ml online-endpoint commands can be used for managing Azure Machine Learning online endpoints.
Examples
Examples are available in the examples GitHub repository. Several are shown below.
YAML: basic
$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-endpoint
auth_mode: key
YAML: system-assigned identity
$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-sai-endpoint
auth_mode: key
YAML: user-assigned identity
$schema: https://azuremlschemas.azureedge.net/latest/managedOnlineEndpoint.schema.json
name: my-uai-endpoint
auth_mode: key
identity:
type: user_assigned
user_assigned_identities:
- resource_id: user_identity_ARM_id_place_holder