az acr replication

  • Reference

Manage geo-replicated regions of Azure Container Registries.

Commands

Name Description Type Status
az acr replication create

Create a replicated region for an Azure Container Registry.

 Core GA
az acr replication delete

Delete a replicated region from an Azure Container Registry.

 Core GA
az acr replication list

List all of the regions for a geo-replicated Azure Container Registry.

 Core GA
az acr replication show

Get the details of a replicated region.

 Core GA
az acr replication update

Updates a replication.

 Core GA

az acr replication create

Edit

Create a replicated region for an Azure Container Registry.

az acr replication create --location
                          --registry
                          [--name]
                          [--region-endpoint-enabled {false, true}]
                          [--resource-group]
                          [--tags]
                          [--zone-redundancy {Disabled, Enabled}]

Examples

Create a replicated region for an Azure Container Registry.

az acr replication create -r myregistry -l westus

Create a replicated region for an Azure Container Registry. (autogenerated)

az acr replication create --location westus --registry myregistry --resource-group MyResourceGroup

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

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

--name -n

The name of the replication. Default to the location name.

--region-endpoint-enabled
Preview

Allow routing to this replication. Requests will not be routed to a disabled replication. Data syncing will continue regardless of the region endpoint status. Default: true.

accepted values: false, true
--resource-group -g

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--zone-redundancy
Preview

Indicates whether or not zone redundancy should be enabled for this registry or replication. For more information, such as supported locations, please visit https://aka.ms/acr/az. Zone-redundancy cannot be updated. Defaults to 'Disabled'.

accepted values: Disabled, Enabled
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 replication delete

Edit

Delete a replicated region from an Azure Container Registry.

az acr replication delete --name
                          --registry
                          [--resource-group]

Examples

Delete a replicated region from an Azure Container Registry.

az acr replication delete -n MyReplication -r myregistry

Required Parameters

--name -n

The name of the replication.

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

Edit

List all of the regions for a geo-replicated Azure Container Registry.

az acr replication list --registry
                        [--resource-group]

Examples

List replications and show the results in a table.

az acr replication list -r myregistry -o table

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

Edit

Get the details of a replicated region.

az acr replication show --name
                        --registry
                        [--resource-group]

Examples

Get the details of a replicated region

az acr replication show -n MyReplication -r myregistry

Required Parameters

--name -n

The name of the replication.

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

Edit

Updates a replication.

az acr replication update --name
                          --registry
                          [--add]
                          [--force-string]
                          [--region-endpoint-enabled {false, true}]
                          [--remove]
                          [--resource-group]
                          [--set]
                          [--tags]

Examples

Update tags for a replication

az acr replication update -n MyReplication -r myregistry --tags key1=value1 key2=value2

Updates a replication. (autogenerated)

az acr replication update --name MyReplication --registry myregistry --resource-group MyResourceGroup --tags key1=value1 key2=value2

Required Parameters

--name -n

The name of the replication.

--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
--region-endpoint-enabled
Preview

Allow routing to this replication. Requests will not be routed to a disabled replication. Data syncing will continue regardless of the region endpoint status.

accepted values: false, true
--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: []
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.