Share via


az storage account or-policy rule

Command group 'storage account or-policy' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Object Replication Service Policy Rules.

Commands

Name Description Type Status
az storage account or-policy rule add

Add rule to the specified Object Replication Service Policy.

Core Preview
az storage account or-policy rule list

List all the rules in the specified Object Replication Service Policy.

Core Preview
az storage account or-policy rule remove

Remove the specified rule from the specified Object Replication Service Policy.

Core Preview
az storage account or-policy rule show

Show the properties of specified rule in Object Replication Service Policy.

Core Preview
az storage account or-policy rule update

Update rule properties to Object Replication Service Policy.

Core Preview

az storage account or-policy rule add

Preview

Command group 'storage account or-policy rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add rule to the specified Object Replication Service Policy.

az storage account or-policy rule add --account-name
                                      --destination-container
                                      --policy-id
                                      --source-container
                                      [--min-creation-time]
                                      [--prefix]
                                      [--resource-group]

Examples

Add rule to the specified Object Replication Service Policy.

az storage account or-policy rule add -g ResourceGroupName -n StorageAccountName --policy-id "04344ea7-aa3c-4846-bfb9-e908e32d3bf8" -d destContainer -s srcContainer

Required Parameters

--account-name -n

The storage account name.

--destination-container -d

The destination storage container name.

--policy-id

The ID of object replication policy or "default" if the policy ID is unknown. Policy Id will be auto-generated when setting on destination account. Required when setting on source account.

--source-container -s

The source storage container name.

Optional Parameters

--min-creation-time -t

Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z.

--prefix --prefix-match

Optional. Filter the results to replicate only blobs whose names begin with the specified prefix.

--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 storage account or-policy rule list

Preview

Command group 'storage account or-policy rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all the rules in the specified Object Replication Service Policy.

az storage account or-policy rule list --account-name
                                       --policy-id
                                       [--resource-group]

Examples

List all the rules in the specified Object Replication Service Policy.

az storage account or-policy rule list -g ResourceGroupName -n StorageAccountName --policy-id "04344ea7-aa3c-4846-bfb9-e908e32d3bf8"

Required Parameters

--account-name -n

The storage account name.

--policy-id

The ID of object replication policy or "default" if the policy ID is unknown. Policy Id will be auto-generated when setting on destination account. Required when setting on source account.

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 storage account or-policy rule remove

Preview

Command group 'storage account or-policy rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove the specified rule from the specified Object Replication Service Policy.

az storage account or-policy rule remove --account-name
                                         --policy-id
                                         --rule-id
                                         [--resource-group]

Examples

Remove the specified rule from the specified Object Replication Service Policy.

az storage account or-policy rule remove -g ResourceGroupName -n StorageAccountName --policy-id "04344ea7-aa3c-4846-bfb9-e908e32d3bf8" --rule-id "78746d86-d3b7-4397-a99c-0837e6741332"

Required Parameters

--account-name -n

The storage account name.

--policy-id

The ID of object replication policy or "default" if the policy ID is unknown. Policy Id will be auto-generated when setting on destination account. Required when setting on source account.

--rule-id -r

Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account.

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 storage account or-policy rule show

Preview

Command group 'storage account or-policy rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show the properties of specified rule in Object Replication Service Policy.

az storage account or-policy rule show --account-name
                                       --policy-id
                                       --rule-id
                                       [--resource-group]

Examples

Show the properties of specified rule in Object Replication Service Policy.

az storage account or-policy rule show -g ResourceGroupName -n StorageAccountName --policy-id "04344ea7-aa3c-4846-bfb9-e908e32d3bf8" --rule-id "78746d86-d3b7-4397-a99c-0837e6741332"

Required Parameters

--account-name -n

The storage account name.

--policy-id

The ID of object replication policy or "default" if the policy ID is unknown. Policy Id will be auto-generated when setting on destination account. Required when setting on source account.

--rule-id -r

Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account.

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 storage account or-policy rule update

Preview

Command group 'storage account or-policy rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update rule properties to Object Replication Service Policy.

az storage account or-policy rule update --account-name
                                         --policy-id
                                         --rule-id
                                         [--destination-container]
                                         [--min-creation-time]
                                         [--prefix]
                                         [--resource-group]
                                         [--source-container]

Examples

Update rule properties to Object Replication Service Policy.

az storage account or-policy rule update -g ResourceGroupName -n StorageAccountName --policy-id "04344ea7-aa3c-4846-bfb9-e908e32d3bf8" --rule-id "78746d86-d3b7-4397-a99c-0837e6741332" --prefix-match blobA blobB

Required Parameters

--account-name -n

The storage account name.

--policy-id

The ID of object replication policy or "default" if the policy ID is unknown. Policy Id will be auto-generated when setting on destination account. Required when setting on source account.

--rule-id -r

Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account.

Optional Parameters

--destination-container -d

The destination storage container name.

--min-creation-time -t

Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z.

--prefix --prefix-match

Optional. Filter the results to replicate only blobs whose names begin with the specified prefix.

--resource-group -g

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

--source-container -s

The source storage container 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.