@azure/storage-file-share

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

CopyStatusType

CopyStatusType: "pending" | "success" | "aborted" | "failed"

Defines values for CopyStatusType.

CredentialPolicyCreator

CredentialPolicyCreator: (nextPolicy: RequestPolicy, options: RequestPolicyOptions) => CredentialPolicy

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

Type declaration

- (nextPolicy: RequestPolicy, options: RequestPolicyOptions): CredentialPolicy
- Parameters
  - nextPolicy: RequestPolicy
  - options: RequestPolicyOptions
  Returns CredentialPolicy

DeleteSnapshotsOptionType

DeleteSnapshotsOptionType: "include" | "include-leased"

Defines values for DeleteSnapshotsOptionType.

DirectoryCreateResponse

DirectoryCreateResponse: DirectoryCreateHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: DirectoryCreateHeaders } }

Contains response data for the create operation.

DirectoryDeleteResponse

DirectoryDeleteResponse: DirectoryDeleteHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: DirectoryDeleteHeaders } }

Contains response data for the delete operation.

DirectoryForceCloseHandlesResponse

DirectoryForceCloseHandlesResponse: CloseHandlesInfo & DirectoryCloseHandlesHeaders & { _response: HttpResponse & { parsedHeaders: DirectoryForceCloseHandlesHeaders } }

Contains response data for the forceCloseHandles operation. Response type for ShareDirectoryClient.forceCloseHandle.

DirectoryGetPropertiesResponse

DirectoryGetPropertiesResponse: DirectoryGetPropertiesHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: DirectoryGetPropertiesHeaders } }

Contains response data for the getProperties operation.

DirectoryListFilesAndDirectoriesSegmentResponse

DirectoryListFilesAndDirectoriesSegmentResponse: DirectoryListFilesAndDirectoriesSegmentHeaders & ListFilesAndDirectoriesSegmentResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ListFilesAndDirectoriesSegmentResponse; parsedHeaders: DirectoryListFilesAndDirectoriesSegmentHeaders } }

Contains response data for the listFilesAndDirectoriesSegment operation.

DirectoryListHandlesResponse

DirectoryListHandlesResponse: DirectoryListHandlesHeaders & ListHandlesResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ListHandlesResponse; parsedHeaders: DirectoryListHandlesHeaders } }

Contains response data for the listHandles operation.

DirectorySetMetadataResponse

DirectorySetMetadataResponse: DirectorySetMetadataHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: DirectorySetMetadataHeaders } }

Contains response data for the setMetadata operation.

DirectorySetPropertiesResponse

DirectorySetPropertiesResponse: DirectorySetPropertiesHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: DirectorySetPropertiesHeaders } }

Contains response data for the setProperties operation.

FileAbortCopyResponse

FileAbortCopyResponse: FileAbortCopyHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: FileAbortCopyHeaders } }

Contains response data for the abortCopy operation.

FileAcquireLeaseResponse

FileAcquireLeaseResponse: FileAcquireLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: FileAcquireLeaseHeaders } }

Contains response data for the acquireLease operation.

FileAttributesPreserveType

FileAttributesPreserveType: "preserve"

Indicates keep existing file attributes unchanged.

FileBreakLeaseResponse

FileBreakLeaseResponse: FileBreakLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: FileBreakLeaseHeaders } }

Contains response data for the breakLease operation.

FileChangeLeaseResponse

FileChangeLeaseResponse: FileChangeLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: FileChangeLeaseHeaders } }

Contains response data for the changeLease operation.

FileCreateResponse

FileCreateResponse: FileCreateHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: FileCreateHeaders } }

Contains response data for the create operation.

FileDeleteResponse

FileDeleteResponse: FileDeleteHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: FileDeleteHeaders } }

Contains response data for the delete operation.

FileForceCloseHandlesResponse

FileForceCloseHandlesResponse: CloseHandlesInfo & FileCloseHandlesHeaders & { _response: HttpResponse & { parsedHeaders: FileForceCloseHandlesHeaders } }

Contains response data for the forceCloseHandles operation. Response type for ShareFileClient.forceCloseHandle.

FileGetPropertiesResponse

FileGetPropertiesResponse: FileGetPropertiesHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: FileGetPropertiesHeaders } }

Contains response data for the getProperties operation.

FileGetRangeListResponse

FileGetRangeListResponse: FileGetRangeListHeaders & { _response: HttpResponse & { bodyAsText: string; parsedBody: RangeModel[]; parsedHeaders: FileGetRangeListHeaders }; rangeList: RangeModel[] }

Contains response data for the getRangeList operation. Contains response data for the ShareFileClient.getRangeList operation.

FileListHandlesResponse

FileListHandlesResponse: FileListHandlesHeaders & ListHandlesResponse & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ListHandlesResponse; parsedHeaders: FileListHandlesHeaders } }

Contains response data for the listHandles operation.

FilePermissionInheritType

FilePermissionInheritType: "inherit"

Indicates inherit file permission from the parent directory.

FilePermissionPreserveType

FilePermissionPreserveType: "preserve"

Indicates keep existing file permission value unchanged.

FileRangeWriteType

FileRangeWriteType: "update" | "clear"

Defines values for FileRangeWriteType.

FileReleaseLeaseResponse

FileReleaseLeaseResponse: FileReleaseLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: FileReleaseLeaseHeaders } }

Contains response data for the releaseLease operation.

FileSetHttpHeadersResponse

FileSetHttpHeadersResponse: FileSetHttpHeadersHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: FileSetHttpHeadersHeaders } }

Contains response data for the setHttpHeaders operation.

FileSetMetadataResponse

FileSetMetadataResponse: FileSetMetadataHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: FileSetMetadataHeaders } }

Contains response data for the setMetadata operation.

FileStartCopyResponse

FileStartCopyResponse: FileStartCopyHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: FileStartCopyHeaders } }

Contains response data for the startCopy operation.

FileType

FileType: "File"

Defines values for FileType. Possible values include: 'File'

readonly

FileUploadRangeFromURLResponse

FileUploadRangeFromURLResponse: FileUploadRangeFromURLHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: FileUploadRangeFromURLHeaders } }

Contains response data for the uploadRangeFromURL operation.

FileUploadRangeResponse

FileUploadRangeResponse: FileUploadRangeHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: FileUploadRangeHeaders } }

Contains response data for the uploadRange operation.

LeaseDurationType

LeaseDurationType: "infinite" | "fixed"

Defines values for LeaseDurationType.

LeaseOperationResponse

LeaseOperationResponse: LeaseOperationResponseHeaders & { _response: HttpResponse & { parsedHeaders: LeaseOperationResponseHeaders } }

Contains the response data for operations that acquire, change, break or release a lease.

See ShareLeaseClient.

LeaseStateType

LeaseStateType: "available" | "leased" | "expired" | "breaking" | "broken"

Defines values for LeaseStateType.

LeaseStatusType

LeaseStatusType: "locked" | "unlocked"

Defines values for LeaseStatusType.

ListFilesIncludeType

ListFilesIncludeType: "Timestamps" | "Etag" | "Attributes" | "PermissionKey"

Defines values for ListFilesIncludeType.

ListSharesIncludeType

ListSharesIncludeType: "snapshots" | "metadata" | "deleted"

Defines values for ListSharesIncludeType.

Operation

Operation: () => Promise<any>

Operation is an async function to be executed and managed by Batch.

Type declaration

- (): Promise<any>
- Returns Promise<any>

OutgoingHandler

OutgoingHandler: (buffer: Buffer, offset?: undefined | number) => Promise<any>

OutgoingHandler is an async function triggered by BufferScheduler.

