@azure/storage-blob

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Object literals

Type aliases

AccessTier

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

AccountKind

AccountKind: "Storage" | "BlobStorage" | "StorageV2"

AppendBlobAppendBlockFromUrlResponse

AppendBlobAppendBlockFromUrlResponse: AppendBlobAppendBlockFromUrlHeaders & object

AppendBlobAppendBlockResponse

AppendBlobAppendBlockResponse: AppendBlobAppendBlockHeaders & object

AppendBlobCreateResponse

AppendBlobCreateResponse: AppendBlobCreateHeaders & object

ArchiveStatus

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

BlobAbortCopyFromURLResponse

BlobAbortCopyFromURLResponse: BlobAbortCopyFromURLHeaders & object

BlobAcquireLeaseResponse

BlobAcquireLeaseResponse: BlobAcquireLeaseHeaders & object

BlobBatchDeleteBlobsResponse

BlobBatchDeleteBlobsResponse: BlobBatchSubmitBatchResponse

BlobBatchSetBlobsAccessTierResponse

BlobBatchSetBlobsAccessTierResponse: BlobBatchSubmitBatchResponse

BlobBatchSubmitBatchResponse

BlobBatchSubmitBatchResponse: ParsedBatchResponse & ServiceSubmitBatchHeaders & object

BlobBreakLeaseResponse

BlobBreakLeaseResponse: BlobBreakLeaseHeaders & object

BlobChangeLeaseResponse

BlobChangeLeaseResponse: BlobChangeLeaseHeaders & object

BlobCopyFromURLResponse

BlobCopyFromURLResponse: BlobCopyFromURLHeaders & object

BlobCreateSnapshotResponse

BlobCreateSnapshotResponse: BlobCreateSnapshotHeaders & object

BlobDeleteResponse

BlobDeleteResponse: BlobDeleteHeaders & object

BlobGetAccessControlResponse

BlobGetAccessControlResponse: BlobGetAccessControlHeaders & object

BlobGetAccountInfoResponse

BlobGetAccountInfoResponse: BlobGetAccountInfoHeaders & object

BlobGetPropertiesResponse

BlobGetPropertiesResponse: BlobGetPropertiesHeaders & object

BlobReleaseLeaseResponse

BlobReleaseLeaseResponse: BlobReleaseLeaseHeaders & object

BlobRenameResponse

BlobRenameResponse: BlobRenameHeaders & object

BlobRenewLeaseResponse

BlobRenewLeaseResponse: BlobRenewLeaseHeaders & object

BlobSetAccessControlResponse

BlobSetAccessControlResponse: BlobSetAccessControlHeaders & object

BlobSetHTTPHeadersResponse

BlobSetHTTPHeadersResponse: BlobSetHTTPHeadersHeaders & object

BlobSetMetadataResponse

BlobSetMetadataResponse: BlobSetMetadataHeaders & object

BlobSetTierResponse

BlobSetTierResponse: BlobSetTierHeaders & object

BlobStartCopyFromURLResponse

BlobStartCopyFromURLResponse: BlobStartCopyFromURLHeaders & object

BlobType

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

BlobUndeleteResponse

BlobUndeleteResponse: BlobUndeleteHeaders & object

BlobUploadCommonResponse

BlobUploadCommonResponse: BlockBlobUploadHeaders & object

BlockBlobCommitBlockListResponse

BlockBlobCommitBlockListResponse: BlockBlobCommitBlockListHeaders & object

BlockBlobGetBlockListResponse

BlockBlobGetBlockListResponse: BlockList & BlockBlobGetBlockListHeaders & object

BlockBlobStageBlockFromURLResponse

BlockBlobStageBlockFromURLResponse: BlockBlobStageBlockFromURLHeaders & object

BlockBlobStageBlockResponse

BlockBlobStageBlockResponse: BlockBlobStageBlockHeaders & object

BlockBlobUploadResponse

BlockBlobUploadResponse: BlockBlobUploadHeaders & object

BlockListType

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

ContainerAcquireLeaseResponse

ContainerAcquireLeaseResponse: ContainerAcquireLeaseHeaders & object

ContainerBreakLeaseResponse

ContainerBreakLeaseResponse: ContainerBreakLeaseHeaders & object

ContainerChangeLeaseResponse

ContainerChangeLeaseResponse: ContainerChangeLeaseHeaders & object

