BlobInventoryPolicyFilter Class

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.

Inheritance

azure.mgmt.storage._serialization.Model

BlobInventoryPolicyFilter

Constructor

BlobInventoryPolicyFilter(*, prefix_match: List[str] | None = None, exclude_prefix: List[str] | None = None, blob_types: List[str] | None = None, include_blob_versions: bool | None = None, include_snapshots: bool | None = None, include_deleted: bool | None = None, creation_time: _models.BlobInventoryCreationTime | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
prefix_match	list[str] An array of strings with maximum 10 blob prefixes to be included in the inventory.
exclude_prefix	list[str] An array of strings with maximum 10 blob prefixes to be excluded from the inventory.
blob_types	list[str] 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'.
include_blob_versions	bool 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.
include_snapshots	bool 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.
include_deleted	bool 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.
creation_time	BlobInventoryCreationTime This property is used to filter objects based on the object creation time.

Variables

Name	Description
prefix_match	list[str] An array of strings with maximum 10 blob prefixes to be included in the inventory.
exclude_prefix	list[str] An array of strings with maximum 10 blob prefixes to be excluded from the inventory.
blob_types	list[str] 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'.
include_blob_versions	bool 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.
include_snapshots	bool 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.
include_deleted	bool 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.
creation_time	BlobInventoryCreationTime This property is used to filter objects based on the object creation time.