Type declaration

- (buffer: Buffer, offset?: undefined | number): Promise<any>
- Parameters
  - buffer: Buffer
  - Optional offset: undefined | number
  Returns Promise<any>

PermissionCopyModeType

PermissionCopyModeType: "source" | "override"

Defines values for PermissionCopyModeType.

ReadableStreamGetter

ReadableStreamGetter: (offset: number) => Promise<NodeJS.ReadableStream>

Type declaration

- (offset: number): Promise<NodeJS.ReadableStream>
- Parameters
  - offset: number
  Returns Promise<NodeJS.ReadableStream>

ServiceGetPropertiesResponse

ServiceGetPropertiesResponse: ServiceGetPropertiesHeaders & FileServiceProperties & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: FileServiceProperties; parsedHeaders: ServiceGetPropertiesHeaders } }

Contains response data for the getProperties operation.

ServiceListSharesSegmentResponse

ServiceListSharesSegmentResponse: ListSharesResponse & ServiceListSharesSegmentHeaders & { _response: HttpResponse & { bodyAsText: string; parsedBody: ListSharesResponseModel; parsedHeaders: ServiceListSharesSegmentHeaders } }

Contains response data for the listSharesSegment operation. Contains response data for the ShareServiceClient.listShares operation.

ServiceSetPropertiesResponse

ServiceSetPropertiesResponse: ServiceSetPropertiesHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ServiceSetPropertiesHeaders } }

Contains response data for the setProperties operation.

ShareAccessTier

ShareAccessTier: "TransactionOptimized" | "Hot" | "Cool"

Defines values for ShareAccessTier.

ShareAcquireLeaseResponse

ShareAcquireLeaseResponse: ShareAcquireLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ShareAcquireLeaseHeaders } }

Contains response data for the acquireLease operation.

ShareBreakLeaseResponse

ShareBreakLeaseResponse: ShareBreakLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ShareBreakLeaseHeaders } }

Contains response data for the breakLease operation.

ShareChangeLeaseResponse

ShareChangeLeaseResponse: ShareChangeLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ShareChangeLeaseHeaders } }

Contains response data for the changeLease operation.

ShareCreatePermissionResponse

ShareCreatePermissionResponse: ShareCreatePermissionHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ShareCreatePermissionHeaders } }

Contains response data for the createPermission operation.

ShareCreateResponse

ShareCreateResponse: ShareCreateHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ShareCreateHeaders } }

Contains response data for the create operation.

ShareCreateSnapshotResponse

ShareCreateSnapshotResponse: ShareCreateSnapshotHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ShareCreateSnapshotHeaders } }

Contains response data for the createSnapshot operation.

ShareDeleteResponse

ShareDeleteResponse: ShareDeleteHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ShareDeleteHeaders } }

Contains response data for the delete operation.

ShareGetAccessPolicyResponse

ShareGetAccessPolicyResponse: { signedIdentifiers: SignedIdentifier[] } & ShareGetAccessPolicyHeaders & { _response: HttpResponse & { bodyAsText: string; parsedBody: SignedIdentifierModel[]; parsedHeaders: ShareGetAccessPolicyHeaders } }

Contains response data for the getAccessPolicy operation.

ShareGetPermissionResponse

ShareGetPermissionResponse: ShareGetPermissionHeaders & SharePermission & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SharePermission; parsedHeaders: ShareGetPermissionHeaders } }

Contains response data for the getPermission operation.

ShareGetPropertiesResponse

ShareGetPropertiesResponse: ShareGetPropertiesResponseModel & { protocols?: ShareProtocols }

Contains response data for the getProperties operation. Contains response data for the ShareClient.getProperties operation.

ShareGetStatisticsResponse

ShareGetStatisticsResponse: ShareGetStatisticsResponseModel & { shareUsage: number }

Contains response data for the getStatistics operation. Response data for the ShareClient.getStatistics Operation.

ShareProperties

ShareProperties: SharePropertiesInternal & { protocols?: ShareProtocols }

Properties of a share.

ShareReleaseLeaseResponse

ShareReleaseLeaseResponse: ShareReleaseLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ShareReleaseLeaseHeaders } }

Contains response data for the releaseLease operation.

ShareRenewLeaseResponse

ShareRenewLeaseResponse: ShareRenewLeaseHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ShareRenewLeaseHeaders } }

Contains response data for the renewLease operation.

ShareRestoreResponse

ShareRestoreResponse: ShareRestoreHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ShareRestoreHeaders } }

Contains response data for the restore operation.

ShareRootSquash

ShareRootSquash: "NoRootSquash" | "RootSquash" | "AllSquash"

Defines values for ShareRootSquash.

ShareSetAccessPolicyResponse

ShareSetAccessPolicyResponse: ShareSetAccessPolicyHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ShareSetAccessPolicyHeaders } }

Contains response data for the setAccessPolicy operation.

ShareSetMetadataResponse

ShareSetMetadataResponse: ShareSetMetadataHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ShareSetMetadataHeaders } }

Contains response data for the setMetadata operation.

ShareSetPropertiesResponse

ShareSetPropertiesResponse: ShareSetPropertiesHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: ShareSetPropertiesHeaders } }

Contains response data for the setProperties operation.

ShareSetQuotaHeaders

ShareSetQuotaHeaders: ShareSetPropertiesHeaders

Defines headers for setQuota operation.

ShareSetQuotaResponse

ShareSetQuotaResponse: ShareSetPropertiesResponse

Contains response data for the setQuota operation.

StorageErrorCode

StorageErrorCode: string

Defines values for StorageErrorCode.
KnownStorageErrorCode can be used interchangeably with StorageErrorCode, this enum contains the known values that the service supports.

Know values supported by the service

AccountAlreadyExists
AccountBeingCreated
AccountIsDisabled
AuthenticationFailed
AuthorizationFailure
ConditionHeadersNotSupported
ConditionNotMet
EmptyMetadataKey
InsufficientAccountPermissions
InternalError
InvalidAuthenticationInfo
InvalidHeaderValue
InvalidHttpVerb
InvalidInput
InvalidMd5
InvalidMetadata
InvalidQueryParameterValue
InvalidRange
InvalidResourceName
InvalidUri
InvalidXmlDocument
InvalidXmlNodeValue
Md5Mismatch
MetadataTooLarge
MissingContentLengthHeader
MissingRequiredQueryParameter
MissingRequiredHeader
MissingRequiredXmlNode
MultipleConditionHeadersNotSupported
OperationTimedOut
OutOfRangeInput
OutOfRangeQueryParameterValue
RequestBodyTooLarge
ResourceTypeMismatch
RequestUrlFailedToParse
ResourceAlreadyExists
ResourceNotFound
ServerBusy
UnsupportedHeader
UnsupportedXmlNode
UnsupportedQueryParameter
UnsupportedHttpVerb
CannotDeleteFileOrDirectory
ClientCacheFlushDelay
DeletePending
DirectoryNotEmpty
FileLockConflict
InvalidFileOrDirectoryPathName
ParentNotFound
ReadOnlyAttribute
ShareAlreadyExists
ShareBeingDeleted
ShareDisabled
ShareNotFound
SharingViolation
ShareSnapshotInProgress
ShareSnapshotCountExceeded
ShareSnapshotOperationNotSupported
ShareHasSnapshots
ContainerQuotaDowngradeNotAllowed
AuthorizationSourceIPMismatch
AuthorizationProtocolMismatch
AuthorizationPermissionMismatch
AuthorizationServiceMismatch
AuthorizationResourceTypeMismatch
FeatureVersionMismatch

TimeNowType

TimeNowType: "now"

Indicates setting as the time of the request.

