az aimanager namespace modeldeployment

Note

This reference is part of the aimanager extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az aimanager namespace modeldeployment command. Learn more about extensions.

Command group 'aimanager namespace' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage model deployments within an AI Manager namespace.

Commands

Name	Description	Type	Status
az aimanager namespace modeldeployment create	Create a model deployment in an AI Manager namespace.	Extension	Preview
az aimanager namespace modeldeployment delete	Delete a model deployment from an AI Manager namespace.	Extension	Preview
az aimanager namespace modeldeployment list	List model deployments within an AI Manager namespace.	Extension	Preview
az aimanager namespace modeldeployment show	Show a model deployment within an AI Manager namespace.	Extension	Preview
az aimanager namespace modeldeployment update	Update a model deployment within an AI Manager namespace.	Extension	Preview
az aimanager namespace modeldeployment wait	Wait for an AI Manager model deployment to reach a desired state.	Extension	Preview

az aimanager namespace modeldeployment create

Preview

Command group 'aimanager namespace modeldeployment' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a model deployment in an AI Manager namespace.

This command is idempotent: running it again with the same name updates the model deployment and returns it, rather than failing because it already exists.

az aimanager namespace modeldeployment create --aimanager --manager
                                              --model-resource-id
                                              --name
                                              --namespace --ns
                                              --resource-group
                                              --vm-size
                                              [--acquire-policy-token]
                                              [--change-reference]
                                              [--custom-headers]
                                              [--max-replicas]
                                              [--min-replicas]
                                              [--model-source-resource-id --source-id]
                                              [--no-wait]
                                              [--overrides]
                                              [--performance-mode {Balanced, Latency, Throughput}]
                                              [--replicas]

Examples

Create a manually scaled model deployment

az aimanager namespace modeldeployment create -g myrg --aimanager my-ai-manager --namespace team-alpha -n phi --model-resource-id /subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus2/aiModels/phi --vm-size Standard_NC24ads_A100_v4 --replicas 1

Create an autoscaled model deployment

az aimanager namespace modeldeployment create -g myrg --aimanager my-ai-manager --namespace team-alpha -n phi --model-resource-id /subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus2/aiModels/phi --vm-size Standard_NC24ads_A100_v4 --min-replicas 1 --max-replicas 3

Required Parameters

--aimanager --manager -m

The name of the AI Manager resource.

--model-resource-id

The full ARM resource ID of the AI model to deploy.

--name -n

The name of the model deployment.

--namespace --ns

The name of the AI Manager namespace.

--resource-group -g

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

--vm-size -s

The Azure VM SKU used to host the deployment.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--custom-headers

Comma-separated key=value pairs to specify custom headers, this is mainly for internal testing.

--max-replicas

Maximum autoscale replica count.

--min-replicas

Minimum autoscale replica count. Must be at least 1.

--model-source-resource-id --source-id

The full ARM resource ID of the model source used to pull artifacts.

--no-wait

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

Property	Value
Default value:	False

--overrides

Space-separated experimental deployment overrides (key=value).

--performance-mode

Runtime performance mode.

Property	Value
Accepted values:	Balanced, Latency, Throughput

--replicas

Fixed replica count. Cannot be combined with autoscale arguments.

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 aimanager namespace modeldeployment delete

Preview

Command group 'aimanager namespace modeldeployment' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a model deployment from an AI Manager namespace.

az aimanager namespace modeldeployment delete --aimanager --manager
                                              --name
                                              --namespace --ns
                                              --resource-group
                                              [--acquire-policy-token]
                                              [--change-reference]
                                              [--no-wait]
                                              [--yes]

Examples

Delete a model deployment

az aimanager namespace modeldeployment delete -g myrg --aimanager my-ai-manager --namespace team-alpha -n phi

Required Parameters

--aimanager --manager -m

The name of the AI Manager resource.

--name -n

The name of the model deployment.

--namespace --ns

The name of the AI Manager namespace.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--no-wait

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

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 aimanager namespace modeldeployment list

Preview

