Share via

az ml serverless-endpoint

  • Preview
  • Reference

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 serverless-endpoint command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Azure ML serverless endpoints.

Commands

Name Description Type Status
az ml serverless-endpoint create

Create a serverless endpoint.

 Extension Preview
az ml serverless-endpoint delete

Delete a serverless endpoint.

 Extension Preview
az ml serverless-endpoint get-credentials

List the keys for a serverless endpoint.

 Extension Preview
az ml serverless-endpoint list

List serverless endpoints in a workspace.

 Extension Preview
az ml serverless-endpoint regenerate-keys

Regenerate the keys for a serverless endpoint.

 Extension Preview
az ml serverless-endpoint show

Shows details for a serverless endpoint.

 Extension Preview
az ml serverless-endpoint update

Update a serverlesss endpoint.

 Extension Preview

az ml serverless-endpoint create

Preview

Command group 'ml serverless-endpoint' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a serverless endpoint.

az ml serverless-endpoint create --resource-group
                                 --workspace-name
                                 [--file]
                                 [--name]
                                 [--no-wait]
                                 [--set]

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

--file -f

Local path to the YAML file containing the Azure ML serverless-endpoint specification. The YAML reference docs for serverless-endpoint can be found at:.

--name -n

Name of the serverless endpoint.

--no-wait

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

Default value: False
--set

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml serverless-endpoint delete

Preview

Command group 'ml serverless-endpoint' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a serverless endpoint.

az ml serverless-endpoint delete --name
                                 --resource-group
                                 --workspace-name
                                 [--no-wait]

Required Parameters

--name -n

Name of the serverless 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>.

Optional Parameters

--no-wait

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

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml serverless-endpoint get-credentials

Preview

Command group 'ml serverless-endpoint' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the keys for a serverless endpoint.

az ml serverless-endpoint get-credentials --name
                                          --resource-group
                                          --workspace-name

Required Parameters

--name -n

Name of the serverless 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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml serverless-endpoint list

Preview

Command group 'ml serverless-endpoint' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List serverless endpoints in a workspace.

az ml serverless-endpoint list --resource-group
                               --workspace-name

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml serverless-endpoint regenerate-keys

Preview

Command group 'ml serverless-endpoint' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Regenerate the keys for a serverless endpoint.

az ml serverless-endpoint regenerate-keys --name
                                          --resource-group
                                          --workspace-name
                                          [--key-type]
                                          [--no-wait]

Required Parameters

--name -n

Name of the serverless 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>.

Optional Parameters

--key-type

The type of key to regenerate. Allowed values: primary, secondary.

Default value: primary
--no-wait

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

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml serverless-endpoint show

Preview

Command group 'ml serverless-endpoint' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Shows details for a serverless endpoint.

az ml serverless-endpoint show --name
                               --resource-group
                               --workspace-name

Required Parameters

--name -n

Name of the serverless 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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml serverless-endpoint update

Preview

Command group 'ml serverless-endpoint' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a serverlesss endpoint.

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

Required Parameters

--name -n

Name of the serverless 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>.

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

Default value: []
--force-string

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

Default value: False
--no-wait

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

Default value: False
--remove

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

Default value: []
--set

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

Default value: []
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.