BlobContainer interface

Package:

@azure/arm-storage

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

Extends

AzureEntityResource

Properties

defaultEncryptionScope	Default the container to use specified encryption scope for all writes.
deleted	Indicates whether the blob container was deleted. NOTE: This property will not be serialized. It can only be populated by the server.
deletedTime	Blob container deletion time. NOTE: This property will not be serialized. It can only be populated by the server.
denyEncryptionScopeOverride	Block override of encryption scope from the container default.
enableNfsV3AllSquash	Enable NFSv3 all squash on blob container.
enableNfsV3RootSquash	Enable NFSv3 root squash on blob container.
hasImmutabilityPolicy	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. NOTE: This property will not be serialized. It can only be populated by the server.
hasLegalHold	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. NOTE: This property will not be serialized. It can only be populated by the server.
immutabilityPolicy	The ImmutabilityPolicy property of the container. NOTE: This property will not be serialized. It can only be populated by the server.
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.
lastModifiedTime	Returns the date and time the container was last modified. NOTE: This property will not be serialized. It can only be populated by the server.
leaseDuration	Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. NOTE: This property will not be serialized. It can only be populated by the server.
leaseState	Lease state of the container. NOTE: This property will not be serialized. It can only be populated by the server.
leaseStatus	The lease status of the container. NOTE: This property will not be serialized. It can only be populated by the server.
legalHold	The LegalHold property of the container. NOTE: This property will not be serialized. It can only be populated by the server.
metadata	A name-value pair to associate with the container as metadata.
publicAccess	Specifies whether data in the container may be accessed publicly and the level of access.
remainingRetentionDays	Remaining retention days for soft deleted blob container. NOTE: This property will not be serialized. It can only be populated by the server.
version	The version of the deleted blob container. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

etag	Resource Etag. NOTE: This property will not be serialized. It can only be populated by the server.
id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

defaultEncryptionScope

Default the container to use specified encryption scope for all writes.

defaultEncryptionScope?: string

Property Value

string

deleted

Indicates whether the blob container was deleted. NOTE: This property will not be serialized. It can only be populated by the server.

deleted?: boolean

Property Value

boolean

deletedTime

Blob container deletion time. NOTE: This property will not be serialized. It can only be populated by the server.

deletedTime?: Date

Property Value

Date

denyEncryptionScopeOverride

Block override of encryption scope from the container default.

denyEncryptionScopeOverride?: boolean

Property Value

boolean

enableNfsV3AllSquash

Enable NFSv3 all squash on blob container.

enableNfsV3AllSquash?: boolean

Property Value

boolean

enableNfsV3RootSquash

Enable NFSv3 root squash on blob container.

enableNfsV3RootSquash?: boolean

Property Value

boolean

hasImmutabilityPolicy

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. NOTE: This property will not be serialized. It can only be populated by the server.

hasImmutabilityPolicy?: boolean

Property Value

boolean

hasLegalHold

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. NOTE: This property will not be serialized. It can only be populated by the server.

hasLegalHold?: boolean

Property Value

boolean

immutabilityPolicy

The ImmutabilityPolicy property of the container. NOTE: This property will not be serialized. It can only be populated by the server.

immutabilityPolicy?: ImmutabilityPolicyProperties

Property Value

ImmutabilityPolicyProperties

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.

immutableStorageWithVersioning?: ImmutableStorageWithVersioning

Property Value

ImmutableStorageWithVersioning

lastModifiedTime

Returns the date and time the container was last modified. NOTE: This property will not be serialized. It can only be populated by the server.

lastModifiedTime?: Date

Property Value

Date

leaseDuration

Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. NOTE: This property will not be serialized. It can only be populated by the server.

leaseDuration?: string

Property Value

string

leaseState

Lease state of the container. NOTE: This property will not be serialized. It can only be populated by the server.

leaseState?: string

Property Value

string

leaseStatus

The lease status of the container. NOTE: This property will not be serialized. It can only be populated by the server.

leaseStatus?: string

Property Value

string

legalHold

The LegalHold property of the container. NOTE: This property will not be serialized. It can only be populated by the server.

legalHold?: LegalHoldProperties

Property Value

LegalHoldProperties

metadata

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

metadata?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

publicAccess

Specifies whether data in the container may be accessed publicly and the level of access.

publicAccess?: PublicAccess

Property Value

PublicAccess

remainingRetentionDays

Remaining retention days for soft deleted blob container. NOTE: This property will not be serialized. It can only be populated by the server.

remainingRetentionDays?: number

Property Value

number

version

The version of the deleted blob container. NOTE: This property will not be serialized. It can only be populated by the server.

version?: string

Property Value

string

Inherited Property Details

etag

Resource Etag. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

Inherited From AzureEntityResource.etag

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From AzureEntityResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From AzureEntityResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From AzureEntityResource.type