ContainerCreateResponse

ContainerCreateResponse: ContainerCreateHeaders & object

ContainerDeleteResponse

ContainerDeleteResponse: ContainerDeleteHeaders & object

ContainerGetAccessPolicyResponse

ContainerGetAccessPolicyResponse: object & ContainerGetAccessPolicyHeaders & object

ContainerGetAccountInfoResponse

ContainerGetAccountInfoResponse: ContainerGetAccountInfoHeaders & object

ContainerGetPropertiesResponse

ContainerGetPropertiesResponse: ContainerGetPropertiesHeaders & object

ContainerListBlobFlatSegmentResponse

ContainerListBlobFlatSegmentResponse: ListBlobsFlatSegmentResponse & ContainerListBlobFlatSegmentHeaders & object

ContainerListBlobHierarchySegmentResponse

ContainerListBlobHierarchySegmentResponse: ListBlobsHierarchySegmentResponse & ContainerListBlobHierarchySegmentHeaders & object

ContainerReleaseLeaseResponse

ContainerReleaseLeaseResponse: ContainerReleaseLeaseHeaders & object

ContainerRenewLeaseResponse

ContainerRenewLeaseResponse: ContainerRenewLeaseHeaders & object

ContainerSetAccessPolicyResponse

ContainerSetAccessPolicyResponse: ContainerSetAccessPolicyHeaders & object

ContainerSetMetadataResponse

ContainerSetMetadataResponse: ContainerSetMetadataHeaders & object

CopyPollerBlobClient

CopyPollerBlobClient: Pick<BlobClient, "abortCopyFromURL" | "getProperties"> & object

CopyStatusType

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

CredentialPolicyCreator

CredentialPolicyCreator: function

Type declaration

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

DeleteSnapshotsOptionType

DeleteSnapshotsOptionType: "include" | "only"

DirectoryCreateResponse

DirectoryCreateResponse: DirectoryCreateHeaders & object

DirectoryDeleteResponse

DirectoryDeleteResponse: DirectoryDeleteHeaders & object

DirectoryGetAccessControlResponse

DirectoryGetAccessControlResponse: DirectoryGetAccessControlHeaders & object

DirectoryRenameResponse

DirectoryRenameResponse: DirectoryRenameHeaders & object

DirectorySetAccessControlResponse

DirectorySetAccessControlResponse: DirectorySetAccessControlHeaders & object

EncryptionAlgorithmType

EncryptionAlgorithmType: "AES256"

GeoReplicationStatusType

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

LeaseDurationType

LeaseDurationType: "infinite" | "fixed"

LeaseOperationResponse

LeaseOperationResponse: Lease & object

LeaseStateType

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

LeaseStatusType

LeaseStatusType: "locked" | "unlocked"

ListBlobsIncludeItem

ListBlobsIncludeItem: "copy" | "deleted" | "metadata" | "snapshots" | "uncommittedblobs"

ListContainersIncludeType

ListContainersIncludeType: "metadata"

Operation

Operation: function

Type declaration

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

OutgoingHandler

OutgoingHandler: function

Type declaration

- (buffer: Buffer, offset: undefined | number): Promise<any>
- Parameters
  - buffer: Buffer
  - Optional offset: undefined | number
  Returns Promise<any>

PageBlobClearPagesResponse

PageBlobClearPagesResponse: PageBlobClearPagesHeaders & object

PageBlobCopyIncrementalResponse

PageBlobCopyIncrementalResponse: PageBlobCopyIncrementalHeaders & object

PageBlobCreateResponse

PageBlobCreateResponse: PageBlobCreateHeaders & object

PageBlobGetPageRangesDiffResponse

PageBlobGetPageRangesDiffResponse: PageList & PageBlobGetPageRangesDiffHeaders & object

_response

_response: HttpResponse & object

Optional blobContentLength

blobContentLength: undefined | number

Optional clearRange

clearRange: Range[]

Optional clientRequestId

clientRequestId: undefined | string

Optional date

date: Date

Optional errorCode

errorCode: undefined | string

Optional etag

etag: undefined | string

Optional lastModified

lastModified: Date

Optional pageRange

pageRange: Range[]

Optional requestId

requestId: undefined | string

Optional version

version: undefined | string

PageBlobGetPageRangesResponse

PageBlobGetPageRangesResponse: PageList & PageBlobGetPageRangesHeaders & object

_response

_response: HttpResponse & object

Optional blobContentLength

blobContentLength: undefined | number

Optional clearRange

clearRange: Range[]

Optional clientRequestId

clientRequestId: undefined | string

Optional date

date: Date

Optional errorCode

errorCode: undefined | string

Optional etag

etag: undefined | string

Optional lastModified

lastModified: Date

Optional pageRange

pageRange: Range[]

Optional requestId

requestId: undefined | string

Optional version

version: undefined | string

PageBlobResizeResponse

PageBlobResizeResponse: PageBlobResizeHeaders & object

PageBlobUpdateSequenceNumberResponse

PageBlobUpdateSequenceNumberResponse: PageBlobUpdateSequenceNumberHeaders & object

PageBlobUploadPagesFromURLResponse

PageBlobUploadPagesFromURLResponse: PageBlobUploadPagesFromURLHeaders & object

PageBlobUploadPagesResponse

PageBlobUploadPagesResponse: PageBlobUploadPagesHeaders & object

PathRenameMode

PathRenameMode: "legacy" | "posix"

PublicAccessType

PublicAccessType: "container" | "blob"

ReadableStreamGetter

ReadableStreamGetter: function

Type declaration

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

RehydratePriority

RehydratePriority: "High" | "Standard"

SequenceNumberActionType

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

ServiceGetAccountInfoResponse

ServiceGetAccountInfoResponse: ServiceGetAccountInfoHeaders & object

ServiceGetPropertiesResponse

ServiceGetPropertiesResponse: BlobServiceProperties & ServiceGetPropertiesHeaders & object

ServiceGetStatisticsResponse

ServiceGetStatisticsResponse: BlobServiceStatistics & ServiceGetStatisticsHeaders & object

ServiceGetUserDelegationKeyResponse

ServiceGetUserDelegationKeyResponse: UserDelegationKey & ServiceGetUserDelegationKeyHeaders & object

ServiceListContainersSegmentResponse

ServiceListContainersSegmentResponse: ListContainersSegmentResponse & ServiceListContainersSegmentHeaders & object

ServiceSetPropertiesResponse

ServiceSetPropertiesResponse: ServiceSetPropertiesHeaders & object

ServiceSubmitBatchResponse

ServiceSubmitBatchResponse: ServiceSubmitBatchHeaders & object

SkuName

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

StorageErrorCode

SyncCopyStatusType

SyncCopyStatusType: "success"

Variables

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 = 100 * 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_LINE_ENDING

HTTP_LINE_ENDING: "" = ""

Const HTTP_VERSION_1_1

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

Const SDK_VERSION

SDK_VERSION: string = "12.0.2"

Const SERVICE_VERSION

SERVICE_VERSION: string = "2019-02-02"

Const SIZE_1_MB

SIZE_1_MB: number = 1 * 1024 * 1024

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"]

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"

Const fsStat

fsStat: any = util.promisify(isNode ? fs.stat : function stat() {})

Const logger

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

Functions

NewRetryPolicyFactory

NewRetryPolicyFactory(retryOptions: StorageRetryOptions): RequestPolicyFactory

- Defined in policies/StorageRetryPolicy.ts:29
Parameters
- Optional retryOptions: StorageRetryOptions
Returns RequestPolicyFactory

appendToURLPath

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

- Defined in utils/utils.common.ts:227
Parameters
- url: string
- name: string
Returns string

An updated URL string

base64decode

base64decode(encodedString: string): string

- Defined in utils/utils.common.ts:399
Parameters
- encodedString: string
Returns string

base64encode

base64encode(content: string): string

- Defined in utils/utils.common.ts:388
Parameters
- content: string
Returns string

blobToArrayBuffer

blobToArrayBuffer(blob: Blob): Promise<ArrayBuffer>

- Defined in utils/utils.browser.ts:11
Parameters
- blob: Blob
Returns Promise<ArrayBuffer>

blobToString

blobToString(blob: Blob): Promise<string>

- Defined in utils/utils.browser.ts:29
Parameters
- blob: Blob
Returns Promise<string>

createSpan

createSpan(operationName: string, tracingOptions?: OperationTracingOptions): object

- Defined in utils/tracing.ts:13
Parameters
- operationName: string
- Default value tracingOptions: OperationTracingOptions = {}
Returns object

delay

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

