Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/storage-blob

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AccessTier

AccessTier: "P4" | "P6" | "P10" | "P15" | "P20" | "P30" | "P40" | "P50" | "P60" | "P70" | "P80" | "Hot" | "Cool" | "Archive"

Defines values for AccessTier.

AccessTokenGetter

AccessTokenGetter: (options: GetTokenOptions) => Promise<AccessToken>

A function that gets a promise of an access token and allows providing options.

param

the options to pass to the underlying token provider

Type declaration

    • (options: GetTokenOptions): Promise<AccessToken>
    • Parameters

      • options: GetTokenOptions

      Returns Promise<AccessToken>

AccountKind

AccountKind: "Storage" | "BlobStorage" | "StorageV2" | "FileStorage" | "BlockBlobStorage"

Defines values for AccountKind.

AppendBlobAppendBlockFromUrlResponse

AppendBlobAppendBlockFromUrlResponse: AppendBlobAppendBlockFromUrlHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: AppendBlobAppendBlockFromUrlHeaders } }

Contains response data for the appendBlockFromUrl operation.

AppendBlobAppendBlockResponse

AppendBlobAppendBlockResponse: AppendBlobAppendBlockHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: AppendBlobAppendBlockHeaders } }

Contains response data for the appendBlock operation.

AppendBlobCreateResponse

AppendBlobCreateResponse: AppendBlobCreateHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: AppendBlobCreateHeaders } }

Contains response data for the create operation.

AppendBlobSealResponse

AppendBlobSealResponse: AppendBlobSealHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: AppendBlobSealHeaders } }

Contains response data for the seal operation.

ArchiveStatus

ArchiveStatus: "rehydrate-pending-to-hot" | "rehydrate-pending-to-cool"

Defines values for ArchiveStatus.

BlobAbortCopyFromURLResponse

BlobAbortCopyFromURLResponse: BlobAbortCopyFromURLHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobAbortCopyFromURLHeaders } }

Contains response data for the abortCopyFromURL operation.

BlobAcquireLeaseResponse

BlobAcquireLeaseResponse: BlobAcquireLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobAcquireLeaseHeaders } }

Contains response data for the acquireLease operation.

BlobBatchDeleteBlobsResponse

BlobBatchDeleteBlobsResponse: BlobBatchSubmitBatchResponse

Contains response data for the deleteBlobs operation.

BlobBatchSetBlobsAccessTierResponse

BlobBatchSetBlobsAccessTierResponse: BlobBatchSubmitBatchResponse

Contains response data for the setBlobsAccessTier operation.

BlobBatchSubmitBatchResponse

BlobBatchSubmitBatchResponse: ParsedBatchResponse & ServiceSubmitBatchHeaders & { _response: HttpResponse & { parsedHeaders: ServiceSubmitBatchHeaders } }

Contains response data for blob batch operations.

BlobBreakLeaseResponse

BlobBreakLeaseResponse: BlobBreakLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobBreakLeaseHeaders } }

Contains response data for the breakLease operation.

BlobChangeLeaseResponse

BlobChangeLeaseResponse: BlobChangeLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobChangeLeaseHeaders } }

Contains response data for the changeLease operation.

BlobCopyFromURLResponse

BlobCopyFromURLResponse: BlobCopyFromURLHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobCopyFromURLHeaders } }

Contains response data for the copyFromURL operation.

BlobCopySourceTags

BlobCopySourceTags: "REPLACE" | "COPY"

Defines values for BlobCopySourceTags.

BlobCreateSnapshotResponse

BlobCreateSnapshotResponse: BlobCreateSnapshotHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobCreateSnapshotHeaders } }

Contains response data for the createSnapshot operation.

BlobDeleteImmutabilityPolicyResponse

BlobDeleteImmutabilityPolicyResponse: BlobDeleteImmutabilityPolicyHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobDeleteImmutabilityPolicyHeaders } }

Contains response data for the deleteImmutabilityPolicy operation.

BlobDeleteResponse

BlobDeleteResponse: BlobDeleteHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobDeleteHeaders } }

Contains response data for the delete operation.

BlobExpiryOptions

BlobExpiryOptions: string

Defines values for BlobExpiryOptions.
KnownBlobExpiryOptions can be used interchangeably with BlobExpiryOptions, this enum contains the known values that the service supports.

Know values supported by the service

NeverExpire
RelativeToCreation
RelativeToNow
Absolute

BlobGetAccountInfoResponse

BlobGetAccountInfoResponse: BlobGetAccountInfoHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobGetAccountInfoHeaders } }

Contains response data for the getAccountInfo operation.

BlobGetPropertiesResponse

BlobGetPropertiesResponse: BlobGetPropertiesHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobGetPropertiesHeaders } }

Contains response data for the getProperties operation. Contains response data for the BlobClient.getProperties operation.

_response

_response: coreHttp.HttpResponse & { parsedHeaders: BlobGetPropertiesHeaders }

The underlying HTTP response.

Optional acceptRanges

acceptRanges: undefined | string

Indicates that the service supports requests for partial blob content.

Optional accessTier

accessTier: undefined | string

The tier of page blob on a premium storage account or tier of block blob on blob storage LRS accounts. For a list of allowed premium page blob tiers, see https://docs.microsoft.com/en-us/azure/virtual-machines/windows/premium-storage#features. For blob storage LRS accounts, valid values are Hot/Cool/Archive.

Optional accessTierChangedOn

accessTierChangedOn: Date

The time the tier was changed on the object. This is only returned if the tier on the block blob was ever set.

Optional accessTierInferred

accessTierInferred: undefined | false | true

For page blobs on a premium storage account only. If the access tier is not explicitly set on the blob, the tier is inferred based on its content length and this header will be returned with true value.

Optional archiveStatus

archiveStatus: undefined | string

For blob storage LRS accounts, valid values are rehydrate-pending-to-hot/rehydrate-pending-to-cool. If the blob is being rehydrated and is not complete then this header is returned indicating that rehydrate is pending and also tells the destination tier.

Optional blobCommittedBlockCount

blobCommittedBlockCount: undefined | number

The number of committed blocks present in the blob. This header is returned only for append blobs.

Optional blobSequenceNumber

blobSequenceNumber: undefined | number

The current sequence number for a page blob. This header is not returned for block blobs or append blobs

Optional blobType

blobType: BlobType

The blob's type.

Optional cacheControl

cacheControl: undefined | string

This header is returned if it was previously specified for the blob.

Optional clientRequestId

clientRequestId: undefined | string

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

Optional contentDisposition

contentDisposition: undefined | string

This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified.

Optional contentEncoding

contentEncoding: undefined | string

This header returns the value that was specified for the Content-Encoding request header

Optional contentLanguage

contentLanguage: undefined | string

This header returns the value that was specified for the Content-Language request header.

Optional contentLength

contentLength: undefined | number

The size of the blob in bytes. For a page blob, this header returns the value of the x-ms-blob-content-length header that is stored with the blob.

Optional contentMD5

contentMD5: Uint8Array

If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity.

Optional contentType

contentType: undefined | string

The content type specified for the blob. The default content type is 'application/octet-stream'

Optional copyCompletedOn

copyCompletedOn: Date

Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

Optional copyId

copyId: undefined | string

String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.

Optional copyProgress

copyProgress: undefined | string

Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List

Optional copySource

copySource: undefined | string

URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List.

Optional copyStatus

copyStatus: CopyStatusType

State of the copy operation identified by x-ms-copy-id.

Optional copyStatusDescription

copyStatusDescription: undefined | string

Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List

Optional createdOn

createdOn: Date

Returns the date and time the blob was created.

Optional date

date: Date

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

Optional destinationSnapshot

destinationSnapshot: undefined | string

Included if the blob is incremental copy blob or incremental copy snapshot, if x-ms-copy-status is success. Snapshot time of the last successful incremental copy snapshot for this blob.

Optional encryptionKeySha256

encryptionKeySha256: undefined | string

The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key.

Optional encryptionScope

encryptionScope: undefined | string

Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope.

Optional errorCode

errorCode: undefined | string

Error Code

Optional etag

etag: undefined | 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.

Optional expiresOn

expiresOn: Date

The time this blob will expire.

Optional immutabilityPolicyExpiresOn

immutabilityPolicyExpiresOn: Date

UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire.

Optional immutabilityPolicyMode

immutabilityPolicyMode: BlobImmutabilityPolicyMode

Indicates immutability policy mode.

Optional isCurrentVersion

isCurrentVersion: undefined | false | true

The value of this header indicates whether version of this blob is a current version, see also x-ms-version-id header.

Optional isIncrementalCopy

isIncrementalCopy: undefined | false | true

Included if the blob is incremental copy blob.

Optional isSealed

isSealed: undefined | false | true

