Microsoft.Storage storageAccounts/managementPolicies 2021-06-01

Bicep resource definition

The storageAccounts/managementPolicies 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/managementPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Storage/storageAccounts/managementPolicies@2021-06-01' = {
  name: 'default'
  parent: resourceSymbolicName
  properties: {
    policy: {
      rules: [
        {
          definition: {
            actions: {
              baseBlob: {
                delete: {
                  daysAfterLastAccessTimeGreaterThan: int
                  daysAfterModificationGreaterThan: int
                }
                enableAutoTierToHotFromCool: bool
                tierToArchive: {
                  daysAfterLastAccessTimeGreaterThan: int
                  daysAfterModificationGreaterThan: int
                }
                tierToCool: {
                  daysAfterLastAccessTimeGreaterThan: int
                  daysAfterModificationGreaterThan: int
                }
              }
              snapshot: {
                delete: {
                  daysAfterCreationGreaterThan: int
                }
                tierToArchive: {
                  daysAfterCreationGreaterThan: int
                }
                tierToCool: {
                  daysAfterCreationGreaterThan: int
                }
              }
              version: {
                delete: {
                  daysAfterCreationGreaterThan: int
                }
                tierToArchive: {
                  daysAfterCreationGreaterThan: int
                }
                tierToCool: {
                  daysAfterCreationGreaterThan: int
                }
              }
            }
            filters: {
              blobIndexMatch: [
                {
                  name: 'string'
                  op: 'string'
                  value: 'string'
                }
              ]
              blobTypes: [
                'string'
              ]
              prefixMatch: [
                'string'
              ]
            }
          }
          enabled: bool
          name: 'string'
          type: 'Lifecycle'
        }
      ]
    }
  }
}

Property values

storageAccounts/managementPolicies

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
'default'
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 Data Policies Rules. ManagementPolicyProperties

ManagementPolicyProperties

Name Description Value
policy The Storage Account ManagementPolicy, in JSON format. See more details in: /azure/storage/common/storage-lifecycle-managment-concepts. ManagementPolicySchema (required)

ManagementPolicySchema

Name Description Value
rules The Storage Account ManagementPolicies Rules. See more details in: /azure/storage/common/storage-lifecycle-managment-concepts. ManagementPolicyRule[] (required)

ManagementPolicyRule

Name Description Value
definition An object that defines the Lifecycle rule. ManagementPolicyDefinition (required)
enabled Rule is enabled if set to true. bool
name A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. string (required)
type The valid value is Lifecycle 'Lifecycle' (required)

ManagementPolicyDefinition

Name Description Value
actions An object that defines the action set. ManagementPolicyAction (required)
filters An object that defines the filter set. ManagementPolicyFilter

ManagementPolicyAction

Name Description Value
baseBlob The management policy action for base blob ManagementPolicyBaseBlob
snapshot The management policy action for snapshot ManagementPolicySnapShot
version The management policy action for version ManagementPolicyVersion

ManagementPolicyBaseBlob

Name Description Value
delete The function to delete the blob DateAfterModification
enableAutoTierToHotFromCool This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. bool
tierToArchive The function to tier blobs to archive storage. Support blobs currently at Hot or Cool tier DateAfterModification
tierToCool The function to tier blobs to cool storage. Support blobs currently at Hot tier DateAfterModification

DateAfterModification

Name Description Value
daysAfterLastAccessTimeGreaterThan Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy int

Constraints:
Min value = 0
daysAfterModificationGreaterThan Value indicating the age in days after last modification int

Constraints:
Min value = 0

ManagementPolicySnapShot

Name Description Value
delete The function to delete the blob snapshot DateAfterCreation
tierToArchive The function to tier blob snapshot to archive storage. Support blob snapshot currently at Hot or Cool tier DateAfterCreation
tierToCool The function to tier blob snapshot to cool storage. Support blob snapshot currently at Hot tier DateAfterCreation

DateAfterCreation

Name Description Value
daysAfterCreationGreaterThan Value indicating the age in days after creation int (required)

Constraints:
Min value = 0

ManagementPolicyVersion

Name Description Value
delete The function to delete the blob version DateAfterCreation
tierToArchive The function to tier blob version to archive storage. Support blob version currently at Hot or Cool tier DateAfterCreation
tierToCool The function to tier blob version to cool storage. Support blob version currently at Hot tier DateAfterCreation

ManagementPolicyFilter

Name Description Value
blobIndexMatch An array of blob index tag based filters, there can be at most 10 tag filters TagFilter[]
blobTypes An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. string[] (required)
prefixMatch An array of strings for prefixes to be match. string[]

TagFilter

Name Description Value
name This is the filter tag name, it can have 1 - 128 characters string (required)

Constraints:
Min length = 1
Max length = 128
op This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported string (required)
value This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters string (required)

Constraints:
Max length = 256

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Deploy Darktrace Autoscaling vSensors

Deploy to Azure
This template allows you to deploy an automatically autoscaling deployment of Darktrace vSensors

ARM template resource definition

