@azure/storage-blob package

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.

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.

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.

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

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

AppendBlobClient defines a set of operations applicable to append blobs.

The base class from which all request policies derive.

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

A BlobBatchClient allows you to make batched requests to the Azure Storage Blob service.

See https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch

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

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

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.

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

BlockBlobClient defines a set of operations applicable to block blobs.

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

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.

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

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

PageBlobClient defines a set of operations applicable to page blobs.

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.

A custom error type for failed pipeline requests.

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

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

StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.

Retry policy with exponential retry and linear retry implemented.

StorageRetryPolicyFactory is a factory class helping generating StorageRetryPolicy objects.

ONLY AVAILABLE IN NODE.JS RUNTIME.

StorageSharedKeyCredential for account key authorization of Azure Storage service.

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

An Access policy

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

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 https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 for more conceptual information on SAS See https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas for descriptions of the parameters, including which are required

Options to configure the appendBlockFromURL operation.

Defines headers for AppendBlob_appendBlockFromUrl operation.

Defines headers for AppendBlob_appendBlock operation.

Options to configure the appendBlock operation.

Defines headers for AppendBlob_create operation.

Options to configure createIfNotExists operation.

Contains response data for the <xref:appendBlobClient.createIfNotExists> operation.

Options to configure create operation.

Conditions to add to the creation of this append blob.

Options to configure seal operation.

Parameter group

A request associated with a batch operation.

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

Defines headers for Blob_abortCopyFromURL operation.

Options to configure the abortCopyFromURL operation.

Options to configure Blob - Acquire Lease operation.

Options to configure the Service - Submit Batch Optional Params.

Options to configure the beginCopyFromURL operation.

Contains response data for the beginCopyFromURL operation.

The state used by the poller returned from beginCopyFromURL.

This state is passed into the user-specified onProgress callback whenever copy progress is detected.

Options to configure Blob - Break Lease operation.

Options to configure Blob - Change Lease operation.

Defines headers for Blob_copyFromURL operation.

Defines headers for Blob_createSnapshot operation.

Options to configure the createSnapshot operation.

Defines headers for Blob_delete operation.

Contains response data for the deleteIfExists operation.

Defines headers for Blob_deleteImmutabilityPolicy operation.

Options for deleting immutability policy deleteImmutabilityPolicy operation.

Options to configure the delete operation.

Defines headers for Blob_download operation.

Optional parameters.

Options to configure the download operation.

Contains response data for the download operation.

Option interface for the downloadToBuffer operation.

Options to configure the exists operation.

An interface representing BlobFlatListSegment.

Options to configure generateSasUrl operation.

Defines headers for Blob_getAccountInfo operation.

Options to configure the getAccountInfo operation.

Defines headers for Blob_getProperties operation.

Options to configure the getProperties operation.

Contains response data for the getProperties operation.

Defines headers for Blob_getTags operation.

Options to configure the getTags operation.

Parameter group

An interface representing BlobHierarchyListSegment.

Describe immutable policy for blob.

An Azure Storage blob

An Azure Storage blob

Properties of a blob

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

Describe a field in BlobQueryArrowConfiguration.

Options to query blob with CSV format.

Blob query error type.

Defines headers for Blob_query operation.

Options to query blob with JSON format.

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

Options to configure Blob - Release Lease operation.

Options to configure Blob - Renew Lease operation.

standard HTTP conditional headers, tags condition and lease condition

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

ONLY AVAILABLE IN NODE.JS RUNTIME.

BlobSASSignatureValues is used to help generating Blob service SAS tokens for containers or blobs.

Storage Service Properties.

Stats for the storage service.

Defines headers for Blob_setHttpHeaders operation.

Options to configure the setHTTPHeaders operation.

Defines headers for Blob_setImmutabilityPolicy operation.

Options for setting immutability policy setImmutabilityPolicy operation.

Defines headers for Blob_setLegalHold operation.

Options for setting legal hold setLegalHold operation.

Defines headers for Blob_setMetadata operation.

