az ml service

Manage operationalized services.

Commands

az ml service delete Delete a service from the workspace.
az ml service get-access-token Get a token to issue requests a service.
az ml service get-keys Get keys to issue requests against a service.
az ml service get-logs Get logs for a service.
az ml service list List services in the workspace.
az ml service regen-key Regenerate keys for a service.
az ml service run Run a service in the workspace.
az ml service show Show details for a service in the workspace.
az ml service update Update a service in the workspace.

az ml service delete

Delete a service from the workspace.

az ml service delete --name
[--path]
[--resource-group]
[--workspace-name]
[-v]

Required Parameters

--name -n

The service name to delete.

Optional Parameters

--path

Path to a project folder. Default: current directory.

--resource-group -g

Resource group corresponding to the provided workspace.

--workspace-name -w

Name of the workspace containing the service to delete.

-v

Verbosity flag.

az ml service get-access-token

Get a token to issue requests a service.

az ml service get-access-token --name
[--path]
[--resource-group]
[--workspace-name]
[-v]

Required Parameters

--name -n

Service Name.

Optional Parameters

--path

Path to a project folder. Default: current directory.

--resource-group -g

Resource group corresponding to the provided workspace.

--workspace-name -w

Name of the workspace containing the service to show.

-v

Verbosity flag.

az ml service get-keys

Get keys to issue requests against a service.

az ml service get-keys --name
[--path]
[--resource-group]
[--workspace-name]
[-v]

Required Parameters

--name -n

Service Name.

Optional Parameters

--path

Path to a project folder. Default: current directory.

--resource-group -g

Resource group corresponding to the provided workspace.

--workspace-name -w

Name of the workspace containing the service to show.

-v

Verbosity flag.

az ml service get-logs

Get logs for a service.

az ml service get-logs --name
[--num_lines]
[--path]
[--resource-group]
[--workspace-name]
[-v]

Required Parameters

--name -n

Service Name.

Optional Parameters

--num_lines -l

Number of log lines to return from tail (default is 5000).

default value: 5000
--path

Path to a project folder. Default: current directory.

--resource-group -g

Resource group corresponding to the provided workspace.

--workspace-name -w

Name of the workspace containing the service to show.

-v

Verbosity flag.

az ml service list

List services in the workspace.

az ml service list [--compute-type]
[--image-digest]
[--model-id]
[--model-name]
[--path]
[--property]
[--resource-group]
[--tag]
[--workspace-name]
[-v]

Optional Parameters

--compute-type -c

If provided, will only show services that have the specified compute type. (Options are 'ACI', 'AKS').

--image-digest

If provided, will only show services that have the specified image digest.

--model-id

If provided, will only show services that have the specified model id.

--model-name

If provided, will only show services that have the specified model name.

--path

Path to a project folder. Default: current directory.

--property

If provided, will filter based on the provided key/value (e.g. key, or key=value). Multiple properties can be specified with multiple --property options.

--resource-group -g

Resource group corresponding to the provided workspace.

--tag

If provided, will filter based on the provided key/value (e.g. key, or key=value). Multiple tags can be specified with multiple --tag options.

--workspace-name -w

Name of the workspace containing the services to list.

-v

Verbosity flag.

az ml service regen-key

Regenerate keys for a service.

az ml service regen-key --key
--name
[--path]
[--resource-group]
[--workspace-name]
[-v]

Required Parameters

--key -k

Which key to regenerate, if regen is specified. Options: Primary, Secondary.

--name -n

Service Name.

Optional Parameters

--path

Path to a project folder. Default: current directory.

--resource-group -g

Resource group corresponding to the provided workspace.

--workspace-name -w

Name of the workspace containing the service to show.

-v

Verbosity flag.

az ml service run

Run a service in the workspace.

az ml service run --name
[--input-data]
[--path]
[--resource-group]
[--workspace-name]
[-v]

Required Parameters

