Share via

Microsoft.Storage storageAccounts/objectReplicationPolicies 2021-09-01

  • Article

Bicep resource definition

The storageAccounts/objectReplicationPolicies resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Storage/storageAccounts/objectReplicationPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-09-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    destinationAccount: 'string'
    rules: [
      {
        destinationContainer: 'string'
        filters: {
          minCreationTime: 'string'
          prefixMatch: [
            'string'
          ]
        }
        ruleId: 'string'
        sourceContainer: 'string'
      }
    ]
    sourceAccount: 'string'
  }
}

Property Values

Microsoft.Storage/storageAccounts/objectReplicationPolicies

Name Description Value
name The resource name string

Constraints:
Min length = 1 (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: storageAccounts
properties Returns the Storage Account Object Replication Policy. ObjectReplicationPolicyProperties

ObjectReplicationPolicyFilter

Name Description Value
minCreationTime 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 string
prefixMatch Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. string[]

ObjectReplicationPolicyProperties

Name Description Value
destinationAccount Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false. string (required)
rules The storage account object replication rules. ObjectReplicationPolicyRule[]
sourceAccount Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false. string (required)

ObjectReplicationPolicyRule

Name Description Value
destinationContainer Required. Destination container name. string (required)
filters Optional. An object that defines the filter set. ObjectReplicationPolicyFilter
ruleId Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. string
sourceContainer Required. Source container name. string (required)

ARM template resource definition

The storageAccounts/objectReplicationPolicies resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Storage/storageAccounts/objectReplicationPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.Storage/storageAccounts/objectReplicationPolicies",
  "apiVersion": "2021-09-01",
  "name": "string",
  "properties": {
    "destinationAccount": "string",
    "rules": [
      {
        "destinationContainer": "string",
        "filters": {
          "minCreationTime": "string",
          "prefixMatch": [ "string" ]
        },
        "ruleId": "string",
        "sourceContainer": "string"
      }
    ],
    "sourceAccount": "string"
  }
}

Property Values

Microsoft.Storage/storageAccounts/objectReplicationPolicies

Name Description Value
apiVersion The api version '2021-09-01'
name The resource name string

Constraints:
Min length = 1 (required)
properties Returns the Storage Account Object Replication Policy. ObjectReplicationPolicyProperties
type The resource type 'Microsoft.Storage/storageAccounts/objectReplicationPolicies'

ObjectReplicationPolicyFilter

Name Description Value
minCreationTime 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 string
prefixMatch Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. string[]

ObjectReplicationPolicyProperties

Name Description Value
destinationAccount Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false. string (required)
rules The storage account object replication rules. ObjectReplicationPolicyRule[]
sourceAccount Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false. string (required)

ObjectReplicationPolicyRule

Name Description Value
destinationContainer Required. Destination container name. string (required)
filters Optional. An object that defines the filter set. ObjectReplicationPolicyFilter
ruleId Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. string
sourceContainer Required. Source container name. string (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The storageAccounts/objectReplicationPolicies resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Storage/storageAccounts/objectReplicationPolicies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-09-01"
  name = "string"
  body = {
    properties = {
      destinationAccount = "string"
      rules = [
        {
          destinationContainer = "string"
          filters = {
            minCreationTime = "string"
            prefixMatch = [
              "string"
            ]
          }
          ruleId = "string"
          sourceContainer = "string"
        }
      ]
      sourceAccount = "string"
    }
  }
}

Property Values

Microsoft.Storage/storageAccounts/objectReplicationPolicies

Name Description Value
name The resource name string

Constraints:
Min length = 1 (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: storageAccounts
properties Returns the Storage Account Object Replication Policy. ObjectReplicationPolicyProperties
type The resource type "Microsoft.Storage/storageAccounts/objectReplicationPolicies@2021-09-01"

ObjectReplicationPolicyFilter

Name Description Value
minCreationTime 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 string
prefixMatch Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. string[]

ObjectReplicationPolicyProperties

Name Description Value
destinationAccount Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false. string (required)
rules The storage account object replication rules. ObjectReplicationPolicyRule[]
sourceAccount Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false. string (required)

ObjectReplicationPolicyRule

Name Description Value
destinationContainer Required. Destination container name. string (required)
filters Optional. An object that defines the filter set. ObjectReplicationPolicyFilter
ruleId Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. string
sourceContainer Required. Source container name. string (required)