If this blob has been sealed

Optional isServerEncrypted

isServerEncrypted: undefined | false | true

The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted).

Optional lastAccessed

lastAccessed: Date

UTC date/time value generated by the service that indicates the time at which the blob was last read or written to

Optional lastModified

lastModified: Date

Returns the date and time the blob 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.

Optional leaseDuration

leaseDuration: LeaseDurationType

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

Optional leaseState

leaseState: LeaseStateType

Lease state of the blob.

Optional leaseStatus

leaseStatus: LeaseStatusType

The current lease status of the blob.

Optional legalHold

legalHold: undefined | false | true

Indicates if a legal hold is present on the blob.

Optional metadata

metadata: undefined | {}

Optional objectReplicationDestinationPolicyId

objectReplicationDestinationPolicyId: undefined | string

Object Replication Policy Id of the destination blob.

Optional objectReplicationPolicyId

objectReplicationPolicyId: undefined | string

Optional. Only valid when Object Replication is enabled for the storage container and on the destination blob of the replication.

Optional objectReplicationRules

objectReplicationRules: undefined | {}

Optional. Only valid when Object Replication is enabled for the storage container and on the source blob of the replication. When retrieving this header, it will return the header with the policy id and rule id (e.g. x-ms-or-policyid_ruleid), and the value will be the status of the replication (e.g. complete, failed).

Optional objectReplicationSourceProperties

objectReplicationSourceProperties: ObjectReplicationPolicy[]

Parsed Object Replication Policy Id, Rule Id(s) and status of the source blob.

Optional rehydratePriority

rehydratePriority: RehydratePriority

If an object is in rehydrate pending state then this header is returned with priority of rehydrate.

Optional requestId

requestId: undefined | string

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

Optional tagCount

tagCount: undefined | number

The number of tags associated with the blob

Optional version

version: undefined | 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.

Optional versionId

versionId: undefined | string

A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob.

BlobGetTagsResponse

BlobGetTagsResponse: { tags: Tags } & BlobGetTagsHeaders & { _response: HttpResponse & { bodyAsText: string; parsedBody: BlobTags; parsedHeaders: BlobGetTagsHeaders } }

Contains response data for the getTags operation. Contains response data for the BlobClient.getTags operation.

BlobImmutabilityPolicyMode

BlobImmutabilityPolicyMode: "Mutable" | "Unlocked" | "Locked"

Defines values for BlobImmutabilityPolicyMode.

BlobQueryArrowFieldType

BlobQueryArrowFieldType: "int64" | "bool" | "timestamp[ms]" | "string" | "double" | "decimal"

The type of a BlobQueryArrowField.

BlobReleaseLeaseResponse

BlobReleaseLeaseResponse: BlobReleaseLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobReleaseLeaseHeaders } }

Contains response data for the releaseLease operation.

BlobRenewLeaseResponse

BlobRenewLeaseResponse: BlobRenewLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobRenewLeaseHeaders } }

Contains response data for the renewLease operation.

BlobSetExpiryResponse

BlobSetExpiryResponse: BlobSetExpiryHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobSetExpiryHeaders } }

Contains response data for the setExpiry operation.

BlobSetHttpHeadersResponse

BlobSetHttpHeadersResponse: BlobSetHttpHeadersHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobSetHttpHeadersHeaders } }

Contains response data for the setHttpHeaders operation.

BlobSetImmutabilityPolicyResponse

BlobSetImmutabilityPolicyResponse: BlobSetImmutabilityPolicyHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobSetImmutabilityPolicyHeaders } }

Contains response data for the setImmutabilityPolicy operation.

BlobSetLegalHoldResponse

BlobSetLegalHoldResponse: BlobSetLegalHoldHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobSetLegalHoldHeaders } }

Contains response data for the setLegalHold operation.

BlobSetMetadataResponse

BlobSetMetadataResponse: BlobSetMetadataHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobSetMetadataHeaders } }

Contains response data for the setMetadata operation.

BlobSetTagsResponse

BlobSetTagsResponse: BlobSetTagsHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobSetTagsHeaders } }

Contains response data for the setTags operation.

BlobSetTierResponse

BlobSetTierResponse: BlobSetTierHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobSetTierHeaders } }

Contains response data for the setTier operation.

BlobStartCopyFromURLResponse

BlobStartCopyFromURLResponse: BlobStartCopyFromURLHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobStartCopyFromURLHeaders } }

Contains response data for the startCopyFromURL operation.

BlobType

BlobType: "BlockBlob" | "PageBlob" | "AppendBlob"

Defines values for BlobType.

BlobUndeleteResponse

BlobUndeleteResponse: BlobUndeleteHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobUndeleteHeaders } }

Contains response data for the undelete operation.

BlobUploadCommonResponse

BlobUploadCommonResponse: BlockBlobUploadHeaders & { _response: HttpResponse }

Response type for BlockBlobClient.uploadFile, BlockBlobClient.uploadStream, and {@link BlockBlobClient.uploadBrowserDate}.

BlockBlobCommitBlockListResponse

BlockBlobCommitBlockListResponse: BlockBlobCommitBlockListHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlockBlobCommitBlockListHeaders } }

Contains response data for the commitBlockList operation.

BlockBlobGetBlockListResponse

BlockBlobGetBlockListResponse: BlockBlobGetBlockListHeaders & BlockList & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: BlockList; parsedHeaders: BlockBlobGetBlockListHeaders } }

Contains response data for the getBlockList operation.

BlockBlobPutBlobFromUrlResponse

BlockBlobPutBlobFromUrlResponse: BlockBlobPutBlobFromUrlHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlockBlobPutBlobFromUrlHeaders } }

Contains response data for the putBlobFromUrl operation.

BlockBlobStageBlockFromURLResponse

BlockBlobStageBlockFromURLResponse: BlockBlobStageBlockFromURLHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlockBlobStageBlockFromURLHeaders } }

Contains response data for the stageBlockFromURL operation.

BlockBlobStageBlockResponse

BlockBlobStageBlockResponse: BlockBlobStageBlockHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlockBlobStageBlockHeaders } }

Contains response data for the stageBlock operation.

BlockBlobUploadResponse

BlockBlobUploadResponse: BlockBlobUploadHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlockBlobUploadHeaders } }

Contains response data for the upload operation.

BlockListType

BlockListType: "committed" | "uncommitted" | "all"

Defines values for BlockListType.

Callback

Callback: (...args: any[]) => any

Type declaration

    • (...args: any[]): any
    • Parameters

      • Rest ...args: any[]

      Returns any

ContainerAcquireLeaseResponse

ContainerAcquireLeaseResponse: ContainerAcquireLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ContainerAcquireLeaseHeaders } }

Contains response data for the acquireLease operation.

ContainerBreakLeaseResponse

ContainerBreakLeaseResponse: ContainerBreakLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ContainerBreakLeaseHeaders } }

Contains response data for the breakLease operation.

ContainerChangeLeaseResponse

ContainerChangeLeaseResponse: ContainerChangeLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ContainerChangeLeaseHeaders } }

Contains response data for the changeLease operation.

ContainerCreateResponse

ContainerCreateResponse: ContainerCreateHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ContainerCreateHeaders } }

Contains response data for the create operation.

ContainerDeleteResponse

ContainerDeleteResponse: ContainerDeleteHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ContainerDeleteHeaders } }

Contains response data for the delete operation.

ContainerFilterBlobsResponse

ContainerFilterBlobsResponse: ContainerFilterBlobsHeaders & FilterBlobSegment & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: FilterBlobSegment; parsedHeaders: ContainerFilterBlobsHeaders } }

Contains response data for the filterBlobs operation.

ContainerFindBlobsByTagsSegmentResponse

ContainerFindBlobsByTagsSegmentResponse: FilterBlobSegment & ContainerFilterBlobsHeaders & { _response: HttpResponse & { bodyAsText: string; parsedBody: FilterBlobSegmentModel; parsedHeaders: ContainerFilterBlobsHeaders } }

The response of BlobServiceClient.findBlobsByTags operation.

ContainerGetAccessPolicyResponse

ContainerGetAccessPolicyResponse: { signedIdentifiers: SignedIdentifier[] } & ContainerGetAccessPolicyHeaders & { _response: HttpResponse & { bodyAsText: string; parsedBody: SignedIdentifierModel[]; parsedHeaders: ContainerGetAccessPolicyHeaders } }

Contains response data for the getAccessPolicy operation. Contains response data for the ContainerClient.getAccessPolicy operation.

ContainerGetAccountInfoResponse

ContainerGetAccountInfoResponse: ContainerGetAccountInfoHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ContainerGetAccountInfoHeaders } }

Contains response data for the getAccountInfo operation.

ContainerGetPropertiesResponse

