@azure/storage-blob

@azure/storage-blob

Version 12.27.0
Published 3 months ago
6.16 MB
13 dependencies
MIT license

Install

npm i @azure/storage-blob

yarn add @azure/storage-blob

pnpm add @azure/storage-blob

Overview

Microsoft Azure Storage SDK for JavaScript - Blob

Index

Variables

variable logger

const logger: AzureLogger;

The @azure/logger configuration for this package.

variable StorageOAuthScopes

const StorageOAuthScopes: string | string[];

The OAuth scope to use with Azure Storage.

Functions

function generateAccountSASQueryParameters

generateAccountSASQueryParameters: (
    accountSASSignatureValues: AccountSASSignatureValues,
    sharedKeyCredential: StorageSharedKeyCredential
) => SASQueryParameters;

ONLY AVAILABLE IN NODE.JS RUNTIME.
Generates a SASQueryParameters object which contains all SAS query parameters needed to make an actual REST request.
Parameter accountSASSignatureValues
Parameter sharedKeyCredential
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

function generateBlobSASQueryParameters

generateBlobSASQueryParameters: {
    (
        blobSASSignatureValues: BlobSASSignatureValues,
        sharedKeyCredential: StorageSharedKeyCredential
    ): SASQueryParameters;
    (
        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 * 1000), // 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 * 1000), // 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 * 1000), // 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();

Parameter blobSASSignatureValues

Parameter sharedKeyCredential

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();

Parameter blobSASSignatureValues

Parameter userDelegationKey

Return value of blobServiceClient.getUserDelegationKey()

Parameter accountName

function getBlobServiceAccountAudience

getBlobServiceAccountAudience: (storageAccountName: string) => string;

To get OAuth audience for a storage account for blob service.

function isPipelineLike

isPipelineLike: (pipeline: unknown) => pipeline is PipelineLike;

A helper to decide if a given argument satisfies the Pipeline contract
Parameter pipeline
An argument that may be a Pipeline
Returns
true when the argument satisfies the Pipeline contract

function newPipeline

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

Creates a new Pipeline object with Credential provided.
Parameter credential
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.
Parameter pipelineOptions
Optional. Options.
Returns
A new Pipeline object.

Classes

class AccountSASPermissions

class AccountSASPermissions {}

ONLY AVAILABLE IN NODE.JS RUNTIME.
This is a helper class to construct a string representing the permissions granted by an AccountSAS. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the values are set, this should be serialized with toString and set as the permissions field on an AccountSASSignatureValues object. It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness.

property add

add: boolean;

Permission to add messages, table entities, and append to blobs granted.

property create

create: boolean;

Permission to create blobs and files granted.

property delete

delete: boolean;

Permission to delete blobs and files granted.

property filter

filter: boolean;

Permission to filter blobs.

property list

list: boolean;

Permission to list blob containers, blobs, shares, directories, and files granted.

property permanentDelete

permanentDelete: boolean;

Specifies that Permanent Delete is permitted.

property process

process: boolean;

Permission to get and delete messages granted.

property read

read: boolean;

Permission to read resources and list queues and tables granted.

property setImmutabilityPolicy

setImmutabilityPolicy: boolean;

Permission to set immutability policy.

property tag

tag: boolean;

Specfies Tag access granted.

property update

update: boolean;

Permissions to update messages and table entities granted.

property write

write: boolean;

Permission to write resources granted.

method from

static from: (
    permissionLike: AccountSASPermissionsLike
) => AccountSASPermissions;

Creates a AccountSASPermissions from a raw object which contains same keys as it and boolean values for them.
Parameter permissionLike

method parse

static parse: (permissions: string) => AccountSASPermissions;

Parse initializes the AccountSASPermissions fields from a string.
Parameter permissions

method toString

toString: () => string;

Produces the SAS permissions string for an Azure Storage account. Call this method to set AccountSASSignatureValues Permissions field.
Using this method will guarantee the resource types are in an order accepted by the service.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

class AccountSASResourceTypes

class AccountSASResourceTypes {}

ONLY AVAILABLE IN NODE.JS RUNTIME.
This is a helper class to construct a string representing the resources accessible by an AccountSAS. Setting a value to true means that any SAS which uses these permissions will grant access to that resource type. Once all the values are set, this should be serialized with toString and set as the resources field on an AccountSASSignatureValues object. It is possible to construct the resources string without this class, but the order of the resources is particular and this class guarantees correctness.

property container

container: boolean;

Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted.

property object

object: boolean;

Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted.

property service

service: boolean;

Permission to access service level APIs granted.

method parse

static parse: (resourceTypes: string) => AccountSASResourceTypes;

Creates an AccountSASResourceTypes from the specified resource types string. This method will throw an Error if it encounters a character that does not correspond to a valid resource type.
Parameter resourceTypes

method toString

toString: () => string;

Converts the given resource types to a string.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

class AccountSASServices

class AccountSASServices {}

ONLY AVAILABLE IN NODE.JS RUNTIME.
This is a helper class to construct a string representing the services accessible by an AccountSAS. Setting a value to true means that any SAS which uses these permissions will grant access to that service. Once all the values are set, this should be serialized with toString and set as the services field on an AccountSASSignatureValues object. It is possible to construct the services string without this class, but the order of the services is particular and this class guarantees correctness.

property blob

blob: boolean;

Permission to access blob resources granted.

property file

file: boolean;

Permission to access file resources granted.

property queue

queue: boolean;

Permission to access queue resources granted.

property table

table: boolean;

Permission to access table resources granted.

method parse

static parse: (services: string) => AccountSASServices;

Creates an AccountSASServices from the specified services string. This method will throw an Error if it encounters a character that does not correspond to a valid service.
Parameter services

class AnonymousCredential

class AnonymousCredential extends Credential_2 {}

AnonymousCredential provides a credentialPolicyCreator member used to create AnonymousCredentialPolicy objects. AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources or for use with Shared Access Signatures (SAS).

method create

create: (
    nextPolicy: RequestPolicy,
    options: RequestPolicyOptions
) => AnonymousCredentialPolicy;

Creates an AnonymousCredentialPolicy object.
Parameter nextPolicy
Parameter options

class AnonymousCredentialPolicy

class AnonymousCredentialPolicy extends CredentialPolicy {}

AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources or for use with Shared Access Signatures (SAS).

constructor

constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);

Creates an instance of AnonymousCredentialPolicy.
Parameter nextPolicy
Parameter options

class AppendBlobClient

class AppendBlobClient extends BlobClient {}

AppendBlobClient defines a set of operations applicable to append blobs.

constructor

constructor(
    connectionString: string,
    containerName: string,
    blobName: string,
    options?: StoragePipelineOptions
);

Creates an instance of AppendBlobClient.
Parameter connectionString
Account connection string or a SAS connection string of an Azure storage account. [ Note - Account connection string can only be used in NODE.JS runtime. ] Account connection string example - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS connection string example - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
Parameter containerName
Container name.
Parameter blobName
Blob name.
Parameter options
Optional. Options to configure the HTTP pipeline.

constructor

constructor(url: string, credential: any, options?: StoragePipelineOptions);

Creates an instance of AppendBlobClient. This method accepts an encoded URL or non-encoded URL pointing to an append blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. If a blob name includes ? or %, blob name must be encoded in the URL.
Parameter url
A URL string pointing to Azure Storage append blob, such as "https://myaccount.blob.core.windows.net/mycontainer/appendblob". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". This method accepts an encoded URL or non-encoded URL pointing to a blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. However, if a blob name includes ? or %, blob name must be encoded in the URL. Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
Parameter credential
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.
Parameter options
Optional. Options to configure the HTTP pipeline.

constructor

constructor(url: string, pipeline: PipelineLike);

Creates an instance of AppendBlobClient. This method accepts an encoded URL or non-encoded URL pointing to an append blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. If a blob name includes ? or %, blob name must be encoded in the URL.
Parameter url
A URL string pointing to Azure Storage append blob, such as "https://myaccount.blob.core.windows.net/mycontainer/appendblob". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". This method accepts an encoded URL or non-encoded URL pointing to a blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. However, if a blob name includes ? or %, blob name must be encoded in the URL. Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
Parameter pipeline
Call newPipeline() to create a default pipeline, or provide a customized pipeline.

method appendBlock

appendBlock: (
    body: HttpRequestBody,
    contentLength: number,
    options?: AppendBlobAppendBlockOptions
) => Promise<AppendBlobAppendBlockResponse>;

Commits a new block of data to the end of the existing append blob.

Parameter body

Data to be appended.

Parameter contentLength

Length of the body in bytes.

Parameter options

Options to the Append Block operation.

Example usage:

const content = "Hello World!";

// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);

// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await existingAppendBlobClient.appendBlock(content, content.length);

method appendBlockFromURL

appendBlockFromURL: (
    sourceURL: string,
    sourceOffset: number,
    count: number,
    options?: AppendBlobAppendBlockFromURLOptions
) => Promise<AppendBlobAppendBlockFromUrlResponse>;

The Append Block operation commits a new block of data to the end of an existing append blob where the contents are read from a source url.
Parameter sourceURL
The url to the blob that will be the source of the copy. A source blob in the same storage account can be authenticated via Shared Key. However, if the source is a blob in another account, the source blob must either be public or must be authenticated via a shared access signature. If the source blob is public, no authentication is required to perform the operation.
Parameter sourceOffset
Offset in source to be appended
Parameter count
Number of bytes to be appended as a block
Parameter options
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/append-block-from-url

method create

create: (options?: AppendBlobCreateOptions) => Promise<AppendBlobCreateResponse>;

Creates a 0-length append blob. Call AppendBlock to append data to an append blob.
Parameter options
Options to the Append Block Create operation.
Example usage:
const appendBlobClient = containerClient.getAppendBlobClient("<blob name>"); await appendBlobClient.create();
See Also
- https://learn.microsoft.com/rest/api/storageservices/put-blob

method createIfNotExists

createIfNotExists: (
    options?: AppendBlobCreateIfNotExistsOptions
) => Promise<AppendBlobCreateIfNotExistsResponse>;

Creates a 0-length append blob. Call AppendBlock to append data to an append blob. If the blob with the same name already exists, the content of the existing blob will remain unchanged.
Parameter options
See Also
- https://learn.microsoft.com/rest/api/storageservices/put-blob

method seal

seal: (
    options?: AppendBlobSealOptions
) => Promise<AppendBlobAppendBlockResponse>;

Seals the append blob, making it read only.
Parameter options

method withSnapshot

withSnapshot: (snapshot: string) => AppendBlobClient;

Creates a new AppendBlobClient object identical to the source but with the specified snapshot timestamp. Provide "" will remove the snapshot and return a Client to the base blob.
Parameter snapshot
The snapshot timestamp.
Returns
A new AppendBlobClient object identical to the source but with the specified snapshot timestamp.

class BaseRequestPolicy

abstract class BaseRequestPolicy implements RequestPolicy {}

The base class from which all request policies derive.

constructor

protected constructor(
    _nextPolicy: RequestPolicy,
    _options: RequestPolicyOptions
);

The main method to implement that manipulates a request/response.

method log

log: (logLevel: HttpPipelineLogLevel, message: string) => void;

Attempt to log the provided message to the provided logger. If no logger was provided or if the log level does not meat the logger's threshold, then nothing will be logged.
Parameter logLevel
The log level of this log.
Parameter message
The message of this log.

method sendRequest

abstract sendRequest: (
    webResource: WebResource
) => Promise<HttpOperationResponse>;

Sends a network request based on the given web resource.
Parameter webResource
A WebResourceLike that describes a HTTP request to be made.

method shouldLog

shouldLog: (logLevel: HttpPipelineLogLevel) => boolean;

Get whether or not a log with the provided log level should be logged.
Parameter logLevel
The log level of the log that will be logged.
Returns
Whether or not a log with the provided log level should be logged.

class BlobBatch

class BlobBatch {}

A BlobBatch represents an aggregated set of operations on blobs. Currently, only delete and setAccessTier are supported.

constructor

constructor();

method deleteBlob

deleteBlob: {
    (
        url: string,
        credential:
            | StorageSharedKeyCredential
            | AnonymousCredential
            | TokenCredential,
        options?: BlobDeleteOptions
    ): Promise<void>;
    (blobClient: BlobClient, options?: BlobDeleteOptions): Promise<void>;
};

The deleteBlob operation marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection. Only one kind of operation is allowed per batch request.
Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time. See [delete operation details](https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob). The operation will be authenticated and authorized with specified credential. See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
Parameter url
The url of the blob resource to delete.
Parameter credential
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.
Parameter options
The deleteBlob operation marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection. Only one kind of operation is allowed per batch request.
Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time. See [delete operation details](https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob). The operation will be authenticated and authorized with specified credential. See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
Parameter blobClient
The BlobClient.
Parameter options

method getHttpRequestBody

getHttpRequestBody: () => string;

Get assembled HTTP request body for sub requests.

method getMultiPartContentType

getMultiPartContentType: () => string;

Get the value of Content-Type for a batch request. The value must be multipart/mixed with a batch boundary. Example: multipart/mixed; boundary=batch_a81786c8-e301-4e42-a729-a32ca24ae252

method getSubRequests

getSubRequests: () => Map<number, BatchSubRequest>;

Get sub requests that are added into the batch request.

method setBlobAccessTier

setBlobAccessTier: {
    (
        url: string,
        credential:
            | StorageSharedKeyCredential
            | AnonymousCredential
            | TokenCredential,
        tier: AccessTier,
        options?: BlobSetTierOptions
    ): Promise<void>;
    (
        blobClient: BlobClient,
        tier: AccessTier,
        options?: BlobSetTierOptions
    ): Promise<void>;
};

The setBlobAccessTier operation sets the tier on a blob. The operation is allowed on block blobs in a blob storage or general purpose v2 account. Only one kind of operation is allowed per batch request.
A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. For detailed information about block blob level tiering see [hot, cool, and archive access tiers](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers). The operation will be authenticated and authorized with specified credential. See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
Parameter url
The url of the blob resource to delete.
Parameter credential
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.
Parameter tier
Parameter options
The setBlobAccessTier operation sets the tier on a blob. The operation is allowed on block blobs in a blob storage or general purpose v2 account. Only one kind of operation is allowed per batch request.
A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. For detailed information about block blob level tiering see [hot, cool, and archive access tiers](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers). The operation will be authenticated and authorized with specified credential. See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
Parameter blobClient
The BlobClient.
Parameter tier
Parameter options

class BlobBatchClient

class BlobBatchClient {}

A BlobBatchClient allows you to make batched requests to the Azure Storage Blob service.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch

constructor

constructor(url: string, credential?: any, options?: StoragePipelineOptions);

Creates an instance of BlobBatchClient.
Parameter url
A url pointing to Azure Storage blob service, such as "https://myaccount.blob.core.windows.net". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
Parameter credential
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.
Parameter options
Options to configure the HTTP pipeline.

constructor

constructor(url: string, pipeline: PipelineLike);

Creates an instance of BlobBatchClient.
Parameter url
A url pointing to Azure Storage blob service, such as "https://myaccount.blob.core.windows.net". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
Parameter pipeline
Call newPipeline() to create a default pipeline, or provide a customized pipeline.

method createBatch

createBatch: () => BlobBatch;

Creates a BlobBatch. A BlobBatch represents an aggregated set of operations on blobs.

method deleteBlobs

deleteBlobs: {
    (
        urls: string[],
        credential:
            | StorageSharedKeyCredential
            | AnonymousCredential
            | TokenCredential,
        options?: BlobDeleteOptions
    ): Promise<BlobBatchDeleteBlobsResponse>;
    (
        blobClients: BlobClient[],
        options?: BlobDeleteOptions
    ): Promise<BlobBatchSubmitBatchResponse>;
};

Create multiple delete operations to mark the specified blobs or snapshots for deletion. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time. See [delete operation details](https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob). The operations will be authenticated and authorized with specified credential. See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
Parameter urls
The urls of the blob resources to delete.
Parameter credential
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.
Parameter options
Create multiple delete operations to mark the specified blobs or snapshots for deletion. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time. See [delete operation details](https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob). The operation(subrequest) will be authenticated and authorized with specified credential. See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
Parameter blobClients
The BlobClients for the blobs to delete.
Parameter options

method setBlobsAccessTier

setBlobsAccessTier: {
    (
        urls: string[],
        credential:
            | StorageSharedKeyCredential
            | AnonymousCredential
            | TokenCredential,
        tier: AccessTier,
        options?: BlobSetTierOptions
    ): Promise<BlobBatchSetBlobsAccessTierResponse>;
    (
        blobClients: BlobClient[],
        tier: AccessTier,
        options?: BlobSetTierOptions
    ): Promise<BlobBatchSubmitBatchResponse>;
};

Create multiple set tier operations to set the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. See [set blob tier details](https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-tier). The operation(subrequest) will be authenticated and authorized with specified credential.See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
Parameter urls
The urls of the blob resource to delete.
Parameter credential
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.
Parameter tier
Parameter options
Create multiple set tier operations to set the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. See [set blob tier details](https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-tier). The operation(subrequest) will be authenticated and authorized with specified credential.See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
Parameter blobClients
The BlobClients for the blobs which should have a new tier set.
Parameter tier
Parameter options

class BlobClient

class BlobClient extends StorageClient {}

A BlobClient represents a URL to an Azure Storage blob; the blob may be a block blob, append blob, or page blob.

constructor

constructor(
    connectionString: string,
    containerName: string,
    blobName: string,
    options?: StoragePipelineOptions
);

Creates an instance of BlobClient from connection string.
Parameter connectionString
Account connection string or a SAS connection string of an Azure storage account. [ Note - Account connection string can only be used in NODE.JS runtime. ] Account connection string example - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS connection string example - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
Parameter containerName
Container name.
Parameter blobName
Blob name.
Parameter options
Optional. Options to configure the HTTP pipeline.

constructor

constructor(url: string, credential?: any, options?: StoragePipelineOptions);

Creates an instance of BlobClient. This method accepts an encoded URL or non-encoded URL pointing to a blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. If a blob name includes ? or %, blob name must be encoded in the URL.
Parameter url
A Client string pointing to Azure Storage blob service, such as "https://myaccount.blob.core.windows.net". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
Parameter credential
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.
Parameter options
Optional. Options to configure the HTTP pipeline.

constructor

constructor(url: string, pipeline: PipelineLike);

Creates an instance of BlobClient. This method accepts an encoded URL or non-encoded URL pointing to a blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. If a blob name includes ? or %, blob name must be encoded in the URL.
Parameter url
A URL string pointing to Azure Storage blob, such as "https://myaccount.blob.core.windows.net/mycontainer/blob". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net/mycontainer/blob?sasString". This method accepts an encoded URL or non-encoded URL pointing to a blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. However, if a blob name includes ? or %, blob name must be encoded in the URL. Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
Parameter pipeline
Call newPipeline() to create a default pipeline, or provide a customized pipeline.

property containerName

readonly containerName: string;

The name of the storage container the blob is associated with.

property name

readonly name: string;

The name of the blob.

method abortCopyFromURL

abortCopyFromURL: (
    copyId: string,
    options?: BlobAbortCopyFromURLOptions
) => Promise<BlobAbortCopyFromURLResponse>;

Aborts a pending asynchronous Copy Blob operation, and leaves a destination blob with zero length and full metadata. Version 2012-02-12 and newer.
Parameter copyId
Id of the Copy From URL operation.
Parameter options
Optional options to the Blob Abort Copy From URL operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob

method beginCopyFromURL

beginCopyFromURL: (
    copySource: string,
    options?: BlobBeginCopyFromURLOptions
) => Promise<
    PollerLikeWithCancellation<
        PollOperationState<BlobBeginCopyFromURLResponse>,
        BlobBeginCopyFromURLResponse
    >
>;

