Share via

az ml batch-deployment

Note

This reference is part of the ml extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az ml batch-deployment command. Learn more about extensions.

Manage Azure ML batch deployments.

Azure ML deployments provide a simple interface for creating and managing model deployments.

Commands

Name Description Type Status
az ml batch-deployment create

Create a deployment. If the deployment already exists, it will be over-written with the new settings.

 Extension GA
az ml batch-deployment delete

Delete a deployment.

 Extension GA
az ml batch-deployment list

List deployments.

 Extension GA
az ml batch-deployment list-jobs

List the batch scoring jobs for a batch deployment.

 Extension GA
az ml batch-deployment show

Show a deployment.

 Extension GA
az ml batch-deployment update

Update a deployment.

 Extension GA

az ml batch-deployment create

Create a deployment. If the deployment already exists, it will be over-written with the new settings.

az ml batch-deployment create --file
                              --resource-group
                              --workspace-name
                              [--endpoint-name]
                              [--name]
                              [--no-wait]
                              [--set]
                              [--set-default]
                              [--skip-script-validation]

Examples

Create a deployment from a YAML specification file

az ml batch-deployment create --file deployment.yaml --resource-group my-resource-group --workspace-name my-workspace

Required Parameters

--file -f

Local path to the YAML file containing the Azure ML batch-deployment specification. The YAML reference docs for batch-deployment can be found at: https://aka.ms/ml-cli-v2-deployment-batch-yaml-reference.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--endpoint-name -e

Name of the batch endpoint.

--name -n

Name of the deployment.

--no-wait

Do not wait for the long-running-operation to finish. Default is False.

Property Value
Default value: False
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=value.

--set-default

Sets endpoint defaults.deployment_name to this deployment after successful creation, does not work with --no-wait.

Property Value
Default value: False
--skip-script-validation

Allows user to bypass deployment scoring script validation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az ml batch-deployment delete

Delete a deployment.

az ml batch-deployment delete --endpoint-name
                              --name
                              --resource-group
                              --workspace-name
                              [--no-wait]
                              [--yes]

Examples

Delete a deployment with confirmation

az ml batch-deployment delete --name my-deployment --endpoint-name my-endpoint --yes --resource-group my-resource-group --workspace-name my-workspace

Required Parameters

--endpoint-name -e

Name of the batch endpoint.

--name -n

Name of the deployment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running-operation to finish. Default is False.

Property Value
Default value: False
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az ml batch-deployment list

List deployments.

az ml batch-deployment list --endpoint-name
                            --resource-group
                            --workspace-name

Examples

List deployment in an endpoint

az ml batch-deployment list --endpoint-name my-endpoint --resource-group my-resource-group --workspace-name my-workspace

Required Parameters

--endpoint-name -e

Name of the endpoint.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az ml batch-deployment list-jobs

List the batch scoring jobs for a batch deployment.

az ml batch-deployment list-jobs --endpoint-name
                                 --name
                                 --resource-group
                                 --workspace-name

Examples

List the batch scoring jobs for a specific deployment

az ml batch-deployment list-jobs --name my-batch-endpoint --endpoint-name my-endpoint --resource-group my-resource-group --workspace-name my-workspace

Required Parameters

--endpoint-name -e

Name of the batch endpoint.

--name -n

Name of the deployment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az ml batch-deployment show

Show a deployment.

az ml batch-deployment show --endpoint-name
                            --name
                            --resource-group
                            --workspace-name

Examples

Show a deployment

az ml batch-deployment show --name my-deployment --endpoint-name my-endpoint --resource-group my-resource-group --workspace-name my-workspace

Required Parameters

--endpoint-name -e

Name of the batch endpoint.

--name -n

Name of the deployment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az ml batch-deployment update

Update a deployment.

az ml batch-deployment update --resource-group
                              --workspace-name
                              [--add]
                              [--endpoint-name]
                              [--file]
                              [--force-string]
                              [--name]
                              [--no-wait]
                              [--remove]
                              [--set]

Examples

Update a deployment from a YAML specification file

az ml batch-deployment update --file deployment.yaml --resource-group my-resource-group --workspace-name my-workspace

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
Default value: []
--endpoint-name -e

Name of the batch endpoint.

--file -f

Local path to the YAML file containing the Azure ML batch-deployment specification. The YAML reference docs for batch-deployment can be found at: https://aka.ms/ml-cli-v2-deployment-batch-yaml-reference.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Default value: False
--name -n

Name of the deployment.

--no-wait

Do not wait for the long-running-operation to finish. Default is False.

Property Value
Default value: False
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
Default value: []
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
Default value: []
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False