Package version:

Interface BlobContainer

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

interface BlobContainer {
    defaultEncryptionScope?: string;
    deleted?: boolean;
    deletedTime?: any;
    denyEncryptionScopeOverride?: boolean;
    enableNfsV3AllSquash?: boolean;
    enableNfsV3RootSquash?: boolean;
    etag?: string;
    hasImmutabilityPolicy?: boolean;
    hasLegalHold?: boolean;
    id?: string;
    immutabilityPolicy?: ImmutabilityPolicyProperties;
    immutableStorageWithVersioning?: ImmutableStorageWithVersioning;
    lastModifiedTime?: any;
    leaseDuration?: string;
    leaseState?: string;
    leaseStatus?: string;
    legalHold?: LegalHoldProperties;
    metadata?: {
        [propertyName: string]: string;
    };
    name?: string;
    publicAccess?: PublicAccess;
    remainingRetentionDays?: number;
    type?: string;
    version?: string;
}

Hierarchy (view full)

Properties

defaultEncryptionScope? deleted? deletedTime? denyEncryptionScopeOverride? enableNfsV3AllSquash? enableNfsV3RootSquash? etag? hasImmutabilityPolicy? hasLegalHold? id? immutabilityPolicy? immutableStorageWithVersioning? lastModifiedTime? leaseDuration? leaseState? leaseStatus? legalHold? metadata? name? publicAccess? remainingRetentionDays? type? version?

Properties

OptionaldefaultEncryptionScope

defaultEncryptionScope?: string

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

Optional Readonlydeleted

deleted?: boolean

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

Optional ReadonlydeletedTime

deletedTime?: any

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

OptionaldenyEncryptionScopeOverride

denyEncryptionScopeOverride?: boolean

Block override of encryption scope from the container default.

OptionalenableNfsV3AllSquash

enableNfsV3AllSquash?: boolean

Enable NFSv3 all squash on blob container.

OptionalenableNfsV3RootSquash

enableNfsV3RootSquash?: boolean

Enable NFSv3 root squash on blob container.

Optional Readonlyetag

etag?: string

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

Optional ReadonlyhasImmutabilityPolicy

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

Optional ReadonlyhasLegalHold

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

Optional Readonlyid

id?: string

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.

Optional ReadonlyimmutabilityPolicy

immutabilityPolicy?: ImmutabilityPolicyProperties

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

OptionalimmutableStorageWithVersioning

immutableStorageWithVersioning?: 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.

Optional ReadonlylastModifiedTime

lastModifiedTime?: any

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.

Optional ReadonlyleaseDuration

leaseDuration?: string

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.

Optional ReadonlyleaseState

leaseState?: string

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

Optional ReadonlyleaseStatus

leaseStatus?: string

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

Optional ReadonlylegalHold

legalHold?: LegalHoldProperties

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

Optionalmetadata

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

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

Optional Readonlyname

name?: string

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

OptionalpublicAccess

publicAccess?: PublicAccess

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

Optional ReadonlyremainingRetentionDays

remainingRetentionDays?: number

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

Optional Readonlytype

type?: string

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.

Optional Readonlyversion

version?: string

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

Settings

Member Visibility