通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Storage storageAccounts/inventoryPolicies 2023-01-01

  • 项目

Bicep 资源定义

可以使用目标操作部署 storageAccounts/inventoryPolicies 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Storage/storageAccounts/inventoryPolicies 资源，请将以下 Bicep 添加到模板。

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'
    }
  }
}

属性值

storageAccounts/inventoryPolicies

名字 描述 价值
名字 资源名称

了解如何在 Bicep中设置子资源的名称和类型。		 “default”
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：storageAccounts
性能 返回存储帐户 Blob 清单策略规则。 BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

名字 描述 价值
政策 存储帐户 Blob 清单策略对象。 它由策略规则组成。 BlobInventoryPolicySchema （必需）

BlobInventoryPolicySchema

名字 描述 价值
启用 如果设置为 true，则启用策略。 bool （必需）
规则 存储帐户 Blob 清单策略规则。 启用规则时应用该规则。 BlobInventoryPolicyRule[] （必需）
类型 有效值为 Inventory “清单”（必需）

BlobInventoryPolicyRule

名字 描述 价值
定义 定义 Blob 清单策略规则的对象。 BlobInventoryPolicyDefinition （必需）
目的地 存储 blob 清单文件的容器名称。 必须预先创建。 string （必需）
启用 设置为 true 时启用规则。 bool （必需）
名字 规则名称可以包含字母数字字符的任意组合。 规则名称区分大小写。 它在策略中必须是唯一的。 string （必需）

BlobInventoryPolicyDefinition

名字 描述 价值
过滤 器 定义筛选器集的对象。 BlobInventoryPolicyFilter
格式 这是必填字段，它指定清单文件的格式。 “Csv”
“Parquet”（必需）
objectType 这是必填字段。 此字段指定在 Blob 或容器级别创建的清单的范围。 “Blob”
“Container”（必需）
附表 这是必填字段。 此字段用于计划库存形成。 “每日”
“每周”（必需）
schemaFields 这是必填字段。 此字段指定要包含在清单中的对象的字段和属性。 架构字段值“Name”始终是必需的。 “Blob”定义的此字段的有效值。objectType 包括“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、 DeleteId、DeletedTime、RemainingRetentionDays、ImmutabilityPolicyUntilDate、ImmutabilityPolicyMode、LegalHold、CopyId、CopyStatus、CopySource、CopyProgress、CopyCompletionTime、CopyStatusDescription、CustomerProvidedKeySha256、RehydratePriority、ArchiveStatus、XmsBlobSequenceNumber、EncryptionScope、IncrementalCopy、TagCount'。 对于 Blob 对象类型架构字段值“DeletedTime”仅适用于已启用 Hns 的帐户。 “Container”definition.objectType 的有效值包括“Name、Last-Modified、Metadata、LeaseStatus、LeaseState、LeaseDuration、PublicAccess、HasImmutabilityPolicy、HasLegalHold、Etag、DefaultEncryptionScope、DenyEncryptionScopeOverride、ImmutableStorageWithVersioningEnabled、Deleted、Version、DeletedTime、RemainingRetentionDays”。 架构字段值“Expiry-Time， hdi_isfolder， Owner， Group， Permissions， Acl， DeletionId” 仅适用于已启用 Hns 的帐户。架构字段值“Tags， TagCount”仅适用于 Non-Hns 帐户。 string[] （必需）

BlobInventoryPolicyFilter

名字 描述 价值
blobTypes 预定义枚举值的数组。 有效值包括 blockBlob、appendBlob、pageBlob。 Hns 帐户不支持 pageBlobs。 当 definition.objectType 属性设置为“Blob”时，此字段是必需的。 string[]
creationTime 此属性用于根据对象创建时间筛选对象 BlobInventoryCreationTime
excludePrefix 一个由最多 10 个 blob 前缀从清单中排除的字符串数组。 string[]
includeBlobVersions 当值设置为 true 时，在 Blob 清单中包含 Blob 版本。 如果此属性设置为 true，则定义.schemaFields 值“VersionId 和 IsCurrentVersion”是必需的，否则必须排除它们。 bool
includeDeleted 对于“Container”definition.objectType，definition.schemaFields 必须包括“Deleted、Version、DeletedTime 和 RemainingRetentionDays”。 对于“Blob”definition.objectType 和已启用 HNS 的存储帐户，definition.schemaFields 必须包括“DeleteId、Deleted、DeletedTime 和 RemainingRetentionDays”，对于 Hns 禁用的帐户，definition.schemaFields 必须包括“Deleted 和 RemainingRetentionDays”，否则必须排除。 bool
includeSnapshots 当值设置为 true 时，在 Blob 清单中包含 Blob 快照。 如果此属性设置为 true，则需要 definition.schemaFields 值“Snapshot”，否则必须排除它。 bool
prefixMatch 包含清单中最多 10 个 blob 前缀的字符串数组。 string[]

BlobInventoryCreationTime

名字 描述 价值
lastNDays 设置策略时会筛选过去 N 天内创建的对象。 其中 N 是介于 1 到 36500 之间的整数值。 int

约束：
最小值 = 1
最大值 = 36500