Asynchronously copies a blob to a destination within the storage account. This method returns a long running operation poller that allows you to wait indefinitely until the copy is completed. You can also cancel a copy before it is completed by calling cancelOperation on the poller. Note that the onProgress callback will not be invoked if the operation completes in the first request, and attempting to cancel a completed copy will result in an error being thrown.
In version 2012-02-12 and later, the source for a Copy Blob operation can be a committed blob in any Azure storage account. Beginning with version 2015-02-21, the source for a Copy Blob operation can be an Azure file in any Azure storage account. Only storage accounts created on or after June 7th, 2012 allow the Copy Blob operation to copy from another storage account.
Parameter copySource
url to the source Azure Blob/File.
Parameter options
Optional options to the Blob Start Copy From URL operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob
  Example using automatic polling:
  const copyPoller = await blobClient.beginCopyFromURL('url'); const result = await copyPoller.pollUntilDone();
  Example using manual polling:
  const copyPoller = await blobClient.beginCopyFromURL('url'); while (!poller.isDone()) { await poller.poll(); } const result = copyPoller.getResult();
  Example using progress updates:
  const copyPoller = await blobClient.beginCopyFromURL('url', { onProgress(state) { console.log(`Progress: ${state.copyProgress}`); } }); const result = await copyPoller.pollUntilDone();
  Example using a changing polling interval (default 15 seconds):
  const copyPoller = await blobClient.beginCopyFromURL('url', { intervalInMs: 1000 // poll blob every 1 second for copy progress }); const result = await copyPoller.pollUntilDone();
  Example using copy cancellation:
  const copyPoller = await blobClient.beginCopyFromURL('url'); // cancel operation after starting it. try { await copyPoller.cancelOperation(); // calls to get the result now throw PollerCancelledError await copyPoller.getResult(); } catch (err) { if (err.name === 'PollerCancelledError') { console.log('The copy was cancelled.'); } }

method createSnapshot

createSnapshot: (
    options?: BlobCreateSnapshotOptions
) => Promise<BlobCreateSnapshotResponse>;

Creates a read-only snapshot of a blob.
Parameter options
Optional options to the Blob Create Snapshot operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/snapshot-blob

method delete

delete: (options?: BlobDeleteOptions) => Promise<BlobDeleteResponse>;

Marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time with the Delete Blob operation.
Parameter options
Optional options to Blob Delete operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob

method deleteIfExists

deleteIfExists: (
    options?: BlobDeleteOptions
) => Promise<BlobDeleteIfExistsResponse>;

Marks the specified blob or snapshot for deletion if it exists. The blob is later deleted during garbage collection. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time with the Delete Blob operation.
Parameter options
Optional options to Blob Delete operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob

method deleteImmutabilityPolicy

deleteImmutabilityPolicy: (
    options?: BlobDeleteImmutabilityPolicyOptions
) => Promise<BlobDeleteImmutabilityPolicyResponse>;

Delete the immutablility policy on the blob.
Parameter options
Optional options to delete immutability policy on the blob.

method download

download: (
    offset?: number,
    count?: number,
    options?: BlobDownloadOptions
) => Promise<BlobDownloadResponseParsed>;

Reads or downloads a blob from the system, including its metadata and properties. You can also call Get Blob to read a snapshot.

* In Node.js, data returns in a Readable stream readableStreamBody * In browsers, data returns in a promise blobBody

Parameter offset

From which position of the blob to download, greater than or equal to 0

Parameter count

How much data to be downloaded, greater than 0. Will download to the end when undefined

Parameter options

Optional options to Blob Download operation.

Example usage (Node.js):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(typeof data === "string" ? Buffer.from(data) : data);
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

Example usage (browser):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

method downloadToBuffer

downloadToBuffer: {
    (
        offset?: number,
        count?: number,
        options?: BlobDownloadToBufferOptions
    ): Promise<Buffer>;
    (
        buffer: Buffer,
        offset?: number,
        count?: number,
        options?: BlobDownloadToBufferOptions
    ): Promise<Buffer>;
};

ONLY AVAILABLE IN NODE.JS RUNTIME.
Downloads an Azure Blob in parallel to a buffer. Offset and count are optional, downloads the entire blob if they are not provided.
Warning: Buffers can only support files up to about one gigabyte on 32-bit systems or about two gigabytes on 64-bit systems due to limitations of Node.js/V8. For blobs larger than this size, consider downloadToFile.
Parameter offset
From which position of the block blob to download(in bytes)
Parameter count
How much data(in bytes) to be downloaded. Will download to the end when passing undefined
Parameter options
BlobDownloadToBufferOptions
ONLY AVAILABLE IN NODE.JS RUNTIME.
Downloads an Azure Blob in parallel to a buffer. Offset and count are optional, downloads the entire blob if they are not provided.
Warning: Buffers can only support files up to about one gigabyte on 32-bit systems or about two gigabytes on 64-bit systems due to limitations of Node.js/V8. For blobs larger than this size, consider downloadToFile.
Parameter buffer
Buffer to be fill, must have length larger than count
Parameter offset
From which position of the block blob to download(in bytes)
Parameter count
How much data(in bytes) to be downloaded. Will download to the end when passing undefined
Parameter options
BlobDownloadToBufferOptions

method downloadToFile

downloadToFile: (
    filePath: string,
    offset?: number,
    count?: number,
    options?: BlobDownloadOptions
) => Promise<BlobDownloadResponseParsed>;

ONLY AVAILABLE IN NODE.JS RUNTIME.
Downloads an Azure Blob to a local file. Fails if the the given file path already exits. Offset and count are optional, pass 0 and undefined respectively to download the entire blob.
Parameter filePath
Parameter offset
From which position of the block blob to download.
Parameter count
How much data to be downloaded. Will download to the end when passing undefined.
Parameter options
Options to Blob download options.
Returns
The response data for blob download operation, but with readableStreamBody set to undefined since its content is already read and written into a local file at the specified path.

method exists

exists: (options?: BlobExistsOptions) => Promise<boolean>;

Returns true if the Azure blob resource represented by this client exists; false otherwise.
NOTE: use this function with care since an existing blob might be deleted by other clients or applications. Vice versa new blobs might be added by other clients or applications after this function completes.
Parameter options
options to Exists operation.

method generateSasStringToSign

generateSasStringToSign: (options: BlobGenerateSasUrlOptions) => string;

Only available for BlobClient constructed with a shared key credential.
Generates string to sign for a Blob Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
Parameter options
Optional parameters.
Returns
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

method generateSasUrl

generateSasUrl: (options: BlobGenerateSasUrlOptions) => Promise<string>;

Only available for BlobClient constructed with a shared key credential.
Generates a Blob Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
Parameter options
Optional parameters.
Returns
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

method generateUserDelegationSasStringToSign

generateUserDelegationSasStringToSign: (
    options: BlobGenerateSasUrlOptions,
    userDelegationKey: UserDelegationKey
) => string;

Only available for BlobClient constructed with a shared key credential.
Generates string to sign for a Blob Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the input user delegation key.
Parameter options
Optional parameters.
Parameter userDelegationKey
Return value of blobServiceClient.getUserDelegationKey()
Returns
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

method generateUserDelegationSasUrl

generateUserDelegationSasUrl: (
    options: BlobGenerateSasUrlOptions,
    userDelegationKey: UserDelegationKey
) => Promise<string>;

Generates a Blob Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the input user delegation key.
Parameter options
Optional parameters.
Parameter userDelegationKey
Return value of blobServiceClient.getUserDelegationKey()
Returns
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

method getAccountInfo

getAccountInfo: (
    options?: BlobGetAccountInfoOptions
) => Promise<BlobGetAccountInfoResponse>;

The Get Account Information operation returns the sku name and account kind for the specified account. The Get Account Information operation is available on service versions beginning with version 2018-03-28.
Parameter options
Options to the Service Get Account Info operation.
Returns
Response data for the Service Get Account Info operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information

method getBlobLeaseClient

getBlobLeaseClient: (proposeLeaseId?: string) => BlobLeaseClient;

Get a BlobLeaseClient that manages leases on the blob.
Parameter proposeLeaseId
Initial proposed lease Id.
Returns
A new BlobLeaseClient object for managing leases on the blob.

method getProperties

getProperties: (
    options?: BlobGetPropertiesOptions
) => Promise<BlobGetPropertiesResponse>;

Returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.
Parameter options
Optional options to Get Properties operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
  WARNING: The metadata object returned in the response will have its keys in lowercase, even if they originally contained uppercase characters. This differs from the metadata keys returned by the methods of ContainerClient that list blobs using the includeMetadata option, which will retain their original casing.

method getTags

getTags: (options?: BlobGetTagsOptions) => Promise<BlobGetTagsResponse>;

Gets the tags associated with the underlying blob.
Parameter options

method setAccessTier

setAccessTier: (
    tier: BlockBlobTier | PremiumPageBlobTier | string,
    options?: BlobSetTierOptions
) => Promise<BlobSetTierResponse>;

Sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag.
Parameter tier
The tier to be set on the blob. Valid values are Hot, Cool, or Archive.
Parameter options
Optional options to the Blob Set Tier operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-tier

method setHTTPHeaders

setHTTPHeaders: (
    blobHTTPHeaders?: BlobHTTPHeaders,
    options?: BlobSetHTTPHeadersOptions
) => Promise<BlobSetHTTPHeadersResponse>;

Sets system properties on the blob.
If no value provided, or no value provided for the specified blob HTTP headers, these blob HTTP headers without a value will be cleared.
Parameter blobHTTPHeaders
If no value provided, or no value provided for the specified blob HTTP headers, these blob HTTP headers without a value will be cleared. A common header to set is blobContentType enabling the browser to provide functionality based on file type.
Parameter options
Optional options to Blob Set HTTP Headers operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

method setImmutabilityPolicy

setImmutabilityPolicy: (
    immutabilityPolicy: BlobImmutabilityPolicy,
    options?: BlobSetImmutabilityPolicyOptions
) => Promise<BlobSetImmutabilityPolicyResponse>;

Set immutability policy on the blob.
Parameter options
Optional options to set immutability policy on the blob.

method setLegalHold

setLegalHold: (
    legalHoldEnabled: boolean,
    options?: BlobSetLegalHoldOptions
) => Promise<BlobSetLegalHoldResponse>;

Set legal hold on the blob.
Parameter options
Optional options to set legal hold on the blob.

method setMetadata

setMetadata: (
    metadata?: Metadata,
    options?: BlobSetMetadataOptions
) => Promise<BlobSetMetadataResponse>;

Sets user-defined metadata for the specified blob as one or more name-value pairs.
If no option provided, or no metadata defined in the parameter, the blob metadata will be removed.
Parameter metadata
Replace existing metadata with this value. If no value provided the existing metadata will be removed.
Parameter options
Optional options to Set Metadata operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

method setTags

setTags: (
    tags: Tags,
    options?: BlobSetTagsOptions
) => Promise<BlobSetTagsResponse>;

Sets tags on the underlying blob. A blob can have up to 10 tags. Tag keys must be between 1 and 128 characters. Tag values must be between 0 and 256 characters. Valid tag key and value characters include lower and upper case letters, digits (0-9), space (' '), plus ('+'), minus ('-'), period ('.'), foward slash ('/'), colon (':'), equals ('='), and underscore ('_').
Parameter tags
Parameter options

method syncCopyFromURL

syncCopyFromURL: (
    copySource: string,
    options?: BlobSyncCopyFromURLOptions
) => Promise<BlobCopyFromURLResponse>;

The synchronous Copy From URL operation copies a blob or an internet resource to a new blob. It will not return a response until the copy is complete.
Parameter copySource
The source URL to copy from, Shared Access Signature(SAS) maybe needed for authentication
Parameter options
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url

method undelete

undelete: (options?: BlobUndeleteOptions) => Promise<BlobUndeleteResponse>;

Restores the contents and metadata of soft deleted blob and any associated soft deleted snapshots. Undelete Blob is supported only on version 2017-07-29 or later.
Parameter options
Optional options to Blob Undelete operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/undelete-blob

method withSnapshot

withSnapshot: (snapshot: string) => BlobClient;

Creates a new BlobClient object identical to the source but with the specified snapshot timestamp. Provide "" will remove the snapshot and return a Client to the base blob.
Parameter snapshot
The snapshot timestamp.
Returns
A new BlobClient object identical to the source but with the specified snapshot timestamp

method withVersion

withVersion: (versionId: string) => BlobClient;

Creates a new BlobClient object pointing to a version of this blob. Provide "" will remove the versionId and return a Client to the base blob.
Parameter versionId
The versionId.
Returns
A new BlobClient object pointing to the version of this blob.

class BlobLeaseClient

class BlobLeaseClient {}

A client that manages leases for a ContainerClient or a BlobClient.

constructor

constructor(client: BlobClient | ContainerClient, leaseId?: string);

Creates an instance of BlobLeaseClient.
Parameter client
The client to make the lease operation requests.
Parameter leaseId
Initial proposed lease id.

property leaseId

readonly leaseId: string;

Gets the lease Id.
Modifiers
- @readonly

property url

readonly url: string;

Gets the url.
Modifiers
- @readonly

method acquireLease

acquireLease: (
    duration: number,
    options?: LeaseOperationOptions
) => Promise<LeaseOperationResponse>;

Establishes and manages a lock on a container for delete operations, or on a blob for write and delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.
Parameter duration
Must be between 15 to 60 seconds, or infinite (-1)
Parameter options
option to configure lease management operations.
Returns
Response data for acquire lease operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container and
- https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob

method breakLease

breakLease: (
    breakPeriod: number,
    options?: LeaseOperationOptions
) => Promise<LeaseOperationResponse>;

To end the lease but ensure that another client cannot acquire a new lease until the current lease period has expired.
Parameter breakPeriod
Break period
Parameter options
Optional options to configure lease management operations.
Returns
Response data for break lease operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container and
- https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob

method changeLease

changeLease: (
    proposedLeaseId: string,
    options?: LeaseOperationOptions
) => Promise<LeaseOperationResponse>;

To change the ID of the lease.
Parameter proposedLeaseId
the proposed new lease Id.
Parameter options
option to configure lease management operations.
Returns
Response data for change lease operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container and
- https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob

method releaseLease

releaseLease: (
    options?: LeaseOperationOptions
) => Promise<LeaseOperationResponse>;

To free the lease if it is no longer needed so that another client may immediately acquire a lease against the container or the blob.
Parameter options
option to configure lease management operations.
Returns
Response data for release lease operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container and
- https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob

method renewLease

renewLease: (options?: LeaseOperationOptions) => Promise<Lease>;

To renew the lease.
Parameter options
Optional option to configure lease management operations.
Returns
Response data for renew lease operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container and
- https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob

class BlobSASPermissions

class BlobSASPermissions {}

ONLY AVAILABLE IN NODE.JS RUNTIME.
This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a blob. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the values are set, this should be serialized with toString and set as the permissions field on a BlobSASSignatureValues object. It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness.

property add

add: boolean;

Specifies Add access granted.

property create

create: boolean;

Specifies Create access granted.

property delete

delete: boolean;

Specifies Delete access granted.

property execute

execute: boolean;

Specifies Execute access granted.

property move

move: boolean;

Specifies Move access granted.

property permanentDelete

permanentDelete: boolean;

Specifies that Permanent Delete is permitted.

property read

read: boolean;

Specifies Read access granted.

property setImmutabilityPolicy

setImmutabilityPolicy: boolean;

Specifies SetImmutabilityPolicy access granted.

property tag

tag: boolean;

Specfies Tag access granted.

property write

write: boolean;

Specifies Write access granted.

method from

static from: (permissionLike: BlobSASPermissionsLike) => BlobSASPermissions;

Creates a BlobSASPermissions from a raw object which contains same keys as it and boolean values for them.
Parameter permissionLike

method parse

static parse: (permissions: string) => BlobSASPermissions;

Creates a BlobSASPermissions from the specified permissions string. This method will throw an Error if it encounters a character that does not correspond to a valid permission.
Parameter permissions

method toString

toString: () => string;

Converts the given permissions to a string. Using this method will guarantee the permissions are in an order accepted by the service.
Returns
A string which represents the BlobSASPermissions

class BlobServiceClient

class BlobServiceClient extends StorageClient {}

A BlobServiceClient represents a Client to the Azure Storage Blob service allowing you to manipulate blob containers.

constructor

constructor(url: string, credential?: any, options?: StoragePipelineOptions);

Creates an instance of BlobServiceClient.
Parameter url
A Client string pointing to Azure Storage blob service, such as "https://myaccount.blob.core.windows.net". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
Parameter credential
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.
Parameter options
Optional. Options to configure the HTTP pipeline.
Example using DefaultAzureCredential from @azure/identity:
const account = "<storage account name>"; const defaultAzureCredential = new DefaultAzureCredential(); const blobServiceClient = new BlobServiceClient( `https://${account}.blob.core.windows.net`, defaultAzureCredential );
Example using an account name/key:
const account = "<storage account name>" const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>"); const blobServiceClient = new BlobServiceClient( `https://${account}.blob.core.windows.net`, sharedKeyCredential );

constructor

constructor(url: string, pipeline: PipelineLike);

Creates an instance of BlobServiceClient.
Parameter url
A Client string pointing to Azure Storage blob service, such as "https://myaccount.blob.core.windows.net". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
Parameter pipeline
Call newPipeline() to create a default pipeline, or provide a customized pipeline.

method createContainer

createContainer: (
    containerName: string,
    options?: ContainerCreateOptions
) => Promise<{
    containerClient: ContainerClient;
    containerCreateResponse: ContainerCreateResponse;
}>;

Create a Blob container.
Parameter containerName
Name of the container to create.
Parameter options
Options to configure Container Create operation.
Returns
Container creation response and the corresponding container client.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/create-container

method deleteContainer

deleteContainer: (
    containerName: string,
    options?: ContainerDeleteMethodOptions
) => Promise<ContainerDeleteResponse>;

Deletes a Blob container.
Parameter containerName
Name of the container to delete.
Parameter options
Options to configure Container Delete operation.
Returns
Container deletion response.

method findBlobsByTags

findBlobsByTags: (
    tagFilterSqlExpression: string,
    options?: ServiceFindBlobByTagsOptions
) => PagedAsyncIterableIterator<
    FilterBlobItem,
    ServiceFindBlobsByTagsSegmentResponse
>;

Returns an async iterable iterator to find all blobs with specified tag under the specified account.

.byPage() returns an async iterable iterator to list the blobs in pages.

Parameter tagFilterSqlExpression

The where parameter enables the caller to query blobs whose tags match a given expression. The given expression must evaluate to true for a blob to be returned in the results. The[OData - ABNF] filter syntax rule defines the formal grammar for the value of the where query parameter; however, only a subset of the OData filter syntax is supported in the Blob service.

Parameter options

Options to find blobs by tags.

method fromConnectionString

static fromConnectionString: (
    connectionString: string,
    options?: StoragePipelineOptions
) => BlobServiceClient;

Creates an instance of BlobServiceClient from connection string.
Parameter connectionString
Account connection string or a SAS connection string of an Azure storage account. [ Note - Account connection string can only be used in NODE.JS runtime. ] Account connection string example - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS connection string example - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
Parameter options
Optional. Options to configure the HTTP pipeline.

method generateAccountSasUrl

generateAccountSasUrl: (
    expiresOn?: Date,
    permissions?: AccountSASPermissions,
    resourceTypes?: string,
    options?: ServiceGenerateAccountSasUrlOptions
) => string;

Only available for BlobServiceClient constructed with a shared key credential.
Generates a Blob account Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
Parameter expiresOn
Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not provided.
Parameter permissions
Specifies the list of permissions to be associated with the SAS.
Parameter resourceTypes
Specifies the resource types associated with the shared access signature.
Parameter options
Optional parameters.
Returns
An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas

method generateSasStringToSign

generateSasStringToSign: (
    expiresOn?: Date,
    permissions?: AccountSASPermissions,
    resourceTypes?: string,
    options?: ServiceGenerateAccountSasUrlOptions
) => string;

Only available for BlobServiceClient constructed with a shared key credential.
Generates string to sign for a Blob account Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
Parameter expiresOn
Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not provided.
Parameter permissions
Specifies the list of permissions to be associated with the SAS.
Parameter resourceTypes
Specifies the resource types associated with the shared access signature.
Parameter options
Optional parameters.
Returns
An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas

method getAccountInfo

getAccountInfo: (
    options?: ServiceGetAccountInfoOptions
) => Promise<ServiceGetAccountInfoResponse>;

The Get Account Information operation returns the sku name and account kind for the specified account. The Get Account Information operation is available on service versions beginning with version 2018-03-28.
Parameter options
Options to the Service Get Account Info operation.
Returns
Response data for the Service Get Account Info operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information

method getBlobBatchClient

getBlobBatchClient: () => BlobBatchClient;

Creates a BlobBatchClient object to conduct batch operations.
Returns
A new BlobBatchClient object for this service.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch

method getContainerClient

getContainerClient: (containerName: string) => ContainerClient;

Creates a ContainerClient object
Parameter containerName
A container name
Returns
A new ContainerClient object for the given container name.
Example usage:
const containerClient = blobServiceClient.getContainerClient("<container name>");

method getProperties

getProperties: (
    options?: ServiceGetPropertiesOptions
) => Promise<ServiceGetPropertiesResponse>;

Gets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
Parameter options
Options to the Service Get Properties operation.
Returns
Response data for the Service Get Properties operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties

method getStatistics

getStatistics: (
    options?: ServiceGetStatisticsOptions
) => Promise<ServiceGetStatisticsResponse>;

Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.
Parameter options
Options to the Service Get Statistics operation.
Returns
Response data for the Service Get Statistics operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats

method getUserDelegationKey

getUserDelegationKey: (
    startsOn: Date,
    expiresOn: Date,
    options?: ServiceGetUserDelegationKeyOptions
) => Promise<ServiceGetUserDelegationKeyResponse>;

ONLY AVAILABLE WHEN USING BEARER TOKEN AUTHENTICATION (TokenCredential).
Retrieves a user delegation key for the Blob service. This is only a valid operation when using bearer token authentication.
Parameter startsOn
The start time for the user delegation SAS. Must be within 7 days of the current time
Parameter expiresOn
The end time for the user delegation SAS. Must be within 7 days of the current time
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key

method listContainers

listContainers: (
    options?: ServiceListContainersOptions
) => PagedAsyncIterableIterator<
    ContainerItem,
    ServiceListContainersSegmentResponse
>;

Returns an async iterable iterator to list all the containers under the specified account.

.byPage() returns an async iterable iterator to list the containers in pages.

Example using for await syntax:

let i = 1;
for await (const container of blobServiceClient.listContainers()) {
  console.log(`Container ${i++}: ${container.name}`);
}

Example using iter.next():

let i = 1;
const iter = blobServiceClient.listContainers();
let containerItem = await iter.next();
while (!containerItem.done) {
  console.log(`Container ${i++}: ${containerItem.value.name}`);
  containerItem = await iter.next();
}

Example using byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of blobServiceClient.listContainers().byPage({ maxPageSize: 20 })) {
  if (response.containerItems) {
    for (const container of response.containerItems) {
      console.log(`Container ${i++}: ${container.name}`);
    }
  }
}

Example using paging with a marker:

let i = 1;
let iterator = blobServiceClient.listContainers().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 container names
if (response.containerItems) {
  for (const container of response.containerItems) {
    console.log(`Container ${i++}: ${container.name}`);
  }
}

// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = blobServiceClient
  .listContainers()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 container names
if (response.containerItems) {
  for (const container of response.containerItems) {
     console.log(`Container ${i++}: ${container.name}`);
  }
}

Parameter options

Options to list containers.

Returns

An asyncIterableIterator that supports paging.

method setProperties

setProperties: (
    properties: BlobServiceProperties,
    options?: ServiceSetPropertiesOptions
) => Promise<ServiceSetPropertiesResponse>;

Sets properties for a storage account’s Blob service endpoint, including properties for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.
Parameter properties
Parameter options
Options to the Service Set Properties operation.
Returns
Response data for the Service Set Properties operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties

method undeleteContainer

undeleteContainer: (
    deletedContainerName: string,
    deletedContainerVersion: string,
    options?: ServiceUndeleteContainerOptions
) => Promise<{
    containerClient: ContainerClient;
    containerUndeleteResponse: ContainerUndeleteResponse;
}>;

Restore a previously deleted Blob container. This API is only functional if Container Soft Delete is enabled for the storage account associated with the container.
Parameter deletedContainerName
Name of the previously deleted container.
Parameter deletedContainerVersion
Version of the previously deleted container, used to uniquely identify the deleted container.
Parameter options
Options to configure Container Restore operation.
Returns
Container deletion response.

class BlockBlobClient

class BlockBlobClient extends BlobClient {}

BlockBlobClient defines a set of operations applicable to block blobs.

constructor

constructor(
    connectionString: string,
    containerName: string,
    blobName: string,
    options?: StoragePipelineOptions
);

Creates an instance of BlockBlobClient.
Parameter connectionString
Account connection string or a SAS connection string of an Azure storage account. [ Note - Account connection string can only be used in NODE.JS runtime. ] Account connection string example - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS connection string example - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
Parameter containerName
Container name.
Parameter blobName
Blob name.
Parameter options
Optional. Options to configure the HTTP pipeline.

constructor

constructor(url: string, credential?: any, options?: StoragePipelineOptions);

Creates an instance of BlockBlobClient. This method accepts an encoded URL or non-encoded URL pointing to a block blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. If a blob name includes ? or %, blob name must be encoded in the URL.
Parameter url
A URL string pointing to Azure Storage block blob, such as "https://myaccount.blob.core.windows.net/mycontainer/blockblob". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString". This method accepts an encoded URL or non-encoded URL pointing to a blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. However, if a blob name includes ? or %, blob name must be encoded in the URL. Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
Parameter credential
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.
Parameter options
Optional. Options to configure the HTTP pipeline.

constructor

constructor(url: string, pipeline: PipelineLike);

Creates an instance of BlockBlobClient. This method accepts an encoded URL or non-encoded URL pointing to a block blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. If a blob name includes ? or %, blob name must be encoded in the URL.
Parameter url
A URL string pointing to Azure Storage block blob, such as "https://myaccount.blob.core.windows.net/mycontainer/blockblob". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString". This method accepts an encoded URL or non-encoded URL pointing to a blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. However, if a blob name includes ? or %, blob name must be encoded in the URL. Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
Parameter pipeline
Call newPipeline() to create a default pipeline, or provide a customized pipeline.

method commitBlockList

commitBlockList: (
    blocks: string[],
    options?: BlockBlobCommitBlockListOptions
) => Promise<BlockBlobCommitBlockListResponse>;

Writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior stageBlock operation. You can call commitBlockList to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. Any blocks not specified in the block list and permanently deleted.
Parameter blocks
Array of 64-byte value that is base64-encoded
Parameter options
Options to the Block Blob Commit Block List operation.
Returns
Response data for the Block Blob Commit Block List operation.
See Also
- https://learn.microsoft.com/rest/api/storageservices/put-block-list

method getBlockList

getBlockList: (
    listType: BlockListType,
    options?: BlockBlobGetBlockListOptions
) => Promise<BlockBlobGetBlockListResponse>;

Returns the list of blocks that have been uploaded as part of a block blob using the specified block list filter.
Parameter listType
Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together.
Parameter options
Options to the Block Blob Get Block List operation.
Returns
Response data for the Block Blob Get Block List operation.
See Also
- https://learn.microsoft.com/rest/api/storageservices/get-block-list

method query

query: (
    query: string,
    options?: BlockBlobQueryOptions
) => Promise<BlobDownloadResponseModel>;

ONLY AVAILABLE IN NODE.JS RUNTIME.

Quick query for a JSON or CSV formatted blob.

Example usage (Node.js):

// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob content:", downloaded);

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(typeof data === "string" ? Buffer.from(data) : data);
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

Parameter query

Parameter options

method stageBlock

stageBlock: (
    blockId: string,
    body: HttpRequestBody,
    contentLength: number,
    options?: BlockBlobStageBlockOptions
) => Promise<BlockBlobStageBlockResponse>;

Uploads the specified block to the block blob's "staging area" to be later committed by a call to commitBlockList.
Parameter blockId
A 64-byte value that is base64-encoded
Parameter body
Data to upload to the staging area.
Parameter contentLength
Number of bytes to upload.
Parameter options
Options to the Block Blob Stage Block operation.
Returns
Response data for the Block Blob Stage Block operation.
See Also
- https://learn.microsoft.com/rest/api/storageservices/put-block

method stageBlockFromURL

stageBlockFromURL: (
    blockId: string,
    sourceURL: string,
    offset?: number,
    count?: number,
    options?: BlockBlobStageBlockFromURLOptions
) => Promise<BlockBlobStageBlockFromURLResponse>;

The Stage Block From URL operation creates a new block to be committed as part of a blob where the contents are read from a URL. This API is available starting in version 2018-03-28.
Parameter blockId
A 64-byte value that is base64-encoded
Parameter sourceURL
Specifies the URL of the blob. The value may be a URL of up to 2 KB in length that specifies a blob. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature. If the source blob is public, no authentication is required to perform the operation. Here are some examples of source object URLs: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
Parameter offset
From which position of the blob to download, greater than or equal to 0
Parameter count
How much data to be downloaded, greater than 0. Will download to the end when undefined
Parameter options
Options to the Block Blob Stage Block From URL operation.
Returns
Response data for the Block Blob Stage Block From URL operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/put-block-from-url

method syncUploadFromURL

syncUploadFromURL: (
    sourceURL: string,
    options?: BlockBlobSyncUploadFromURLOptions
) => Promise<BlockBlobPutBlobFromUrlResponse>;

Creates a new Block Blob where the contents of the blob are read from a given URL. This API is supported beginning with the 2020-04-08 version. Partial updates are not supported with Put Blob from URL; the content of an existing blob is overwritten with the content of the new blob. To perform partial updates to a block blob’s contents using a source URL, use stageBlockFromURL and commitBlockList.
Parameter sourceURL
Specifies the URL of the blob. The value may be a URL of up to 2 KB in length that specifies a blob. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature. If the source blob is public, no authentication is required to perform the operation. Here are some examples of source object URLs: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
Parameter options
Optional parameters.

method upload

upload: (
    body: HttpRequestBody,
    contentLength: number,
    options?: BlockBlobUploadOptions
) => Promise<BlockBlobUploadResponse>;

Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported; the content of the existing blob is overwritten with the new content. To perform a partial update of a block blob's, use stageBlock and commitBlockList.
This is a non-parallel uploading method, please use uploadFile, uploadStream or uploadBrowserData for better performance with concurrency uploading.
Parameter body
Blob, string, ArrayBuffer, ArrayBufferView or a function which returns a new Readable stream whose offset is from data source beginning.
Parameter contentLength
Length of body in bytes. Use Buffer.byteLength() to calculate body length for a string including non non-Base64/Hex-encoded characters.
Parameter options
Options to the Block Blob Upload operation.
Returns
Response data for the Block Blob Upload operation.
Example usage:
const content = "Hello world!"; const uploadBlobResponse = await blockBlobClient.upload(content, content.length);
See Also
- https://learn.microsoft.com/rest/api/storageservices/put-blob

method uploadBrowserData

uploadBrowserData: (
    browserData: Blob | ArrayBuffer | ArrayBufferView,
    options?: BlockBlobParallelUploadOptions
) => Promise<BlobUploadCommonResponse>;

ONLY AVAILABLE IN BROWSERS.
Uploads a browser Blob/File/ArrayBuffer/ArrayBufferView object to block blob.
When buffer length lesser than or equal to 256MB, this method will use 1 upload call to finish the upload. Otherwise, this method will call stageBlock to upload blocks, and finally call commitBlockList to commit the block list.
A common BlockBlobParallelUploadOptions.blobHTTPHeaders option to set is blobContentType, enabling the browser to provide functionality based on file type.
Parameter browserData
Blob, File, ArrayBuffer or ArrayBufferView
Parameter options
Options to upload browser data.
Returns
Response data for the Blob Upload operation.
Deprecated
Use uploadData instead.

method uploadData

uploadData: (
    data: Buffer | Blob | ArrayBuffer | ArrayBufferView,
    options?: BlockBlobParallelUploadOptions
) => Promise<BlobUploadCommonResponse>;

Uploads a Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView object to a BlockBlob.
When data length is no more than the specifiled BlockBlobParallelUploadOptions.maxSingleShotSize (default is BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES), this method will use 1 upload call to finish the upload. Otherwise, this method will call stageBlock to upload blocks, and finally call commitBlockList to commit the block list.
A common BlockBlobParallelUploadOptions.blobHTTPHeaders option to set is blobContentType, enabling the browser to provide functionality based on file type.
Parameter data
Buffer(Node.js), Blob, ArrayBuffer or ArrayBufferView
Parameter options

method uploadFile

uploadFile: (
    filePath: string,
    options?: BlockBlobParallelUploadOptions
) => Promise<BlobUploadCommonResponse>;

ONLY AVAILABLE IN NODE.JS RUNTIME.
Uploads a local file in blocks to a block blob.
When file size lesser than or equal to 256MB, this method will use 1 upload call to finish the upload. Otherwise, this method will call stageBlock to upload blocks, and finally call commitBlockList to commit the block list.
Parameter filePath
Full path of local file
Parameter options
Options to Upload to Block Blob operation.
Returns
Response data for the Blob Upload operation.

method uploadStream

uploadStream: (
    stream: Readable,
    bufferSize?: number,
    maxConcurrency?: number,
    options?: BlockBlobUploadStreamOptions
) => Promise<BlobUploadCommonResponse>;

ONLY AVAILABLE IN NODE.JS RUNTIME.
Uploads a Node.js Readable stream into block blob.
PERFORMANCE IMPROVEMENT TIPS: * Input stream highWaterMark is better to set a same value with bufferSize parameter, which will avoid Buffer.concat() operations.
Parameter stream
Node.js Readable stream
Parameter bufferSize
Size of every buffer allocated, also the block size in the uploaded block blob. Default value is 8MB
Parameter maxConcurrency
Max concurrency indicates the max number of buffers that can be allocated, positive correlation with max uploading concurrency. Default value is 5
Parameter options
Options to Upload Stream to Block Blob operation.
Returns
Response data for the Blob Upload operation.

method withSnapshot

withSnapshot: (snapshot: string) => BlockBlobClient;

Creates a new BlockBlobClient object identical to the source but with the specified snapshot timestamp. Provide "" will remove the snapshot and return a URL to the base blob.
Parameter snapshot
The snapshot timestamp.
Returns
A new BlockBlobClient object identical to the source but with the specified snapshot timestamp.

class ContainerClient

class ContainerClient extends StorageClient {}

A ContainerClient represents a URL to the Azure Storage container allowing you to manipulate its blobs.

constructor

constructor(
    connectionString: string,
    containerName: string,
    options?: StoragePipelineOptions
);

Creates an instance of ContainerClient.
Parameter connectionString
Account connection string or a SAS connection string of an Azure storage account. [ Note - Account connection string can only be used in NODE.JS runtime. ] Account connection string example - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS connection string example - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
Parameter containerName
Container name.
Parameter options
Optional. Options to configure the HTTP pipeline.

constructor

constructor(url: string, credential?: any, options?: StoragePipelineOptions);

Creates an instance of ContainerClient. This method accepts an URL pointing to a container. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. If a blob name includes ? or %, blob name must be encoded in the URL.
Parameter url
A URL string pointing to Azure Storage container, such as "https://myaccount.blob.core.windows.net/mycontainer". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net/mycontainer?sasString".
Parameter credential
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.
Parameter options
Optional. Options to configure the HTTP pipeline.

constructor

constructor(url: string, pipeline: PipelineLike);

Creates an instance of ContainerClient. This method accepts an URL pointing to a container. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. If a blob name includes ? or %, blob name must be encoded in the URL.
Parameter url
A URL string pointing to Azure Storage container, such as "https://myaccount.blob.core.windows.net/mycontainer". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net/mycontainer?sasString".
Parameter pipeline
Call newPipeline() to create a default pipeline, or provide a customized pipeline.

property containerName

readonly containerName: string;

The name of the container.

method create

create: (options?: ContainerCreateOptions) => Promise<ContainerCreateResponse>;

Creates a new container under the specified account. If the container with the same name already exists, the operation fails.
Parameter options
Options to Container Create operation.
Example usage:
const containerClient = blobServiceClient.getContainerClient("<container name>"); const createContainerResponse = await containerClient.create(); console.log("Container was created successfully", createContainerResponse.requestId);
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/create-container Naming rules:
- https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

method createIfNotExists

createIfNotExists: (
    options?: ContainerCreateOptions
) => Promise<ContainerCreateIfNotExistsResponse>;

Creates a new container under the specified account. If the container with the same name already exists, it is not changed.
Parameter options
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/create-container Naming rules:
- https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

method delete

delete: (
    options?: ContainerDeleteMethodOptions
) => Promise<ContainerDeleteResponse>;

Marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection.
Parameter options
Options to Container Delete operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container

method deleteBlob

deleteBlob: (
    blobName: string,
    options?: ContainerDeleteBlobOptions
) => Promise<BlobDeleteResponse>;

Marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time with the Delete Blob operation.
Parameter blobName
Parameter options
Options to Blob Delete operation.
Returns
Block blob deletion response data.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob

method deleteIfExists

deleteIfExists: (
    options?: ContainerDeleteMethodOptions
) => Promise<ContainerDeleteIfExistsResponse>;

Marks the specified container for deletion if it exists. The container and any blobs contained within it are later deleted during garbage collection.
Parameter options
Options to Container Delete operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container

method exists

exists: (options?: ContainerExistsOptions) => Promise<boolean>;

Returns true if the Azure container resource represented by this client exists; false otherwise.
NOTE: use this function with care since an existing container might be deleted by other clients or applications. Vice versa new containers with the same name might be added by other clients or applications after this function completes.
Parameter options

method findBlobsByTags

findBlobsByTags: (
    tagFilterSqlExpression: string,
    options?: ContainerFindBlobByTagsOptions
) => PagedAsyncIterableIterator<
    FilterBlobItem,
    ContainerFindBlobsByTagsSegmentResponse
>;

Returns an async iterable iterator to find all blobs with specified tag under the specified container.

.byPage() returns an async iterable iterator to list the blobs in pages.

Example using for await syntax:

let i = 1;
for await (const blob of containerClient.findBlobsByTags("tagkey='tagvalue'")) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

Example using iter.next():

let i = 1;
const iter = containerClient.findBlobsByTags("tagkey='tagvalue'");
let blobItem = await iter.next();
while (!blobItem.done) {
  console.log(`Blob ${i++}: ${blobItem.value.name}`);
  blobItem = await iter.next();
}

Example using byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of containerClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 20 })) {
  if (response.blobs) {
    for (const blob of response.blobs) {
      console.log(`Blob ${i++}: ${blob.name}`);
    }
  }
}