TimePreserveType

TimePreserveType: "preserve"

Indicates keep existing time value unchanged.

Variables

Const ABORT_ERROR

ABORT_ERROR: any = new AbortError("The operation was aborted.")

Const DEFAULT_HIGH_LEVEL_CONCURRENCY

DEFAULT_HIGH_LEVEL_CONCURRENCY: number = 5

Const DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS

DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS: number = 5

Const ETagAny

ETagAny: "*" = "*"

Const ETagNone

ETagNone: "" = ""

Const FILE_MAX_SIZE_BYTES

FILE_MAX_SIZE_BYTES: number = 4 * 1024 * 1024 * 1024 * 1024

Const FILE_RANGE_MAX_SIZE_BYTES

FILE_RANGE_MAX_SIZE_BYTES: number = 4 * 1024 * 1024

Const RETRY_ABORT_ERROR

RETRY_ABORT_ERROR: any = new AbortError("The operation was aborted.")

Const SDK_VERSION

SDK_VERSION: string = "12.8.0-beta.1"

Const SERVICE_VERSION

SERVICE_VERSION: string = "2020-10-02"

Const StorageFileLoggingAllowedHeaderNames

StorageFileLoggingAllowedHeaderNames: string[] = ["Access-Control-Allow-Origin","Cache-Control","Content-Length","Content-Type","Date","Request-Id","traceparent","Transfer-Encoding","User-Agent","x-ms-client-request-id","x-ms-date","x-ms-error-code","x-ms-request-id","x-ms-return-client-request-id","x-ms-version","Accept-Ranges","Content-Disposition","Content-Encoding","Content-Language","Content-MD5","Content-Range","ETag","Last-Modified","Server","Vary","x-ms-content-crc64","x-ms-copy-action","x-ms-copy-completion-time","x-ms-copy-id","x-ms-copy-progress","x-ms-copy-status","x-ms-has-immutability-policy","x-ms-has-legal-hold","x-ms-lease-state","x-ms-lease-status","x-ms-range","x-ms-request-server-encrypted","x-ms-server-encrypted","x-ms-snapshot","x-ms-source-range","x-ms-cache-control","x-ms-content-disposition","x-ms-content-encoding","x-ms-content-language","x-ms-content-length","x-ms-content-md5","x-ms-content-type","x-ms-file-attributes","x-ms-file-change-time","x-ms-file-creation-time","x-ms-file-id","x-ms-file-last-write-time","x-ms-file-parent-id","x-ms-handle-id","x-ms-number-of-handles-closed","x-ms-recursive","x-ms-share-quota","x-ms-type","x-ms-write"]

Const StorageFileLoggingAllowedQueryParameters

StorageFileLoggingAllowedQueryParameters: string[] = ["comp","maxresults","rscc","rscd","rsce","rscl","rsct","se","si","sip","sp","spr","sr","srt","ss","st","sv","copyid","restype"]

Const _defaultHttpClient

_defaultHttpClient: any = new DefaultHttpClient()

Const createSpan

createSpan: any = createSpanFunction({packagePrefix: "Azure.Storage.File",namespace: "Microsoft.Storage"})

Creates a span using the global tracer.

internal

Const logger

logger: any = createClientLogger("storage-file-share")

The @azure/logger configuration for this package.

Const packageName

packageName: "azure-storage-file-share" = "azure-storage-file-share"

Const packageVersion

packageVersion: "12.7.0-beta.1" = "12.7.0-beta.1"

Functions

NewStorageRetryPolicyFactory

NewStorageRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory

- Defined in policies/StorageRetryPolicy.ts:27
A factory method used to generated a RetryPolicy factory.

Parameters
- Optional retryOptions: StorageRetryOptions
  
  -
Returns RequestPolicyFactory

appendToURLPath

appendToURLPath(url: string, name: string): string

- Defined in utils/utils.common.ts:194
Append a string to URL path. Will remove duplicated "/" in front of the string when URL path ends with a "/".

Parameters
- url: string
  
  Source URL string
- name: string
  
  String to be appended to URL
Returns string

An updated URL string

appendToURLQuery

appendToURLQuery(url: string, queryParts: string): string

- Defined in utils/utils.common.ts:211
Append a string to URL query.

Parameters
- url: string
  
  Source URL string.
- queryParts: string
  
  String to be appended to the URL query.
Returns string

An updated URL string.

base64decode

base64decode(encodedString: string): string

- Defined in utils/utils.common.ts:337
Base64 decode.

Parameters
- encodedString: string
  
  -
Returns string

base64encode

base64encode(content: string): string

- Defined in utils/utils.common.ts:328
Base64 encode.

Parameters
- content: string
  
  -
Returns string

blobToArrayBuffer

blobToArrayBuffer(blob: Blob): Promise<ArrayBuffer>

- Defined in utils/utils.browser.ts:9
Convert a Browser Blob object into ArrayBuffer.

Parameters
- blob: Blob
  
  -
Returns Promise<ArrayBuffer>

convertTracingToRequestOptionsBase

convertTracingToRequestOptionsBase(options?: OperationOptions): Pick<RequestOptionsBase, "spanOptions" | "tracingContext">

- Defined in utils/tracing.ts:23
internal

Adapt the tracing options from OperationOptions to what they need to be for RequestOptionsBase (when we update to later OpenTelemetry versions this is now two separate fields, not just one).

Parameters
- Optional options: OperationOptions
Returns Pick<RequestOptionsBase, "spanOptions" | "tracingContext">

delay

delay(timeInMs: number, aborter?: AbortSignalLike, abortError?: Error): Promise<void>

- Defined in utils/utils.common.ts:348
Delay specified time interval.

Parameters
- timeInMs: number
  
  -
- Optional aborter: AbortSignalLike
  
  -
- Optional abortError: Error
  
  -
Returns Promise<void>

escape

escape(text: string): string

- Defined in utils/utils.common.ts:178
Internal escape method implemented Strategy Two mentioned in escapeURL() description.

Parameters
- text: string
  
  -
Returns string

escapeURLPath

escapeURLPath(url: string): string

- Defined in utils/utils.common.ts:61
Reserved URL characters must be properly escaped for Storage services like Blob or File.

URL encode and escape strategy for JS SDKs

When customers pass a URL string into XXXClient classes constructor, the URL string may already be URL encoded or not. But before sending to Azure Storage server, the URL must be encoded. However, it's hard for a SDK to guess whether the URL string has been encoded or not. We have 2 potential strategies, and chose strategy two for the XXXClient constructors.

Strategy One: Assume the customer URL string is not encoded, and always encode URL string in SDK.

This is what legacy V2 SDK does, simple and works for most of the cases.
- When customer URL string is "http://account.blob.core.windows.net/con/b:", SDK will encode it to "http://account.blob.core.windows.net/con/b%3A" and send to server. A blob named "b:" will be created.
- When customer URL string is "http://account.blob.core.windows.net/con/b%3A", SDK will encode it to "http://account.blob.core.windows.net/con/b%253A" and send to server. A blob named "b%3A" will be created.
But this strategy will make it not possible to create a blob with "?" in it's name. Because when customer URL string is "http://account.blob.core.windows.net/con/blob?name", the "?name" will be treated as URL paramter instead of blob name. If customer URL string is "http://account.blob.core.windows.net/con/blob%3Fname", a blob named "blob%3Fname" will be created. V2 SDK doesn't have this issue because it doesn't allow customer pass in a full URL, it accepts a separate blob name and encodeURIComponent for it. We cannot accept a SDK cannot create a blob name with "?". So we implement strategy two:

Strategy Two: SDK doesn't assume the URL has been encoded or not. It will just escape the special characters.

