reference-yaml-endpoint-batch.md

title	titleSuffix	description	services	ms.service	ms.subservice	ms.topic	ms.custom	author	ms.author	ms.date	ms.reviewer
CLI (v2) batch endpoint YAML schema	Azure Machine Learning	Reference documentation for the CLI (v2) batch endpoint YAML schema.	machine-learning	machine-learning	core	reference	cliv2, event-tier1-build-2022	blackmist	larryfr	10/21/2021	laobri

CLI (v2) batch endpoint YAML schema

[!INCLUDE cli v2]

The source JSON schema can be found at https://azuremlschemas.azureedge.net/latest/batchEndpoint.schema.json.

[!INCLUDE schema note]

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.
description	string	Description of the endpoint.
tags	object	Dictionary of tags for the endpoint.
auth_mode	string	The authentication method for the endpoint. Currently only Azure Active Directory (Azure AD) token-based authentication is supported.	aad_token	aad_token
defaults	object	Default settings for the endpoint.
defaults.deployment_name	string	Name of the deployment that will serve as the default deployment for the endpoint.

Remarks

The az ml batch-endpoint commands can be used for managing Azure Machine Learning endpoints.

Examples

Examples are available in the examples GitHub repository. Several are shown below.

YAML: basic

:::code language="yaml" source="~/azureml-examples-main/cli/endpoints/batch/batch-endpoint.yml":::

Next steps

• Install and use the CLI (v2)