Example using paging with a marker:

let i = 1;
let iterator = containerClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 blob names
if (response.blobs) {
  for (const blob of response.blobs) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = containerClient
  .findBlobsByTags("tagkey='tagvalue'")
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints blob names
if (response.blobs) {
  for (const blob of response.blobs) {
     console.log(`Blob ${i++}: ${blob.name}`);
  }
}

Parameter tagFilterSqlExpression

Parameter options

Options to find blobs by tags.

method generateSasStringToSign

generateSasStringToSign: (options: ContainerGenerateSasUrlOptions) => string;

Only available for ContainerClient constructed with a shared key credential.
Generates string to sign for a Blob Container Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
Parameter options
Optional parameters.
Returns
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

method generateSasUrl

generateSasUrl: (options: ContainerGenerateSasUrlOptions) => Promise<string>;

Only available for ContainerClient constructed with a shared key credential.
Generates a Blob Container Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
Parameter options
Optional parameters.
Returns
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

method generateUserDelegationSasStringToSign

generateUserDelegationSasStringToSign: (
    options: ContainerGenerateSasUrlOptions,
    userDelegationKey: UserDelegationKey
) => string;

Generates string to sign for a Blob Container Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the input user delegation key.
Parameter options
Optional parameters.
Parameter userDelegationKey
Return value of blobServiceClient.getUserDelegationKey()
Returns
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

method generateUserDelegationSasUrl

generateUserDelegationSasUrl: (
    options: ContainerGenerateSasUrlOptions,
    userDelegationKey: UserDelegationKey
) => Promise<string>;

Generates a Blob Container Service Shared Access Signature (SAS) URI based on the client properties and parameters passed in. The SAS is signed by the input user delegation key.
Parameter options
Optional parameters.
Parameter userDelegationKey
Return value of blobServiceClient.getUserDelegationKey()
Returns
The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

method getAccessPolicy

getAccessPolicy: (
    options?: ContainerGetAccessPolicyOptions
) => Promise<ContainerGetAccessPolicyResponse>;

Gets the permissions for the specified container. The permissions indicate whether container data may be accessed publicly.
WARNING: JavaScript Date will potentially lose precision when parsing startsOn and expiresOn strings. For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
Parameter options
Options to Container Get Access Policy operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-acl

method getAccountInfo

getAccountInfo: (
    options?: ContainerGetAccountInfoOptions
) => Promise<ContainerGetAccountInfoResponse>;

The Get Account Information operation returns the sku name and account kind for the specified account. The Get Account Information operation is available on service versions beginning with version 2018-03-28.
Parameter options
Options to the Service Get Account Info operation.
Returns
Response data for the Service Get Account Info operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information

method getAppendBlobClient

getAppendBlobClient: (blobName: string) => AppendBlobClient;

Creates an AppendBlobClient
Parameter blobName
An append blob name

method getBlobBatchClient

getBlobBatchClient: () => BlobBatchClient;

Creates a BlobBatchClient object to conduct batch operations.
Returns
A new BlobBatchClient object for this container.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch

method getBlobClient

getBlobClient: (blobName: string) => BlobClient;

Creates a BlobClient
Parameter blobName
A blob name
Returns
A new BlobClient object for the given blob name.

method getBlobLeaseClient

getBlobLeaseClient: (proposeLeaseId?: string) => BlobLeaseClient;

Get a BlobLeaseClient that manages leases on the container.
Parameter proposeLeaseId
Initial proposed lease Id.
Returns
A new BlobLeaseClient object for managing leases on the container.

method getBlockBlobClient

getBlockBlobClient: (blobName: string) => BlockBlobClient;

Creates a BlockBlobClient

Parameter blobName

A block blob name

Example usage:

const content = "Hello world!";

const blockBlobClient = containerClient.getBlockBlobClient("<blob name>");
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

method getPageBlobClient

getPageBlobClient: (blobName: string) => PageBlobClient;

Creates a PageBlobClient
Parameter blobName
A page blob name

method getProperties

getProperties: (
    options?: ContainerGetPropertiesOptions
) => Promise<ContainerGetPropertiesResponse>;

Returns all user-defined metadata and system properties for the specified container. The data returned does not include the container's list of blobs.
Parameter options
Options to Container Get Properties operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-properties
  WARNING: The metadata object returned in the response will have its keys in lowercase, even if they originally contained uppercase characters. This differs from the metadata keys returned by the listContainers method of BlobServiceClient using the includeMetadata option, which will retain their original casing.

method listBlobsByHierarchy

listBlobsByHierarchy: (
    delimiter: string,
    options?: ContainerListBlobsOptions
) => PagedAsyncIterableIterator<
    ({ kind: 'prefix' } & BlobPrefix) | ({ kind: 'blob' } & BlobItem),
    ContainerListBlobHierarchySegmentResponse
>;

Returns an async iterable iterator to list all the blobs by hierarchy. under the specified account.

.byPage() returns an async iterable iterator to list the blobs by hierarchy in pages.

Example using for await syntax:

for await (const item of containerClient.listBlobsByHierarchy("/")) {
  if (item.kind === "prefix") {
    console.log(`\tBlobPrefix: ${item.name}`);
  } else {
    console.log(`\tBlobItem: name - ${item.name}`);
  }
}

Example using iter.next():

let iter = containerClient.listBlobsByHierarchy("/", { prefix: "prefix1/" });
let entity = await iter.next();
while (!entity.done) {
  let item = entity.value;
  if (item.kind === "prefix") {
    console.log(`\tBlobPrefix: ${item.name}`);
  } else {
    console.log(`\tBlobItem: name - ${item.name}`);
  }
  entity = await iter.next();
}

Example using byPage():

console.log("Listing blobs by hierarchy by page");
for await (const response of containerClient.listBlobsByHierarchy("/").byPage()) {
  const segment = response.segment;
  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }
  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}`);
  }
}

Example using paging with a max page size:

console.log("Listing blobs by hierarchy by page, specifying a prefix and a max page size");

let i = 1;
for await (const response of containerClient
  .listBlobsByHierarchy("/", { prefix: "prefix2/sub1/" })
  .byPage({ maxPageSize: 2 })) {
  console.log(`Page ${i++}`);
  const segment = response.segment;

  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }

  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}`);
  }
}

Parameter delimiter

The character or string used to define the virtual hierarchy

Parameter options

Options to list blobs operation.

method listBlobsFlat

listBlobsFlat: (
    options?: ContainerListBlobsOptions
) => PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse>;

Returns an async iterable iterator to list all the blobs under the specified account.

.byPage() returns an async iterable iterator to list the blobs in pages.

Example using for await syntax:

// Get the containerClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>");`
let i = 1;
for await (const blob of containerClient.listBlobsFlat()) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

Example using iter.next():

let i = 1;
let iter = containerClient.listBlobsFlat();
let blobItem = await iter.next();
while (!blobItem.done) {
  console.log(`Blob ${i++}: ${blobItem.value.name}`);
  blobItem = await iter.next();
}

Example using byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of containerClient.listBlobsFlat().byPage({ maxPageSize: 20 })) {
  for (const blob of response.segment.blobItems) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

Example using paging with a marker:

let i = 1;
let iterator = containerClient.listBlobsFlat().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 blob names
for (const blob of response.segment.blobItems) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = containerClient.listBlobsFlat().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 blob names
for (const blob of response.segment.blobItems) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

Parameter options

Options to list blobs.

Returns

An asyncIterableIterator that supports paging.

method setAccessPolicy

setAccessPolicy: (
    access?: PublicAccessType,
    containerAcl?: SignedIdentifier[],
    options?: ContainerSetAccessPolicyOptions
) => Promise<ContainerSetAccessPolicyResponse>;

Sets the permissions for the specified container. The permissions indicate whether blobs in a container may be accessed publicly.
When you set permissions for a container, the existing permissions are replaced. If no access or containerAcl provided, the existing container ACL will be removed.
When you establish a stored access policy on a container, it may take up to 30 seconds to take effect. During this interval, a shared access signature that is associated with the stored access policy will fail with status code 403 (Forbidden), until the access policy becomes active.
Parameter access
The level of public access to data in the container.
Parameter containerAcl
Array of elements each having a unique Id and details of the access policy.
Parameter options
Options to Container Set Access Policy operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-acl

method setMetadata

setMetadata: (
    metadata?: Metadata,
    options?: ContainerSetMetadataOptions
) => Promise<ContainerSetMetadataResponse>;

Sets one or more user-defined name-value pairs for the specified container.
If no option provided, or no metadata defined in the parameter, the container metadata will be removed.
Parameter metadata
Replace existing metadata with this value. If no value provided the existing metadata will be removed.
Parameter options
Options to Container Set Metadata operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-metadata

method uploadBlockBlob

uploadBlockBlob: (
    blobName: string,
    body: HttpRequestBody,
    contentLength: number,
    options?: BlockBlobUploadOptions
) => Promise<{
    blockBlobClient: BlockBlobClient;
    response: BlockBlobUploadResponse;
}>;

Creates a new block blob, or updates the content of an existing block blob.
Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported; the content of the existing blob is overwritten with the new content. To perform a partial update of a block blob's, use BlockBlobClient.stageBlock and BlockBlobClient.commitBlockList.
This is a non-parallel uploading method, please use BlockBlobClient.uploadFile, BlockBlobClient.uploadStream or BlockBlobClient.uploadBrowserData for better performance with concurrency uploading.
Parameter blobName
Name of the block blob to create or update.
Parameter body
Blob, string, ArrayBuffer, ArrayBufferView or a function which returns a new Readable stream whose offset is from data source beginning.
Parameter contentLength
Length of body in bytes. Use Buffer.byteLength() to calculate body length for a string including non non-Base64/Hex-encoded characters.
Parameter options
Options to configure the Block Blob Upload operation.
Returns
Block Blob upload response data and the corresponding BlockBlobClient instance.
See Also
- https://learn.microsoft.com/rest/api/storageservices/put-blob

class ContainerSASPermissions

class ContainerSASPermissions {}

This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a container. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the values are set, this should be serialized with toString and set as the permissions field on a BlobSASSignatureValues object. It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness.

property add

add: boolean;

Specifies Add access granted.

property create

create: boolean;

Specifies Create access granted.

property delete

delete: boolean;

Specifies Delete access granted.

property deleteVersion

deleteVersion: boolean;

Specifies Delete version access granted.

property execute

execute: boolean;

Specifies Execute access granted.

property filterByTags

filterByTags: boolean;

Specifies that Filter Blobs by Tags is permitted.

property list

list: boolean;

Specifies List access granted.

property move

move: boolean;

Specifies Move access granted.

property permanentDelete

permanentDelete: boolean;

Specifies that Permanent Delete is permitted.

property read

read: boolean;

Specifies Read access granted.

property setImmutabilityPolicy

setImmutabilityPolicy: boolean;

Specifies SetImmutabilityPolicy access granted.

property tag

tag: boolean;

Specfies Tag access granted.

property write

write: boolean;

Specifies Write access granted.

method from

static from: (
    permissionLike: ContainerSASPermissionsLike
) => ContainerSASPermissions;

Creates a ContainerSASPermissions from a raw object which contains same keys as it and boolean values for them.
Parameter permissionLike

method parse

static parse: (permissions: string) => ContainerSASPermissions;

Creates an ContainerSASPermissions from the specified permissions string. This method will throw an Error if it encounters a character that does not correspond to a valid permission.
Parameter permissions

method toString

toString: () => string;

Converts the given permissions to a string. Using this method will guarantee the permissions are in an order accepted by the service.
The order of the characters should be as specified here to ensure correctness.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

class Credential

abstract class Credential_2 implements RequestPolicyFactory {}

Credential is an abstract class for Azure Storage HTTP requests signing. This class will host an credentialPolicyCreator factory which generates CredentialPolicy.

method create

create: (
    _nextPolicy: RequestPolicy,
    _options: RequestPolicyOptions
) => RequestPolicy;

Creates a RequestPolicy object.
Parameter _nextPolicy
Parameter _options

class CredentialPolicy

abstract class CredentialPolicy extends BaseRequestPolicy {}

Credential policy used to sign HTTP(S) requests before sending. This is an abstract class.

method sendRequest

sendRequest: (request: WebResource) => Promise<HttpOperationResponse>;

Sends out request.
Parameter request

method signRequest

protected signRequest: (request: WebResource) => WebResource;

Child classes must implement this method with request signing. This method will be executed in sendRequest.
Parameter request

class PageBlobClient

class PageBlobClient extends BlobClient {}

PageBlobClient defines a set of operations applicable to page blobs.

constructor

constructor(
    connectionString: string,
    containerName: string,
    blobName: string,
    options?: StoragePipelineOptions
);

Creates an instance of PageBlobClient.
Parameter connectionString
Account connection string or a SAS connection string of an Azure storage account. [ Note - Account connection string can only be used in NODE.JS runtime. ] Account connection string example - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS connection string example - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
Parameter containerName
Container name.
Parameter blobName
Blob name.
Parameter options
Optional. Options to configure the HTTP pipeline.

constructor

constructor(url: string, credential: any, options?: StoragePipelineOptions);

Creates an instance of PageBlobClient. This method accepts an encoded URL or non-encoded URL pointing to a blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. If a blob name includes ? or %, blob name must be encoded in the URL.
Parameter url
A Client string pointing to Azure Storage page blob, such as "https://myaccount.blob.core.windows.net/mycontainer/pageblob". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString".
Parameter credential
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.
Parameter options
Optional. Options to configure the HTTP pipeline.

constructor

constructor(url: string, pipeline: PipelineLike);

Creates an instance of PageBlobClient.
Parameter url
A URL string pointing to Azure Storage page blob, such as "https://myaccount.blob.core.windows.net/mycontainer/pageblob". You can append a SAS if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString". This method accepts an encoded URL or non-encoded URL pointing to a blob. Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped. However, if a blob name includes ? or %, blob name must be encoded in the URL. Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
Parameter pipeline
Call newPipeline() to create a default pipeline, or provide a customized pipeline.

method clearPages

clearPages: (
    offset?: number,
    count?: number,
    options?: PageBlobClearPagesOptions
) => Promise<PageBlobClearPagesResponse>;

Frees the specified pages from the page blob.
Parameter offset
Starting byte position of the pages to clear.
Parameter count
Number of bytes to clear.
Parameter options
Options to the Page Blob Clear Pages operation.
Returns
Response data for the Page Blob Clear Pages operation.
See Also
- https://learn.microsoft.com/rest/api/storageservices/put-page

method create

create: (
    size: number,
    options?: PageBlobCreateOptions
) => Promise<PageBlobCreateResponse>;

Creates a page blob of the specified length. Call uploadPages to upload data data to a page blob.
Parameter size
size of the page blob.
Parameter options
Options to the Page Blob Create operation.
Returns
Response data for the Page Blob Create operation.
See Also
- https://learn.microsoft.com/rest/api/storageservices/put-blob

method createIfNotExists

createIfNotExists: (
    size: number,
    options?: PageBlobCreateIfNotExistsOptions
) => Promise<PageBlobCreateIfNotExistsResponse>;

Creates a page blob of the specified length. Call uploadPages to upload data data to a page blob. If the blob with the same name already exists, the content of the existing blob will remain unchanged.
Parameter size
size of the page blob.
Parameter options
See Also
- https://learn.microsoft.com/rest/api/storageservices/put-blob

method getPageRanges

getPageRanges: (
    offset?: number,
    count?: number,
    options?: PageBlobGetPageRangesOptions
) => Promise<PageBlobGetPageRangesResponse>;

Returns the list of valid page ranges for a page blob or snapshot of a page blob.
Parameter offset
Starting byte position of the page ranges.
Parameter count
Number of bytes to get.
Parameter options
Options to the Page Blob Get Ranges operation.
Returns
Response data for the Page Blob Get Ranges operation.
See Also
- https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

method getPageRangesDiff

getPageRangesDiff: (
    offset: number,
    count: number,
    prevSnapshot: string,
    options?: PageBlobGetPageRangesDiffOptions
) => Promise<PageBlobGetPageRangesDiffResponse>;

Gets the collection of page ranges that differ between a specified snapshot and this page blob.
Parameter offset
Starting byte position of the page blob
Parameter count
Number of bytes to get ranges diff.
Parameter prevSnapshot
Timestamp of snapshot to retrieve the difference.
Parameter options
Options to the Page Blob Get Page Ranges Diff operation.
Returns
Response data for the Page Blob Get Page Range Diff operation.
See Also
- https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

method getPageRangesDiffForManagedDisks

getPageRangesDiffForManagedDisks: (
    offset: number,
    count: number,
    prevSnapshotUrl: string,
    options?: PageBlobGetPageRangesDiffOptions
) => Promise<PageBlobGetPageRangesDiffResponse>;

Gets the collection of page ranges that differ between a specified snapshot and this page blob for managed disks.
Parameter offset
Starting byte position of the page blob
Parameter count
Number of bytes to get ranges diff.
Parameter prevSnapshotUrl
URL of snapshot to retrieve the difference.
Parameter options
Options to the Page Blob Get Page Ranges Diff operation.
Returns
Response data for the Page Blob Get Page Range Diff operation.
See Also
- https://learn.microsoft.com/rest/api/storageservices/get-page-ranges

method listPageRanges

listPageRanges: (
    offset?: number,
    count?: number,
    options?: PageBlobListPageRangesOptions
) => PagedAsyncIterableIterator<
    PageRangeInfo,
    PageBlobGetPageRangesResponseModel
>;

Returns an async iterable iterator to list of page ranges for a page blob.

Parameter offset

Starting byte position of the page ranges.

Parameter count

Number of bytes to get.

Parameter options

Options to the Page Blob Get Ranges operation.

Returns

An asyncIterableIterator that supports paging.

method listPageRangesDiff

listPageRangesDiff: (
    offset: number,
    count: number,
    prevSnapshot: string,
    options?: PageBlobListPageRangesDiffOptions
) => PagedAsyncIterableIterator<
    PageRangeInfo,
    PageBlobGetPageRangesDiffResponseModel
>;

Returns an async iterable iterator to list of page ranges that differ between a specified snapshot and this page blob.

Parameter offset

Starting byte position of the page ranges.

Parameter count

Number of bytes to get.

Parameter prevSnapshot

Timestamp of snapshot to retrieve the difference.

Parameter options

Options to the Page Blob Get Ranges operation.

Returns

An asyncIterableIterator that supports paging.

method resize

resize: (
    size: number,
    options?: PageBlobResizeOptions
) => Promise<PageBlobResizeResponse>;

Resizes the page blob to the specified size (which must be a multiple of 512).
Parameter size
Target size
Parameter options
Options to the Page Blob Resize operation.
Returns
Response data for the Page Blob Resize operation.
See Also
- https://learn.microsoft.com/rest/api/storageservices/set-blob-properties

method startCopyIncremental

startCopyIncremental: (
    copySource: string,
    options?: PageBlobStartCopyIncrementalOptions
) => Promise<PageBlobCopyIncrementalResponse>;

Begins an operation to start an incremental copy from one page blob's snapshot to this page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual.
Parameter copySource
Specifies the name of the source page blob snapshot. For example, https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
Parameter options
Options to the Page Blob Copy Incremental operation.
Returns
Response data for the Page Blob Copy Incremental operation.
See Also
- https://learn.microsoft.com/rest/api/storageservices/incremental-copy-blob
- https://learn.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots

method updateSequenceNumber

updateSequenceNumber: (
    sequenceNumberAction: SequenceNumberActionType,
    sequenceNumber?: number,
    options?: PageBlobUpdateSequenceNumberOptions
) => Promise<PageBlobUpdateSequenceNumberResponse>;

Sets a page blob's sequence number.
Parameter sequenceNumberAction
Indicates how the service should modify the blob's sequence number.
Parameter sequenceNumber
Required if sequenceNumberAction is max or update
Parameter options
Options to the Page Blob Update Sequence Number operation.
Returns
Response data for the Page Blob Update Sequence Number operation.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

method uploadPages

uploadPages: (
    body: HttpRequestBody,
    offset: number,
    count: number,
    options?: PageBlobUploadPagesOptions
) => Promise<PageBlobUploadPagesResponse>;

Writes 1 or more pages to the page blob. The start and end offsets must be a multiple of 512.
Parameter body
Data to upload
Parameter offset
Offset of destination page blob
Parameter count
Content length of the body, also number of bytes to be uploaded
Parameter options
Options to the Page Blob Upload Pages operation.
Returns
Response data for the Page Blob Upload Pages operation.
See Also
- https://learn.microsoft.com/rest/api/storageservices/put-page

method uploadPagesFromURL

uploadPagesFromURL: (
    sourceURL: string,
    sourceOffset: number,
    destOffset: number,
    count: number,
    options?: PageBlobUploadPagesFromURLOptions
) => Promise<PageBlobUploadPagesFromURLResponse>;

The Upload Pages operation writes a range of pages to a page blob where the contents are read from a URL.
Parameter sourceURL
Specify a URL to the copy source, Shared Access Signature(SAS) maybe needed for authentication
Parameter sourceOffset
The source offset to copy from. Pass 0 to copy from the beginning of source page blob
Parameter destOffset
Offset of destination page blob
Parameter count
Number of bytes to be uploaded from source page blob
Parameter options
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/put-page-from-url

method withSnapshot

withSnapshot: (snapshot: string) => PageBlobClient;

Creates a new PageBlobClient object identical to the source but with the specified snapshot timestamp. Provide "" will remove the snapshot and return a Client to the base blob.
Parameter snapshot
The snapshot timestamp.
Returns
A new PageBlobClient object identical to the source but with the specified snapshot timestamp.

class Pipeline

class Pipeline implements PipelineLike {}

A Pipeline class containing HTTP request policies. You can create a default Pipeline by calling newPipeline. Or you can create a Pipeline with your own policies by the constructor of Pipeline.
Refer to newPipeline and provided policies before implementing your customized Pipeline.

constructor

constructor(factories: RequestPolicyFactory[], options?: PipelineOptions);

Creates an instance of Pipeline. Customize HTTPClient by implementing IHttpClient interface.
Parameter factories
Parameter options

property factories

readonly factories: RequestPolicyFactory[];

A list of chained request policy factories.

property options

readonly options: PipelineOptions;

Configures pipeline logger and HTTP client.

method toServiceClientOptions

toServiceClientOptions: () => ServiceClientOptions;

Transfer Pipeline object to ServiceClientOptions object which is required by ServiceClient constructor.
Returns
The ServiceClientOptions object from this Pipeline.

class SASQueryParameters

class SASQueryParameters {}

Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly by the user; it is only generated by the AccountSASSignatureValues and BlobSASSignatureValues types. Once generated, it can be encoded into a String and appended to a URL directly (though caution should be taken here in case there are existing query parameters, which might affect the appropriate means of appending these query parameters).
NOTE: Instances of this class are immutable.

constructor

constructor(
    version: string,
    signature: string,
    permissions?: string,
    services?: string,
    resourceTypes?: string,
    protocol?: SASProtocol,
    startsOn?: Date,
    expiresOn?: Date,
    ipRange?: SasIPRange,
    identifier?: string,
    resource?: string,
    cacheControl?: string,
    contentDisposition?: string,
    contentEncoding?: string,
    contentLanguage?: string,
    contentType?: string,
    userDelegationKey?: UserDelegationKey,
    preauthorizedAgentObjectId?: string,
    correlationId?: string,
    encryptionScope?: string
);

Creates an instance of SASQueryParameters.
Parameter version
Representing the storage version
Parameter signature
Representing the signature for the SAS token
Parameter permissions
Representing the storage permissions
Parameter services
Representing the storage services being accessed (only for Account SAS)
Parameter resourceTypes
Representing the storage resource types being accessed (only for Account SAS)
Parameter protocol
Representing the allowed HTTP protocol(s)
Parameter startsOn
Representing the start time for this SAS token
Parameter expiresOn
Representing the expiry time for this SAS token
Parameter ipRange
Representing the range of valid IP addresses for this SAS token
Parameter identifier
Representing the signed identifier (only for Service SAS)
Parameter resource
Representing the storage container or blob (only for Service SAS)
Parameter cacheControl
Representing the cache-control header (only for Blob/File Service SAS)
Parameter contentDisposition
Representing the content-disposition header (only for Blob/File Service SAS)
Parameter contentEncoding
Representing the content-encoding header (only for Blob/File Service SAS)
Parameter contentLanguage
Representing the content-language header (only for Blob/File Service SAS)
Parameter contentType
Representing the content-type header (only for Blob/File Service SAS)
Parameter userDelegationKey
Representing the user delegation key properties
Parameter preauthorizedAgentObjectId
Representing the authorized AAD Object ID (only for User Delegation SAS)
Parameter correlationId
Representing the correlation ID (only for User Delegation SAS)
Parameter encryptionScope

constructor

constructor(
    version: string,
    signature: string,
    options?: SASQueryParametersOptions
);

Creates an instance of SASQueryParameters.
Parameter version
Representing the storage version
Parameter signature
Representing the signature for the SAS token
Parameter options
Optional. Options to construct the SASQueryParameters.

property cacheControl

readonly cacheControl?: string;

Value for cache-control header in Blob/File Service SAS.

property contentDisposition

readonly contentDisposition?: string;

Value for content-disposition header in Blob/File Service SAS.

property contentEncoding

readonly contentEncoding?: string;

Value for content-encoding header in Blob/File Service SAS.

property contentLanguage

readonly contentLanguage?: string;

Value for content-length header in Blob/File Service SAS.

property contentType

readonly contentType?: string;

Value for content-type header in Blob/File Service SAS.

property correlationId

readonly correlationId?: string;

A GUID value that will be logged in the storage diagnostic logs and can be used to correlate SAS generation with storage resource access. This is only used for User Delegation SAS.

property encryptionScope

readonly encryptionScope?: string;

Optional. Encryption scope to use when sending requests authorized with this SAS URI.

property expiresOn

readonly expiresOn?: Date;

Optional only when identifier is provided. The expiry time for this SAS token.

property identifier

readonly identifier?: string;

Optional. The signed identifier (only for BlobSASSignatureValues).
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy

property ipRange

readonly ipRange: SasIPRange;

Optional. IP range allowed for this SAS.
Modifiers
- @readonly

property permissions

readonly permissions?: string;

Optional only when identifier is provided. Please refer to AccountSASPermissions, BlobSASPermissions, or ContainerSASPermissions for more details.

property preauthorizedAgentObjectId

readonly preauthorizedAgentObjectId?: string;

Authorized AAD Object ID in GUID format. The AAD Object ID of a user authorized by the owner of the User Delegation Key to perform the action granted by the SAS. The Azure Storage service will ensure that the owner of the user delegation key has the required permissions before granting access but no additional permission check for the user specified in this value will be performed. This is only used for User Delegation SAS.

property protocol

readonly protocol?: SASProtocol;

Optional. The allowed HTTP protocol(s).

property resource

readonly resource?: string;

Optional. Specifies which resources are accessible via the SAS (only for BlobSASSignatureValues).
See Also
- https://learn.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only

property resourceTypes

readonly resourceTypes?: string;

Optional. The storage resource types being accessed (only for Account SAS). Please refer to AccountSASResourceTypes for more details.

property services

readonly services?: string;

Optional. The storage services being accessed (only for Account SAS). Please refer to AccountSASServices for more details.

property signature

readonly signature: string;

The signature for the SAS token.

property startsOn

readonly startsOn?: Date;

Optional. The start time for this SAS token.

property version

readonly version: string;

The storage API version.

method toString

toString: () => string;

Encodes all SAS query parameters into a string that can be appended to a URL.

class StorageBrowserPolicy

class StorageBrowserPolicy extends BaseRequestPolicy {}

StorageBrowserPolicy will handle differences between Node.js and browser runtime, including:
1. Browsers cache GET/HEAD requests by adding conditional headers such as 'IF_MODIFIED_SINCE'. StorageBrowserPolicy is a policy used to add a timestamp query to GET/HEAD request URL thus avoid the browser cache.
2. Remove cookie header for security
3. Remove content-length header to avoid browsers warning

constructor

constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);

