BlobInventoryPolicyDefinition Class

  • Reference

Definition

Namespace:
Microsoft.Azure.PowerShell.Cmdlets.Storage.Models
Assembly:
Az.Storage.private.dll

An object that defines the blob inventory rule.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.BlobInventoryPolicyDefinitionTypeConverter))]
public class BlobInventoryPolicyDefinition : Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IBlobInventoryPolicyDefinition
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.BlobInventoryPolicyDefinitionTypeConverter))>]
type BlobInventoryPolicyDefinition = class
    interface IBlobInventoryPolicyDefinition
    interface IJsonSerializable
Public Class BlobInventoryPolicyDefinition
Implements IBlobInventoryPolicyDefinition
Inheritance
Object
BlobInventoryPolicyDefinition
Attributes
TypeConverterAttribute
Implements
IBlobInventoryPolicyDefinition IJsonSerializable

Constructors

BlobInventoryPolicyDefinition()

Creates an new BlobInventoryPolicyDefinition instance.

Properties

CreationTimeLastNDay

When set the policy filters the objects that are created in the last N days. Where N is an integer value between 1 to 36500.
FilterBlobType

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

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

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

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

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

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

This is a required field, it specifies the format for the inventory files.
ObjectType

This is a required field. This field specifies the scope of the inventory created either at the blob or container level.
Schedule

This is a required field. This field is used to schedule an inventory formation.
SchemaField

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, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount'. For Blob object type schema field value 'DeletedTime' is applicable only for Hns enabled accounts. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId' are valid only for Hns enabled accounts.Schema field values 'Tags, TagCount' are only valid for Non-Hns accounts.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of BlobInventoryPolicyDefinition.
DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of BlobInventoryPolicyDefinition.
FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IBlobInventoryPolicyDefinition.
FromJsonString(String)

Creates a new instance of BlobInventoryPolicyDefinition, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)

Serializes this instance of BlobInventoryPolicyDefinition into a JsonNode.
ToJsonString()

Serializes this instance to a json string.
ToString()

Applies to