az ml batch-deployment

Note

This reference is part of the ml extension for Azure CLI and requires 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

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 delete

Delete a deployment.

az ml batch-deployment list

List deployments.

az ml batch-deployment list-jobs

List the batch scoring jobs for a batch deployment.

az ml batch-deployment show

Show a deployment.

az ml batch-deployment update

Update a deployment.

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]

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 deployment specification.

--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 group using az configure --defaults workspace=<name>.

Optional Parameters

--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.

--set

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

--set-default

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

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 group using az configure --defaults workspace=<name>.

Optional Parameters

--no-wait

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

--yes -y

Do not prompt for confirmation.

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 group using az configure --defaults workspace=<name>.

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 group using az configure --defaults workspace=<name>.

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 group using az configure --defaults workspace=<name>.

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 group using az configure --defaults workspace=<name>.

Optional Parameters

--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>.

--endpoint-name -e

Name of the batch endpoint.

--file -f

Local path to the YAML file containing the Azure ML deployment specification.

--force-string

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

--name -n

Name of the deployment.

--no-wait

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

--remove

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

--set

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