Microsoft.Storage storageAccounts/inventoryPolicies 2021-09-01

Definição de recurso do Bicep

O tipo de recurso storageAccounts/inventoryPolicies pode ser implantado com operações direcionadas:

Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Storage/storageAccounts/inventoryPolicies, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.Storage/storageAccounts/inventoryPolicies@2021-09-01' = {
  name: 'default'
  parent: resourceSymbolicName
  properties: {
    policy: {
      enabled: bool
      rules: [
        {
          definition: {
            filters: {
              blobTypes: [
                'string'
              ]
              excludePrefix: [
                'string'
              ]
              includeBlobVersions: bool
              includeDeleted: bool
              includeSnapshots: bool
              prefixMatch: [
                'string'
              ]
            }
            format: 'string'
            objectType: 'string'
            schedule: 'string'
            schemaFields: [
              'string'
            ]
          }
          destination: 'string'
          enabled: bool
          name: 'string'
        }
      ]
      type: 'Inventory'
    }
  }
}

Valores de propriedade

storageAccounts/inventoryPolicies

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.
'default'
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte Recurso filho fora do recurso pai.
Nome simbólico para o recurso do tipo: storageAccounts
properties Retorna as regras de política de inventário de blobs da conta de armazenamento. BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

Nome Descrição Valor
policy O objeto de política de inventário de blobs da conta de armazenamento. Ele é composto por regras de política. BlobInventoryPolicySchema (obrigatório)

BlobInventoryPolicySchema

Nome Descrição Valor
Habilitado A política será habilitada se definida como true. bool (obrigatório)
regras As regras de política de inventário de blob da conta de armazenamento. A regra é aplicada quando está habilitada. BlobInventoryPolicyRule[] (obrigatório)
tipo O valor válido é Inventory 'Inventory' (obrigatório)

BlobInventoryPolicyRule

Nome Descrição Valor
definição Um objeto que define a regra de política de inventário de blobs. BlobInventoryPolicyDefinition (obrigatório)
destino Nome do contêiner em que os arquivos de inventário de blob são armazenados. Deve ser pré-criado. cadeia de caracteres (obrigatório)
Habilitado A regra é habilitada quando definida como true. bool (obrigatório)
name Um nome de regra pode conter qualquer combinação de caracteres alfanuméricos. A regra de nome diferencia maiúsculas de minúsculas. Ela deve ser exclusiva em uma política. cadeia de caracteres (obrigatório)

BlobInventoryPolicyDefinition

Nome Descrição Valor
filtros Um objeto que define o conjunto de filtros. BlobInventoryPolicyFilter
format Esse é um campo obrigatório, que especifica o formato dos arquivos de inventário. 'Csv'
'Parquet' (obrigatório)
objectType Esse é um campo obrigatório. Esse campo especifica o escopo do inventário criado no nível do blob ou do contêiner. 'Blob'
'Container' (obrigatório)
schedule Esse é um campo obrigatório. Esse campo é usado para agendar uma formação de inventário. 'Diariamente'
'Semanal' (obrigatório)
schemaFields Esse é um campo obrigatório. Esse campo especifica os campos e as propriedades do objeto a ser incluído no inventário. O valor do campo Esquema 'Name' é sempre necessário. Os valores válidos para esse campo para a definição de 'Blob'.objectType incluem 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount'. Para o tipo de objeto Blob, o valor do campo de esquema 'DeletedTime' é aplicável somente para contas habilitadas para Hns. Os valores válidos para 'Container' definition.objectType incluem 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays'. Os valores de campo de esquema 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId' são válidos apenas para contas habilitadas para Hns. Os valores de campo de esquema 'Tags, TagCount' só são válidos para contas não Hns. string[] (obrigatório)

BlobInventoryPolicyFilter