The storageAccounts/managementPolicies 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/managementPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.Storage/storageAccounts/managementPolicies",
  "apiVersion": "2021-06-01",
  "name": "default",
  "properties": {
    "policy": {
      "rules": [
        {
          "definition": {
            "actions": {
              "baseBlob": {
                "delete": {
                  "daysAfterLastAccessTimeGreaterThan": "int",
                  "daysAfterModificationGreaterThan": "int"
                },
                "enableAutoTierToHotFromCool": "bool",
                "tierToArchive": {
                  "daysAfterLastAccessTimeGreaterThan": "int",
                  "daysAfterModificationGreaterThan": "int"
                },
                "tierToCool": {
                  "daysAfterLastAccessTimeGreaterThan": "int",
                  "daysAfterModificationGreaterThan": "int"
                }
              },
              "snapshot": {
                "delete": {
                  "daysAfterCreationGreaterThan": "int"
                },
                "tierToArchive": {
                  "daysAfterCreationGreaterThan": "int"
                },
                "tierToCool": {
                  "daysAfterCreationGreaterThan": "int"
                }
              },
              "version": {
                "delete": {
                  "daysAfterCreationGreaterThan": "int"
                },
                "tierToArchive": {
                  "daysAfterCreationGreaterThan": "int"
                },
                "tierToCool": {
                  "daysAfterCreationGreaterThan": "int"
                }
              }
            },
            "filters": {
              "blobIndexMatch": [
                {
                  "name": "string",
                  "op": "string",
                  "value": "string"
                }
              ],
              "blobTypes": [ "string" ],
              "prefixMatch": [ "string" ]
            }
          },
          "enabled": "bool",
          "name": "string",
          "type": "Lifecycle"
        }
      ]
    }
  }
}

Property values

storageAccounts/managementPolicies

Name Description Value
type The resource type 'Microsoft.Storage/storageAccounts/managementPolicies'
apiVersion The resource api version '2021-06-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
'default'
properties Returns the Storage Account Data Policies Rules. ManagementPolicyProperties

ManagementPolicyProperties

Name Description Value
policy The Storage Account ManagementPolicy, in JSON format. See more details in: /azure/storage/common/storage-lifecycle-managment-concepts. ManagementPolicySchema (required)

ManagementPolicySchema

Name Description Value
rules The Storage Account ManagementPolicies Rules. See more details in: /azure/storage/common/storage-lifecycle-managment-concepts. ManagementPolicyRule[] (required)

ManagementPolicyRule

Name Description Value
definition An object that defines the Lifecycle rule. ManagementPolicyDefinition (required)
enabled Rule is enabled if set to true. bool
name A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. string (required)
type The valid value is Lifecycle 'Lifecycle' (required)

ManagementPolicyDefinition

Name Description Value
actions An object that defines the action set. ManagementPolicyAction (required)
filters An object that defines the filter set. ManagementPolicyFilter

ManagementPolicyAction

Name Description Value
baseBlob The management policy action for base blob ManagementPolicyBaseBlob
snapshot The management policy action for snapshot ManagementPolicySnapShot
version The management policy action for version ManagementPolicyVersion

ManagementPolicyBaseBlob

Name Description Value
delete The function to delete the blob DateAfterModification
enableAutoTierToHotFromCool This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. bool
tierToArchive The function to tier blobs to archive storage. Support blobs currently at Hot or Cool tier DateAfterModification
tierToCool The function to tier blobs to cool storage. Support blobs currently at Hot tier DateAfterModification

DateAfterModification

Name Description Value
daysAfterLastAccessTimeGreaterThan Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy int

Constraints:
Min value = 0
daysAfterModificationGreaterThan Value indicating the age in days after last modification int

Constraints:
Min value = 0

ManagementPolicySnapShot

Name Description Value
delete The function to delete the blob snapshot DateAfterCreation
tierToArchive The function to tier blob snapshot to archive storage. Support blob snapshot currently at Hot or Cool tier DateAfterCreation
tierToCool The function to tier blob snapshot to cool storage. Support blob snapshot currently at Hot tier DateAfterCreation

DateAfterCreation

Name Description Value
daysAfterCreationGreaterThan Value indicating the age in days after creation int (required)

Constraints:
Min value = 0

ManagementPolicyVersion

Name Description Value
delete The function to delete the blob version DateAfterCreation
tierToArchive The function to tier blob version to archive storage. Support blob version currently at Hot or Cool tier DateAfterCreation
tierToCool The function to tier blob version to cool storage. Support blob version currently at Hot tier DateAfterCreation

ManagementPolicyFilter

Name Description Value
blobIndexMatch An array of blob index tag based filters, there can be at most 10 tag filters TagFilter[]
blobTypes An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. string[] (required)
prefixMatch An array of strings for prefixes to be match. string[]

TagFilter

Name Description Value
name This is the filter tag name, it can have 1 - 128 characters string (required)

Constraints:
Min length = 1
Max length = 128
op This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported string (required)
value This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters string (required)

Constraints:
Max length = 256

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Deploy Darktrace Autoscaling vSensors

