Share via

az containerapp registry

  • Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Commands to manage container registry information.

Commands

Name Description Type Status
az containerapp registry list

List container registries configured in a container app.

 Core GA
az containerapp registry remove

Remove a container registry's details.

 Core GA
az containerapp registry set

Add or update a container registry's details.

 Core GA
az containerapp registry set (containerapp extension)

Add or update a container registry's details.

 Extension Preview
az containerapp registry show

Show details of a container registry.

 Core GA

az containerapp registry list

Edit

List container registries configured in a container app.

az containerapp registry list --name
                              --resource-group

Examples

List container registries configured in a container app.

az containerapp registry list -n my-containerapp -g MyResourceGroup

Required Parameters

--name -n

The name of the Containerapp. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

--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 containerapp registry remove

Edit

Remove a container registry's details.

az containerapp registry remove --server
                                [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

Examples

Remove a registry from a Containerapp.

az containerapp registry remove -n my-containerapp -g MyResourceGroup --server MyContainerappRegistry.azurecr.io

Required Parameters

--server

The container registry server, e.g. myregistry.azurecr.io.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the Containerapp. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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 containerapp registry set

Edit

Add or update a container registry's details.

az containerapp registry set --server
                             [--identity]
                             [--ids]
                             [--name]
                             [--password]
                             [--resource-group]
                             [--subscription]
                             [--username]

Examples

Configure a container app to use a registry.

az containerapp registry set -n my-containerapp -g MyResourceGroup \
    --server MyExistingContainerappRegistry.azurecr.io --username MyRegistryUsername --password MyRegistryPassword

Required Parameters

--server

The container registry server, e.g. myregistry.azurecr.io.

Optional Parameters

--identity

The managed identity with which to authenticate to the Azure Container Registry (instead of username/password). Use 'system' for a system-defined identity or a resource id for a user-defined identity. The managed identity should have been assigned acrpull permissions on the ACR before deployment (use 'az role assignment create --role acrpull ...').

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the Containerapp. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

--password

The password of the registry. If using Azure Container Registry, we will try to infer the credentials if not supplied.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--username

The username of the registry. If using Azure Container Registry, we will try to infer the credentials if not supplied.

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 containerapp registry set (containerapp extension)

Preview

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

Add or update a container registry's details.

az containerapp registry set --server
                             [--identity]
                             [--ids]
                             [--name]
                             [--password]
                             [--resource-group]
                             [--subscription]
                             [--username]

Examples

Configure a container app to use a registry.

az containerapp registry set -n my-containerapp -g MyResourceGroup \
    --server MyExistingContainerappRegistry.azurecr.io --username MyRegistryUsername --password MyRegistryPassword

Configure a container app to use environment system assigned managed identity to authenticate Azure container registry.

az containerapp registry set -n my-containerapp -g MyResourceGroup \
    --server MyExistingContainerappRegistry.azurecr.io --identity system-environment

Required Parameters

--server

The container registry server, e.g. myregistry.azurecr.io.

Optional Parameters

--identity

The managed identity with which to authenticate to the Azure Container Registry (instead of username/password). Use 'system' for a system-defined identity, Use 'system-environment' for an environment level system-defined identity or a resource id for a user-defined environment/containerapp level identity. The managed identity should have been assigned acrpull permissions on the ACR before deployment (use 'az role assignment create --role acrpull ...').

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the Containerapp. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

--password

The password of the registry. If using Azure Container Registry, we will try to infer the credentials if not supplied.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--username

The username of the registry. If using Azure Container Registry, we will try to infer the credentials if not supplied.

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 containerapp registry show

Edit

Show details of a container registry.

az containerapp registry show --server
                              [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

Examples

Show the details of a container registry.

az containerapp registry show -n my-containerapp -g MyResourceGroup --server MyContainerappRegistry.azurecr.io

Required Parameters

--server

The container registry server, e.g. myregistry.azurecr.io.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

The name of the Containerapp. A name must consist of lower case alphanumeric characters or '-', start with a letter, end with an alphanumeric character, cannot have '--', and must be less than 32 characters.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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.