Microsoft.Storage storageAccounts/inventoryPolicies 2023-01-01

Definição de recurso do Bicep

O tipo de recurso storageAccounts/inventoryPolicies pode ser implementado com operações que visam:

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

Formato do recurso

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

resource symbolicname 'Microsoft.Storage/storageAccounts/inventoryPolicies@2023-01-01' = {
  name: 'default'
  parent: resourceSymbolicName
  properties: {
    policy: {
      enabled: bool
      rules: [
        {
          definition: {
            filters: {
              blobTypes: [
                'string'
              ]
              creationTime: {
                lastNDays: int
              }
              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 subordinados no Bicep.
"predefinição"
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só precisa de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.
Nome simbólico para recurso do tipo: storageAccounts
propriedades Devolve as regras de política de inventário de blobs da conta de armazenamento. BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

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

BlobInventoryPolicySchema

Nome Descrição Valor
ativado A política está ativada se estiver definida como verdadeira. bool (obrigatório)
regras As regras de política de inventário de blobs da conta de armazenamento. A regra é aplicada quando está ativada. 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 blobs. BlobInventoryPolicyDefinition (obrigatório)
destino Nome do contentor onde os ficheiros de inventário de blobs são armazenados. Tem de ser pré-criado. cadeia (obrigatório)
ativado A regra é ativada quando definida como verdadeira. bool (obrigatório)
name Um nome de regra pode conter qualquer combinação de carateres numéricos alfa. O nome da regra é sensível às maiúsculas e minúsculas. Tem de ser exclusivo dentro de uma política. cadeia (obrigatório)

BlobInventoryPolicyDefinition

Nome Descrição Valor
filtros Um objeto que define o conjunto de filtros. BlobInventoryPolicyFilter
formato Este é um campo obrigatório, especifica o formato dos ficheiros de inventário. "Csv"
"Parquet" (obrigatório)
objectType Este é um campo obrigatório. Este campo especifica o âmbito do inventário criado ao nível do blob ou do contentor. "Blob"
"Contentor" (obrigatório)
agenda Este é um campo obrigatório. Este campo é utilizado para agendar uma formação de inventário. 'Diário'
"Semanal" (obrigatório)
schemaFields Este é um campo obrigatório. Este campo especifica os campos e propriedades do objeto a incluir no inventário. O valor do campo Esquema "Nome" é sempre necessário. Os valores válidos para este campo para a definição "Blob".objectType incluem "Nome, Criação-Hora, Última Modificação, Comprimento do Conteúdo, Conteúdo-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 apenas para contas ativadas por Hns. Os valores válidos para a definição "Contentor".objectType incluem "Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays". Os valores do campo de esquema "Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId" são válidos apenas para contas ativadas por Hns. Os valores do campo de esquema "Etiquetas, 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 numeração predefinidos. Os valores válidos incluem blockBlob, appendBlob, pageBlob. As contas Hns não suportam pageBlobs. Este campo é necessário quando a propriedade definition.objectType está definida como "Blob". cadeia[]
creationTime Esta propriedade é utilizada para filtrar objetos com base no tempo de criação do objeto BlobInventoryCreationTime
excludePrefix Uma matriz de cadeias com um máximo de 10 prefixos de blobs a serem excluídos do inventário. cadeia[]
includeBlobVersions Inclui versões de blobs no inventário de blobs quando o valor está definido como verdadeiro. Os valores definition.schemaFields "VersionId e IsCurrentVersion" são necessários se esta propriedade estiver definida como true, caso contrário, têm de ser excluídos. bool
includeDeleted Para a definição "Contentor".objectType, a definição.schemaFields tem de incluir "Deleted, Version, DeletedTime e RemainingRetentionDays". Para contas de armazenamento ativadas por "Blob".objectType e HNS, os campos definition.schema Têm de incluir "DeletionId, Deleted, DeletedTime e RemainingRetentionDays" e, para contas Hns desativadas, a definição.schemaFields tem de incluir "Delete and RemainingRetentionDays", caso contrário, tem de ser excluída. bool
includeSnapshots Inclui instantâneos de blobs no inventário de blobs quando o valor está definido como verdadeiro. O valor definition.schemaFields "Snapshot" é necessário se esta propriedade estiver definida como verdadeira, caso contrário, tem de ser excluída. bool
prefixMatch Uma matriz de cadeias com um máximo de 10 prefixos de blobs a incluir no inventário. cadeia[]

BlobInventoryCreationTime

Nome Descrição Valor
lastNDays Quando definir a política, filtra os objetos criados nos últimos N dias. Em que N é um valor inteiro entre 1 e 36500. int

Restrições:
Valor mínimo = 1
Valor máximo = 36500

Definição de recurso de modelo do ARM

O tipo de recurso storageAccounts/inventoryPolicies pode ser implementado com operações que visam:

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

Formato do recurso

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

{
  "type": "Microsoft.Storage/storageAccounts/inventoryPolicies",
  "apiVersion": "2023-01-01",
  "name": "default",
  "properties": {
    "policy": {
      "enabled": "bool",
      "rules": [
        {
          "definition": {
            "filters": {
              "blobTypes": [ "string" ],
              "creationTime": {
                "lastNDays": "int"
              },
              "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 '2023-01-01'
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos do ARM JSON.
"predefinição"
propriedades Devolve as regras de política de inventário de blobs da conta de armazenamento. BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

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

BlobInventoryPolicySchema

Nome Descrição Valor
ativado A política está ativada se estiver definida como verdadeira. bool (obrigatório)
regras As regras de política de inventário de blobs da conta de armazenamento. A regra é aplicada quando está ativada. 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 blobs. BlobInventoryPolicyDefinition (obrigatório)
destino Nome do contentor onde os ficheiros de inventário de blobs são armazenados. Tem de ser pré-criado. cadeia (obrigatório)
ativado A regra é ativada quando definida como verdadeira. bool (obrigatório)
name Um nome de regra pode conter qualquer combinação de carateres numéricos alfa. O nome da regra é sensível às maiúsculas e minúsculas. Tem de ser exclusivo dentro de uma política. cadeia (obrigatório)

BlobInventoryPolicyDefinition

Nome Descrição Valor
filtros Um objeto que define o conjunto de filtros. BlobInventoryPolicyFilter
formato Este é um campo obrigatório, especifica o formato dos ficheiros de inventário. 'Csv'
"Parquet" (obrigatório)
objectType Este é um campo obrigatório. Este campo especifica o âmbito do inventário criado ao nível do blob ou do contentor. 'Blob'
"Contentor" (obrigatório)
agenda Este é um campo obrigatório. Este campo é utilizado para agendar uma formação de inventário. "Diariamente"
"Semanal" (obrigatório)
schemaFields Este é um campo obrigatório. Este campo especifica os campos e propriedades do objeto a incluir no inventário. O valor do campo De esquema "Nome" é sempre obrigatório. Os valores válidos para este campo para a definição "Blob".objectType incluem "Nome, Tempo de Criação, Última Modificação, Comprimento do Conteúdo, 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 apenas a contas com Hns ativados. Os valores válidos para a definição "Contentor".objectType incluem "Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays". Os valores do campo de esquema "Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId" são válidos apenas para contas com Hns ativados. Os valores do campo de esquema "Etiquetas, 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 suportam pageBlobs. Este campo é necessário quando a propriedade definition.objectType está definida como "Blob". string[]
creationTime Esta propriedade é utilizada para filtrar objetos com base na hora de criação do objeto BlobInventoryCreationTime
excludePrefix Uma matriz de cadeias com um máximo de 10 prefixos de blobs a serem excluídos do inventário. string[]
includeBlobVersions Inclui versões de blobs no inventário de blobs quando o valor está definido como verdadeiro. Os valores definition.schemaFields "VersionId e IsCurrentVersion" são necessários se esta propriedade estiver definida como true, caso contrário, têm de ser excluídos. bool
includeDeleted Para a definição "Container".objectType, a definição.schemaFields tem de incluir "Deleted, Version, DeletedTime e RemainingRetentionDays". Para as contas de armazenamento ativadas por "Blob".objectType e HNS, os campos definition.schema têm de incluir "DeletionId, Deleted, DeletedTime e RemainingRetentionDays" e, para contas Hns desativadas, a definição.schemaFields tem de incluir "Deleted and RemainingRetentionDays", caso contrário, tem de ser excluída. bool
includeSnapshots Inclui instantâneos de blobs no inventário de blobs quando o valor está definido como verdadeiro. O valor definition.schemaFields "Snapshot" é necessário se esta propriedade estiver definida como true, caso contrário, tem de ser excluída. bool
prefixMatch Uma matriz de cadeias com um máximo de 10 prefixos de blobs a serem incluídos no inventário. string[]

BlobInventoryCreationTime

Nome Descrição Valor
lastNDays Quando definida, a política filtra os objetos criados nos últimos N dias. Em que N é um valor inteiro entre 1 e 36500. int

Restrições:
Valor mínimo = 1
Valor máximo = 36500

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso storageAccounts/inventoryPolicies pode ser implementado com operações que visam:

  • Grupos de recursos

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

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Storage/storageAccounts/inventoryPolicies@2023-01-01"
  name = "default"
  parent_id = "string"
  body = jsonencode({
    properties = {
      policy = {
        enabled = bool
        rules = [
          {
            definition = {
              filters = {
                blobTypes = [
                  "string"
                ]
                creationTime = {
                  lastNDays = int
                }
                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@2023-01-01"
name O nome do recurso "predefinição"
parent_id O ID do recurso que é o principal para este recurso. ID do recurso do tipo: storageAccounts
propriedades Devolve as regras de política de inventário de blobs da conta de armazenamento. BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

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

BlobInventoryPolicySchema

Nome Descrição Valor
ativado A política é ativada se estiver definida como verdadeira. bool (obrigatório)
regras As regras de política de inventário de blobs da conta de armazenamento. A regra é aplicada quando está ativada. 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 blobs. BlobInventoryPolicyDefinition (obrigatório)
destino Nome do contentor onde os ficheiros de inventário de blobs são armazenados. Tem de ser pré-criado. cadeia (obrigatório)
ativado A regra é ativada quando definida como verdadeira. bool (obrigatório)
name Um nome de regra pode conter qualquer combinação de carateres numéricos alfa. O nome da regra é sensível às maiúsculas e minúsculas. Tem de ser exclusivo dentro de uma política. cadeia (obrigatório)

BlobInventoryPolicyDefinition

Nome Descrição Valor
filtros Um objeto que define o conjunto de filtros. BlobInventoryPolicyFilter
formato Este é um campo obrigatório, especifica o formato dos ficheiros de inventário. "Csv"
"Parquet" (obrigatório)
objectType Este é um campo obrigatório. Este campo especifica o âmbito do inventário criado ao nível do blob ou do contentor. "Blob"
"Contentor" (obrigatório)
agenda Este é um campo obrigatório. Este campo é utilizado para agendar uma formação de inventário. "Diariamente"
"Semanal" (obrigatório)
schemaFields Este é um campo obrigatório. Este campo especifica os campos e propriedades do objeto a incluir no inventário. O valor do campo De esquema "Nome" é sempre obrigatório. Os valores válidos para este campo para a definição "Blob".objectType incluem "Nome, Tempo de Criação, Última Modificação, Comprimento do Conteúdo, 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 apenas a contas com Hns ativados. Os valores válidos para a definição "Contentor".objectType incluem "Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays". Os valores do campo de esquema "Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId" são válidos apenas para contas com Hns ativados. Os valores do campo de esquema "Etiquetas, 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 suportam pageBlobs. Este campo é necessário quando a propriedade definition.objectType está definida como "Blob". string[]
creationTime Esta propriedade é utilizada para filtrar objetos com base na hora de criação do objeto BlobInventoryCreationTime
excludePrefix Uma matriz de cadeias com um máximo de 10 prefixos de blobs a serem excluídos do inventário. string[]
includeBlobVersions Inclui versões de blobs no inventário de blobs quando o valor está definido como verdadeiro. Os valores definition.schemaFields "VersionId e IsCurrentVersion" são necessários se esta propriedade estiver definida como true, caso contrário, têm de ser excluídos. bool
includeDeleted Para a definição "Container".objectType, a definição.schemaFields tem de incluir "Deleted, Version, DeletedTime e RemainingRetentionDays". Para as contas de armazenamento ativadas por "Blob".objectType e HNS, os campos definition.schema têm de incluir "DeletionId, Deleted, DeletedTime e RemainingRetentionDays" e, para contas Hns desativadas, a definição.schemaFields tem de incluir "Deleted and RemainingRetentionDays", caso contrário, tem de ser excluída. bool
includeSnapshots Inclui instantâneos de blobs no inventário de blobs quando o valor está definido como verdadeiro. O valor definition.schemaFields "Snapshot" é necessário se esta propriedade estiver definida como true, caso contrário, tem de ser excluída. bool
prefixMatch Uma matriz de cadeias com um máximo de 10 prefixos de blobs a serem incluídos no inventário. string[]

BlobInventoryCreationTime

Nome Descrição Valor
lastNDays Quando definida, a política filtra os objetos criados nos últimos N dias. Em que N é um valor inteiro entre 1 e 36500. int

Restrições:
Valor mínimo = 1
Valor máximo = 36500