ContainerGetPropertiesResponse: ContainerGetPropertiesHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ContainerGetPropertiesHeaders } }

Contains response data for the getProperties operation.

ContainerListBlobFlatSegmentResponse

ContainerListBlobFlatSegmentResponse: ListBlobsFlatSegmentResponse & ContainerListBlobFlatSegmentHeaders & { _response: HttpResponse & { bodyAsText: string; parsedBody: ListBlobsFlatSegmentResponseModel; parsedHeaders: ContainerListBlobFlatSegmentHeaders } }

Contains response data for the listBlobFlatSegment operation. Contains response data for the listBlobFlatSegment operation.

ContainerListBlobHierarchySegmentResponse

ContainerListBlobHierarchySegmentResponse: ListBlobsHierarchySegmentResponse & ContainerListBlobHierarchySegmentHeaders & { _response: HttpResponse & { bodyAsText: string; parsedBody: ListBlobsHierarchySegmentResponseModel; parsedHeaders: ContainerListBlobHierarchySegmentHeaders } }

Contains response data for the listBlobHierarchySegment operation. Contains response data for the listBlobHierarchySegment operation.

ContainerReleaseLeaseResponse

ContainerReleaseLeaseResponse: ContainerReleaseLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ContainerReleaseLeaseHeaders } }

Contains response data for the releaseLease operation.

ContainerRenameResponse

ContainerRenameResponse: ContainerRenameHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ContainerRenameHeaders } }

Contains response data for the rename operation.

ContainerRenewLeaseResponse

ContainerRenewLeaseResponse: ContainerRenewLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ContainerRenewLeaseHeaders } }

Contains response data for the renewLease operation.

ContainerRestoreResponse

ContainerRestoreResponse: ContainerRestoreHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ContainerRestoreHeaders } }

Contains response data for the restore operation.

ContainerSetAccessPolicyResponse

ContainerSetAccessPolicyResponse: ContainerSetAccessPolicyHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ContainerSetAccessPolicyHeaders } }

Contains response data for the setAccessPolicy operation.

ContainerSetMetadataResponse

ContainerSetMetadataResponse: ContainerSetMetadataHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ContainerSetMetadataHeaders } }

Contains response data for the setMetadata operation.

ContainerSubmitBatchResponse

ContainerSubmitBatchResponse: ContainerSubmitBatchHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ContainerSubmitBatchHeaders }; blobBody?: Promise<Blob>; readableStreamBody?: NodeJS.ReadableStream }

Contains response data for the submitBatch operation.

CopyPollerBlobClient

CopyPollerBlobClient: Pick<BlobClient, "abortCopyFromURL" | "getProperties"> & { startCopyFromURL: any }

Defines the operations from a BlobClient that are needed for the poller returned by BlobClient.beginCopyFromURL to work.

CopyStatusType

CopyStatusType: "pending" | "success" | "aborted" | "failed"

Defines values for CopyStatusType.

CredentialPolicyCreator

CredentialPolicyCreator: (nextPolicy: RequestPolicy, options: RequestPolicyOptions) => CredentialPolicy

A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.

Type declaration

    • Parameters

      • nextPolicy: RequestPolicy
      • options: RequestPolicyOptions

      Returns CredentialPolicy

DeleteSnapshotsOptionType

DeleteSnapshotsOptionType: "include" | "only"

Defines values for DeleteSnapshotsOptionType.

EncryptionAlgorithmType

EncryptionAlgorithmType: "AES256"

Defines values for EncryptionAlgorithmType.

GeoReplicationStatusType

GeoReplicationStatusType: "live" | "bootstrap" | "unavailable"

Defines values for GeoReplicationStatusType.

LeaseDurationType

LeaseDurationType: "infinite" | "fixed"

Defines values for LeaseDurationType.

LeaseOperationResponse

LeaseOperationResponse: Lease & { _response: HttpResponse & { parsedHeaders: Lease } }

Contains the response data for operations that create, modify, or delete a lease.

See BlobLeaseClient.

LeaseStateType

LeaseStateType: "available" | "leased" | "expired" | "breaking" | "broken"

Defines values for LeaseStateType.

LeaseStatusType

LeaseStatusType: "locked" | "unlocked"

Defines values for LeaseStatusType.

ListBlobsIncludeItem

ListBlobsIncludeItem: "copy" | "deleted" | "metadata" | "snapshots" | "uncommittedblobs" | "versions" | "tags" | "immutabilitypolicy" | "legalhold" | "deletedwithversions"

Defines values for ListBlobsIncludeItem.

ListContainersIncludeType

ListContainersIncludeType: "metadata" | "deleted" | "system"

Defines values for ListContainersIncludeType.

ObjectReplicationStatus

ObjectReplicationStatus: "complete" | "failed"

Specifies the Replication Status of a blob. This is used when a storage account has Object Replication Policy(s) applied. See ObjectReplicationPolicy and ObjectReplicationRule.

Operation

Operation: () => Promise<any>

Operation is an async function to be executed and managed by Batch.

Type declaration

    • (): Promise<any>
    • Returns Promise<any>

OutgoingHandler

OutgoingHandler: (body: () => NodeJS.ReadableStream, length: number, offset?: undefined | number) => Promise<any>

OutgoingHandler is an async function triggered by BufferScheduler.

Type declaration

    • (body: () => NodeJS.ReadableStream, length: number, offset?: undefined | number): Promise<any>
    • Parameters

      • body: () => NodeJS.ReadableStream
          • (): NodeJS.ReadableStream
          • Returns NodeJS.ReadableStream

      • length: number
      • Optional offset: undefined | number

      Returns Promise<any>

PageBlobClearPagesResponse

PageBlobClearPagesResponse: PageBlobClearPagesHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: PageBlobClearPagesHeaders } }

Contains response data for the clearPages operation.

PageBlobCopyIncrementalResponse

PageBlobCopyIncrementalResponse: PageBlobCopyIncrementalHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: PageBlobCopyIncrementalHeaders } }

Contains response data for the copyIncremental operation.

PageBlobCreateResponse

PageBlobCreateResponse: PageBlobCreateHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: PageBlobCreateHeaders } }

Contains response data for the create operation.

PageBlobGetPageRangesDiffResponse

PageBlobGetPageRangesDiffResponse: PageBlobGetPageRangesDiffHeaders & PageList & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageList; parsedHeaders: PageBlobGetPageRangesDiffHeaders } }

Contains response data for the getPageRangesDiff operation. Contains response data for the {@link BlobClient.getPageRangesDiff} operation.

_response

_response: HttpResponse & { bodyAsText: string; parsedBody: PageList; parsedHeaders: PageBlobGetPageRangesDiffHeaders }

The underlying HTTP response.

Optional blobContentLength

blobContentLength: undefined | number

The size of the blob in bytes.

Optional clearRange

clearRange: Range[]

Present if the prevSnapshot parameter was specified and there were cleared pages between the previous snapshot and the target snapshot.

Optional clientRequestId

clientRequestId: undefined | string

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

Optional date

date: Date

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

Optional errorCode

errorCode: undefined | string

Error Code

Optional etag

etag: undefined | 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.

Optional lastModified

lastModified: Date

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.

Optional pageRange

pageRange: Range[]

Valid non-overlapping page ranges.

Optional requestId

requestId: undefined | string

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

Optional version

version: undefined | 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.

PageBlobGetPageRangesResponse

PageBlobGetPageRangesResponse: PageBlobGetPageRangesHeaders & PageList & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: PageList; parsedHeaders: PageBlobGetPageRangesHeaders } }

Contains response data for the getPageRanges operation. Contains response data for the {@link BlobClient.getPageRanges} operation.

_response

_response: HttpResponse & { bodyAsText: string; parsedBody: PageList; parsedHeaders: PageBlobGetPageRangesHeaders }

The underlying HTTP response.

Optional blobContentLength

blobContentLength: undefined | number

The size of the blob in bytes.

Optional clearRange

clearRange: Range[]

Present if the prevSnapshot parameter was specified and there were cleared pages between the previous snapshot and the target snapshot.

Optional clientRequestId

clientRequestId: undefined | string

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

Optional date

date: Date

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

Optional errorCode

errorCode: undefined | string

Error Code

Optional etag

etag: undefined | 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.

Optional lastModified

lastModified: Date

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.

Optional pageRange

pageRange: Range[]

Valid non-overlapping page ranges.

Optional requestId

requestId: undefined | string

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

Optional version

version: undefined | 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.

PageBlobResizeResponse

PageBlobResizeResponse: PageBlobResizeHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: PageBlobResizeHeaders } }

Contains response data for the resize operation.

PageBlobUpdateSequenceNumberResponse

PageBlobUpdateSequenceNumberResponse: PageBlobUpdateSequenceNumberHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: PageBlobUpdateSequenceNumberHeaders } }

Contains response data for the updateSequenceNumber operation.

PageBlobUploadPagesFromURLResponse

PageBlobUploadPagesFromURLResponse: PageBlobUploadPagesFromURLHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: PageBlobUploadPagesFromURLHeaders } }

Contains response data for the uploadPagesFromURL operation.

PageBlobUploadPagesResponse

PageBlobUploadPagesResponse: PageBlobUploadPagesHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: PageBlobUploadPagesHeaders } }

Contains response data for the uploadPages operation.

PublicAccessType

PublicAccessType: "container" | "blob"

Defines values for PublicAccessType.

QueryFormatType

QueryFormatType: "delimited" | "json" | "arrow" | "parquet"

Defines values for QueryFormatType.

ReadableStreamGetter

ReadableStreamGetter: (offset: number) => Promise<NodeJS.ReadableStream>

Type declaration

    • (offset: number): Promise<NodeJS.ReadableStream>
    • Parameters

      • offset: number

      Returns Promise<NodeJS.ReadableStream>

RehydratePriority

RehydratePriority: "High" | "Standard"

Defines values for RehydratePriority.

SequenceNumberActionType

SequenceNumberActionType: "max" | "update" | "increment"

Defines values for SequenceNumberActionType.

ServiceFilterBlobsResponse

ServiceFilterBlobsResponse: ServiceFilterBlobsHeaders & FilterBlobSegment & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: FilterBlobSegment; parsedHeaders: ServiceFilterBlobsHeaders } }

Contains response data for the filterBlobs operation.

ServiceFindBlobsByTagsSegmentResponse

ServiceFindBlobsByTagsSegmentResponse: FilterBlobSegment & ServiceFilterBlobsHeaders & { _response: HttpResponse & { bodyAsText: string; parsedBody: FilterBlobSegmentModel; parsedHeaders: ServiceFilterBlobsHeaders } }

The response of BlobServiceClient.findBlobsByTags operation.

ServiceGetAccountInfoResponse

ServiceGetAccountInfoResponse: ServiceGetAccountInfoHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ServiceGetAccountInfoHeaders } }

Contains response data for the getAccountInfo operation.

ServiceGetPropertiesResponse

ServiceGetPropertiesResponse: ServiceGetPropertiesHeaders & BlobServiceProperties & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: BlobServiceProperties; parsedHeaders: ServiceGetPropertiesHeaders } }

Contains response data for the getProperties operation.

ServiceGetStatisticsResponse

ServiceGetStatisticsResponse: ServiceGetStatisticsHeaders & BlobServiceStatistics & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: BlobServiceStatistics; parsedHeaders: ServiceGetStatisticsHeaders } }

Contains response data for the getStatistics operation.

ServiceGetUserDelegationKeyResponse

ServiceGetUserDelegationKeyResponse: UserDelegationKey & ServiceGetUserDelegationKeyHeaders & { _response: HttpResponse & { bodyAsText: string; parsedBody: UserDelegationKeyModel; parsedHeaders: ServiceGetUserDelegationKeyHeaders } }

Contains response data for the getUserDelegationKey operation. Contains response data for the getUserDelegationKey operation.

ServiceListContainersSegmentResponse

ServiceListContainersSegmentResponse: ServiceListContainersSegmentHeaders & ListContainersSegmentResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ListContainersSegmentResponse; parsedHeaders: ServiceListContainersSegmentHeaders } }

Contains response data for the listContainersSegment operation.

ServiceSetPropertiesResponse

ServiceSetPropertiesResponse: ServiceSetPropertiesHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ServiceSetPropertiesHeaders } }

Contains response data for the setProperties operation.

ServiceSubmitBatchResponse

ServiceSubmitBatchResponse: ServiceSubmitBatchHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ServiceSubmitBatchHeaders }; blobBody?: Promise<Blob>; readableStreamBody?: NodeJS.ReadableStream }

Contains response data for the submitBatch operation.

SkuName

SkuName: "Standard_LRS" | "Standard_GRS" | "Standard_RAGRS" | "Standard_ZRS" | "Premium_LRS"

Defines values for SkuName.

StorageErrorCode

StorageErrorCode: string

Defines values for StorageErrorCode.
KnownStorageErrorCode can be used interchangeably with StorageErrorCode, this enum contains the known values that the service supports.

Know values supported by the service

AccountAlreadyExists
AccountBeingCreated
AccountIsDisabled
AuthenticationFailed
AuthorizationFailure
ConditionHeadersNotSupported
ConditionNotMet
EmptyMetadataKey
InsufficientAccountPermissions
InternalError
InvalidAuthenticationInfo
InvalidHeaderValue
InvalidHttpVerb
InvalidInput
InvalidMd5
InvalidMetadata
InvalidQueryParameterValue
InvalidRange
InvalidResourceName
InvalidUri
InvalidXmlDocument
InvalidXmlNodeValue
Md5Mismatch
MetadataTooLarge
MissingContentLengthHeader
MissingRequiredQueryParameter
MissingRequiredHeader
MissingRequiredXmlNode
MultipleConditionHeadersNotSupported
OperationTimedOut
OutOfRangeInput
OutOfRangeQueryParameterValue
RequestBodyTooLarge
ResourceTypeMismatch
RequestUrlFailedToParse
ResourceAlreadyExists
ResourceNotFound
ServerBusy
UnsupportedHeader
UnsupportedXmlNode
UnsupportedQueryParameter
UnsupportedHttpVerb
AppendPositionConditionNotMet
BlobAlreadyExists
BlobImmutableDueToPolicy
BlobNotFound
BlobOverwritten
BlobTierInadequateForContentLength
BlobUsesCustomerSpecifiedEncryption
BlockCountExceedsLimit
BlockListTooLong
CannotChangeToLowerTier
CannotVerifyCopySource
ContainerAlreadyExists
ContainerBeingDeleted
ContainerDisabled
ContainerNotFound
ContentLengthLargerThanTierLimit
CopyAcrossAccountsNotSupported
CopyIdMismatch
FeatureVersionMismatch
IncrementalCopyBlobMismatch
IncrementalCopyOfEralierVersionSnapshotNotAllowed
IncrementalCopySourceMustBeSnapshot
InfiniteLeaseDurationRequired
InvalidBlobOrBlock
InvalidBlobTier
InvalidBlobType
InvalidBlockId
InvalidBlockList
InvalidOperation
InvalidPageRange
InvalidSourceBlobType
InvalidSourceBlobUrl
InvalidVersionForPageBlobOperation
LeaseAlreadyPresent
LeaseAlreadyBroken
LeaseIdMismatchWithBlobOperation
LeaseIdMismatchWithContainerOperation
LeaseIdMismatchWithLeaseOperation
LeaseIdMissing
LeaseIsBreakingAndCannotBeAcquired
LeaseIsBreakingAndCannotBeChanged
LeaseIsBrokenAndCannotBeRenewed
LeaseLost
LeaseNotPresentWithBlobOperation
LeaseNotPresentWithContainerOperation
LeaseNotPresentWithLeaseOperation
MaxBlobSizeConditionNotMet
NoAuthenticationInformation
NoPendingCopyOperation
OperationNotAllowedOnIncrementalCopyBlob
PendingCopyOperation
PreviousSnapshotCannotBeNewer
PreviousSnapshotNotFound
PreviousSnapshotOperationNotSupported
SequenceNumberConditionNotMet
SequenceNumberIncrementTooLarge
SnapshotCountExceeded
SnapshotOperationRateExceeded
SnapshotsPresent
SourceConditionNotMet
SystemInUse
TargetConditionNotMet
UnauthorizedBlobOverwrite
BlobBeingRehydrated
BlobArchived
BlobNotArchived
AuthorizationSourceIPMismatch
AuthorizationProtocolMismatch
AuthorizationPermissionMismatch
AuthorizationServiceMismatch
AuthorizationResourceTypeMismatch

SyncCopyStatusType

SyncCopyStatusType: "success"

Defines values for SyncCopyStatusType.

Tags

Tags: Record<string, string>

Blob tags.

Variables

Const ABORT_ERROR

ABORT_ERROR: any = new AbortError("Reading from the avro stream was aborted.")

Const AVRO_CODEC_KEY

AVRO_CODEC_KEY: string = "avro.codec"

Const AVRO_INIT_BYTES

AVRO_INIT_BYTES: Uint8Array = new Uint8Array([79, 98, 106, 1])

Const AVRO_SCHEMA_KEY

AVRO_SCHEMA_KEY: string = "avro.schema"

Const AVRO_SYNC_MARKER_SIZE

AVRO_SYNC_MARKER_SIZE: number = 16

Const BATCH_MAX_PAYLOAD_IN_BYTES

BATCH_MAX_PAYLOAD_IN_BYTES: number = 4 * SIZE_1_MB

Const BATCH_MAX_REQUEST

BATCH_MAX_REQUEST: 256 = 256

Const BLOCK_BLOB_MAX_BLOCKS

BLOCK_BLOB_MAX_BLOCKS: number = 50000

Const BLOCK_BLOB_MAX_STAGE_BLOCK_BYTES

BLOCK_BLOB_MAX_STAGE_BLOCK_BYTES: number = 4000 * 1024 * 1024

Const BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES

BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES: number = 256 * 1024 * 1024

Const BlobDoesNotUseCustomerSpecifiedEncryption

BlobDoesNotUseCustomerSpecifiedEncryption: "BlobDoesNotUseCustomerSpecifiedEncryption" = "BlobDoesNotUseCustomerSpecifiedEncryption"

Const BlobUsesCustomerSpecifiedEncryptionMsg

BlobUsesCustomerSpecifiedEncryptionMsg: "BlobUsesCustomerSpecifiedEncryption" = "BlobUsesCustomerSpecifiedEncryption"

Const DEFAULT_BLOB_DOWNLOAD_BLOCK_BYTES

DEFAULT_BLOB_DOWNLOAD_BLOCK_BYTES: number = 4 * 1024 * 1024

Const DEFAULT_BLOCK_BUFFER_SIZE_BYTES

DEFAULT_BLOCK_BUFFER_SIZE_BYTES: number = 8 * 1024 * 1024

Const DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS

DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS: number = 5

Const DevelopmentConnectionString

DevelopmentConnectionString: "DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;" = `DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;`

Const ETagAny

ETagAny: "*" = "*"

Const ETagNone

ETagNone: "" = ""

Const EncryptionAlgorithmAES25

EncryptionAlgorithmAES25: "AES256" = "AES256"

Const HTTP_HEADER_DELIMITER

HTTP_HEADER_DELIMITER: ": " = ": "

Const HTTP_LINE_ENDING

HTTP_LINE_ENDING: "" = ""

Const HTTP_VERSION_1_1

HTTP_VERSION_1_1: "HTTP/1.1" = "HTTP/1.1"

Const NOT_FOUND

NOT_FOUND: -1 = -1

Const PathStylePorts

PathStylePorts: string[] = ["10000","10001","10002","10003","10004","10100","10101","10102","10103","10104","11000","11001","11002","11003","11004","11100","11101","11102","11103","11104",]

Const REQUEST_TIMEOUT

REQUEST_TIMEOUT: number = 100 * 1000

Const RETRY_ABORT_ERROR

RETRY_ABORT_ERROR: any = new AbortError("The operation was aborted.")

Const SDK_VERSION

SDK_VERSION: string = "12.12.0-beta.1"

Const SERVICE_VERSION

SERVICE_VERSION: string = "2021-10-04"

Const SIZE_1_MB

SIZE_1_MB: number = 1 * 1024 * 1024

Const SPACE_DELIMITER

SPACE_DELIMITER: " " = " "

Const StorageBlobLoggingAllowedHeaderNames

StorageBlobLoggingAllowedHeaderNames: string[] = ["Access-Control-Allow-Origin","Cache-Control","Content-Length","Content-Type","Date","Request-Id","traceparent","Transfer-Encoding","User-Agent","x-ms-client-request-id","x-ms-date","x-ms-error-code","x-ms-request-id","x-ms-return-client-request-id","x-ms-version","Accept-Ranges","Content-Disposition","Content-Encoding","Content-Language","Content-MD5","Content-Range","ETag","Last-Modified","Server","Vary","x-ms-content-crc64","x-ms-copy-action","x-ms-copy-completion-time","x-ms-copy-id","x-ms-copy-progress","x-ms-copy-status","x-ms-has-immutability-policy","x-ms-has-legal-hold","x-ms-lease-state","x-ms-lease-status","x-ms-range","x-ms-request-server-encrypted","x-ms-server-encrypted","x-ms-snapshot","x-ms-source-range","If-Match","If-Modified-Since","If-None-Match","If-Unmodified-Since","x-ms-access-tier","x-ms-access-tier-change-time","x-ms-access-tier-inferred","x-ms-account-kind","x-ms-archive-status","x-ms-blob-append-offset","x-ms-blob-cache-control","x-ms-blob-committed-block-count","x-ms-blob-condition-appendpos","x-ms-blob-condition-maxsize","x-ms-blob-content-disposition","x-ms-blob-content-encoding","x-ms-blob-content-language","x-ms-blob-content-length","x-ms-blob-content-md5","x-ms-blob-content-type","x-ms-blob-public-access","x-ms-blob-sequence-number","x-ms-blob-type","x-ms-copy-destination-snapshot","x-ms-creation-time","x-ms-default-encryption-scope","x-ms-delete-snapshots","x-ms-delete-type-permanent","x-ms-deny-encryption-scope-override","x-ms-encryption-algorithm","x-ms-if-sequence-number-eq","x-ms-if-sequence-number-le","x-ms-if-sequence-number-lt","x-ms-incremental-copy","x-ms-lease-action","x-ms-lease-break-period","x-ms-lease-duration","x-ms-lease-id","x-ms-lease-time","x-ms-page-write","x-ms-proposed-lease-id","x-ms-range-get-content-md5","x-ms-rehydrate-priority","x-ms-sequence-number-action","x-ms-sku-name","x-ms-source-content-md5","x-ms-source-if-match","x-ms-source-if-modified-since","x-ms-source-if-none-match","x-ms-source-if-unmodified-since","x-ms-tag-count","x-ms-encryption-key-sha256","x-ms-if-tags","x-ms-source-if-tags",]

Const StorageBlobLoggingAllowedQueryParameters

StorageBlobLoggingAllowedQueryParameters: string[] = ["comp","maxresults","rscc","rscd","rsce","rscl","rsct","se","si","sip","sp","spr","sr","srt","ss","st","sv","include","marker","prefix","copyid","restype","blockid","blocklisttype","delimiter","prevsnapshot","ske","skoid","sks","skt","sktid","skv","snapshot",]

Const StorageOAuthScopes

StorageOAuthScopes: string | string[] = "https://storage.azure.com/.default"

The OAuth scope to use with Azure Storage.

Const _defaultHttpClient

_defaultHttpClient: any = new DefaultHttpClient()

Const logger

logger: any = createClientLogger("storage-blob")

The @azure/logger configuration for this package.

Const maxBufferLength

maxBufferLength: any = require("buffer").constants.MAX_LENGTH

maxBufferLength is max size of each buffer in the pooled buffers.

Const packageName

packageName: "azure-storage-blob" = "azure-storage-blob"

Const packageVersion

packageVersion: "12.12.0-beta.1" = "12.12.0-beta.1"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers, /* isXml */ false)

Const xmlSerializer

xmlSerializer: any = new coreHttp.Serializer(Mappers, /* isXml */ true)

Functions

BlobNameToString

  • BlobNameToString(name: BlobName): string

ConvertInternalResponseOfListBlobFlat

ConvertInternalResponseOfListBlobHierarchy

ExtractPageRangeInfoItems

  • ExtractPageRangeInfoItems(getPageRangesSegment: PageBlobGetPageRangesDiffResponseModel): IterableIterator<PageRangeInfo>

NewRetryPolicyFactory

ParseBlobItem

ParseBlobName

  • ParseBlobName(blobNameInXML: any): BlobName

ParseBlobPrefix

  • ParseBlobPrefix(blobPrefixInXML: any): BlobPrefix

ParseBlobProperties

ParseBlobTag

  • ParseBlobTag(blobTagInXML: any): BlobTag

ParseBlobTags

  • ParseBlobTags(blobTagsInXML: any): BlobTags | undefined

ParseBoolean

  • ParseBoolean(content: any): undefined | false | true

ProcessBlobItems

ProcessBlobPrefixes

  • ProcessBlobPrefixes(blobPrefixesInXML: any[]): BlobPrefix[]

SASSignatureValuesSanityCheckAndAutofill

appendToURLPath

  • appendToURLPath(url: string, name: string): string
  • Append a string to URL path. Will remove duplicated "/" in front of the string when URL path ends with a "/".

    Parameters

    • url: string

      Source URL string

    • name: string

      String to be appended to URL

    Returns string

    An updated URL string

appendToURLQuery

  • appendToURLQuery(url: string, queryParts: string): string
  • Append a string to URL query.

    Parameters

    • url: string

      Source URL string.

    • queryParts: string

      String to be appended to the URL query.

    Returns string

    An updated URL string.

arraysEqual

  • arraysEqual(a: Uint8Array, b: Uint8Array): boolean

attachCredential

  • attachCredential<T>(thing: T, credential: TokenCredential): T