Command group 'aimanager namespace modeldeployment' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List model deployments within an AI Manager namespace.

If --namespace/--ns is omitted, model deployments are listed across namespaces of the AI Manager. This first lists the namespaces, which requires namespace read permission on the AI Manager resource; without it, no namespaces can be listed. Model deployments are then listed per namespace, which requires model deployment read permission for each namespace (granted on the namespace resource, or inherited from the AI Manager resource) — you may have this for some namespaces but not others. Namespaces you are not authorized to read model deployments in are skipped with a warning. To list a single namespace you have model deployment read access to, specify --namespace/--ns.

az aimanager namespace modeldeployment list --aimanager --manager
                                            --resource-group
                                            [--namespace --ns]

Examples

List model deployments in a namespace

az aimanager namespace modeldeployment list -g myrg --aimanager my-ai-manager --namespace team-alpha

List model deployments across all readable namespaces (omit --namespace)

az aimanager namespace modeldeployment list -g myrg --aimanager my-ai-manager

Required Parameters

--aimanager --manager -m

The name of the AI Manager resource.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

--namespace --ns

The name of the AI Manager namespace. If omitted, model deployments across all readable namespaces of the AI Manager are listed.

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 aimanager namespace modeldeployment show

Preview

Command group 'aimanager namespace modeldeployment' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show a model deployment within an AI Manager namespace.

az aimanager namespace modeldeployment show --aimanager --manager
                                            --name
                                            --namespace --ns
                                            --resource-group

Examples

Show a model deployment

az aimanager namespace modeldeployment show -g myrg --aimanager my-ai-manager --namespace team-alpha -n phi

Required Parameters

--aimanager --manager -m

The name of the AI Manager resource.

--name -n

The name of the model deployment.

--namespace --ns

The name of the AI Manager namespace.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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 aimanager namespace modeldeployment update

Preview

Command group 'aimanager namespace modeldeployment' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a model deployment within an AI Manager namespace.

az aimanager namespace modeldeployment update --aimanager --manager
                                              --name
                                              --namespace --ns
                                              --resource-group
                                              [--acquire-policy-token]
                                              [--change-reference]
                                              [--custom-headers]
                                              [--max-replicas]
                                              [--min-replicas]
                                              [--no-wait]
                                              [--overrides]
                                              [--performance-mode {Balanced, Latency, Throughput}]
                                              [--replicas]

Examples

Change the fixed replica count

az aimanager namespace modeldeployment update -g myrg --aimanager my-ai-manager --namespace team-alpha -n phi --replicas 2

Change the performance mode

az aimanager namespace modeldeployment update -g myrg --aimanager my-ai-manager --namespace team-alpha -n phi --performance-mode Throughput

Required Parameters

--aimanager --manager -m

The name of the AI Manager resource.

--name -n

The name of the model deployment.

--namespace --ns

The name of the AI Manager namespace.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--custom-headers

Comma-separated key=value pairs to specify custom headers, this is mainly for internal testing.

--max-replicas

Maximum autoscale replica count.

--min-replicas

Minimum autoscale replica count. Must be at least 1.

--no-wait

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

Property	Value
Default value:	False

--overrides

Space-separated experimental deployment overrides (key=value).

--performance-mode

Runtime performance mode.

Property	Value
Accepted values:	Balanced, Latency, Throughput

--replicas

Fixed replica count. Cannot be combined with autoscale arguments.

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 aimanager namespace modeldeployment wait

Preview

Command group 'aimanager namespace modeldeployment' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Wait for an AI Manager model deployment to reach a desired state.

az aimanager namespace modeldeployment wait --aimanager --manager
                                            --name
                                            --namespace --ns
                                            --resource-group
                                            [--acquire-policy-token]
                                            [--change-reference]
                                            [--created]
                                            [--custom]
                                            [--deleted]
                                            [--exists]
                                            [--interval]
                                            [--timeout]
                                            [--updated]

Required Parameters

--aimanager --manager -m

The name of the AI Manager resource.

--name -n

The name of the model deployment.

--namespace --ns

The name of the AI Manager namespace.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
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