Share via

az acr credential-set

  • Reference

Manage credential sets in Azure Container Registries.

Commands

Name Description Type Status
az acr credential-set create

Create a credential set.

 Core GA
az acr credential-set delete

Delete a credential set.

 Core GA
az acr credential-set list

List the credential sets in an Azure Container Registry.

 Core GA
az acr credential-set show

Show a credential set.

 Core GA
az acr credential-set update

Update the username or password Azure Key Vault secret ID on a credential set.

 Core GA

az acr credential-set create

Edit

Create a credential set.

az acr credential-set create --login-server
                             --name
                             --password-id
                             --registry
                             --username-id
                             [--resource-group]

Examples

Create a credential set.

az acr credential-set create -r myregistry -n MyDockerHubCredSet -l docker.io -u https://MyKeyvault.vault.azure.net/secrets/usernamesecret -p https://MyKeyvault.vault.azure.net/secrets/passwordsecret

Required Parameters

--login-server -l

The login server address of the upstream registry such as 'docker.io'.

--name -n

The name of the credential set.

--password-id -p

The Azure Key Vault secret ID of the secret containing the password to the upstream registry.

--registry -r

The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>.

--username-id -u

The Azure Key Vault secret ID of the secret containing the username to the upstream registry.

Optional Parameters

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

--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 acr credential-set delete

Edit

Delete a credential set.

az acr credential-set delete --name
                             --registry
                             [--resource-group]
                             [--yes]

Examples

Delete a credential set.

az acr credential-set delete -r myregistry -n MyCredSet

Required Parameters

--name -n

The name of the credential set.

--registry -r

The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

--resource-group -g

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

--yes -y

Do not prompt for confirmation.

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 acr credential-set list

Edit

List the credential sets in an Azure Container Registry.

az acr credential-set list --registry
                           [--resource-group]

Examples

List the credential sets in an Azure Container Registry.

az acr credential-set list -r myregistry

Required Parameters

--registry -r

The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

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

--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 acr credential-set show

Edit

Show a credential set.

az acr credential-set show --name
                           --registry
                           [--resource-group]

Examples

Show a credential set rule.

az acr credential-set show -r myregistry -n MyCredSet

Required Parameters

--name -n

The name of the credential set.

--registry -r

The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

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

--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 acr credential-set update

Edit

Update the username or password Azure Key Vault secret ID on a credential set.

az acr credential-set update --name
                             --registry
                             [--add]
                             [--force-string]
                             [--password-id]
                             [--remove]
                             [--resource-group]
                             [--set]
                             [--username-id]

Examples

Update the password Azure Key Vault secret ID.

az acr credential-set update -r myregistry -n MyDockerHubCredSet -p https://MyKeyvault.vault.azure.net/secrets/newsecretname

Required Parameters

--name -n

The name of the credential set.

--registry -r

The name of the container registry. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry 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
--password-id -p

The Azure Key Vault secret ID of the secret containing the password to the upstream registry.

--remove

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

Default value: []
--resource-group -g

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

--set

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

Default value: []
--username-id -u

The Azure Key Vault secret ID of the secret containing the username to the upstream registry.

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.