Share via

BlobInventoryPolicyDefinition Class

  • Reference

An object that defines the blob inventory rule.

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.storage._serialization.Model
BlobInventoryPolicyDefinition

Constructor

BlobInventoryPolicyDefinition(*, format: str | _models.Format, schedule: str | _models.Schedule, object_type: str | _models.ObjectType, schema_fields: List[str], filters: _models.BlobInventoryPolicyFilter | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
filters
BlobInventoryPolicyFilter

An object that defines the filter set.
format
str or Format

This is a required field, it specifies the format for the inventory files. Required. Known values are: "Csv" and "Parquet".
schedule
str or Schedule

This is a required field. This field is used to schedule an inventory formation. Required. Known values are: "Daily" and "Weekly".
object_type
str or ObjectType

This is a required field. This field specifies the scope of the inventory created either at the blob or container level. Required. Known values are: "Blob" and "Container".
schema_fields
list[str]

This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include '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'. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl' are valid only for Hns enabled accounts.'Tags' field is only valid for non Hns accounts. Required.

Variables

Name Description
filters
BlobInventoryPolicyFilter

An object that defines the filter set.
format
str or Format

This is a required field, it specifies the format for the inventory files. Required. Known values are: "Csv" and "Parquet".
schedule
str or Schedule

This is a required field. This field is used to schedule an inventory formation. Required. Known values are: "Daily" and "Weekly".
object_type
str or ObjectType

This is a required field. This field specifies the scope of the inventory created either at the blob or container level. Required. Known values are: "Blob" and "Container".
schema_fields
list[str]

This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include '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'. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl' are valid only for Hns enabled accounts.'Tags' field is only valid for non Hns accounts. Required.