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

CredentialPolicy

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

Credential_2

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

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(Credential_2, StoragePipelineOptions). Or you can create a Pipeline with your own policies by the constructor of Pipeline. Refer to newPipeline(Credential_2, StoragePipelineOptions) and provided policies as reference 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 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:

  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 BrowserPolicy objects.

StorageClient

A StorageClient represents a base client class for ServiceClient, ContainerClient and etc.

StorageClientContext
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(AccountSASSignatureValues, StorageSharedKeyCredential) 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(DirectoryCreateOptions) operation.

DirectoryDeleteHeaders

Defines headers for Directory_delete operation.

DirectoryDeleteIfExistsResponse

Contains response data for the deleteIfExists(DirectoryDeleteOptions) operation.

DirectoryDeleteOptions

Options to configure the delete(DirectoryDeleteOptions) operation.

DirectoryExistsOptions

Options to configure the exists(DirectoryExistsOptions) operation.

DirectoryForceCloseHandlesHeaders

Defines headers for Directory_forceCloseHandles operation.

DirectoryForceCloseHandlesOptions

Options to configure forceCloseHandle(string, DirectoryForceCloseHandlesOptions).

DirectoryForceCloseHandlesSegmentOptions

Options to configure Directory - Force Close Handles Segment operations. See:

DirectoryGetPropertiesHeaders

Defines headers for Directory_getProperties operation.

DirectoryGetPropertiesOptions

Options to configure the getProperties(DirectoryGetPropertiesOptions) operation.

DirectoryItem

A listed directory item.

DirectoryListFilesAndDirectoriesOptions

Options to configure listFilesAndDirectories(DirectoryListFilesAndDirectoriesOptions) operation.

DirectoryListFilesAndDirectoriesSegmentHeaders

Defines headers for Directory_listFilesAndDirectoriesSegment operation.

DirectoryListHandlesHeaders

Defines headers for Directory_listHandles operation.

DirectoryListHandlesOptions

Options to configure the listHandles(DirectoryListHandlesOptions) operation.

DirectoryListHandlesSegmentOptions

Options to configure Directory - List Handles Segment operations. See:

  • <xref:ShareDirectoryClient.listHandlesSegment>
  • <xref:ShareDirectoryClient.iterateHandleSegments>
  • <xref:ShareDirectoryClient.listHandleItems>
DirectoryProperties
DirectoryRenameHeaders

Defines headers for Directory_rename operation.

DirectoryRenameOptions

Options to configure the rename(string, DirectoryRenameOptions) operation.

DirectorySetMetadataHeaders

Defines headers for Directory_setMetadata operation.

DirectorySetMetadataOptions

Options to configure the setMetadata(Metadata, DirectorySetMetadataOptions) operation.

DirectorySetPropertiesHeaders

Defines headers for Directory_setProperties operation.

FileAbortCopyFromURLOptions

Options to configure the abortCopyFromURL(string, FileAbortCopyFromURLOptions) operation.

FileAbortCopyHeaders

Defines headers for File_abortCopy operation.

FileAndDirectoryCreateCommonOptions
FileAndDirectorySetPropertiesCommonOptions
FileClearRangeOptions

Options to configure the clearRange(number, number, FileClearRangeOptions) operation.

FileCloseHandlesHeaders

Additional response header values for close handles request.

FileCreateHeaders

Defines headers for File_create operation.

FileCreateOptions

Options to configure the create(number, FileCreateOptions) operation.

FileDeleteHeaders

Defines headers for File_delete operation.

FileDeleteIfExistsResponse

Contains response data for the deleteIfExists(FileDeleteOptions) operation.

FileDeleteOptions

Options to configure the delete(FileDeleteOptions) operation.

FileDownloadHeaders

Defines headers for File_download operation.

FileDownloadOptionalParams

Optional parameters.

FileDownloadOptions

Options to configure File - Download operations. See:

