1. Packages
  2. Azure Native
  3. API Docs
  4. storage
  5. getBlobContainer
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.storage.getBlobContainer

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Gets properties of a specified container.

Uses Azure REST API version 2024-01-01.

Other available API versions: 2022-09-01, 2023-01-01, 2023-04-01, 2023-05-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native storage [ApiVersion]. See the version guide for details.

Using getBlobContainer

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 getBlobContainer(args: GetBlobContainerArgs, opts?: InvokeOptions): Promise<GetBlobContainerResult>
function getBlobContainerOutput(args: GetBlobContainerOutputArgs, opts?: InvokeOptions): Output<GetBlobContainerResult>
Copy
def get_blob_container(account_name: Optional[str] = None,
                       container_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetBlobContainerResult
def get_blob_container_output(account_name: Optional[pulumi.Input[str]] = None,
                       container_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetBlobContainerResult]
Copy
func LookupBlobContainer(ctx *Context, args *LookupBlobContainerArgs, opts ...InvokeOption) (*LookupBlobContainerResult, error)
func LookupBlobContainerOutput(ctx *Context, args *LookupBlobContainerOutputArgs, opts ...InvokeOption) LookupBlobContainerResultOutput
Copy

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

public static class GetBlobContainer 
{
    public static Task<GetBlobContainerResult> InvokeAsync(GetBlobContainerArgs args, InvokeOptions? opts = null)
    public static Output<GetBlobContainerResult> Invoke(GetBlobContainerInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBlobContainerResult> getBlobContainer(GetBlobContainerArgs args, InvokeOptions options)
public static Output<GetBlobContainerResult> getBlobContainer(GetBlobContainerArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:storage:getBlobContainer
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
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.
ContainerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
AccountName
This property is required.
Changes to this property will trigger replacement.
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.
ContainerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
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.
containerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
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.
containerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
account_name
This property is required.
Changes to this property will trigger replacement.
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.
container_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group within the user's subscription. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
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.
containerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.

getBlobContainer Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Deleted bool
Indicates whether the blob container was deleted.
DeletedTime string
Blob container deletion time.
Etag string
Resource Etag.
HasImmutabilityPolicy bool
The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container.
HasLegalHold bool
The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ImmutabilityPolicy Pulumi.AzureNative.Storage.Outputs.ImmutabilityPolicyPropertiesResponse
The ImmutabilityPolicy property of the container.
LastModifiedTime string
Returns the date and time the container was last modified.
LeaseDuration string
Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased.
LeaseState string
Lease state of the container.
LeaseStatus string
The lease status of the container.
LegalHold Pulumi.AzureNative.Storage.Outputs.LegalHoldPropertiesResponse
The LegalHold property of the container.
Name string
The name of the resource
RemainingRetentionDays int
Remaining retention days for soft deleted blob container.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Version string
The version of the deleted blob container.
DefaultEncryptionScope string
Default the container to use specified encryption scope for all writes.
DenyEncryptionScopeOverride bool
Block override of encryption scope from the container default.
EnableNfsV3AllSquash bool
Enable NFSv3 all squash on blob container.
EnableNfsV3RootSquash bool
Enable NFSv3 root squash on blob container.
ImmutableStorageWithVersioning Pulumi.AzureNative.Storage.Outputs.ImmutableStorageWithVersioningResponse
The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process.
Metadata Dictionary<string, string>
A name-value pair to associate with the container as metadata.
PublicAccess string
Specifies whether data in the container may be accessed publicly and the level of access.
AzureApiVersion string
The Azure API version of the resource.
Deleted bool
Indicates whether the blob container was deleted.
DeletedTime string
Blob container deletion time.
Etag string
Resource Etag.
HasImmutabilityPolicy bool
The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container.
HasLegalHold bool
The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ImmutabilityPolicy ImmutabilityPolicyPropertiesResponse
The ImmutabilityPolicy property of the container.
LastModifiedTime string
Returns the date and time the container was last modified.
LeaseDuration string
Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased.
LeaseState string
Lease state of the container.
LeaseStatus string
The lease status of the container.
LegalHold LegalHoldPropertiesResponse
The LegalHold property of the container.
Name string
The name of the resource
RemainingRetentionDays int
Remaining retention days for soft deleted blob container.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Version string
The version of the deleted blob container.
DefaultEncryptionScope string
Default the container to use specified encryption scope for all writes.
DenyEncryptionScopeOverride bool
Block override of encryption scope from the container default.
EnableNfsV3AllSquash bool
Enable NFSv3 all squash on blob container.
EnableNfsV3RootSquash bool
Enable NFSv3 root squash on blob container.
ImmutableStorageWithVersioning ImmutableStorageWithVersioningResponse
The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process.
Metadata map[string]string
A name-value pair to associate with the container as metadata.
PublicAccess string
Specifies whether data in the container may be accessed publicly and the level of access.
azureApiVersion String
The Azure API version of the resource.
deleted Boolean
Indicates whether the blob container was deleted.
deletedTime String
Blob container deletion time.
etag String
Resource Etag.
hasImmutabilityPolicy Boolean
The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container.
hasLegalHold Boolean
The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
immutabilityPolicy ImmutabilityPolicyPropertiesResponse
The ImmutabilityPolicy property of the container.
lastModifiedTime String
Returns the date and time the container was last modified.
leaseDuration String
Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased.
leaseState String
Lease state of the container.
leaseStatus String
The lease status of the container.
legalHold LegalHoldPropertiesResponse
The LegalHold property of the container.
name String
The name of the resource
remainingRetentionDays Integer
Remaining retention days for soft deleted blob container.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
version String
The version of the deleted blob container.
defaultEncryptionScope String
Default the container to use specified encryption scope for all writes.
denyEncryptionScopeOverride Boolean
Block override of encryption scope from the container default.
enableNfsV3AllSquash Boolean
Enable NFSv3 all squash on blob container.
enableNfsV3RootSquash Boolean
Enable NFSv3 root squash on blob container.
immutableStorageWithVersioning ImmutableStorageWithVersioningResponse
The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process.
metadata Map<String,String>
A name-value pair to associate with the container as metadata.
publicAccess String
Specifies whether data in the container may be accessed publicly and the level of access.
azureApiVersion string
The Azure API version of the resource.
deleted boolean
Indicates whether the blob container was deleted.
deletedTime string
Blob container deletion time.
etag string
Resource Etag.
hasImmutabilityPolicy boolean
The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container.
hasLegalHold boolean
The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
immutabilityPolicy ImmutabilityPolicyPropertiesResponse
The ImmutabilityPolicy property of the container.
lastModifiedTime string
Returns the date and time the container was last modified.
leaseDuration string
Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased.
leaseState string
Lease state of the container.
leaseStatus string
The lease status of the container.
legalHold LegalHoldPropertiesResponse
The LegalHold property of the container.
name string
The name of the resource
remainingRetentionDays number
Remaining retention days for soft deleted blob container.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
version string
The version of the deleted blob container.
defaultEncryptionScope string
Default the container to use specified encryption scope for all writes.
denyEncryptionScopeOverride boolean
Block override of encryption scope from the container default.
enableNfsV3AllSquash boolean
Enable NFSv3 all squash on blob container.
enableNfsV3RootSquash boolean
Enable NFSv3 root squash on blob container.
immutableStorageWithVersioning ImmutableStorageWithVersioningResponse
The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process.
metadata {[key: string]: string}
A name-value pair to associate with the container as metadata.
publicAccess string
Specifies whether data in the container may be accessed publicly and the level of access.
azure_api_version str
The Azure API version of the resource.
deleted bool
Indicates whether the blob container was deleted.
deleted_time str
Blob container deletion time.
etag str
Resource Etag.
has_immutability_policy bool
The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container.
has_legal_hold bool
The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
immutability_policy ImmutabilityPolicyPropertiesResponse
The ImmutabilityPolicy property of the container.
last_modified_time str
Returns the date and time the container was last modified.
lease_duration str
Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased.
lease_state str
Lease state of the container.
lease_status str
The lease status of the container.
legal_hold LegalHoldPropertiesResponse
The LegalHold property of the container.
name str
The name of the resource
remaining_retention_days int
Remaining retention days for soft deleted blob container.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
version str
The version of the deleted blob container.
default_encryption_scope str
Default the container to use specified encryption scope for all writes.
deny_encryption_scope_override bool
Block override of encryption scope from the container default.
enable_nfs_v3_all_squash bool
Enable NFSv3 all squash on blob container.
enable_nfs_v3_root_squash bool
Enable NFSv3 root squash on blob container.
immutable_storage_with_versioning ImmutableStorageWithVersioningResponse
The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process.
metadata Mapping[str, str]
A name-value pair to associate with the container as metadata.
public_access str
Specifies whether data in the container may be accessed publicly and the level of access.
azureApiVersion String
The Azure API version of the resource.
deleted Boolean
Indicates whether the blob container was deleted.
deletedTime String
Blob container deletion time.
etag String
Resource Etag.
hasImmutabilityPolicy Boolean
The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container.
hasLegalHold Boolean
The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
immutabilityPolicy Property Map
The ImmutabilityPolicy property of the container.
lastModifiedTime String
Returns the date and time the container was last modified.
leaseDuration String
Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased.
leaseState String
Lease state of the container.
leaseStatus String
The lease status of the container.
legalHold Property Map
The LegalHold property of the container.
name String
The name of the resource
remainingRetentionDays Number
Remaining retention days for soft deleted blob container.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
version String
The version of the deleted blob container.
defaultEncryptionScope String
Default the container to use specified encryption scope for all writes.
denyEncryptionScopeOverride Boolean
Block override of encryption scope from the container default.
enableNfsV3AllSquash Boolean
Enable NFSv3 all squash on blob container.
enableNfsV3RootSquash Boolean
Enable NFSv3 root squash on blob container.
immutableStorageWithVersioning Property Map
The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process.
metadata Map<String>
A name-value pair to associate with the container as metadata.
publicAccess String
Specifies whether data in the container may be accessed publicly and the level of access.

Supporting Types

ImmutabilityPolicyPropertiesResponse

Etag This property is required. string
ImmutabilityPolicy Etag.
State This property is required. string
The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked.
UpdateHistory This property is required. List<Pulumi.AzureNative.Storage.Inputs.UpdateHistoryPropertyResponse>
The ImmutabilityPolicy update history of the blob container.
AllowProtectedAppendWrites bool
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
AllowProtectedAppendWritesAll bool
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
ImmutabilityPeriodSinceCreationInDays int
The immutability period for the blobs in the container since the policy creation, in days.
Etag This property is required. string
ImmutabilityPolicy Etag.
State This property is required. string
The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked.
UpdateHistory This property is required. []UpdateHistoryPropertyResponse
The ImmutabilityPolicy update history of the blob container.
AllowProtectedAppendWrites bool
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
AllowProtectedAppendWritesAll bool
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
ImmutabilityPeriodSinceCreationInDays int
The immutability period for the blobs in the container since the policy creation, in days.
etag This property is required. String
ImmutabilityPolicy Etag.
state This property is required. String
The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked.
updateHistory This property is required. List<UpdateHistoryPropertyResponse>
The ImmutabilityPolicy update history of the blob container.
allowProtectedAppendWrites Boolean
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
allowProtectedAppendWritesAll Boolean
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
immutabilityPeriodSinceCreationInDays Integer
The immutability period for the blobs in the container since the policy creation, in days.
etag This property is required. string
ImmutabilityPolicy Etag.
state This property is required. string
The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked.
updateHistory This property is required. UpdateHistoryPropertyResponse[]
The ImmutabilityPolicy update history of the blob container.
allowProtectedAppendWrites boolean
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
allowProtectedAppendWritesAll boolean
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
immutabilityPeriodSinceCreationInDays number
The immutability period for the blobs in the container since the policy creation, in days.
etag This property is required. str
ImmutabilityPolicy Etag.
state This property is required. str
The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked.
update_history This property is required. Sequence[UpdateHistoryPropertyResponse]
The ImmutabilityPolicy update history of the blob container.
allow_protected_append_writes bool
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
allow_protected_append_writes_all bool
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
immutability_period_since_creation_in_days int
The immutability period for the blobs in the container since the policy creation, in days.
etag This property is required. String
ImmutabilityPolicy Etag.
state This property is required. String
The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked.
updateHistory This property is required. List<Property Map>
The ImmutabilityPolicy update history of the blob container.
allowProtectedAppendWrites Boolean
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
allowProtectedAppendWritesAll Boolean
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
immutabilityPeriodSinceCreationInDays Number
The immutability period for the blobs in the container since the policy creation, in days.

ImmutableStorageWithVersioningResponse

MigrationState This property is required. string
This property denotes the container level immutability to object level immutability migration state.
TimeStamp This property is required. string
Returns the date and time the object level immutability was enabled.
Enabled bool
This is an immutable property, when set to true it enables object level immutability at the container level.
MigrationState This property is required. string
This property denotes the container level immutability to object level immutability migration state.
TimeStamp This property is required. string
Returns the date and time the object level immutability was enabled.
Enabled bool
This is an immutable property, when set to true it enables object level immutability at the container level.
migrationState This property is required. String
This property denotes the container level immutability to object level immutability migration state.
timeStamp This property is required. String
Returns the date and time the object level immutability was enabled.
enabled Boolean
This is an immutable property, when set to true it enables object level immutability at the container level.
migrationState This property is required. string
This property denotes the container level immutability to object level immutability migration state.
timeStamp This property is required. string
Returns the date and time the object level immutability was enabled.
enabled boolean
This is an immutable property, when set to true it enables object level immutability at the container level.
migration_state This property is required. str
This property denotes the container level immutability to object level immutability migration state.
time_stamp This property is required. str
Returns the date and time the object level immutability was enabled.
enabled bool
This is an immutable property, when set to true it enables object level immutability at the container level.
migrationState This property is required. String
This property denotes the container level immutability to object level immutability migration state.
timeStamp This property is required. String
Returns the date and time the object level immutability was enabled.
enabled Boolean
This is an immutable property, when set to true it enables object level immutability at the container level.

LegalHoldPropertiesResponse

HasLegalHold This property is required. bool
The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
ProtectedAppendWritesHistory Pulumi.AzureNative.Storage.Inputs.ProtectedAppendWritesHistoryResponse
Protected append blob writes history.
Tags List<Pulumi.AzureNative.Storage.Inputs.TagPropertyResponse>
The list of LegalHold tags of a blob container.
HasLegalHold This property is required. bool
The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
ProtectedAppendWritesHistory ProtectedAppendWritesHistoryResponse
Protected append blob writes history.
Tags []TagPropertyResponse
The list of LegalHold tags of a blob container.
hasLegalHold This property is required. Boolean
The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
protectedAppendWritesHistory ProtectedAppendWritesHistoryResponse
Protected append blob writes history.
tags List<TagPropertyResponse>
The list of LegalHold tags of a blob container.
hasLegalHold This property is required. boolean
The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
protectedAppendWritesHistory ProtectedAppendWritesHistoryResponse
Protected append blob writes history.
tags TagPropertyResponse[]
The list of LegalHold tags of a blob container.
has_legal_hold This property is required. bool
The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
protected_append_writes_history ProtectedAppendWritesHistoryResponse
Protected append blob writes history.
tags Sequence[TagPropertyResponse]
The list of LegalHold tags of a blob container.
hasLegalHold This property is required. Boolean
The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.
protectedAppendWritesHistory Property Map
Protected append blob writes history.
tags List<Property Map>
The list of LegalHold tags of a blob container.

ProtectedAppendWritesHistoryResponse

Timestamp This property is required. string
Returns the date and time the tag was added.
AllowProtectedAppendWritesAll bool
When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.
Timestamp This property is required. string
Returns the date and time the tag was added.
AllowProtectedAppendWritesAll bool
When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.
timestamp This property is required. String
Returns the date and time the tag was added.
allowProtectedAppendWritesAll Boolean
When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.
timestamp This property is required. string
Returns the date and time the tag was added.
allowProtectedAppendWritesAll boolean
When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.
timestamp This property is required. str
Returns the date and time the tag was added.
allow_protected_append_writes_all bool
When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.
timestamp This property is required. String
Returns the date and time the tag was added.
allowProtectedAppendWritesAll Boolean
When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.

TagPropertyResponse

ObjectIdentifier This property is required. string
Returns the Object ID of the user who added the tag.
Tag This property is required. string
The tag value.
TenantId This property is required. string
Returns the Tenant ID that issued the token for the user who added the tag.
Timestamp This property is required. string
Returns the date and time the tag was added.
Upn This property is required. string
Returns the User Principal Name of the user who added the tag.
ObjectIdentifier This property is required. string
Returns the Object ID of the user who added the tag.
Tag This property is required. string
The tag value.
TenantId This property is required. string
Returns the Tenant ID that issued the token for the user who added the tag.
Timestamp This property is required. string
Returns the date and time the tag was added.
Upn This property is required. string
Returns the User Principal Name of the user who added the tag.
objectIdentifier This property is required. String
Returns the Object ID of the user who added the tag.
tag This property is required. String
The tag value.
tenantId This property is required. String
Returns the Tenant ID that issued the token for the user who added the tag.
timestamp This property is required. String
Returns the date and time the tag was added.
upn This property is required. String
Returns the User Principal Name of the user who added the tag.
objectIdentifier This property is required. string
Returns the Object ID of the user who added the tag.
tag This property is required. string
The tag value.
tenantId This property is required. string
Returns the Tenant ID that issued the token for the user who added the tag.
timestamp This property is required. string
Returns the date and time the tag was added.
upn This property is required. string
Returns the User Principal Name of the user who added the tag.
object_identifier This property is required. str
Returns the Object ID of the user who added the tag.
tag This property is required. str
The tag value.
tenant_id This property is required. str
Returns the Tenant ID that issued the token for the user who added the tag.
timestamp This property is required. str
Returns the date and time the tag was added.
upn This property is required. str
Returns the User Principal Name of the user who added the tag.
objectIdentifier This property is required. String
Returns the Object ID of the user who added the tag.
tag This property is required. String
The tag value.
tenantId This property is required. String
Returns the Tenant ID that issued the token for the user who added the tag.
timestamp This property is required. String
Returns the date and time the tag was added.
upn This property is required. String
Returns the User Principal Name of the user who added the tag.

UpdateHistoryPropertyResponse

ImmutabilityPeriodSinceCreationInDays This property is required. int
The immutability period for the blobs in the container since the policy creation, in days.
ObjectIdentifier This property is required. string
Returns the Object ID of the user who updated the ImmutabilityPolicy.
TenantId This property is required. string
Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy.
Timestamp This property is required. string
Returns the date and time the ImmutabilityPolicy was updated.
Update This property is required. string
The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend.
Upn This property is required. string
Returns the User Principal Name of the user who updated the ImmutabilityPolicy.
AllowProtectedAppendWrites bool
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
AllowProtectedAppendWritesAll bool
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
ImmutabilityPeriodSinceCreationInDays This property is required. int
The immutability period for the blobs in the container since the policy creation, in days.
ObjectIdentifier This property is required. string
Returns the Object ID of the user who updated the ImmutabilityPolicy.
TenantId This property is required. string
Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy.
Timestamp This property is required. string
Returns the date and time the ImmutabilityPolicy was updated.
Update This property is required. string
The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend.
Upn This property is required. string
Returns the User Principal Name of the user who updated the ImmutabilityPolicy.
AllowProtectedAppendWrites bool
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
AllowProtectedAppendWritesAll bool
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
immutabilityPeriodSinceCreationInDays This property is required. Integer
The immutability period for the blobs in the container since the policy creation, in days.
objectIdentifier This property is required. String
Returns the Object ID of the user who updated the ImmutabilityPolicy.
tenantId This property is required. String
Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy.
timestamp This property is required. String
Returns the date and time the ImmutabilityPolicy was updated.
update This property is required. String
The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend.
upn This property is required. String
Returns the User Principal Name of the user who updated the ImmutabilityPolicy.
allowProtectedAppendWrites Boolean
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
allowProtectedAppendWritesAll Boolean
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
immutabilityPeriodSinceCreationInDays This property is required. number
The immutability period for the blobs in the container since the policy creation, in days.
objectIdentifier This property is required. string
Returns the Object ID of the user who updated the ImmutabilityPolicy.
tenantId This property is required. string
Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy.
timestamp This property is required. string
Returns the date and time the ImmutabilityPolicy was updated.
update This property is required. string
The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend.
upn This property is required. string
Returns the User Principal Name of the user who updated the ImmutabilityPolicy.
allowProtectedAppendWrites boolean
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
allowProtectedAppendWritesAll boolean
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
immutability_period_since_creation_in_days This property is required. int
The immutability period for the blobs in the container since the policy creation, in days.
object_identifier This property is required. str
Returns the Object ID of the user who updated the ImmutabilityPolicy.
tenant_id This property is required. str
Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy.
timestamp This property is required. str
Returns the date and time the ImmutabilityPolicy was updated.
update This property is required. str
The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend.
upn This property is required. str
Returns the User Principal Name of the user who updated the ImmutabilityPolicy.
allow_protected_append_writes bool
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
allow_protected_append_writes_all bool
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.
immutabilityPeriodSinceCreationInDays This property is required. Number
The immutability period for the blobs in the container since the policy creation, in days.
objectIdentifier This property is required. String
Returns the Object ID of the user who updated the ImmutabilityPolicy.
tenantId This property is required. String
Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy.
timestamp This property is required. String
Returns the date and time the ImmutabilityPolicy was updated.
update This property is required. String
The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend.
upn This property is required. String
Returns the User Principal Name of the user who updated the ImmutabilityPolicy.
allowProtectedAppendWrites Boolean
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.
allowProtectedAppendWritesAll Boolean
This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi