Share via


az acr manifest

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

Manage artifact manifests in Azure Container Registries.

Commands

Name Description Type Status
az acr manifest delete

Delete a manifest in an Azure Container Registry.

Core Preview
az acr manifest list

List the manifests in a repository in an Azure Container Registry.

Core Preview
az acr manifest list-deleted

List the soft-deleted manifests in a repository in an Azure Container Registry.

Core Preview
az acr manifest list-deleted-tags

List the soft-deleted tags in a repository in an Azure Container Registry.

Core Preview
az acr manifest list-metadata

List the metadata of the manifests in a repository in an Azure Container Registry.

Core Preview
az acr manifest list-referrers

List the referrers to a manifest in an Azure Container Registry.

Core Preview
az acr manifest metadata

Manage artifact manifest metadata in Azure Container Registries.

Core Preview and Deprecated
az acr manifest metadata list

List the metadata of the manifests in a repository in an Azure Container Registry.

Core Preview and Deprecated
az acr manifest metadata show

Get the metadata of an artifact in an Azure Container Registry.

Core Preview and Deprecated
az acr manifest metadata update

Update the manifest metadata of an artifact in an Azure Container Registry.

Core Preview and Deprecated
az acr manifest restore

Restore a soft-deleted artifact and tag in an Azure Container Registry.

Core Preview
az acr manifest show

Get a manifest in an Azure Container Registry.

Core Preview
az acr manifest show-metadata

Get the metadata of an artifact in an Azure Container Registry.

Core Preview
az acr manifest update-metadata

Update the manifest metadata of an artifact in an Azure Container Registry.

Core Preview

az acr manifest delete

Preview

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

Delete a manifest in an Azure Container Registry.

az acr manifest delete [--name]
                       [--password]
                       [--registry]
                       [--suffix]
                       [--username]
                       [--yes]
                       [<MANIFEST_ID>]

Examples

Delete the manifest of the artifact 'hello-world:latest'.

az acr manifest delete -r myregistry -n hello-world:latest

Delete the manifest of the artifact 'hello-world:latest'.

az acr manifest delete myregistry.azurecr.io/hello-world:latest

Delete the manifest of the artifact referenced by digest 'hello-world@sha256:abc123'.

az acr manifest delete -r myregistry -n hello-world@sha256:abc123

Optional Parameters

--name -n

The name of the artifact. May include a tag in the format 'name:tag' or digest in the format 'name@digest'.

--password -p

The password used to log into a container registry.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

--suffix

The tenant suffix in registry login server. You may specify '--suffix tenant' if your registry login server is in the format 'registry-tenant.azurecr.io'. Applicable if you're accessing the registry from a different subscription or you have permission to access images but not the permission to manage the registry resource.

--username -u

The username used to log into a container registry.

--yes -y

Do not prompt for confirmation.

Default value: False
<MANIFEST_ID>

A fully qualified manifest specifier such as 'myregistry.azurecr.io/hello-world:latest'.

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

Preview

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

List the manifests in a repository in an Azure Container Registry.

az acr manifest list [--name]
                     [--orderby {time_asc, time_desc}]
                     [--password]
                     [--registry]
                     [--suffix]
                     [--top]
                     [--username]
                     [<REPO_ID>]

Examples

List the manifests of the repository 'hello-world'.

az acr manifest list -r myregistry -n hello-world

List the manifests of the repository 'hello-world'.

az acr manifest list myregistry.azurecr.io/hello-world

Optional Parameters

--name -n

The name of the repository.

--orderby

Order the items in the results. Default to alphabetical order of names.

Accepted values: time_asc, time_desc
--password -p

The password used to log into a container registry.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

--suffix

The tenant suffix in registry login server. You may specify '--suffix tenant' if your registry login server is in the format 'registry-tenant.azurecr.io'. Applicable if you're accessing the registry from a different subscription or you have permission to access images but not the permission to manage the registry resource.

--top

Limit the number of items in the results.

--username -u

The username used to log into a container registry.

<REPO_ID>

A fully qualified repository specifier such as 'myregistry.azurecr.io/hello-world'.

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 manifest list-deleted

Preview

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

List the soft-deleted manifests in a repository in an Azure Container Registry.

az acr manifest list-deleted [--name]
                             [--password]
                             [--registry]
                             [--suffix]
                             [--username]
                             [<REPO_ID>]

Examples

List the soft-deleted manifests in the repository 'hello-world'.

az acr manifest list-deleted -r myregistry -n hello-world

List the soft-deleted manifests in the repository 'hello-world'.

az acr manifest list-deleted myregistry.azurecr.io/hello-world

Optional Parameters

--name -n

The name of the repository.

--password -p

The password used to log into a container registry.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

--suffix

The tenant suffix in registry login server. You may specify '--suffix tenant' if your registry login server is in the format 'registry-tenant.azurecr.io'. Applicable if you're accessing the registry from a different subscription or you have permission to access images but not the permission to manage the registry resource.

--username -u

The username used to log into a container registry.

<REPO_ID>

A fully qualified repository specifier such as 'myregistry.azurecr.io/hello-world'.

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 manifest list-deleted-tags

Preview

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

List the soft-deleted tags in a repository in an Azure Container Registry.

az acr manifest list-deleted-tags [--name]
                                  [--password]
                                  [--registry]
                                  [--suffix]
                                  [--username]
                                  [<PERM_REPO_ID>]

Examples

List the soft-deleted tags in the repository 'hello-world'.

az acr manifest list-deleted-tags -r myregistry -n hello-world

List the soft-deleted tags in the repository 'hello-world'.

az acr manifest list-deleted-tags myregistry.azurecr.io/hello-world

List the soft-deleted tags that match tag 'latest' in the repository 'hello-world'.

az acr manifest list-deleted-tags -r myregistry -n hello-world:latest

List the soft-deleted tags that match tag 'latest' in the repository 'hello-world'.

az acr manifest list-deleted-tags myregistry.azurecr.io/hello-world:latest

Optional Parameters

--name -n

The name of the repository. May include a tag in the format 'name:tag'.

--password -p

The password used to log into a container registry.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

--suffix

The tenant suffix in registry login server. You may specify '--suffix tenant' if your registry login server is in the format 'registry-tenant.azurecr.io'. Applicable if you're accessing the registry from a different subscription or you have permission to access images but not the permission to manage the registry resource.

--username -u

The username used to log into a container registry.

<PERM_REPO_ID>

A fully qualified repository specifier such as 'myregistry.azurecr.io/hello-world'. May include a tag such as myregistry.azurecr.io/hello-world:latest.

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 manifest list-metadata

Preview

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

List the metadata of the manifests in a repository in an Azure Container Registry.

az acr manifest list-metadata [--name]
                              [--orderby {time_asc, time_desc}]
                              [--password]
                              [--registry]
                              [--suffix]
                              [--top]
                              [--username]
                              [<REPO_ID>]

Examples

List the metadata of the manifests in the repository 'hello-world'.

az acr manifest list-metadata -r myregistry -n hello-world

List the metadata of the manifests in the repository 'hello-world'.

az acr manifest list-metadata myregistry.azurecr.io/hello-world

Optional Parameters

--name -n

The name of the repository.

--orderby

Order the items in the results. Default to alphabetical order of names.

Accepted values: time_asc, time_desc
--password -p

The password used to log into a container registry.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

--suffix

The tenant suffix in registry login server. You may specify '--suffix tenant' if your registry login server is in the format 'registry-tenant.azurecr.io'. Applicable if you're accessing the registry from a different subscription or you have permission to access images but not the permission to manage the registry resource.

--top

Limit the number of items in the results.

--username -u

The username used to log into a container registry.

<REPO_ID>

A fully qualified repository specifier such as 'myregistry.azurecr.io/hello-world'.

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 manifest list-referrers