This is what V10 Blob Go SDK does. It accepts a URL type in Go, and call url.EscapedPath() to escape the special chars unescaped.
- When customer URL string is "http://account.blob.core.windows.net/con/b:", SDK will escape ":" like "http://account.blob.core.windows.net/con/b%3A" and send to server. A blob named "b:" will be created.
- When customer URL string is "http://account.blob.core.windows.net/con/b%3A", There is no special characters, so send "http://account.blob.core.windows.net/con/b%3A" to server. A blob named "b:" will be created.
- When customer URL string is "http://account.blob.core.windows.net/con/b%253A", There is no special characters, so send "http://account.blob.core.windows.net/con/b%253A" to server. A blob named "b%3A" will be created.
This strategy gives us flexibility to create with any special characters. But "%" will be treated as a special characters, if the URL string is not encoded, there shouldn't a "%" in the URL string, otherwise the URL is not a valid URL. If customer needs to create a blob with "%" in it's blob name, use "%25" insead of "%". Just like above 3rd sample. And following URL strings are invalid:
Another special character is "?", use "%2F" to represent a blob name with "?" in a URL string.

Strategy for containerName, blobName or other specific XXXName parameters in methods such as ContainerClient.getBlobClient(blobName)

We will apply strategy one, and call encodeURIComponent for these parameters like blobName. Because what customers passes in is a plain name instead of a URL.

see

https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

see

https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-shares--directories--files--and-metadata
Parameters
- url: string
  
  -
Returns string

extractConnectionStringParts

extractConnectionStringParts(connectionString: string): ConnectionString

- Defined in utils/utils.common.ts:106
Extracts the parts of an Azure Storage account connection string.

Parameters
- connectionString: string
  
  Connection string.
Returns ConnectionString

String key value pairs of the storage account's url and credentials.

fileAttributesToString

fileAttributesToString(fileAttributes: FileSystemAttributes | FileAttributesPreserveType): string

- Defined in models.ts:282
Parameters
- fileAttributes: FileSystemAttributes | FileAttributesPreserveType
Returns string

fileCreationTimeToString

fileCreationTimeToString(time: Date | TimeNowType | TimePreserveType): string

- Defined in models.ts:290
Parameters
- time: Date | TimeNowType | TimePreserveType
Returns string

fileLastWriteTimeToString

fileLastWriteTimeToString(time: Date | TimeNowType | TimePreserveType): string

- Defined in models.ts:294
Parameters
- time: Date | TimeNowType | TimePreserveType
Returns string

Const fsCreateReadStream

fsCreateReadStream(): void

- Defined in utils/utils.browser.ts:26
Returns void

Const fsStat

fsStat(): void

- Defined in utils/utils.browser.ts:24
ONLY AVAILABLE IN NODE.JS RUNTIME.

Promisified version of fs.stat().

Returns void

generateAccountSASQueryParameters

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

- Defined in AccountSASSignatureValues.ts:83
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

Parameters
- accountSASSignatureValues: AccountSASSignatureValues
- sharedKeyCredential: StorageSharedKeyCredential
  
  -
Returns SASQueryParameters

generateFileSASQueryParameters

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

- Defined in FileSASSignatureValues.ts:110
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.

Parameters
- fileSASSignatureValues: FileSASSignatureValues
  
  -
- sharedKeyCredential: StorageSharedKeyCredential
  
  -
Returns SASQueryParameters

getAccountNameFromUrl

getAccountNameFromUrl(url: string): string

- Defined in utils/utils.common.ts:432
Extracts account name from the url

Parameters
- url: string
  
  url to extract the account name from
Returns string

with the account name

getCachedDefaultHttpClient

getCachedDefaultHttpClient(): IHttpClient

- Defined in utils/cache.ts:9
Returns IHttpClient

getCanonicalName

getCanonicalName(accountName: string, shareName: string, filePath?: undefined | string): string

- Defined in FileSASSignatureValues.ts:190
Parameters
- accountName: string
- shareName: string
- Optional filePath: undefined | string
Returns string

getShareNameAndPathFromUrl

getShareNameAndPathFromUrl(url: string): { baseName: string; path: string; shareName: string }

- Defined in utils/utils.common.ts:474
Parameters
- url: string
Returns { baseName: string; path: string; shareName: string }
- baseName: string
- path: string
- shareName: string

getURLParameter

getURLParameter(url: string, name: string): string | string[] | undefined

- Defined in utils/utils.common.ts:246
Get URL parameter by name.

Parameters
- url: string
  
  -
- name: string
  
  -
Returns string | string[] | undefined

getURLPath

getURLPath(url: string): string | undefined

- Defined in utils/utils.common.ts:269
Get URL path from an URL string.

Parameters
- url: string
  
  Source URL string
Returns string | undefined

getURLQueries

getURLQueries(url: string): {}

- Defined in utils/utils.common.ts:279
Get URL query key value pairs from an URL string.

Parameters
- url: string
  
  -
Returns {}
- [key: string]: string

getValueInConnString

getValueInConnString(connectionString: string, argument: "FileEndpoint" | "AccountName" | "AccountKey" | "DefaultEndpointsProtocol" | "EndpointSuffix" | "SharedAccessSignature"): string

- Defined in utils/utils.common.ts:81
Parameters
- connectionString: string
- argument: "FileEndpoint" | "AccountName" | "AccountKey" | "DefaultEndpointsProtocol" | "EndpointSuffix" | "SharedAccessSignature"
Returns string

httpAuthorizationToString

httpAuthorizationToString(httpAuthorization?: HttpAuthorization): string | undefined

- Defined in utils/utils.common.ts:535
Parameters
- Optional httpAuthorization: HttpAuthorization
Returns string | undefined

ipRangeToString

ipRangeToString(ipRange: SasIPRange): string

- Defined in SasIPRange.ts:28
Generate SasIPRange format string. For example:

"8.8.8.8" or "1.1.1.1-255.255.255.255"

Parameters
- ipRange: SasIPRange
  
  A range of IP addresses.
Returns string

string representation of the IP range.

isIpEndpointStyle

isIpEndpointStyle(parsedUrl: URLBuilder): boolean

- Defined in utils/utils.common.ts:457
Parameters
- parsedUrl: URLBuilder
Returns boolean

newPipeline

newPipeline(credential?: Credential, pipelineOptions?: StoragePipelineOptions): Pipeline

- Defined in Pipeline.ts:146
Creates a new Pipeline object with Credential provided.

Parameters
- Optional credential: Credential
  
  Such as AnonymousCredential, StorageSharedKeyCredential.
- Default value pipelineOptions: StoragePipelineOptions = {}
  
  Optional. Options.
Returns Pipeline

A new Pipeline object.

padStart

padStart(currentString: string, targetLength: number, padString?: string): string

- Defined in utils/utils.common.ts:380
String.prototype.padStart()

Parameters
- currentString: string
  
  -
- targetLength: number
  
  -
- Default value padString: string = " "
  
  -
Returns string

rangeToString

rangeToString(range: Range): string

- Defined in Range.ts:29
Generate a range string. For example:

"bytes=255-" or "bytes=0-511"

Parameters
- range: Range
  
  A range of byte positions.
Returns string

The string representation for the byte range.

readStreamToLocalFile

readStreamToLocalFile(rs: NodeJS.ReadableStream, file: string): Promise<void>

- Defined in utils/utils.node.ts:71
ONLY AVAILABLE IN NODE.JS RUNTIME.

Writes the content of a readstream to a local file. Returns a Promise which is completed after the file handle is closed.

Parameters
- rs: NodeJS.ReadableStream
  
  The read stream.
