BlobInventoryPolicyFilter Class

  • Reference

Definition

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

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.

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

Constructors

BlobInventoryPolicyFilter()

Creates an new BlobInventoryPolicyFilter instance.

Properties

BlobType

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

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

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

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.

Methods

DeserializeFromDictionary(IDictionary)

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

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

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

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

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

Serializes this instance to a json string.
ToString()

Applies to