Creates an instance of StorageBrowserPolicy.
Parameter nextPolicy
Parameter options

method sendRequest

sendRequest: (request: WebResource) => Promise<HttpOperationResponse>;

Sends out request.
Parameter request

class StorageBrowserPolicyFactory

class StorageBrowserPolicyFactory implements RequestPolicyFactory {}

StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.

method create

create: (
    nextPolicy: RequestPolicy,
    options: RequestPolicyOptions
) => StorageBrowserPolicy;

Creates a StorageBrowserPolicyFactory object.
Parameter nextPolicy
Parameter options

class StorageRetryPolicy

class StorageRetryPolicy extends BaseRequestPolicy {}

Retry policy with exponential retry and linear retry implemented.

constructor

constructor(
    nextPolicy: RequestPolicy,
    options: RequestPolicyOptions,
    retryOptions?: StorageRetryOptions
);

Creates an instance of RetryPolicy.
Parameter nextPolicy
Parameter options
Parameter retryOptions

method attemptSendRequest

protected attemptSendRequest: (
    request: WebResource,
    secondaryHas404: boolean,
    attempt: number
) => Promise<HttpOperationResponse>;

Decide and perform next retry. Won't mutate request parameter.
Parameter request
Parameter secondaryHas404
If attempt was against the secondary & it returned a StatusNotFound (404), then the resource was not found. This may be due to replication delay. So, in this case, we'll never try the secondary again for this operation.
Parameter attempt
How many retries has been attempted to performed, starting from 1, which includes the attempt will be performed by this method call.

method sendRequest

sendRequest: (request: WebResource) => Promise<HttpOperationResponse>;

Sends request.
Parameter request

method shouldRetry

protected shouldRetry: (
    isPrimaryRetry: boolean,
    attempt: number,
    response?: HttpOperationResponse,
    err?: RestError
) => boolean;

Decide whether to retry according to last HTTP response and retry counters.
Parameter isPrimaryRetry
Parameter attempt
Parameter response
Parameter err

class StorageRetryPolicyFactory

class StorageRetryPolicyFactory implements RequestPolicyFactory {}

StorageRetryPolicyFactory is a factory class helping generating StorageRetryPolicy objects.

constructor

constructor(retryOptions?: StorageRetryOptions);

Creates an instance of StorageRetryPolicyFactory.
Parameter retryOptions

method create

create: (
    nextPolicy: RequestPolicy,
    options: RequestPolicyOptions
) => StorageRetryPolicy;

Creates a StorageRetryPolicy object.
Parameter nextPolicy
Parameter options

class StorageSharedKeyCredential

class StorageSharedKeyCredential extends Credential_2 {}

ONLY AVAILABLE IN NODE.JS RUNTIME.
StorageSharedKeyCredential for account key authorization of Azure Storage service.

constructor

constructor(accountName: string, accountKey: string);

Creates an instance of StorageSharedKeyCredential.
Parameter accountName
Parameter accountKey

property accountName

readonly accountName: string;

Azure Storage account name; readonly.

method computeHMACSHA256

computeHMACSHA256: (stringToSign: string) => string;

Generates a hash signature for an HTTP request or for a SAS.
Parameter stringToSign

method create

create: (
    nextPolicy: RequestPolicy,
    options: RequestPolicyOptions
) => StorageSharedKeyCredentialPolicy;

Creates a StorageSharedKeyCredentialPolicy object.
Parameter nextPolicy
Parameter options

class StorageSharedKeyCredentialPolicy

class StorageSharedKeyCredentialPolicy extends CredentialPolicy {}

StorageSharedKeyCredentialPolicy is a policy used to sign HTTP request with a shared key.

constructor

constructor(
    nextPolicy: RequestPolicy,
    options: RequestPolicyOptions,
    factory: StorageSharedKeyCredential
);

Creates an instance of StorageSharedKeyCredentialPolicy.
Parameter nextPolicy
Parameter options
Parameter factory

method signRequest

protected signRequest: (request: WebResource) => WebResource;

Signs request.
Parameter request

Interfaces

interface AccessPolicy

interface AccessPolicy {}

An Access policy

property expiresOn

expiresOn?: string;

the date-time the policy expires

property permissions

permissions?: string;

the permissions for the acl policy

property startsOn

startsOn?: string;

the date-time the policy is active

interface AccountSASPermissionsLike

interface AccountSASPermissionsLike {}

A type that looks like an account SAS permission. Used in AccountSASPermissions to parse SAS permissions from raw objects.

property add

add?: boolean;

Permission to add messages, table entities, and append to blobs granted.

property create

create?: boolean;

Permission to create blobs and files granted.

property delete

delete?: boolean;

Permission to delete blobs and files granted.

property deleteVersion

deleteVersion?: boolean;

Permission to delete versions granted.

property filter

filter?: boolean;

Permission to filter blobs.

property list

list?: boolean;

Permission to list blob containers, blobs, shares, directories, and files granted.

property permanentDelete

permanentDelete?: boolean;

Specifies that Permanent Delete is permitted.

property process

process?: boolean;

Permission to get and delete messages granted.

property read

read?: boolean;

Permission to read resources and list queues and tables granted.

property setImmutabilityPolicy

setImmutabilityPolicy?: boolean;

Permission to set immutability policy.

property tag

tag?: boolean;

Specfies Tag access granted.

property update

update?: boolean;

Permissions to update messages and table entities granted.

property write

write?: boolean;

Permission to write resources granted.

interface AccountSASSignatureValues

interface AccountSASSignatureValues {}

ONLY AVAILABLE IN NODE.JS RUNTIME.
AccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account. Once all the values here are set appropriately, call generateAccountSASQueryParameters to obtain a representation of the SAS which can actually be applied to blob urls. Note: that both this class and SASQueryParameters exist because the former is mutable and a logical representation while the latter is immutable and used to generate actual REST requests.
See Also
- https://learn.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 for more conceptual information on SAS
- https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas for descriptions of the parameters, including which are required

property encryptionScope

encryptionScope?: string;

Optional. Encryption scope to use when sending requests authorized with this SAS URI.

property expiresOn

expiresOn: Date;

The time after which the SAS will no longer work.

property ipRange

ipRange?: SasIPRange;

Optional. IP range allowed.

property permissions

permissions: AccountSASPermissions;

Specifies which operations the SAS user may perform. Please refer to AccountSASPermissions for help constructing the permissions string.

property protocol

protocol?: SASProtocol;

Optional. SAS protocols allowed.

property resourceTypes

resourceTypes: string;

The values that indicate the resource types accessible with this SAS. Please refer to AccountSASResourceTypes to construct this value.

property services

services: string;

The values that indicate the services accessible with this SAS. Please refer to AccountSASServices to construct this value.

property startsOn

startsOn?: Date;

Optional. When the SAS will take effect.

property version

version?: string;

If not provided, this defaults to the service version targeted by this version of the library.

interface AppendBlobAppendBlockFromUrlHeaders

interface AppendBlobAppendBlockFromUrlHeaders {}

Defines headers for AppendBlob_appendBlockFromUrl operation.

property blobAppendOffset

blobAppendOffset?: string;

This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes.

property blobCommittedBlockCount

blobCommittedBlockCount?: number;

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

property 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.

property date

date?: Date;

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

property encryptionKeySha256

encryptionKeySha256?: string;

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property isServerEncrypted

isServerEncrypted?: boolean;

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

property xMsContentCrc64

xMsContentCrc64?: Uint8Array;

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

interface AppendBlobAppendBlockFromURLOptions

interface AppendBlobAppendBlockFromURLOptions extends CommonOptions {}

Options to configure the AppendBlobClient.appendBlockFromURL operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: AppendBlobRequestConditions;

Conditions to meet when appending append blob blocks.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property sourceAuthorization

sourceAuthorization?: HttpAuthorization;

Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source.

property sourceConditions

sourceConditions?: MatchConditions & ModificationConditions;

Conditions to meet for the source Azure Blob/File when copying from a URL to the blob.

property sourceContentCrc64

sourceContentCrc64?: Uint8Array;

A CRC64 hash of the append block content from the URI. This hash is used to verify the integrity of the append block during transport of the data from the URI. When this is specified, the storage service compares the hash of the content that has arrived from the copy-source with this value.
sourceContentMD5 and sourceContentCrc64 cannot be set at same time.

property sourceContentMD5

sourceContentMD5?: Uint8Array;

An MD5 hash of the append block content from the URI. This hash is used to verify the integrity of the append block during transport of the data from the URI. When this is specified, the storage service compares the hash of the content that has arrived from the copy-source with this value.
sourceContentMD5 and sourceContentCrc64 cannot be set at same time.

interface AppendBlobAppendBlockHeaders

interface AppendBlobAppendBlockHeaders {}

Defines headers for AppendBlob_appendBlock operation.

property blobAppendOffset

blobAppendOffset?: string;

This response header is returned only for append operations. It returns the offset at which the block was committed, in bytes.

property blobCommittedBlockCount

blobCommittedBlockCount?: number;

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

property clientRequestId

clientRequestId?: string;

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

property 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.

property date

date?: Date;

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

property encryptionKeySha256

encryptionKeySha256?: string;

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property isServerEncrypted

isServerEncrypted?: boolean;

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

property xMsContentCrc64

xMsContentCrc64?: Uint8Array;

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

interface AppendBlobAppendBlockOptions

interface AppendBlobAppendBlockOptions extends CommonOptions {}

Options to configure the AppendBlobClient.appendBlock operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: AppendBlobRequestConditions;

Conditions to meet when appending append blob blocks.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property onProgress

onProgress?: (progress: TransferProgressEvent) => void;

Callback to receive events on the progress of append block operation.

property transactionalContentCrc64

transactionalContentCrc64?: Uint8Array;

A CRC64 hash of the append block content. This hash is used to verify the integrity of the append block during transport. When this is specified, the storage service compares the hash of the content that has arrived with this value.
transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time.

property transactionalContentMD5

transactionalContentMD5?: Uint8Array;

An MD5 hash of the block content. This hash is used to verify the integrity of the block during transport. When this is specified, the storage service compares the hash of the content that has arrived with this value.
transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time.

interface AppendBlobCreateHeaders

interface AppendBlobCreateHeaders {}

Defines headers for AppendBlob_create operation.

property clientRequestId

clientRequestId?: string;

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

property 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.

property date

date?: Date;

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

property encryptionKeySha256

encryptionKeySha256?: string;

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property isServerEncrypted

isServerEncrypted?: boolean;

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

property versionId

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

interface AppendBlobCreateIfNotExistsOptions

interface AppendBlobCreateIfNotExistsOptions extends CommonOptions {}

Options to configure AppendBlobClient.createIfNotExists operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property blobHTTPHeaders

blobHTTPHeaders?: BlobHTTPHeaders;

HTTP headers to set when creating append blobs. A common header to set is blobContentType, enabling the browser to provide functionality based on file type.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property immutabilityPolicy

immutabilityPolicy?: BlobImmutabilityPolicy;

Optional. Specifies immutability policy for a blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property legalHold

legalHold?: boolean;

Optional. Indicates if a legal hold should be placed on the blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property metadata

metadata?: Metadata;

A collection of key-value string pair to associate with the blob when creating append blobs.

interface AppendBlobCreateIfNotExistsResponse

interface AppendBlobCreateIfNotExistsResponse extends AppendBlobCreateResponse {}

Contains response data for the appendBlobClient.createIfNotExists operation.

property succeeded

succeeded: boolean;

Indicate whether the blob is successfully created. Is false when the blob is not changed as it already exists.

interface AppendBlobCreateOptions

interface AppendBlobCreateOptions extends CommonOptions {}

Options to configure AppendBlobClient.create operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property blobHTTPHeaders

blobHTTPHeaders?: BlobHTTPHeaders;

HTTP headers to set when creating append blobs. A common header to set is blobContentType, enabling the browser to provide functionality based on file type.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when creating append blobs.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property immutabilityPolicy

immutabilityPolicy?: BlobImmutabilityPolicy;

Optional. Specifies immutability policy for a blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property legalHold

legalHold?: boolean;

Optional. Indicates if a legal hold should be placed on the blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property metadata

metadata?: Metadata;

A collection of key-value string pair to associate with the blob when creating append blobs.

property tags

tags?: Tags;

Blob tags.

interface AppendBlobRequestConditions

interface AppendBlobRequestConditions
    extends BlobRequestConditions,
        AppendPositionAccessConditions {}

Conditions to add to the creation of this append blob.

interface AppendBlobSealOptions

interface AppendBlobSealOptions extends CommonOptions {}

Options to configure AppendBlobClient.seal operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: AppendBlobRequestConditions;

Conditions to meet.

interface AppendPositionAccessConditions

interface AppendPositionAccessConditions {}

Parameter group

property appendPosition

appendPosition?: number;

Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed).

property maxSize

maxSize?: number;

Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).

interface BatchSubRequest

interface BatchSubRequest {}

A request associated with a batch operation.

property credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential;

The credential used for sub request. 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.

property url

url: string;

The URL of the resource to request operation.

interface BatchSubResponse

interface BatchSubResponse {}

The response data associated with a single request within a batch operation.

property bodyAsText

bodyAsText?: string;

The body as text.

property errorCode

errorCode?: string;

The error code of the sub operation, if the sub operation failed.

property headers

headers: HttpHeaders;

The HTTP response headers.

property status

status: number;

The status code of the sub operation.

property statusMessage

statusMessage: string;

The status message of the sub operation.

interface BlobAbortCopyFromURLHeaders

interface BlobAbortCopyFromURLHeaders {}

Defines headers for Blob_abortCopyFromURL operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface BlobAbortCopyFromURLOptions

interface BlobAbortCopyFromURLOptions extends CommonOptions {}

Options to configure the BlobClient.abortCopyFromURL operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: LeaseAccessConditions;

If specified, contains the lease id that must be matched and lease with this id must be active in order for the operation to succeed.

interface BlobAcquireLeaseOptions

interface BlobAcquireLeaseOptions extends CommonOptions {}

Options to configure Blob - Acquire Lease operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ModifiedAccessConditions;

Conditions to meet when acquiring the lease of a blob.

interface BlobBatchSubmitBatchOptionalParams

interface BlobBatchSubmitBatchOptionalParams
    extends ServiceSubmitBatchOptionalParamsModel {}

Options to configure the Service - Submit Batch Optional Params.

interface BlobBeginCopyFromURLOptions

interface BlobBeginCopyFromURLOptions extends BlobStartCopyFromURLOptions {}

Options to configure the BlobClient.beginCopyFromURL operation.

property intervalInMs

intervalInMs?: number;

The amount of time in milliseconds the poller should wait between calls to the service to determine the status of the Blob copy. Defaults to 15 seconds.

property onProgress

onProgress?: (state: BlobBeginCopyFromUrlPollState) => void;

Callback to receive the state of the copy progress.

property resumeFrom

resumeFrom?: string;

Serialized poller state that can be used to resume polling from. This may be useful when starting a copy on one process or thread and you wish to continue polling on another process or thread.
To get serialized poller state, call poller.toString() on an existing poller.

interface BlobBeginCopyFromUrlPollState

interface BlobBeginCopyFromUrlPollState
    extends PollOperationState<BlobBeginCopyFromURLResponse> {}

The state used by the poller returned from BlobClient.beginCopyFromURL.
This state is passed into the user-specified onProgress callback whenever copy progress is detected.

property blobClient

readonly blobClient: CopyPollerBlobClient;

The instance of BlobClient that was used when calling BlobClient.beginCopyFromURL.

property copyId

copyId?: string;

The copyId that identifies the in-progress blob copy.

property copyProgress

copyProgress?: string;

the progress of the blob copy as reported by the service.

property copySource

copySource: string;

The source URL provided in BlobClient.beginCopyFromURL.

property startCopyFromURLOptions

readonly startCopyFromURLOptions?: BlobStartCopyFromURLOptions;

The options that were passed to the initial BlobClient.beginCopyFromURL call. This is exposed for the poller and should not be modified directly.

interface BlobBeginCopyFromURLResponse

interface BlobBeginCopyFromURLResponse extends BlobStartCopyFromURLResponse {}

Contains response data for the BlobClient.beginCopyFromURL operation.

interface BlobBreakLeaseOptions

interface BlobBreakLeaseOptions extends CommonOptions {}

Options to configure Blob - Break Lease operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ModifiedAccessConditions;

Conditions to meet when breaking the lease of a blob.

interface BlobChangeLeaseOptions

interface BlobChangeLeaseOptions extends CommonOptions {}

Options to configure Blob - Change Lease operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ModifiedAccessConditions;

Conditions to meet when changing the lease of a blob.

interface BlobCopyFromURLHeaders

interface BlobCopyFromURLHeaders {}

Defines headers for Blob_copyFromURL operation.

property clientRequestId

clientRequestId?: string;

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

property contentMD5

contentMD5?: Uint8Array;

This response header is returned so that the client can check for the integrity of the copied content. This header is only returned if the source content MD5 was specified.

property copyId

copyId?: string;

String identifier for this copy operation.

property copyStatus

copyStatus?: SyncCopyStatusType;

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

property date

date?: Date;

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

property versionId

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

property xMsContentCrc64

xMsContentCrc64?: Uint8Array;

This response header is returned so that the client can check for the integrity of the copied content.

interface BlobCreateSnapshotHeaders

interface BlobCreateSnapshotHeaders {}

Defines headers for Blob_createSnapshot operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property isServerEncrypted

isServerEncrypted?: boolean;

True if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. For a snapshot request, this header is set to true when metadata was provided in the request and encrypted with a customer-provided key.

property 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.

property requestId

requestId?: string;

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

property snapshot

snapshot?: string;

Uniquely identifies the snapshot and indicates the snapshot version. It may be used in subsequent requests to access the snapshot

property version

version?: string;

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

property versionId

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

interface BlobCreateSnapshotOptions

interface BlobCreateSnapshotOptions extends CommonOptions {}

Options to configure the BlobClient.createSnapshot operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when creating blob snapshots.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property metadata

metadata?: Metadata;

A collection of key-value string pair to associate with the snapshot.

interface BlobDeleteHeaders

interface BlobDeleteHeaders {}

Defines headers for Blob_delete operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface BlobDeleteIfExistsResponse

interface BlobDeleteIfExistsResponse extends BlobDeleteResponse {}

Contains response data for the BlobClient.deleteIfExists operation.

property succeeded

succeeded: boolean;

Indicate whether the blob is successfully deleted. Is false if the blob does not exist in the first place.

interface BlobDeleteImmutabilityPolicyHeaders

interface BlobDeleteImmutabilityPolicyHeaders {}

Defines headers for Blob_deleteImmutabilityPolicy operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property requestId

requestId?: string;

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

property version

version?: string;

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

interface BlobDeleteImmutabilityPolicyOptions

interface BlobDeleteImmutabilityPolicyOptions extends CommonOptions {}

Options for deleting immutability policy BlobClient.deleteImmutabilityPolicy operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

interface BlobDeleteOptions

interface BlobDeleteOptions extends CommonOptions {}

Options to configure the BlobClient.delete operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when deleting blobs.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property deleteSnapshots

deleteSnapshots?: DeleteSnapshotsOptionType;

Specifies options to delete blobs that have associated snapshots. - include: Delete the base blob and all of its snapshots. - only: Delete only the blob's snapshots and not the blob itself.

interface BlobDownloadHeaders

interface BlobDownloadHeaders {}

Defines headers for Blob_download operation.

property acceptRanges

acceptRanges?: string;

Indicates that the service supports requests for partial blob content.

property blobCommittedBlockCount

blobCommittedBlockCount?: number;

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

property blobContentMD5

blobContentMD5?: Uint8Array;

If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range

property blobSequenceNumber

blobSequenceNumber?: number;

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

property blobType

blobType?: BlobType;

The blob's type.

property cacheControl

cacheControl?: string;

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

property clientRequestId

clientRequestId?: string;

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

property contentCrc64

contentCrc64?: Uint8Array;

If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request).

property contentDisposition

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

property contentEncoding

contentEncoding?: string;

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

property contentLanguage

contentLanguage?: string;

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

property contentLength

contentLength?: number;

The number of bytes present in the response body.

property 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.

property contentRange

contentRange?: string;

Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header.

property contentType

contentType?: string;

The media type of the body of the response. For Download Blob this is 'application/octet-stream'

property 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.

property copyId

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

property copyProgress

copyProgress?: 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

property copySource

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

property copyStatus

copyStatus?: CopyStatusType;

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

property copyStatusDescription

copyStatusDescription?: 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

property createdOn

createdOn?: Date;

Returns the date and time the blob was created.

property date

date?: Date;

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

property encryptionKeySha256

encryptionKeySha256?: string;

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property immutabilityPolicyExpiresOn

immutabilityPolicyExpiresOn?: Date;

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

property immutabilityPolicyMode

immutabilityPolicyMode?: BlobImmutabilityPolicyMode;

Indicates immutability policy mode.

property isCurrentVersion

isCurrentVersion?: boolean;

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

property isSealed

isSealed?: boolean;

If this blob has been sealed

property isServerEncrypted

isServerEncrypted?: boolean;

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).

property 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

property 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.

property leaseDuration

leaseDuration?: LeaseDurationType;

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

property leaseState

leaseState?: LeaseStateType;

Lease state of the blob.

property leaseStatus

leaseStatus?: LeaseStatusType;

The current lease status of the blob.

property legalHold

legalHold?: boolean;

Indicates if a legal hold is present on the blob.

property metadata

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

property objectReplicationPolicyId

objectReplicationPolicyId?: string;

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

property objectReplicationRules

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

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

property requestId

requestId?: string;

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

property tagCount

tagCount?: number;

The number of tags associated with the blob

property version

version?: string;

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

property versionId

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

interface BlobDownloadOptionalParams

interface BlobDownloadOptionalParams extends coreClient.OperationOptions {}

Optional parameters.

property cpkInfo

cpkInfo?: CpkInfo;

Parameter group

property leaseAccessConditions

leaseAccessConditions?: LeaseAccessConditions;

Parameter group

property modifiedAccessConditions

modifiedAccessConditions?: ModifiedAccessConditionsModel;

Parameter group

property range

range?: string;

Return only the bytes of the blob in the specified range.

property rangeGetContentCRC64

rangeGetContentCRC64?: boolean;

When set to true and specified together with the Range, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MB in size.

property rangeGetContentMD5

rangeGetContentMD5?: boolean;

When set to true and specified together with the Range, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size.

property requestId

requestId?: string;

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

property snapshot

snapshot?: string;

The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob.

property timeoutInSeconds

timeoutInSeconds?: number;

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

property versionId

versionId?: string;

The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer.

interface BlobDownloadOptions

interface BlobDownloadOptions extends CommonOptions {}

Options to configure the BlobClient.download operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when downloading blobs.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property maxRetryRequests

maxRetryRequests?: number;

Optional. ONLY AVAILABLE IN NODE.JS.
How many retries will perform when original body download stream unexpected ends. Above kind of ends will not trigger retry policy defined in a pipeline, because they doesn't emit network errors.
With this option, every additional retry means an additional FileClient.download() request will be made from the broken point, until the requested range has been successfully downloaded or maxRetryRequests is reached.
Default value is 5, please set a larger value when loading large files in poor network.

property onProgress

onProgress?: (progress: TransferProgressEvent) => void;

Call back to receive events on the progress of download operation.

property rangeGetContentCrc64

rangeGetContentCrc64?: boolean;

When this is set to true and download range of blob, the service returns the CRC64 hash for the range, as long as the range is less than or equal to 4 MB in size.
rangeGetContentCrc64 and rangeGetContentMD5 cannot be set at same time.

property rangeGetContentMD5

rangeGetContentMD5?: boolean;

When this is set to true and download range of blob, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size.
rangeGetContentCrc64 and rangeGetContentMD5 cannot be set at same time.

property snapshot

snapshot?: string;

An opaque DateTime string value that, when present, specifies the blob snapshot to retrieve.

interface BlobDownloadResponseParsed

interface BlobDownloadResponseParsed extends BlobDownloadResponseModel {}

Contains response data for the BlobClient.download operation.

property objectReplicationDestinationPolicyId

objectReplicationDestinationPolicyId?: string;

Object Replication Policy Id of the destination blob.

property objectReplicationSourceProperties

objectReplicationSourceProperties?: ObjectReplicationPolicy[];

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

interface BlobDownloadToBufferOptions

interface BlobDownloadToBufferOptions extends CommonOptions {}

Option interface for the BlobClient.downloadToBuffer operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property blockSize

blockSize?: number;

blockSize is the data every request trying to download. Must be greater than or equal to 0. If set to 0 or undefined, blockSize will automatically calculated according to the blob size.

property concurrency

concurrency?: number;

Concurrency of parallel download.

property conditions

conditions?: BlobRequestConditions;

Access conditions headers.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property maxRetryRequestsPerBlock

maxRetryRequestsPerBlock?: number;

Optional. ONLY AVAILABLE IN NODE.JS.
How many retries will perform when original block download stream unexpected ends. Above kind of ends will not trigger retry policy defined in a pipeline, because they doesn't emit network errors.
With this option, every additional retry means an additional FileClient.download() request will be made from the broken point, until the requested block has been successfully downloaded or maxRetryRequestsPerBlock is reached.
Default value is 5, please set a larger value when in poor network.

property onProgress

onProgress?: (progress: TransferProgressEvent) => void;

Progress updater.

interface BlobExistsOptions

interface BlobExistsOptions extends CommonOptions {}

Options to configure the BlobClient.exists operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

interface BlobFlatListSegment

interface BlobFlatListSegment {}

An interface representing BlobFlatListSegment.

property blobItems

blobItems: BlobItem[];

interface BlobFlatListSegmentModel

interface BlobFlatListSegmentModel {}

property blobItems

blobItems: BlobItemInternal[];

interface BlobGenerateSasUrlOptions

interface BlobGenerateSasUrlOptions extends CommonGenerateSasUrlOptions {}

Options to configure BlobClient.generateSasUrl operation.

property permissions

permissions?: BlobSASPermissions;

Optional only when identifier is provided. Specifies the list of permissions to be associated with the SAS.

interface BlobGetAccountInfoHeaders

interface BlobGetAccountInfoHeaders {}

Defines headers for Blob_getAccountInfo operation.

property accountKind

accountKind?: AccountKind;

Identifies the account kind

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property isHierarchicalNamespaceEnabled

isHierarchicalNamespaceEnabled?: boolean;

Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled.

property requestId

requestId?: string;

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

property skuName

skuName?: SkuName;

Identifies the sku name of the account

property version

version?: string;

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

interface BlobGetAccountInfoOptions

interface BlobGetAccountInfoOptions extends CommonOptions {}

Options to configure the BlobClient.getAccountInfo operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

interface BlobGetPropertiesHeaders

interface BlobGetPropertiesHeaders {}

Defines headers for Blob_getProperties operation.

property acceptRanges

acceptRanges?: string;

Indicates that the service supports requests for partial blob content.

property accessTier

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

property 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.

property accessTierInferred

accessTierInferred?: boolean;

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.

property archiveStatus

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

property blobCommittedBlockCount

blobCommittedBlockCount?: number;

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

property blobSequenceNumber

blobSequenceNumber?: number;

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

property blobType

blobType?: BlobType;

The blob's type.

property cacheControl

cacheControl?: string;

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

property clientRequestId

clientRequestId?: string;

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

property contentDisposition

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

property contentEncoding

contentEncoding?: string;

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

property contentLanguage

contentLanguage?: string;

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

property contentLength

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

property 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.

property contentType

contentType?: string;

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

property 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.

property copyId

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

property copyProgress

copyProgress?: 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

property copySource

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

property copyStatus

copyStatus?: CopyStatusType;

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

property copyStatusDescription

copyStatusDescription?: 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

property createdOn

createdOn?: Date;

Returns the date and time the blob was created.

property date

date?: Date;

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

property destinationSnapshot

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

property encryptionKeySha256

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property expiresOn

expiresOn?: Date;

The time this blob will expire.

property immutabilityPolicyExpiresOn

immutabilityPolicyExpiresOn?: Date;

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

property immutabilityPolicyMode

immutabilityPolicyMode?: BlobImmutabilityPolicyMode;

Indicates immutability policy mode.

property isCurrentVersion

isCurrentVersion?: boolean;

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

property isIncrementalCopy

isIncrementalCopy?: boolean;

Included if the blob is incremental copy blob.

property isSealed

isSealed?: boolean;

If this blob has been sealed

property isServerEncrypted

isServerEncrypted?: boolean;

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).

property 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

property 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.

property leaseDuration

leaseDuration?: LeaseDurationType;

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

property leaseState

leaseState?: LeaseStateType;

Lease state of the blob.

property leaseStatus

leaseStatus?: LeaseStatusType;

The current lease status of the blob.

property legalHold

legalHold?: boolean;

Indicates if a legal hold is present on the blob.

property metadata

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

property objectReplicationPolicyId

objectReplicationPolicyId?: string;

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

property objectReplicationRules

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

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

property rehydratePriority

rehydratePriority?: RehydratePriority;

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

property requestId

requestId?: string;

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

property tagCount

tagCount?: number;

The number of tags associated with the blob

property version

version?: string;

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

property versionId

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

interface BlobGetPropertiesOptions

interface BlobGetPropertiesOptions extends CommonOptions {}

Options to configure the BlobClient.getProperties operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when getting blob properties.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

interface BlobGetPropertiesResponse

interface BlobGetPropertiesResponse extends BlobGetPropertiesResponseModel {}

Contains response data for the BlobClient.getProperties operation.

property objectReplicationDestinationPolicyId

objectReplicationDestinationPolicyId?: string;

Object Replication Policy Id of the destination blob.

property objectReplicationSourceProperties

objectReplicationSourceProperties?: ObjectReplicationPolicy[];

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

interface BlobGetTagsHeaders

interface BlobGetTagsHeaders {}

Defines headers for Blob_getTags operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface BlobGetTagsOptions

interface BlobGetTagsOptions extends CommonOptions {}

Options to configure the BlobClient.getTags operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: TagConditions & LeaseAccessConditions;

Conditions to meet for the blob to perform this operation.

interface BlobHierarchyListSegment

interface BlobHierarchyListSegment {}

An interface representing BlobHierarchyListSegment.

property blobItems

blobItems: BlobItem[];

property blobPrefixes

blobPrefixes?: BlobPrefix[];

interface BlobHierarchyListSegmentModel

interface BlobHierarchyListSegmentModel {}

property blobItems

blobItems: BlobItemInternal[];

property blobPrefixes

blobPrefixes?: BlobPrefix[];

interface BlobHTTPHeaders

interface BlobHTTPHeaders {}

Parameter group

property blobCacheControl

blobCacheControl?: string;

Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request.

property blobContentDisposition

blobContentDisposition?: string;

Optional. Sets the blob's Content-Disposition header.

property blobContentEncoding

blobContentEncoding?: string;

Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request.

property blobContentLanguage

blobContentLanguage?: string;

Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request.

property blobContentMD5

blobContentMD5?: Uint8Array;

Optional. An MD5 hash of the blob content. Note that this hash is not validated, as the hashes for the individual blocks were validated when each was uploaded.

property blobContentType

blobContentType?: string;

Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request.

interface BlobImmutabilityPolicy

interface BlobImmutabilityPolicy {}

Describe immutable policy for blob.

property expiriesOn

expiriesOn?: Date;

Specifies the date time when the blobs immutability policy is set to expire.

property policyMode

policyMode?: BlobImmutabilityPolicyMode;

Specifies the immutability policy mode to set on the blob.

interface BlobItem

interface BlobItem {}

An Azure Storage blob

property deleted

deleted: boolean;

property hasVersionsOnly

hasVersionsOnly?: boolean;

property isCurrentVersion

isCurrentVersion?: boolean;

property metadata

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

property name

name: string;

property objectReplicationSourceProperties

objectReplicationSourceProperties?: ObjectReplicationPolicy[];

property properties

properties: BlobProperties;

property snapshot

snapshot: string;

property tags

tags?: Tags;

property versionId

versionId?: string;

interface BlobItemInternal

interface BlobItemInternal {}

An Azure Storage blob

property blobTags

blobTags?: BlobTags;

Blob tags

property deleted

deleted: boolean;

property hasVersionsOnly

hasVersionsOnly?: boolean;

Inactive root blobs which have any versions would have such tag with value true.

property isCurrentVersion

isCurrentVersion?: boolean;

property metadata

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

Dictionary of

property name

name: string;

property objectReplicationMetadata

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

Dictionary of

property properties

properties: BlobProperties;

Properties of a blob

property snapshot

snapshot: string;

property versionId

versionId?: string;

interface BlobPrefix

interface BlobPrefix {}

property name

name: string;

interface BlobProperties

interface BlobProperties {}

Properties of a blob

property accessTier

accessTier?: AccessTier;

property accessTierChangedOn

accessTierChangedOn?: Date;

property accessTierInferred

accessTierInferred?: boolean;

property archiveStatus

archiveStatus?: ArchiveStatus;

property blobSequenceNumber

blobSequenceNumber?: number;

property blobType

blobType?: BlobType;

property cacheControl

cacheControl?: string;

property contentDisposition

contentDisposition?: string;

property contentEncoding

contentEncoding?: string;

property contentLanguage

contentLanguage?: string;

property contentLength

contentLength?: number;

Size in bytes

property contentMD5

contentMD5?: Uint8Array;

property contentType

contentType?: string;

property copyCompletedOn

copyCompletedOn?: Date;

property copyId

copyId?: string;

property copyProgress

copyProgress?: string;

property copySource

copySource?: string;

property copyStatus

copyStatus?: CopyStatusType;

property copyStatusDescription

copyStatusDescription?: string;

property createdOn

createdOn?: Date;

property customerProvidedKeySha256

customerProvidedKeySha256?: string;

property deletedOn

deletedOn?: Date;

property destinationSnapshot

destinationSnapshot?: string;

property encryptionScope

encryptionScope?: string;

The name of the encryption scope under which the blob is encrypted.

property etag

etag: string;

property expiresOn

expiresOn?: Date;

property immutabilityPolicyExpiresOn

immutabilityPolicyExpiresOn?: Date;

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

property immutabilityPolicyMode

immutabilityPolicyMode?: BlobImmutabilityPolicyMode;

Indicates immutability policy mode.

property incrementalCopy

incrementalCopy?: boolean;

property isSealed

isSealed?: boolean;

property lastAccessedOn

lastAccessedOn?: Date;

property lastModified

lastModified: Date;

property leaseDuration

leaseDuration?: LeaseDurationType;

property leaseState

leaseState?: LeaseStateType;

property leaseStatus

leaseStatus?: LeaseStatusType;

property legalHold

legalHold?: boolean;

Indicates if a legal hold is present on the blob.

property rehydratePriority

rehydratePriority?: RehydratePriority;

If an object is in rehydrate pending state then this header is returned with priority of rehydrate. Valid values are High and Standard.

property remainingRetentionDays

remainingRetentionDays?: number;

property serverEncrypted

serverEncrypted?: boolean;

property tagCount

tagCount?: number;

interface BlobQueryArrowConfiguration

interface BlobQueryArrowConfiguration {}

Options to query blob with Apache Arrow format. Only valid for BlockBlobQueryOptions.outputTextConfiguration.

property kind

kind: 'arrow';

Kind.

property schema

schema: BlobQueryArrowField[];

List of BlobQueryArrowField describing the schema of the data.

interface BlobQueryArrowField

interface BlobQueryArrowField {}

Describe a field in BlobQueryArrowConfiguration.

property name

name?: string;

The name of the field.

property precision

precision?: number;

The precision of the field. Required if type is "decimal".

property scale

scale?: number;

The scale of the field. Required if type is is "decimal".

property type

type: BlobQueryArrowFieldType;

The type of the field.

interface BlobQueryCsvTextConfiguration

interface BlobQueryCsvTextConfiguration {}

Options to query blob with CSV format.

property columnSeparator

columnSeparator?: string;

Column separator. Default is ",".

property escapeCharacter

escapeCharacter?: string;

Escape character.

property fieldQuote

fieldQuote?: string;

Field quote.

property hasHeaders

hasHeaders?: boolean;

Has headers. Default is false.

property kind

kind: 'csv';

Query for a CSV format blob.

property recordSeparator

recordSeparator: string;

Record separator.

interface BlobQueryError

interface BlobQueryError {}

Blob query error type.

property description

description: string;

Error description.

property isFatal

isFatal: boolean;

Whether error is fatal. Fatal error will stop query.

property name

name: string;

Error name.

property position

position: number;

Position in bytes of the query.

interface BlobQueryHeaders

interface BlobQueryHeaders {}

Defines headers for Blob_query operation.

property acceptRanges

acceptRanges?: string;

Indicates that the service supports requests for partial blob content.

property blobCommittedBlockCount

blobCommittedBlockCount?: number;

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

property blobContentMD5

blobContentMD5?: Uint8Array;

If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range

property blobSequenceNumber

blobSequenceNumber?: number;

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

property blobType

blobType?: BlobType;

The blob's type.

property cacheControl

cacheControl?: string;

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

property clientRequestId

clientRequestId?: string;

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

property contentCrc64

contentCrc64?: Uint8Array;

If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request).

property contentDisposition

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

property contentEncoding

contentEncoding?: string;

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

property contentLanguage

contentLanguage?: string;

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

property contentLength

contentLength?: number;

The number of bytes present in the response body.

property 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.

property contentRange

contentRange?: string;

Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header.

property contentType

contentType?: string;

The media type of the body of the response. For Download Blob this is 'application/octet-stream'

property copyCompletionTime

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

property copyId

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

property copyProgress

copyProgress?: 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

property copySource

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

property copyStatus

copyStatus?: CopyStatusType;

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

property copyStatusDescription

copyStatusDescription?: 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

property date

date?: Date;

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

property encryptionKeySha256

encryptionKeySha256?: string;

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property isServerEncrypted

isServerEncrypted?: boolean;

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).

property 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.

property leaseDuration

leaseDuration?: LeaseDurationType;

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

property leaseState

leaseState?: LeaseStateType;

Lease state of the blob.

property leaseStatus

leaseStatus?: LeaseStatusType;

The current lease status of the blob.

property metadata

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

property requestId

requestId?: string;

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

property version

version?: string;

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

interface BlobQueryJsonTextConfiguration

interface BlobQueryJsonTextConfiguration {}

Options to query blob with JSON format.

property kind

kind: 'json';

Query for a JSON format blob.

property recordSeparator

recordSeparator: string;

Record separator.

interface BlobQueryParquetConfiguration

interface BlobQueryParquetConfiguration {}

Options to query blob with Parquet format. Only valid for BlockBlobQueryOptions.inputTextConfiguration.

property kind

kind: 'parquet';

Kind.

interface BlobReleaseLeaseOptions

interface BlobReleaseLeaseOptions extends CommonOptions {}

Options to configure Blob - Release Lease operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ModifiedAccessConditions;

Conditions to meet when releasing the lease of a blob.

interface BlobRenewLeaseOptions

interface BlobRenewLeaseOptions extends CommonOptions {}

Options to configure Blob - Renew Lease operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ModifiedAccessConditions;

Conditions to meet when renewing the lease of a blob.

interface BlobRequestConditions

interface BlobRequestConditions
    extends ModifiedAccessConditions,
        LeaseAccessConditions {}

standard HTTP conditional headers, tags condition and lease condition

interface BlobSASPermissionsLike

interface BlobSASPermissionsLike {}

A type that looks like a Blob SAS permission. Used in BlobSASPermissions to parse SAS permissions from raw objects.

property add

add?: boolean;

Specifies Add access granted.

property create

create?: boolean;

Specifies Create access granted.

property delete

delete?: boolean;

Specifies Delete access granted.

property deleteVersion

deleteVersion?: boolean;

Specifies Delete version access granted.

property execute

execute?: boolean;

Specifies Execute access granted.

property move

move?: boolean;

Specifies Move access granted.

property permanentDelete

permanentDelete?: boolean;

Specifies that Permanent Delete is permitted.

property read

read?: boolean;

Specifies Read access granted.

property setImmutabilityPolicy

setImmutabilityPolicy?: boolean;

Specifies SetImmutabilityPolicy access granted.

property tag

tag?: boolean;

Specfies Tag access granted.

property write

write?: boolean;

Specifies Write access granted.

interface BlobSASSignatureValues

interface BlobSASSignatureValues {}

ONLY AVAILABLE IN NODE.JS RUNTIME.
BlobSASSignatureValues is used to help generating Blob service SAS tokens for containers or blobs.

property blobName

blobName?: string;

Optional. The blob name of the SAS user may access. Required if snapshotTime or versionId is provided.

property cacheControl

cacheControl?: string;

Optional. The cache-control header for the SAS.

property containerName

containerName: string;

The name of the container the SAS user may access.

property contentDisposition

contentDisposition?: string;

Optional. The content-disposition header for the SAS.

property contentEncoding

contentEncoding?: string;

Optional. The content-encoding header for the SAS.

property contentLanguage

contentLanguage?: string;

Optional. The content-language header for the SAS.

property contentType

contentType?: string;

Optional. The content-type header for the SAS.

property correlationId

correlationId?: string;

Optional. Beginning in version 2020-02-10, this is a GUID value that will be logged in the storage diagnostic logs and can be used to correlate SAS generation with storage resource access. This is only used for User Delegation SAS.

property encryptionScope

encryptionScope?: string;

Optional. Encryption scope to use when sending requests authorized with this SAS URI.

property expiresOn

expiresOn?: Date;

Optional only when identifier is provided. The time after which the SAS will no longer work.

property identifier

identifier?: string;

Optional. The name of the access policy on the container this SAS references if any.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy

property ipRange

ipRange?: SasIPRange;

Optional. IP ranges allowed in this SAS.

property permissions

permissions?: BlobSASPermissions | ContainerSASPermissions;

Optional only when identifier is provided. Please refer to either ContainerSASPermissions or BlobSASPermissions depending on the resource being accessed for help constructing the permissions string.

property preauthorizedAgentObjectId

preauthorizedAgentObjectId?: string;

Optional. Beginning in version 2020-02-10, specifies the Authorized AAD Object ID in GUID format. The AAD Object ID of a user authorized by the owner of the user delegation key to perform the action granted by the SAS. The Azure Storage service will ensure that the owner of the user delegation key has the required permissions before granting access but no additional permission check for the user specified in this value will be performed. This is only used for User Delegation SAS.

property protocol

protocol?: SASProtocol;

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

property snapshotTime

snapshotTime?: string;

Optional. Snapshot timestamp string the SAS user may access. Only supported from API version 2018-11-09.

property startsOn

startsOn?: Date;

Optional. When the SAS will take effect.

property version

version?: string;

The version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

property versionId

versionId?: string;

Optional. VersionId of the blob version the SAS user may access. Only supported from API version 2019-10-10.

interface BlobServiceProperties

interface BlobServiceProperties {}

Storage Service Properties.

property blobAnalyticsLogging

blobAnalyticsLogging?: Logging;

Azure Analytics Logging settings.

property cors

cors?: CorsRule[];

The set of CORS rules.

property defaultServiceVersion

defaultServiceVersion?: string;

The default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions

property deleteRetentionPolicy

deleteRetentionPolicy?: RetentionPolicy;

the retention policy which determines how long the associated data should persist

property hourMetrics

hourMetrics?: Metrics;

a summary of request statistics grouped by API in hour or minute aggregates for blobs

property minuteMetrics

minuteMetrics?: Metrics;

a summary of request statistics grouped by API in hour or minute aggregates for blobs

property staticWebsite

staticWebsite?: StaticWebsite;

The properties that enable an account to host a static website

interface BlobServiceStatistics

interface BlobServiceStatistics {}

Stats for the storage service.

property geoReplication

geoReplication?: GeoReplication;

Geo-Replication information for the Secondary Storage Service

interface BlobSetHTTPHeadersHeaders

interface BlobSetHTTPHeadersHeaders {}

Defines headers for Blob_setHttpHeaders operation.

property blobSequenceNumber

blobSequenceNumber?: number;

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

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

interface BlobSetHTTPHeadersOptions

interface BlobSetHTTPHeadersOptions extends CommonOptions {}

Options to configure the BlobClient.setHTTPHeaders operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when setting blob HTTP headers.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

interface BlobSetImmutabilityPolicyHeaders

interface BlobSetImmutabilityPolicyHeaders {}

Defines headers for Blob_setImmutabilityPolicy operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property immutabilityPolicyExpiry

immutabilityPolicyExpiry?: Date;

Indicates the time the immutability policy will expire.

property immutabilityPolicyMode

immutabilityPolicyMode?: BlobImmutabilityPolicyMode;

Indicates immutability policy mode.

property requestId

requestId?: string;

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

property version

version?: string;

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

interface BlobSetImmutabilityPolicyOptions

interface BlobSetImmutabilityPolicyOptions extends CommonOptions {}

Options for setting immutability policy BlobClient.setImmutabilityPolicy operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property modifiedAccessCondition

modifiedAccessCondition?: ModificationConditions;

interface BlobSetLegalHoldHeaders

interface BlobSetLegalHoldHeaders {}

Defines headers for Blob_setLegalHold operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property legalHold

legalHold?: boolean;

Indicates if the blob has a legal hold.

property requestId

requestId?: string;

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

property version

version?: string;

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

interface BlobSetLegalHoldOptions

interface BlobSetLegalHoldOptions extends CommonOptions {}

Options for setting legal hold BlobClient.setLegalHold operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

interface BlobSetMetadataHeaders

interface BlobSetMetadataHeaders {}

Defines headers for Blob_setMetadata operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property encryptionKeySha256

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property isServerEncrypted

isServerEncrypted?: boolean;

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

property versionId

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

interface BlobSetMetadataOptions

interface BlobSetMetadataOptions extends CommonOptions {}

Options to configure the BlobClient.setMetadata operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when setting blob metadata.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

interface BlobSetTagsHeaders

interface BlobSetTagsHeaders {}

Defines headers for Blob_setTags operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface BlobSetTagsOptions

interface BlobSetTagsOptions extends CommonOptions {}

Options to configure the BlobClient.setTags operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: TagConditions & LeaseAccessConditions;

Conditions to meet for the blob to perform this operation.

interface BlobSetTierHeaders

interface BlobSetTierHeaders {}

Defines headers for Blob_setTier operation.

property clientRequestId

clientRequestId?: string;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface BlobSetTierOptions

interface BlobSetTierOptions extends CommonOptions {}

Options to configure the BlobClient.setAccessTier operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: LeaseAccessConditions & TagConditions;

If specified, contains the lease id that must be matched and lease with this id must be active in order for the operation to succeed.

property rehydratePriority

rehydratePriority?: RehydratePriority;

Rehydrate Priority - possible values include 'High', 'Standard'. More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-rehydration#rehydrate-an-archived-blob-to-an-online-tier

interface BlobStartCopyFromURLHeaders

interface BlobStartCopyFromURLHeaders {}

Defines headers for Blob_startCopyFromURL operation.

property clientRequestId

clientRequestId?: string;

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

property copyId

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

property copyStatus

copyStatus?: CopyStatusType;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

property versionId

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

interface BlobStartCopyFromURLOptions

interface BlobStartCopyFromURLOptions extends CommonOptions {}

Options to configure the BlobClient.beginCopyFromURL operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet for the destination blob when copying from a URL to the blob.

property immutabilityPolicy

immutabilityPolicy?: BlobImmutabilityPolicy;

Optional. Specifies immutability policy for a blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property legalHold

legalHold?: boolean;

Optional. Indicates if a legal hold should be placed on the blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property metadata

metadata?: Metadata;

A collection of key-value string pair to associate with the blob that are being copied.

property rehydratePriority

rehydratePriority?: RehydratePriority;

Rehydrate Priority - possible values include 'High', 'Standard'. More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-rehydration#rehydrate-an-archived-blob-to-an-online-tier

property sealBlob

sealBlob?: boolean;

Overrides the sealed state of the destination blob. Default true.

property sourceConditions

sourceConditions?: ModifiedAccessConditions;

Conditions to meet for the source Azure Blob/File when copying from a URL to the blob.

property tags

tags?: Tags;

Blob tags.

property tier

tier?: BlockBlobTier | PremiumPageBlobTier | string;

Access tier. More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers

interface BlobSyncCopyFromURLOptions

interface BlobSyncCopyFromURLOptions extends CommonOptions {}

Options to configure the BlobClient.syncCopyFromURL operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet for the destination blob when copying from a URL to the blob.

property copySourceTags

copySourceTags?: BlobCopySourceTags;

Optional. Default 'REPLACE'. Indicates if source tags should be copied or replaced with the tags specified by tags.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property immutabilityPolicy

immutabilityPolicy?: BlobImmutabilityPolicy;

Optional. Specifies immutability policy for a blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property legalHold

legalHold?: boolean;

Optional. Indicates if a legal hold should be placed on the blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property metadata

metadata?: Metadata;

A collection of key-value string pair to associate with the snapshot.

property sourceAuthorization

sourceAuthorization?: HttpAuthorization;

Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source.

property sourceConditions

sourceConditions?: MatchConditions & ModificationConditions;

Conditions to meet for the source Azure Blob/File when copying from a URL to the blob.

property sourceContentMD5

sourceContentMD5?: Uint8Array;

Specify the md5 calculated for the range of bytes that must be read from the copy source.

property tags

tags?: Tags;

Blob tags.

property tier

tier?: BlockBlobTier | PremiumPageBlobTier | string;

Access tier. More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers

interface BlobTag

interface BlobTag {}

property key

key: string;

property value

value: string;

interface BlobTags

interface BlobTags {}

Blob tags

property blobTagSet

blobTagSet: BlobTag[];

interface BlobUndeleteHeaders

interface BlobUndeleteHeaders {}

Defines headers for Blob_undelete operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface BlobUndeleteOptions

interface BlobUndeleteOptions extends CommonOptions {}

Options to configure the BlobClient.undelete operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

interface Block

interface Block {}

Represents a single block in a block blob. It describes the block's ID and size.

property name

name: string;

The base64 encoded block ID.

property size

size: number;

The block size in bytes.

interface BlockBlobCommitBlockListHeaders

interface BlockBlobCommitBlockListHeaders {}

Defines headers for BlockBlob_commitBlockList operation.

property clientRequestId

clientRequestId?: string;

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

property contentMD5

contentMD5?: Uint8Array;

This header is returned so that the client can check for message content integrity. This header refers to the content of the request, meaning, in this case, the list of blocks, and not the content of the blob itself.

property date

date?: Date;

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

property encryptionKeySha256

encryptionKeySha256?: string;

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property isServerEncrypted

isServerEncrypted?: boolean;

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

property versionId

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

property xMsContentCrc64

xMsContentCrc64?: Uint8Array;

This header is returned so that the client can check for message content integrity. This header refers to the content of the request, meaning, in this case, the list of blocks, and not the content of the blob itself.

interface BlockBlobCommitBlockListOptions

interface BlockBlobCommitBlockListOptions extends CommonOptions {}

Options to configure BlockBlobClient.commitBlockList operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property blobHTTPHeaders

blobHTTPHeaders?: BlobHTTPHeaders;

HTTP headers to set when committing block list.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when committing the block list.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property immutabilityPolicy

immutabilityPolicy?: BlobImmutabilityPolicy;

Optional. Specifies immutability policy for a blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property legalHold

legalHold?: boolean;

Optional. Indicates if a legal hold should be placed on the blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property metadata

metadata?: Metadata;

A collection of key-value string pair to associate with the blob when committing block list.

property tags

tags?: Tags;

Blob tags.

property tier

tier?: BlockBlobTier | string;

Access tier. More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers

interface BlockBlobGetBlockListHeaders

interface BlockBlobGetBlockListHeaders {}

Defines headers for BlockBlob_getBlockList operation.

property blobContentLength

blobContentLength?: number;

The size of the blob in bytes.

property clientRequestId

clientRequestId?: string;

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

property contentType

contentType?: string;

The media type of the body of the response. For Get Block List this is 'application/xml'

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

interface BlockBlobGetBlockListOptions

interface BlockBlobGetBlockListOptions extends CommonOptions {}

Options to configure BlockBlobClient.getBlockList operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: LeaseAccessConditions & TagConditions;

If specified, contains the lease id that must be matched and lease with this id must be active in order for the operation to succeed.

interface BlockBlobParallelUploadOptions

interface BlockBlobParallelUploadOptions extends CommonOptions {}

Option interface for BlockBlobClient.uploadFile and BlockBlobClient.uploadSeekableStream.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property blobHTTPHeaders

blobHTTPHeaders?: BlobHTTPHeaders;

Blob HTTP Headers. A common header to set is blobContentType, enabling the browser to provide functionality based on file type.

property blockSize

blockSize?: number;

Destination block blob size in bytes.

property concurrency

concurrency?: number;

Concurrency of parallel uploading. Must be greater than or equal to 0.

property conditions

conditions?: BlobRequestConditions;

Access conditions headers.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property maxSingleShotSize

maxSingleShotSize?: number;

Blob size threshold in bytes to start concurrency uploading. Default value is 256MB, blob size less than this option will be uploaded via one I/O operation without concurrency. You can customize a value less equal than the default value.

property metadata

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

Metadata of block blob.

property onProgress

onProgress?: (progress: TransferProgressEvent) => void;

Progress updater.

property tags

tags?: Tags;

Blob tags.

property tier

tier?: BlockBlobTier | string;

Access tier. More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers

interface BlockBlobPutBlobFromUrlHeaders

interface BlockBlobPutBlobFromUrlHeaders {}

Defines headers for BlockBlob_putBlobFromUrl operation.

property clientRequestId

clientRequestId?: string;

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

property 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.

property date

date?: Date;

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

property encryptionKeySha256

encryptionKeySha256?: string;

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property isServerEncrypted

isServerEncrypted?: boolean;

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

property versionId

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

interface BlockBlobQueryOptions

interface BlockBlobQueryOptions extends CommonOptions {}

Options to configure BlockBlobClient.query operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when uploading to the block blob.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property inputTextConfiguration

inputTextConfiguration?:
    | BlobQueryJsonTextConfiguration
    | BlobQueryCsvTextConfiguration
    | BlobQueryParquetConfiguration;

Configurations for the query input.

property onError

onError?: (error: BlobQueryError) => void;

Callback to receive error events during the query operaiton.

property onProgress

onProgress?: (progress: TransferProgressEvent) => void;

Callback to receive events on the progress of query operation.

property outputTextConfiguration

outputTextConfiguration?:
    | BlobQueryJsonTextConfiguration
    | BlobQueryCsvTextConfiguration
    | BlobQueryArrowConfiguration;

Configurations for the query output.

interface BlockBlobStageBlockFromURLHeaders

interface BlockBlobStageBlockFromURLHeaders {}

Defines headers for BlockBlob_stageBlockFromURL operation.

property clientRequestId

clientRequestId?: string;

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

property contentMD5

contentMD5?: Uint8Array;

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

property date

date?: Date;

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

property encryptionKeySha256

encryptionKeySha256?: string;

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property isServerEncrypted

isServerEncrypted?: boolean;

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

property requestId

requestId?: string;

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

property version

version?: string;

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

property xMsContentCrc64

xMsContentCrc64?: Uint8Array;

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

interface BlockBlobStageBlockFromURLOptions

interface BlockBlobStageBlockFromURLOptions extends CommonOptions {}

Options to configure BlockBlobClient.stageBlockFromURL operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: LeaseAccessConditions;

If specified, contains the lease id that must be matched and lease with this id must be active in order for the operation to succeed.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property range

range?: Range_2;

Specifies the bytes of the source Blob/File to upload. If not specified, the entire content is uploaded as a single block.

property sourceAuthorization

sourceAuthorization?: HttpAuthorization;

Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source.

property sourceContentCrc64

sourceContentCrc64?: Uint8Array;

A CRC64 hash of the content from the URI. This hash is used to verify the integrity of the content during transport of the data from the URI. When this is specified, the storage service compares the hash of the content that has arrived from the copy-source with this value.
sourceContentMD5 and sourceContentCrc64 cannot be set at same time.

property sourceContentMD5

sourceContentMD5?: Uint8Array;

An MD5 hash of the content from the URI. This hash is used to verify the integrity of the content during transport of the data from the URI. When this is specified, the storage service compares the hash of the content that has arrived from the copy-source with this value.
sourceContentMD5 and sourceContentCrc64 cannot be set at same time.

interface BlockBlobStageBlockHeaders

interface BlockBlobStageBlockHeaders {}

Defines headers for BlockBlob_stageBlock operation.

property clientRequestId

clientRequestId?: string;

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

property contentMD5

contentMD5?: Uint8Array;

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

property date

date?: Date;

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

property encryptionKeySha256

encryptionKeySha256?: string;

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property isServerEncrypted

isServerEncrypted?: boolean;

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

property requestId

requestId?: string;

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

property version

version?: string;

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

property xMsContentCrc64

xMsContentCrc64?: Uint8Array;

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

interface BlockBlobStageBlockOptions

interface BlockBlobStageBlockOptions extends CommonOptions {}

Options to configure BlockBlobClient.stageBlock operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: LeaseAccessConditions;

If specified, contains the lease id that must be matched and lease with this id must be active in order for the operation to succeed.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property onProgress

onProgress?: (progress: TransferProgressEvent) => void;

Callback to receive events on the progress of stage block operation.

property transactionalContentCrc64

transactionalContentCrc64?: Uint8Array;

A CRC64 hash of the block content. This hash is used to verify the integrity of the block during transport. When this is specified, the storage service compares the hash of the content that has arrived with this value.
transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time.

property transactionalContentMD5

transactionalContentMD5?: Uint8Array;

An MD5 hash of the block content. This hash is used to verify the integrity of the block during transport. When this is specified, the storage service compares the hash of the content that has arrived with this value.
transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time.

interface BlockBlobSyncUploadFromURLOptions

interface BlockBlobSyncUploadFromURLOptions extends CommonOptions {}

Options to configure BlockBlobClient.syncUploadFromURL operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property blobHTTPHeaders

blobHTTPHeaders?: BlobHTTPHeaders;

HTTP headers to set when uploading to a block blob.
A common header to set is blobContentType, enabling the browser to provide functionality based on file type.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet for the destination Azure Blob.

property copySourceBlobProperties

copySourceBlobProperties?: boolean;

Optional, default is true. Indicates if properties from the source blob should be copied.

property copySourceTags

copySourceTags?: BlobCopySourceTags;

Optional, default 'replace'. Indicates if source tags should be copied or replaced with the tags specified by tags.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property metadata

metadata?: Metadata;

Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information.

property sourceAuthorization

sourceAuthorization?: HttpAuthorization;

Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source.

property sourceConditions

sourceConditions?: ModifiedAccessConditions;

Optional. Conditions to meet for the source Azure Blob.

property sourceContentMD5

sourceContentMD5?: Uint8Array;

Specify the md5 calculated for the range of bytes that must be read from the copy source.

property tags

tags?: Tags;

Blob tags.

property tier

tier?: BlockBlobTier | string;

Access tier. More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers

property timeoutInSeconds

timeoutInSeconds?: number;

Server timeout in seconds. For more information,
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations

interface BlockBlobUploadHeaders

interface BlockBlobUploadHeaders {}

Defines headers for BlockBlob_upload operation.

property clientRequestId

clientRequestId?: string;

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

property 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.

property date

date?: Date;

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

property encryptionKeySha256

encryptionKeySha256?: string;

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property isServerEncrypted

isServerEncrypted?: boolean;

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

property versionId

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

interface BlockBlobUploadOptions

interface BlockBlobUploadOptions extends CommonOptions {}

Options to configure BlockBlobClient.upload operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property blobHTTPHeaders

blobHTTPHeaders?: BlobHTTPHeaders;

HTTP headers to set when uploading to a block blob. A common header to set is blobContentType, enabling the browser to provide functionality based on file type.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when uploading to the block blob.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property immutabilityPolicy

immutabilityPolicy?: BlobImmutabilityPolicy;

Optional. Specifies immutability policy for a blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property legalHold

legalHold?: boolean;

Optional. Indicates if a legal hold should be placed on the blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property metadata

metadata?: Metadata;

A collection of key-value string pair to associate with the blob when uploading to a block blob.

property onProgress

onProgress?: (progress: TransferProgressEvent) => void;

Callback to receive events on the progress of upload operation.

property tags

tags?: Tags;

Blob tags.

property tier

tier?: BlockBlobTier | string;

Access tier. More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers

interface BlockBlobUploadStreamOptions

interface BlockBlobUploadStreamOptions extends CommonOptions {}

Option interface for the BlockBlobClient.uploadStream operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property blobHTTPHeaders

blobHTTPHeaders?: BlobHTTPHeaders;

Blob HTTP Headers.
A common header to set is blobContentType, enabling the browser to provide functionality based on file type.

property conditions

conditions?: BlobRequestConditions;

Access conditions headers.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property metadata

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

Metadata of block blob.

property onProgress

onProgress?: (progress: TransferProgressEvent) => void;

Progress updater.

property tags

tags?: Tags;

Blob tags.

property tier

tier?: BlockBlobTier | string;

Access tier. More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers

interface BlockList

interface BlockList {}

property committedBlocks

committedBlocks?: Block[];

property uncommittedBlocks

uncommittedBlocks?: Block[];

interface ClearRange

interface ClearRange {}

property end

end: number;

property start

start: number;

interface CommonGenerateSasUrlOptions

interface CommonGenerateSasUrlOptions {}

Common options of BlobGenerateSasUrlOptions and ContainerGenerateSasUrlOptions.

property cacheControl

cacheControl?: string;

Optional. The cache-control header for the SAS.

property contentDisposition

contentDisposition?: string;

Optional. The content-disposition header for the SAS.

property contentEncoding

contentEncoding?: string;

Optional. The content-encoding header for the SAS.

property contentLanguage

contentLanguage?: string;

Optional. The content-language header for the SAS.

property contentType

contentType?: string;

Optional. The content-type header for the SAS.

property encryptionScope

encryptionScope?: string;

Optional. Encryption scope to use when sending requests authorized with this SAS URI.

property expiresOn

expiresOn?: Date;

Optional only when identifier is provided. The time after which the SAS will no longer work.

property identifier

identifier?: string;

Optional. The name of the access policy on the container this SAS references if any.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy

property ipRange

ipRange?: SasIPRange;

Optional. IP ranges allowed in this SAS.

property protocol

protocol?: SASProtocol;

Optional. SAS protocols, HTTPS only or HTTPSandHTTP

property startsOn

startsOn?: Date;

Optional. When the SAS will take effect.

property version

version?: string;

The version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

interface CommonOptions

interface CommonOptions {}

An interface for options common to every remote operation.

property tracingOptions

tracingOptions?: OperationTracingOptions;

Options to configure spans created when tracing is enabled.

interface ContainerAcquireLeaseOptions

interface ContainerAcquireLeaseOptions extends CommonOptions {}

Options to configure Container - Acquire Lease operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ModifiedAccessConditions;

Conditions to meet when acquiring the lease.

interface ContainerBreakLeaseOptionalParams

interface ContainerBreakLeaseOptionalParams extends coreClient.OperationOptions {}

Optional parameters.

property breakPeriod

breakPeriod?: number;

For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately.

property modifiedAccessConditions

modifiedAccessConditions?: ModifiedAccessConditionsModel;

Parameter group

property requestId

requestId?: string;

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

property timeoutInSeconds

timeoutInSeconds?: number;

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

interface ContainerBreakLeaseOptions

interface ContainerBreakLeaseOptions extends CommonOptions {}

Options to configure Container - Break Lease operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ModifiedAccessConditions;

Conditions to meet when breaking the lease.

interface ContainerChangeLeaseOptions

interface ContainerChangeLeaseOptions extends CommonOptions {}

Options to configure Container - Change Lease operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ModifiedAccessConditions;

Conditions to meet when changing the lease.

interface ContainerCreateHeaders

interface ContainerCreateHeaders {}

Defines headers for Container_create operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ContainerCreateIfNotExistsResponse

interface ContainerCreateIfNotExistsResponse extends ContainerCreateResponse {}

Contains response data for the ContainerClient.createIfNotExists operation.

property succeeded

succeeded: boolean;

Indicate whether the container is successfully created. Is false when the container is not changed as it already exists.

interface ContainerCreateOptions

interface ContainerCreateOptions extends CommonOptions {}

Options to configure ContainerClient.create operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property access

access?: PublicAccessType;

Specifies whether data in the container may be accessed publicly and the level of access. Possible values include: - container: Specifies full public read access for container and blob data. Clients can enumerate blobs within the container via anonymous request, but cannot enumerate containers within the storage account. - blob: Specifies public read access for blobs. Blob data within this container can be read via anonymous request, but container data is not available. Clients cannot enumerate blobs within the container via anonymous request.

property containerEncryptionScope

containerEncryptionScope?: ContainerEncryptionScope;

Container encryption scope info.

property metadata

metadata?: Metadata;

A collection of key-value string pair to associate with the container.

interface ContainerDeleteBlobOptions

interface ContainerDeleteBlobOptions extends BlobDeleteOptions {}

Options to configure the ContainerClient.deleteBlob operation.

property versionId

versionId?: string;

An opaque DateTime value that, when present, specifies the version of the blob to delete. It's for service version 2019-10-10 and newer.

interface ContainerDeleteHeaders

interface ContainerDeleteHeaders {}

Defines headers for Container_delete operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ContainerDeleteIfExistsResponse

interface ContainerDeleteIfExistsResponse extends ContainerDeleteResponse {}

Contains response data for the ContainerClient.deleteIfExists operation.

property succeeded

succeeded: boolean;

Indicate whether the container is successfully deleted. Is false if the container does not exist in the first place.

interface ContainerDeleteMethodOptions

interface ContainerDeleteMethodOptions extends CommonOptions {}

Options to configure ContainerClient.delete operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ContainerRequestConditions;

Conditions to meet when deleting the container.

interface ContainerEncryptionScope

interface ContainerEncryptionScope {}

Parameter group

property defaultEncryptionScope

defaultEncryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the default encryption scope to set on the container and use for all future writes.

property preventEncryptionScopeOverride

preventEncryptionScopeOverride?: boolean;

Optional. Version 2019-07-07 and newer. If true, prevents any request from specifying a different encryption scope than the scope set on the container.

interface ContainerExistsOptions

interface ContainerExistsOptions extends CommonOptions {}

Options to configure ContainerClient.exists operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

interface ContainerFilterBlobsHeaders

interface ContainerFilterBlobsHeaders {}

Defines headers for Container_filterBlobs operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ContainerFindBlobByTagsOptions

interface ContainerFindBlobByTagsOptions extends CommonOptions {}

Options to configure the BlobServiceClient.findBlobsByTags operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

interface ContainerGenerateSasUrlOptions

interface ContainerGenerateSasUrlOptions extends CommonGenerateSasUrlOptions {}

Options to configure ContainerClient.generateSasUrl operation.

property permissions

permissions?: ContainerSASPermissions;

Optional only when identifier is provided. Specifies the list of permissions to be associated with the SAS.

interface ContainerGetAccessPolicyHeaders

interface ContainerGetAccessPolicyHeaders {}

Defines headers for Container_getAccessPolicy operation.

property blobPublicAccess

blobPublicAccess?: PublicAccessType;

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

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ContainerGetAccessPolicyOptions

interface ContainerGetAccessPolicyOptions extends CommonOptions {}

Options to configure ContainerClient.getAccessPolicy operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: LeaseAccessConditions;

If specified, contains the lease id that must be matched and lease with this id must be active in order for the operation to succeed.

interface ContainerGetAccountInfoHeaders

interface ContainerGetAccountInfoHeaders {}

Defines headers for Container_getAccountInfo operation.

property accountKind

accountKind?: AccountKind;

Identifies the account kind

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property isHierarchicalNamespaceEnabled

isHierarchicalNamespaceEnabled?: boolean;

Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled.

property requestId

requestId?: string;

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

property skuName

skuName?: SkuName;

Identifies the sku name of the account

property version

version?: string;

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

interface ContainerGetAccountInfoOptions

interface ContainerGetAccountInfoOptions extends CommonOptions {}

Options to configure the ContainerClient.getAccountInfo operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

interface ContainerGetPropertiesHeaders

interface ContainerGetPropertiesHeaders {}

Defines headers for Container_getProperties operation.

property blobPublicAccess

blobPublicAccess?: PublicAccessType;

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

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property defaultEncryptionScope

defaultEncryptionScope?: string;

The default encryption scope for the container.

property denyEncryptionScopeOverride

denyEncryptionScopeOverride?: boolean;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property hasImmutabilityPolicy

hasImmutabilityPolicy?: boolean;

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

property hasLegalHold

hasLegalHold?: boolean;

Indicates whether the container has a legal hold.

property isImmutableStorageWithVersioningEnabled

isImmutableStorageWithVersioningEnabled?: boolean;

Indicates whether version level worm is enabled on a container.

property 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.

property leaseDuration

leaseDuration?: LeaseDurationType;

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

property leaseState

leaseState?: LeaseStateType;

Lease state of the blob.

property leaseStatus

leaseStatus?: LeaseStatusType;

The current lease status of the blob.

property metadata

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

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ContainerGetPropertiesOptions

interface ContainerGetPropertiesOptions extends CommonOptions {}

Options to configure ContainerClient.getProperties operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: LeaseAccessConditions;

If specified, contains the lease id that must be matched and lease with this id must be active in order for the operation to succeed.

interface ContainerItem

interface ContainerItem {}

An Azure Storage container

property deleted

deleted?: boolean;

property metadata

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

Dictionary of

property name

name: string;

property properties

properties: ContainerProperties;

Properties of a container

property version

version?: string;

interface ContainerListBlobFlatSegmentHeaders

interface ContainerListBlobFlatSegmentHeaders {}

Defines headers for Container_listBlobFlatSegment operation.

property clientRequestId

clientRequestId?: string;

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

property contentType

contentType?: string;

The media type of the body of the response. For List Blobs this is 'application/xml'

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ContainerListBlobHierarchySegmentHeaders

interface ContainerListBlobHierarchySegmentHeaders {}

Defines headers for Container_listBlobHierarchySegment operation.

property clientRequestId

clientRequestId?: string;

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

property contentType

contentType?: string;

The media type of the body of the response. For List Blobs this is 'application/xml'

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ContainerListBlobsOptions

interface ContainerListBlobsOptions extends CommonOptions {}

Options to configure Container - List Blobs operations.
See: - ContainerClient.listBlobsFlat - ContainerClient.listBlobsByHierarchy

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property includeCopy

includeCopy?: boolean;

Specifies whether metadata related to any current or previous Copy Blob operation should be included in the response.

property includeDeleted

includeDeleted?: boolean;

Specifies whether soft deleted blobs should be included in the response.

property includeDeletedWithVersions

includeDeletedWithVersions?: boolean;

Specifies whether deleted blob with versions be returned in the response.

property includeImmutabilityPolicy

includeImmutabilityPolicy?: boolean;

Specifies whether blob immutability policy be returned in the response.

property includeLegalHold

includeLegalHold?: boolean;

Specifies whether blob legal hold be returned in the response.

property includeMetadata

includeMetadata?: boolean;

Specifies whether blob metadata be returned in the response.

property includeSnapshots

includeSnapshots?: boolean;

Specifies whether snapshots should be included in the enumeration. Snapshots are listed from oldest to newest in the response.

property includeTags

includeTags?: boolean;

Specifies whether blob tags be returned in the response.

property includeUncommitedBlobs

includeUncommitedBlobs?: boolean;

Specifies whether blobs for which blocks have been uploaded, but which have not been committed using Put Block List, be included in the response.

property includeVersions

includeVersions?: boolean;

Specifies whether versions should be included in the enumeration. Versions are listed from oldest to newest in the response.

property prefix

prefix?: string;

Filters the results to return only containers whose name begins with the specified prefix.

interface ContainerProperties

interface ContainerProperties {}

Properties of a container

property defaultEncryptionScope

defaultEncryptionScope?: string;

property deletedOn

deletedOn?: Date;

property etag

etag: string;

property hasImmutabilityPolicy

hasImmutabilityPolicy?: boolean;

property hasLegalHold

hasLegalHold?: boolean;

property isImmutableStorageWithVersioningEnabled

isImmutableStorageWithVersioningEnabled?: boolean;

Indicates if version level worm is enabled on this container.

property lastModified

lastModified: Date;

property leaseDuration

leaseDuration?: LeaseDurationType;

property leaseState

leaseState?: LeaseStateType;

property leaseStatus

leaseStatus?: LeaseStatusType;

property preventEncryptionScopeOverride

preventEncryptionScopeOverride?: boolean;

property publicAccess

publicAccess?: PublicAccessType;

property remainingRetentionDays

remainingRetentionDays?: number;

interface ContainerReleaseLeaseOptions

interface ContainerReleaseLeaseOptions extends CommonOptions {}

Options to configure Container - Release Lease operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ModifiedAccessConditions;

Conditions to meet when releasing the lease.

interface ContainerRenameHeaders

interface ContainerRenameHeaders {}

Defines headers for Container_rename operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ContainerRenewLeaseOptions

interface ContainerRenewLeaseOptions extends CommonOptions {}

Options to configure Container - Renew Lease operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ModifiedAccessConditions;

Conditions to meet when renewing the lease.

interface ContainerRequestConditions

interface ContainerRequestConditions
    extends LeaseAccessConditions,
        ModificationConditions {}

Conditions to meet for the container.

interface ContainerSASPermissionsLike

interface ContainerSASPermissionsLike {}

A type that looks like a Container SAS permission. Used in ContainerSASPermissions to parse SAS permissions from raw objects.

property add

add?: boolean;

Specifies Add access granted.

property create

create?: boolean;

Specifies Create access granted.

property delete

delete?: boolean;

Specifies Delete access granted.

property deleteVersion

deleteVersion?: boolean;

Specifies Delete version access granted.

property execute

execute?: boolean;

Specifies Execute access granted.

property filterByTags

filterByTags?: boolean;

Specifies that Filter Blobs by Tags is permitted.

property list

list?: boolean;

Specifies List access granted.

property move

move?: boolean;

Specifies Move access granted.

property permanentDelete

permanentDelete?: boolean;

Specifies that Permanent Delete is permitted.

property read

read?: boolean;

Specifies Read access granted.

property setImmutabilityPolicy

setImmutabilityPolicy?: boolean;

Specifies SetImmutabilityPolicy access granted.

property tag

tag?: boolean;

Specfies Tag access granted.

property write

write?: boolean;

Specifies Write access granted.

interface ContainerSetAccessPolicyHeaders

interface ContainerSetAccessPolicyHeaders {}

Defines headers for Container_setAccessPolicy operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ContainerSetAccessPolicyOptions

interface ContainerSetAccessPolicyOptions extends CommonOptions {}

Options to configure ContainerClient.setAccessPolicy operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ContainerRequestConditions;

Conditions to meet when setting the access policy.

interface ContainerSetMetadataHeaders

interface ContainerSetMetadataHeaders {}

Defines headers for Container_setMetadata operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ContainerSetMetadataOptions

interface ContainerSetMetadataOptions extends CommonOptions {}

Options to configure ContainerClient.setMetadata operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ContainerRequestConditions;

If specified, contains the lease id that must be matched and lease with this id must be active in order for the operation to succeed.

interface ContainerUndeleteHeaders

interface ContainerUndeleteHeaders {}

Defines headers for Container_restore operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface CorsRule

interface CorsRule {}

CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain

property allowedHeaders

allowedHeaders: string;

the request headers that the origin domain may specify on the CORS request.

property allowedMethods

allowedMethods: string;

The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)

property allowedOrigins

allowedOrigins: string;

The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.

property exposedHeaders

exposedHeaders: string;

The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer

property maxAgeInSeconds

maxAgeInSeconds: number;

The maximum amount time that a browser should cache the preflight OPTIONS request.

interface CpkInfo

interface CpkInfo {}

Parameter group

property encryptionAlgorithm

encryptionAlgorithm?: EncryptionAlgorithmType;

The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided.

property encryptionKey

encryptionKey?: string;

Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption is performed with the root account encryption key. For more information, see Encryption at Rest for Azure Storage Services.

property encryptionKeySha256

encryptionKeySha256?: string;

The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided.

interface FilterBlobItem

interface FilterBlobItem {}

Blob info from a BlobServiceClient.findBlobsByTags

property containerName

containerName: string;

Container Name.

property name

name: string;

Blob Name.

property tags

tags?: Tags;

Blob Tags.

property tagValue

tagValue: string;

Tag value.
Deprecated
The service no longer returns this value. Use tags to fetch all matching Blob Tags.

interface FilterBlobItemModel

interface FilterBlobItemModel {}

Blob info from a Filter Blobs API call

property containerName

containerName: string;

property name

name: string;

property tags

tags?: BlobTags;

Blob tags

interface FilterBlobSegment

interface FilterBlobSegment {}

Segment response of BlobServiceClient.findBlobsByTags operation.

property blobs

blobs: FilterBlobItem[];

property continuationToken

continuationToken?: string;

property serviceEndpoint

serviceEndpoint: string;

property where

where: string;

interface FilterBlobSegmentModel

interface FilterBlobSegmentModel {}

The result of a Filter Blobs API call

property blobs

blobs: FilterBlobItemModel[];

property continuationToken

continuationToken?: string;

property serviceEndpoint

serviceEndpoint: string;

property where

where: string;

interface GeoReplication

interface GeoReplication {}

Geo-Replication information for the Secondary Storage Service

property lastSyncOn

lastSyncOn: Date;

A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.

property status

status: GeoReplicationStatusType;

The status of the secondary location

interface HttpAuthorization

interface HttpAuthorization {}

Represents authentication information in Authorization, ProxyAuthorization, WWW-Authenticate, and Proxy-Authenticate header values.

property scheme

scheme: string;

The scheme to use for authorization.

property value

value: string;

the credentials containing the authentication information of the user agent for the resource being requested.

interface HttpResponse

interface HttpResponse {}

A representation of an HTTP response that includes a reference to the request that originated it.

property headers

headers: HttpHeaders;

The headers from the response.

property request

request: WebResource;

The original request that resulted in this response.

property status

status: number;

The HTTP status code returned from the service.

interface Lease

interface Lease {}

The details for a specific lease.

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error code if any associated with the response that returned the Lease information.

property etag

etag?: string;

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

property 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.

property leaseId

leaseId?: string;

Uniquely identifies a container's lease

property leaseTime

leaseTime?: number;

Approximate time remaining in the lease period, in seconds.

property requestId

requestId?: string;

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

property version

version?: string;

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

interface LeaseAccessConditions

interface LeaseAccessConditions {}

Parameter group

property leaseId

leaseId?: string;

If specified, the operation only succeeds if the resource's lease is active and matches this ID.

interface LeaseOperationOptions

interface LeaseOperationOptions extends CommonOptions {}

Configures lease operations.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ModifiedAccessConditions;

Conditions to meet when changing the lease.

interface ListBlobsFlatSegmentResponse

interface ListBlobsFlatSegmentResponse {}

An enumeration of blobs

property containerName

containerName: string;

property continuationToken

continuationToken?: string;

property marker

marker?: string;

property maxPageSize

maxPageSize?: number;

property prefix

prefix?: string;

property segment

segment: BlobFlatListSegment;

property serviceEndpoint

serviceEndpoint: string;

interface ListBlobsFlatSegmentResponseModel

interface ListBlobsFlatSegmentResponseModel {}

An enumeration of blobs

property containerName

containerName: string;

property continuationToken

continuationToken?: string;

property marker

marker?: string;

property maxPageSize

maxPageSize?: number;

property prefix

prefix?: string;

property segment

segment: BlobFlatListSegmentModel;

property serviceEndpoint

serviceEndpoint: string;

interface ListBlobsHierarchySegmentResponse

interface ListBlobsHierarchySegmentResponse {}

An enumeration of blobs

property containerName

containerName: string;

property continuationToken

continuationToken?: string;

property delimiter

delimiter?: string;

property marker

marker?: string;

property maxPageSize

maxPageSize?: number;

property prefix

prefix?: string;

property segment

segment: BlobHierarchyListSegment;

property serviceEndpoint

serviceEndpoint: string;

interface ListBlobsHierarchySegmentResponseModel

interface ListBlobsHierarchySegmentResponseModel {}

An enumeration of blobs

property containerName

containerName: string;

property continuationToken

continuationToken?: string;

property delimiter

delimiter?: string;

property marker

marker?: string;

property maxPageSize

maxPageSize?: number;

property prefix

prefix?: string;

property segment

segment: BlobHierarchyListSegmentModel;

property serviceEndpoint

serviceEndpoint: string;

interface ListContainersSegmentResponse

interface ListContainersSegmentResponse {}

An enumeration of containers

property containerItems

containerItems: ContainerItem[];

property continuationToken

continuationToken?: string;

property marker

marker?: string;

property maxPageSize

maxPageSize?: number;

property prefix

prefix?: string;

property serviceEndpoint

serviceEndpoint: string;

interface Logging

interface Logging {}

Azure Analytics Logging settings.

property deleteProperty

deleteProperty: boolean;

Indicates whether all delete requests should be logged.

property read

read: boolean;

Indicates whether all read requests should be logged.

property retentionPolicy

retentionPolicy: RetentionPolicy;

the retention policy which determines how long the associated data should persist

property version

version: string;

The version of Storage Analytics to configure.

property write

write: boolean;

Indicates whether all write requests should be logged.

interface MatchConditions

interface MatchConditions {}

Specifies HTTP options for conditional requests based on ETag matching.

property ifMatch

ifMatch?: string;

Specify an ETag value to operate only on blobs with a matching value.

property ifNoneMatch

ifNoneMatch?: string;

Specify an ETag value to operate only on blobs without a matching value.

interface Metadata

interface Metadata {}

A map of name-value pairs to associate with the resource.

index signature

[propertyName: string]: string;

A name-value pair.

interface Metrics

interface Metrics {}

a summary of request statistics grouped by API in hour or minute aggregates for blobs

property enabled

enabled: boolean;

Indicates whether metrics are enabled for the Blob service.

property includeAPIs

includeAPIs?: boolean;

Indicates whether metrics should generate summary statistics for called API operations.

property retentionPolicy

retentionPolicy?: RetentionPolicy;

the retention policy which determines how long the associated data should persist

property version

version?: string;

The version of Storage Analytics to configure.

interface ModificationConditions

interface ModificationConditions {}

Specifies HTTP options for conditional requests based on modification time.

property ifModifiedSince

ifModifiedSince?: Date;

Specify this header value to operate only on a blob if it has been modified since the specified date/time.

property ifUnmodifiedSince

ifUnmodifiedSince?: Date;

Specify this header value to operate only on a blob if it has not been modified since the specified date/time.

interface ModifiedAccessConditions

interface ModifiedAccessConditions
    extends MatchConditions,
        ModificationConditions,
        TagConditions {}

standard HTTP conditional headers and tags condition.

interface ModifiedAccessConditionsModel

interface ModifiedAccessConditionsModel {}

Parameter group

property ifMatch

ifMatch?: string;

Specify an ETag value to operate only on blobs with a matching value.

property ifModifiedSince

ifModifiedSince?: Date;

Specify this header value to operate only on a blob if it has been modified since the specified date/time.

property ifNoneMatch

ifNoneMatch?: string;

Specify an ETag value to operate only on blobs without a matching value.

property ifTags

ifTags?: string;

Specify a SQL where clause on blob tags to operate only on blobs with a matching value.

property ifUnmodifiedSince

ifUnmodifiedSince?: Date;

Specify this header value to operate only on a blob if it has not been modified since the specified date/time.

interface ObjectReplicationPolicy

interface ObjectReplicationPolicy {}

Contains Object Replication Policy ID and the respective list of ObjectReplicationRule. This is used when retrieving the Object Replication Properties on the source blob. The policy id for the destination blob is set in ObjectReplicationDestinationPolicyId of the respective method responses (e.g. BlobProperties.ObjectReplicationDestinationPolicyId.

property policyId

policyId: string;

The Object Replication Policy ID.

property rules

rules: ObjectReplicationRule[];

The Rule ID(s) and respective Replication Status(s) that are under the Policy ID.

interface ObjectReplicationRule

interface ObjectReplicationRule {}

Contains the Object Replication Rule ID and ObjectReplicationStatus of a blob. There can be more than one ObjectReplicationRule under a ObjectReplicationPolicy.

property replicationStatus

replicationStatus: ObjectReplicationStatus;

The Replication Status

property ruleId

ruleId: string;

The Object Replication Rule ID.

interface PageBlobClearPagesHeaders

interface PageBlobClearPagesHeaders {}

Defines headers for PageBlob_clearPages operation.

property blobSequenceNumber

blobSequenceNumber?: number;

The current sequence number for the page blob.

property clientRequestId

clientRequestId?: string;

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

property 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.

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

property xMsContentCrc64

xMsContentCrc64?: Uint8Array;

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

interface PageBlobClearPagesOptions

interface PageBlobClearPagesOptions extends CommonOptions {}

Options to configure the PageBlobClient.clearPages operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: PageBlobRequestConditions;

Conditions to meet when clearing pages.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

interface PageBlobCopyIncrementalHeaders

interface PageBlobCopyIncrementalHeaders {}

Defines headers for PageBlob_copyIncremental operation.

property clientRequestId

clientRequestId?: string;

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

property copyId

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

property copyStatus

copyStatus?: CopyStatusType;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

interface PageBlobCreateHeaders

interface PageBlobCreateHeaders {}

Defines headers for PageBlob_create operation.

property clientRequestId

clientRequestId?: string;

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

property 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.

property date

date?: Date;

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

property encryptionKeySha256

encryptionKeySha256?: string;

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property isServerEncrypted

isServerEncrypted?: boolean;

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

property versionId

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

interface PageBlobCreateIfNotExistsOptions

interface PageBlobCreateIfNotExistsOptions extends CommonOptions {}

Options to configure the PageBlobClient.createIfNotExists operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property blobHTTPHeaders

blobHTTPHeaders?: BlobHTTPHeaders;

HTTP headers to set when creating a page blob.

property blobSequenceNumber

blobSequenceNumber?: number;

A user-controlled value that can be used to track requests. The value must be between 0 and 2^63 - 1. The default value is 0.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property immutabilityPolicy

immutabilityPolicy?: BlobImmutabilityPolicy;

Optional. Specifies immutability policy for a blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property legalHold

legalHold?: boolean;

Optional. Indicates if a legal hold should be placed on the blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property metadata

metadata?: Metadata;

A collection of key-value string pair to associate with the blob when creating append blobs.

property tier

tier?: PremiumPageBlobTier | string;

Access tier. More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers

interface PageBlobCreateIfNotExistsResponse

interface PageBlobCreateIfNotExistsResponse extends PageBlobCreateResponse {}

Contains response data for the PageBlobClient.createIfNotExists operation.

property succeeded

succeeded: boolean;

Indicate whether the blob is successfully created. Is false when the blob is not changed as it already exists.

interface PageBlobCreateOptions

interface PageBlobCreateOptions extends CommonOptions {}

Options to configure the PageBlobClient.create operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property blobHTTPHeaders

blobHTTPHeaders?: BlobHTTPHeaders;

HTTP headers to set when creating a page blob.

property blobSequenceNumber

blobSequenceNumber?: number;

A user-controlled value that can be used to track requests. The value must be between 0 and 2^63 - 1. The default value is 0.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when creating a page blob.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property immutabilityPolicy

immutabilityPolicy?: BlobImmutabilityPolicy;

Optional. Specifies immutability policy for a blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property legalHold

legalHold?: boolean;

Optional. Indicates if a legal hold should be placed on the blob. Note that is parameter is only applicable to a blob within a container that has version level worm enabled.

property metadata

metadata?: Metadata;

A collection of key-value string pair to associate with the blob when creating append blobs.

property tags

tags?: Tags;

Blob tags.

property tier

tier?: PremiumPageBlobTier | string;

Access tier. More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers

interface PageBlobGetPageRangesDiffHeaders

interface PageBlobGetPageRangesDiffHeaders {}

Defines headers for PageBlob_getPageRangesDiff operation.

property blobContentLength

blobContentLength?: number;

The size of the blob in bytes.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

interface PageBlobGetPageRangesDiffOptions

interface PageBlobGetPageRangesDiffOptions extends CommonOptions {}

Options to configure the PageBlobClient.getRangesDiff operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when getting page ranges diff.

property range

range?: string;

(unused)

interface PageBlobGetPageRangesDiffResponse

interface PageBlobGetPageRangesDiffResponse
    extends PageList,
        PageBlobGetPageRangesDiffHeaders,
        ResponseWithBody<PageBlobGetPageRangesDiffHeaders, PageList> {}

Contains response data for the BlobClient.getPageRangesDiff operation.

interface PageBlobGetPageRangesHeaders

interface PageBlobGetPageRangesHeaders {}

Defines headers for PageBlob_getPageRanges operation.

property blobContentLength

blobContentLength?: number;

The size of the blob in bytes.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

interface PageBlobGetPageRangesOptions

interface PageBlobGetPageRangesOptions extends CommonOptions {}

Options to configure the PageBlobClient.getPageRanges operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when getting page ranges.

interface PageBlobGetPageRangesResponse

interface PageBlobGetPageRangesResponse
    extends PageList,
        PageBlobGetPageRangesHeaders,
        ResponseWithBody<PageBlobGetPageRangesHeaders, PageList> {}

Contains response data for the BlobClient.getPageRanges operation.

interface PageBlobListPageRangesDiffOptions

interface PageBlobListPageRangesDiffOptions extends CommonOptions {}

Options to configure the PageBlobClient.listPageRangesDiff operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when getting page ranges diff.

interface PageBlobListPageRangesOptions

interface PageBlobListPageRangesOptions extends CommonOptions {}

Options to configure the PageBlobClient.listPageRanges operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when getting page ranges.

interface PageBlobRequestConditions

interface PageBlobRequestConditions
    extends BlobRequestConditions,
        SequenceNumberAccessConditions {}

Conditions to add to the creation of this page blob.

interface PageBlobResizeHeaders

interface PageBlobResizeHeaders {}

Defines headers for PageBlob_resize operation.

property blobSequenceNumber

blobSequenceNumber?: number;

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

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

interface PageBlobResizeOptions

interface PageBlobResizeOptions extends CommonOptions {}

Options to configure PageBlobClient.resize operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when resizing a page blob.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

interface PageBlobStartCopyIncrementalOptions

interface PageBlobStartCopyIncrementalOptions extends CommonOptions {}

Options to configure PageBlobClient.startCopyIncremental operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: ModifiedAccessConditions;

Conditions to meet when starting a copy incremental operation.

interface PageBlobUpdateSequenceNumberHeaders

interface PageBlobUpdateSequenceNumberHeaders {}

Defines headers for PageBlob_updateSequenceNumber operation.

property blobSequenceNumber

blobSequenceNumber?: number;

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

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

interface PageBlobUpdateSequenceNumberOptions

interface PageBlobUpdateSequenceNumberOptions extends CommonOptions {}

Options to configure PageBlobClient.updateSequenceNumber operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: BlobRequestConditions;

Conditions to meet when updating sequence number.

interface PageBlobUploadPagesFromURLHeaders

interface PageBlobUploadPagesFromURLHeaders {}

Defines headers for PageBlob_uploadPagesFromURL operation.

property blobSequenceNumber

blobSequenceNumber?: number;

The current sequence number for the page blob.

property 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.

property date

date?: Date;

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

property encryptionKeySha256

encryptionKeySha256?: string;

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property isServerEncrypted

isServerEncrypted?: boolean;

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

property xMsContentCrc64

xMsContentCrc64?: Uint8Array;

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

interface PageBlobUploadPagesFromURLOptions

interface PageBlobUploadPagesFromURLOptions extends CommonOptions {}

Options to configure PageBlobClient.uploadPagesFromURL operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: PageBlobRequestConditions;

Conditions to meet when updating sequence number.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property sourceAuthorization

sourceAuthorization?: HttpAuthorization;

Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source.

property sourceConditions

sourceConditions?: MatchConditions & ModificationConditions;

Conditions to meet for the source Azure Blob/File when copying from a URL to the blob.

property sourceContentCrc64

sourceContentCrc64?: Uint8Array;

A CRC64 hash of the content from the URI. This hash is used to verify the integrity of the content during transport of the data from the URI. When this is specified, the storage service compares the hash of the content that has arrived from the copy-source with this value.
sourceContentMD5 and sourceContentCrc64 cannot be set at same time.

property sourceContentMD5

sourceContentMD5?: Uint8Array;

An MD5 hash of the content from the URI. This hash is used to verify the integrity of the content during transport of the data from the URI. When this is specified, the storage service compares the hash of the content that has arrived from the copy-source with this value.
sourceContentMD5 and sourceContentCrc64 cannot be set at same time.

interface PageBlobUploadPagesHeaders

interface PageBlobUploadPagesHeaders {}

Defines headers for PageBlob_uploadPages operation.

property blobSequenceNumber

blobSequenceNumber?: number;

The current sequence number for the page blob.

property clientRequestId

clientRequestId?: string;

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

property 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.

property date

date?: Date;

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

property encryptionKeySha256

encryptionKeySha256?: string;

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

property encryptionScope

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

property errorCode

errorCode?: string;

Error Code

property etag

etag?: string;

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

property isServerEncrypted

isServerEncrypted?: boolean;

The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise.

property 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.

property requestId

requestId?: string;

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

property version

version?: string;

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

property xMsContentCrc64

xMsContentCrc64?: Uint8Array;

This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers.

interface PageBlobUploadPagesOptions

interface PageBlobUploadPagesOptions extends CommonOptions {}

Options to configure the PageBlobClient.uploadPages operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property conditions

conditions?: PageBlobRequestConditions;

Conditions to meet when uploading pages.

property customerProvidedKey

customerProvidedKey?: CpkInfo;

Customer Provided Key Info.

property encryptionScope

encryptionScope?: string;

Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services.

property onProgress

onProgress?: (progress: TransferProgressEvent) => void;

Callback to receive events on the progress of upload pages operation.

property transactionalContentCrc64

transactionalContentCrc64?: Uint8Array;

A CRC64 hash of the content. This hash is used to verify the integrity of the content during transport. When this is specified, the storage service compares the hash of the content that has arrived with this value.
transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time.

property transactionalContentMD5

transactionalContentMD5?: Uint8Array;

An MD5 hash of the content. This hash is used to verify the integrity of the content during transport. When this is specified, the storage service compares the hash of the content that has arrived with this value.
transactionalContentMD5 and transactionalContentCrc64 cannot be set at same time.

interface PageList

interface PageList {}

List of page ranges for a blob.

property clearRange

clearRange?: Range_2[];

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

property pageRange

pageRange?: Range_2[];

Valid non-overlapping page ranges.

interface PageListInternal

interface PageListInternal {}

the list of pages

property clearRange

clearRange?: ClearRange[];

property continuationToken

continuationToken?: string;

property pageRange

pageRange?: PageRange[];

interface PageRange

interface PageRange {}

property end

end: number;

property start

start: number;

interface PageRangeInfo

interface PageRangeInfo {}

property end

end: number;

property isClear

isClear: boolean;

property start

start: number;

interface ParsedBatchResponse

interface ParsedBatchResponse {}

The multipart/mixed response which contains the response for each subrequest.

property subResponses

subResponses: BatchSubResponse[];

The parsed sub responses.

property subResponsesFailedCount

subResponsesFailedCount: number;

The failed executed sub responses' count;

property subResponsesSucceededCount

subResponsesSucceededCount: number;

The succeeded executed sub responses' count;

interface PipelineLike

interface PipelineLike {}

An interface for the Pipeline class containing HTTP request policies. You can create a default Pipeline by calling newPipeline. Or you can create a Pipeline with your own policies by the constructor of Pipeline.
Refer to newPipeline and provided policies before implementing your customized Pipeline.

property factories

readonly factories: RequestPolicyFactory[];

A list of chained request policy factories.

property options

readonly options: PipelineOptions;

Configures pipeline logger and HTTP client.

method toServiceClientOptions

toServiceClientOptions: () => ServiceClientOptions;

Transfer Pipeline object to ServiceClientOptions object which is required by ServiceClient constructor.
Returns
The ServiceClientOptions object from this Pipeline.

interface PipelineOptions

interface PipelineOptions {}

Option interface for Pipeline constructor.

property httpClient

httpClient?: RequestPolicy;

Optional. Configures the HTTP client to send requests and receive responses.

interface PollerLikeWithCancellation

interface PollerLikeWithCancellation<
    TState extends PollOperationState<TResult>,
    TResult
> {}

Abstract representation of a poller, intended to expose just the minimal API that the user needs to work with.

method cancelOperation

cancelOperation: (options?: { abortSignal?: AbortSignalLike }) => Promise<void>;

Attempts to cancel the underlying operation.

method getOperationState

getOperationState: () => TState;

Returns the state of the operation. The TState defined in PollerLike can be a subset of the TState defined in the Poller implementation.

method getResult

getResult: () => TResult | undefined;

Returns the result value of the operation, regardless of the state of the poller. It can return undefined or an incomplete form of the final TResult value depending on the implementation.

method isDone

isDone: () => boolean;

Returns true if the poller has finished polling.

method isStopped

isStopped: () => boolean;

Returns true if the poller is stopped.

method onProgress

onProgress: (callback: (state: TState) => void) => CancelOnProgress;

Invokes the provided callback after each polling is completed, sending the current state of the poller's operation.
It returns a method that can be used to stop receiving updates on the given callback function.

method poll

poll: (options?: { abortSignal?: AbortSignalLike }) => Promise<void>;

Returns a promise that will resolve once a single polling request finishes. It does this by calling the update method of the Poller's operation.

method pollUntilDone

pollUntilDone: () => Promise<TResult>;

Returns a promise that will resolve once the underlying operation is completed.

method stopPolling

stopPolling: () => void;

Stops the poller. After this, no manual or automated requests can be sent.

method toString

toString: () => string;

Returns a serialized version of the poller's operation by invoking the operation's toString method.

interface Range

interface Range_2 {}

Range for Blob Service Operations.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations

property count

count?: number;

Optional. Count of bytes, larger than 0. If not provided, will return bytes from offset to the end.

property offset

offset: number;

StartByte, larger than or equal 0.

interface ResponseLike

interface ResponseLike {}

An object with a simple _response property.

interface ResponseWithBody

interface ResponseWithBody<Headers, Body> {}

An object with a _response property that has body and headers already parsed into known types.

interface ResponseWithHeaders

interface ResponseWithHeaders<Headers> {}

An object with a _response property that has headers already parsed into a typed object.

interface RetentionPolicy

interface RetentionPolicy {}

the retention policy which determines how long the associated data should persist

property days

days?: number;

Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted

property enabled

enabled: boolean;

Indicates whether a retention policy is enabled for the storage service

interface SasIPRange

interface SasIPRange {}

Allowed IP range for a SAS.

property end

end?: string;

Optional. IP address that ends the IP range. If not provided, start IP will the only IP allowed.

property start

start: string;

Starting IP address in the IP range. If end IP doesn't provide, start IP will the only IP allowed.

interface SASQueryParametersOptions

interface SASQueryParametersOptions {}

Options to construct SASQueryParameters.

property cacheControl

cacheControl?: string;

Value for cache-control header in Blob/File Service SAS.

property contentDisposition

contentDisposition?: string;

Value for content-disposition header in Blob/File Service SAS.

property contentEncoding

contentEncoding?: string;

Value for content-encoding header in Blob/File Service SAS.

property contentLanguage

contentLanguage?: string;

Value for content-length header in Blob/File Service SAS.

property contentType

contentType?: string;

Value for content-type header in Blob/File Service SAS.

property correlationId

correlationId?: string;

A GUID value that will be logged in the storage diagnostic logs and can be used to correlate SAS generation with storage resource access. This is only used for User Delegation SAS.

property encryptionScope

encryptionScope?: string;

Optional. Encryption scope to use when sending requests authorized with this SAS URI.

property expiresOn

expiresOn?: Date;

Optional only when identifier is provided. The expiry time for this SAS token.

property identifier

identifier?: string;

Optional. The signed identifier (only for BlobSASSignatureValues).
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy

property ipRange

ipRange?: SasIPRange;

Optional. IP ranges allowed in this SAS.

property permissions

permissions?: string;

Optional only when identifier is provided. Please refer to AccountSASPermissions, BlobSASPermissions, or ContainerSASPermissions for more details.

property preauthorizedAgentObjectId

preauthorizedAgentObjectId?: string;

Authorized AAD Object ID in GUID format. The AAD Object ID of a user authorized by the owner of the User Delegation Key to perform the action granted by the SAS. The Azure Storage service will ensure that the owner of the user delegation key has the required permissions before granting access but no additional permission check for the user specified in this value will be performed. This cannot be used in conjuction with signedUnauthorizedUserObjectId. This is only used for User Delegation SAS.

property protocol

protocol?: SASProtocol;

Optional. The allowed HTTP protocol(s).

property resource

resource?: string;

Optional. Specifies which resources are accessible via the SAS (only for BlobSASSignatureValues).
See Also
- https://learn.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only

property resourceTypes

resourceTypes?: string;

Optional. The storage resource types being accessed (only for Account SAS). Please refer to AccountSASResourceTypes for more details.

property services

services?: string;

Optional. The storage services being accessed (only for Account SAS). Please refer to AccountSASServices for more details.

property startsOn

startsOn?: Date;

Optional. The start time for this SAS token.

property userDelegationKey

userDelegationKey?: UserDelegationKey;

User delegation key properties.

interface SequenceNumberAccessConditions

interface SequenceNumberAccessConditions {}

Parameter group

property ifSequenceNumberEqualTo

ifSequenceNumberEqualTo?: number;

Specify this header value to operate only on a blob if it has the specified sequence number.

property ifSequenceNumberLessThan

ifSequenceNumberLessThan?: number;

Specify this header value to operate only on a blob if it has a sequence number less than the specified.

property ifSequenceNumberLessThanOrEqualTo

ifSequenceNumberLessThanOrEqualTo?: number;

Specify this header value to operate only on a blob if it has a sequence number less than or equal to the specified.

interface ServiceClientOptions

interface ServiceClientOptions {}

A subset of @azure/core-http ServiceClientOptions

property httpClient

httpClient?: RequestPolicy;

Optional. Configures the HTTP client to send requests and receive responses.

property requestPolicyFactories

requestPolicyFactories?:
    | RequestPolicyFactory[]
    | ((
          defaultRequestPolicyFactories: RequestPolicyFactory[]
      ) => void | RequestPolicyFactory[]);

Optional. Overrides the default policy factories.

interface ServiceFilterBlobsHeaders

interface ServiceFilterBlobsHeaders {}

Defines headers for Service_filterBlobs operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ServiceFindBlobByTagsOptions

interface ServiceFindBlobByTagsOptions extends CommonOptions {}

Options to configure the BlobServiceClient.findBlobsByTags operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

interface ServiceGenerateAccountSasUrlOptions

interface ServiceGenerateAccountSasUrlOptions {}

Options to configure BlobServiceClient.generateAccountSasUrl operation.

property encryptionScope

encryptionScope?: string;

Optional. Encryption scope to use when sending requests authorized with this SAS URI.

property ipRange

ipRange?: SasIPRange;

Optional. IP range allowed.

property protocol

protocol?: SASProtocol;

Optional. SAS protocols allowed.

property startsOn

startsOn?: Date;

Optional. When the SAS will take effect.

property version

version?: string;

The version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

interface ServiceGetAccountInfoHeaders

interface ServiceGetAccountInfoHeaders {}

Defines headers for Service_getAccountInfo operation.

property accountKind

accountKind?: AccountKind;

Identifies the account kind

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property isHierarchicalNamespaceEnabled

isHierarchicalNamespaceEnabled?: boolean;

Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled.

property requestId

requestId?: string;

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

property skuName

skuName?: SkuName;

Identifies the sku name of the account

property version

version?: string;

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

interface ServiceGetAccountInfoOptions

interface ServiceGetAccountInfoOptions extends CommonOptions {}

Options to configure the BlobServiceClient.getAccountInfo operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

interface ServiceGetPropertiesHeaders

interface ServiceGetPropertiesHeaders {}

Defines headers for Service_getProperties operation.

property clientRequestId

clientRequestId?: string;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ServiceGetPropertiesOptions

interface ServiceGetPropertiesOptions extends CommonOptions {}

Options to configure the BlobServiceClient.getProperties operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

interface ServiceGetStatisticsHeaders

interface ServiceGetStatisticsHeaders {}

Defines headers for Service_getStatistics operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ServiceGetStatisticsOptions

interface ServiceGetStatisticsOptions extends CommonOptions {}

Options to configure the BlobServiceClient.getStatistics operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

interface ServiceGetUserDelegationKeyHeaders

interface ServiceGetUserDelegationKeyHeaders {}

Defines headers for Service_getUserDelegationKey operation.

property clientRequestId

clientRequestId?: string;

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

property date

date?: Date;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ServiceGetUserDelegationKeyOptions

interface ServiceGetUserDelegationKeyOptions extends CommonOptions {}

Options to configure the Service - Get User Delegation Key.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

interface ServiceListContainersOptions

interface ServiceListContainersOptions extends CommonOptions {}

Options to configure the BlobServiceClient.listContainers operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property includeDeleted

includeDeleted?: boolean;

Specifies whether soft deleted containers should be included in the response.

property includeMetadata

includeMetadata?: boolean;

Specifies whether the container's metadata should be returned as part of the response body.

property includeSystem

includeSystem?: boolean;

Specifies whether system containers should be included in the response.

property prefix

prefix?: string;

Filters the results to return only containers whose name begins with the specified prefix.

interface ServiceListContainersSegmentHeaders

interface ServiceListContainersSegmentHeaders {}

Defines headers for Service_listContainersSegment operation.

property clientRequestId

clientRequestId?: string;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ServiceRenameContainerOptions

interface ServiceRenameContainerOptions extends CommonOptions {}

Options to configure BlobServiceClient.renameContainer operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property sourceCondition

sourceCondition?: LeaseAccessConditions;

Condition to meet for the source container.

interface ServiceSetPropertiesHeaders

interface ServiceSetPropertiesHeaders {}

Defines headers for Service_setProperties operation.

property clientRequestId

clientRequestId?: string;

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

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ServiceSetPropertiesOptions

interface ServiceSetPropertiesOptions extends CommonOptions {}

Options to configure the BlobServiceClient.setProperties operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

interface ServiceSubmitBatchHeaders

interface ServiceSubmitBatchHeaders {}

Defines headers for Service_submitBatch operation.

property clientRequestId

clientRequestId?: string;

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

property contentType

contentType?: string;

The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID

property errorCode

errorCode?: string;

Error Code

property requestId

requestId?: string;

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

property version

version?: string;

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

interface ServiceSubmitBatchOptionalParamsModel

interface ServiceSubmitBatchOptionalParamsModel
    extends coreClient.OperationOptions {}

Optional parameters.

property requestId

requestId?: string;

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

property timeoutInSeconds

timeoutInSeconds?: number;

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

interface ServiceUndeleteContainerOptions

interface ServiceUndeleteContainerOptions extends CommonOptions {}

Options to configure BlobServiceClient.undeleteContainer operation.

property abortSignal

abortSignal?: AbortSignalLike;

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the &commat;azure/abort-controller to create an AbortSignal.

property destinationContainerName

destinationContainerName?: string;

Optional. Specifies the new name of the restored container. Will use its original name if this is not specified.
Deprecated
Restore container to a different name is not supported by service anymore.

interface SignedIdentifier

interface SignedIdentifier {}

Signed identifier.

property accessPolicy

accessPolicy: {
    /**
     * Optional. The date-time the policy is active
     */
    startsOn?: Date;
    /**
     * Optional. The date-time the policy expires
     */
    expiresOn?: Date;
    /**
     * The permissions for the acl policy
     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-acl
     */
    permissions?: string;
};

Access Policy

property id

id: string;

a unique id

interface SignedIdentifierModel

interface SignedIdentifierModel {}

signed identifier

property accessPolicy

accessPolicy: AccessPolicy;

An Access policy

property id

id: string;

a unique id

interface StaticWebsite

interface StaticWebsite {}

The properties that enable an account to host a static website

property defaultIndexDocumentPath

defaultIndexDocumentPath?: string;

Absolute path of the default index page

property enabled

enabled: boolean;

Indicates whether this account is hosting a static website

property errorDocument404Path

errorDocument404Path?: string;

The absolute path of the custom 404 page

property indexDocument

indexDocument?: string;

The default name of the index page under each directory

interface StoragePipelineOptions

interface StoragePipelineOptions {}

Options interface for the newPipeline function.

property audience

audience?: string | string[];

The audience used to retrieve an AAD token. By default, audience 'https://storage.azure.com/.default' will be used.

property httpClient

httpClient?: RequestPolicy;

Configures the HTTP client to send requests and receive responses.

property keepAliveOptions

keepAliveOptions?: KeepAliveOptions;

Keep alive configurations. Default keep-alive is enabled.

property proxyOptions

proxyOptions?: ProxySettings;

Options to configure a proxy for outgoing requests.

property retryOptions

retryOptions?: StorageRetryOptions;

Configures the built-in retry policy behavior.

property userAgentOptions

userAgentOptions?: UserAgentPolicyOptions;

Options for adding user agent details to outgoing requests.

interface StorageRetryOptions

interface StorageRetryOptions {}

Storage Blob retry options interface.

property maxRetryDelayInMs

readonly maxRetryDelayInMs?: number;

Optional. Specifies the maximum delay allowed before retrying an operation (default is 120s or 120 * 1000ms). If you specify 0, then you must also specify 0 for retryDelayInMs.

property maxTries

readonly maxTries?: number;

Optional. Max try number of attempts, default is 4. A value of 1 means 1 try and no retries. A value smaller than 1 means default retry number of attempts.

property retryDelayInMs

readonly retryDelayInMs?: number;

Optional. Specifies the amount of delay to use before retrying an operation (default is 4s or 4 * 1000ms). The delay increases (exponentially or linearly) with each retry up to a maximum specified by maxRetryDelayInMs. If you specify 0, then you must also specify 0 for maxRetryDelayInMs.

property retryPolicyType

readonly retryPolicyType?: StorageRetryPolicyType;

Optional. StorageRetryPolicyType, default is exponential retry policy.

property secondaryHost

readonly secondaryHost?: string;

If a secondaryHost is specified, retries will be tried against this host. If secondaryHost is undefined (the default) then operations are not retried against another host.
NOTE: Before setting this field, make sure you understand the issues around reading stale and potentially-inconsistent data at https://learn.microsoft.com/en-us/azure/storage/common/storage-designing-ha-apps-with-ragrs

property tryTimeoutInMs

readonly tryTimeoutInMs?: number;

Optional. Indicates the maximum time in ms allowed for any single try of an HTTP request. A value of zero or undefined means no default timeout on SDK client, Azure Storage server's default timeout policy will be used.
See Also
- https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations

interface TagConditions

interface TagConditions {}

Specifies HTTP options for conditional requests based on blob tags.

property tagConditions

tagConditions?: string;

Optional SQL statement to apply to the tags of the blob.

interface UserDelegationKey

interface UserDelegationKey {}

A user delegation key.

property signedExpiresOn

signedExpiresOn: Date;

The date-time the key expires.

property signedObjectId

signedObjectId: string;

The Azure Active Directory object ID in GUID format.

property signedService

signedService: string;

Abbreviation of the Azure Storage service that accepts the key.

property signedStartsOn

signedStartsOn: Date;

The date-time the key is active.

property signedTenantId

signedTenantId: string;

The Azure Active Directory tenant ID in GUID format.

property signedVersion

signedVersion: string;

The service version that created the key.

property value

value: string;

The key as a base64 string.

interface UserDelegationKeyModel

interface UserDelegationKeyModel {}

A user delegation key

property signedExpiresOn

signedExpiresOn: string;

The date-time the key expires

property signedObjectId

signedObjectId: string;

The Azure Active Directory object ID in GUID format.

property signedService

signedService: string;

Abbreviation of the Azure Storage service that accepts the key

property signedStartsOn

signedStartsOn: string;

The date-time the key is active

property signedTenantId

signedTenantId: string;

The Azure Active Directory tenant ID in GUID format

property signedVersion

signedVersion: string;

The service version that created the key

property value

value: string;

The key as a base64 string

Enums

enum BlockBlobTier

enum BlockBlobTier {
    Hot = 'Hot',
    Cool = 'Cool',
    Cold = 'Cold',
    Archive = 'Archive',
}

Represents the access tier on a blob. For detailed information about block blob level tiering see Hot, cool and archive storage tiers.

member Archive

Archive = 'Archive'

Optimized for storing data that is rarely accessed and stored for at least 180 days with flexible latency requirements (on the order of hours).

member Cold

Cold = 'Cold'

Optimized for storing data that is rarely accessed.

member Cool

Cool = 'Cool'

Optimized for storing data that is infrequently accessed and stored for at least 30 days.

member Hot

Hot = 'Hot'

Optimized for storing data that is accessed frequently.

enum KnownEncryptionAlgorithmType

enum KnownEncryptionAlgorithmType {
    AES256 = 'AES256',
}

Known values of EncryptionAlgorithmType that the service accepts.

member AES256

AES256 = 'AES256'

enum PremiumPageBlobTier

enum PremiumPageBlobTier {
    P4 = 'P4',
    P6 = 'P6',
    P10 = 'P10',
    P15 = 'P15',
    P20 = 'P20',
    P30 = 'P30',
    P40 = 'P40',
    P50 = 'P50',
    P60 = 'P60',
    P70 = 'P70',
    P80 = 'P80',
}

Specifies the page blob tier to set the blob to. This is only applicable to page blobs on premium storage accounts. Please see here for detailed information on the corresponding IOPS and throughput per PageBlobTier.

member P10

P10 = 'P10'

P10 Tier.

member P15

P15 = 'P15'

P15 Tier.

member P20

P20 = 'P20'

P20 Tier.

member P30

P30 = 'P30'

P30 Tier.

member P4

P4 = 'P4'

P4 Tier.

member P40

P40 = 'P40'

P40 Tier.

member P50

P50 = 'P50'

P50 Tier.

member P6

P6 = 'P6'

P6 Tier.

member P60

P60 = 'P60'

P60 Tier.

member P70

P70 = 'P70'

P70 Tier.

member P80

P80 = 'P80'

P80 Tier.

enum SASProtocol

enum SASProtocol {
    Https = 'https',
    HttpsAndHttp = 'https,http',
}

Protocols for generated SAS.

member Https

Https = 'https'

Protocol that allows HTTPS only

member HttpsAndHttp

HttpsAndHttp = 'https,http'

Protocol that allows both HTTPS and HTTP

enum StorageBlobAudience

enum StorageBlobAudience {
    StorageOAuthScopes = 'https://storage.azure.com/.default',
    DiskComputeOAuthScopes = 'https://disk.compute.azure.com/.default',
}

Defines the known cloud audiences for Storage.

member DiskComputeOAuthScopes

DiskComputeOAuthScopes = 'https://disk.compute.azure.com/.default'

The OAuth scope to use to retrieve an AAD token for Azure Disk.

member StorageOAuthScopes

StorageOAuthScopes = 'https://storage.azure.com/.default'

The OAuth scope to use to retrieve an AAD token for Azure Storage.

enum StorageRetryPolicyType

enum StorageRetryPolicyType {
    EXPONENTIAL = 0,
    FIXED = 1,
}

RetryPolicy types.

member EXPONENTIAL

EXPONENTIAL = 0

Exponential retry. Retry time delay grows exponentially.

member FIXED

FIXED = 1

Linear retry. Retry time delay grows linearly.

Type Aliases

type AccessTier

type AccessTier =
    | 'P4'
    | 'P6'
    | 'P10'
    | 'P15'
    | 'P20'
    | 'P30'
    | 'P40'
    | 'P50'
    | 'P60'
    | 'P70'
    | 'P80'
    | 'Hot'
    | 'Cool'
    | 'Archive'
    | 'Cold';

Defines values for AccessTier.

type AccountKind

type AccountKind =
    | 'Storage'
    | 'BlobStorage'
    | 'StorageV2'
    | 'FileStorage'
    | 'BlockBlobStorage';

Defines values for AccountKind.

type AppendBlobAppendBlockFromUrlResponse

type AppendBlobAppendBlockFromUrlResponse = WithResponse<
    AppendBlobAppendBlockFromUrlHeaders,
    AppendBlobAppendBlockFromUrlHeaders
>;

Contains response data for the appendBlockFromUrl operation.

type AppendBlobAppendBlockResponse

type AppendBlobAppendBlockResponse = WithResponse<
    AppendBlobAppendBlockHeaders,
    AppendBlobAppendBlockHeaders
>;

Contains response data for the appendBlock operation.

type AppendBlobCreateResponse

type AppendBlobCreateResponse = WithResponse<
    AppendBlobCreateHeaders,
    AppendBlobCreateHeaders
>;

Contains response data for the create operation.

type ArchiveStatus

type ArchiveStatus =
    | 'rehydrate-pending-to-hot'
    | 'rehydrate-pending-to-cool'
    | 'rehydrate-pending-to-cold';

Defines values for ArchiveStatus.

type BlobAbortCopyFromURLResponse

type BlobAbortCopyFromURLResponse = WithResponse<
    BlobAbortCopyFromURLHeaders,
    BlobAbortCopyFromURLHeaders
>;

Contains response data for the abortCopyFromURL operation.

type BlobBatchDeleteBlobsResponse

type BlobBatchDeleteBlobsResponse = BlobBatchSubmitBatchResponse;

Contains response data for the deleteBlobs operation.

type BlobBatchSetBlobsAccessTierResponse

type BlobBatchSetBlobsAccessTierResponse = BlobBatchSubmitBatchResponse;

Contains response data for the setBlobsAccessTier operation.

type BlobBatchSubmitBatchResponse

type BlobBatchSubmitBatchResponse = WithResponse<
    ParsedBatchResponse & ServiceSubmitBatchHeaders,
    ServiceSubmitBatchHeaders
>;

Contains response data for blob batch operations.

type BlobCopyFromURLResponse

type BlobCopyFromURLResponse = WithResponse<
    BlobCopyFromURLHeaders,
    BlobCopyFromURLHeaders
>;

Contains response data for the copyFromURL operation.

type BlobCopySourceTags

type BlobCopySourceTags = 'REPLACE' | 'COPY';

Defines values for BlobCopySourceTags.

type BlobCreateSnapshotResponse

type BlobCreateSnapshotResponse = WithResponse<
    BlobCreateSnapshotHeaders,
    BlobCreateSnapshotHeaders
>;

Contains response data for the createSnapshot operation.

type BlobDeleteImmutabilityPolicyResponse

type BlobDeleteImmutabilityPolicyResponse = WithResponse<
    BlobDeleteImmutabilityPolicyHeaders,
    BlobDeleteImmutabilityPolicyHeaders
>;

Contains response data for the deleteImmutabilityPolicy operation.

type BlobDeleteResponse

type BlobDeleteResponse = WithResponse<BlobDeleteHeaders, BlobDeleteHeaders>;

Contains response data for the delete operation.

type BlobDownloadResponseInternal

type BlobDownloadResponseInternal = BlobDownloadHeaders & {
    /**
     * BROWSER ONLY
     *
     * The response body as a browser Blob.
     * Always `undefined` in node.js.
     */
    blobBody?: Promise<Blob>;
    /**
     * NODEJS ONLY
     *
     * The response body as a node.js Readable stream.
     * Always `undefined` in the browser.
     */
    readableStreamBody?: NodeJS.ReadableStream;
};

Contains response data for the download operation.

type BlobDownloadResponseModel

type BlobDownloadResponseModel = WithResponse<
    BlobDownloadResponseInternal,
    BlobDownloadHeaders
>;

Contains response data for the download operation.

type BlobGetAccountInfoResponse

type BlobGetAccountInfoResponse = WithResponse<
    BlobGetAccountInfoHeaders,
    BlobGetAccountInfoHeaders
>;

Contains response data for the getAccountInfo operation.

type BlobGetPropertiesResponseModel

type BlobGetPropertiesResponseModel = WithResponse<
    BlobGetPropertiesHeaders,
    BlobGetPropertiesHeaders
>;

Contains response data for the getProperties operation.

type BlobGetTagsResponse

type BlobGetTagsResponse = WithResponse<
    {
        tags: Tags;
    } & BlobGetTagsHeaders,
    BlobGetTagsHeaders,
    BlobTags
>;

Contains response data for the BlobClient.getTags operation.

type BlobImmutabilityPolicyMode

type BlobImmutabilityPolicyMode = 'Mutable' | 'Unlocked' | 'Locked';

Defines values for BlobImmutabilityPolicyMode.

type BlobQueryArrowFieldType

type BlobQueryArrowFieldType =
    | 'int64'
    | 'bool'
    | 'timestamp[ms]'
    | 'string'
    | 'double'
    | 'decimal';

The type of a BlobQueryArrowField.

type BlobQueryResponseInternal

type BlobQueryResponseInternal = BlobQueryHeaders & {
    /**
     * BROWSER ONLY
     *
     * The response body as a browser Blob.
     * Always `undefined` in node.js.
     */
    blobBody?: Promise<Blob>;
    /**
     * NODEJS ONLY
     *
     * The response body as a node.js Readable stream.
     * Always `undefined` in the browser.
     */
    readableStreamBody?: NodeJS.ReadableStream;
};

Contains response data for the query operation.

type BlobQueryResponseModel

type BlobQueryResponseModel = WithResponse<
    BlobQueryResponseInternal,
    BlobQueryHeaders
>;

Contains response data for the query operation.

type BlobSetHTTPHeadersResponse

type BlobSetHTTPHeadersResponse = WithResponse<
    BlobSetHTTPHeadersHeaders,
    BlobSetHTTPHeadersHeaders
>;

Contains response data for the setHttpHeaders operation.

type BlobSetImmutabilityPolicyResponse

type BlobSetImmutabilityPolicyResponse = WithResponse<
    BlobSetImmutabilityPolicyHeaders,
    BlobSetImmutabilityPolicyHeaders
>;

Contains response data for the setImmutabilityPolicy operation.

type BlobSetLegalHoldResponse

type BlobSetLegalHoldResponse = WithResponse<
    BlobSetLegalHoldHeaders,
    BlobSetLegalHoldHeaders
>;

Contains response data for the setLegalHold operation.

type BlobSetMetadataResponse

type BlobSetMetadataResponse = WithResponse<
    BlobSetMetadataHeaders,
    BlobSetMetadataHeaders
>;

Contains response data for the setMetadata operation.

type BlobSetTagsResponse

type BlobSetTagsResponse = WithResponse<BlobSetTagsHeaders, BlobSetTagsHeaders>;

Contains response data for the setTags operation.

type BlobSetTierResponse

type BlobSetTierResponse = WithResponse<BlobSetTierHeaders, BlobSetTierHeaders>;

Contains response data for the setTier operation.

type BlobStartCopyFromURLResponse

type BlobStartCopyFromURLResponse = WithResponse<
    BlobStartCopyFromURLHeaders,
    BlobStartCopyFromURLHeaders
>;

Contains response data for the startCopyFromURL operation.

type BlobType

type BlobType = 'BlockBlob' | 'PageBlob' | 'AppendBlob';

Defines values for BlobType.

type BlobUndeleteResponse

type BlobUndeleteResponse = WithResponse<BlobUndeleteHeaders, BlobUndeleteHeaders>;

Contains response data for the undelete operation.

type BlobUploadCommonResponse

type BlobUploadCommonResponse = WithResponse<BlockBlobUploadHeaders>;

Response type for BlockBlobClient.uploadFile, BlockBlobClient.uploadStream, and BlockBlobClient.uploadBrowserDate.

type BlockBlobCommitBlockListResponse

type BlockBlobCommitBlockListResponse = WithResponse<
    BlockBlobCommitBlockListHeaders,
    BlockBlobCommitBlockListHeaders
>;

Contains response data for the commitBlockList operation.

type BlockBlobGetBlockListResponse

type BlockBlobGetBlockListResponse = WithResponse<
    BlockBlobGetBlockListResponseInternal,
    BlockBlobGetBlockListHeaders
>;

Contains response data for the getBlockList operation.

type BlockBlobGetBlockListResponseInternal

type BlockBlobGetBlockListResponseInternal = BlockBlobGetBlockListHeaders &
    BlockList;

Contains response data for the getBlockList operation.

type BlockBlobPutBlobFromUrlResponse

type BlockBlobPutBlobFromUrlResponse = WithResponse<
    BlockBlobPutBlobFromUrlHeaders,
    BlockBlobPutBlobFromUrlHeaders
>;

Contains response data for the putBlobFromUrl operation.

type BlockBlobStageBlockFromURLResponse

type BlockBlobStageBlockFromURLResponse = WithResponse<
    BlockBlobStageBlockFromURLHeaders,
    BlockBlobStageBlockFromURLHeaders
>;

Contains response data for the stageBlockFromURL operation.

type BlockBlobStageBlockResponse

type BlockBlobStageBlockResponse = WithResponse<
    BlockBlobStageBlockHeaders,
    BlockBlobStageBlockHeaders
>;

Contains response data for the stageBlock operation.

type BlockBlobUploadResponse

type BlockBlobUploadResponse = WithResponse<
    BlockBlobUploadHeaders,
    BlockBlobUploadHeaders
>;

Contains response data for the upload operation.

type BlockListType

type BlockListType = 'committed' | 'uncommitted' | 'all';

Defines values for BlockListType.

type ContainerCreateResponse

type ContainerCreateResponse = WithResponse<
    ContainerCreateHeaders,
    ContainerCreateHeaders
>;

Contains response data for the create operation.

type ContainerDeleteResponse

type ContainerDeleteResponse = WithResponse<
    ContainerDeleteHeaders,
    ContainerDeleteHeaders
>;

Contains response data for the delete operation.

type ContainerFilterBlobsResponse

type ContainerFilterBlobsResponse = ContainerFilterBlobsHeaders &
    FilterBlobSegmentModel;

Contains response data for the filterBlobs operation.

type ContainerFindBlobsByTagsSegmentResponse

type ContainerFindBlobsByTagsSegmentResponse = WithResponse<
    FilterBlobSegment & ContainerFilterBlobsHeaders,
    ContainerFilterBlobsHeaders,
    FilterBlobSegmentModel
>;

The response of BlobServiceClient.findBlobsByTags operation.

type ContainerGetAccessPolicyResponse

type ContainerGetAccessPolicyResponse = WithResponse<
    {
        signedIdentifiers: SignedIdentifier[];
    } & ContainerGetAccessPolicyHeaders,
    ContainerGetAccessPolicyHeaders,
    SignedIdentifierModel
>;

Contains response data for the ContainerClient.getAccessPolicy operation.

type ContainerGetAccessPolicyResponseModel

type ContainerGetAccessPolicyResponseModel = ContainerGetAccessPolicyHeaders &
    SignedIdentifierModel[];

Contains response data for the getAccessPolicy operation.

type ContainerGetAccountInfoResponse

type ContainerGetAccountInfoResponse = WithResponse<
    ContainerGetAccountInfoHeaders,
    ContainerGetAccountInfoHeaders
>;

Contains response data for the getAccountInfo operation.

type ContainerGetPropertiesResponse

type ContainerGetPropertiesResponse = WithResponse<
    ContainerGetPropertiesHeaders,
    ContainerGetPropertiesHeaders
>;

Contains response data for the getProperties operation.

type ContainerListBlobFlatSegmentResponse

type ContainerListBlobFlatSegmentResponse = WithResponse<
    ListBlobsFlatSegmentResponse & ContainerListBlobFlatSegmentHeaders,
    ContainerListBlobFlatSegmentHeaders,
    ListBlobsFlatSegmentResponseModel
>;

Contains response data for the listBlobFlatSegment operation.

type ContainerListBlobHierarchySegmentResponse

type ContainerListBlobHierarchySegmentResponse = WithResponse<
    ListBlobsHierarchySegmentResponse & ContainerListBlobHierarchySegmentHeaders,
    ContainerListBlobHierarchySegmentHeaders,
    ListBlobsHierarchySegmentResponseModel
>;

Contains response data for the listBlobHierarchySegment operation.

type ContainerRenameResponse

type ContainerRenameResponse = WithResponse<
    ContainerRenameHeaders,
    ContainerRenameHeaders
>;

Contains response data for the rename operation.

type ContainerSetAccessPolicyResponse

type ContainerSetAccessPolicyResponse = WithResponse<
    ContainerSetAccessPolicyHeaders,
    ContainerSetAccessPolicyHeaders
>;

Contains response data for the setAccessPolicy operation.

type ContainerSetMetadataResponse

type ContainerSetMetadataResponse = WithResponse<
    ContainerSetMetadataHeaders,
    ContainerSetMetadataHeaders
>;

Contains response data for the setMetadata operation.

type ContainerUndeleteResponse

type ContainerUndeleteResponse = WithResponse<
    ContainerUndeleteHeaders,
    ContainerUndeleteHeaders
>;

Contains response data for the restore operation.

type CopyPollerBlobClient

type CopyPollerBlobClient = Pick<
    BlobClient,
    'abortCopyFromURL' | 'getProperties'
> & {
    startCopyFromURL(
        copySource: string,
        options?: BlobStartCopyFromURLOptions
    ): Promise<BlobBeginCopyFromURLResponse>;
};

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

type CopyStatusType

type CopyStatusType = 'pending' | 'success' | 'aborted' | 'failed';

Defines values for CopyStatusType.

type CredentialPolicyCreator

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

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

type DeleteSnapshotsOptionType

type DeleteSnapshotsOptionType = 'include' | 'only';

Defines values for DeleteSnapshotsOptionType.

type EncryptionAlgorithmType

type EncryptionAlgorithmType = string;

Defines values for EncryptionAlgorithmType. \ KnownEncryptionAlgorithmType can be used interchangeably with EncryptionAlgorithmType, this enum contains the known values that the service supports. ### Known values supported by the service **AES256**

type GeoReplicationStatusType

type GeoReplicationStatusType = 'live' | 'bootstrap' | 'unavailable';

Defines values for GeoReplicationStatusType.

type LeaseDurationType

type LeaseDurationType = 'infinite' | 'fixed';

Defines values for LeaseDurationType.

type LeaseOperationResponse

type LeaseOperationResponse = WithResponse<Lease, Lease>;

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

type LeaseStateType

type LeaseStateType = 'available' | 'leased' | 'expired' | 'breaking' | 'broken';

Defines values for LeaseStateType.

type LeaseStatusType

type LeaseStatusType = 'locked' | 'unlocked';

Defines values for LeaseStatusType.

type ObjectReplicationStatus

type 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.

type PageBlobClearPagesResponse

type PageBlobClearPagesResponse = WithResponse<
    PageBlobClearPagesHeaders,
    PageBlobClearPagesHeaders
>;

Contains response data for the clearPages operation.

type PageBlobCopyIncrementalResponse

type PageBlobCopyIncrementalResponse = WithResponse<
    PageBlobCopyIncrementalHeaders,
    PageBlobCopyIncrementalHeaders
>;

Contains response data for the copyIncremental operation.

type PageBlobCreateResponse

type PageBlobCreateResponse = WithResponse<
    PageBlobCreateHeaders,
    PageBlobCreateHeaders
>;

Contains response data for the create operation.

type PageBlobGetPageRangesDiffResponseInternal

type PageBlobGetPageRangesDiffResponseInternal = PageBlobGetPageRangesDiffHeaders &
    PageListInternal;

Contains response data for the getPageRangesDiff operation.

type PageBlobGetPageRangesDiffResponseModel

type PageBlobGetPageRangesDiffResponseModel = WithResponse<
    PageBlobGetPageRangesDiffResponseInternal,
    PageBlobGetPageRangesDiffHeaders,
    PageListInternal
>;

Contains response data for the getPageRangesDiff operation.

type PageBlobGetPageRangesResponseInternal

type PageBlobGetPageRangesResponseInternal = PageBlobGetPageRangesHeaders &
    PageListInternal;

Contains response data for the getPageRanges operation.

type PageBlobGetPageRangesResponseModel

type PageBlobGetPageRangesResponseModel = WithResponse<
    PageBlobGetPageRangesResponseInternal,
    PageBlobGetPageRangesHeaders,
    PageListInternal
>;

Contains response data for the getPageRanges operation.

type PageBlobResizeResponse

type PageBlobResizeResponse = WithResponse<
    PageBlobResizeHeaders,
    PageBlobResizeHeaders
>;

Contains response data for the resize operation.

type PageBlobUpdateSequenceNumberResponse

type PageBlobUpdateSequenceNumberResponse = WithResponse<
    PageBlobUpdateSequenceNumberHeaders,
    PageBlobUpdateSequenceNumberHeaders
>;

Contains response data for the updateSequenceNumber operation.

type PageBlobUploadPagesFromURLResponse

type PageBlobUploadPagesFromURLResponse = WithResponse<
    PageBlobUploadPagesFromURLHeaders,
    PageBlobUploadPagesFromURLHeaders
>;

Contains response data for the uploadPagesFromURL operation.

type PageBlobUploadPagesResponse

type PageBlobUploadPagesResponse = WithResponse<
    PageBlobUploadPagesHeaders,
    PageBlobUploadPagesHeaders
>;

Contains response data for the uploadPages operation.

type PublicAccessType

type PublicAccessType = 'container' | 'blob';

Defines values for PublicAccessType.

type RehydratePriority

type RehydratePriority = 'High' | 'Standard';

Defines values for RehydratePriority.

type SequenceNumberActionType

type SequenceNumberActionType = 'max' | 'update' | 'increment';

Defines values for SequenceNumberActionType.

type ServiceFindBlobsByTagsSegmentResponse

type ServiceFindBlobsByTagsSegmentResponse = WithResponse<
    FilterBlobSegment & ServiceFilterBlobsHeaders,
    ServiceFilterBlobsHeaders,
    FilterBlobSegmentModel
>;

The response of BlobServiceClient.findBlobsByTags operation.

type ServiceGetAccountInfoResponse

type ServiceGetAccountInfoResponse = WithResponse<
    ServiceGetAccountInfoHeaders,
    ServiceGetAccountInfoHeaders
>;

Contains response data for the getAccountInfo operation.

type ServiceGetPropertiesResponse

type ServiceGetPropertiesResponse = WithResponse<
    ServiceGetPropertiesResponseInternal,
    ServiceGetPropertiesHeaders
>;

Contains response data for the getProperties operation.

type ServiceGetPropertiesResponseInternal

type ServiceGetPropertiesResponseInternal = ServiceGetPropertiesHeaders &
    BlobServiceProperties;

Contains response data for the getProperties operation.

type ServiceGetStatisticsResponse

type ServiceGetStatisticsResponse = WithResponse<
    ServiceGetStatisticsResponseInternal,
    ServiceGetStatisticsHeaders
>;

Contains response data for the getStatistics operation.

type ServiceGetStatisticsResponseInternal

type ServiceGetStatisticsResponseInternal = ServiceGetStatisticsHeaders &
    BlobServiceStatistics;

Contains response data for the getStatistics operation.

type ServiceGetUserDelegationKeyResponse

type ServiceGetUserDelegationKeyResponse = WithResponse<
    UserDelegationKey & ServiceGetUserDelegationKeyHeaders,
    ServiceGetUserDelegationKeyHeaders,
    UserDelegationKeyModel
>;

Contains response data for the getUserDelegationKey operation.

type ServiceListContainersSegmentResponse

type ServiceListContainersSegmentResponse = WithResponse<
    ServiceListContainersSegmentResponseInternal,
    ServiceListContainersSegmentHeaders
>;

Contains response data for the listContainersSegment operation.

type ServiceListContainersSegmentResponseInternal

type ServiceListContainersSegmentResponseInternal =
    ServiceListContainersSegmentHeaders & ListContainersSegmentResponse;

Contains response data for the listContainersSegment operation.

type ServiceSetPropertiesResponse

type ServiceSetPropertiesResponse = WithResponse<
    ServiceSetPropertiesHeaders,
    ServiceSetPropertiesHeaders
>;

Contains response data for the setProperties operation.

type ServiceSubmitBatchResponseInternal

type ServiceSubmitBatchResponseInternal = ServiceSubmitBatchHeaders & {
    /**
     * BROWSER ONLY
     *
     * The response body as a browser Blob.
     * Always `undefined` in node.js.
     */
    blobBody?: Promise<Blob>;
    /**
     * NODEJS ONLY
     *
     * The response body as a node.js Readable stream.
     * Always `undefined` in the browser.
     */
    readableStreamBody?: NodeJS.ReadableStream;
};

Contains response data for the submitBatch operation.

type ServiceSubmitBatchResponseModel

type ServiceSubmitBatchResponseModel = WithResponse<
    ServiceSubmitBatchResponseInternal,
    ServiceSubmitBatchHeaders
>;

Contains response data for the submitBatch operation.

type SkuName

type SkuName =
    | 'Standard_LRS'
    | 'Standard_GRS'
    | 'Standard_RAGRS'
    | 'Standard_ZRS'
    | 'Premium_LRS';

Defines values for SkuName.

type SyncCopyStatusType

type SyncCopyStatusType = 'success';

Defines values for SyncCopyStatusType.

type Tags

type Tags = Record<string, string>;

Blob tags.

type WithResponse

type WithResponse<T, Headers = undefined, Body = undefined> = T &
    (Body extends object
        ? ResponseWithBody<Headers, Body>
        : Headers extends object
        ? ResponseWithHeaders<Headers>
        : ResponseLike);

A type that represents an operation result with a known _response property.

Package Files (1)

types/latest/storage-blob.d.ts

Dependencies (13)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@azure/storage-blob.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@azure/storage-blob)

