az aimanager modelsource

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

Manage model sources within an AI Manager.

A model source tells the platform where to pull model artifacts from and, for gated or private sources, which credential to authenticate with. Model sources are referenced by 'az aimanager namespace modeldeployment add --model-source-resource-id'.

Commands

Name	Description	Type	Status
az aimanager modelsource add	Add a model source to an AI Manager.	Extension	GA
az aimanager modelsource delete	Delete a model source from an AI Manager.	Extension	GA
az aimanager modelsource list	List the model sources within an AI Manager.	Extension	GA
az aimanager modelsource show	Show the details of a model source within an AI Manager.	Extension	GA
az aimanager modelsource update	Update a model source within an AI Manager.	Extension	GA
az aimanager modelsource wait	Wait for an AI Manager model source to reach a desired state.	Extension	GA

az aimanager modelsource add

Add a model source to an AI Manager.

az aimanager modelsource add --aimanager-name
                             --name
                             --resource-group
                             --source-type {HuggingFace}
                             [--acquire-policy-token]
                             [--aks-custom-headers]
                             [--change-reference]
                             [--description]
                             [--no-wait]
                             [--token]

Examples

Add a public Hugging Face model source

az aimanager modelsource add -g myrg --aimanager-name my-ai-manager -n hf --source-type HuggingFace

Add a Hugging Face model source with an access token for gated models

az aimanager modelsource add -g myrg --aimanager-name my-ai-manager -n hf -s HuggingFace --token hf_xxx --description "Gated models"

Required Parameters

--aimanager-name

The name of the AI Manager resource.

--name -n

The name of the model source.

--resource-group -g

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

--source-type -s

The type of the model source. Immutable after creation.

Property	Value
Accepted values:	HuggingFace

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

--aks-custom-headers

Comma-separated key=value pairs to specify custom headers.

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--description

An optional, free-form description of the model source.

--no-wait

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

Property	Value
Default value:	False

--token

Access token used by the platform to authenticate to the source. Optional for public sources such as ungated Hugging Face models.

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 modelsource delete

Delete a model source from an AI Manager.

az aimanager modelsource delete --aimanager-name
                                --name
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]
                                [--no-wait]
                                [--yes]

Examples

Delete a model source

az aimanager modelsource delete -g myrg --aimanager-name my-ai-manager -n hf

Required Parameters

--aimanager-name

The name of the AI Manager resource.

--name -n

The name of the model source.

--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 modelsource list

List the model sources within an AI Manager.

az aimanager modelsource list --aimanager-name
                              --resource-group

Examples

List model sources

az aimanager modelsource list -g myrg --aimanager-name my-ai-manager

Required Parameters

--aimanager-name

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

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 modelsource show

Show the details of a model source within an AI Manager.

az aimanager modelsource show --aimanager-name
                              --name
                              --resource-group

Examples

Show a model source

az aimanager modelsource show -g myrg --aimanager-name my-ai-manager -n hf

Required Parameters

--aimanager-name

The name of the AI Manager resource.

--name -n

The name of the model source.

--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 modelsource update

Update a model source within an AI Manager.

The source type is immutable after creation and is always preserved. Omitted properties keep their current values.

az aimanager modelsource update --aimanager-name
                                --name
                                --resource-group
                                [--acquire-policy-token]
                                [--aks-custom-headers]
                                [--change-reference]
                                [--description]
                                [--no-wait]
                                [--token]

Examples

Rotate the access token of a model source

az aimanager modelsource update -g myrg --aimanager-name my-ai-manager -n hf --token hf_yyy

Update the description of a model source

az aimanager modelsource update -g myrg --aimanager-name my-ai-manager -n hf --description "Internal mirror"

Required Parameters

--aimanager-name

The name of the AI Manager resource.

--name -n

The name of the model source.

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

--aks-custom-headers

Comma-separated key=value pairs to specify custom headers.

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--description

An optional, free-form description of the model source.

--no-wait

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

Property	Value
Default value:	False

--token

Access token used by the platform to authenticate to the source. Optional for public sources such as ungated Hugging Face models.

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 modelsource wait

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

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

Required Parameters

--aimanager-name

The name of the AI Manager resource.

--name -n

The name of the model source.

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