ARM 模板资源定义

可以使用目标操作部署 storageAccounts/inventoryPolicies 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Storage/storageAccounts/inventoryPolicies 资源，请将以下 JSON 添加到模板。

{
  "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"
    }
  }
}

属性值

storageAccounts/inventoryPolicies

名字 描述 价值
类型 资源类型 “Microsoft.Storage/storageAccounts/inventoryPolicies”
apiVersion 资源 API 版本 '2023-01-01'
名字 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。		 “default”
性能 返回存储帐户 Blob 清单策略规则。 BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

名字 描述 价值
政策 存储帐户 Blob 清单策略对象。 它由策略规则组成。 BlobInventoryPolicySchema （必需）

BlobInventoryPolicySchema

名字 描述 价值
启用 如果设置为 true，则启用策略。 bool （必需）
规则 存储帐户 Blob 清单策略规则。 启用规则时应用该规则。 BlobInventoryPolicyRule[] （必需）
类型 有效值为 Inventory “清单”（必需）

BlobInventoryPolicyRule

名字 描述 价值
定义 定义 Blob 清单策略规则的对象。 BlobInventoryPolicyDefinition （必需）
目的地 存储 blob 清单文件的容器名称。 必须预先创建。 string （必需）
启用 设置为 true 时启用规则。 bool （必需）
名字 规则名称可以包含字母数字字符的任意组合。 规则名称区分大小写。 它在策略中必须是唯一的。 string （必需）

BlobInventoryPolicyDefinition

名字 描述 价值
过滤 器 定义筛选器集的对象。 BlobInventoryPolicyFilter
格式 这是必填字段，它指定清单文件的格式。 “Csv”
“Parquet”（必需）
objectType 这是必填字段。 此字段指定在 Blob 或容器级别创建的清单的范围。 “Blob”
“Container”（必需）
附表 这是必填字段。 此字段用于计划库存形成。 “每日”
“每周”（必需）
schemaFields 这是必填字段。 此字段指定要包含在清单中的对象的字段和属性。 架构字段值“Name”始终是必需的。 “Blob”定义的此字段的有效值。objectType 包括“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、 DeleteId、DeletedTime、RemainingRetentionDays、ImmutabilityPolicyUntilDate、ImmutabilityPolicyMode、LegalHold、CopyId、CopyStatus、CopySource、CopyProgress、CopyCompletionTime、CopyStatusDescription、CustomerProvidedKeySha256、RehydratePriority、ArchiveStatus、XmsBlobSequenceNumber、EncryptionScope、IncrementalCopy、TagCount'。 对于 Blob 对象类型架构字段值“DeletedTime”仅适用于已启用 Hns 的帐户。 “Container”definition.objectType 的有效值包括“Name、Last-Modified、Metadata、LeaseStatus、LeaseState、LeaseDuration、PublicAccess、HasImmutabilityPolicy、HasLegalHold、Etag、DefaultEncryptionScope、DenyEncryptionScopeOverride、ImmutableStorageWithVersioningEnabled、Deleted、Version、DeletedTime、RemainingRetentionDays”。 架构字段值“Expiry-Time， hdi_isfolder， Owner， Group， Permissions， Acl， DeletionId” 仅适用于已启用 Hns 的帐户。架构字段值“Tags， TagCount”仅适用于 Non-Hns 帐户。 string[] （必需）

BlobInventoryPolicyFilter

名字 描述 价值
blobTypes 预定义枚举值的数组。 有效值包括 blockBlob、appendBlob、pageBlob。 Hns 帐户不支持 pageBlobs。 当 definition.objectType 属性设置为“Blob”时，此字段是必需的。 string[]
creationTime 此属性用于根据对象创建时间筛选对象 BlobInventoryCreationTime
excludePrefix 一个由最多 10 个 blob 前缀从清单中排除的字符串数组。 string[]
includeBlobVersions 当值设置为 true 时，在 Blob 清单中包含 Blob 版本。 如果此属性设置为 true，则定义.schemaFields 值“VersionId 和 IsCurrentVersion”是必需的，否则必须排除它们。 bool
includeDeleted 对于“Container”definition.objectType，definition.schemaFields 必须包括“Deleted、Version、DeletedTime 和 RemainingRetentionDays”。 对于“Blob”definition.objectType 和已启用 HNS 的存储帐户，definition.schemaFields 必须包括“DeleteId、Deleted、DeletedTime 和 RemainingRetentionDays”，对于 Hns 禁用的帐户，definition.schemaFields 必须包括“Deleted 和 RemainingRetentionDays”，否则必须排除。 bool
includeSnapshots 当值设置为 true 时，在 Blob 清单中包含 Blob 快照。 如果此属性设置为 true，则需要 definition.schemaFields 值“Snapshot”，否则必须排除它。 bool
prefixMatch 包含清单中最多 10 个 blob 前缀的字符串数组。 string[]

BlobInventoryCreationTime

名字 描述 价值
lastNDays 设置策略时会筛选过去 N 天内创建的对象。 其中 N 是介于 1 到 36500 之间的整数值。 int