- Defined in utils/utils.common.ts:436
Parameters
- timeInMs: number
- Optional aborter: AbortSignalLike
- Optional abortError: Error
Returns Promise<unknown>

ensureCpkIfSpecified

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

- Defined in models.ts:125
Parameters
- cpk: CpkInfo | undefined
- isHttps: boolean
Returns void

escapeURLPath

escapeURLPath(url: string): string

- Defined in utils/utils.common.ts:62
Parameters
- url: string
Returns string

extractConnectionStringParts

extractConnectionStringParts(connectionString: string): ConnectionString

- Defined in utils/utils.common.ts:125
Parameters
- connectionString: string
Returns ConnectionString

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

generateAccountSASQueryParameters

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

- Defined in AccountSASSignatureValues.ts:113
Parameters
- accountSASSignatureValues: AccountSASSignatureValues
- sharedKeyCredential: StorageSharedKeyCredential
Returns SASQueryParameters

generateBlobSASQueryParameters

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

- Defined in BlobSASSignatureValues.ts:235
Parameters
- blobSASSignatureValues: BlobSASSignatureValues
- sharedKeyCredential: StorageSharedKeyCredential
Returns SASQueryParameters
- Defined in BlobSASSignatureValues.ts:271
Parameters
- blobSASSignatureValues: BlobSASSignatureValues
- userDelegationKey: UserDelegationKey
- accountName: string
Returns SASQueryParameters

generateBlockID

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

- Defined in utils/utils.common.ts:410
Parameters
- blockIDPrefix: string
- blockIndex: number
Returns string

getAccountNameFromUrl

getAccountNameFromUrl(url: string): string

- Defined in utils/utils.common.ts:531
Parameters
- url: string
Returns string

with the account name

getBodyAsText

getBodyAsText(batchResponse: ServiceSubmitBatchResponseModel): Promise<string>

- Defined in BatchUtils.ts:5
Parameters
- batchResponse: ServiceSubmitBatchResponseModel
Returns Promise<string>

getCachedDefaultHttpClient

getCachedDefaultHttpClient(): any

- Defined in utils/cache.ts:8
Returns any

getURLParameter

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

- Defined in utils/utils.common.ts:261
Parameters
- url: string
- name: string
Returns string | string[] | undefined

getURLPath

getURLPath(url: string): string | undefined

- Defined in utils/utils.common.ts:287
Parameters
- url: string
Returns string | undefined

getURLPathAndQuery

getURLPathAndQuery(url: string): string | undefined

- Defined in utils/utils.common.ts:311
Parameters
- url: string
Returns string | undefined

getURLQueries

getURLQueries(url: string): object

- Defined in utils/utils.common.ts:334
Parameters
- url: string
Returns object
- [key: string]: string

getURLScheme

getURLScheme(url: string): string | undefined

- Defined in utils/utils.common.ts:299
Parameters
- url: string
Returns string | undefined

getValueInConnString

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

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

iEqual

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

- Defined in utils/utils.common.ts:522
Parameters
- str1: string
- str2: string
Returns boolean

ipRangeToString

ipRangeToString(ipRange: SasIPRange): string

- Defined in SasIPRange.ts:38
Parameters
- ipRange: SasIPRange
Returns string

newPipeline

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

- Defined in Pipeline.ts:178
Parameters
- credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
- Default value pipelineOptions: StoragePipelineOptions = {}
Returns Pipeline

A new Pipeline object.

padStart

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

- Defined in utils/utils.common.ts:470
Parameters
- currentString: string
- targetLength: number
- Default value padString: string = " "
Returns string

rangeResponseFromModel

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

- Defined in PageBlobRangeResponse.ts:83
Parameters
- response: PageBlobGetPageRangesResponseModel | PageBlobGetPageRangesDiffResponseModel
Returns PageBlobGetPageRangesResponse | PageBlobGetPageRangesDiffResponse

rangeToString

rangeToString(iRange: Range): string

- Defined in Range.ts:39
Parameters
- iRange: Range
Returns string

readStreamToLocalFile

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

- Defined in utils/utils.node.ts:126
Parameters
- rs: NodeJS.ReadableStream
- file: string
Returns Promise<void>

sanitizeHeaders

sanitizeHeaders(originalHeader: HttpHeaders): HttpHeaders

- Defined in utils/utils.common.ts:500
Parameters
- originalHeader: HttpHeaders
Returns HttpHeaders