FileDownloadToBufferOptions

Option interface for the downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions) operation.

FileExistsOptions

Options to configure the exists(FileExistsOptions) operation.

FileForceCloseHandlesHeaders

Defines headers for File_forceCloseHandles operation.

FileForceCloseHandlesOptions

Options to configure File - Force Close Handles operations. See:

FileGenerateSasUrlOptions

Options to configure generateSasUrl(FileGenerateSasUrlOptions) operation.

FileGetPropertiesHeaders

Defines headers for File_getProperties operation.

FileGetPropertiesOptions

Options to configure the getProperties(FileGetPropertiesOptions) operation.

FileGetRangeListHeaders

Defines headers for File_getRangeList operation.

FileGetRangeListOptions

Options to configure the getRangeList(FileGetRangeListOptions) operation.

FileHttpHeaders
FileItem

A listed file item.

FileListHandlesHeaders

Defines headers for File_listHandles operation.

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

FileProperties
FileProperty

File properties.

FileRenameHeaders

Defines headers for File_rename operation.

FileRenameOptions

Options to configure the rename(string, FileRenameOptions) operation.

FileResizeOptions

Options to configure the resize(number, FileResizeOptions) 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(FileHttpHeaders, FileSetHttpHeadersOptions) operation.

FileSetMetadataHeaders

Defines headers for File_setMetadata operation.

FileSetMetadataOptions

Options to configure the setMetadata(Metadata, FileSetMetadataOptions) operation.

FileStartCopyHeaders

Defines headers for File_startCopy operation.

FileStartCopyOptions

Options to configure the startCopyFromURL(string, FileStartCopyOptions) operation.

FileUploadRangeFromURLHeaders

Defines headers for File_uploadRangeFromURL operation.

FileUploadRangeFromURLOptionalParams

Optional parameters.

FileUploadRangeFromURLOptions

Options to configure the uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions) operation.

FileUploadRangeHeaders

Defines headers for File_uploadRange operation.

FileUploadRangeOptions

Options to configure the uploadRange(HttpRequestBody, number, number, FileUploadRangeOptions) 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.

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.

PipelineOptions

Option interface for Pipeline constructor.

RangeModel

An Azure Storage file range.

Range_2

Range for Service Operations.

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

RetentionPolicy

The retention policy.

SasIPRange

Allowed IP range for a SAS.

ServiceGenerateAccountSasUrlOptions

Options to configure generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions) operation.

ServiceGetPropertiesHeaders

Defines headers for Service_getProperties operation.

ServiceGetPropertiesOptions

Options to configure the getProperties(ServiceGetPropertiesOptions) operation.

ServiceListSharesOptions

Options to configure the listShares(ServiceListSharesOptions) operation.

ServiceListSharesSegmentHeaders

Defines headers for Service_listSharesSegment operation.

ServiceSetPropertiesHeaders

Defines headers for Service_setProperties operation.

ServiceSetPropertiesOptions

Options to configure the setProperties(FileServiceProperties, ServiceSetPropertiesOptions) operation.

ServiceUndeleteShareOptions

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

SetPropertiesResponse
ShareCreateHeaders

Defines headers for Share_create operation.

ShareCreateIfNotExistsResponse

Contains response data for the createIfNotExists(ShareCreateOptions) operation.

ShareCreateOptions

Options to configure the create(ShareCreateOptions) operation.

ShareCreatePermissionHeaders

Defines headers for Share_createPermission operation.

ShareCreatePermissionOptions

Options to configure the createPermission(string, ShareCreatePermissionOptions) operation.

ShareCreateSnapshotHeaders

Defines headers for Share_createSnapshot operation.

ShareCreateSnapshotOptions

Options to configure the createSnapshot(ShareCreateSnapshotOptions) operation.

ShareDeleteHeaders

Defines headers for Share_delete operation.

ShareDeleteIfExistsResponse

