1. Packages
  2. Azure Native
  3. API Docs
  4. storage
  5. getBlobInventoryPolicy
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.storage.getBlobInventoryPolicy

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Gets the blob inventory policy associated with the specified storage account. Azure REST API version: 2022-09-01.

    Other available API versions: 2023-01-01, 2023-04-01.

    Using getBlobInventoryPolicy

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBlobInventoryPolicy(args: GetBlobInventoryPolicyArgs, opts?: InvokeOptions): Promise<GetBlobInventoryPolicyResult>
    function getBlobInventoryPolicyOutput(args: GetBlobInventoryPolicyOutputArgs, opts?: InvokeOptions): Output<GetBlobInventoryPolicyResult>
    def get_blob_inventory_policy(account_name: Optional[str] = None,
                                  blob_inventory_policy_name: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetBlobInventoryPolicyResult
    def get_blob_inventory_policy_output(account_name: Optional[pulumi.Input[str]] = None,
                                  blob_inventory_policy_name: Optional[pulumi.Input[str]] = None,
                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetBlobInventoryPolicyResult]
    func LookupBlobInventoryPolicy(ctx *Context, args *LookupBlobInventoryPolicyArgs, opts ...InvokeOption) (*LookupBlobInventoryPolicyResult, error)
    func LookupBlobInventoryPolicyOutput(ctx *Context, args *LookupBlobInventoryPolicyOutputArgs, opts ...InvokeOption) LookupBlobInventoryPolicyResultOutput

    > Note: This function is named LookupBlobInventoryPolicy in the Go SDK.

    public static class GetBlobInventoryPolicy 
    {
        public static Task<GetBlobInventoryPolicyResult> InvokeAsync(GetBlobInventoryPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetBlobInventoryPolicyResult> Invoke(GetBlobInventoryPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBlobInventoryPolicyResult> getBlobInventoryPolicy(GetBlobInventoryPolicyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:storage:getBlobInventoryPolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountName string
    The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
    BlobInventoryPolicyName string
    The name of the storage account blob inventory policy. It should always be 'default'
    ResourceGroupName string
    The name of the resource group within the user's subscription. The name is case insensitive.
    AccountName string
    The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
    BlobInventoryPolicyName string
    The name of the storage account blob inventory policy. It should always be 'default'
    ResourceGroupName string
    The name of the resource group within the user's subscription. The name is case insensitive.
    accountName String
    The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
    blobInventoryPolicyName String
    The name of the storage account blob inventory policy. It should always be 'default'
    resourceGroupName String
    The name of the resource group within the user's subscription. The name is case insensitive.
    accountName string
    The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
    blobInventoryPolicyName string
    The name of the storage account blob inventory policy. It should always be 'default'
    resourceGroupName string
    The name of the resource group within the user's subscription. The name is case insensitive.
    account_name str
    The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
    blob_inventory_policy_name str
    The name of the storage account blob inventory policy. It should always be 'default'
    resource_group_name str
    The name of the resource group within the user's subscription. The name is case insensitive.
    accountName String
    The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
    blobInventoryPolicyName String
    The name of the storage account blob inventory policy. It should always be 'default'
    resourceGroupName String
    The name of the resource group within the user's subscription. The name is case insensitive.

    getBlobInventoryPolicy Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    LastModifiedTime string
    Returns the last modified date and time of the blob inventory policy.
    Name string
    The name of the resource
    Policy Pulumi.AzureNative.Storage.Outputs.BlobInventoryPolicySchemaResponse
    The storage account blob inventory policy object. It is composed of policy rules.
    SystemData Pulumi.AzureNative.Storage.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    LastModifiedTime string
    Returns the last modified date and time of the blob inventory policy.
    Name string
    The name of the resource
    Policy BlobInventoryPolicySchemaResponse
    The storage account blob inventory policy object. It is composed of policy rules.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    lastModifiedTime String
    Returns the last modified date and time of the blob inventory policy.
    name String
    The name of the resource
    policy BlobInventoryPolicySchemaResponse
    The storage account blob inventory policy object. It is composed of policy rules.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    lastModifiedTime string
    Returns the last modified date and time of the blob inventory policy.
    name string
    The name of the resource
    policy BlobInventoryPolicySchemaResponse
    The storage account blob inventory policy object. It is composed of policy rules.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    last_modified_time str
    Returns the last modified date and time of the blob inventory policy.
    name str
    The name of the resource
    policy BlobInventoryPolicySchemaResponse
    The storage account blob inventory policy object. It is composed of policy rules.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    lastModifiedTime String
    Returns the last modified date and time of the blob inventory policy.
    name String
    The name of the resource
    policy Property Map
    The storage account blob inventory policy object. It is composed of policy rules.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    BlobInventoryPolicyDefinitionResponse

    Format string
    This is a required field, it specifies the format for the inventory files.
    ObjectType string
    This is a required field. This field specifies the scope of the inventory created either at the blob or container level.
    Schedule string
    This is a required field. This field is used to schedule an inventory formation.
    SchemaFields List<string>
    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.
    Filters Pulumi.AzureNative.Storage.Inputs.BlobInventoryPolicyFilterResponse
    An object that defines the filter set.
    Format string
    This is a required field, it specifies the format for the inventory files.
    ObjectType string
    This is a required field. This field specifies the scope of the inventory created either at the blob or container level.
    Schedule string
    This is a required field. This field is used to schedule an inventory formation.
    SchemaFields []string
    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.
    Filters BlobInventoryPolicyFilterResponse
    An object that defines the filter set.
    format String
    This is a required field, it specifies the format for the inventory files.
    objectType String
    This is a required field. This field specifies the scope of the inventory created either at the blob or container level.
    schedule String
    This is a required field. This field is used to schedule an inventory formation.
    schemaFields List<String>
    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.
    filters BlobInventoryPolicyFilterResponse
    An object that defines the filter set.
    format string
    This is a required field, it specifies the format for the inventory files.
    objectType string
    This is a required field. This field specifies the scope of the inventory created either at the blob or container level.
    schedule string
    This is a required field. This field is used to schedule an inventory formation.
    schemaFields string[]
    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.
    filters BlobInventoryPolicyFilterResponse
    An object that defines the filter set.
    format str
    This is a required field, it specifies the format for the inventory files.
    object_type str
    This is a required field. This field specifies the scope of the inventory created either at the blob or container level.
    schedule str
    This is a required field. This field is used to schedule an inventory formation.
    schema_fields Sequence[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, 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.
    filters BlobInventoryPolicyFilterResponse
    An object that defines the filter set.
    format String
    This is a required field, it specifies the format for the inventory files.
    objectType String
    This is a required field. This field specifies the scope of the inventory created either at the blob or container level.
    schedule String
    This is a required field. This field is used to schedule an inventory formation.
    schemaFields List<String>
    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.
    filters Property Map
    An object that defines the filter set.

    BlobInventoryPolicyFilterResponse

    BlobTypes List<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'.
    ExcludePrefix List<string>
    An array of strings with maximum 10 blob prefixes to be excluded from the inventory.
    IncludeBlobVersions 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.
    IncludeDeleted 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.
    IncludeSnapshots 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.
    PrefixMatch List<string>
    An array of strings with maximum 10 blob prefixes to be included in the inventory.
    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'.
    ExcludePrefix []string
    An array of strings with maximum 10 blob prefixes to be excluded from the inventory.
    IncludeBlobVersions 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.
    IncludeDeleted 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.
    IncludeSnapshots 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.
    PrefixMatch []string
    An array of strings with maximum 10 blob prefixes to be included in the inventory.
    blobTypes List<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'.
    excludePrefix List<String>
    An array of strings with maximum 10 blob prefixes to be excluded from the inventory.
    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.
    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.
    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.
    prefixMatch List<String>
    An array of strings with maximum 10 blob prefixes to be included in the inventory.
    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'.
    excludePrefix string[]
    An array of strings with maximum 10 blob prefixes to be excluded from the inventory.
    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.
    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.
    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.
    prefixMatch string[]
    An array of strings with maximum 10 blob prefixes to be included in the inventory.
    blob_types Sequence[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'.
    exclude_prefix Sequence[str]
    An array of strings with maximum 10 blob prefixes to be excluded from the inventory.
    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_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.
    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.
    prefix_match Sequence[str]
    An array of strings with maximum 10 blob prefixes to be included in the inventory.
    blobTypes List<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'.
    excludePrefix List<String>
    An array of strings with maximum 10 blob prefixes to be excluded from the inventory.
    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.
    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.
    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.
    prefixMatch List<String>
    An array of strings with maximum 10 blob prefixes to be included in the inventory.

    BlobInventoryPolicyRuleResponse

    Definition Pulumi.AzureNative.Storage.Inputs.BlobInventoryPolicyDefinitionResponse
    An object that defines the blob inventory policy rule.
    Destination string
    Container name where blob inventory files are stored. Must be pre-created.
    Enabled bool
    Rule is enabled when set to true.
    Name string
    A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.
    Definition BlobInventoryPolicyDefinitionResponse
    An object that defines the blob inventory policy rule.
    Destination string
    Container name where blob inventory files are stored. Must be pre-created.
    Enabled bool
    Rule is enabled when set to true.
    Name string
    A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.
    definition BlobInventoryPolicyDefinitionResponse
    An object that defines the blob inventory policy rule.
    destination String
    Container name where blob inventory files are stored. Must be pre-created.
    enabled Boolean
    Rule is enabled when set to true.
    name String
    A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.
    definition BlobInventoryPolicyDefinitionResponse
    An object that defines the blob inventory policy rule.
    destination string
    Container name where blob inventory files are stored. Must be pre-created.
    enabled boolean
    Rule is enabled when set to true.
    name string
    A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.
    definition BlobInventoryPolicyDefinitionResponse
    An object that defines the blob inventory policy rule.
    destination str
    Container name where blob inventory files are stored. Must be pre-created.
    enabled bool
    Rule is enabled when set to true.
    name str
    A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.
    definition Property Map
    An object that defines the blob inventory policy rule.
    destination String
    Container name where blob inventory files are stored. Must be pre-created.
    enabled Boolean
    Rule is enabled when set to true.
    name String
    A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.

    BlobInventoryPolicySchemaResponse

    Destination string
    Deprecated Property from API version 2021-04-01 onwards, the required destination container name must be specified at the rule level 'policy.rule.destination'
    Enabled bool
    Policy is enabled if set to true.
    Rules List<Pulumi.AzureNative.Storage.Inputs.BlobInventoryPolicyRuleResponse>
    The storage account blob inventory policy rules. The rule is applied when it is enabled.
    Type string
    The valid value is Inventory
    Destination string
    Deprecated Property from API version 2021-04-01 onwards, the required destination container name must be specified at the rule level 'policy.rule.destination'
    Enabled bool
    Policy is enabled if set to true.
    Rules []BlobInventoryPolicyRuleResponse
    The storage account blob inventory policy rules. The rule is applied when it is enabled.
    Type string
    The valid value is Inventory
    destination String
    Deprecated Property from API version 2021-04-01 onwards, the required destination container name must be specified at the rule level 'policy.rule.destination'
    enabled Boolean
    Policy is enabled if set to true.
    rules List<BlobInventoryPolicyRuleResponse>
    The storage account blob inventory policy rules. The rule is applied when it is enabled.
    type String
    The valid value is Inventory
    destination string
    Deprecated Property from API version 2021-04-01 onwards, the required destination container name must be specified at the rule level 'policy.rule.destination'
    enabled boolean
    Policy is enabled if set to true.
    rules BlobInventoryPolicyRuleResponse[]
    The storage account blob inventory policy rules. The rule is applied when it is enabled.
    type string
    The valid value is Inventory
    destination str
    Deprecated Property from API version 2021-04-01 onwards, the required destination container name must be specified at the rule level 'policy.rule.destination'
    enabled bool
    Policy is enabled if set to true.
    rules Sequence[BlobInventoryPolicyRuleResponse]
    The storage account blob inventory policy rules. The rule is applied when it is enabled.
    type str
    The valid value is Inventory
    destination String
    Deprecated Property from API version 2021-04-01 onwards, the required destination container name must be specified at the rule level 'policy.rule.destination'
    enabled Boolean
    Policy is enabled if set to true.
    rules List<Property Map>
    The storage account blob inventory policy rules. The rule is applied when it is enabled.
    type String
    The valid value is Inventory

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi