@azure/storage-blob

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. Possible values include: 'P4', 'P6', 'P10', 'P15', 'P20', 'P30', 'P40', 'P50', 'P60', 'P70', 'P80', 'Hot', 'Cool', 'Archive'

readonly

AccountKind

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

Defines values for AccountKind. Possible values include: 'Storage', 'BlobStorage', 'StorageV2', 'FileStorage', 'BlockBlobStorage'

readonly

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. Possible values include: 'rehydrate-pending-to-hot', 'rehydrate-pending-to-cool'

readonly

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.

BlobCreateSnapshotResponse

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

Contains response data for the createSnapshot operation.

BlobDeleteResponse

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

Contains response data for the deleteMethod operation.

BlobDeleteType

BlobDeleteType: "Permanent"

Defines values for BlobDeleteType. Possible values include: 'Permanent'

readonly

BlobExpiryOptions

BlobExpiryOptions: "NeverExpire" | "RelativeToCreation" | "RelativeToNow" | "Absolute"

Defines values for BlobExpiryOptions. Possible values include: 'NeverExpire', 'RelativeToCreation', 'RelativeToNow', 'Absolute'

readonly

BlobGetAccessControlResponse

BlobGetAccessControlResponse: BlobGetAccessControlHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobGetAccessControlHeaders } }

Contains response data for the getAccessControl operation.

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. Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'

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. Possible values include: 'pending', 'success', 'aborted', 'failed'

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

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 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. Possible values include: 'infinite', 'fixed'

Optional leaseState

leaseState: LeaseStateType

Lease state of the blob. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'

Optional leaseStatus

leaseStatus: LeaseStatusType

The current lease status of the blob. Possible values include: 'locked', 'unlocked'

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 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. Possible values include: 'High', 'Standard'

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.

BlobQueryArrowFieldType

The type of a BlobQueryArrowField.

BlobReleaseLeaseResponse

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

Contains response data for the releaseLease operation.

BlobRenameResponse

BlobRenameResponse: BlobRenameHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobRenameHeaders } }

Contains response data for the rename operation.

BlobRenewLeaseResponse

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

Contains response data for the renewLease operation.

BlobSetAccessControlResponse

BlobSetAccessControlResponse: BlobSetAccessControlHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: BlobSetAccessControlHeaders } }

Contains response data for the setAccessControl 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.

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. Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'

readonly

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: BlockList & BlockBlobGetBlockListHeaders & { _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. Possible values include: 'committed', 'uncommitted', 'all'

readonly

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 deleteMethod 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. Possible values include: 'pending', 'success', 'aborted', 'failed'

readonly

CredentialPolicyCreator

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

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

Type declaration

- (nextPolicy: RequestPolicy, options: RequestPolicyOptions): CredentialPolicy
- Parameters
  - nextPolicy: RequestPolicy
  - options: RequestPolicyOptions
  Returns CredentialPolicy

DeleteSnapshotsOptionType

DeleteSnapshotsOptionType: "include" | "only"

Defines values for DeleteSnapshotsOptionType. Possible values include: 'include', 'only'

readonly

DirectoryCreateResponse

DirectoryCreateResponse: DirectoryCreateHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: DirectoryCreateHeaders } }

Contains response data for the create operation.

DirectoryDeleteResponse

DirectoryDeleteResponse: DirectoryDeleteHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: DirectoryDeleteHeaders } }

Contains response data for the deleteMethod operation.

DirectoryGetAccessControlResponse

DirectoryGetAccessControlResponse: DirectoryGetAccessControlHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: DirectoryGetAccessControlHeaders } }

Contains response data for the getAccessControl operation.

DirectoryRenameResponse

DirectoryRenameResponse: DirectoryRenameHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: DirectoryRenameHeaders } }

Contains response data for the rename operation.

DirectorySetAccessControlResponse

DirectorySetAccessControlResponse: DirectorySetAccessControlHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: DirectorySetAccessControlHeaders } }

Contains response data for the setAccessControl operation.

EncryptionAlgorithmType

EncryptionAlgorithmType: "AES256"

Defines values for EncryptionAlgorithmType. Possible values include: 'AES256'

readonly

GeoReplicationStatusType

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

Defines values for GeoReplicationStatusType. Possible values include: 'live', 'bootstrap', 'unavailable'

readonly

LeaseDurationType

LeaseDurationType: "infinite" | "fixed"

Defines values for LeaseDurationType. Possible values include: 'infinite', 'fixed'

readonly

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. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'

readonly

LeaseStatusType

LeaseStatusType: "locked" | "unlocked"

Defines values for LeaseStatusType. Possible values include: 'locked', 'unlocked'

readonly

ListBlobsIncludeItem

Defines values for ListBlobsIncludeItem. Possible values include: 'copy', 'deleted', 'metadata', 'snapshots', 'uncommittedblobs', 'versions', 'tags'

readonly

ListContainersIncludeType

ListContainersIncludeType: "metadata" | "deleted"

Defines values for ListContainersIncludeType. Possible values include: 'metadata', 'deleted'