Options to configure the setMetadata operation.

Defines headers for Blob_setTags operation.

Options to configure the setTags operation.

Defines headers for Blob_setTier operation.

Options to configure the setAccessTier operation.

Defines headers for Blob_startCopyFromURL operation.

Options to configure the beginCopyFromURL operation.

Options to configure the syncCopyFromURL operation.

Blob tags

Defines headers for Blob_undelete operation.

Options to configure the undelete operation.

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

Defines headers for BlockBlob_commitBlockList operation.

Options to configure commitBlockList operation.

Defines headers for BlockBlob_getBlockList operation.

Options to configure getBlockList operation.

Option interface for uploadFile and <xref:BlockBlobClient.uploadSeekableStream>.

Defines headers for BlockBlob_putBlobFromUrl operation.

Options to configure query operation.

Defines headers for BlockBlob_stageBlockFromURL operation.

Options to configure stageBlockFromURL operation.

Defines headers for BlockBlob_stageBlock operation.

Options to configure stageBlock operation.

Options to configure syncUploadFromURL operation.

Defines headers for BlockBlob_upload operation.

Options to configure upload operation.

Option interface for the uploadStream operation.

Common options of BlobGenerateSasUrlOptions and ContainerGenerateSasUrlOptions.

An interface for options common to every remote operation.

Options to configure Container - Acquire Lease operation.

Optional parameters.

Options to configure Container - Break Lease operation.

Options to configure Container - Change Lease operation.

Defines headers for Container_create operation.

Contains response data for the createIfNotExists operation.

Options to configure create operation.

Options to configure the deleteBlob operation.

Defines headers for Container_delete operation.

Contains response data for the deleteIfExists operation.

Options to configure delete operation.

Parameter group

Options to configure exists operation.

Defines headers for Container_filterBlobs operation.

Options to configure the findBlobsByTags operation.

Options to configure generateSasUrl operation.

Defines headers for Container_getAccessPolicy operation.

Options to configure getAccessPolicy operation.

Defines headers for Container_getAccountInfo operation.

Options to configure the getAccountInfo operation.

Defines headers for Container_getProperties operation.

Options to configure getProperties operation.

An Azure Storage container

Defines headers for Container_listBlobFlatSegment operation.

Defines headers for Container_listBlobHierarchySegment operation.

Options to configure Container - List Blobs operations.

See:

• listBlobsFlat
• listBlobsByHierarchy

Properties of a container

Options to configure Container - Release Lease operation.

Defines headers for Container_rename operation.

Options to configure Container - Renew Lease operation.

Conditions to meet for the container.

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

Defines headers for Container_setAccessPolicy operation.

Options to configure setAccessPolicy operation.

Defines headers for Container_setMetadata operation.

Options to configure setMetadata operation.

Defines headers for Container_restore operation.

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

Parameter group

Blob info from a findBlobsByTags

Blob info from a Filter Blobs API call

Segment response of findBlobsByTags operation.

The result of a Filter Blobs API call

Geo-Replication information for the Secondary Storage Service

Represents authentication information in Authorization, ProxyAuthorization, WWW-Authenticate, and Proxy-Authenticate header values.

A collection of HTTP header key/value pairs.

Http Response that is compatible with the core-v1(core-http).

A representation of an HTTP response that includes a reference to the request that originated it.

A compatible interface for core-http request policies

The details for a specific lease.

Parameter group

Configures lease operations.

An enumeration of blobs

An enumeration of blobs

An enumeration of blobs

An enumeration of blobs

An enumeration of containers

Azure Analytics Logging settings.

Specifies HTTP options for conditional requests based on ETag matching.

A map of name-value pairs to associate with the resource.

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

Specifies HTTP options for conditional requests based on modification time.

standard HTTP conditional headers and tags condition.

Parameter group

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. <xref:BlobProperties.ObjectReplicationDestinationPolicyId>.

Contains the Object Replication Rule ID and ObjectReplicationStatus of a blob. There can be more than one ObjectReplicationRule under a ObjectReplicationPolicy.

