@azure/storage-blob package

Reference

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 <xref: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: 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. Remove cookie header for security 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
AccountSASPermissionsLike	A type that looks like an account SAS permission. Used in <xref:AccountSASPermissions> to parse SAS permissions from raw objects.
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 AppendBlob_appendBlockFromUrl operation.
AppendBlobAppendBlockHeaders	Defines headers for AppendBlob_appendBlock operation.
AppendBlobAppendBlockOptions	Options to configure the <xref:AppendBlobClient.appendBlock> operation.
AppendBlobCreateHeaders	Defines headers for AppendBlob_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.
AppendBlobSealOptions	Options to configure <xref:AppendBlobClient.seal> operation.
AppendPositionAccessConditions	Parameter group
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 Blob_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 Blob_copyFromURL operation.
BlobCreateSnapshotHeaders	Defines headers for Blob_createSnapshot operation.
BlobCreateSnapshotOptions	Options to configure the <xref:BlobClient.createSnapshot> operation.
BlobDeleteHeaders	Defines headers for Blob_delete operation.
BlobDeleteIfExistsResponse	Contains response data for the <xref:BlobClient.deleteIfExists> operation.
BlobDeleteImmutabilityPolicyHeaders	Defines headers for Blob_deleteImmutabilityPolicy operation.
BlobDeleteImmutabilityPolicyOptions	Options for deleting immutability policy <xref:BlobClient.deleteImmutabilityPolicy> operation.
BlobDeleteOptions	Options to configure the <xref:BlobClient.delete> operation.
BlobDownloadHeaders	Defines headers for Blob_download operation.
BlobDownloadOptionalParams	Optional parameters.
BlobDownloadOptions	Options to configure the <xref:BlobClient.download> operation.
BlobDownloadResponseParsed	Contains response data for 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
BlobGenerateSasUrlOptions	Options to configure <xref:BlobClient.generateSasUrl> operation.
BlobGetPropertiesHeaders	Defines headers for Blob_getProperties operation.
BlobGetPropertiesOptions	Options to configure the <xref:BlobClient.getProperties> operation.
BlobGetPropertiesResponse	Contains response data for the <xref:BlobClient.getProperties> operation.
BlobGetTagsHeaders	Defines headers for Blob_getTags operation.
BlobGetTagsOptions	Options to configure the <xref:BlobClient.getTags> operation.
BlobHTTPHeaders	Parameter group
BlobHierarchyListSegment	An interface representing BlobHierarchyListSegment.
BlobHierarchyListSegmentModel
BlobImmutabilityPolicy	Describe immutable policy for blob.
BlobItem	An Azure Storage blob
BlobItemInternal	An Azure Storage blob
BlobPrefix
BlobProperties	Properties of a blob
BlobQueryArrowConfiguration	Options to query blob with Apache Arrow format. Only valid for <xref:BlockBlobQueryOptions.outputTextConfiguration>.
BlobQueryArrowField	Describe a field in <xref:BlobQueryArrowConfiguration>.
BlobQueryCsvTextConfiguration	Options to query blob with CSV format.
BlobQueryError	Blob query error type.
BlobQueryHeaders	Defines headers for Blob_query operation.
BlobQueryJsonTextConfiguration	Options to query blob with JSON format.
BlobQueryParquetConfiguration	Options to query blob with Parquet format. Only valid for <xref:BlockBlobQueryOptions.inputTextConfiguration>.
BlobReleaseLeaseOptions	Options to configure Blob - Release Lease operation.
BlobRenewLeaseOptions	Options to configure Blob - Renew Lease operation.
BlobRequestConditions	standard HTTP conditional headers, tags condition and lease condition
BlobSASPermissionsLike	A type that looks like a Blob SAS permission. Used in <xref:BlobSASPermissions> to parse SAS permissions from raw objects.
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 Blob_setHttpHeaders operation.
BlobSetHTTPHeadersOptions	Options to configure the <xref:BlobClient.setHTTPHeaders> operation.
BlobSetImmutabilityPolicyHeaders	Defines headers for Blob_setImmutabilityPolicy operation.
BlobSetImmutabilityPolicyOptions	Options for setting immutability policy <xref:BlobClient.setImmutabilityPolicy> operation.
BlobSetLegalHoldHeaders	Defines headers for Blob_setLegalHold operation.
BlobSetLegalHoldOptions	Options for setting legal hold <xref:BlobClient.setLegalHold> operation.
BlobSetMetadataHeaders	Defines headers for Blob_setMetadata operation.
BlobSetMetadataOptions	Options to configure the <xref:BlobClient.setMetadata> operation.
BlobSetTagsHeaders	Defines headers for Blob_setTags operation.
BlobSetTagsOptions	Options to configure the <xref:BlobClient.setTags> operation.
BlobSetTierHeaders	Defines headers for Blob_setTier operation.
BlobSetTierOptions	Options to configure the <xref:BlobClient.setAccessTier> operation.
BlobStartCopyFromURLHeaders	Defines headers for Blob_startCopyFromURL operation.
BlobStartCopyFromURLOptions	Options to configure the <xref:BlobClient.beginCopyFromURL> operation.
BlobSyncCopyFromURLOptions	Options to configure the <xref:BlobClient.syncCopyFromURL> operation.
BlobTag
BlobTags	Blob tags
BlobUndeleteHeaders	Defines headers for Blob_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 BlockBlob_commitBlockList operation.
BlockBlobCommitBlockListOptions	Options to configure <xref:BlockBlobClient.commitBlockList> operation.
BlockBlobGetBlockListHeaders	Defines headers for BlockBlob_getBlockList operation.
BlockBlobGetBlockListOptions	Options to configure <xref:BlockBlobClient.getBlockList> operation.
BlockBlobParallelUploadOptions	Option interface for <xref:BlockBlobClient.uploadFile> and <xref:BlockBlobClient.uploadSeekableStream>.
BlockBlobPutBlobFromUrlHeaders	Defines headers for BlockBlob_putBlobFromUrl operation.
BlockBlobQueryOptions	Options to configure <xref:BlockBlobClient.query> operation.
BlockBlobStageBlockFromURLHeaders	Defines headers for BlockBlob_stageBlockFromURL operation.
BlockBlobStageBlockFromURLOptions	Options to configure <xref:BlockBlobClient.stageBlockFromURL> operation.
BlockBlobStageBlockHeaders	Defines headers for BlockBlob_stageBlock operation.
BlockBlobStageBlockOptions	Options to configure <xref:BlockBlobClient.stageBlock> operation.
BlockBlobSyncUploadFromURLOptions	Options to configure <xref:BlockBlobClient.syncUploadFromURL> operation.
BlockBlobUploadHeaders	Defines headers for BlockBlob_upload operation.
BlockBlobUploadOptions	Options to configure <xref:BlockBlobClient.upload> operation.
BlockBlobUploadStreamOptions	Option interface for the <xref:BlockBlobClient.uploadStream> operation.
BlockList
CommonGenerateSasUrlOptions	Common options of <xref:BlobGenerateSasUrlOptions> and <xref:ContainerGenerateSasUrlOptions>.
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 Container_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 Container_delete operation.
ContainerDeleteIfExistsResponse	Contains response data for the <xref:ContainerClient.deleteIfExists> operation.
ContainerDeleteMethodOptions	Options to configure <xref:ContainerClient.delete> operation.
ContainerEncryptionScope	Parameter group
ContainerExistsOptions	Options to configure <xref:ContainerClient.exists> operation.
ContainerGenerateSasUrlOptions	Options to configure <xref:ContainerClient.generateSasUrl> operation.
ContainerGetAccessPolicyHeaders	Defines headers for Container_getAccessPolicy operation.
ContainerGetAccessPolicyOptions	Options to configure <xref:ContainerClient.getAccessPolicy> operation.
ContainerGetPropertiesHeaders	Defines headers for Container_getProperties operation.
ContainerGetPropertiesOptions	Options to configure <xref:ContainerClient.getProperties> operation.
ContainerItem	An Azure Storage container
ContainerListBlobFlatSegmentHeaders	Defines headers for Container_listBlobFlatSegment operation.
ContainerListBlobHierarchySegmentHeaders	Defines headers for Container_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.
ContainerRenameHeaders	Defines headers for Container_rename operation.
ContainerRenewLeaseOptions	Options to configure Container - Renew Lease operation.
ContainerRequestConditions	Conditions to meet for the container.
ContainerSASPermissionsLike	A type that looks like a Container SAS permission. Used in <xref:ContainerSASPermissions> to parse SAS permissions from raw objects.
ContainerSetAccessPolicyHeaders	Defines headers for Container_setAccessPolicy operation.
ContainerSetAccessPolicyOptions	Options to configure <xref:ContainerClient.setAccessPolicy> operation.
ContainerSetMetadataHeaders	Defines headers for Container_setMetadata operation.
ContainerSetMetadataOptions	Options to configure <xref:ContainerClient.setMetadata> operation.
ContainerUndeleteHeaders	Defines headers for Container_restore 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	Parameter group
FilterBlobItem	Blob info from a <xref:BlobServiceClient.findBlobsByTags>
FilterBlobItemModel	Blob info from a Filter Blobs API call
FilterBlobSegment	Segment response of <xref:BlobServiceClient.findBlobsByTags> operation.
FilterBlobSegmentModel	The result of a Filter Blobs API call
GeoReplication	Geo-Replication information for the Secondary Storage Service
HttpAuthorization	Represents authentication information in Authorization, ProxyAuthorization, WWW-Authenticate, and Proxy-Authenticate header values.
Lease	The details for a specific lease.
LeaseAccessConditions	Parameter group
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.
MatchConditions	Specifies HTTP options for conditional requests based on ETag matching.
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
ModificationConditions	Specifies HTTP options for conditional requests based on modification time.
ModifiedAccessConditions	standard HTTP conditional headers and tags condition.
ModifiedAccessConditionsModel	Parameter group
ObjectReplicationPolicy	Contains Object Replication Policy ID and the respective list of <xref: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>.
ObjectReplicationRule	Contains the Object Replication Rule ID and <xref:ObjectReplicationStatus> of a blob. There can be more than one <xref:ObjectReplicationRule> under a <xref:ObjectReplicationPolicy>.
PageBlobClearPagesHeaders	Defines headers for PageBlob_clearPages operation.
PageBlobClearPagesOptions	Options to configure the <xref:PageBlobClient.clearPages> operation.
PageBlobCopyIncrementalHeaders	Defines headers for PageBlob_copyIncremental operation.
PageBlobCreateHeaders	Defines headers for PageBlob_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 PageBlob_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 PageBlob_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 PageBlob_resize operation.
PageBlobResizeOptions	Options to configure <xref:PageBlobClient.resize> operation.
PageBlobStartCopyIncrementalOptions	Options to configure <xref:PageBlobClient.startCopyIncremental> operation.
PageBlobUpdateSequenceNumberHeaders	Defines headers for PageBlob_updateSequenceNumber operation.
PageBlobUpdateSequenceNumberOptions	Options to configure <xref:PageBlobClient.updateSequenceNumber> operation.
PageBlobUploadPagesFromURLHeaders	Defines headers for PageBlob_uploadPagesFromURL operation.
PageBlobUploadPagesFromURLOptions	Options to configure <xref:PageBlobClient.uploadPagesFromURL> operation.
PageBlobUploadPagesHeaders	Defines headers for PageBlob_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.
PipelineLike	An interface for the <xref: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.
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
SASQueryParametersOptions	Options to construct <xref:SASQueryParameters>.
SasIPRange	Allowed IP range for a SAS.
SequenceNumberAccessConditions	Parameter group
ServiceFilterBlobsHeaders	Defines headers for Service_filterBlobs operation.
ServiceFindBlobByTagsOptions	Options to configure the <xref:BlobServiceClient.findBlobsByTags> operation.
ServiceGenerateAccountSasUrlOptions	Options to configure <xref:BlobServiceClient.generateAccountSasUrl> operation.
ServiceGetAccountInfoHeaders	Defines headers for Service_getAccountInfo operation.
ServiceGetAccountInfoOptions	Options to configure the <xref:BlobServiceClient.getAccountInfo> operation.
ServiceGetPropertiesHeaders	Defines headers for Service_getProperties operation.
ServiceGetPropertiesOptions	Options to configure the <xref:BlobServiceClient.getProperties> operation.
ServiceGetStatisticsHeaders	Defines headers for Service_getStatistics operation.
ServiceGetStatisticsOptions	Options to configure the <xref:BlobServiceClient.getStatistics> operation.
ServiceGetUserDelegationKeyHeaders	Defines headers for Service_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 Service_listContainersSegment operation.
ServiceRenameContainerOptions	Options to configure <xref:BlobServiceClient.renameContainer> operation.
ServiceSetPropertiesHeaders	Defines headers for Service_setProperties operation.
ServiceSetPropertiesOptions	Options to configure the <xref:BlobServiceClient.setProperties> operation.
ServiceSubmitBatchHeaders	Defines headers for Service_submitBatch operation.
ServiceSubmitBatchOptionalParamsModel	Optional parameters.
ServiceUndeleteContainerOptions	Options to configure <xref:BlobServiceClient.undeleteContainer> operation.
SignedIdentifier	Signed identifier.
SignedIdentifierModel	signed identifier
StaticWebsite	The properties that enable an account to host a static website
StorageClientOptionalParams	Optional parameters.
StoragePipelineOptions	Options interface for the <xref:newPipeline> function.
StorageRetryOptions	Storage Blob retry options interface.
TagConditions	Specifies HTTP options for conditional requests based on blob tags.
UserDelegationKey	A user delegation key.
UserDelegationKeyModel	A user delegation key

