Share via

BlobInventoryPolicyFilter interface

  • Reference
Package:
@azure/arm-storage

An object that defines the blob inventory rule filter conditions. For 'Blob' definition.objectType all filter properties are applicable, 'blobTypes' is required and others are optional. For 'Container' definition.objectType only prefixMatch is applicable and is optional.

Properties

blobTypes

An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'.
creationTime

This property is used to filter objects based on the object creation time
excludePrefix

An array of strings with maximum 10 blob prefixes to be excluded from the inventory.
includeBlobVersions

Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded.
includeDeleted

For 'Container' definition.objectType the definition.schemaFields must include 'Deleted, Version, DeletedTime and RemainingRetentionDays'. For 'Blob' definition.objectType and HNS enabled storage accounts the definition.schemaFields must include 'DeletionId, Deleted, DeletedTime and RemainingRetentionDays' and for Hns disabled accounts the definition.schemaFields must include 'Deleted and RemainingRetentionDays', else it must be excluded.
includeSnapshots

Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded.
prefixMatch

An array of strings with maximum 10 blob prefixes to be included in the inventory.

Property Details

blobTypes

An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'.

blobTypes?: string[]

Property Value

string[]

creationTime

This property is used to filter objects based on the object creation time

creationTime?: BlobInventoryCreationTime

Property Value

BlobInventoryCreationTime

excludePrefix

An array of strings with maximum 10 blob prefixes to be excluded from the inventory.

excludePrefix?: string[]

Property Value

string[]

includeBlobVersions

Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded.

includeBlobVersions?: boolean

Property Value

boolean

includeDeleted

For 'Container' definition.objectType the definition.schemaFields must include 'Deleted, Version, DeletedTime and RemainingRetentionDays'. For 'Blob' definition.objectType and HNS enabled storage accounts the definition.schemaFields must include 'DeletionId, Deleted, DeletedTime and RemainingRetentionDays' and for Hns disabled accounts the definition.schemaFields must include 'Deleted and RemainingRetentionDays', else it must be excluded.

includeDeleted?: boolean

Property Value

boolean

includeSnapshots

Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded.

includeSnapshots?: boolean

Property Value

boolean

prefixMatch

An array of strings with maximum 10 blob prefixes to be included in the inventory.

prefixMatch?: string[]

Property Value

string[]