@azure/storage-file-share 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 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 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 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).
BaseRequestPolicy	The base class from which all request policies derive.
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.
FileSASPermissions	ONLY AVAILABLE IN NODE.JS RUNTIME. This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a file. 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 FileSASSignatureValues 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.
FileSystemAttributes	This is a helper class to construct a string representing the NTFS attributes to a file or directory. See https://docs.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes
Pipeline	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.
RestError	A custom error type for failed pipeline requests.
SASQueryParameters	Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly by the user; it is only generated by the AccountSASSignatureValues and FileSASSignatureValues 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.
ShareClient	A ShareClient represents a URL to the Azure Storage share allowing you to manipulate its directories and files.
ShareDirectoryClient	A ShareDirectoryClient represents a URL to the Azure Storage directory allowing you to manipulate its files and directories.
ShareFileClient	A ShareFileClient represents a URL to an Azure Storage file.
ShareLeaseClient	A client that manages leases for a ShareFileClient or ShareClient. See https://docs.microsoft.com/rest/api/storageservices/lease-file and See https://docs.microsoft.com/rest/api/storageservices/lease-share
ShareSASPermissions	This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a share. 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 FileSASSignatureValues 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.
ShareServiceClient	A ShareServiceClient represents a URL to the Azure Storage File service allowing you to manipulate file shares.
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.
StorageRetryPolicy	Retry policy with exponential retry and linear retry implemented.
StorageRetryPolicyFactory	StorageRetryPolicyFactory is a factory class helping generating 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 generateAccountSASQueryParameters to obtain a representation of the SAS which can actually be applied to file 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
ClearRange
CloseHandlesInfo	Close handles result information.
CommonGenerateSasUrlOptions	Common options of the ShareGenerateSasUrlOptions and FileGenerateSasUrlOptions.
CommonOptions	An interface for options common to every remote operation.
CopyFileSmbInfo	Parameter group
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.
DirectoryCloseHandlesHeaders	Additional response header values for close handles request.
DirectoryCreateHeaders	Defines headers for Directory_create operation.
DirectoryCreateIfNotExistsResponse	Contains response data for the createIfNotExists(DirectoryCreateOptions) operation.
DirectoryCreateOptions	Options to configure create operation.
DirectoryDeleteHeaders	Defines headers for Directory_delete operation.
DirectoryDeleteIfExistsResponse	Contains response data for the deleteIfExists(DirectoryDeleteOptions) operation.
DirectoryDeleteOptions	Options to configure the delete operation.
DirectoryExistsOptions	Options to configure the exists operation.
DirectoryForceCloseHandlesHeaders	Defines headers for Directory_forceCloseHandles operation.
DirectoryForceCloseHandlesOptions	Options to configure forceCloseHandle.
DirectoryForceCloseHandlesSegmentOptions	Options to configure Directory - Force Close Handles Segment operations. See: <xref:ShareDirectoryClient.forceCloseHandlesSegment> forceCloseAllHandles
DirectoryGetPropertiesHeaders	Defines headers for Directory_getProperties operation.
DirectoryGetPropertiesOptions	Options to configure the getProperties operation.
DirectoryItem	A listed directory item.
DirectoryListFilesAndDirectoriesOptions	Options to configure listFilesAndDirectories operation.
DirectoryListFilesAndDirectoriesSegmentHeaders	Defines headers for Directory_listFilesAndDirectoriesSegment operation.
DirectoryListHandlesHeaders	Defines headers for Directory_listHandles operation.
DirectoryListHandlesOptions	Options to configure the listHandles operation.
DirectoryListHandlesSegmentOptions	Options to configure Directory - List Handles Segment operations. See: <xref:ShareDirectoryClient.listHandlesSegment> <xref:ShareDirectoryClient.iterateHandleSegments> <xref:ShareDirectoryClient.listHandleItems>
DirectoryProperties	An interface for options common to every remote operation.
DirectoryRenameHeaders	Defines headers for Directory_rename operation.
DirectoryRenameOptions	Options to configure the rename operation.
DirectorySetMetadataHeaders	Defines headers for Directory_setMetadata operation.
DirectorySetMetadataOptions	Options to configure the setMetadata operation.
DirectorySetPropertiesHeaders	Defines headers for Directory_setProperties operation.
FileAbortCopyFromURLOptions	Options to configure the abortCopyFromURL operation.
FileAbortCopyHeaders	Defines headers for File_abortCopy operation.
FileAndDirectoryCreateCommonOptions
FileAndDirectorySetPropertiesCommonOptions
FileClearRangeOptions	Options to configure the clearRange operation.
FileCloseHandlesHeaders	Additional response header values for close handles request.
FileCreateHeaders	Defines headers for File_create operation.
FileCreateOptions	Options to configure the create operation.
FileDeleteHeaders	Defines headers for File_delete operation.
FileDeleteIfExistsResponse	Contains response data for the deleteIfExists operation.
FileDeleteOptions	Options to configure the delete operation.
FileDownloadHeaders	Defines headers for File_download operation.
FileDownloadOptionalParams	Optional parameters.
FileDownloadOptions	Options to configure File - Download operations. See: download downloadToFile
FileDownloadToBufferOptions	Option interface for the downloadToBuffer operation.
FileExistsOptions	Options to configure the exists operation.
FileForceCloseHandlesHeaders	Defines headers for File_forceCloseHandles operation.
FileForceCloseHandlesOptions	Options to configure File - Force Close Handles operations. See: <xref:ShareFileClient.forceCloseHandlesSegment> forceCloseAllHandles forceCloseHandle
FileGenerateSasUrlOptions	Options to configure generateSasUrl operation.
FileGetPropertiesHeaders	Defines headers for File_getProperties operation.
FileGetPropertiesOptions	Options to configure the getProperties operation.
FileGetRangeListHeaders	Defines headers for File_getRangeList operation.
FileGetRangeListOptions	Options to configure the getRangeList operation.
FileHttpHeaders
FileItem	A listed file item.
FileListHandlesHeaders	Defines headers for File_listHandles operation.
FileListHandlesOptions	An interface for options common to every remote operation.
FileListHandlesSegmentOptions	Options to configure File - List Handles Segment operations. See: <xref:ShareFileClient.listHandlesSegment> <xref:ShareFileClient.iterateHandleSegments> <xref:ShareFileClient.listHandleItems>
FileParallelUploadOptions	Option interface for File - Upload operations See: uploadFile <xref:ShareFileClient.uploadSeekableStream>
FileProperties	An interface for options common to every remote operation.
FileProperty	File properties.
FileRenameHeaders	Defines headers for File_rename operation.
FileRenameOptions	Options to configure the rename operation.
FileResizeOptions	Options to configure the resize operation.
FileSASSignatureValues	ONLY AVAILABLE IN NODE.JS RUNTIME. FileSASSignatureValues is used to help generating File service SAS tokens for shares or files.
FileServiceProperties	Storage service properties.
FileSetHTTPHeadersHeaders	Defines headers for File_setHttpHeaders operation.
FileSetHttpHeadersOptions	Options to configure the setHttpHeaders operation.
FileSetMetadataHeaders	Defines headers for File_setMetadata operation.
FileSetMetadataOptions	Options to configure the setMetadata operation.
FileStartCopyHeaders	Defines headers for File_startCopy operation.
FileStartCopyOptions	Options to configure the startCopyFromURL operation.
FileUploadRangeFromURLHeaders	Defines headers for File_uploadRangeFromURL operation.
FileUploadRangeFromURLOptionalParams	Optional parameters.
FileUploadRangeFromURLOptions	Options to configure the uploadRangeFromURL operation.
FileUploadRangeHeaders	Defines headers for File_uploadRange operation.
FileUploadRangeOptions	Options to configure the uploadRange operation.
FileUploadStreamOptions	Option interface for ShareFileClient.uploadStream().
FilesAndDirectoriesListSegment	Abstract for entries that can be listed from Directory.
HandleItem	A listed Azure Storage handle item.
HttpAuthorization	Represents authentication information in Authorization, ProxyAuthorization, WWW-Authenticate, and Proxy-Authenticate header values.
HttpHeaders	A collection of HTTP header key/value pairs.
HttpOperationResponse	Http Response that is compatible with the core-v1(core-http).
HttpResponse	A representation of an HTTP response that includes a reference to the request that originated it.
IHttpClient	A compatible interface for core-http request policies
LeaseAccessConditions	Parameter group
LeaseOperationOptions	lease operations options.
LeaseOperationResponseHeaders	The details of the response for a specific lease operation.
ListFilesAndDirectoriesSegmentResponse	An enumeration of directories and files.
ListHandlesResponse	An enumeration of handles.
ListSharesResponse	An enumeration of shares.
ListSharesResponseModel	An enumeration of shares.
Metadata
Metrics	Storage Analytics metrics for file service.
PipelineLike	An interface for the Pipeline class containing HTTP request policies. You can create a default Pipeline by calling newPipeline. Or you can create a Pipeline with your own policies by the constructor of Pipeline. Refer to newPipeline and provided policies before implementing your customized Pipeline.
PipelineOptions	Option interface for Pipeline constructor.
Range	Range for Service Operations. See https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations
RangeModel	An Azure Storage file range.
RequestPolicyFactory	An interface for compatibility with core-http's RequestPolicyFactory
RequestPolicyOptions	An interface for compatibility with RequestPolicy
ResponseLike	An object with a simple _response property.
ResponseWithBody	An object with a _response property that has body and headers already parsed into known types.
ResponseWithHeaders	An object with a _response property that has headers already parsed into a typed object.
RetentionPolicy	The retention policy.
SasIPRange	Allowed IP range for a SAS.
ServiceClientOptions	A subset of @azure/core-http ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Options to configure generateAccountSasUrl operation.
ServiceGetPropertiesHeaders	Defines headers for Service_getProperties operation.
ServiceGetPropertiesOptions	Options to configure the getProperties operation.
ServiceListSharesOptions	Options to configure the listShares operation.
ServiceListSharesSegmentHeaders	Defines headers for Service_listSharesSegment operation.
ServiceSetPropertiesHeaders	Defines headers for Service_setProperties operation.
ServiceSetPropertiesOptions	Options to configure the setProperties operation.
ServiceUndeleteShareOptions	Options to configure the <xref:ShareServiceClient.undelete> operation.
SetPropertiesResponse	Contains response data for the setHttpHeaders operation.
ShareClientConfig
ShareCreateHeaders	Defines headers for Share_create operation.
ShareCreateIfNotExistsResponse	Contains response data for the createIfNotExists operation.
ShareCreateOptions	Options to configure the create operation.
ShareCreatePermissionHeaders	Defines headers for Share_createPermission operation.
ShareCreatePermissionOptions	Options to configure the createPermission operation.
ShareCreateSnapshotHeaders	Defines headers for Share_createSnapshot operation.
ShareCreateSnapshotOptions	Options to configure the createSnapshot operation.
ShareDeleteHeaders	Defines headers for Share_delete operation.
ShareDeleteIfExistsResponse	Contains response data for the deleteIfExists operation.
ShareDeleteMethodOptions	Options to configure the delete operation.
ShareExistsOptions	Options to configure the exists operation.
ShareFileRangeList	The list of file ranges
ShareGenerateSasUrlOptions	Options to configure generateSasUrl operation.
ShareGetAccessPolicyHeaders	Defines headers for Share_getAccessPolicy operation.
ShareGetAccessPolicyOptions	Options to configure the getAccessPolicy operation.
ShareGetPermissionHeaders	Defines headers for Share_getPermission operation.
ShareGetPermissionOptions	Options to configure the getPermission operation.
ShareGetPropertiesHeaders	Defines headers for Share_getProperties operation.
ShareGetPropertiesOptions	Options to configure the getProperties operation.
ShareGetStatisticsHeaders	Defines headers for Share_getStatistics operation.
ShareGetStatisticsOptions	Options to configure the getStatistics operation.
ShareItem	A listed Azure Storage share item.
ShareItemInternal	A listed Azure Storage share item.
SharePermission	A permission (a security descriptor) at the share level.
SharePropertiesInternal	Properties of a share.
ShareProtocolSettings	Protocol settings
ShareProtocols	Protocols to enable on the share. For now, only support SMB or NFS.
ShareSetAccessPolicyHeaders	Defines headers for Share_setAccessPolicy operation.
ShareSetAccessPolicyOptions	Options to configure the setAccessPolicy operation.
ShareSetMetadataHeaders	Defines headers for Share_setMetadata operation.
ShareSetMetadataOptions	Options to configure the setMetadata operation.
ShareSetPropertiesHeaders	Defines headers for Share_setProperties operation.
ShareSetPropertiesOptions	Options to configure the setProperties operation.
ShareSetQuotaOptions	Options to configure the setQuota operation.
ShareSmbSettings	Settings for SMB protocol.
ShareStats	Stats for the share.
SignedIdentifier	Signed Identifier
SignedIdentifierModel	Signed identifier.
SmbMultichannel	Settings for SMB multichannel
SourceModifiedAccessConditions	Parameter group
StoragePipelineOptions	Options interface for the newPipeline function.
StorageRetryOptions	Storage Blob retry options interface.
WebResource	A description of a HTTP request to be made to a remote server.