Contains response data for the deleteIfExists(ShareDeleteMethodOptions) operation.

ShareDeleteMethodOptions

Options to configure the delete(ShareDeleteMethodOptions) operation.

ShareExistsOptions

Options to configure the exists(ShareExistsOptions) operation.

ShareFileRangeList

The list of file ranges

ShareGenerateSasUrlOptions

Options to configure generateSasUrl(ShareGenerateSasUrlOptions) operation.

ShareGetAccessPolicyHeaders

Defines headers for Share_getAccessPolicy operation.

ShareGetAccessPolicyOptions

Options to configure the getAccessPolicy(ShareGetAccessPolicyOptions) operation.

ShareGetPermissionHeaders

Defines headers for Share_getPermission operation.

ShareGetPermissionOptions

Options to configure the getPermission(string, ShareGetPermissionOptions) operation.

ShareGetPropertiesHeaders

Defines headers for Share_getProperties operation.

ShareGetPropertiesOptions

Options to configure the getProperties(ShareGetPropertiesOptions) operation.

ShareGetStatisticsHeaders

Defines headers for Share_getStatistics operation.

ShareGetStatisticsOptions

Options to configure the getStatistics(ShareGetStatisticsOptions) 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(SignedIdentifier[], ShareSetAccessPolicyOptions) operation.

ShareSetMetadataHeaders

Defines headers for Share_setMetadata operation.

ShareSetMetadataOptions

Options to configure the setMetadata(Metadata, ShareSetMetadataOptions) operation.

ShareSetPropertiesHeaders

Defines headers for Share_setProperties operation.

ShareSetPropertiesOptions

Options to configure the setProperties(ShareSetPropertiesOptions) operation.

ShareSetQuotaOptions

Options to configure the setQuota(number, ShareSetQuotaOptions) 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

StorageClientOptionalParams

Optional parameters.

StoragePipelineOptions

Option interface for newPipeline(Credential_2, StoragePipelineOptions) function.

StorageRetryOptions

Retry options interface.

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(string, DirectoryForceCloseHandlesOptions).

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(string, FileForceCloseHandlesOptions).

FileGetPropertiesResponse

Contains response data for the getProperties operation.

FileGetRangeListDiffResponse

Contains response data for the getRangeList operation.

FileGetRangeListResponse

Contains response data for the getRangeList(FileGetRangeListOptions) operation.

FileLastWrittenMode

Defines values for FileLastWrittenMode.

FileListHandlesResponse

Contains response data for the listHandles operation.

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.

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.

ServiceGetPropertiesResponse

Contains response data for the getProperties operation.

ServiceListSharesSegmentResponse

Contains response data for the listShares(ServiceListSharesOptions) operation.

ServiceSetPropertiesResponse

Contains response data for the setProperties operation.

ShareAccessTier

Defines values for ShareAccessTier.

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.

ShareGetAccessPolicyResponse
ShareGetPermissionResponse

Contains response data for the getPermission operation.

ShareGetPropertiesResponse

Contains response data for the getProperties(ShareGetPropertiesOptions) operation.

ShareGetPropertiesResponseModel

Contains response data for the getProperties operation.

ShareGetStatisticsResponse

Response data for the getStatistics(ShareGetStatisticsOptions) 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.

TimeNowType

Indicates setting as the time of the request.

TimePreserveType

Indicates keep existing time value unchanged.

Enums

SASProtocol

Protocols for generated SAS.

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.

newPipeline(Credential_2, StoragePipelineOptions)

Creates a new Pipeline object with AnonymousCredential 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

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

newPipeline(Credential_2, StoragePipelineOptions)

Creates a new Pipeline object with AnonymousCredential provided.

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

Parameters

credential
Credential_2

Such as AnonymousCredential, StorageSharedKeyCredential.

pipelineOptions
StoragePipelineOptions

Optional. Options.

Returns

A new Pipeline object.