Defines headers for PageBlob_clearPages operation.

Options to configure the clearPages operation.

Defines headers for PageBlob_copyIncremental operation.

Defines headers for PageBlob_create operation.

Options to configure the createIfNotExists operation.

Contains response data for the createIfNotExists operation.

Options to configure the create operation.

Defines headers for PageBlob_getPageRangesDiff operation.

Options to configure the <xref:PageBlobClient.getRangesDiff> operation.

Contains response data for the getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions) operation.

Defines headers for PageBlob_getPageRanges operation.

Options to configure the getPageRanges operation.

Contains response data for the getPageRanges(number, number, PageBlobGetPageRangesOptions) operation.

Options to configure the listPageRangesDiff operation.

Options to configure the listPageRanges operation.

Conditions to add to the creation of this page blob.

Defines headers for PageBlob_resize operation.

Options to configure resize operation.

Options to configure startCopyIncremental operation.

Defines headers for PageBlob_updateSequenceNumber operation.

Options to configure updateSequenceNumber operation.

Defines headers for PageBlob_uploadPagesFromURL operation.

Options to configure uploadPagesFromURL operation.

Defines headers for PageBlob_uploadPages operation.

Options to configure the uploadPages operation.

List of page ranges for a blob.

the list of pages

The multipart/mixed response which contains the response for each subrequest.

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.

Option interface for Pipeline constructor.

PollOperationState contains an opinionated list of the smallest set of properties needed to define any long running operation poller.

While the Poller class works as the local control mechanism to start triggering, wait for, and potentially cancel a long running operation, the PollOperationState documents the status of the remote long running operation.

It should be updated at least when the operation starts, when it's finished, and when it's cancelled. Though, implementations can have any other number of properties that can be updated by other reasons.

Abstract representation of a poller, intended to expose just the minimal API that the user needs to work with.

Abstract representation of a poller, intended to expose just the minimal API that the user needs to work with.

Range for Blob Service Operations.

See https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations

An interface for compatibility with core-http's RequestPolicyFactory

An interface for compatibility with RequestPolicy

An object with a simple _response property.

An object with a _response property that has body and headers already parsed into known types.

An object with a _response property that has headers already parsed into a typed object.

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

Options to construct SASQueryParameters.

Allowed IP range for a SAS.

Parameter group

A subset of @azure/core-http ServiceClientOptions

Defines headers for Service_filterBlobs operation.

Options to configure the findBlobsByTags operation.

Options to configure generateAccountSasUrl operation.

Defines headers for Service_getAccountInfo operation.

Options to configure the getAccountInfo operation.

Defines headers for Service_getProperties operation.

Options to configure the getProperties operation.

Defines headers for Service_getStatistics operation.

Options to configure the getStatistics operation.

Defines headers for Service_getUserDelegationKey operation.

Options to configure the Service - Get User Delegation Key.

Options to configure the listContainers operation.

Defines headers for Service_listContainersSegment operation.

Options to configure <xref:BlobServiceClient.renameContainer> operation.

Defines headers for Service_setProperties operation.

Options to configure the setProperties operation.

Defines headers for Service_submitBatch operation.

Optional parameters.

Options to configure undeleteContainer operation.

Signed identifier.

signed identifier

The properties that enable an account to host a static website

Options interface for the newPipeline function.

Storage Blob retry options interface.

Specifies HTTP options for conditional requests based on blob tags.

A user delegation key.

A user delegation key

A description of a HTTP request to be made to a remote server.

Defines values for AccessTier.

Defines values for AccountKind.

Contains response data for the appendBlockFromUrl operation.

Contains response data for the appendBlock operation.

Contains response data for the create operation.

Defines values for ArchiveStatus.

Contains response data for the abortCopyFromURL operation.

Contains response data for the deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions) operation.

Contains response data for the setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions) operation.

Contains response data for blob batch operations.

Contains response data for the copyFromURL operation.

Defines values for BlobCopySourceTags.