Type Aliases

CopyStatusType	Defines values for CopyStatusType.
CredentialPolicyCreator	A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
DeleteSnapshotsOptionType	Defines values for DeleteSnapshotsOptionType.
DirectoryCreateResponse	Contains response data for the create operation.
DirectoryDeleteResponse	Contains response data for the delete operation.
DirectoryForceCloseHandlesResponse	Response type for forceCloseHandle.
DirectoryGetPropertiesResponse	Contains response data for the getProperties operation.
DirectoryListFilesAndDirectoriesSegmentResponse	Contains response data for the listFilesAndDirectoriesSegment operation.
DirectoryListHandlesResponse	Contains response data for the listHandles operation.
DirectoryRenameResponse	Contains response data for the rename operation.
DirectorySetMetadataResponse	Contains response data for the setMetadata operation.
DirectorySetPropertiesResponse	Contains response data for the setProperties operation.
FileAbortCopyResponse	Contains response data for the abortCopy operation.
FileAttributesPreserveType	Indicates keep existing file attributes unchanged.
FileCreateResponse	Contains response data for the create operation.
FileDeleteResponse	Contains response data for the delete operation.
FileDownloadResponseModel	Contains response data for the download operation.
FileForceCloseHandlesResponse	Response type for forceCloseHandle.
FileGetPropertiesResponse	Contains response data for the getProperties operation.
FileGetRangeListDiffResponse	Contains response data for the getRangeList operation.
FileGetRangeListResponse	Contains response data for the getRangeList operation.
FileLastWrittenMode	Defines values for FileLastWrittenMode.
FileListHandlesResponse	Contains response data for the listHandles operation.
FilePermissionFormat	Defines values for FilePermissionFormat.
FilePermissionInheritType	Indicates inherit file permission from the parent directory.
FilePermissionPreserveType	Indicates keep existing file permission value unchanged.
FileRenameResponse	Contains response data for the rename operation.
FileSetHTTPHeadersResponse	Contains response data for the setHttpHeaders operation.
FileSetMetadataResponse	Contains response data for the setMetadata operation.
FileStartCopyResponse	Contains response data for the startCopy operation.
FileUploadRangeFromURLResponse	Contains response data for the uploadRangeFromURL operation.
FileUploadRangeResponse	Contains response data for the uploadRange operation.
HttpRequestBody	Types of bodies supported on the request. NodeJS.ReadableStream and () => NodeJS.ReadableStream is Node only. Blob, ReadableStream, and () => ReadableStream are browser only.
LeaseDurationType	Defines values for LeaseDurationType.
LeaseOperationResponse	Contains the response data for operations that acquire, change, break or release a lease. See ShareLeaseClient.
LeaseStateType	Defines values for LeaseStateType.
LeaseStatusType	Defines values for LeaseStatusType.
ListSharesIncludeType	Defines values for ListSharesIncludeType.
PermissionCopyModeType	Defines values for PermissionCopyModeType.
RawFileDownloadResponse	Contains response data for the download operation.
ServiceGetPropertiesResponse	Contains response data for the getProperties operation.
ServiceListSharesSegmentResponse	Contains response data for the listShares operation.
ServiceSetPropertiesResponse	Contains response data for the setProperties operation.
ShareAccessTier	Defines values for ShareAccessTier.
ShareClientOptions
ShareCreatePermissionResponse	Contains response data for the createPermission operation.
ShareCreateResponse	Contains response data for the create operation.
ShareCreateSnapshotResponse	Contains response data for the createSnapshot operation.
ShareDeleteResponse	Contains response data for the delete operation.
ShareFileHandleAccessRights	Defines values for AccessRight.
ShareGetAccessPolicyResponse
ShareGetPermissionResponse	Contains response data for the getPermission operation.
ShareGetPropertiesResponse	Contains response data for the getProperties operation.
ShareGetPropertiesResponseModel	Contains response data for the getProperties operation.
ShareGetStatisticsResponse	Response data for the getStatistics Operation.
ShareGetStatisticsResponseModel	Contains response data for the getStatistics operation.
ShareProperties	Properties of a share.
ShareRootSquash	Defines values for ShareRootSquash.
ShareSetAccessPolicyResponse	Contains response data for the setAccessPolicy operation.
ShareSetMetadataResponse	Contains response data for the setMetadata operation.
ShareSetPropertiesResponse	Contains response data for the setProperties operation.
ShareSetQuotaHeaders	Defines headers for setQuota operation.
ShareSetQuotaResponse	Contains response data for the setQuota operation.
ShareTokenIntent	Defines values for ShareTokenIntent. KnownShareTokenIntent can be used interchangeably with ShareTokenIntent, this enum contains the known values that the service supports. Known values supported by the service backup
TimeNowType	Indicates setting as the time of the request.
TimePreserveType	Indicates keep existing time value unchanged.
WithResponse	A type that represents an operation result with a known _response property.