Nome Descrição Valor
blobTypes Uma matriz de valores de enumeração predefinidos. Os valores válidos incluem blockBlob, appendBlob, pageBlob. As contas Hns não dão suporte a pageBlobs. Esse campo é necessário quando a propriedade definition.objectType é definida como 'Blob'. string[]
excludePrefix Uma matriz de cadeias de caracteres com no máximo 10 prefixos de blob a serem excluídos do inventário. string[]
includeBlobVersions Inclui versões de blob no inventário de blobs quando o valor é definido como true. Os valores definition.schemaFields 'VersionId e IsCurrentVersion' serão necessários se essa propriedade for definida como true, caso contrário, elas deverão ser excluídas. bool
includeDeleted Para 'Container' definition.objectType, o definition.schemaFields deve incluir 'Deleted, Version, DeletedTime e RemainingRetentionDays'. Para contas de armazenamento habilitadas para 'Blob', objectType e HNS, o definition.schemaFields deve incluir 'DeletionId, Deleted, DeletedTime e RemainingRetentionDays' e, para contas desabilitadas do Hns, o definition.schemaFields deve incluir 'Deleted e RemainingRetentionDays', caso contrário, ele deve ser excluído. bool
includeSnapshots Inclui instantâneos de blob no inventário de blobs quando o valor é definido como true. O valor definition.schemaFields 'Snapshot' será necessário se essa propriedade estiver definida como true, caso contrário, ela deverá ser excluída. bool
prefixMatch Uma matriz de cadeias de caracteres com no máximo 10 prefixos de blob a serem incluídos no inventário. string[]

Definição de recurso de modelo do ARM

O tipo de recurso storageAccounts/inventoryPolicies pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Storage/storageAccounts/inventoryPolicies, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.Storage/storageAccounts/inventoryPolicies",
  "apiVersion": "2021-09-01",
  "name": "default",
  "properties": {
    "policy": {
      "enabled": "bool",
      "rules": [
        {
          "definition": {
            "filters": {
              "blobTypes": [ "string" ],
              "excludePrefix": [ "string" ],
              "includeBlobVersions": "bool",
              "includeDeleted": "bool",
              "includeSnapshots": "bool",
              "prefixMatch": [ "string" ]
            },
            "format": "string",
            "objectType": "string",
            "schedule": "string",
            "schemaFields": [ "string" ]
          },
          "destination": "string",
          "enabled": "bool",
          "name": "string"
        }
      ],
      "type": "Inventory"
    }
  }
}

Valores de propriedade

storageAccounts/inventoryPolicies

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.Storage/storageAccounts/inventoryPolicies'
apiVersion A versão da API de recursos '2021-09-01'
name O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.
'default'
properties Retorna as regras de política de inventário de blobs da conta de armazenamento. BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

Nome Descrição Valor
policy O objeto de política de inventário de blobs da conta de armazenamento. Ele é composto por regras de política. BlobInventoryPolicySchema (obrigatório)

BlobInventoryPolicySchema

Nome Descrição Valor
Habilitado A política será habilitada se definida como true. bool (obrigatório)
regras As regras de política de inventário de blobs da conta de armazenamento. A regra é aplicada quando está habilitada. BlobInventoryPolicyRule[] (obrigatório)
tipo O valor válido é Inventário 'Inventory' (obrigatório)

BlobInventoryPolicyRule

Nome Descrição Valor
definição Um objeto que define a regra de política de inventário de blob. BlobInventoryPolicyDefinition (obrigatório)
destino Nome do contêiner em que os arquivos de inventário de blob são armazenados. Deve ser pré-criado. cadeia de caracteres (obrigatório)
Habilitado A regra é habilitada quando definida como true. bool (obrigatório)
name Um nome de regra pode conter qualquer combinação de caracteres alfanuméricos. A regra de nome diferencia maiúsculas de minúsculas. Ela deve ser exclusiva em uma política. cadeia de caracteres (obrigatório)

BlobInventoryPolicyDefinition