Preview

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

List the referrers to a manifest in an Azure Container Registry.

az acr manifest list-referrers [--artifact-type]
                               [--name]
                               [--password]
                               [--recursive]
                               [--registry]
                               [--suffix]
                               [--username]
                               [<MANIFEST_ID>]

Examples

List the referrers to the manifest of the artifact 'hello-world:latest'.

az acr manifest list-referrers -r myregistry -n hello-world:latest

List the referrers to the manifest of the artifact 'hello-world:latest'.

az acr manifest list-referrers myregistry.azurecr.io/hello-world:latest

List the referrers to the manifest of the artifact referenced by digest 'hello-world@sha256:abc123'.

az acr manifest list-referrers -r myregistry -n hello-world@sha256:abc123

Optional Parameters

--artifact-type

Filter referrers based on artifact type.

--name -n

The name of the artifact. May include a tag in the format 'name:tag' or digest in the format 'name@digest'.

--password -p

The password used to log into a container registry.

--recursive

Recursively include referrer artifacts.

Default value: False
--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

--suffix

The tenant suffix in registry login server. You may specify '--suffix tenant' if your registry login server is in the format 'registry-tenant.azurecr.io'. Applicable if you're accessing the registry from a different subscription or you have permission to access images but not the permission to manage the registry resource.

--username -u

The username used to log into a container registry.

<MANIFEST_ID>

A fully qualified manifest specifier such as 'myregistry.azurecr.io/hello-world:latest'.

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

Preview

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

Restore a soft-deleted artifact and tag in an Azure Container Registry.

az acr manifest restore [--digest]
                        [--force]
                        [--name]
                        [--password]
                        [--registry]
                        [--suffix]
                        [--username]
                        [--yes]
                        [<MANIFEST_ID>]

Examples

Restore the manifest matching digest 'sha256:abc123' with tag 'latest' in the repository 'hello-world'.

az acr manifest restore -r myregistry -n hello-world:latest -d sha256:abc123

Restore the manifest matching digest 'sha256:abc123' with tag 'latest' in the repository 'hello-world'.

az acr manifest restore myregistry.azurecr.io/hello-world:latest -d sha256:abc123

Restore the most recently deleted manifest associated with the tag 'latest' in the repository 'hello-world'.

az acr manifest restore -r myregistry -n hello-world:latest

Restore the most recently deleted manifest associated with the tag 'latest' in the repository 'hello-world'.

az acr manifest restore myregistry.azurecr.io/hello-world:latest

Optional Parameters

--digest -d

The digest of the manifest such as 'sha256@abc123'.

--force -f

Overwrite the existing tag.

Default value: False
--name -n

The name of the artifact. May include a tag in the format 'name:tag'.

--password -p

The password used to log into a container registry.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

--suffix

The tenant suffix in registry login server. You may specify '--suffix tenant' if your registry login server is in the format 'registry-tenant.azurecr.io'. Applicable if you're accessing the registry from a different subscription or you have permission to access images but not the permission to manage the registry resource.

--username -u

The username used to log into a container registry.

--yes -y

Do not prompt for confirmation.

Default value: False
<MANIFEST_ID>

A fully qualified manifest specifier such as 'myregistry.azurecr.io/hello-world:latest'.

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

Preview

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

Get a manifest in an Azure Container Registry.

az acr manifest show [--name]
                     [--password]
                     [--raw]
                     [--registry]
                     [--suffix]
                     [--username]
                     [<MANIFEST_ID>]

Examples

Get the manifest of the artifact 'hello-world:latest'.

az acr manifest show -r myregistry -n hello-world:latest

Get the manifest of the artifact 'hello-world:latest'.

az acr manifest show myregistry.azurecr.io/hello-world:latest

Get the manifest of the artifact referenced by digest 'hello-world@sha256:abc123'.

az acr manifest show -r myregistry -n hello-world@sha256:abc123