readonly

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: PageList & PageBlobGetPageRangesDiffHeaders & { _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

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: PageList & PageBlobGetPageRangesHeaders & { _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

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.

PathRenameMode

PathRenameMode: "legacy" | "posix"

Defines values for PathRenameMode. Possible values include: 'legacy', 'posix'

readonly

PublicAccessType

PublicAccessType: "container" | "blob"

Defines values for PublicAccessType. Possible values include: 'container', 'blob'

readonly

QueryFormatType

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

Defines values for QueryFormatType. Possible values include: 'delimited', 'json', 'arrow'

readonly

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. Possible values include: 'High', 'Standard'

readonly

SequenceNumberActionType

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

Defines values for SequenceNumberActionType. Possible values include: 'max', 'update', 'increment'

readonly

ServiceFilterBlobsResponse

ServiceFilterBlobsResponse: FilterBlobSegment & ServiceFilterBlobsHeaders & { _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: BlobServiceProperties & ServiceGetPropertiesHeaders & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: BlobServiceProperties; parsedHeaders: ServiceGetPropertiesHeaders } }

Contains response data for the getProperties operation.

ServiceGetStatisticsResponse

ServiceGetStatisticsResponse: BlobServiceStatistics & ServiceGetStatisticsHeaders & { _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: ListContainersSegmentResponse & ServiceListContainersSegmentHeaders & { _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. Possible values include: 'Standard_LRS', 'Standard_GRS', 'Standard_RAGRS', 'Standard_ZRS', 'Premium_LRS'

readonly

StorageErrorCode

Defines values for StorageErrorCode. Possible values include: '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', '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', 'SnaphotOperationRateExceeded', 'SnapshotsPresent', 'SourceConditionNotMet', 'SystemInUse', 'TargetConditionNotMet', 'UnauthorizedBlobOverwrite', 'BlobBeingRehydrated', 'BlobArchived', 'BlobNotArchived', 'AuthorizationSourceIPMismatch', 'AuthorizationProtocolMismatch', 'AuthorizationPermissionMismatch', 'AuthorizationServiceMismatch', 'AuthorizationResourceTypeMismatch'

readonly

SyncCopyStatusType

SyncCopyStatusType: "success"

Defines values for SyncCopyStatusType. Possible values include: 'success'

readonly

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 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 RETRY_ABORT_ERROR

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

Const SDK_VERSION

SDK_VERSION: string = "12.5.0"

Const SERVICE_VERSION

SERVICE_VERSION: string = "2020-06-12"

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 createSpan

createSpan: any = createSpanFunction({packagePrefix: "Azure.Storage.Blob",namespace: "Microsoft.Storage"})

Creates a span using the global tracer.

internal

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.5.0" = "12.5.0"

Functions

NewRetryPolicyFactory

NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory

- Defined in storage-blob/src/policies/StorageRetryPolicy.ts:27
A factory method used to generated a RetryPolicy factory.

Parameters
- Optional retryOptions: StorageRetryOptions
  
  -
Returns RequestPolicyFactory

SASSignatureValuesSanityCheckAndAutofill

SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues: BlobSASSignatureValues): BlobSASSignatureValues

- Defined in storage-blob/src/sas/BlobSASSignatureValues.ts:741
Parameters
- blobSASSignatureValues: BlobSASSignatureValues
Returns BlobSASSignatureValues

appendToURLPath

appendToURLPath(url: string, name: string): string

- Defined in storage-blob/src/utils/utils.common.ts:233
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

- Defined in storage-blob/src/utils/utils.common.ts:364
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

- Defined in storage-internal-avro/src/utils/utils.common.ts:9
Parameters
- a: Uint8Array
- b: Uint8Array
Returns boolean

attachCredential

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

- Defined in storage-blob/src/utils/utils.common.ts:735
Attach a TokenCredential to an object.

Type parameters
- T
Parameters
- thing: T
  
  -
- credential: TokenCredential
  
  -
Returns T

base64decode

base64decode(encodedString: string): string

- Defined in storage-blob/src/utils/utils.common.ts:409
Base64 decode.

Parameters
- encodedString: string
  
  -
Returns string

base64encode

base64encode(content: string): string

- Defined in storage-blob/src/utils/utils.common.ts:400
Base64 encode.

Parameters
- content: string
  
  -
Returns string

blobToArrayBuffer

blobToArrayBuffer(blob: Blob): Promise<ArrayBuffer>

- Defined in storage-blob/src/utils/utils.browser.ts:9
Convert a Browser Blob object into ArrayBuffer.

Parameters
- blob: Blob
  
  -
Returns Promise<ArrayBuffer>

blobToString

blobToString(blob: Blob): Promise<string>

- Defined in storage-blob/src/utils/utils.browser.ts:25
Convert a Browser Blob object into string.

Parameters
- blob: Blob
  
  -
Returns Promise<string>

convertTracingToRequestOptionsBase

convertTracingToRequestOptionsBase(options?: OperationOptions): Pick<RequestOptionsBase, "spanOptions">

- Defined in storage-blob/src/utils/tracing.ts:23
internal

Adapt the tracing options from OperationOptions to what they need to be for RequestOptionsBase (when we update to later OpenTelemetry versions this is now two separate fields, not just one).

Parameters
- Optional options: OperationOptions
Returns Pick<RequestOptionsBase, "spanOptions">

delay

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

- Defined in storage-blob/src/utils/utils.common.ts:443
Delay specified time interval.

Parameters
- timeInMs: number
  
  -
- Optional aborter: AbortSignalLike
  
  -
- Optional abortError: Error
  
  -
Returns Promise<void>

ensureCpkIfSpecified

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

- Defined in storage-blob/src/models.ts:183
Parameters
- cpk: CpkInfo | undefined
- isHttps: boolean
Returns void

escape

escape(text: string): string

- Defined in storage-blob/src/utils/utils.common.ts:217
Internal escape method implemented Strategy Two mentioned in escapeURL() description.

Parameters
- text: string
  
  -
Returns string

escapeURLPath

escapeURLPath(url: string): string

- Defined in storage-blob/src/utils/utils.common.ts:73
Reserved URL characters must be properly escaped for Storage services like Blob or File.

URL encode and escape strategy for JS SDKs

When customers pass a URL string into XxxClient classes constructor, the URL string may already be URL encoded or not. But before sending to Azure Storage server, the URL must be encoded. However, it's hard for a SDK to guess whether the URL string has been encoded or not. We have 2 potential strategies, and chose strategy two for the XxxClient constructors.

Strategy One: Assume the customer URL string is not encoded, and always encode URL string in SDK.

This is what legacy V2 SDK does, simple and works for most of the cases.
- When customer URL string is "http://account.blob.core.windows.net/con/b:", SDK will encode it to "http://account.blob.core.windows.net/con/b%3A" and send to server. A blob named "b:" will be created.
- When customer URL string is "http://account.blob.core.windows.net/con/b%3A", SDK will encode it to "http://account.blob.core.windows.net/con/b%253A" and send to server. A blob named "b%3A" will be created.
But this strategy will make it not possible to create a blob with "?" in it's name. Because when customer URL string is "http://account.blob.core.windows.net/con/blob?name", the "?name" will be treated as URL paramter instead of blob name. If customer URL string is "http://account.blob.core.windows.net/con/blob%3Fname", a blob named "blob%3Fname" will be created. V2 SDK doesn't have this issue because it doesn't allow customer pass in a full URL, it accepts a separate blob name and encodeURIComponent for it. We cannot accept a SDK cannot create a blob name with "?". So we implement strategy two:

Strategy Two: SDK doesn't assume the URL has been encoded or not. It will just escape the special characters.

This is what V10 Blob Go SDK does. It accepts a URL type in Go, and call url.EscapedPath() to escape the special chars unescaped.
- When customer URL string is "http://account.blob.core.windows.net/con/b:", SDK will escape ":" like "http://account.blob.core.windows.net/con/b%3A" and send to server. A blob named "b:" will be created.
- When customer URL string is "http://account.blob.core.windows.net/con/b%3A", There is no special characters, so send "http://account.blob.core.windows.net/con/b%3A" to server. A blob named "b:" will be created.
- When customer URL string is "http://account.blob.core.windows.net/con/b%253A", There is no special characters, so send "http://account.blob.core.windows.net/con/b%253A" to server. A blob named "b%3A" will be created.
This strategy gives us flexibility to create with any special characters. But "%" will be treated as a special characters, if the URL string is not encoded, there shouldn't a "%" in the URL string, otherwise the URL is not a valid URL. If customer needs to create a blob with "%" in it's blob name, use "%25" instead of "%". Just like above 3rd sample. And following URL strings are invalid:
Another special character is "?", use "%2F" to represent a blob name with "?" in a URL string.

Strategy for containerName, blobName or other specific XXXName parameters in methods such as containerClient.getBlobClient(blobName)

We will apply strategy one, and call encodeURIComponent for these parameters like blobName. Because what customers passes in is a plain name instead of a URL.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

see

https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-shares--directories--files--and-metadata
Parameters
- url: string
  
  -
Returns string

extractConnectionStringParts

extractConnectionStringParts(connectionString: string): ConnectionString

- Defined in storage-blob/src/utils/utils.common.ts:135
Extracts the parts of an Azure Storage account connection string.

Parameters
- connectionString: string
  
  Connection string.
Returns ConnectionString

String key value pairs of the storage account's url and credentials.

Const fsCreateReadStream

fsCreateReadStream(): void

- Defined in storage-blob/src/utils/utils.browser.ts:44
Returns void

Const fsStat

fsStat(): void

- Defined in storage-blob/src/utils/utils.browser.ts:42
ONLY AVAILABLE IN NODE.JS RUNTIME.

Promisified version of fs.stat().

Returns void

generateAccountSASQueryParameters

generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

- Defined in storage-blob/src/sas/AccountSASSignatureValues.ts:84
ONLY AVAILABLE IN NODE.JS RUNTIME.

Generates a SASQueryParameters object which contains all SAS query parameters needed to make an actual REST request.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

Parameters
- accountSASSignatureValues: AccountSASSignatureValues
  
  -
- sharedKeyCredential: StorageSharedKeyCredential
  
  -
Returns SASQueryParameters

generateBlobSASQueryParameters

generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters
generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

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

blobSASSignatureValues: BlobSASSignatureValues

-
sharedKeyCredential: StorageSharedKeyCredential

-

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

generateBlobSASQueryParameters20150405(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

- Defined in storage-blob/src/sas/BlobSASSignatureValues.ts:317
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
- blobSASSignatureValues: BlobSASSignatureValues
  
  -
- sharedKeyCredential: StorageSharedKeyCredential
  
  -
Returns SASQueryParameters

generateBlobSASQueryParameters20181109

generateBlobSASQueryParameters20181109(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

- Defined in storage-blob/src/sas/BlobSASSignatureValues.ts:414
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
- blobSASSignatureValues: BlobSASSignatureValues
  
  -
- sharedKeyCredential: StorageSharedKeyCredential
  
  -
Returns SASQueryParameters

generateBlobSASQueryParametersUDK20181109

generateBlobSASQueryParametersUDK20181109(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKeyCredential: UserDelegationKeyCredential): SASQueryParameters

- Defined in storage-blob/src/sas/BlobSASSignatureValues.ts:518
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.

WARNING: identifier will be ignored, permissions and expiresOn are required.

Parameters
- blobSASSignatureValues: BlobSASSignatureValues
  
  -
- userDelegationKeyCredential: UserDelegationKeyCredential
  
  -
Returns SASQueryParameters

generateBlobSASQueryParametersUDK20200210

generateBlobSASQueryParametersUDK20200210(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKeyCredential: UserDelegationKeyCredential): SASQueryParameters

- Defined in storage-blob/src/sas/BlobSASSignatureValues.ts:629
ONLY AVAILABLE IN NODE.JS RUNTIME. IMPLEMENTATION FOR API VERSION FROM 2020-02-10.

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.

WARNING: identifier will be ignored, permissions and expiresOn are required.

Parameters
- blobSASSignatureValues: BlobSASSignatureValues
  
  -
- userDelegationKeyCredential: UserDelegationKeyCredential
  
  -
Returns SASQueryParameters

generateBlockID

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

- Defined in storage-blob/src/utils/utils.common.ts:418
Generate a 64 bytes base64 block ID string.

Parameters
- blockIDPrefix: string
- blockIndex: number
  
  -
Returns string

getAccountNameFromUrl

getAccountNameFromUrl(url: string): string

- Defined in storage-blob/src/utils/utils.common.ts:536
Extracts account name from the url

Parameters
- url: string
  
  url to extract the account name from
Returns string

with the account name

getBodyAsText

getBodyAsText(batchResponse: ServiceSubmitBatchResponseModel): Promise<string>

- Defined in storage-blob/src/BatchUtils.ts:8
Parameters
- batchResponse: ServiceSubmitBatchResponseModel
Returns Promise<string>

getCachedDefaultHttpClient

getCachedDefaultHttpClient(): IHttpClient

- Defined in storage-blob/src/utils/cache.ts:9
Returns IHttpClient

getCanonicalName

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

- Defined in storage-blob/src/sas/BlobSASSignatureValues.ts:731
Parameters
- accountName: string
- containerName: string
- Optional blobName: undefined | string
Returns string

getProxyUriFromDevConnString

getProxyUriFromDevConnString(connectionString: string): string

- Defined in storage-blob/src/utils/utils.common.ts:94
Parameters
- connectionString: string
Returns string

getURLParameter

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

- Defined in storage-blob/src/utils/utils.common.ts:264
Get URL parameter by name.

Parameters
- url: string
  
  -
- name: string
  
  -
Returns string | string[] | undefined

getURLPath

getURLPath(url: string): string | undefined

- Defined in storage-blob/src/utils/utils.common.ts:287
Get URL path from an URL string.

Parameters
- url: string
  
  Source URL string
Returns string | undefined

getURLPathAndQuery

getURLPathAndQuery(url: string): string | undefined

- Defined in storage-blob/src/utils/utils.common.ts:307
Get URL path and query from an URL string.

Parameters
- url: string
  
  Source URL string
Returns string | undefined

getURLQueries

getURLQueries(url: string): {}

- Defined in storage-blob/src/utils/utils.common.ts:328
Get URL query key value pairs from an URL string.

Parameters
- url: string
  
  -
Returns {}
- [key: string]: string

getURLScheme

getURLScheme(url: string): string | undefined

- Defined in storage-blob/src/utils/utils.common.ts:297
Get URL scheme from an URL string.

Parameters
- url: string
  
  Source URL string
Returns string | undefined

getValueInConnString

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

- Defined in storage-blob/src/utils/utils.common.ts:110
Parameters
- connectionString: string
- argument: "BlobEndpoint" | "AccountName" | "AccountKey" | "DefaultEndpointsProtocol" | "EndpointSuffix" | "SharedAccessSignature"
Returns string

iEqual

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

- Defined in storage-blob/src/utils/utils.common.ts:527
If two strings are equal when compared case insensitive.

Parameters
- str1: string
  
  -
- str2: string
  
  -
Returns boolean

ipRangeToString

ipRangeToString(ipRange: SasIPRange): string

- Defined in storage-blob/src/sas/SasIPRange.ts:27
Generate SasIPRange format string. For example:

"8.8.8.8" or "1.1.1.1-255.255.255.255"

Parameters
- ipRange: SasIPRange
  
  -
Returns string

isIpEndpointStyle

isIpEndpointStyle(parsedUrl: URLBuilder): boolean

- Defined in storage-blob/src/utils/utils.common.ts:558
Parameters
- parsedUrl: URLBuilder
Returns boolean

newPipeline

newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

- Defined in storage-blob/src/Pipeline.ts:153
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

- Defined in storage-blob/src/utils/utils.common.ts:475
String.prototype.padStart()

Parameters
- currentString: string
  
  -
- targetLength: number
  
  -
- Default value padString: string = " "
  
  -
Returns string

parseObjectReplicationRecord

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

- Defined in storage-blob/src/utils/utils.common.ts:692
Parameters
- Optional objectReplicationRecord: Record<string, string>
Returns ObjectReplicationPolicy[] | undefined

rangeResponseFromModel

rangeResponseFromModel(response: PageBlobGetPageRangesResponseModel | PageBlobGetPageRangesDiffResponseModel): PageBlobGetPageRangesResponse | PageBlobGetPageRangesDiffResponse

- Defined in storage-blob/src/PageBlobRangeResponse.ts:86
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

- Defined in storage-blob/src/Range.ts:28
Generate a range string. For example:

"bytes=255-" or "bytes=0-511"

Parameters
- iRange: Range
  
  -
Returns string

readStreamToLocalFile

readStreamToLocalFile(rs: NodeJS.ReadableStream, file: string): Promise<void>

- Defined in storage-blob/src/utils/utils.node.ts:138
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

- Defined in storage-blob/src/utils/utils.common.ts:507
Parameters
- originalHeader: HttpHeaders
Returns HttpHeaders

sanitizeURL

sanitizeURL(url: string): string

- Defined in storage-blob/src/utils/utils.common.ts:498
Parameters
- url: string
Returns string

setURLHost

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

- Defined in storage-blob/src/utils/utils.common.ts:276
Set URL host.

Parameters
- url: string
  
  Source URL string
- host: string
  
  New host string
Returns string

An updated URL string

setURLParameter

setURLParameter(url: string, name: string, value?: undefined | string): string

- Defined in storage-blob/src/utils/utils.common.ts:252
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

streamToBuffer

streamToBuffer(stream: NodeJS.ReadableStream, buffer: Buffer, offset: number, end: number, encoding?: undefined | string): Promise<void>

- Defined in storage-blob/src/utils/utils.node.ts:16
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: undefined | string
  
  Encoding of the Readable stream
Returns Promise<void>

streamToBuffer2

streamToBuffer2(stream: NodeJS.ReadableStream, buffer: Buffer, encoding?: undefined | string): Promise<number>

- Defined in storage-blob/src/utils/utils.node.ts:72
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: undefined | string
  
  Encoding of the Readable stream
Returns Promise<number>

with the count of bytes read.

streamToBuffer3

streamToBuffer3(readableStream: NodeJS.ReadableStream, encoding?: undefined | string): Promise<Buffer>

- Defined in storage-blob/src/utils/utils.node.ts:114
Reads a readable stream into a buffer.

Parameters
- readableStream: NodeJS.ReadableStream
- Optional encoding: undefined | string
  
  Encoding of the Readable stream
Returns Promise<Buffer>

with the count of bytes read.

toAccessTier

toAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string | undefined): AccessTier | undefined

- Defined in storage-blob/src/models.ts:173
Parameters
- tier: BlockBlobTier | PremiumPageBlobTier | string | undefined
Returns AccessTier | undefined

toBlobTags

toBlobTags(tags?: Tags): BlobTags | undefined

- Defined in storage-blob/src/utils/utils.common.ts:601
Convert Tags type to BlobTags.

Parameters
- Optional tags: Tags
  
  -
Returns BlobTags | undefined

toBlobTagsString

toBlobTagsString(tags?: Tags): string | undefined

- Defined in storage-blob/src/utils/utils.common.ts:580
Convert Tags to encoded string.

Parameters
- Optional tags: Tags
  
  -
Returns string | undefined

toQuerySerialization

toQuerySerialization(textConfiguration?: BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration | BlobQueryArrowConfiguration): QuerySerialization | undefined

- Defined in storage-blob/src/utils/utils.common.ts:644
Convert BlobQueryTextConfiguration to QuerySerialization type.

Parameters
- Optional textConfiguration: BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration | BlobQueryArrowConfiguration
  
  -
Returns QuerySerialization | undefined

toTags

toTags(tags?: BlobTags): Tags | undefined

- Defined in storage-blob/src/utils/utils.common.ts:627
Covert BlobTags to Tags type.

Parameters
- Optional tags: BlobTags
  
  -
Returns Tags | undefined

truncatedISO8061Date

truncatedISO8061Date(date: Date, withMilliseconds?: boolean): string

- Defined in storage-blob/src/utils/utils.common.ts:386
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

- Defined in storage-blob/src/BatchUtils.ts:24
Parameters
- str: string
Returns number

Object literals

Const AccessPolicy

AccessPolicy: object

serializedName

serializedName: string = "AccessPolicy"

type

type: object

className

className: string = "AccessPolicy"

name

modelProperties

className

className: string = "AppendBlobAppendBlockHeaders"

name

modelProperties

className

className: string = "AppendBlobCreateHeaders"

name

modelProperties

className

className: string = "AppendBlobSealHeaders"

name

modelProperties

className

className: string = "AppendPositionAccessConditions"

name

modelProperties

className

className: string = "ArrowConfiguration"

name

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

element

element: object

type

type: object

className

className: string = "ArrowField"

name

Const ArrowField

ArrowField: object

serializedName

serializedName: string = "ArrowField"

xmlName

xmlName: string = "Field"

type

type: object

className

className: string = "ArrowField"

name

modelProperties

modelProperties: object

className

className: string = "BlobAcquireLeaseHeaders"

name

modelProperties

className

className: string = "BlobBreakLeaseHeaders"

name

modelProperties

className

className: string = "BlobChangeLeaseHeaders"

name

modelProperties

className

className: string = "BlobCopyFromURLHeaders"

name

modelProperties

className

className: string = "BlobCreateSnapshotHeaders"

name

modelProperties

className

className: string = "BlobDeleteHeaders"

name

modelProperties

className

className: string = "BlobDownloadHeaders"

name

modelProperties

className

className: string = "BlobFlatListSegment"

name

modelProperties

modelProperties: object

blobItems

blobItems: object

required

required: boolean = true

serializedName

className

className: string = "BlobGetAccessControlHeaders"

name

modelProperties

className

className: string = "BlobGetAccountInfoHeaders"

name

modelProperties

modelProperties: object

accountKind

allowedValues

allowedValues: string[] = ["Standard_LRS","Standard_GRS","Standard_RAGRS","Standard_ZRS","Premium_LRS"]

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

Const BlobGetPropertiesHeaders

BlobGetPropertiesHeaders: object

serializedName

serializedName: string = "blob-getproperties-headers"

type

type: object

className

className: string = "BlobGetPropertiesHeaders"

name

modelProperties

name

modelProperties

className

className: string = "BlobHTTPHeaders"

name

modelProperties

type

type: object

className

className: string = "BlobHierarchyListSegment"

name

modelProperties

modelProperties: object

blobItems

blobItems: object

required

required: boolean = true

serializedName

serializedName: string = "BlobItems"

xmlElementName

xmlElementName: string = "Blob"

xmlName

xmlName: string = "BlobItems"

type

type: object

name

element

element: object

type

type: object

className

className: string = "BlobItemInternal"

name

blobPrefixes

blobPrefixes: object

serializedName

serializedName: string = "BlobPrefixes"

xmlElementName

xmlElementName: string = "BlobPrefix"

xmlName

xmlName: string = "BlobPrefixes"

type

type: object

name

element

element: object

type

type: object

className

className: string = "BlobPrefix"

name

Const BlobItemInternal

BlobItemInternal: object

serializedName

serializedName: string = "BlobItemInternal"

xmlName

xmlName: string = "Blob"

type

type: object

className

className: string = "BlobItemInternal"

name

modelProperties

modelProperties: object

blobTags

blobTags: object

serializedName

serializedName: string = "BlobTags"

xmlName

xmlName: string = "Tags"

type

type: object

className

className: string = "BlobTags"

name

deleted

deleted: object

required

required: boolean = true

serializedName

serializedName: string = "Deleted"

xmlName

xmlName: string = "Deleted"

type

type: object

name

isCurrentVersion

isCurrentVersion: object

serializedName

required

required: boolean = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

objectReplicationMetadata

objectReplicationMetadata: object

serializedName

serializedName: string = "ObjectReplicationMetadata"

xmlName

xmlName: string = "OrMetadata"

type

type: object

name

value

value: object

type

type: object

name

properties

properties: object

required

required: boolean = true

serializedName

serializedName: string = "Properties"

xmlName

xmlName: string = "Properties"

type

type: object

className

className: string = "BlobPropertiesInternal"

name

snapshot

name

modelProperties

modelProperties: object

name

required

required: boolean = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

Const BlobPropertiesInternal

BlobPropertiesInternal: object

serializedName

serializedName: string = "BlobPropertiesInternal"

xmlName

xmlName: string = "Properties"

type

type: object

className

className: string = "BlobPropertiesInternal"

name

modelProperties

name

modelProperties

className

className: string = "BlobRenameHeaders"

name

modelProperties

className

className: string = "BlobRenewLeaseHeaders"

name

modelProperties

modelProperties: object

geoReplication

className

className: string = "BlobSetExpiryHeaders"

name

modelProperties

className

className: string = "BlobSetHTTPHeadersHeaders"

name

modelProperties

className

className: string = "BlobSetMetadataHeaders"

name

modelProperties

className

className: string = "BlobSetTagsHeaders"

name

modelProperties

className

className: string = "BlobSetTierHeaders"

name

modelProperties

className

className: string = "BlobStartCopyFromURLHeaders"

name

modelProperties

type

type: object

className

className: string = "BlobTag"

name

modelProperties

className

className: string = "BlobUndeleteHeaders"

name

modelProperties

className

className: string = "Block"

name

modelProperties

modelProperties: object

name

required

required: boolean = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

size

className

className: string = "BlockBlobGetBlockListHeaders"

name

modelProperties

className

className: string = "BlockBlobPutBlobFromUrlHeaders"

name

modelProperties

className

className: string = "BlockBlobStageBlockFromURLHeaders"

name

modelProperties

className

className: string = "BlockBlobStageBlockHeaders"

name

modelProperties

className

className: string = "BlockBlobUploadHeaders"

name

modelProperties

className

className: string = "BlockList"

name

modelProperties

modelProperties: object

committedBlocks

committedBlocks: object

serializedName

serializedName: string = "CommittedBlocks"

xmlElementName

xmlElementName: string = "Block"

xmlIsWrapped

xmlIsWrapped: boolean = true

xmlName

xmlName: string = "CommittedBlocks"

type

type: object

name

element

element: object

type

type: object

className

className: string = "Block"

name

uncommittedBlocks

uncommittedBlocks: object

serializedName

serializedName: string = "UncommittedBlocks"

xmlElementName

xmlElementName: string = "Block"

type: object

className

className: string = "BlockLookupList"

name

modelProperties

modelProperties: object

committed

committed: object

serializedName

serializedName: string = "Committed"

xmlElementName

xmlElementName: string = "Committed"

xmlName

xmlName: string = "Committed"

type

type: object

name

element

element: object

type

type: object

name

latest

latest: object

serializedName

serializedName: string = "Latest"

xmlElementName

xmlElementName: string = "Latest"

xmlName

xmlName: string = "Latest"

type

type: object

name

element

element: object

type

type: object

name

uncommitted

uncommitted: object

serializedName

serializedName: string = "Uncommitted"

xmlElementName

xmlElementName: string = "Uncommitted"

xmlName

xmlName: string = "Uncommitted"

type

type: object

name

element

element: object

type

type: object

name

Const ClearRange

ClearRange: object

serializedName

serializedName: string = "ClearRange"

type

type: object

className

className: string = "ClearRange"

name

modelProperties

modelProperties: object

end

end: object

required

required: boolean = true

serializedName

serializedName: string = "End"

xmlName

xmlName: string = "End"

type

type: object

name

start

className

className: string = "ContainerBreakLeaseHeaders"

name

modelProperties

className

className: string = "ContainerChangeLeaseHeaders"

name

modelProperties

className

className: string = "ContainerCreateHeaders"

name

modelProperties

className

className: string = "ContainerDeleteHeaders"

name

modelProperties

className

className: string = "ContainerEncryptionScope"

name

modelProperties

className

className: string = "ContainerGetAccessPolicyHeaders"

name

modelProperties

className

className: string = "ContainerGetAccountInfoHeaders"

name

modelProperties

modelProperties: object

accountKind

allowedValues

allowedValues: string[] = ["Standard_LRS","Standard_GRS","Standard_RAGRS","Standard_ZRS","Premium_LRS"]

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

Const ContainerGetPropertiesHeaders

ContainerGetPropertiesHeaders: object

serializedName

serializedName: string = "container-getproperties-headers"

type

type: object

className

className: string = "ContainerGetPropertiesHeaders"

name

modelProperties

className

className: string = "ContainerItem"

name

modelProperties

modelProperties: object

deleted

deleted: object

serializedName

required

required: boolean = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

properties

properties: object

required

className

className: string = "ContainerListBlobHierarchySegmentHeaders"

name

modelProperties

className

className: string = "ContainerProperties"

name

modelProperties

type

type: object

name

hasImmutabilityPolicy

hasImmutabilityPolicy: object

serializedName

serializedName: string = "HasImmutabilityPolicy"

xmlName

xmlName: string = "HasImmutabilityPolicy"

type

type: object

className

className: string = "ContainerRenameHeaders"

name

modelProperties

className

className: string = "ContainerRenewLeaseHeaders"

name

modelProperties

className

className: string = "ContainerRestoreHeaders"

name

modelProperties

className

className: string = "ContainerSetAccessPolicyHeaders"

name

modelProperties

className

className: string = "ContainerSetMetadataHeaders"

name

modelProperties

className

className: string = "ContainerSubmitBatchHeaders"

name

modelProperties

className

className: string = "CorsRule"

name

modelProperties

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

Const CpkInfo

encryptionKeySha256: object

xmlName

xmlName: string = "encryptionKeySha256"

type

type: object

name

Const DEFAULT_RETRY_OPTIONS

DEFAULT_RETRY_OPTIONS: object

maxRetryDelayInMs

maxRetryDelayInMs: number = 120 * 1000

maxTries

maxTries: number = 4

retryDelayInMs

retryDelayInMs: number = 4 * 1000

retryPolicyType

retryPolicyType: EXPONENTIAL = StorageRetryPolicyType.EXPONENTIAL

secondaryHost

secondaryHost: string = ""

tryTimeoutInMs

tryTimeoutInMs: undefined = undefined

Const DataLakeStorageError

DataLakeStorageError: object

serializedName

serializedName: string = "DataLakeStorageError"

type

type: object

className

className: string = "DataLakeStorageError"

name

modelProperties

modelProperties: object

dataLakeStorageErrorDetails

name

Const DirectoryCreateHeaders

DirectoryCreateHeaders: object

serializedName

serializedName: string = "directory-create-headers"

type

type: object

className

className: string = "DirectoryCreateHeaders"

name

modelProperties

className

className: string = "DirectoryDeleteHeaders"

name

modelProperties

className

className: string = "DirectoryGetAccessControlHeaders"

name

modelProperties

className

className: string = "DirectoryHttpHeaders"

name

modelProperties

className

className: string = "DirectoryRenameHeaders"

name

modelProperties

className

className: string = "DirectorySetAccessControlHeaders"

name

modelProperties

type

type: object

className

className: string = "FilterBlobItem"

name

serializedName: string = "Tags"

xmlName

xmlName: string = "Tags"

type

type: object

className

className: string = "BlobTags"

name

Const FilterBlobSegment

FilterBlobSegment: object

serializedName

serializedName: string = "FilterBlobSegment"

xmlName

xmlName: string = "EnumerationResults"

type

type: object

className

className: string = "FilterBlobSegment"

name

modelProperties

modelProperties: object

blobs

blobs: object

required

required: boolean = true

serializedName

serializedName: string = "Blobs"

xmlElementName

xmlElementName: string = "Blob"

xmlIsWrapped

xmlIsWrapped: boolean = true

xmlName

xmlName: string = "Blobs"

type

type: object

name

element

element: object

type

type: object

className

className: string = "FilterBlobItem"

name

continuationToken

continuationToken: object

serializedName

serializedName: string = "NextMarker"

xmlName

xmlName: string = "NextMarker"

type

type: object

name

serviceEndpoint

serviceEndpoint: object

required

required: boolean = true

serializedName

serializedName: string = "ServiceEndpoint"

xmlIsAttribute

xmlIsAttribute: boolean = true

xmlName

xmlName: string = "ServiceEndpoint"

type

type: object

HTTP_RANGE_NOT_SATISFIABLE

HTTP_RANGE_NOT_SATISFIABLE: number = 416

Const HeaderConstants

HeaderConstants: object

AUTHORIZATION

AUTHORIZATION: string = "Authorization"

AUTHORIZATION_SCHEME

AUTHORIZATION_SCHEME: string = "Bearer"

CONTENT_ENCODING

CONTENT_ENCODING: string = "Content-Encoding"

CONTENT_ID

CONTENT_ID: string = "Content-ID"

CONTENT_LANGUAGE

CONTENT_LANGUAGE: string = "Content-Language"

CONTENT_LENGTH

CONTENT_LENGTH: string = "Content-Length"

CONTENT_MD5

CONTENT_MD5: string = "Content-Md5"

CONTENT_TRANSFER_ENCODING

CONTENT_TRANSFER_ENCODING: string = "Content-Transfer-Encoding"

CONTENT_TYPE

CONTENT_TYPE: string = "Content-Type"

COOKIE

COOKIE: string = "Cookie"

DATE

DATE: string = "date"

IF_MATCH

IF_MATCH: string = "if-match"

IF_MODIFIED_SINCE

IF_MODIFIED_SINCE: string = "if-modified-since"

IF_NONE_MATCH

IF_NONE_MATCH: string = "if-none-match"

IF_UNMODIFIED_SINCE

IF_UNMODIFIED_SINCE: string = "if-unmodified-since"

PREFIX_FOR_STORAGE

PREFIX_FOR_STORAGE: string = "x-ms-"

RANGE

RANGE: string = "Range"

USER_AGENT

USER_AGENT: string = "User-Agent"

X_MS_CLIENT_REQUEST_ID

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

X_MS_COPY_SOURCE

X_MS_COPY_SOURCE: string = "x-ms-copy-source"

X_MS_DATE

X_MS_DATE: string = "x-ms-date"

X_MS_ERROR_CODE

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

X_MS_VERSION

X_MS_VERSION: string = "x-ms-version"

Const JsonTextConfiguration

JsonTextConfiguration: object

serializedName

serializedName: string = "JsonTextConfiguration"

type

type: object

className

className: string = "JsonTextConfiguration"

name

modelProperties

modelProperties: object

recordSeparator

xmlName

xmlName: string = "Expiry"

type

type: object

name

startsOn

className

className: string = "ListBlobsFlatSegmentResponse"

name

modelProperties

modelProperties: object

containerName

containerName: object

required

type

type: object

className

className: string = "BlobFlatListSegment"

name

serviceEndpoint

type

type: object

className

className: string = "BlobHierarchyListSegment"

name

serviceEndpoint

xmlIsWrapped

xmlIsWrapped: boolean = true

xmlName

xmlName: string = "Containers"

type

type: object

serviceEndpoint: object

required

xmlName

xmlName: string = "Delete"

type

type: object

name

read

read: object

required

required: boolean = true

serializedName

serializedName: string = "Read"

xmlName

xmlName: string = "Read"

type

type: object

name

retentionPolicy

retentionPolicy: object

required

required: boolean = true

serializedName

serializedName: string = "RetentionPolicy"

xmlName

xmlName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

className

className: string = "PageBlobClearPagesHeaders"

name

modelProperties

className

className: string = "PageBlobCopyIncrementalHeaders"

name

modelProperties

className

className: string = "PageBlobCreateHeaders"

name

modelProperties

className

className: string = "PageBlobGetPageRangesDiffHeaders"

name

modelProperties

className

className: string = "PageBlobGetPageRangesHeaders"

name

modelProperties

className

className: string = "PageBlobResizeHeaders"

name

modelProperties

className

className: string = "PageBlobUpdateSequenceNumberHeaders"

name

modelProperties

className

className: string = "PageBlobUploadPagesFromURLHeaders"

name

modelProperties

className

className: string = "PageBlobUploadPagesHeaders"

name

modelProperties

className

className: string = "PageList"

name

modelProperties

modelProperties: object

clearRange

clearRange: object

serializedName

serializedName: string = "ClearRange"

xmlElementName

xmlElementName: string = "ClearRange"

xmlName

xmlName: string = "ClearRange"

type

type: object

name

element

element: object

type

type: object

className

className: string = "ClearRange"

name

pageRange

pageRange: object

serializedName

serializedName: string = "PageRange"

xmlElementName

xmlElementName: string = "PageRange"

xmlName

xmlName: string = "PageRange"

type

type: object

name

element

element: object

type

type: object

className

className: string = "PageRange"

name

Const PageRange

PageRange: object

serializedName

serializedName: string = "PageRange"

type

type: object

className

className: string = "PageRange"

name

modelProperties

modelProperties: object

end

end: object

required

required: boolean = true

serializedName

serializedName: string = "End"

xmlName

xmlName: string = "End"

type

type: object

xmlName

xmlName: string = "QueryType"

type

type: object

name

Const QuerySerialization

QuerySerialization: object

serializedName

serializedName: string = "QuerySerialization"

type

type: object

className

className: string = "QuerySerialization"

name

modelProperties

modelProperties: object

format

format: object

required

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

enabled

className

className: string = "ServiceFilterBlobsHeaders"

name

modelProperties

className

className: string = "ServiceGetAccountInfoHeaders"

name

modelProperties

modelProperties: object

accountKind

allowedValues

allowedValues: string[] = ["Standard_LRS","Standard_GRS","Standard_RAGRS","Standard_ZRS","Premium_LRS"]

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

Const ServiceGetPropertiesHeaders

ServiceGetPropertiesHeaders: object

serializedName

serializedName: string = "service-getproperties-headers"

type

type: object

className

className: string = "ServiceGetPropertiesHeaders"

name

modelProperties

className

className: string = "ServiceGetStatisticsHeaders"

name

modelProperties

className

className: string = "ServiceGetUserDelegationKeyHeaders"

name

modelProperties

className

className: string = "ServiceListContainersSegmentHeaders"

name

modelProperties

className

className: string = "ServiceSetPropertiesHeaders"

name

modelProperties

className

className: string = "ServiceSubmitBatchHeaders"

name

modelProperties

className

className: string = "SignedIdentifier"

name

modelProperties

modelProperties: object

accessPolicy

accessPolicy: object

required

required: boolean = true

serializedName

serializedName: string = "AccessPolicy"

xmlName

xmlName: string = "AccessPolicy"

type

type: object

className

className: string = "AccessPolicy"

name

id

className

className: string = "StaticWebsite"

name

modelProperties

modelProperties: object

defaultIndexDocumentPath

defaultIndexDocumentPath: object

serializedName

serializedName: string = "DefaultIndexDocumentPath"

xmlName

xmlName: string = "DefaultIndexDocumentPath"

type

type: object

name

enabled

type

type: object

name

message

message: object

serializedName

serializedName: string = "Message"

xmlName

xmlName: string = "Message"

type

type: object

name

Const URLConstants

URLConstants: object

Parameters

Parameters: object

FORCE_BROWSER_NO_CACHE

FORCE_BROWSER_NO_CACHE: string = "_"

SIGNATURE

SIGNATURE: string = "sig"

SNAPSHOT

SNAPSHOT: string = "snapshot"

TIMEOUT

TIMEOUT: string = "timeout"

VERSIONID

VERSIONID: string = "versionid"

Const UserDelegationKey

UserDelegationKey: object

serializedName

serializedName: string = "UserDelegationKey"

type

type: object

className

className: string = "UserDelegationKey"

name

modelProperties

required

required: boolean = true

serializedName

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

type

type: object

name

Const action1

action1: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "release"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

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

type

type: object

name

Const action2

action2: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "renew"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

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

type

type: object

name

Const action3

action3: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "break"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

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

type

type: object

name

Const action4

action4: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "change"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

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

type

type: object

name

Const action5

action5: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "setAccessControl"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "action"

type

type: object

name

Const action6

action6: object

parameterPath

parameterPath: string = "action"

mapper

type

type: object

allowedValues

allowedValues: string[] = ["Permanent"]

name

Const blobSequenceNumber

required

required: boolean = true

serializedName

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

type

type: object

name

Const blobType1

blobType1: object

parameterPath

parameterPath: string = "blobType"

mapper

mapper: object

defaultValue

defaultValue: string = "AppendBlob"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

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

type

type: object

name

Const blobType2

blobType2: object

parameterPath

parameterPath: string = "blobType"

mapper

mapper: object

defaultValue

defaultValue: string = "BlockBlob"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

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

type

type: object

name

Const blockId

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp1

comp1: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "stats"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp10

comp10: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "lease"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp11

comp11: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "expiry"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp12

comp12: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "snapshot"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp13

comp13: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "copy"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp14

comp14: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "tier"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp15

comp15: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "query"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp16

comp16: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "tags"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp17

comp17: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "page"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp18

comp18: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "pagelist"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp19

comp19: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "incrementalcopy"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp2

comp2: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "list"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp20

comp20: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "appendblock"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp21

comp21: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "seal"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp22

comp22: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "block"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp23

comp23: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "blocklist"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp3

comp3: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "userdelegationkey"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp4

comp4: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "batch"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp5

comp5: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "blobs"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp6

comp6: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "metadata"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp7

comp7: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "acl"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp8

comp8: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "undelete"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp9

comp9: object

parameterPath

parameterPath: string = "comp"

mapper

type

type: object

name

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options","directoryHttpHeaders","contentType"]

mapper

mapper: object

serializedName

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

type

type: object

name

Const copyActionAbortConstant

copyActionAbortConstant: object

parameterPath

serializedName

serializedName: string = "include"

type

type: object

name

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["metadata","deleted"]

name

Const include1

include1: object

collectionFormat

collectionFormat: any = coreHttp.QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options","include"]

mapper

mapper: object

serializedName

serializedName: string = "include"

type

type: object

name

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["copy","deleted","metadata","snapshots","uncommittedblobs","versions","tags"]

name

Const leaseId0

leaseId0: object

parameterPath

parameterPath: string[] = ["options","leaseAccessConditions","leaseId"]

mapper

mapper: object

serializedName

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

type

type: object

name

Const leaseId1

leaseId1: object

parameterPath

parameterPath: string = "leaseId"

mapper

mapper: object

required

required: boolean = true

serializedName

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

type

type: object

name

Const listType

listType: object

parameterPath

parameterPath: string = "listType"

mapper

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const maxSize

maxSize: object

parameterPath

parameterPath: string[] = ["options","appendPositionAccessConditions","maxSize"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-blob-condition-maxsize"

type

type: object

name

Const metadata

metadata: object

parameterPath

parameterPath: string[] = ["options","metadata"]

mapper

mapper: object

headerCollectionPrefix

headerCollectionPrefix: string = "x-ms-meta-"

serializedName

serializedName: string = "x-ms-meta"

type

type: object

name

value

value: object

type

type: object

name

Const multipartContentType

required

required: boolean = true

serializedName

serializedName: string = "x-ms-page-write"

type

type: object

name

Const pageWrite1

pageWrite1: object

parameterPath

parameterPath: string = "pageWrite"

mapper

mapper: object

defaultValue

defaultValue: string = "clear"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "x-ms-page-write"

type

type: object

name

Const pathRenameMode

type

type: object

name

Const range0

range0: object

parameterPath

parameterPath: string[] = ["options","range"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-range"

type

type: object

name

Const range1

type

type: object

name

Const rehydratePriority

rehydratePriority: object

parameterPath

parameterPath: string[] = ["options","rehydratePriority"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-rehydrate-priority"

type

type: object

name

Const renameSource

required

required: boolean = true

serializedName

serializedName: string = "resource"

type

type: object

name

Const restype0

restype0: object

parameterPath

parameterPath: string = "restype"

mapper

mapper: object

defaultValue

defaultValue: string = "service"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "restype"

type

type: object

name

Const restype1

restype1: object

parameterPath

parameterPath: string = "restype"

mapper

mapper: object

defaultValue

defaultValue: string = "account"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "restype"

type

type: object

name

Const restype2

restype2: object

parameterPath

parameterPath: string = "restype"

mapper

type

type: object

allowedValues

allowedValues: string[] = ["max","update","increment"]

name

Const snapshot

snapshot: object

parameterPath

parameterPath: string[] = ["options","snapshot"]

mapper

mapper: object

serializedName

serializedName: string = "snapshot"

type

type: object

name

Const sourceContainerName

type

type: object

name

Const sourceRange1

sourceRange1: object

parameterPath

parameterPath: string[] = ["options","sourceRange"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-source-range"

type

type: object

name

Const sourceUrl

type

type: object

name

Const timeoutInSeconds

timeoutInSeconds: object

parameterPath

required

required: boolean = true

serializedName

serializedName: string = "url"

type

type: object

name

Const version

version: object

parameterPath

parameterPath: string = "version"

mapper

required

required: boolean = true

serializedName

serializedName: string = "x-ms-requires-sync"

type

type: object

name