- file: string
  
  Destination file path.
Returns Promise<void>

sanitizeHeaders

sanitizeHeaders(originalHeader: HttpHeaders): HttpHeaders

- Defined in utils/utils.common.ts:412
Parameters
- originalHeader: HttpHeaders
Returns HttpHeaders

sanitizeURL

sanitizeURL(url: string): string

- Defined in utils/utils.common.ts:403
Parameters
- url: string
Returns string

setURLHost

setURLHost(url: string, host: string): string

- Defined in utils/utils.common.ts:258
Set URL host.

Parameters
- url: string
  
  Source URL string
- host: string
  
  New host string
Returns string

An updated URL string

setURLParameter

setURLParameter(url: string, name: string, value?: undefined | string): string

- Defined in utils/utils.common.ts:234
Set URL parameter name and value. If name exists in URL parameters, old value will be replaced by name key. If not provide value, the parameter will be deleted.

Parameters
- url: string
  
  Source URL string
- name: string
  
  Parameter name
- Optional value: undefined | string
  
  Parameter value
Returns string

An updated URL string

streamToBuffer

streamToBuffer(stream: NodeJS.ReadableStream, buffer: Buffer, offset: number, end: number, encoding?: BufferEncoding): Promise<void>

- Defined in utils/utils.node.ts:16
Reads a readable stream into buffer. Fill the buffer from offset to end.

Parameters
- stream: NodeJS.ReadableStream
  
  A Node.js Readable stream
- buffer: Buffer
  
  Buffer to be filled, length must greater than or equal to offset
- offset: number
  
  From which position in the buffer to be filled, inclusive
- end: number
  
  To which position in the buffer to be filled, exclusive
- Optional encoding: BufferEncoding
  
  Encoding of the Readable stream
Returns Promise<void>

toShareProtocols

toShareProtocols(protocolsString?: undefined | string): ShareProtocols | undefined

- Defined in models.ts:183
Convert protocols from joined string to ShareProtocols.

Parameters
- Optional protocolsString: undefined | string
  
  -
Returns ShareProtocols | undefined

toShareProtocolsString

toShareProtocolsString(protocols?: ShareProtocols): string | undefined

- Defined in models.ts:205
Convert ShareProtocols to joined string.

Parameters
- Default value protocols: ShareProtocols = {}
  
  -
Returns string | undefined

truncatedISO8061Date

truncatedISO8061Date(date: Date, withMilliseconds?: boolean): string

- Defined in utils/utils.common.ts:314
Rounds a date off to seconds.

Parameters
- date: Date
  
  -
- Default value withMilliseconds: boolean = true
  
  If true, YYYY-MM-DDThh:mm:ss.fffffffZ will be returned; If false, YYYY-MM-DDThh:mm:ssZ will be returned.
Returns string

Date string in ISO8061 format, with or without 7 milliseconds component

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options: FileAndDirectoryCreateCommonOptions): FileAndDirectoryCreateCommonOptions

- Defined in models.ts:226
Parameters
- options: FileAndDirectoryCreateCommonOptions
Returns FileAndDirectoryCreateCommonOptions

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options: FileAndDirectorySetPropertiesCommonOptions): FileAndDirectorySetPropertiesCommonOptions

- Defined in models.ts:252
Parameters
- options: FileAndDirectorySetPropertiesCommonOptions
Returns FileAndDirectorySetPropertiesCommonOptions

validateFilePermissionOptions

validateFilePermissionOptions(filePermission?: undefined | string, filePermissionKey?: undefined | string): void

- Defined in models.ts:220
Parameters
- Optional filePermission: undefined | string
- Optional filePermissionKey: undefined | string
Returns void

Object literals

Const AccessPolicy

AccessPolicy: object

serializedName

serializedName: string = "AccessPolicy"

type

type: object

className

className: string = "AccessPolicy"

name

modelProperties

className

className: string = "ClearRange"

name

modelProperties

modelProperties: object

end

end: object

required

required: boolean = true

serializedName

serializedName: string = "End"

xmlName

xmlName: string = "End"

type

type: object

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

Const DEFAULT_RETRY_OPTIONS

DEFAULT_RETRY_OPTIONS: object

maxRetryDelayInMs

maxRetryDelayInMs: number = 120 * 1000

maxTries

maxTries: number = 4

retryDelayInMs

retryDelayInMs: number = 4 * 1000

retryPolicyType

retryPolicyType: EXPONENTIAL = StorageRetryPolicyType.EXPONENTIAL

tryTimeoutInMs

tryTimeoutInMs: undefined = undefined

Const DirectoryCreateExceptionHeaders

DirectoryCreateExceptionHeaders: object

serializedName

serializedName: string = "Directory_createExceptionHeaders"

type

type: object

className

className: string = "DirectoryCreateExceptionHeaders"

name

modelProperties

type

type: object

name

Const DirectoryDeleteHeaders

DirectoryDeleteHeaders: object

serializedName

serializedName: string = "Directory_deleteHeaders"

type

type: object

className

className: string = "DirectoryDeleteHeaders"

name

modelProperties

type

type: object

name

Const DirectoryForceCloseHandlesHeaders

DirectoryForceCloseHandlesHeaders: object

serializedName

serializedName: string = "Directory_forceCloseHandlesHeaders"

type

type: object

className

className: string = "DirectoryForceCloseHandlesHeaders"

name

modelProperties

type

type: object

name

Const DirectoryGetPropertiesHeaders

DirectoryGetPropertiesHeaders: object

serializedName

serializedName: string = "Directory_getPropertiesHeaders"

type

type: object

className

className: string = "DirectoryGetPropertiesHeaders"

name

modelProperties

type

type: object

serializedName: string = "DirectoryItem"

xmlName

xmlName: string = "Directory"

type

type: object

className

className: string = "DirectoryItem"

name

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "Attributes"

xmlName

xmlName: string = "Attributes"

type

type: object

name

fileId

fileId: object

serializedName

serializedName: string = "FileId"

xmlName

xmlName: string = "FileId"

type

type: object

type: object

className

className: string = "FileProperty"

name

Const DirectoryListFilesAndDirectoriesSegmentExceptionHeaders

DirectoryListFilesAndDirectoriesSegmentExceptionHeaders: object

serializedName

serializedName: string = "Directory_listFilesAndDirectoriesSegmentExceptionHeaders"

type

type: object

className

className: string = "DirectoryListFilesAndDirectoriesSegmentExceptionHeaders"

name

modelProperties

type

type: object

name

Const DirectoryListHandlesHeaders

DirectoryListHandlesHeaders: object

serializedName

serializedName: string = "Directory_listHandlesHeaders"

type

type: object

className

className: string = "DirectoryListHandlesHeaders"

name

modelProperties

type

type: object

name

Const DirectorySetMetadataHeaders

DirectorySetMetadataHeaders: object

serializedName

serializedName: string = "Directory_setMetadataHeaders"

type

type: object

className

className: string = "DirectorySetMetadataHeaders"

name

modelProperties

type

type: object

name

Const DirectorySetPropertiesHeaders

DirectorySetPropertiesHeaders: object

serializedName

serializedName: string = "Directory_setPropertiesHeaders"

type

type: object

className

className: string = "DirectorySetPropertiesHeaders"

name

modelProperties

type

type: object

name

Const FileAbortCopyHeaders

FileAbortCopyHeaders: object

serializedName

serializedName: string = "File_abortCopyHeaders"

type

type: object

className

className: string = "FileAbortCopyHeaders"

name

modelProperties

type

type: object

name

Const FileAcquireLeaseHeaders

FileAcquireLeaseHeaders: object