Contains response data for the createSnapshot operation.

Contains response data for the deleteImmutabilityPolicy operation.

Contains response data for the delete operation.

Contains response data for the download operation.

Contains response data for the download operation.

Contains response data for the getAccountInfo operation.

Contains response data for the getProperties operation.

Contains response data for the getTags operation.

Defines values for BlobImmutabilityPolicyMode.

The type of a BlobQueryArrowField.

Contains response data for the query operation.

Contains response data for the query operation.

Contains response data for the setHttpHeaders operation.

Contains response data for the setImmutabilityPolicy operation.

Contains response data for the setLegalHold operation.

Contains response data for the setMetadata operation.

Contains response data for the setTags operation.

Contains response data for the setTier operation.

Contains response data for the startCopyFromURL operation.

Defines values for BlobType.

Contains response data for the undelete operation.

Response type for uploadFile, uploadStream, and <xref:BlockBlobClient.uploadBrowserDate>.

Contains response data for the commitBlockList operation.

Contains response data for the getBlockList operation.

Contains response data for the getBlockList operation.

Contains response data for the putBlobFromUrl operation.

Contains response data for the stageBlockFromURL operation.

Contains response data for the stageBlock operation.

Contains response data for the upload operation.

Defines values for BlockListType.

Contains response data for the create operation.

Contains response data for the delete operation.

Contains response data for the filterBlobs operation.

The response of findBlobsByTags operation.

Contains response data for the getAccessPolicy operation.

Contains response data for the getAccessPolicy operation.

Contains response data for the getAccountInfo operation.

Contains response data for the getProperties operation.

Contains response data for the listBlobFlatSegment operation.

Contains response data for the listBlobHierarchySegment operation.

Contains response data for the rename operation.

Contains response data for the setAccessPolicy operation.

Contains response data for the setMetadata operation.

Contains response data for the restore operation.

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

Defines values for CopyStatusType.

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

Defines values for DeleteSnapshotsOptionType.

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

Defines values for GeoReplicationStatusType.

Types of bodies supported on the request. NodeJS.ReadableStream and () => NodeJS.ReadableStream is Node only. Blob, ReadableStream, and () => ReadableStream are browser only.

Defines values for LeaseDurationType.

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

See BlobLeaseClient.

Defines values for LeaseStateType.

Defines values for LeaseStatusType.

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

Contains response data for the clearPages operation.

Contains response data for the copyIncremental operation.

Contains response data for the create operation.

Contains response data for the getPageRangesDiff operation.

Contains response data for the getPageRangesDiff operation.

Contains response data for the getPageRanges operation.

Contains response data for the getPageRanges operation.

Contains response data for the resize operation.

Contains response data for the updateSequenceNumber operation.

Contains response data for the uploadPagesFromURL operation.

Contains response data for the uploadPages operation.

Defines values for PublicAccessType.

Defines values for RehydratePriority.

Defines values for SequenceNumberActionType.

The response of findBlobsByTags operation.

Contains response data for the getAccountInfo operation.

Contains response data for the getProperties operation.

Contains response data for the getProperties operation.

Contains response data for the getStatistics operation.

Contains response data for the getStatistics operation.

Contains response data for the getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions) operation.

Contains response data for the listContainersSegment operation.

Contains response data for the listContainersSegment operation.

Contains response data for the setProperties operation.

Contains response data for the submitBatch operation.

Contains response data for the submitBatch operation.

Defines values for SkuName.

Defines values for SyncCopyStatusType.

Blob tags.

A type that represents an operation result with a known _response property.

Represents the access tier on a blob. For detailed information about block blob level tiering see Hot, cool and archive storage tiers.

Known values of EncryptionAlgorithmType that the service accepts.

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.

Protocols for generated SAS.

Defines the known cloud audiences for Storage.

RetryPolicy types.

ONLY AVAILABLE IN NODE.JS RUNTIME.

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

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

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

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

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

A helper to decide if a given argument satisfies the Pipeline contract

Creates a new Pipeline object with Credential provided.