Nome Descrição Valor
filtros Um objeto que define o conjunto de filtros. BlobInventoryPolicyFilter
format Esse é um campo obrigatório, que especifica o formato dos arquivos de inventário. 'Csv'
'Parquet' (obrigatório)
objectType Esse é um campo obrigatório. Esse campo especifica o escopo do inventário criado no nível do blob ou do contêiner. 'Blob'
'Container' (obrigatório)
schedule Esse é um campo obrigatório. Esse campo é usado para agendar uma formação de inventário. 'Diário'
'Weekly' (obrigatório)
schemaFields Esse é um campo obrigatório. Esse campo especifica os campos e as propriedades do objeto a ser incluído no inventário. O valor do campo Esquema 'Name' é sempre necessário. Os valores válidos para esse campo para a definição de 'Blob'.objectType incluem 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount'. Para o tipo de objeto Blob, o valor do campo de esquema 'DeletedTime' é aplicável somente para contas habilitadas para Hns. Os valores válidos para 'Container' definition.objectType incluem 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays'. Os valores de campo de esquema 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId' são válidos apenas para contas habilitadas para Hns. Os valores de campo de esquema 'Tags, TagCount' só são válidos para contas não Hns. string[] (obrigatório)

BlobInventoryPolicyFilter

Nome Descrição Valor
blobTypes Uma matriz de valores de enumeração predefinidos. Os valores válidos incluem blockBlob, appendBlob, pageBlob. As contas Hns não dão suporte a pageBlobs. Esse campo é necessário quando a propriedade definition.objectType é definida como 'Blob'. string[]
excludePrefix Uma matriz de cadeias de caracteres com no máximo 10 prefixos de blob a serem excluídos do inventário. string[]
includeBlobVersions Inclui versões de blob no inventário de blobs quando o valor é definido como true. Os valores definition.schemaFields 'VersionId e IsCurrentVersion' serão necessários se essa propriedade for definida como true, caso contrário, elas deverão ser excluídas. bool
includeDeleted Para 'Container' definition.objectType, o definition.schemaFields deve incluir 'Deleted, Version, DeletedTime e RemainingRetentionDays'. Para contas de armazenamento habilitadas para 'Blob', objectType e HNS, o definition.schemaFields deve incluir 'DeletionId, Deleted, DeletedTime e RemainingRetentionDays' e, para contas desabilitadas do Hns, o definition.schemaFields deve incluir 'Deleted e RemainingRetentionDays', caso contrário, ele deve ser excluído. bool
includeSnapshots Inclui instantâneos de blob no inventário de blobs quando o valor é definido como true. O valor definition.schemaFields 'Snapshot' será necessário se essa propriedade estiver definida como true, caso contrário, ela deverá ser excluída. bool
prefixMatch Uma matriz de cadeias de caracteres com no máximo 10 prefixos de blob a serem incluídos no inventário. string[]

Definição de recurso do Terraform (provedor AzAPI)

O tipo de recurso storageAccounts/inventoryPolicies pode ser implantado com operações direcionadas:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Storage/storageAccounts/inventoryPolicies, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Storage/storageAccounts/inventoryPolicies@2021-09-01"
  name = "default"
  parent_id = "string"
  body = jsonencode({
    properties = {
      policy = {
        enabled = bool
        rules = [
          {
            definition = {
              filters = {
                blobTypes = [
                  "string"
                ]
                excludePrefix = [
                  "string"
                ]
                includeBlobVersions = bool
                includeDeleted = bool
                includeSnapshots = bool
                prefixMatch = [
                  "string"
                ]
              }
              format = "string"
              objectType = "string"
              schedule = "string"
              schemaFields = [
                "string"
              ]
            }
            destination = "string"
            enabled = bool
            name = "string"
          }
        ]
        type = "Inventory"
      }
    }
  })
}

Valores de propriedade

storageAccounts/inventoryPolicies

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Storage/storageAccounts/inventoryPolicies@2021-09-01"
name O nome do recurso "default"
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: storageAccounts
properties Retorna as regras de política de inventário de blobs da conta de armazenamento. BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

Nome Descrição Valor
policy O objeto de política de inventário de blobs da conta de armazenamento. Ele é composto por regras de política. BlobInventoryPolicySchema (obrigatório)

