Share via

BlobContainer Class

  • Reference

Properties of the blob container, including Id, resource name, resource type, Etag.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.storage.v2021_04_01.models._models_py3.AzureEntityResource
BlobContainer

Constructor

BlobContainer(*, default_encryption_scope: str | None = None, deny_encryption_scope_override: bool | None = None, public_access: str | _models.PublicAccess | None = None, metadata: Dict[str, str] | None = None, immutable_storage_with_versioning: _models.ImmutableStorageWithVersioning | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
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.
public_access
str or PublicAccess

Specifies whether data in the container may be accessed publicly and the level of access. Known values are: "Container", "Blob", and "None".
metadata
dict[str, str]

A name-value pair to associate with the container as metadata.
immutable_storage_with_versioning
ImmutableStorageWithVersioning

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.

Variables

Name Description
id
str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name
str

The name of the resource.
type
str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
etag
str

Resource Etag.
version
str

The version of the deleted blob container.
deleted
bool

Indicates whether the blob container was deleted.
deleted_time
datetime

Blob container deletion time.
remaining_retention_days
int

Remaining retention days for soft 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.
public_access
str or PublicAccess

Specifies whether data in the container may be accessed publicly and the level of access. Known values are: "Container", "Blob", and "None".
last_modified_time
datetime

Returns the date and time the container was last modified.
lease_status
str or LeaseStatus

The lease status of the container. Known values are: "Locked" and "Unlocked".
lease_state
str or LeaseState

Lease state of the container. Known values are: "Available", "Leased", "Expired", "Breaking", and "Broken".
lease_duration
str or LeaseDuration

Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. Known values are: "Infinite" and "Fixed".
metadata
dict[str, str]

A name-value pair to associate with the container as metadata.
immutability_policy
ImmutabilityPolicyProperties

The ImmutabilityPolicy property of the container.
legal_hold
LegalHoldProperties

The LegalHold property of the 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.
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.
immutable_storage_with_versioning
ImmutableStorageWithVersioning

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.