serializedName

serializedName: string = "File_acquireLeaseHeaders"

type

type: object

className

className: string = "FileAcquireLeaseHeaders"

name

modelProperties

type

type: object

name

Const FileBreakLeaseHeaders

FileBreakLeaseHeaders: object

serializedName

serializedName: string = "File_breakLeaseHeaders"

type

type: object

className

className: string = "FileBreakLeaseHeaders"

name

modelProperties

type

type: object

name

Const FileChangeLeaseHeaders

FileChangeLeaseHeaders: object

serializedName

serializedName: string = "File_changeLeaseHeaders"

type

type: object

className

className: string = "FileChangeLeaseHeaders"

name

modelProperties

type

type: object

name

Const FileCreateHeaders

FileCreateHeaders: object

serializedName

serializedName: string = "File_createHeaders"

type

type: object

className

className: string = "FileCreateHeaders"

name

modelProperties

type

type: object

name

Const FileDeleteHeaders

FileDeleteHeaders: object

serializedName

serializedName: string = "File_deleteHeaders"

type

type: object

className

className: string = "FileDeleteHeaders"

name

modelProperties

type

type: object

name

Const FileDownloadHeaders

FileDownloadHeaders: object

serializedName

serializedName: string = "File_downloadHeaders"

type

type: object

className

className: string = "FileDownloadHeaders"

name

modelProperties

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const FileForceCloseHandlesHeaders

FileForceCloseHandlesHeaders: object

serializedName

serializedName: string = "File_forceCloseHandlesHeaders"

type

type: object

className

className: string = "FileForceCloseHandlesHeaders"

name

modelProperties

type

type: object

name

Const FileGetPropertiesHeaders

FileGetPropertiesHeaders: object

serializedName

serializedName: string = "File_getPropertiesHeaders"

type

type: object

className

className: string = "FileGetPropertiesHeaders"

name

modelProperties

serializedName: string = "x-ms-error-code"

xmlName

xmlName: string = "x-ms-error-code"

type

type: object

name

Const FileGetRangeListHeaders

FileGetRangeListHeaders: object

serializedName

serializedName: string = "File_getRangeListHeaders"

type

type: object

className

className: string = "FileGetRangeListHeaders"

name

modelProperties

className

className: string = "FileItem"

name

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "Attributes"

xmlName

xmlName: string = "Attributes"

type

type: object

name

fileId

fileId: object

serializedName

serializedName: string = "FileId"

xmlName

xmlName: string = "FileId"

type

type: object

type: object

className

className: string = "FileProperty"

name

Const FileListHandlesExceptionHeaders

FileListHandlesExceptionHeaders: object

serializedName

serializedName: string = "File_listHandlesExceptionHeaders"

type

type: object

className

className: string = "FileListHandlesExceptionHeaders"

name

modelProperties

type

type: object

name

contentLength

className

className: string = "FileRange"

name

modelProperties

modelProperties: object

end

end: object

required

required: boolean = true

serializedName

serializedName: string = "End"

xmlName

xmlName: string = "End"

type

type: object

name

start

type

type: object

name

Const FileReleaseLeaseHeaders

FileReleaseLeaseHeaders: object

serializedName

serializedName: string = "File_releaseLeaseHeaders"

type

type: object

className

className: string = "FileReleaseLeaseHeaders"

name

modelProperties

className

className: string = "FileServiceProperties"

name

modelProperties

modelProperties: object

cors

cors: object

serializedName

serializedName: string = "Cors"

xmlElementName

xmlElementName: string = "CorsRule"

xmlIsWrapped

xmlIsWrapped: boolean = true

xmlName

xmlName: string = "Cors"

type

type: object

type

type: object

name

Const FileSetHttpHeadersHeaders

FileSetHttpHeadersHeaders: object

serializedName

serializedName: string = "File_setHttpHeadersHeaders"

type

type: object

className

className: string = "FileSetHttpHeadersHeaders"

name

modelProperties

type

type: object

name

Const FileSetMetadataHeaders

FileSetMetadataHeaders: object

serializedName

serializedName: string = "File_setMetadataHeaders"

type

type: object

className

className: string = "FileSetMetadataHeaders"

name

modelProperties

type

type: object

name

Const FileStartCopyHeaders

FileStartCopyHeaders: object

serializedName

serializedName: string = "File_startCopyHeaders"

type

type: object

className

className: string = "FileStartCopyHeaders"

name

modelProperties

modelProperties: object

copyId

copyId: object

serializedName

serializedName: string = "x-ms-copy-id"

xmlName

xmlName: string = "x-ms-copy-id"

type

type: object

name

copyStatus

type

type: object

name

Const FileUploadRangeFromURLExceptionHeaders

FileUploadRangeFromURLExceptionHeaders: object

serializedName

serializedName: string = "File_uploadRangeFromURLExceptionHeaders"

type

type: object

className

className: string = "FileUploadRangeFromURLExceptionHeaders"

name

modelProperties

type

type: object

className

className: string = "FilesAndDirectoriesListSegment"

name

modelProperties

modelProperties: object

directoryItems

directoryItems: object

required

required: boolean = true

serializedName

serializedName: string = "DirectoryItems"

xmlElementName

xmlElementName: string = "Directory"

xmlName

xmlName: string = "DirectoryItems"

type

type: object

name

element

element: object

type

type: object

className

className: string = "DirectoryItem"

name

fileItems

fileItems: object

required

required: boolean = true

serializedName

serializedName: string = "FileItems"

type: object

className

className: string = "HandleItem"

name

modelProperties

type

type: object

HeaderConstants: object

AUTHORIZATION

AUTHORIZATION: string = "authorization"

AUTHORIZATION_SCHEME

AUTHORIZATION_SCHEME: string = "Bearer"

CONTENT_ENCODING

CONTENT_ENCODING: string = "content-encoding"

CONTENT_LANGUAGE

CONTENT_LANGUAGE: string = "content-language"

CONTENT_LENGTH

CONTENT_LENGTH: string = "content-length"

CONTENT_MD5

CONTENT_MD5: string = "content-md5"

CONTENT_TYPE

CONTENT_TYPE: string = "content-type"

COOKIE

COOKIE: string = "Cookie"

DATE

DATE: string = "date"

IF_MATCH

IF_MATCH: string = "if-match"

IF_MODIFIED_SINCE

IF_MODIFIED_SINCE: string = "if-modified-since"

IF_NONE_MATCH

IF_NONE_MATCH: string = "if-none-match"

IF_UNMODIFIED_SINCE

IF_UNMODIFIED_SINCE: string = "if-unmodified-since"

PREFIX_FOR_STORAGE

PREFIX_FOR_STORAGE: string = "x-ms-"

RANGE

RANGE: string = "Range"

USER_AGENT

USER_AGENT: string = "User-Agent"

X_MS_CLIENT_REQUEST_ID

X_MS_CLIENT_REQUEST_ID: string = "x-ms-client-request-id"

X_MS_COPY_SOURCE

X_MS_COPY_SOURCE: string = "x-ms-copy-source"

X_MS_DATE

X_MS_DATE: string = "x-ms-date"

Const HttpUrlConnection

HttpUrlConnection: object

HTTP_CONFLICT

HTTP_CONFLICT: number = 409

HTTP_NOT_FOUND

HTTP_NOT_FOUND: number = 404

HTTP_PRECON_FAILED

HTTP_PRECON_FAILED: number = 412

HTTP_RANGE_NOT_SATISFIABLE

HTTP_RANGE_NOT_SATISFIABLE: number = 416

Const ListFilesAndDirectoriesSegmentResponse

required: boolean = true

serializedName

