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

Microsoft.Storage storageAccounts/inventoryPolicies 2022-05-01

• 最新
• 2023-01-01
• 2022-09-01
• 2022-05-01
• 2021-09-01
• 2021-08-01
• 2021-06-01
• 2021-04-01
• 2021-02-01
• 2021-01-01

Bicep 资源定义

storageAccounts/inventoryPolicies 资源类型可以通过针对以下操作进行部署：

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

resource symbolicname 'Microsoft.Storage/storageAccounts/inventoryPolicies@2022-05-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'
    }
  }
}

属性值

storageAccounts/inventoryPolicies

名称	说明	值
name	资源名称 了解如何在 Bicep 中为子资源设置名称和类型。	“default”
父级 (parent)	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。	类型为资源的符号名称： storageAccounts
properties	返回存储帐户 Blob 清单策略规则。	BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

名称	说明	值
policy	存储帐户 Blob 清单策略对象。 它由策略规则组成。	BlobInventoryPolicySchema (必需)

BlobInventoryPolicySchema

名称	说明	值
enabled	如果设置为 true，则启用策略。	bool (必需)
规则	存储帐户 Blob 清单策略规则。 规则在启用时应用。	BlobInventoryPolicyRule[] (必需的)
类型	有效值为 Inventory	“库存” (必需)

BlobInventoryPolicyRule

名称	说明	值
定义	定义 Blob 清单策略规则的 对象。	需要 BlobInventoryPolicyDefinition ()
destination	存储 Blob 清单文件的容器名称。 必须预先创建。	字符串 (必需)
enabled	设置为 true 时启用规则。	bool (必需)
name	规则名称只能包含字母数字字符的任意组合。 规则名称区分大小写。 该名称必须在策略中唯一。	字符串 (必需)

BlobInventoryPolicyDefinition

名称	说明	值
筛选器	定义筛选器集的 对象。	BlobInventoryPolicyFilter
format	这是必填字段，它指定清单文件的格式。	“Csv” “Parquet” (必需)
objectType	这是必填字段。 此字段指定在 Blob 或容器级别创建的清单的范围。	“Blob” “Container” (必需)
schedule	这是必填字段。 此字段用于计划库存形成。	“每日” 需要“每周” ()
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、 DeletionId、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”仅对非 Hns 帐户有效。	string[] (必需)

BlobInventoryPolicyFilter

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

ARM 模板资源定义

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

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

{
  "type": "Microsoft.Storage/storageAccounts/inventoryPolicies",
  "apiVersion": "2022-05-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"
    }
  }
}

属性值

storageAccounts/inventoryPolicies

名称	说明	Value
type	资源类型	'Microsoft.Storage/storageAccounts/inventoryPolicies'
apiVersion	资源 API 版本	'2022-05-01'
name	资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。	'default'
properties	返回存储帐户 Blob 清单策略规则。	BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

名称	说明	值
policy	存储帐户 Blob 清单策略对象。 它由策略规则组成。	BlobInventoryPolicySchema (必需)

BlobInventoryPolicySchema

名称	说明	值
enabled	如果设置为 true，则启用策略。	需要 bool ()
规则	存储帐户 Blob 清单策略规则。 规则在启用时应用。	BlobInventoryPolicyRule[] (必需)
类型	有效值为 Inventory	需要“库存” ()

BlobInventoryPolicyRule

名称	说明	值
定义	一个定义 Blob 清单策略规则的 对象。	BlobInventoryPolicyDefinition (必需)
destination	存储 Blob 清单文件的容器名称。 必须预先创建。	字符串 (必需)
enabled	设置为 true 时启用规则。	需要 bool ()
name	规则名称只能包含字母数字字符的任意组合。 规则名称区分大小写。 该名称必须在策略中唯一。	字符串 (必需)

BlobInventoryPolicyDefinition

名称	说明	值
筛选器	定义筛选器集的 对象。	BlobInventoryPolicyFilter
format	这是必填字段，它指定清单文件的格式。	“Csv” “Parquet” (必需)
objectType	这是必填字段。 此字段指定在 Blob 或容器级别创建的清单的范围。	“Blob” “Container” (必需)
schedule	这是必填字段。 此字段用于计划库存形成。	“每日” 需要“每周” ()
schemaFields	这是必填字段。 此字段指定要包含在清单中的对象的字段和属性。 架构字段值“Name”始终是必需的。 “Blob”定义.objectType 的此字段的有效值包括“Name、Create-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”仅对非 Hns 帐户有效。	string[] (必需的)

BlobInventoryPolicyFilter

名称	说明	值
blobTypes	预定义枚举值的数组。 有效值包括 blockBlob、appendBlob、pageBlob。 Hns 帐户不支持 pageBlobs。 当 definition.objectType 属性设置为“Blob”时，此字段是必需的。	string[]
excludePrefix	要从清单中排除最多 10 个 blob 前缀的字符串数组。	string[]
includeBlobVersions	值设置为 true 时，包括 Blob 清单中的 Blob 版本。 如果此属性设置为 true，则需要 definition.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[]

Terraform (AzAPI 提供程序) 资源定义

storageAccounts/inventoryPolicies 资源类型可以通过针对以下操作进行部署：

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Storage/storageAccounts/inventoryPolicies@2022-05-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"
      }
    }
  })
}

属性值

storageAccounts/inventoryPolicies

名称	说明	Value
type	资源类型	“Microsoft.Storage/storageAccounts/inventoryPolicies@2022-05-01”
name	资源名称	"default"
parent_id	此资源的父资源 ID。	类型为：storageAccounts 的资源的 ID
properties	返回存储帐户 Blob 清单策略规则。	BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

名称	说明	值
policy	存储帐户 Blob 清单策略对象。 它由策略规则组成。	BlobInventoryPolicySchema (必需)

BlobInventoryPolicySchema

名称	说明	值
enabled	如果设置为 true，则启用策略。	bool (必需)
规则	存储帐户 Blob 清单策略规则。 规则在启用时应用。	BlobInventoryPolicyRule[] (必需)
类型	有效值为 Inventory	需要“库存” ()

BlobInventoryPolicyRule

名称	说明	值
定义	一个定义 Blob 清单策略规则的 对象。	BlobInventoryPolicyDefinition (必需)
destination	存储 Blob 清单文件的容器名称。 必须预先创建。	字符串 (必需)
enabled	设置为 true 时启用规则。	需要 bool ()
name	规则名称只能包含字母数字字符的任意组合。 规则名称区分大小写。 该名称必须在策略中唯一。	字符串 (必需)

BlobInventoryPolicyDefinition

名称	说明	值
筛选器	定义筛选器集的 对象。	BlobInventoryPolicyFilter
format	这是必填字段，它指定清单文件的格式。	“Csv” 需要“Parquet” ()
objectType	这是必填字段。 此字段指定在 Blob 或容器级别创建的清单的范围。	“Blob” 需要“容器” ()
schedule	这是必填字段。 此字段用于计划库存形成。	“每日” 需要“每周” ()
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、 DeletionId、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”仅对非 Hns 帐户有效。	string[] (必需)

BlobInventoryPolicyFilter

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