Microsoft.Storage storageAccounts/inventoryPolicies 2022-09-01
Bicep 資源定義
storageAccounts/inventoryPolicies 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Storage/storageAccounts/inventoryPolicies 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Storage/storageAccounts/inventoryPolicies@2022-09-01' = {
parent: resourceSymbolicName
name: 'string'
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: 'string'
}
}
}
屬性值
BlobInventoryPolicyDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| 過濾器 | 定義篩選集的物件。 | BlobInventoryPolicyFilter |
| 格式 | 這是必要欄位，它會指定清查檔案的格式。 | 'Csv' 'Parquet' （必要） |
| objectType | 這是必要欄位。 此欄位會指定在 Blob 或容器層級建立的清查範圍。 | 'Blob' 'Container' （必要） |
| 附表 | 這是必要欄位。 此欄位可用來排程清查形成。 | 'Daily' 'Weekly' （必要） |
| 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[] |
| 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 停用的帳戶，schemaFields 必須包含 'Deleted 和 RemainingRetentionDays'，否則必須排除。 | bool |
| includeSnapshots | 當值設定為 true 時，在 Blob 清查中包含 Blob 快照集。 如果此屬性設定為 true，則需要 definition.schemaFields 值 'Snapshot'，否則必須排除它。 | bool |
| prefixMatch | 包含最多 10 個 Blob 前置詞的字串數位。 | string[] |
BlobInventoryPolicyProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 政策 | 記憶體帳戶 Blob 清查原則物件。 它是由原則規則所組成。 | BlobInventoryPolicySchema （必要） |
BlobInventoryPolicyRule
| 名字 | 描述 | 價值 |
|---|---|---|
| 定義 | 定義 Blob 清查原則規則的物件。 | BlobInventoryPolicyDefinition （必要） |
| 目的地 | 儲存 Blob 清查檔案的容器名稱。 必須預先建立。 | 字串 （必要） |
| 啟用 | 當設定為 true 時，會啟用規則。 | 布林 （必要） |
| 名字 | 規則名稱可以包含任意組合的英數位元。 規則名稱區分大小寫。 它在原則內必須是唯一的。 | 字串 （必要） |
BlobInventoryPolicySchema
| 名字 | 描述 | 價值 |
|---|---|---|
| 啟用 | 如果設定為 true，則會啟用原則。 | 布林 （必要） |
| 規則 | 記憶體帳戶 Blob 清查原則規則。 規則會在啟用時套用。 | BlobInventoryPolicyRule[] （必要） |
| 類型 | 有效值為 Inventory | 'Inventory' （必要） |
Microsoft.Storage/storageAccounts/inventoryPolicies
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 'default' （必要） |
| 父母 | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型的資源符號名稱：storageAccounts |
| 性能 | 傳回記憶體帳戶 Blob 清查原則規則。 | BlobInventoryPolicyProperties |
ARM 樣本資源定義
storageAccounts/inventoryPolicies 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Storage/storageAccounts/inventoryPolicies 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.Storage/storageAccounts/inventoryPolicies",
"apiVersion": "2022-09-01",
"name": "string",
"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": "string"
}
}
}
屬性值
BlobInventoryPolicyDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| 過濾器 | 定義篩選集的物件。 | BlobInventoryPolicyFilter |
| 格式 | 這是必要欄位，它會指定清查檔案的格式。 | 'Csv' 'Parquet' （必要） |
| objectType | 這是必要欄位。 此欄位會指定在 Blob 或容器層級建立的清查範圍。 | 'Blob' 'Container' （必要） |
| 附表 | 這是必要欄位。 此欄位可用來排程清查形成。 | 'Daily' 'Weekly' （必要） |
| 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[] |
| 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 停用的帳戶，schemaFields 必須包含 'Deleted 和 RemainingRetentionDays'，否則必須排除。 | bool |
| includeSnapshots | 當值設定為 true 時，在 Blob 清查中包含 Blob 快照集。 如果此屬性設定為 true，則需要 definition.schemaFields 值 'Snapshot'，否則必須排除它。 | bool |
| prefixMatch | 包含最多 10 個 Blob 前置詞的字串數位。 | string[] |
BlobInventoryPolicyProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 政策 | 記憶體帳戶 Blob 清查原則物件。 它是由原則規則所組成。 | BlobInventoryPolicySchema （必要） |
BlobInventoryPolicyRule
| 名字 | 描述 | 價值 |
|---|---|---|
| 定義 | 定義 Blob 清查原則規則的物件。 | BlobInventoryPolicyDefinition （必要） |
| 目的地 | 儲存 Blob 清查檔案的容器名稱。 必須預先建立。 | 字串 （必要） |
| 啟用 | 當設定為 true 時，會啟用規則。 | 布林 （必要） |
| 名字 | 規則名稱可以包含任意組合的英數位元。 規則名稱區分大小寫。 它在原則內必須是唯一的。 | 字串 （必要） |
BlobInventoryPolicySchema
| 名字 | 描述 | 價值 |
|---|---|---|
| 啟用 | 如果設定為 true，則會啟用原則。 | 布林 （必要） |
| 規則 | 記憶體帳戶 Blob 清查原則規則。 規則會在啟用時套用。 | BlobInventoryPolicyRule[] （必要） |
| 類型 | 有效值為 Inventory | 'Inventory' （必要） |
Microsoft.Storage/storageAccounts/inventoryPolicies
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2022-09-01' |
| 名字 | 資源名稱 | 'default' （必要） |
| 性能 | 傳回記憶體帳戶 Blob 清查原則規則。 | BlobInventoryPolicyProperties |
| 類型 | 資源類型 | 'Microsoft.Storage/storageAccounts/inventoryPolicies' |
Terraform （AzAPI 提供者） 資源定義
storageAccounts/inventoryPolicies 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Storage/storageAccounts/inventoryPolicies 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Storage/storageAccounts/inventoryPolicies@2022-09-01"
name = "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 = "string"
}
}
})
}
屬性值
BlobInventoryPolicyDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| 過濾器 | 定義篩選集的物件。 | BlobInventoryPolicyFilter |
| 格式 | 這是必要欄位，它會指定清查檔案的格式。 | 'Csv' 'Parquet' （必要） |
| objectType | 這是必要欄位。 此欄位會指定在 Blob 或容器層級建立的清查範圍。 | 'Blob' 'Container' （必要） |
| 附表 | 這是必要欄位。 此欄位可用來排程清查形成。 | 'Daily' 'Weekly' （必要） |
| 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[] |
| 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 停用的帳戶，schemaFields 必須包含 'Deleted 和 RemainingRetentionDays'，否則必須排除。 | bool |
| includeSnapshots | 當值設定為 true 時，在 Blob 清查中包含 Blob 快照集。 如果此屬性設定為 true，則需要 definition.schemaFields 值 'Snapshot'，否則必須排除它。 | bool |
| prefixMatch | 包含最多 10 個 Blob 前置詞的字串數位。 | string[] |
BlobInventoryPolicyProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 政策 | 記憶體帳戶 Blob 清查原則物件。 它是由原則規則所組成。 | BlobInventoryPolicySchema （必要） |
BlobInventoryPolicyRule
| 名字 | 描述 | 價值 |
|---|---|---|
| 定義 | 定義 Blob 清查原則規則的物件。 | BlobInventoryPolicyDefinition （必要） |
| 目的地 | 儲存 Blob 清查檔案的容器名稱。 必須預先建立。 | 字串 （必要） |
| 啟用 | 當設定為 true 時，會啟用規則。 | 布林 （必要） |
| 名字 | 規則名稱可以包含任意組合的英數位元。 規則名稱區分大小寫。 它在原則內必須是唯一的。 | 字串 （必要） |
BlobInventoryPolicySchema
| 名字 | 描述 | 價值 |
|---|---|---|
| 啟用 | 如果設定為 true，則會啟用原則。 | 布林 （必要） |
| 規則 | 記憶體帳戶 Blob 清查原則規則。 規則會在啟用時套用。 | BlobInventoryPolicyRule[] （必要） |
| 類型 | 有效值為 Inventory | 'Inventory' （必要） |
Microsoft.Storage/storageAccounts/inventoryPolicies
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 'default' （必要） |
| parent_id | 此資源為父系之資源的標識碼。 | 類型資源的標識碼：storageAccounts |
| 性能 | 傳回記憶體帳戶 Blob 清查原則規則。 | BlobInventoryPolicyProperties |
| 類型 | 資源類型 | “Microsoft.Storage/storageAccounts/inventoryPolicies@2022-09-01” |