@azure/storage-blob package

Classes

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

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

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 <xref: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

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

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

AppendBlobClient

AppendBlobClient defines a set of operations applicable to append blobs.

BlobBatch

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

BlobBatchClient

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

BlobClient

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

BlobLeaseClient

A client that manages leases for a <xref:ContainerClient> or a <xref:BlobClient>.

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

BlobServiceClient

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

BlockBlobClient

BlockBlobClient defines a set of operations applicable to block blobs.

ContainerClient

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

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 <xref: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

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

CredentialPolicy

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

PageBlobClient

PageBlobClient defines a set of operations applicable to page blobs.

Pipeline

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

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 <xref:AccountSASSignatureValues> and <xref:BlobSASSignatureValues> types. Once generated, it can be encoded into a {@code 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.

StorageBrowserPolicy

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

StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.

StorageClient

A StorageClient represents a based URL class for <xref:BlobServiceClient>, <xref:ContainerClient> and etc.

StorageClientContext
StorageRetryPolicy

Retry policy with exponential retry and linear retry implemented.

StorageRetryPolicyFactory

StorageRetryPolicyFactory is a factory class helping generating <xref:StorageRetryPolicy> objects.

StorageSharedKeyCredential

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

StorageSharedKeyCredentialPolicy

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

Interfaces

AccessPolicy

An Access policy

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 <xref:generateAccountSASQueryParameters> to obtain a representation of the SAS which can actually be applied to blob urls. Note: that both this class and <xref:SASQueryParameters> exist because the former is mutable and a logical representation while the latter is immutable and used to generate actual REST requests.

AppendBlobAppendBlockFromURLOptions

Options to configure the <xref:AppendBlobClient.appendBlockFromURL> operation.

AppendBlobAppendBlockFromUrlHeaders

Defines headers for AppendBlockFromUrl operation.

AppendBlobAppendBlockHeaders

Defines headers for AppendBlock operation.

AppendBlobAppendBlockOptions

Options to configure the <xref:AppendBlobClient.appendBlock> operation.

AppendBlobCreateHeaders

Defines headers for Create operation.

AppendBlobCreateIfNotExistsOptions

Options to configure <xref:AppendBlobClient.createIfNotExists> operation.

AppendBlobCreateIfNotExistsResponse

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

AppendBlobCreateOptions

Options to configure <xref:AppendBlobClient.create> operation.

AppendBlobRequestConditions

Conditions to add to the creation of this append blob.

AppendPositionAccessConditions

Additional parameters for a set of operations, such as: AppendBlob_appendBlock, AppendBlob_appendBlockFromUrl, AppendBlob_seal.

BatchSubRequest

A request associated with a batch operation.

BatchSubResponse

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

BlobAbortCopyFromURLHeaders

Defines headers for AbortCopyFromURL operation.

BlobAbortCopyFromURLOptions

Options to configure the <xref:BlobClient.abortCopyFromURL> operation.

BlobAcquireLeaseOptions

Options to configure Blob - Acquire Lease operation.

BlobBatchSubmitBatchOptionalParams

Options to configure the Service - Submit Batch Optional Params.

BlobBeginCopyFromURLOptions

Options to configure the <xref:BlobClient.beginCopyFromURL> operation.

BlobBeginCopyFromURLResponse

Contains response data for the <xref:BlobClient.beginCopyFromURL> operation.

BlobBeginCopyFromUrlPollState

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

BlobBreakLeaseOptions

Options to configure Blob - Break Lease operation.

BlobChangeLeaseOptions

Options to configure Blob - Change Lease operation.

BlobCopyFromURLHeaders

Defines headers for CopyFromURL operation.

BlobCreateSnapshotHeaders

Defines headers for CreateSnapshot operation.

BlobCreateSnapshotOptions

Options to configure the <xref:BlobClient.createSnapshot> operation.

BlobDeleteHeaders

Defines headers for Delete operation.

BlobDeleteIfExistsResponse

Contains response data for the <xref:BlobClient.deleteIfExists> operation.

BlobDeleteOptions

Options to configure the <xref:BlobClient.delete> operation.

BlobDownloadHeaders

Defines headers for Download operation.

BlobDownloadOptionalParams

Optional Parameters.

BlobDownloadOptions

Options to configure the <xref:BlobClient.download> operation.

BlobDownloadToBufferOptions

Option interface for the <xref:BlobClient.downloadToBuffer> operation.

BlobExistsOptions

Options to configure the <xref:BlobClient.exists> operation.

BlobFlatListSegment

An interface representing BlobFlatListSegment.

BlobFlatListSegmentModel

An interface representing BlobFlatListSegment.

BlobGetPropertiesHeaders

Defines headers for GetProperties operation.

BlobGetPropertiesOptions

Options to configure the <xref:BlobClient.getProperties> operation.

BlobGetTagsHeaders

Defines headers for GetTags operation.

BlobGetTagsOptions

Options to configure the <xref:BlobClient.getTags> operation.

BlobHTTPHeaders

Additional parameters for a set of operations.

BlobHierarchyListSegment

An interface representing BlobHierarchyListSegment.

BlobHierarchyListSegmentModel

An interface representing BlobHierarchyListSegment.

BlobItem

An Azure Storage blob

BlobItemInternal

An Azure Storage blob

BlobPrefix

An interface representing BlobPrefix.

BlobProperties

Properties of a blob

BlobQueryCsvTextConfiguration

Options to query blob with CSV format.

BlobQueryError

Blob query error type.

BlobQueryHeaders

Defines headers for Query operation.

BlobQueryJsonTextConfiguration

Options to query blob with JSON format.

BlobQueryTextConfiguration

Base type for options to query blob.

BlobReleaseLeaseOptions

Options to configure Blob - Release Lease operation.

BlobRenewLeaseOptions

Options to configure Blob - Renew Lease operation.

BlobRequestConditions

Conditions to add to the creation of this blob.

BlobSASSignatureValues

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

BlobServiceProperties

Storage Service Properties.

BlobServiceStatistics

Stats for the storage service.

BlobSetHTTPHeadersHeaders

Defines headers for SetHTTPHeaders operation.

BlobSetHTTPHeadersOptions

Options to configure the <xref:BlobClient.setHTTPHeaders> operation.

BlobSetMetadataHeaders

Defines headers for SetMetadata operation.

BlobSetMetadataOptions

Options to configure the <xref:BlobClient.setMetadata> operation.

BlobSetTagsHeaders

Defines headers for SetTags operation.

BlobSetTagsOptions

Options to configure the <xref:BlobClient.setTags> operation.

BlobSetTierHeaders

Defines headers for SetTier operation.

BlobSetTierOptions

Options to configure the <xref:BlobClient.setAccessTier> operation.

BlobStartCopyFromURLHeaders

Defines headers for StartCopyFromURL operation.

BlobStartCopyFromURLOptions

Options to configure the <xref:BlobClient.beginCopyFromURL> operation.

BlobSyncCopyFromURLOptions

Options to configure the <xref:BlobClient.syncCopyFromURL> operation.

BlobTag

An interface representing BlobTag.

BlobTags

Blob tags

BlobUndeleteHeaders

Defines headers for Undelete operation.

BlobUndeleteOptions

Options to configure the <xref:BlobClient.undelete> operation.

Block

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

BlockBlobCommitBlockListHeaders

Defines headers for CommitBlockList operation.

BlockBlobCommitBlockListOptions

Options to configure <xref:BlockBlobClient.commitBlockList> operation.

BlockBlobGetBlockListHeaders

Defines headers for GetBlockList operation.

BlockBlobGetBlockListOptions

Options to configure <xref:BlockBlobClient.getBlockList> operation.

BlockBlobParallelUploadOptions

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

BlockBlobQueryOptions

Options to configure <xref:BlockBlobClient.query> operation.

BlockBlobStageBlockFromURLHeaders

Defines headers for StageBlockFromURL operation.

BlockBlobStageBlockFromURLOptions

Options to configure <xref:BlockBlobClient.stageBlockFromURL> operation.

BlockBlobStageBlockHeaders

Defines headers for StageBlock operation.

BlockBlobStageBlockOptions

Options to configure <xref:BlockBlobClient.stageBlock> operation.

BlockBlobUploadHeaders

Defines headers for Upload operation.

BlockBlobUploadOptions

Options to configure <xref:BlockBlobClient.upload> operation.

BlockBlobUploadStreamOptions

Option interface for the <xref:BlockBlobClient.uploadStream> operation.

BlockList

An interface representing BlockList.

CommonOptions

An interface for options common to every remote operation.

ContainerAcquireLeaseOptions

Options to configure Container - Acquire Lease operation.

ContainerBreakLeaseOptionalParams

Optional Parameters.

ContainerBreakLeaseOptions

Options to configure Container - Break Lease operation.

ContainerChangeLeaseOptions

Options to configure Container - Change Lease operation.

ContainerCreateHeaders

Defines headers for Create operation.

ContainerCreateIfNotExistsResponse

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

ContainerCreateOptions

Options to configure <xref:ContainerClient.create> operation.

ContainerDeleteBlobOptions

Options to configure the <xref:ContainerClient.deleteBlob> operation.

ContainerDeleteHeaders

Defines headers for Delete operation.

ContainerDeleteIfExistsResponse

Contains response data for the <xref:ContainerClient.deleteIfExists> operation.

ContainerDeleteMethodOptions

Options to configure <xref:ContainerClient.delete> operation.

ContainerEncryptionScope

Additional parameters for create operation.

ContainerExistsOptions

Options to configure <xref:ContainerClient.exists> operation.

ContainerGetAccessPolicyHeaders

Defines headers for GetAccessPolicy operation.

ContainerGetAccessPolicyOptions

Options to configure <xref:ContainerClient.getAccessPolicy> operation.

ContainerGetPropertiesHeaders

Defines headers for GetProperties operation.

ContainerGetPropertiesOptions

Options to configure <xref:ContainerClient.getProperties> operation.

ContainerItem

An Azure Storage container

ContainerListBlobFlatSegmentHeaders

Defines headers for ListBlobFlatSegment operation.

ContainerListBlobHierarchySegmentHeaders

Defines headers for ListBlobHierarchySegment operation.

ContainerListBlobsOptions

Options to configure Container - List Blobs operations. See:

  • <xref:ContainerClient.listBlobsFlat>
  • <xref:ContainerClient.listBlobsByHierarchy>
ContainerProperties

Properties of a container

ContainerReleaseLeaseOptions

Options to configure Container - Release Lease operation.

ContainerRenewLeaseOptions

Options to configure Container - Renew Lease operation.

ContainerSetAccessPolicyHeaders

Defines headers for SetAccessPolicy operation.

ContainerSetAccessPolicyOptions

Options to configure <xref:ContainerClient.setAccessPolicy> operation.

ContainerSetMetadataHeaders

Defines headers for SetMetadata operation.

ContainerSetMetadataOptions

Options to configure <xref:ContainerClient.setMetadata> operation.

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

CpkInfo

Additional parameters for a set of operations.

FilterBlobItem

Blob info from a Filter Blobs API call

FilterBlobSegment

The result of a Filter Blobs API call

GeoReplication

Geo-Replication information for the Secondary Storage Service

Lease

The details for a specific lease.

LeaseAccessConditions

Additional parameters for a set of operations.

LeaseOperationOptions

Configures lease operations.

ListBlobsFlatSegmentResponse

An enumeration of blobs

ListBlobsFlatSegmentResponseModel

An enumeration of blobs

ListBlobsHierarchySegmentResponse

An enumeration of blobs

ListBlobsHierarchySegmentResponseModel

An enumeration of blobs

ListContainersSegmentResponse

An enumeration of containers

Logging

Azure Analytics Logging settings.

Metadata

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

Metrics

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

ModifiedAccessConditions

Additional parameters for a set of operations.

PageBlobClearPagesHeaders

Defines headers for ClearPages operation.

PageBlobClearPagesOptions

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

PageBlobCopyIncrementalHeaders

Defines headers for CopyIncremental operation.

PageBlobCreateHeaders

Defines headers for Create operation.

PageBlobCreateIfNotExistsOptions

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

PageBlobCreateIfNotExistsResponse

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

PageBlobCreateOptions

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

PageBlobGetPageRangesDiffHeaders

Defines headers for GetPageRangesDiff operation.

PageBlobGetPageRangesDiffOptions

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

PageBlobGetPageRangesDiffResponse

Contains response data for the <xref:BlobClient.getPageRangesDiff> operation.

PageBlobGetPageRangesHeaders

Defines headers for GetPageRanges operation.

PageBlobGetPageRangesOptions

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

PageBlobGetPageRangesResponse

Contains response data for the <xref:BlobClient.getPageRanges> operation.

PageBlobRequestConditions

Conditions to add to the creation of this page blob.

PageBlobResizeHeaders

Defines headers for Resize operation.

PageBlobResizeOptions

Options to configure <xref:PageBlobClient.resize> operation.

PageBlobStartCopyIncrementalOptions

Options to configure <xref:PageBlobClient.startCopyIncremental> operation.

PageBlobUpdateSequenceNumberHeaders

Defines headers for UpdateSequenceNumber operation.

PageBlobUpdateSequenceNumberOptions

Options to configure <xref:PageBlobClient.updateSequenceNumber> operation.

PageBlobUploadPagesFromURLHeaders

Defines headers for UploadPagesFromURL operation.

PageBlobUploadPagesFromURLOptions

Options to configure <xref:PageBlobClient.uploadPagesFromURL> operation.

PageBlobUploadPagesHeaders

Defines headers for UploadPages operation.

PageBlobUploadPagesOptions

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

PageList

List of page ranges for a blob.

ParsedBatchResponse

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

PipelineOptions

Option interface for Pipeline constructor.

Range

Range for Blob Service Operations.

RetentionPolicy

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

SasIPRange

Allowed IP range for a SAS.

SequenceNumberAccessConditions

Additional parameters for a set of operations, such as: PageBlob_uploadPages, PageBlob_clearPages, PageBlob_uploadPagesFromURL.

ServiceFilterBlobsHeaders

Defines headers for FilterBlobs operation.

ServiceFindBlobByTagsOptions

Options to configure the <xref:BlobServiceClient.findBlobsByTags> operation.

ServiceGetAccountInfoHeaders

Defines headers for GetAccountInfo operation.

ServiceGetAccountInfoOptions

Options to configure the <xref:BlobServiceClient.getAccountInfo> operation.

ServiceGetPropertiesHeaders

Defines headers for GetProperties operation.

ServiceGetPropertiesOptions

Options to configure the <xref:BlobServiceClient.getProperties> operation.

ServiceGetStatisticsHeaders

Defines headers for GetStatistics operation.

ServiceGetStatisticsOptions

Options to configure the <xref:BlobServiceClient.getStatistics> operation.

ServiceGetUserDelegationKeyHeaders

Defines headers for GetUserDelegationKey operation.

ServiceGetUserDelegationKeyOptions

Options to configure the Service - Get User Delegation Key.

ServiceListContainersOptions

Options to configure the <xref:BlobServiceClient.listContainers> operation.

ServiceListContainersSegmentHeaders

Defines headers for ListContainersSegment operation.

ServiceSetPropertiesHeaders

Defines headers for SetProperties operation.

ServiceSetPropertiesOptions

Options to configure the <xref:BlobServiceClient.setProperties> operation.

ServiceSubmitBatchHeaders

Defines headers for SubmitBatch operation.

ServiceSubmitBatchOptionalParamsModel

Optional Parameters.

SignedIdentifier

Signed identifier.

SignedIdentifierModel

signed identifier

StaticWebsite

The properties that enable an account to host a static website

StoragePipelineOptions

Options interface for the <xref:newPipeline> function.

StorageRetryOptions

Storage Blob retry options interface.

UserDelegationKey

A user delegation key.

UserDelegationKeyModel

A user delegation key

Type Aliases

AccessTier

Defines values for AccessTier. Possible values include: 'P4', 'P6', 'P10', 'P15', 'P20', 'P30', 'P40', 'P50', 'P60', 'P70', 'P80', 'Hot', 'Cool', 'Archive'

AccountKind

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

AppendBlobAppendBlockFromUrlResponse

Contains response data for the appendBlockFromUrl operation.

AppendBlobAppendBlockResponse

Contains response data for the appendBlock operation.

AppendBlobCreateResponse

Contains response data for the create operation.

ArchiveStatus

Defines values for ArchiveStatus. Possible values include: 'rehydrate-pending-to-hot', 'rehydrate-pending-to-cool'

BlobAbortCopyFromURLResponse

Contains response data for the abortCopyFromURL operation.

BlobBatchDeleteBlobsResponse

Contains response data for the <xref:deleteBlobs> operation.

BlobBatchSetBlobsAccessTierResponse

Contains response data for the <xref:setBlobsAccessTier> operation.

BlobBatchSubmitBatchResponse

Contains response data for blob batch operations.

BlobCopyFromURLResponse

Contains response data for the copyFromURL operation.

BlobCreateSnapshotResponse

Contains response data for the createSnapshot operation.

BlobDeleteResponse

Contains response data for the deleteMethod operation.

BlobDownloadResponseModel

Contains response data for the download operation.

BlobGetPropertiesResponse

Contains response data for the getProperties operation.

BlobGetTagsResponse

Contains response data for the <xref:ContainerClient.getTags> operation.

BlobQueryResponseModel

Contains response data for the query operation.

BlobSetHTTPHeadersResponse

Contains response data for the setHTTPHeaders operation.

BlobSetMetadataResponse

Contains response data for the setMetadata operation.

BlobSetTagsResponse

Contains response data for the setTags operation.

BlobSetTierResponse

Contains response data for the setTier operation.

BlobStartCopyFromURLResponse

Contains response data for the startCopyFromURL operation.

BlobType

Defines values for BlobType. Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'

BlobUndeleteResponse

Contains response data for the undelete operation.

BlobUploadCommonResponse

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

BlockBlobCommitBlockListResponse

Contains response data for the commitBlockList operation.

BlockBlobGetBlockListResponse

Contains response data for the getBlockList operation.

BlockBlobStageBlockFromURLResponse

Contains response data for the stageBlockFromURL operation.

BlockBlobStageBlockResponse

Contains response data for the stageBlock operation.

BlockBlobUploadResponse

Contains response data for the upload operation.

BlockListType

Defines values for BlockListType. Possible values include: 'committed', 'uncommitted', 'all'

ContainerCreateResponse

Contains response data for the create operation.

ContainerDeleteResponse

Contains response data for the deleteMethod operation.

ContainerGetAccessPolicyResponse

Contains response data for the <xref:ContainerClient.getAccessPolicy> operation.

ContainerGetPropertiesResponse

Contains response data for the getProperties operation.

ContainerListBlobFlatSegmentResponse

Contains response data for the listBlobFlatSegment operation.

ContainerListBlobHierarchySegmentResponse

Contains response data for the listBlobHierarchySegment operation.

ContainerSetAccessPolicyResponse

Contains response data for the setAccessPolicy operation.

ContainerSetMetadataResponse

Contains response data for the setMetadata operation.

CopyPollerBlobClient

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

CopyStatusType

Defines values for CopyStatusType. Possible values include: 'pending', 'success', 'aborted', 'failed'

CredentialPolicyCreator

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

DeleteSnapshotsOptionType

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

EncryptionAlgorithmType

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

GeoReplicationStatusType

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

LeaseDurationType

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

LeaseOperationResponse

Contains the response data for operations that create, modify, or delete a lease. See <xref:BlobLeaseClient>.

LeaseStateType

Defines values for LeaseStateType. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'

LeaseStatusType

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

ListBlobsIncludeItem

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

ListContainersIncludeType

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

PageBlobClearPagesResponse

Contains response data for the clearPages operation.

PageBlobCopyIncrementalResponse

Contains response data for the copyIncremental operation.

PageBlobCreateResponse

Contains response data for the create operation.

PageBlobResizeResponse

Contains response data for the resize operation.

PageBlobUpdateSequenceNumberResponse

Contains response data for the updateSequenceNumber operation.

PageBlobUploadPagesFromURLResponse

Contains response data for the uploadPagesFromURL operation.

PageBlobUploadPagesResponse

Contains response data for the uploadPages operation.

PublicAccessType

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

RehydratePriority

Defines values for RehydratePriority. Possible values include: 'High', 'Standard'

SequenceNumberActionType

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

ServiceFindBlobsByTagsSegmentResponse

Contains response data for the filterBlobs operation.

ServiceGetAccountInfoResponse

Contains response data for the getAccountInfo operation.

ServiceGetPropertiesResponse

Contains response data for the getProperties operation.

ServiceGetStatisticsResponse

Contains response data for the getStatistics operation.

ServiceGetUserDelegationKeyResponse

Contains response data for the <xref:getUserDelegationKey> operation.

ServiceListContainersSegmentResponse

Contains response data for the listContainersSegment operation.

ServiceSetPropertiesResponse

Contains response data for the setProperties operation.

ServiceSubmitBatchResponseModel

Contains response data for the submitBatch operation.

SkuName

Defines values for SkuName. Possible values include: 'Standard_LRS', 'Standard_GRS', 'Standard_RAGRS', 'Standard_ZRS', 'Premium_LRS'

SyncCopyStatusType

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

Tags

Blob tags.

Enums

BlockBlobTier

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

PremiumPageBlobTier

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.

SASProtocol

Protocols for generated SAS.

StorageRetryPolicyType

RetryPolicy types.

Functions

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ONLY AVAILABLE IN NODE.JS RUNTIME. Generates a <xref:SASQueryParameters> object which contains all SAS query parameters needed to make an actual REST request.

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

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(), // Required
    expiresOn: new Date(new Date().valueOf() + 86400), // Optional. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Example using an identifier:

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

const containerSAS = generateBlobSASQueryParameters( { containerName, // Required identifier // Required }, sharedKeyCredential // StorageSharedKeyCredential - new StorageSharedKeyCredential(account, accountKey) ).toString();

Example using a blob name:

// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
    containerName, // Required
    blobName, // Required
    permissions: BlobSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Required
    expiresOn: new Date(new Date().valueOf() + 86400), // Optional. 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();
generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)

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, // Required. Date type
    expiresOn, // Optional. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must >= 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Creates a new Pipeline object with Credential provided.

Function Details

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

ONLY AVAILABLE IN NODE.JS RUNTIME. Generates a <xref:SASQueryParameters> object which contains all SAS query parameters needed to make an actual REST request.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parameters

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Returns

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

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(), // Required
    expiresOn: new Date(new Date().valueOf() + 86400), // Optional. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

Example using an identifier:

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

const containerSAS = generateBlobSASQueryParameters( { containerName, // Required identifier // Required }, sharedKeyCredential // StorageSharedKeyCredential - new StorageSharedKeyCredential(account, accountKey) ).toString();

Example using a blob name:

// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
    containerName, // Required
    blobName, // Required
    permissions: BlobSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Required
    expiresOn: new Date(new Date().valueOf() + 86400), // Optional. 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();
function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parameters

blobSASSignatureValues
BlobSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Returns

generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)

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, // Required. Date type
    expiresOn, // Optional. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must >= 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();
function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string)

Parameters

blobSASSignatureValues
BlobSASSignatureValues
userDelegationKey
UserDelegationKey

Return value of blobServiceClient.getUserDelegationKey()

accountName
string

Returns

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Creates a new Pipeline object with Credential provided.

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

Parameters

credential
AnonymousCredential | TokenCredential

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

pipelineOptions
StoragePipelineOptions

Returns

A new Pipeline object.