sanitizeURL

sanitizeURL(url: string): string

- Defined in utils/utils.common.ts:491
Parameters
- url: string
Returns string

setURLHost

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

- Defined in utils/utils.common.ts:274
Parameters
- url: string
- host: string
Returns string

An updated URL string

setURLParameter

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

- Defined in utils/utils.common.ts:247
Parameters
- url: string
- name: string
- Optional value: undefined | string
Returns string

An updated URL string

streamToBuffer

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

- Defined in utils/utils.node.ts:19
Parameters
- stream: NodeJS.ReadableStream
- buffer: Buffer
- offset: number
- end: number
- Optional encoding: undefined | string
Returns Promise<void>

streamToBuffer2

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

- Defined in utils/utils.node.ts:76
Parameters
- stream: NodeJS.ReadableStream
- buffer: Buffer
- Optional encoding: undefined | string
Returns Promise<number>

with the count of bytes read.

toAccessTier

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

- Defined in models.ts:115
Parameters
- tier: BlockBlobTier | PremiumPageBlobTier | string | undefined
Returns AccessTier | undefined

truncatedISO8061Date

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

- Defined in utils/utils.common.ts:372
Parameters
- date: Date
- Default value withMilliseconds: boolean = true
Returns string

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

utf8ByteLength

utf8ByteLength(str: string): number

- Defined in BatchUtils.ts:21
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 = "AppendPositionAccessConditions"

name

modelProperties

className

className: string = "BlobAbortCopyFromURLHeaders"

name

modelProperties

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

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 = "BlobItem"

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 BlobItem

BlobItem: object

serializedName

serializedName: string = "BlobItem"

xmlName

xmlName: string = "Blob"

type

type: object

className

className: string = "BlobItem"

name

modelProperties

modelProperties: object

deleted

deleted: object

required

required: boolean = true

serializedName

required

required: boolean = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

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 = "BlobProperties"

name

snapshot

snapshot: object

required

required: boolean = true

serializedName

serializedName: string = "Snapshot"

xmlName

xmlName: string = "Snapshot"

type

type: object

name

Const BlobPrefix

BlobPrefix: object

serializedName

serializedName: string = "BlobPrefix"

type

type: object

className

className: string = "BlobPrefix"

name

modelProperties

modelProperties: object

name

required

required: boolean = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

Const BlobProperties

BlobProperties: object

serializedName

serializedName: string = "BlobProperties"

xmlName

xmlName: string = "Properties"

type

type: object

className

className: string = "BlobProperties"

name

modelProperties

serializedName

serializedName: string = "Etag"

xmlName

xmlName: string = "Etag"

type

type: object

className

className: string = "BlobRenameHeaders"

name

modelProperties

className

className: string = "BlobRenewLeaseHeaders"

name

modelProperties

modelProperties: object

geoReplication

className

className: string = "BlobSetHTTPHeadersHeaders"

name

modelProperties

className

className: string = "BlobSetMetadataHeaders"

name

modelProperties

className

className: string = "BlobSetTierHeaders"

name

modelProperties

className

className: string = "BlobStartCopyFromURLHeaders"

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 = "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 = "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

metadata

metadata: object

serializedName

serializedName: string = "Metadata"

xmlName

xmlName: string = "Metadata"

type

type: object

name

value

value: object

type

type: object

name

name

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

modelProperties: object

etag

etag: object

required

required: boolean = true

serializedName

serializedName: string = "Etag"

xmlName

xmlName: string = "Etag"

type

type: object

name

hasImmutabilityPolicy

hasImmutabilityPolicy: object

serializedName

serializedName: string = "HasImmutabilityPolicy"

xmlName

xmlName: string = "HasImmutabilityPolicy"

type

type: object

publicAccess: object

serializedName

serializedName: string = "PublicAccess"

xmlName

xmlName: string = "PublicAccess"

type

type: object

name

Const ContainerReleaseLeaseHeaders

ContainerReleaseLeaseHeaders: object

serializedName

serializedName: string = "container-releaselease-headers"

type

type: object

className

className: string = "ContainerReleaseLeaseHeaders"

name

modelProperties

className

className: string = "ContainerRenewLeaseHeaders"

name

modelProperties

className

className: string = "ContainerSetAccessPolicyHeaders"

name

modelProperties

className