--name -n

The service name to score against.

Optional Parameters

--input-data -d

The data to use for calling the web service.

--path

Path to a project folder. Default: current directory.

--resource-group -g

Resource group corresponding to the provided workspace.

--workspace-name -w

Name of the workspace containing the service to run.

-v

Verbosity flag.

az ml service show

Show details for a service in the workspace.

az ml service show --name
[--path]
[--resource-group]
[--workspace-name]
[-v]

Required Parameters

--name -n

Name of the webservice to show.

Optional Parameters

--path

Path to a project folder. Default: current directory.

--resource-group -g

Resource group corresponding to the provided workspace.

--workspace-name -w

Name of the workspace containing the service to show.

-v

Verbosity flag.

az ml service update

Update a service in the workspace.

az ml service update --name
[--add-property]
[--add-tag]
[--ae]
[--ai]
[--ar]
[--as]
[--at]
[--autoscale-max-replicas]
[--autoscale-min-replicas]
[--base-image]
[--base-image-registry]
[--cc]
[--cf]
[--collect-model-data]
[--cuda-version]
[--dc]
[--description]
[--dn]
[--ds]
[--ed]
[--eg]
[--entry-script]
[--environment-name]
[--environment-version]
[--failure-threshold]
[--gb]
[--gc]
[--ic]
[--id]
[--kp]
[--ks]
[--lo]
[--max-request-wait-time]
[--model]
[--model-metadata-file]
[--no-wait]
[--nr]
[--path]
[--period-seconds]
[--po]
[--remove-tag]
[--replica-max-concurrent-requests]
[--resource-group]
[--rt]
[--sc]
[--scoring-timeout-ms]
[--sd]
[--se]
[--sk]
[--sp]
[--st]
[--timeout-seconds]
[--token-auth-enabled]
[--workspace-name]
[-v]

Required Parameters

--name -n

The service name to update.

Optional Parameters

--add-property

Key/value property to add (e.g. key=value ). Multiple properties can be specified with multiple --add-property options.

--add-tag

Key/value tag to add (e.g. key=value ). Multiple tags can be specified with multiple --add-tag options.

--ae --auth-enabled

Whether or not to enable key auth for this Webservice. Defaults to False.

--ai --enable-app-insights

Whether or not to enable AppInsights for this Webservice. Defaults to False.

--ar --autoscale-refresh-seconds

How often the autoscaler should attempt to scale this Webservice. Defaults to 1.

--as --autoscale-enabled

Whether or not to enable autoscaling for this Webservice. Defaults to True if num_replicas is None.

--at --autoscale-target-utilization

The target utilization (in percent out of 100) the autoscaler should attempt to maintain for this Webservice. Defaults to 70.

--autoscale-max-replicas --ma

The maximum number of containers to use when autoscaling this Webservice. Defaults to 10.

--autoscale-min-replicas --mi

The minimum number of containers to use when autoscaling this Webservice. Defaults to 1.

--base-image --bi

A custom image to be used as base image. If no base image is given then the base image will be used based off of given runtime parameter.

--base-image-registry --ir

Image registry that contains the base image.

--cc --cpu-cores

The number of cpu cores to allocate for this Webservice. Can be a decimal. Defaults to 0.1.

--cf --conda-file

Path to local file containing a conda environment definition to use for the image.

--collect-model-data --md

Whether or not to enable model data collection for this Webservice. Defaults to False.

--cuda-version --cv

Version of CUDA to install for images that need GPU support. The GPU image must be used on Microsoft Azure Services such as Azure Container Instances, Azure Machine Learning Compute, Azure Virtual Machines, and Azure Kubernetes Service. Supported versions are 9.0, 9.1, and 10.0. If 'enable_gpu' is set, this defaults to '9.1'.

--dc --deploy-config-file

Path to a JSON file containing deployment metadata.

--description -d

Description of the service.

--dn --dns-name-label