Get the raw, unformatted manifest of the artifact 'hello-world:latest'.

az acr manifest show -r myregistry -n hello-world:latest --raw

Optional Parameters

--name -n

The name of the artifact. May include a tag in the format 'name:tag' or digest in the format 'name@digest'.

--password -p

The password used to log into a container registry.

--raw

Output the raw manifest text with no formatting.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

--suffix

The tenant suffix in registry login server. You may specify '--suffix tenant' if your registry login server is in the format 'registry-tenant.azurecr.io'. Applicable if you're accessing the registry from a different subscription or you have permission to access images but not the permission to manage the registry resource.

--username -u

The username used to log into a container registry.

<MANIFEST_ID>

A fully qualified manifest specifier such as 'myregistry.azurecr.io/hello-world:latest'.

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 manifest show-metadata

Preview

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

Get the metadata of an artifact in an Azure Container Registry.

az acr manifest show-metadata [--name]
                              [--password]
                              [--registry]
                              [--suffix]
                              [--username]
                              [<MANIFEST_ID>]

Examples

Get the metadata of the tag 'hello-world:latest'.

az acr manifest show-metadata -r myregistry -n hello-world:latest

Get the metadata of the tag 'hello-world:latest'.

az acr manifest show-metadata myregistry.azurecr.io/hello-world:latest

Get the metadata of the manifest referenced by digest 'hello-world@sha256:abc123'.

az acr manifest show-metadata -r myregistry -n hello-world@sha256:abc123

Optional Parameters

--name -n

The name of the artifact. May include a tag in the format 'name:tag' or digest in the format 'name@digest'.

--password -p

The password used to log into a container registry.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

--suffix

The tenant suffix in registry login server. You may specify '--suffix tenant' if your registry login server is in the format 'registry-tenant.azurecr.io'. Applicable if you're accessing the registry from a different subscription or you have permission to access images but not the permission to manage the registry resource.

--username -u

The username used to log into a container registry.

<MANIFEST_ID>

A fully qualified manifest specifier such as 'myregistry.azurecr.io/hello-world:latest'.

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 manifest update-metadata

Preview

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

Update the manifest metadata of an artifact in an Azure Container Registry.

az acr manifest update-metadata [--delete-enabled {false, true}]
                                [--list-enabled {false, true}]
                                [--name]
                                [--password]
                                [--read-enabled {false, true}]
                                [--registry]
                                [--suffix]
                                [--username]
                                [--write-enabled {false, true}]
                                [<MANIFEST_ID>]

Examples

Update the metadata of the tag 'hello-world:latest'.

az acr manifest update-metadata -r myregistry -n hello-world:latest --write-enabled false

Update the metadata of the tag 'hello-world:latest'.

az acr manifest update-metadata myregistry.azurecr.io/hello-world:latest --write-enabled false

Update the metadata of the artifact referenced by digest 'hello-world@sha256:abc123'.

az acr manifest update-metadata -r myregistry -n hello-world@sha256:abc123 --write-enabled false

Optional Parameters

--delete-enabled

Indicate whether delete operation is allowed.

Accepted values: false, true
--list-enabled

Indicate whether this item shows in list operation results.

Accepted values: false, true
--name -n

The name of the artifact. May include a tag in the format 'name:tag' or digest in the format 'name@digest'.

--password -p

The password used to log into a container registry.

--read-enabled

Indicate whether read operation is allowed.

Accepted values: false, true
--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

--suffix

The tenant suffix in registry login server. You may specify '--suffix tenant' if your registry login server is in the format 'registry-tenant.azurecr.io'. Applicable if you're accessing the registry from a different subscription or you have permission to access images but not the permission to manage the registry resource.

--username -u

The username used to log into a container registry.

--write-enabled

Indicate whether write or delete operation is allowed.

Accepted values: false, true
<MANIFEST_ID>

A fully qualified manifest specifier such as 'myregistry.azurecr.io/hello-world:latest'.

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.