Enums

KnownShareTokenIntent	Known values of ShareTokenIntent that the service accepts.
SASProtocol	Protocols for generated SAS.
StorageFileAudience	Defines the known cloud audiences for Storage.
StorageRetryPolicyType	RetryPolicy types.

Functions

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	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
generateFileSASQueryParameters(FileSASSignatureValues, 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.
getFileServiceAccountAudience(string)	To get the OAuth audience for a storage account for file service.
isPipelineLike(unknown)	A helper to decide if a given argument satisfies the Pipeline contract
newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)	Creates a new Pipeline object with Credential provided.

Function Details

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

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

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

Parameters

accountSASSignatureValues

AccountSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

Returns

SASQueryParameters

generateFileSASQueryParameters(FileSASSignatureValues, 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.

function generateFileSASQueryParameters(fileSASSignatureValues: FileSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parameters

fileSASSignatureValues

FileSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

Returns

SASQueryParameters

getFileServiceAccountAudience(string)

To get the OAuth audience for a storage account for file service.

function getFileServiceAccountAudience(storageAccountName: string): string

Parameters

storageAccountName

string

Returns

string

isPipelineLike(unknown)

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

function isPipelineLike(pipeline: unknown): pipeline

Parameters

pipeline

unknown

An argument that may be a Pipeline

Returns

pipeline

true when the argument satisfies the Pipeline contract

newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)

Creates a new Pipeline object with Credential provided.

function newPipeline(credential?: Credential_2 | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

Parameters

credential

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