serializedName: string = "ServiceEndpoint"

xmlIsAttribute

xmlIsAttribute: boolean = true

xmlName

xmlName: string = "ServiceEndpoint"

type

type: object

name

shareName

type

type: object

name

handleList

handleList: object

serializedName

serializedName: string = "HandleList"

xmlElementName

xmlElementName: string = "Handle"

xmlIsWrapped

xmlIsWrapped: boolean = true

xmlName

xmlName: string = "Entries"

type

type: object

name

element

element: object

type

type: object

className

className: string = "HandleItem"

name

Const ListSharesResponse

ListSharesResponse: object

serializedName

serializedName: string = "ListSharesResponse"

xmlName

xmlName: string = "EnumerationResults"

type

type: object

className

className: string = "ListSharesResponse"

name

modelProperties

modelProperties: object

continuationToken

xmlName

xmlName: string = "ServiceEndpoint"

type

type: object

name

shareItems

shareItems: object

serializedName

serializedName: string = "ShareItems"

xmlElementName

className

className: string = "Metrics"

name

modelProperties

modelProperties: object

enabled

className

className: string = "RetentionPolicy"

name

version

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 365

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

enabled

type

type: object

name

Const ServiceGetPropertiesHeaders

ServiceGetPropertiesHeaders: object

serializedName

serializedName: string = "Service_getPropertiesHeaders"

type

type: object

className

className: string = "ServiceGetPropertiesHeaders"

name

modelProperties

type

type: object

name

Const ServiceListSharesSegmentHeaders

ServiceListSharesSegmentHeaders: object

serializedName

serializedName: string = "Service_listSharesSegmentHeaders"

type

type: object

className

className: string = "ServiceListSharesSegmentHeaders"

name

modelProperties

type

type: object

name

Const ServiceSetPropertiesHeaders

ServiceSetPropertiesHeaders: object

serializedName

serializedName: string = "Service_setPropertiesHeaders"

type

type: object

className

className: string = "ServiceSetPropertiesHeaders"

name

modelProperties

type

type: object

name

Const ShareAcquireLeaseHeaders

ShareAcquireLeaseHeaders: object

serializedName

serializedName: string = "Share_acquireLeaseHeaders"

type

type: object

className

className: string = "ShareAcquireLeaseHeaders"

name

modelProperties

type

type: object

name

Const ShareBreakLeaseHeaders

ShareBreakLeaseHeaders: object

serializedName

serializedName: string = "Share_breakLeaseHeaders"

type

type: object

className

className: string = "ShareBreakLeaseHeaders"

name

modelProperties

type

type: object

name

Const ShareChangeLeaseHeaders

ShareChangeLeaseHeaders: object

serializedName

serializedName: string = "Share_changeLeaseHeaders"

type

type: object

className

className: string = "ShareChangeLeaseHeaders"

name

modelProperties

type

type: object

name

Const ShareCreateHeaders

ShareCreateHeaders: object

serializedName

serializedName: string = "Share_createHeaders"

type

type: object

className

className: string = "ShareCreateHeaders"

name

modelProperties

type

type: object

name

Const ShareCreatePermissionHeaders

ShareCreatePermissionHeaders: object

serializedName

serializedName: string = "Share_createPermissionHeaders"

type

type: object

className

className: string = "ShareCreatePermissionHeaders"

name

modelProperties

type

type: object

name

Const ShareCreateSnapshotHeaders

ShareCreateSnapshotHeaders: object

serializedName

serializedName: string = "Share_createSnapshotHeaders"

type

type: object

className

className: string = "ShareCreateSnapshotHeaders"

name

modelProperties

type

type: object

name

Const ShareDeleteHeaders

ShareDeleteHeaders: object

serializedName

serializedName: string = "Share_deleteHeaders"

type

type: object

className

className: string = "ShareDeleteHeaders"

name

modelProperties

xmlName

xmlName: string = "ClearRanges"

type

type: object

name

element

element: object

type

type: object

className

className: string = "ClearRange"

name

ranges

ranges: object

serializedName

className

className: string = "ShareGetAccessPolicyExceptionHeaders"

name

modelProperties

type

type: object

name

Const ShareGetPermissionHeaders

ShareGetPermissionHeaders: object

serializedName

serializedName: string = "Share_getPermissionHeaders"

type

type: object

className

className: string = "ShareGetPermissionHeaders"

name

modelProperties

type

type: object

name

Const ShareGetPropertiesHeaders

ShareGetPropertiesHeaders: object

serializedName

serializedName: string = "Share_getPropertiesHeaders"

type

type: object

className

className: string = "ShareGetPropertiesHeaders"

name

modelProperties

name

Const ShareGetStatisticsHeaders

ShareGetStatisticsHeaders: object

serializedName

serializedName: string = "Share_getStatisticsHeaders"

type

type: object

className

className: string = "ShareGetStatisticsHeaders"

name

modelProperties

className

className: string = "ShareItemInternal"

name

modelProperties

modelProperties: object

deleted

deleted: object

serializedName

required

required: boolean = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

properties

xmlName

xmlName: string = "permission"

type

type: object

name

Const SharePropertiesInternal

SharePropertiesInternal: object

serializedName

serializedName: string = "SharePropertiesInternal"

type

type: object

className

className: string = "SharePropertiesInternal"

name

modelProperties

type

type: object

name

remainingRetentionDays

remainingRetentionDays: object

serializedName

serializedName: string = "RemainingRetentionDays"

xmlName

xmlName: string = "RemainingRetentionDays"

type

type: object

name

rootSquash

ShareReleaseLeaseHeaders: object

serializedName

serializedName: string = "Share_releaseLeaseHeaders"

type

type: object

className

className: string = "ShareReleaseLeaseHeaders"

name

modelProperties

type

type: object

name

Const ShareRenewLeaseHeaders

ShareRenewLeaseHeaders: object

serializedName

serializedName: string = "Share_renewLeaseHeaders"

type

type: object

className

className: string = "ShareRenewLeaseHeaders"

name

modelProperties

type

type: object

name

Const ShareRestoreHeaders

ShareRestoreHeaders: object

serializedName

serializedName: string = "Share_restoreHeaders"

type

type: object

className

className: string = "ShareRestoreHeaders"

name

modelProperties

type

type: object

name

Const ShareSetAccessPolicyHeaders

ShareSetAccessPolicyHeaders: object

serializedName

serializedName: string = "Share_setAccessPolicyHeaders"

type

type: object

className

className: string = "ShareSetAccessPolicyHeaders"

name

modelProperties

type

type: object

name

Const ShareSetMetadataHeaders

ShareSetMetadataHeaders: object

serializedName

serializedName: string = "Share_setMetadataHeaders"

type

type: object

className

className: string = "ShareSetMetadataHeaders"

name

modelProperties

type

type: object

name

Const ShareSetPropertiesHeaders

ShareSetPropertiesHeaders: object

serializedName

serializedName: string = "Share_setPropertiesHeaders"

type

type: object

className

className: string = "ShareSetPropertiesHeaders"

name

modelProperties

type

type: object

name

message

message: object

serializedName

serializedName: string = "Message"

xmlName

xmlName: string = "Message"

type

type: object

name

Const URLConstants

URLConstants: object

Parameters

Parameters: object

FORCE_BROWSER_NO_CACHE

FORCE_BROWSER_NO_CACHE: string = "_"

SHARE_SNAPSHOT

SHARE_SNAPSHOT: string = "sharesnapshot"

SIGNATURE

SIGNATURE: string = "sig"

TIMEOUT

TIMEOUT: string = "timeout"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/xml"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

Const accept1

accept1: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/xml"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