className: string = "ContainerSetMetadataHeaders"

name

modelProperties

className

className: string = "CorsRule"

name

modelProperties

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

Const CpkInfo

CpkInfo: object

xmlName

xmlName: string = "cpk-info"

type

type: object

className

className: string = "CpkInfo"

name

modelProperties

modelProperties: object

encryptionAlgorithm

className

className: string = "DataLakeStorageError"

name

modelProperties

modelProperties: object

error

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

className

className: string = "GeoReplication"

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 KeyInfo

KeyInfo: object

serializedName

serializedName: string = "KeyInfo"

type

type: object

className

className: string = "KeyInfo"

name

modelProperties

modelProperties: object

expiresOn

expiresOn: object

required

required: boolean = true

serializedName

serializedName: string = "Expiry"

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

name

start

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

enabled

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

enabled

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"

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

serializedName

serializedName: string = "x-ms-blob-sequence-number"

type

type: object

name

Const blobType0

blobType0: object

parameterPath

parameterPath: string = "blobType"

mapper

mapper: object

defaultValue

defaultValue: string = "PageBlob"

isConstant

isConstant: boolean = true

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 = "copy"

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 = "tier"

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 = "page"

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 = "pagelist"

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 = "incrementalcopy"

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 = "appendblock"

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 = "block"

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 = "blocklist"

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 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 = "metadata"

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 = "acl"

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 = "lease"

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

allowedValues

allowedValues: string[] = ["metadata"]

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"]

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

mapper: object

defaultValue

defaultValue: string = "container"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "restype"

type

type: object

name

Const sequenceNumberAction

sequenceNumberAction: object

parameterPath

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

mapper: object

defaultValue

defaultValue: string = "2019-02-02"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

Const xMsRequiresSync

xMsRequiresSync: object

parameterPath

parameterPath: string = "xMsRequiresSync"

mapper

mapper: object

defaultValue

defaultValue: string = "true"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

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

type

type: object

name

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AccessTier

AccountKind

AppendBlobAppendBlockFromUrlResponse

AppendBlobAppendBlockResponse

AppendBlobCreateResponse

ArchiveStatus

BlobAbortCopyFromURLResponse

BlobAcquireLeaseResponse

BlobBatchDeleteBlobsResponse

BlobBatchSetBlobsAccessTierResponse

BlobBatchSubmitBatchResponse

BlobBreakLeaseResponse

BlobChangeLeaseResponse

BlobCopyFromURLResponse

BlobCreateSnapshotResponse

BlobDeleteResponse

BlobGetAccessControlResponse

BlobGetAccountInfoResponse

BlobGetPropertiesResponse

BlobReleaseLeaseResponse

BlobRenameResponse

BlobRenewLeaseResponse

BlobSetAccessControlResponse

BlobSetHTTPHeadersResponse

BlobSetMetadataResponse

BlobSetTierResponse

BlobStartCopyFromURLResponse

BlobType

BlobUndeleteResponse

BlobUploadCommonResponse

BlockBlobCommitBlockListResponse

BlockBlobGetBlockListResponse

BlockBlobStageBlockFromURLResponse

BlockBlobStageBlockResponse

BlockBlobUploadResponse

BlockListType

ContainerAcquireLeaseResponse

ContainerBreakLeaseResponse

ContainerChangeLeaseResponse

ContainerCreateResponse

ContainerDeleteResponse

ContainerGetAccessPolicyResponse

ContainerGetAccountInfoResponse

ContainerGetPropertiesResponse

ContainerListBlobFlatSegmentResponse

ContainerListBlobHierarchySegmentResponse

ContainerReleaseLeaseResponse

ContainerRenewLeaseResponse

ContainerSetAccessPolicyResponse

ContainerSetMetadataResponse

CopyPollerBlobClient

CopyStatusType

CredentialPolicyCreator

Type declaration

Parameters

nextPolicy: RequestPolicy

options: RequestPolicyOptions

Returns CredentialPolicy

DeleteSnapshotsOptionType

DirectoryCreateResponse

DirectoryDeleteResponse

DirectoryGetAccessControlResponse

DirectoryRenameResponse

DirectorySetAccessControlResponse

EncryptionAlgorithmType

GeoReplicationStatusType

LeaseDurationType

LeaseOperationResponse

LeaseStateType

LeaseStatusType

ListBlobsIncludeItem