Type Aliases

AccessTier	Defines values for AccessTier.
AccountKind	Defines values for AccountKind.
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.
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.
BlobDeleteImmutabilityPolicyResponse	Contains response data for the deleteImmutabilityPolicy operation.
BlobDeleteResponse	Contains response data for the delete operation.
BlobDownloadResponseModel	Contains response data for the download operation.
BlobGetPropertiesResponseModel	Contains response data for the getProperties operation.
BlobGetTagsResponse	Contains response data for the <xref:BlobClient.getTags> operation.
BlobImmutabilityPolicyMode	Defines values for BlobImmutabilityPolicyMode.
BlobQueryArrowFieldType	The type of a <xref:BlobQueryArrowField>.
BlobQueryResponseModel	Contains response data for the query operation.
BlobSetHTTPHeadersResponse	Contains response data for the setHttpHeaders operation.
BlobSetImmutabilityPolicyResponse	Contains response data for the setImmutabilityPolicy operation.
BlobSetLegalHoldResponse	Contains response data for the setLegalHold 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.
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.
BlockBlobPutBlobFromUrlResponse	Contains response data for the putBlobFromUrl 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.
ContainerCreateResponse	Contains response data for the create operation.
ContainerDeleteResponse	Contains response data for the delete 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.
ContainerRenameResponse	Contains response data for the rename operation.
ContainerSetAccessPolicyResponse	Contains response data for the setAccessPolicy operation.
ContainerSetMetadataResponse	Contains response data for the setMetadata operation.
ContainerUndeleteResponse	Contains response data for the restore 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.
CredentialPolicyCreator	A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
DeleteSnapshotsOptionType	Defines values for DeleteSnapshotsOptionType.
EncryptionAlgorithmType	Defines values for EncryptionAlgorithmType.
GeoReplicationStatusType	Defines values for GeoReplicationStatusType.
LeaseDurationType	Defines values for LeaseDurationType.
LeaseOperationResponse	Contains the response data for operations that create, modify, or delete a lease. See <xref:BlobLeaseClient>.
LeaseStateType	Defines values for LeaseStateType.
LeaseStatusType	Defines values for LeaseStatusType.
ListBlobsIncludeItem	Defines values for ListBlobsIncludeItem.
ListContainersIncludeType	Defines values for ListContainersIncludeType.
ObjectReplicationStatus	Specifies the Replication Status of a blob. This is used when a storage account has Object Replication Policy(s) applied. See <xref:ObjectReplicationPolicy> and <xref:ObjectReplicationRule>.
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.
RehydratePriority	Defines values for RehydratePriority.
SequenceNumberActionType	Defines values for SequenceNumberActionType.
ServiceFindBlobsByTagsSegmentResponse	The response of <xref:BlobServiceClient.findBlobsByTags> 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.
SyncCopyStatusType	Defines values for SyncCopyStatusType.
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(), // Optional expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional protocol: SASProtocol.HttpsAndHttp, // Optional version: "2016-05-31" // Optional }, sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)` ).toString(); Example using an identifier: // Generate service level SAS for a container with identifier // startsOn & permissions are optional when identifier is provided const identifier = "unique-id"; await containerClient.setAccessPolicy(undefined, [ { accessPolicy: { expiresOn: new Date(new Date().valueOf() + 86400), // Date type permissions: ContainerSASPermissions.parse("racwdl").toString(), startsOn: new Date() // Date type }, id: identifier } ]); const containerSAS = generateBlobSASQueryParameters( { containerName, // Required identifier // Required }, sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)` ).toString(); Example using a blob name: // Generate service level SAS for a blob const blobSAS = generateBlobSASQueryParameters({ containerName, // Required blobName, // Required permissions: BlobSASPermissions.parse("racwd"), // Required startsOn: new Date(), // Optional expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type cacheControl: "cache-control-override", // Optional contentDisposition: "content-disposition-override", // Optional contentEncoding: "content-encoding-override", // Optional contentLanguage: "content-language-override", // Optional contentType: "content-type-override", // Optional ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional protocol: SASProtocol.HttpsAndHttp, // Optional version: "2016-05-31" // Optional }, sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)` ).toString();
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, // 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();
isPipelineLike(unknown)	A helper to decide if a given argument satisfies the Pipeline contract
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

SASQueryParameters

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

Example using an identifier:

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

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

Example using a blob name:

// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
    containerName, // Required
    blobName, // Required
    permissions: BlobSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parameters

blobSASSignatureValues: BlobSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Returns

SASQueryParameters

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

function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string)

Parameters

blobSASSignatureValues: BlobSASSignatureValues

userDelegationKey: UserDelegationKey

Return value of blobServiceClient.getUserDelegationKey()

accountName: string

Returns

SASQueryParameters

isPipelineLike(unknown)

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

function isPipelineLike(pipeline: unknown)

Parameters

pipeline: unknown

An argument that may be a Pipeline

Returns

boolean

true when the argument satisfies the Pipeline contract

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Creates a new Pipeline object with Credential provided.

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

Parameters

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions: StoragePipelineOptions

Optional. Options.

Returns

Pipeline

A new Pipeline object.

Share via

@azure/storage-blob package

Classes

Interfaces

Type Aliases

Enums

Functions

Function Details

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

Parameters

Returns

generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)

Parameters

Returns

generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)

Parameters

Returns

isPipelineLike(unknown)

Parameters

Returns

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Parameters

Returns

Additional resources