The dns name for this Webservice.

--ds --extra-docker-file-steps

Path to local file containing additional Docker steps to run when setting up image.

--ed --environment-directory

Directory for Azure Machine Learning Environment for deployment. It is the same directory path as provided in 'az ml environment scaffold' command.

--eg --enable-gpu

Whether or not to enable GPU support in the image. The GPU image must be used on Microsoft Azure Services such as Azure Container Instances, Azure Machine Learning Compute, Azure Virtual Machines, and Azure Kubernetes Service. Defaults to False.

--entry-script --es

Path to local file that contains the code to run for service (relative path from source_directory if one is provided).

--environment-name -e

Name of Azure Machine Learning Environment for deployment.

--environment-version --ev

Version of an existing Azure Machine Learning Environment for deployment.

--failure-threshold --ft

When a Pod starts and the liveness probe fails, Kubernetes will try --failure-threshold times before giving up. Defaults to 3. Minimum value is 1.

--gb --memory-gb

The amount of memory (in GB) to allocate for this Webservice. Can be a decimal.

--gc --gpu-cores

The number of gpu cores to allocate for this Webservice. Default is 1.

--ic --inference-config-file

Path to a JSON or YAML file containing inference configuration.

--id --initial-delay-seconds

Number of seconds after the container has started before liveness probes are initiated. Defaults to 310.

--kp --primary-key

A primary auth key to use for this Webservice.

--ks --secondary-key

A secondary auth key to use for this Webservice.

--lo --location

The Azure region to deploy this Webservice to. If not specified the Workspace location will be used. More details on available regions can be found here: https://azure.microsoft.com/en-us/global-infrastructure/services/?regions=all&products=container-instances.

--max-request-wait-time --mr

The maximum amount of time a request will stay in the queue (in milliseconds) before returning a 503 error. Defaults to 500.

--model -m

The ID of the model to be deployed. Multiple models can be specified with additional -m arguments. Models need to be registered first.

--model-metadata-file -f

Path to a JSON file containing model registration metadata. Multiple models can be provided using multiple -f parameters.

--no-wait

Flag to not wait for asynchronous calls.

--nr --num-replicas

The number of containers to allocate for this Webservice. No default, if this parameter is not set then the autoscaler is enabled by default.

--path

Path to a project folder. Default: current directory.

--period-seconds --ps

How often (in seconds) to perform the liveness probe. Default to 10 seconds. Minimum value is 1.

--po --port

The local port on which to expose the service's HTTP endpoint.

--remove-tag

Key of tag to remove. Multiple tags can be specified with multiple --remove-tag options.

--replica-max-concurrent-requests --rm

The number of maximum concurrent requests per node to allow for this Webservice. Defaults to 1.

--resource-group -g

Resource group corresponding to the provided workspace.

--rt --runtime

Which runtime to use for image. Current supported runtimes are 'spark-py' and 'python'spark-py|python|python-slim.

--sc --ssl-cname

The cname for if SSL is enabled.

--scoring-timeout-ms --tm

A timeout to enforce for scoring calls to this Webservice. Defaults to 60000.

--sd --source-directory

Path to folders that contain all files to create the image.

--se --ssl-enabled

Whether or not to enable SSL for this Webservice. Defaults to False.

--sk --ssl-key-pem-file

The key file needed if SSL is enabled.

--sp --ssl-cert-pem-file

The cert file needed if SSL is enabled.

--st --success-threshold

Minimum consecutive successes for the liveness probe to be considered successful after having failed. Defaults to 1. Minimum value is 1.

--timeout-seconds --ts

Number of seconds after which the liveness probe times out. Defaults to 2 second. Minimum value is 1.

--token-auth-enabled

Whether or not to enable token auth for this Webservice. Only available for AKS web services. Defaults to False.

--workspace-name -w

Name of the workspace containing the service to update.

-v

Verbosity flag.