base64decode

  • base64decode(encodedString: string): string

base64encode

  • base64encode(content: string): string

beginRefresh

  • beginRefresh(getAccessToken: () => Promise<AccessToken | null>, retryIntervalInMs: number, timeoutInMs: number): Promise<AccessToken>
  • Converts an an unreliable access token getter (which may resolve with null) into an AccessTokenGetter by retrying the unreliable getter in a regular interval.

    Parameters

    • getAccessToken: () => Promise<AccessToken | null>

      a function that produces a promise of an access token that may fail by returning null

        • (): Promise<AccessToken | null>
        • Returns Promise<AccessToken | null>

    • retryIntervalInMs: number

      the time (in milliseconds) to wait between retry attempts

    • timeoutInMs: number

      the timestamp after which the refresh attempt will fail, throwing an exception

    Returns Promise<AccessToken>

    • a promise that, if it resolves, will resolve with an access token

blobToArrayBuffer

  • blobToArrayBuffer(blob: Blob): Promise<ArrayBuffer>

blobToString

  • blobToString(blob: Blob): Promise<string>

createTokenCycler

  • Creates a token cycler from a credential, scopes, and optional settings.

    A token cycler represents a way to reliably retrieve a valid access token from a TokenCredential. It will handle initializing the token, refreshing it when it nears expiration, and synchronizes refresh attempts to avoid concurrency hazards.

    Parameters

    • credential: TokenCredential

      the underlying TokenCredential that provides the access token

    • scopes: string | string[]

      the scopes to request authorization for

    • Optional tokenCyclerOptions: Partial<TokenCyclerOptions>

      optionally override default settings for the cycler

    Returns AccessTokenGetter

    • a function that reliably produces a valid access token

decodeBase64String

  • decodeBase64String(value: string): Uint8Array

delay

  • delay(timeInMs: number, aborter?: AbortSignalLike, abortError?: Error): Promise<void>

ensureCpkIfSpecified

  • ensureCpkIfSpecified(cpk: CpkInfo | undefined, isHttps: boolean): void

escape

  • escape(text: string): string

escapeURLPath

  • escapeURLPath(url: string): string

extractConnectionStringParts

Const fsCreateReadStream

  • fsCreateReadStream(): void

Const fsStat

  • fsStat(): void

generateAccountSASQueryParameters

generateBlobSASQueryParameters

  • ONLY AVAILABLE IN NODE.JS RUNTIME.

    Creates an instance of SASQueryParameters.

    Only accepts required settings needed to create a SAS. For optional settings please set corresponding properties directly, such as permissions, startsOn and identifier.

    WARNING: When identifier is not provided, permissions and expiresOn are required. You MUST assign value to identifier or expiresOn & permissions manually if you initial with this constructor.

    Fill in the required details before running the following snippets.

    Example usage:

    // Generate service level SAS for a container
    const containerSAS = generateBlobSASQueryParameters({
        containerName, // Required
        permissions: ContainerSASPermissions.parse("racwdl"), // Required
        startsOn: new Date(), // Optional
        expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
        ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
        protocol: SASProtocol.HttpsAndHttp, // Optional
        version: "2016-05-31" // Optional
      },
      sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
    ).toString();

    Example using an identifier:

    // Generate service level SAS for a container with identifier
    // startsOn & permissions are optional when identifier is provided
    const identifier = "unique-id";
    await containerClient.setAccessPolicy(undefined, [
      {
        accessPolicy: {
          expiresOn: new Date(new Date().valueOf() + 86400), // Date type
          permissions: ContainerSASPermissions.parse("racwdl").toString(),
          startsOn: new Date() // Date type
        },
        id: identifier
      }
    ]);
    
    const containerSAS = generateBlobSASQueryParameters(
      {
        containerName, // Required
        identifier // Required
      },
      sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
    ).toString();

    Example using a blob name:

    // Generate service level SAS for a blob
    const blobSAS = generateBlobSASQueryParameters({
        containerName, // Required
        blobName, // Required
        permissions: BlobSASPermissions.parse("racwd"), // Required
        startsOn: new Date(), // Optional
        expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
        cacheControl: "cache-control-override", // Optional
        contentDisposition: "content-disposition-override", // Optional
        contentEncoding: "content-encoding-override", // Optional
        contentLanguage: "content-language-override", // Optional
        contentType: "content-type-override", // Optional
        ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
        protocol: SASProtocol.HttpsAndHttp, // Optional
        version: "2016-05-31" // Optional
      },
      sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
    ).toString();

    Parameters

    Returns SASQueryParameters

  • ONLY AVAILABLE IN NODE.JS RUNTIME.

    Creates an instance of SASQueryParameters. WARNING: identifier will be ignored when generating user delegation SAS, permissions and expiresOn are required.

    Example usage:

    // Generate user delegation SAS for a container
    const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
    const containerSAS = generateBlobSASQueryParameters({
        containerName, // Required
        permissions: ContainerSASPermissions.parse("racwdl"), // Required
        startsOn, // Optional. Date type
        expiresOn, // Required. Date type
        ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
        protocol: SASProtocol.HttpsAndHttp, // Optional
        version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
      },
      userDelegationKey, // UserDelegationKey
      accountName
    ).toString();

    Parameters

    • blobSASSignatureValues: BlobSASSignatureValues

      -

    • userDelegationKey: UserDelegationKey

      Return value of blobServiceClient.getUserDelegationKey()

    • accountName: string

      -

    Returns SASQueryParameters

generateBlobSASQueryParameters20150405

  • ONLY AVAILABLE IN NODE.JS RUNTIME. IMPLEMENTATION FOR API VERSION FROM 2015-04-05 AND BEFORE 2018-11-09.

    Creates an instance of SASQueryParameters.

    Only accepts required settings needed to create a SAS. For optional settings please set corresponding properties directly, such as permissions, startsOn and identifier.

    WARNING: When identifier is not provided, permissions and expiresOn are required. You MUST assign value to identifier or expiresOn & permissions manually if you initial with this constructor.

    Parameters

    Returns SASQueryParameters

generateBlobSASQueryParameters20181109

  • ONLY AVAILABLE IN NODE.JS RUNTIME. IMPLEMENTATION FOR API VERSION FROM 2018-11-09.

    Creates an instance of SASQueryParameters.

    Only accepts required settings needed to create a SAS. For optional settings please set corresponding properties directly, such as permissions, startsOn and identifier.

    WARNING: When identifier is not provided, permissions and expiresOn are required. You MUST assign value to identifier or expiresOn & permissions manually if you initial with this constructor.

    Parameters

    Returns SASQueryParameters

generateBlobSASQueryParameters20201206

  • ONLY AVAILABLE IN NODE.JS RUNTIME. IMPLEMENTATION FOR API VERSION FROM 2020-12-06.

    Creates an instance of SASQueryParameters.

    Only accepts required settings needed to create a SAS. For optional settings please set corresponding properties directly, such as permissions, startsOn and identifier.

    WARNING: When identifier is not provided, permissions and expiresOn are required. You MUST assign value to identifier or expiresOn & permissions manually if you initial with this constructor.

    Parameters

    Returns SASQueryParameters

generateBlobSASQueryParametersUDK20181109

generateBlobSASQueryParametersUDK20200210

generateBlobSASQueryParametersUDK20201206

generateBlockID

  • generateBlockID(blockIDPrefix: string, blockIndex: number): string

getAccountNameFromUrl

  • getAccountNameFromUrl(url: string): string

getBodyAsText

  • getBodyAsText(batchResponse: ServiceSubmitBatchResponseModel): Promise<string>

getCachedDefaultHttpClient

  • getCachedDefaultHttpClient(): IHttpClient

getCanonicalName

  • getCanonicalName(accountName: string, containerName: string, blobName?: undefined | string): string

getChallenge

  • getChallenge(response: HttpOperationResponse): string | undefined

getProxyUriFromDevConnString

  • getProxyUriFromDevConnString(connectionString: string): string

getURLParameter

  • getURLParameter(url: string, name: string): string | string[] | undefined

getURLPath

  • getURLPath(url: string): string | undefined

getURLPathAndQuery

  • getURLPathAndQuery(url: string): string | undefined

getURLQueries

  • getURLQueries(url: string): {}

getURLScheme

  • getURLScheme(url: string): string | undefined

getValueInConnString

  • getValueInConnString(connectionString: string, argument: "BlobEndpoint" | "AccountName" | "AccountKey" | "DefaultEndpointsProtocol" | "EndpointSuffix" | "SharedAccessSignature"): string
  • Parameters

    • connectionString: string
    • argument: "BlobEndpoint" | "AccountName" | "AccountKey" | "DefaultEndpointsProtocol" | "EndpointSuffix" | "SharedAccessSignature"

    Returns string