Const accept2

accept2: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

Const accept3

accept3: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/xml"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

Const accessTier

accessTier: object

parameterPath

parameterPath: string[] = ["options", "accessTier"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-access-tier"

xmlName

xmlName: string = "x-ms-access-tier"

type

type: object

allowedValues

allowedValues: string[] = ["TransactionOptimized", "Hot", "Cool"]

name

Const action

action: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "acquire"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "x-ms-lease-action"

type

type: object

name

Const action1

action1: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "release"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "x-ms-lease-action"

type

type: object

name

Const action2

action2: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "change"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "x-ms-lease-action"

type

type: object

name

Const action3

action3: object

parameterPath

parameterPath: string = "action"

mapper

mapper: object

defaultValue

defaultValue: string = "renew"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "x-ms-lease-action"

type

type: object

name

Const action4

type

type: object

name

Const comp1

comp1: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "list"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp10

comp10: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "forceclosehandles"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp11

comp11: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "range"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp12

comp12: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "rangelist"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp13

comp13: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "copy"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp2

comp2: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "lease"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp3

comp3: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "snapshot"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp4

comp4: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "filepermission"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp5

comp5: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "metadata"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp6

comp6: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "acl"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp7

comp7: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "stats"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp8

comp8: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "undelete"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp9

comp9: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "listhandles"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const contentLength

type

type: object

name

Const contentType1

contentType1: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/octet-stream"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

Const copyActionAbortConstant

copyActionAbortConstant: object

parameterPath

parameterPath: string = "copyActionAbortConstant"

mapper

mapper: object

defaultValue

defaultValue: string = "abort"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "x-ms-copy-action"

type

type: object

name

Const copyId

copyId: object

parameterPath

parameterPath: string = "copyId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "copyid"

xmlName

xmlName: string = "copyid"

type

type: object

name

Const copySource

serializedName

serializedName: string = "x-ms-file-creation-time"

xmlName

xmlName: string = "x-ms-file-creation-time"

type

type: object

name

Const fileCreationTime

fileCreationTime: object

parameterPath

parameterPath: string[] = ["options", "copyFileSmbInfo", "fileCreationTime"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-file-creation-time"

xmlName

xmlName: string = "x-ms-file-creation-time"

type

type: object

name

Const fileLastWriteOn

allowedValues

allowedValues: string[] = ["source", "override"]

name

Const filePermissionKey

xmlName

xmlName: string = "x-ms-write"

type

type: object

allowedValues

allowedValues: string[] = ["update", "clear"]

name

Const fileRangeWriteFromUrl

fileRangeWriteFromUrl: object

parameterPath

parameterPath: string = "fileRangeWriteFromUrl"

mapper

mapper: object

defaultValue

defaultValue: string = "update"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "x-ms-write"

type

type: object

name

Const fileTypeConstant

fileTypeConstant: object

parameterPath

parameterPath: string = "fileTypeConstant"

mapper

mapper: object

defaultValue

defaultValue: string = "file"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "x-ms-type"

type

type: object

name

Const handleId

xmlName

xmlName: string = "include"

type

type: object

name

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["snapshots", "metadata", "deleted"]

name

Const include1

include1: object

collectionFormat

collectionFormat: any = QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options", "include"]

mapper

mapper: object

serializedName

serializedName: string = "include"

xmlElementName

xmlElementName: string = "ListFilesIncludeType"

xmlName

xmlName: string = "include"

type

type: object

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "x-ms-lease-id"

xmlName

xmlName: string = "x-ms-lease-id"

type

type: object

name

Const marker

marker: object

parameterPath

parameterPath: string[] = ["options", "marker"]

mapper

mapper: object

serializedName

serializedName: string = "marker"

xmlName

xmlName: string = "marker"

type

type: object

name

Const maxResults

maxResults: object

parameterPath

parameterPath: string[] = ["options", "maxResults"]

mapper

mapper: object

serializedName

serializedName: string = "maxresults"

xmlName

xmlName: string = "maxresults"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const metadata

metadata: object

parameterPath

parameterPath: string[] = ["options", "metadata"]

mapper

mapper: object

headerCollectionPrefix

headerCollectionPrefix: string = "x-ms-meta-"

serializedName

serializedName: string = "x-ms-meta"

xmlName

xmlName: string = "x-ms-meta"

type

type: object

proposedLeaseId: object

parameterPath

parameterPath: string[] = ["options", "proposedLeaseId"]

mapper

mapper: object

serializedName

serializedName: string = "x-ms-proposed-lease-id"

xmlName

xmlName: string = "x-ms-proposed-lease-id"

type

type: object

name

Const quota

quota: object

parameterPath

type

type: object

name

Const restype1

restype1: object

parameterPath

parameterPath: string = "restype"

mapper

mapper: object

defaultValue

defaultValue: string = "share"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "restype"

type

type: object

name

Const restype2

restype2: object

parameterPath

parameterPath: string = "restype"

mapper

mapper: object

defaultValue

defaultValue: string = "directory"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "restype"

type

type: object

name

Const rootSquash

xmlName

xmlName: string = "SignedIdentifiers"

type

type: object

name

element

element: object

type

type: object

className

className: string = "SignedIdentifier"

name

Const sharePermission

sharePermission: object

mapper

mapper: any = SharePermissionMapper

parameterPath

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

Const url

url: object

parameterPath

parameterPath: string = "url"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "url"

xmlName

xmlName: string = "url"

type

type: object

name

Const version

version: object

parameterPath

parameterPath: string = "version"

mapper

mapper: object

defaultValue

defaultValue: string = "2020-10-02"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

CopyStatusType

CredentialPolicyCreator

Type declaration

Parameters

nextPolicy: RequestPolicy

options: RequestPolicyOptions

Returns CredentialPolicy

DeleteSnapshotsOptionType

DirectoryCreateResponse

DirectoryDeleteResponse

DirectoryForceCloseHandlesResponse

DirectoryGetPropertiesResponse

DirectoryListFilesAndDirectoriesSegmentResponse

DirectoryListHandlesResponse

DirectorySetMetadataResponse

DirectorySetPropertiesResponse

FileAbortCopyResponse

FileAcquireLeaseResponse

FileAttributesPreserveType

FileBreakLeaseResponse

FileChangeLeaseResponse

FileCreateResponse

FileDeleteResponse

FileForceCloseHandlesResponse

FileGetPropertiesResponse

FileGetRangeListResponse

FileListHandlesResponse

FilePermissionInheritType

FilePermissionPreserveType

FileRangeWriteType

FileReleaseLeaseResponse

FileSetHttpHeadersResponse

FileSetMetadataResponse

FileStartCopyResponse

FileType

FileUploadRangeFromURLResponse

FileUploadRangeResponse

LeaseDurationType

LeaseOperationResponse

LeaseStateType

LeaseStatusType

ListFilesIncludeType

ListSharesIncludeType

Operation

Type declaration

Returns Promise<any>

OutgoingHandler

Type declaration

Parameters

buffer: Buffer

Optional offset: undefined | number

Returns Promise<any>

PermissionCopyModeType

ReadableStreamGetter

Type declaration

Parameters

offset: number

Returns Promise<NodeJS.ReadableStream>

ServiceGetPropertiesResponse

ServiceListSharesSegmentResponse

ServiceSetPropertiesResponse

ShareAccessTier

ShareAcquireLeaseResponse

ShareBreakLeaseResponse

ShareChangeLeaseResponse

ShareCreatePermissionResponse

ShareCreateResponse

ShareCreateSnapshotResponse

ShareDeleteResponse

ShareGetAccessPolicyResponse

ShareGetPermissionResponse