Package version:

Interface BlobInventoryPolicyFilter

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.

interface BlobInventoryPolicyFilter {
    blobTypes?: string[];
    creationTime?: BlobInventoryCreationTime;
    excludePrefix?: string[];
    includeBlobVersions?: boolean;
    includeDeleted?: boolean;
    includeSnapshots?: boolean;
    prefixMatch?: string[];
}

Properties

blobTypes? creationTime? excludePrefix? includeBlobVersions? includeDeleted? includeSnapshots? prefixMatch?

Properties

OptionalblobTypes

blobTypes?: string[]

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

OptionalcreationTime

creationTime?: BlobInventoryCreationTime

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

OptionalexcludePrefix

excludePrefix?: string[]

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

OptionalincludeBlobVersions

includeBlobVersions?: boolean

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.

OptionalincludeDeleted

includeDeleted?: boolean

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.

OptionalincludeSnapshots

includeSnapshots?: boolean

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.

OptionalprefixMatch

prefixMatch?: string[]

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

Settings

Member Visibility