httpAuthorizationToString

  • httpAuthorizationToString(httpAuthorization?: HttpAuthorization): string | undefined

iEqual

  • iEqual(str1: string, str2: string): boolean

ipRangeToString

isIpEndpointStyle

  • isIpEndpointStyle(parsedUrl: URLBuilder): boolean

isPipelineLike

  • isPipelineLike(pipeline: unknown): pipeline is PipelineLike
  • A helper to decide if a given argument satisfies the Pipeline contract

    Parameters

    • pipeline: unknown

      An argument that may be a Pipeline

    Returns pipeline is PipelineLike

    true when the argument satisfies the Pipeline contract

newPipeline

  • Creates a new Pipeline object with Credential provided.

    Parameters

    • Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

      Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.

    • Default value pipelineOptions: StoragePipelineOptions = {}

      Optional. Options.

    Returns Pipeline

    A new Pipeline object.

padStart

  • padStart(currentString: string, targetLength: number, padString?: string): string

parseObjectReplicationRecord

  • parseObjectReplicationRecord(objectReplicationRecord?: Record<string, string>): ObjectReplicationPolicy[] | undefined

rangeResponseFromModel

  • rangeResponseFromModel(response: PageBlobGetPageRangesResponseModel | PageBlobGetPageRangesDiffResponseModel): PageBlobGetPageRangesResponse | PageBlobGetPageRangesDiffResponse
  • Function that converts PageRange and ClearRange to a common Range object. PageRange and ClearRange have start and end while Range offset and count this function normalizes to Range.

    Parameters

    • response: PageBlobGetPageRangesResponseModel | PageBlobGetPageRangesDiffResponseModel

      Model PageBlob Range response

    Returns PageBlobGetPageRangesResponse | PageBlobGetPageRangesDiffResponse

rangeToString

  • rangeToString(iRange: Range): string

readStreamToLocalFile

  • readStreamToLocalFile(rs: NodeJS.ReadableStream, file: string): Promise<void>
  • ONLY AVAILABLE IN NODE.JS RUNTIME.

    Writes the content of a readstream to a local file. Returns a Promise which is completed after the file handle is closed.

    Parameters

    • rs: NodeJS.ReadableStream

      The read stream.

    • file: string

      Destination file path.

    Returns Promise<void>

sanitizeHeaders

  • sanitizeHeaders(originalHeader: HttpHeaders): HttpHeaders

sanitizeURL

  • sanitizeURL(url: string): string

setURLHost

  • setURLHost(url: string, host: string): string

setURLParameter

  • setURLParameter(url: string, name: string, value?: undefined | string): string
  • Set URL parameter name and value. If name exists in URL parameters, old value will be replaced by name key. If not provide value, the parameter will be deleted.

    Parameters

    • url: string

      Source URL string

    • name: string

      Parameter name

    • Optional value: undefined | string

      Parameter value

    Returns string

    An updated URL string

storageBearerTokenChallengeAuthenticationPolicy

  • storageBearerTokenChallengeAuthenticationPolicy(credential: TokenCredential, scopes: string | string[]): RequestPolicyFactory
  • Creates a new factory for a RequestPolicy that applies a bearer token to the requests' Authorization headers.

    Parameters

    • credential: TokenCredential

      The TokenCredential implementation that can supply the bearer token.

    • scopes: string | string[]

      The scopes for which the bearer token applies.

    Returns RequestPolicyFactory

streamToBuffer

  • streamToBuffer(stream: NodeJS.ReadableStream, buffer: Buffer, offset: number, end: number, encoding?: BufferEncoding): Promise<void>
  • Reads a readable stream into buffer. Fill the buffer from offset to end.

    Parameters

    • stream: NodeJS.ReadableStream

      A Node.js Readable stream

    • buffer: Buffer

      Buffer to be filled, length must greater than or equal to offset

    • offset: number

      From which position in the buffer to be filled, inclusive

    • end: number

      To which position in the buffer to be filled, exclusive

    • Optional encoding: BufferEncoding

      Encoding of the Readable stream

    Returns Promise<void>

streamToBuffer2

  • streamToBuffer2(stream: NodeJS.ReadableStream, buffer: Buffer, encoding?: BufferEncoding): Promise<number>
  • Reads a readable stream into buffer entirely.

    throws

    RangeError If buffer size is not big enough.

    Parameters

    • stream: NodeJS.ReadableStream

      A Node.js Readable stream

    • buffer: Buffer

      Buffer to be filled, length must greater than or equal to offset

    • Optional encoding: BufferEncoding

      Encoding of the Readable stream

    Returns Promise<number>

    with the count of bytes read.

streamToBuffer3

  • streamToBuffer3(readableStream: NodeJS.ReadableStream, encoding?: BufferEncoding): Promise<Buffer>
  • Reads a readable stream into a buffer.

    Parameters

    • readableStream: NodeJS.ReadableStream
    • Optional encoding: BufferEncoding

      Encoding of the Readable stream

    Returns Promise<Buffer>

    with the count of bytes read.

toAccessTier

toBlobTags

toBlobTagsString

  • toBlobTagsString(tags?: Tags): string | undefined

toQuerySerialization

toTags

truncatedISO8061Date

  • truncatedISO8061Date(date: Date, withMilliseconds?: boolean): string
  • Rounds a date off to seconds.

    Parameters

    • date: Date

      -

    • Default value withMilliseconds: boolean = true

      If true, YYYY-MM-DDThh:mm:ss.fffffffZ will be returned; If false, YYYY-MM-DDThh:mm:ssZ will be returned.

    Returns string

    Date string in ISO8061 format, with or without 7 milliseconds component

utf8ByteLength

  • utf8ByteLength(str: string): number

Object literals

Const AccessPolicy

AccessPolicy: object

serializedName

serializedName: string = "AccessPolicy"

type

type: object

className

className: string = "AccessPolicy"

name

name: string = "Composite"

modelProperties

modelProperties: object

expiresOn

expiresOn: object

serializedName

serializedName: string = "Expiry"

xmlName

xmlName: string = "Expiry"

type

type: object

name

name: string = "String"

permissions

permissions: object

serializedName

serializedName: string = "Permission"

xmlName

xmlName: string = "Permission"

type

type: object

name

name: string = "String"

startsOn

startsOn: object

serializedName

serializedName: string = "Start"

xmlName

xmlName: string = "Start"

type

type: object

name

name: string = "String"

Const AppendBlobAppendBlockExceptionHeaders

AppendBlobAppendBlockExceptionHeaders: object

serializedName

serializedName: string = "AppendBlob_appendBlockExceptionHeaders"

type

type: object

className

className: string = "AppendBlobAppendBlockExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AppendBlobAppendBlockFromUrlExceptionHeaders

AppendBlobAppendBlockFromUrlExceptionHeaders: object

serializedName

serializedName: string = "AppendBlob_appendBlockFromUrlExceptionHeaders"

type

type: object

className

className: string = "AppendBlobAppendBlockFromUrlExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AppendBlobAppendBlockFromUrlHeaders

AppendBlobAppendBlockFromUrlHeaders: object

serializedName

serializedName: string = "AppendBlob_appendBlockFromUrlHeaders"

type

type: object

className

className: string = "AppendBlobAppendBlockFromUrlHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

blobAppendOffset

blobAppendOffset: object

serializedName

serializedName: string = "x-ms-blob-append-offset"

xmlName

xmlName: string = "x-ms-blob-append-offset"

type

type: object

name

name: string = "String"

blobCommittedBlockCount

blobCommittedBlockCount: object

serializedName

serializedName: string = "x-ms-blob-committed-block-count"

xmlName

xmlName: string = "x-ms-blob-committed-block-count"

type

type: object

name

name: string = "Number"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

xmlName

xmlName: string = "content-md5"

type

type: object

name

name: string = "ByteArray"

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

xmlName

xmlName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: string = "String"

encryptionScope

encryptionScope: object

serializedName

serializedName: string = "x-ms-encryption-scope"

xmlName

xmlName: string = "x-ms-encryption-scope"

type

type: object

name

name: string = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

xmlName

xmlName: string = "etag"

type

type: object

name

name: string = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-request-server-encrypted"

xmlName

xmlName: string = "x-ms-request-server-encrypted"

type

type: object

name

name: string = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

xmlName

xmlName: string = "last-modified"

type

type: object

name

name: string = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

name: string = "String"

xMsContentCrc64

xMsContentCrc64: object

serializedName

serializedName: string = "x-ms-content-crc64"

xmlName

xmlName: string = "x-ms-content-crc64"

type

type: object

name

name: string = "ByteArray"

Const AppendBlobAppendBlockHeaders

AppendBlobAppendBlockHeaders: object

serializedName

serializedName: string = "AppendBlob_appendBlockHeaders"

type