Deploy to Azure
This template allows you to deploy an automatically autoscaling deployment of Darktrace vSensors

Terraform (AzAPI provider) resource definition

The storageAccounts/managementPolicies 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/managementPolicies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Storage/storageAccounts/managementPolicies@2021-06-01"
  name = "default"
  parent_id = "string"
  body = jsonencode({
    properties = {
      policy = {
        rules = [
          {
            definition = {
              actions = {
                baseBlob = {
                  delete = {
                    daysAfterLastAccessTimeGreaterThan = int
                    daysAfterModificationGreaterThan = int
                  }
                  enableAutoTierToHotFromCool = bool
                  tierToArchive = {
                    daysAfterLastAccessTimeGreaterThan = int
                    daysAfterModificationGreaterThan = int
                  }
                  tierToCool = {
                    daysAfterLastAccessTimeGreaterThan = int
                    daysAfterModificationGreaterThan = int
                  }
                }
                snapshot = {
                  delete = {
                    daysAfterCreationGreaterThan = int
                  }
                  tierToArchive = {
                    daysAfterCreationGreaterThan = int
                  }
                  tierToCool = {
                    daysAfterCreationGreaterThan = int
                  }
                }
                version = {
                  delete = {
                    daysAfterCreationGreaterThan = int
                  }
                  tierToArchive = {
                    daysAfterCreationGreaterThan = int
                  }
                  tierToCool = {
                    daysAfterCreationGreaterThan = int
                  }
                }
              }
              filters = {
                blobIndexMatch = [
                  {
                    name = "string"
                    op = "string"
                    value = "string"
                  }
                ]
                blobTypes = [
                  "string"
                ]
                prefixMatch = [
                  "string"
                ]
              }
            }
            enabled = bool
            name = "string"
            type = "Lifecycle"
          }
        ]
      }
    }
  })
}

Property values

storageAccounts/managementPolicies

Name Description Value
type The resource type "Microsoft.Storage/storageAccounts/managementPolicies@2021-06-01"
name The resource name "default"
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 Data Policies Rules. ManagementPolicyProperties

ManagementPolicyProperties

Name Description Value
policy The Storage Account ManagementPolicy, in JSON format. See more details in: /azure/storage/common/storage-lifecycle-managment-concepts. ManagementPolicySchema (required)

ManagementPolicySchema

Name Description Value
rules The Storage Account ManagementPolicies Rules. See more details in: /azure/storage/common/storage-lifecycle-managment-concepts. ManagementPolicyRule[] (required)

ManagementPolicyRule

Name Description Value
definition An object that defines the Lifecycle rule. ManagementPolicyDefinition (required)
enabled Rule is enabled if set to true. bool
name A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. string (required)
type The valid value is Lifecycle "Lifecycle" (required)

ManagementPolicyDefinition

Name Description Value
actions An object that defines the action set. ManagementPolicyAction (required)
filters An object that defines the filter set. ManagementPolicyFilter

ManagementPolicyAction

Name Description Value
baseBlob The management policy action for base blob ManagementPolicyBaseBlob
snapshot The management policy action for snapshot ManagementPolicySnapShot
version The management policy action for version ManagementPolicyVersion

ManagementPolicyBaseBlob

Name Description Value
delete The function to delete the blob DateAfterModification
enableAutoTierToHotFromCool This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. bool
tierToArchive The function to tier blobs to archive storage. Support blobs currently at Hot or Cool tier DateAfterModification
tierToCool The function to tier blobs to cool storage. Support blobs currently at Hot tier DateAfterModification

DateAfterModification

Name Description Value
daysAfterLastAccessTimeGreaterThan Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy int

Constraints:
Min value = 0
daysAfterModificationGreaterThan Value indicating the age in days after last modification int

Constraints:
Min value = 0

ManagementPolicySnapShot

Name Description Value
delete The function to delete the blob snapshot DateAfterCreation
tierToArchive The function to tier blob snapshot to archive storage. Support blob snapshot currently at Hot or Cool tier DateAfterCreation
tierToCool The function to tier blob snapshot to cool storage. Support blob snapshot currently at Hot tier DateAfterCreation

DateAfterCreation

Name Description Value
daysAfterCreationGreaterThan Value indicating the age in days after creation int (required)

Constraints:
Min value = 0

ManagementPolicyVersion

Name Description Value
delete The function to delete the blob version DateAfterCreation
tierToArchive The function to tier blob version to archive storage. Support blob version currently at Hot or Cool tier DateAfterCreation
tierToCool The function to tier blob version to cool storage. Support blob version currently at Hot tier DateAfterCreation

ManagementPolicyFilter

Name Description Value
blobIndexMatch An array of blob index tag based filters, there can be at most 10 tag filters TagFilter[]
blobTypes An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. string[] (required)
prefixMatch An array of strings for prefixes to be match. string[]

TagFilter

Name Description Value
name This is the filter tag name, it can have 1 - 128 characters string (required)

Constraints:
Min length = 1
Max length = 128
op This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported string (required)
value This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters string (required)

Constraints:
Max length = 256