约束：
最小值 = 1
最大值 = 36500

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 storageAccounts/inventoryPolicies 资源类型：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Storage/storageAccounts/inventoryPolicies 资源，请将以下 Terraform 添加到模板。

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"
      }
    }
  })
}

属性值

storageAccounts/inventoryPolicies

名字 描述 价值
类型 资源类型 “Microsoft.Storage/storageAccounts/inventoryPolicies@2023-01-01”
名字 资源名称 “default”
parent_id 此资源的父资源的 ID。 类型资源的 ID：storageAccounts
性能 返回存储帐户 Blob 清单策略规则。 BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

名字 描述 价值
政策 存储帐户 Blob 清单策略对象。 它由策略规则组成。 BlobInventoryPolicySchema （必需）

BlobInventoryPolicySchema

名字 描述 价值
启用 如果设置为 true，则启用策略。 bool （必需）
规则 存储帐户 Blob 清单策略规则。 启用规则时应用该规则。 BlobInventoryPolicyRule[] （必需）
类型 有效值为 Inventory “清单”（必需）

BlobInventoryPolicyRule

名字 描述 价值
定义 定义 Blob 清单策略规则的对象。 BlobInventoryPolicyDefinition （必需）
目的地 存储 blob 清单文件的容器名称。 必须预先创建。 string （必需）
启用 设置为 true 时启用规则。 bool （必需）
名字 规则名称可以包含字母数字字符的任意组合。 规则名称区分大小写。 它在策略中必须是唯一的。 string （必需）

BlobInventoryPolicyDefinition

名字 描述 价值
过滤 器 定义筛选器集的对象。 BlobInventoryPolicyFilter
格式 这是必填字段，它指定清单文件的格式。 “Csv”
“Parquet”（必需）
objectType 这是必填字段。 此字段指定在 Blob 或容器级别创建的清单的范围。 “Blob”
“容器”（必需）
附表 这是必填字段。 此字段用于计划库存形成。 “每日”
“每周”（必需）
schemaFields 这是必填字段。 此字段指定要包含在清单中的对象的字段和属性。 架构字段值“Name”始终是必需的。 “Blob”定义的此字段的有效值。objectType 包括“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、 DeleteId、DeletedTime、RemainingRetentionDays、ImmutabilityPolicyUntilDate、ImmutabilityPolicyMode、LegalHold、CopyId、CopyStatus、CopySource、CopyProgress、CopyCompletionTime、CopyStatusDescription、CustomerProvidedKeySha256、RehydratePriority、ArchiveStatus、XmsBlobSequenceNumber、EncryptionScope、IncrementalCopy、TagCount'。 对于 Blob 对象类型架构字段值“DeletedTime”仅适用于已启用 Hns 的帐户。 “Container”definition.objectType 的有效值包括“Name、Last-Modified、Metadata、LeaseStatus、LeaseState、LeaseDuration、PublicAccess、HasImmutabilityPolicy、HasLegalHold、Etag、DefaultEncryptionScope、DenyEncryptionScopeOverride、ImmutableStorageWithVersioningEnabled、Deleted、Version、DeletedTime、RemainingRetentionDays”。 架构字段值“Expiry-Time， hdi_isfolder， Owner， Group， Permissions， Acl， DeletionId” 仅适用于已启用 Hns 的帐户。架构字段值“Tags， TagCount”仅适用于 Non-Hns 帐户。 string[] （必需）

BlobInventoryPolicyFilter

名字 描述 价值
blobTypes 预定义枚举值的数组。 有效值包括 blockBlob、appendBlob、pageBlob。 Hns 帐户不支持 pageBlobs。 当 definition.objectType 属性设置为“Blob”时，此字段是必需的。 string[]
creationTime 此属性用于根据对象创建时间筛选对象 BlobInventoryCreationTime
excludePrefix 一个由最多 10 个 blob 前缀从清单中排除的字符串数组。 string[]
includeBlobVersions 当值设置为 true 时，在 Blob 清单中包含 Blob 版本。 如果此属性设置为 true，则定义.schemaFields 值“VersionId 和 IsCurrentVersion”是必需的，否则必须排除它们。 bool
includeDeleted 对于“Container”definition.objectType，definition.schemaFields 必须包括“Deleted、Version、DeletedTime 和 RemainingRetentionDays”。 对于“Blob”definition.objectType 和已启用 HNS 的存储帐户，definition.schemaFields 必须包括“DeleteId、Deleted、DeletedTime 和 RemainingRetentionDays”，对于 Hns 禁用的帐户，definition.schemaFields 必须包括“Deleted 和 RemainingRetentionDays”，否则必须排除。 bool
includeSnapshots 当值设置为 true 时，在 Blob 清单中包含 Blob 快照。 如果此属性设置为 true，则需要 definition.schemaFields 值“Snapshot”，否则必须排除它。 bool
prefixMatch 包含清单中最多 10 个 blob 前缀的字符串数组。 string[]

BlobInventoryCreationTime

名字 描述 价值
lastNDays 设置策略时会筛选过去 N 天内创建的对象。 其中 N 是介于 1 到 36500 之间的整数值。 int

约束：
最小值 = 1
最大值 = 36500