BlobInventoryPolicySchema

Nome Descrição Valor
Habilitado A política será habilitada se definida como true. bool (obrigatório)
regras As regras de política de inventário de blobs da conta de armazenamento. A regra é aplicada quando está habilitada. BlobInventoryPolicyRule[] (obrigatório)
tipo O valor válido é Inventário "Inventário" (obrigatório)

BlobInventoryPolicyRule

Nome Descrição Valor
definição Um objeto que define a regra de política de inventário de blob. BlobInventoryPolicyDefinition (obrigatório)
destino Nome do contêiner em que os arquivos de inventário de blob são armazenados. Deve ser pré-criado. cadeia de caracteres (obrigatório)
Habilitado A regra é habilitada quando definida como true. bool (obrigatório)
name Um nome de regra pode conter qualquer combinação de caracteres alfanuméricos. A regra de nome diferencia maiúsculas de minúsculas. Ela deve ser exclusiva em uma política. cadeia de caracteres (obrigatório)

BlobInventoryPolicyDefinition

Nome Descrição Valor
filtros Um objeto que define o conjunto de filtros. BlobInventoryPolicyFilter
format Esse é um campo obrigatório, que especifica o formato dos arquivos de inventário. "Csv"
"Parquet" (obrigatório)
objectType Esse é um campo obrigatório. Esse campo especifica o escopo do inventário criado no nível do blob ou do contêiner. "Blob"
"Contêiner" (obrigatório)
schedule Esse é um campo obrigatório. Esse campo é usado para agendar uma formação de inventário. "Diário"
"Semanal" (obrigatório)
schemaFields Esse é um campo obrigatório. Esse campo especifica os campos e as propriedades do objeto a ser incluído no inventário. O valor do campo Esquema 'Name' é sempre necessário. Os valores válidos para esse campo para a definição de 'Blob'.objectType incluem 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount'. Para o tipo de objeto Blob, o valor do campo de esquema 'DeletedTime' é aplicável somente para contas habilitadas para Hns. Os valores válidos para 'Container' definition.objectType incluem 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays'. Os valores de campo de esquema 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId' são válidos apenas para contas habilitadas para Hns. Os valores de campo de esquema 'Tags, TagCount' só são válidos para contas não Hns. string[] (obrigatório)

BlobInventoryPolicyFilter

Nome Descrição Valor
blobTypes Uma matriz de valores de enumeração predefinidos. Os valores válidos incluem blockBlob, appendBlob, pageBlob. As contas Hns não dão suporte a pageBlobs. Esse campo é necessário quando a propriedade definition.objectType é definida como 'Blob'. string[]
excludePrefix Uma matriz de cadeias de caracteres com no máximo 10 prefixos de blob a serem excluídos do inventário. string[]
includeBlobVersions Inclui versões de blob no inventário de blobs quando o valor é definido como true. Os valores definition.schemaFields 'VersionId e IsCurrentVersion' serão necessários se essa propriedade for definida como true, caso contrário, elas deverão ser excluídas. bool
includeDeleted Para 'Container' definition.objectType, o definition.schemaFields deve incluir 'Deleted, Version, DeletedTime e RemainingRetentionDays'. Para contas de armazenamento habilitadas para 'Blob', objectType e HNS, o definition.schemaFields deve incluir 'DeletionId, Deleted, DeletedTime e RemainingRetentionDays' e, para contas desabilitadas do Hns, o definition.schemaFields deve incluir 'Deleted e RemainingRetentionDays', caso contrário, ele deve ser excluído. bool
includeSnapshots Inclui instantâneos de blob no inventário de blobs quando o valor é definido como true. O valor definition.schemaFields 'Snapshot' será necessário se essa propriedade estiver definida como true, caso contrário, ela deverá ser excluída. bool
prefixMatch Uma matriz de cadeias de caracteres com no máximo 10 prefixos de blob a serem incluídos no inventário. string[]