Share via

Microsoft.Storage storageAccounts/inventoryPolicies 2021-09-01

  • 發行項

Bicep 資源定義

storageAccounts/inventoryPolicies 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Storage/storageAccounts/inventoryPolicies 資源，請將下列 Bicep 新增至您的範本。

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

屬性值

storageAccounts/inventoryPolicies

名稱 描述 值
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。		 'default'
父系 (parent) 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增此屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱： storageAccounts
properties 傳回記憶體帳戶 Blob 清查原則規則。 BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

名稱 描述 值
原則 記憶體帳戶 Blob 清查原則物件。 它是由原則規則所組成。 BlobInventoryPolicySchema (必要)

BlobInventoryPolicySchema

名稱 描述 值
已啟用 如果設定為 true，則會啟用原則。 bool (必要)
規則 記憶體帳戶 Blob 清查原則規則。 規則會在啟用時套用。 BlobInventoryPolicyRule[] (必要)
類型 有效值為 Inventory 「清查」 (必要)

BlobInventoryPolicyRule

名稱 描述 值
定義 定義 Blob 清查原則規則的物件。 BlobInventoryPolicyDefinition (必要)
目的地 儲存 Blob 清查檔案的容器名稱。 必須預先建立。 需要字串 ()
已啟用 當設定為 true 時，會啟用規則。 bool (必要)
NAME 規則名稱可包含英數字元的任意組合。 規則名稱會區分大小寫。 該名稱在原則內必須是唯一的。 需要字串 ()

BlobInventoryPolicyDefinition

名稱 描述 值
filters 定義篩選集的物件。 BlobInventoryPolicyFilter
format 這是必要欄位，它會指定清查檔案的格式。 'Csv'
需要 『Parquet』 ()
objectType 這是必要的欄位。 此欄位會指定在 Blob 或容器層級建立的清查範圍。 'Blob'
需要 『Container』 ()
schedule 這是必要的欄位。 此欄位是用來排程清查的組成。 'Daily'
需要 『Weekly』 ()
schemaFields 這是必要的欄位。 此欄位會指定要包含在清查中的物件欄位和屬性。 一律需要架構域值 『Name』。 'Blob' 定義的有效字段值。objectType 包括 'Name、Creation-Time、Last-Modified、Content-Length、Content-MD5、 BlobType、AccessTierChangeTime、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[]
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[]

ARM 範本資源定義

storageAccounts/inventoryPolicies 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Storage/storageAccounts/inventoryPolicies 資源，請將下列 JSON 新增至範本。

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

屬性值

storageAccounts/inventoryPolicies

名稱 描述 值
類型 資源類型 'Microsoft.Storage/storageAccounts/inventoryPolicies'
apiVersion 資源 API 版本 '2021-09-01'
NAME 資源名稱

瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。		 'default'
properties 傳回記憶體帳戶 Blob 清查原則規則。 BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

名稱 描述 值
原則 記憶體帳戶 Blob 清查原則物件。 它是由原則規則所組成。 BlobInventoryPolicySchema (必要)

BlobInventoryPolicySchema

名稱 描述 值
已啟用 如果設定為 true，則會啟用原則。 bool (必要)
規則 記憶體帳戶 Blob 清查原則規則。 規則會在啟用時套用。 BlobInventoryPolicyRule[] (必要)
類型 有效值為 Inventory 「清查」 (必要)

BlobInventoryPolicyRule

名稱 描述 值
定義 定義 Blob 清查原則規則的物件。 BlobInventoryPolicyDefinition (必要)
目的地 儲存 Blob 清查檔案的容器名稱。 必須預先建立。 需要字串 ()
已啟用 當設定為 true 時，會啟用規則。 bool (必要)
NAME 規則名稱可包含英數字元的任意組合。 規則名稱會區分大小寫。 該名稱在原則內必須是唯一的。 需要字串 ()

BlobInventoryPolicyDefinition

名稱 描述 值
filters 定義篩選集的物件。 BlobInventoryPolicyFilter
format 這是必要欄位，它會指定清查檔案的格式。 'Csv'
需要 『Parquet』 ()
objectType 這是必要的欄位。 此欄位會指定在 Blob 或容器層級建立的清查範圍。 'Blob'
需要 『Container』 ()
schedule 這是必要的欄位。 此欄位是用來排程清查的組成。 'Daily'
需要 『Weekly』 ()
schemaFields 這是必要的欄位。 此欄位會指定要包含在清查中的物件欄位和屬性。 一律需要架構域值 『Name』。 'Blob' 定義的有效字段值。objectType 包括 'Name、Creation-Time、Last-Modified、Content-Length、Content-MD5、 BlobType、AccessTierChangeTime、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[]
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@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"
      }
    }
  })
}

屬性值

storageAccounts/inventoryPolicies

名稱 描述 值
類型 資源類型 “Microsoft.Storage/storageAccounts/inventoryPolicies@2021-09-01”
NAME 資源名稱 "default"
parent_id 此資源父系之資源的標識碼。 類型資源的標識碼： storageAccounts
properties 傳回記憶體帳戶 Blob 清查原則規則。 BlobInventoryPolicyProperties

BlobInventoryPolicyProperties

名稱 描述 值
原則 記憶體帳戶 Blob 清查原則物件。 它是由原則規則所組成。 BlobInventoryPolicySchema (必要)

BlobInventoryPolicySchema

名稱 描述 值
已啟用 如果設定為 true，則會啟用原則。 bool (必要)
規則 記憶體帳戶 Blob 清查原則規則。 規則會在啟用時套用。 BlobInventoryPolicyRule[] (必要)
類型 有效值為 Inventory 「清查」 (必要)

BlobInventoryPolicyRule

名稱 描述 值
定義 定義 Blob 清查原則規則的物件。 BlobInventoryPolicyDefinition (必要)
目的地 儲存 Blob 清查檔案的容器名稱。 必須預先建立。 需要字串 ()
已啟用 當設定為 true 時，會啟用規則。 bool (必要)
NAME 規則名稱可包含英數字元的任意組合。 規則名稱會區分大小寫。 該名稱在原則內必須是唯一的。 需要字串 ()

BlobInventoryPolicyDefinition

名稱 描述 值
filters 定義篩選集的物件。 BlobInventoryPolicyFilter
format 這是必要欄位，它會指定清查檔案的格式。 “Csv”
“Parquet” (必要)
objectType 這是必要的欄位。 此欄位會指定在 Blob 或容器層級建立的清查範圍。 “Blob”
“Container” (必要)
schedule 這是必要的欄位。 此欄位是用來排程清查的組成。 “每日”
「每周」 (必要)
schemaFields 這是必要的欄位。 此欄位會指定要包含在清查中的物件欄位和屬性。 一律需要架構域值 『Name』。 'Blob' 定義的有效字段值。objectType 包括 'Name、Creation-Time、Last-Modified、Content-Length、Content-MD5、 BlobType、AccessTierChangeTime、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[]
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[]