HTML

<a href="https://www.jsdocs.io/package/@azure/storage-blob"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 2 months ago.
Package analyzed in 18602 ms.
Missing or incorrect documentation? Open an issue for this package.

@azure/storage-blob

Install

Overview

Index

Variables

Functions

Classes

Interfaces

Enums

Type Aliases

Variables

variable logger

variable StorageOAuthScopes

Functions

function generateAccountSASQueryParameters

Parameter accountSASSignatureValues

Parameter sharedKeyCredential

See Also

function generateBlobSASQueryParameters

Parameter blobSASSignatureValues

Parameter sharedKeyCredential

Parameter blobSASSignatureValues

Parameter userDelegationKey

Parameter accountName

function getBlobServiceAccountAudience

function isPipelineLike

Parameter pipeline

Returns

function newPipeline

Parameter credential

Parameter pipelineOptions

Returns

Classes

class AccountSASPermissions

property add

property create

property delete

property deleteVersion

property filter

property list

property permanentDelete

property process

property read

property setImmutabilityPolicy

property tag

property update

property write

method from

Parameter permissionLike

method parse

Parameter permissions

method toString

See Also

class AccountSASResourceTypes

property container

property object

property service

method parse

Parameter resourceTypes

method toString

See Also

class AccountSASServices

property blob

property file

property queue

property table

method parse

Parameter services

method toString

class AnonymousCredential

method create

Parameter nextPolicy

Parameter options

class AnonymousCredentialPolicy

Parameter nextPolicy

Parameter options

class AppendBlobClient

Parameter connectionString

Parameter containerName

Parameter blobName