Package version:

Interface ContainerGetPropertiesHeaders

Defines headers for Container_getProperties operation.

interface ContainerGetPropertiesHeaders {
    blobPublicAccess?: PublicAccessType;
    clientRequestId?: string;
    date?: any;
    defaultEncryptionScope?: string;
    denyEncryptionScopeOverride?: boolean;
    errorCode?: string;
    etag?: string;
    hasImmutabilityPolicy?: boolean;
    hasLegalHold?: boolean;
    isImmutableStorageWithVersioningEnabled?: boolean;
    lastModified?: any;
    leaseDuration?: LeaseDurationType;
    leaseState?: LeaseStateType;
    leaseStatus?: LeaseStatusType;
    metadata?: {
        [propertyName: string]: string;
    };
    requestId?: string;
    version?: string;
}

Properties

blobPublicAccess? clientRequestId? date? defaultEncryptionScope? denyEncryptionScopeOverride? errorCode? etag? hasImmutabilityPolicy? hasLegalHold? isImmutableStorageWithVersioningEnabled? lastModified? leaseDuration? leaseState? leaseStatus? metadata? requestId? version?

Properties

OptionalblobPublicAccess

blobPublicAccess?: PublicAccessType

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

OptionalclientRequestId

clientRequestId?: string

If a client request id header is sent in the request, this header will be present in the response with the same value.

Optionaldate

date?: any

UTC date/time value generated by the service that indicates the time at which the response was initiated

OptionaldefaultEncryptionScope

defaultEncryptionScope?: string

The default encryption scope for the container.

OptionaldenyEncryptionScopeOverride

denyEncryptionScopeOverride?: boolean

Indicates whether the container's default encryption scope can be overriden.

OptionalerrorCode

errorCode?: string

Error Code

Optionaletag

etag?: string

The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes.

OptionalhasImmutabilityPolicy

hasImmutabilityPolicy?: boolean

Indicates whether the container has an immutability policy set on it.

OptionalhasLegalHold

hasLegalHold?: boolean

Indicates whether the container has a legal hold.

OptionalisImmutableStorageWithVersioningEnabled

isImmutableStorageWithVersioningEnabled?: boolean

Indicates whether version level worm is enabled on a container.

OptionallastModified

lastModified?: any

Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob.

OptionalleaseDuration

leaseDuration?: LeaseDurationType

When a blob is leased, specifies whether the lease is of infinite or fixed duration.

OptionalleaseState

leaseState?: LeaseStateType

Lease state of the blob.

OptionalleaseStatus

leaseStatus?: LeaseStatusType

The current lease status of the blob.

Optionalmetadata

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

OptionalrequestId

requestId?: string

This header uniquely identifies the request that was made and can be used for troubleshooting the request.

Optionalversion

version?: string

Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above.

Settings

Member Visibility