type: object

className

className: string = "AppendBlobAppendBlockHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

blobAppendOffset

blobAppendOffset: object

serializedName

serializedName: string = "x-ms-blob-append-offset"

xmlName

xmlName: string = "x-ms-blob-append-offset"

type

type: object

name

name: string = "String"

blobCommittedBlockCount

blobCommittedBlockCount: object

serializedName

serializedName: string = "x-ms-blob-committed-block-count"

xmlName

xmlName: string = "x-ms-blob-committed-block-count"

type

type: object

name

name: string = "Number"

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

name: string = "String"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

xmlName

xmlName: string = "content-md5"

type

type: object

name

name: string = "ByteArray"

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

xmlName

xmlName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: string = "String"

encryptionScope

encryptionScope: object

serializedName

serializedName: string = "x-ms-encryption-scope"

xmlName

xmlName: string = "x-ms-encryption-scope"

type

type: object

name

name: string = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

xmlName

xmlName: string = "etag"

type

type: object

name

name: string = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-request-server-encrypted"

xmlName

xmlName: string = "x-ms-request-server-encrypted"

type

type: object

name

name: string = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

xmlName

xmlName: string = "last-modified"

type

type: object

name

name: string = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

name: string = "String"

xMsContentCrc64

xMsContentCrc64: object

serializedName

serializedName: string = "x-ms-content-crc64"

xmlName

xmlName: string = "x-ms-content-crc64"

type

type: object

name

name: string = "ByteArray"

Const AppendBlobCreateExceptionHeaders

AppendBlobCreateExceptionHeaders: object

serializedName

serializedName: string = "AppendBlob_createExceptionHeaders"

type

type: object

className

className: string = "AppendBlobCreateExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AppendBlobCreateHeaders

AppendBlobCreateHeaders: object

serializedName

serializedName: string = "AppendBlob_createHeaders"

type

type: object

className

className: string = "AppendBlobCreateHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

name: string = "String"

contentMD5

contentMD5: object

serializedName

serializedName: string = "content-md5"

xmlName

xmlName: string = "content-md5"

type

type: object

name

name: string = "ByteArray"

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

encryptionKeySha256

encryptionKeySha256: object

serializedName

serializedName: string = "x-ms-encryption-key-sha256"

xmlName

xmlName: string = "x-ms-encryption-key-sha256"

type

type: object

name

name: string = "String"

encryptionScope

encryptionScope: object

serializedName

serializedName: string = "x-ms-encryption-scope"

xmlName

xmlName: string = "x-ms-encryption-scope"

type

type: object

name

name: string = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

xmlName

xmlName: string = "etag"

type

type: object

name

name: string = "String"

isServerEncrypted

isServerEncrypted: object

serializedName

serializedName: string = "x-ms-request-server-encrypted"

xmlName

xmlName: string = "x-ms-request-server-encrypted"

type

type: object

name

name: string = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

xmlName

xmlName: string = "last-modified"

type

type: object

name

name: string = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

name: string = "String"

versionId

versionId: object

serializedName

serializedName: string = "x-ms-version-id"

xmlName

xmlName: string = "x-ms-version-id"

type

type: object

name

name: string = "String"

Const AppendBlobSealExceptionHeaders

AppendBlobSealExceptionHeaders: object

serializedName

serializedName: string = "AppendBlob_sealExceptionHeaders"

type

type: object

className

className: string = "AppendBlobSealExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const AppendBlobSealHeaders

AppendBlobSealHeaders: object

serializedName

serializedName: string = "AppendBlob_sealHeaders"

type

type: object

className

className: string = "AppendBlobSealHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

etag

etag: object

serializedName

serializedName: string = "etag"

xmlName

xmlName: string = "etag"

type

type: object

name

name: string = "String"

isSealed

isSealed: object

serializedName

serializedName: string = "x-ms-blob-sealed"

xmlName

xmlName: string = "x-ms-blob-sealed"

type

type: object

name

name: string = "Boolean"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

xmlName

xmlName: string = "last-modified"

type

type: object

name

name: string = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const ArrowConfiguration

ArrowConfiguration: object

serializedName

serializedName: string = "ArrowConfiguration"

xmlName

xmlName: string = "ArrowConfiguration"

type

type: object

className

className: string = "ArrowConfiguration"

name

name: string = "Composite"

modelProperties

modelProperties: object

schema

schema: object

required

required: boolean = true

serializedName

serializedName: string = "Schema"

xmlElementName

xmlElementName: string = "Field"

xmlIsWrapped

xmlIsWrapped: boolean = true

xmlName

xmlName: string = "Schema"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ArrowField"

name

name: string = "Composite"

Const ArrowField

ArrowField: object

serializedName

serializedName: string = "ArrowField"

xmlName

xmlName: string = "Field"

type

type: object

className

className: string = "ArrowField"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

name: string = "String"

precision

precision: object

serializedName

serializedName: string = "Precision"

xmlName

xmlName: string = "Precision"

type

type: object

name

name: string = "Number"

scale

scale: object

serializedName

serializedName: string = "Scale"

xmlName

xmlName: string = "Scale"

type

type: object

name

name: string = "Number"

type

type: object

required

required: boolean = true

serializedName

serializedName: string = "Type"

xmlName

xmlName: string = "Type"

type

type: object

name

name: string = "String"

Const BlobAbortCopyFromURLExceptionHeaders

BlobAbortCopyFromURLExceptionHeaders: object

serializedName

serializedName: string = "Blob_abortCopyFromURLExceptionHeaders"

type

type: object

className

className: string = "BlobAbortCopyFromURLExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const BlobAbortCopyFromURLHeaders

BlobAbortCopyFromURLHeaders: object

serializedName

serializedName: string = "Blob_abortCopyFromURLHeaders"

type

type: object

className

className: string = "BlobAbortCopyFromURLHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const BlobAcquireLeaseExceptionHeaders

BlobAcquireLeaseExceptionHeaders: object

serializedName

serializedName: string = "Blob_acquireLeaseExceptionHeaders"

type

type: object

className

className: string = "BlobAcquireLeaseExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const BlobAcquireLeaseHeaders

BlobAcquireLeaseHeaders: object

serializedName

serializedName: string = "Blob_acquireLeaseHeaders"

type

type: object

className

className: string = "BlobAcquireLeaseHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

etag

etag: object

serializedName

serializedName: string = "etag"

xmlName

xmlName: string = "etag"

type

type: object

name

name: string = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

xmlName

xmlName: string = "last-modified"

type

type: object

name

name: string = "DateTimeRfc1123"

leaseId

leaseId: object

serializedName

serializedName: string = "x-ms-lease-id"

xmlName

xmlName: string = "x-ms-lease-id"

type

type: object

name

name: string = "String"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const BlobBreakLeaseExceptionHeaders

BlobBreakLeaseExceptionHeaders: object

serializedName

serializedName: string = "Blob_breakLeaseExceptionHeaders"

type

type: object

className

className: string = "BlobBreakLeaseExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const BlobBreakLeaseHeaders

BlobBreakLeaseHeaders: object

serializedName

serializedName: string = "Blob_breakLeaseHeaders"

type

type: object

className

className: string = "BlobBreakLeaseHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "x-ms-client-request-id"

xmlName

xmlName: string = "x-ms-client-request-id"

type

type: object

name

name: string = "String"

date

date: object

serializedName

serializedName: string = "date"

xmlName

xmlName: string = "date"

type

type: object

name

name: string = "DateTimeRfc1123"

etag

etag: object

serializedName

serializedName: string = "etag"

xmlName

xmlName: string = "etag"

type

type: object

name

name: string = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

xmlName

xmlName: string = "last-modified"

type

type: object

name

name: string = "DateTimeRfc1123"

leaseTime

leaseTime: object

serializedName

serializedName: string = "x-ms-lease-time"

xmlName

xmlName: string = "x-ms-lease-time"

type

type: object

name

name: string = "Number"

requestId

requestId: object

serializedName

serializedName: string = "x-ms-request-id"

xmlName

xmlName: string = "x-ms-request-id"

type

type: object

name

name: string = "String"

version

version: object

serializedName

serializedName: string = "x-ms-version"

xmlName

xmlName: string = "x-ms-version"

type

type: object

name

name: string = "String"

Const BlobChangeLeaseExceptionHeaders

BlobChangeLeaseExceptionHeaders: object

serializedName

serializedName: string = "Blob_changeLeaseExceptionHeaders"

type

type: object

className

className: string = "BlobChangeLeaseExceptionHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

name: string = "String"

Const BlobChangeLeaseHeaders

BlobChangeLeaseHeaders: object

serializedName

serializedName: string = "Blob_changeLeaseHeaders"

type

type: object

className

className: string = "BlobChangeLeaseHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object