@azure/storage-file-share

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

CopyStatusType

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

CredentialPolicyCreator

CredentialPolicyCreator: function

Type declaration

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

DeleteSnapshotsOptionType

DeleteSnapshotsOptionType: "include"

DirectoryCreateResponse

DirectoryCreateResponse: DirectoryCreateHeaders & object

DirectoryDeleteResponse

DirectoryDeleteResponse: DirectoryDeleteHeaders & object

DirectoryForceCloseHandlesResponse

DirectoryForceCloseHandlesResponse: CloseHandlesInfo & DirectoryCloseHandlesHeaders & object

DirectoryGetPropertiesResponse

DirectoryGetPropertiesResponse: DirectoryGetPropertiesHeaders & object

DirectoryListFilesAndDirectoriesSegmentResponse

DirectoryListFilesAndDirectoriesSegmentResponse: ListFilesAndDirectoriesSegmentResponse & DirectoryListFilesAndDirectoriesSegmentHeaders & object

DirectoryListHandlesResponse

DirectoryListHandlesResponse: ListHandlesResponse & DirectoryListHandlesHeaders & object

DirectorySetMetadataResponse

DirectorySetMetadataResponse: DirectorySetMetadataHeaders & object

DirectorySetPropertiesResponse

DirectorySetPropertiesResponse: DirectorySetPropertiesHeaders & object

FileAbortCopyResponse

FileAbortCopyResponse: FileAbortCopyHeaders & object

FileAttributesPreserveType

FileAttributesPreserveType: "preserve"

FileCreateResponse

FileCreateResponse: FileCreateHeaders & object

FileDeleteResponse

FileDeleteResponse: FileDeleteHeaders & object

FileForceCloseHandlesResponse

FileForceCloseHandlesResponse: CloseHandlesInfo & FileCloseHandlesHeaders & object

FileGetPropertiesResponse

FileGetPropertiesResponse: FileGetPropertiesHeaders & object

FileGetRangeListResponse

FileGetRangeListResponse: FileGetRangeListHeaders & object

FileListHandlesResponse

FileListHandlesResponse: ListHandlesResponse & FileListHandlesHeaders & object

FilePermissionInheritType

FilePermissionInheritType: "inherit"

FilePermissionPreserveType

FilePermissionPreserveType: "preserve"

FileRangeWriteType

FileRangeWriteType: "update" | "clear"

FileSetHTTPHeadersResponse

FileSetHTTPHeadersResponse: FileSetHTTPHeadersHeaders & object

FileSetMetadataResponse

FileSetMetadataResponse: FileSetMetadataHeaders & object

FileStartCopyResponse

FileStartCopyResponse: FileStartCopyHeaders & object

FileType

FileType: "File"

FileUploadRangeFromURLResponse

FileUploadRangeFromURLResponse: FileUploadRangeFromURLHeaders & object

FileUploadRangeResponse

FileUploadRangeResponse: FileUploadRangeHeaders & object

ListSharesIncludeType

ListSharesIncludeType: "snapshots" | "metadata"

Operation

Operation: function

Type declaration

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

OutgoingHandler

OutgoingHandler: function

Type declaration

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

ReadableStreamGetter

ReadableStreamGetter: function

Type declaration

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

ServiceGetPropertiesResponse

ServiceGetPropertiesResponse: FileServiceProperties & ServiceGetPropertiesHeaders & object

ServiceListSharesSegmentResponse

ServiceListSharesSegmentResponse: ListSharesResponse & ServiceListSharesSegmentHeaders & object

ServiceSetPropertiesResponse

ServiceSetPropertiesResponse: ServiceSetPropertiesHeaders & object

ShareCreatePermissionResponse

ShareCreatePermissionResponse: ShareCreatePermissionHeaders & object

ShareCreateResponse

ShareCreateResponse: ShareCreateHeaders & object

ShareCreateSnapshotResponse

ShareCreateSnapshotResponse: ShareCreateSnapshotHeaders & object

ShareDeleteResponse

ShareDeleteResponse: ShareDeleteHeaders & object

ShareGetAccessPolicyResponse

ShareGetAccessPolicyResponse: object & ShareGetAccessPolicyHeaders & object

ShareGetPermissionResponse

ShareGetPermissionResponse: SharePermission & ShareGetPermissionHeaders & object

ShareGetPropertiesResponse

ShareGetPropertiesResponse: ShareGetPropertiesHeaders & object

ShareGetStatisticsResponse

ShareGetStatisticsResponse: ShareGetStatisticsResponseModel & object

ShareSetAccessPolicyResponse

ShareSetAccessPolicyResponse: ShareSetAccessPolicyHeaders & object

ShareSetMetadataResponse

ShareSetMetadataResponse: ShareSetMetadataHeaders & object

ShareSetQuotaResponse

ShareSetQuotaResponse: ShareSetQuotaHeaders & object

StorageErrorCode

TimeNowType

TimeNowType: "now"

TimePreserveType

TimePreserveType: "preserve"

Variables

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 = 1024 * 1024 * 1024 * 1024

Const FILE_RANGE_MAX_SIZE_BYTES

FILE_RANGE_MAX_SIZE_BYTES: number = 4 * 1024 * 1024

Const FileDownloadResponse

FileDownloadResponse: 1 = 1

Const SDK_VERSION

SDK_VERSION: string = "12.0.1"

Const SERVICE_VERSION

SERVICE_VERSION: string = "2019-02-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 fsStat

fsStat: any = util.promisify(isNode ? fs.stat : function stat() {})

Const logger

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

Functions

NewStorageRetryPolicyFactory

NewStorageRetryPolicyFactory(retryOptions: StorageRetryOptions): RequestPolicyFactory

- Defined in policies/StorageRetryPolicy.ts:29
Parameters
- Optional retryOptions: StorageRetryOptions
Returns RequestPolicyFactory

appendToURLPath

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

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

An updated URL string

base64decode

base64decode(encodedString: string): string

- Defined in utils/utils.common.ts:336
Parameters
- encodedString: string
Returns string

base64encode

base64encode(content: string): string

- Defined in utils/utils.common.ts:325
Parameters
- content: string
Returns string

blobToArrayBuffer

blobToArrayBuffer(blob: Blob): Promise<ArrayBuffer>

- Defined in utils/utils.browser.ts:11
Parameters
- blob: Blob
Returns Promise<ArrayBuffer>

createSpan

createSpan(operationName: string, tracingOptions?: OperationTracingOptions): object

- Defined in utils/tracing.ts:13
Parameters
- operationName: string
- Default value tracingOptions: OperationTracingOptions = {}
Returns object

delay

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

- Defined in utils/utils.common.ts:348
Parameters
- timeInMs: number
- Optional aborter: AbortSignalLike
- Optional abortError: Error
Returns Promise<unknown>

escapeURLPath

escapeURLPath(url: string): string

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

extractConnectionStringParts

extractConnectionStringParts(connectionString: string): ConnectionString

- Defined in utils/utils.common.ts:108
Parameters
- connectionString: 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:223
Parameters
- fileAttributes: FileSystemAttributes | FileAttributesPreserveType
Returns string

fileCreationTimeToString

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

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

fileLastWriteTimeToString

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

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

generateAccountSASQueryParameters

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

- Defined in AccountSASSignatureValues.ts:112
Parameters
- accountSASSignatureValues: AccountSASSignatureValues
- sharedKeyCredential: StorageSharedKeyCredential
Returns SASQueryParameters

generateFileSASQueryParameters

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

- Defined in FileSASSignatureValues.ts:157
Parameters
- fileSASSignatureValues: FileSASSignatureValues
- sharedKeyCredential: StorageSharedKeyCredential
Returns SASQueryParameters

getAccountNameFromUrl

getAccountNameFromUrl(url: string): string

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

with the account name

getCachedDefaultHttpClient

getCachedDefaultHttpClient(): any

- Defined in utils/cache.ts:8
Returns any

getShareNameAndPathFromUrl

getShareNameAndPathFromUrl(url: string): object

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

getURLParameter

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

- Defined in utils/utils.common.ts:235
Parameters
- url: string
- name: string
Returns string | string[] | undefined

getURLPath

getURLPath(url: string): string | undefined

- Defined in utils/utils.common.ts:261
Parameters
- url: string
Returns string | undefined

getURLQueries

getURLQueries(url: string): object

- Defined in utils/utils.common.ts:273
Parameters
- url: string
Returns object
- [key: string]: string

ipRangeToString

ipRangeToString(ipRange: SasIPRange): string

- Defined in SasIPRange.ts:38
Parameters
- ipRange: SasIPRange
Returns string

string representation of the IP range.

newPipeline

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

- Defined in Pipeline.ts:172
Parameters
- credential: Credential
- Default value pipelineOptions: StoragePipelineOptions = {}
Returns Pipeline

A new Pipeline object.

padStart

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

- Defined in utils/utils.common.ts:382
Parameters
- currentString: string
- targetLength: number
- Default value padString: string = " "
Returns string

rangeToString

rangeToString(range: Range): string

- Defined in Range.ts:39
Parameters
- range: Range
Returns string

The string representation for the byte range.

readStreamToLocalFile

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

- Defined in utils/utils.node.ts:78
Parameters
- rs: NodeJS.ReadableStream
- file: string
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:248
Parameters
- url: string
- host: string
Returns string

An updated URL string

setURLParameter

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

- Defined in utils/utils.common.ts:221
Parameters
- url: string
- name: string
- Optional value: undefined | string
Returns string

An updated URL string

streamToBuffer

streamToBuffer(stream: NodeJS.ReadableStream, buffer: Buffer, offset: number, end: number, encoding: undefined | string): Promise<void>

- Defined in utils/utils.node.ts:19
Parameters
- stream: NodeJS.ReadableStream
- buffer: Buffer
- offset: number
- end: number
- Optional encoding: undefined | string
Returns Promise<void>

truncatedISO8061Date

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

- Defined in utils/utils.common.ts:309
Parameters
- date: Date
- Default value withMilliseconds: boolean = true
Returns string

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

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options: FileAndDirectoryCreateCommonOptions): FileAndDirectoryCreateCommonOptions

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

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options: FileAndDirectorySetPropertiesCommonOptions): FileAndDirectorySetPropertiesCommonOptions

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

validateFilePermissionOptions

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

- Defined in models.ts:161
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

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

Const DirectoryCreateHeaders

DirectoryCreateHeaders: object

serializedName

serializedName: string = "directory-create-headers"

type

type: object

className

className: string = "DirectoryCreateHeaders"

name

modelProperties

className

className: string = "DirectoryDeleteHeaders"

name

modelProperties

className

className: string = "DirectoryForceCloseHandlesHeaders"

name

modelProperties

className

className: string = "DirectoryGetPropertiesHeaders"

name

modelProperties

type

type: object

DirectoryItem: object

serializedName

serializedName: string = "DirectoryItem"

xmlName

xmlName: string = "Directory"

type

type: object

className

className: string = "DirectoryItem"

className

className: string = "DirectoryListHandlesHeaders"

name

modelProperties

className

className: string = "DirectorySetMetadataHeaders"

name

modelProperties

className

className: string = "DirectorySetPropertiesHeaders"

name

modelProperties

className

className: string = "FileAbortCopyHeaders"

name

modelProperties

className

className: string = "FileCreateHeaders"

name

modelProperties

className

className: string = "FileDeleteHeaders"

name

modelProperties

className

className: string = "FileDownloadHeaders"

name

modelProperties

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

Const FileForceCloseHandlesHeaders

FileForceCloseHandlesHeaders: object

serializedName

serializedName: string = "file-forceclosehandles-headers"

type

type: object

className

className: string = "FileForceCloseHandlesHeaders"

name

modelProperties

className

className: string = "FileGetPropertiesHeaders"

name

modelProperties

type: object

name

version

version: object

serializedName

serializedName: string = "x-ms-version"

type

type: object

name

Const FileGetRangeListHeaders

FileGetRangeListHeaders: object

serializedName

serializedName: string = "file-getrangelist-headers"

type

type: object

className

className: string = "FileGetRangeListHeaders"

name

modelProperties

className

className: string = "FileHttpHeaders"

name

modelProperties

type

type: object

className

className: string = "FileItem"

name

modelProperties

modelProperties: object

name

required

required: boolean = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

properties

properties: object

required

className

className: string = "FileProperty"

name

modelProperties

xmlName

xmlName: string = "Cors"

type

type: object

name

element

element: object

type

type: object

className

className: string = "CorsRule"

name

hourMetrics

hourMetrics: object

serializedName

serializedName: string = "HourMetrics"

xmlName

xmlName: string = "HourMetrics"

type

type: object

className

className: string = "Metrics"

name

minuteMetrics

className

className: string = "FileSetMetadataHeaders"

name

modelProperties

className

className: string = "FileStartCopyHeaders"

name

modelProperties

modelProperties: object

copyId

copyId: object

serializedName

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

type

type: object

name

copyStatus

className

className: string = "FileUploadRangeFromURLHeaders"

name

modelProperties

className

className: string = "FileUploadRangeHeaders"

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

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

enabled: object

required

required: boolean = true

serializedName

serializedName: string = "Enabled"

xmlName

xmlName: string = "Enabled"

type

type: object

name

includeAPIs

includeAPIs: object

serializedName

serializedName: string = "IncludeAPIs"

xmlName

xmlName: string = "IncludeAPIs"

type

type: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

enabled

className

className: string = "ServiceListSharesSegmentHeaders"

name

modelProperties

className

className: string = "ServiceSetPropertiesHeaders"

name

modelProperties

className

className: string = "ShareCreateHeaders"

name

modelProperties

className

className: string = "ShareCreatePermissionHeaders"

name

modelProperties

className

className: string = "ShareCreateSnapshotHeaders"

name

modelProperties

className

className: string = "ShareDeleteHeaders"

name

modelProperties

className

className: string = "ShareGetAccessPolicyHeaders"

name

modelProperties

className

className: string = "ShareGetPermissionHeaders"

name

modelProperties

className

className: string = "ShareGetPropertiesHeaders"

name

modelProperties

type

type: object

ShareGetStatisticsHeaders: object

serializedName

serializedName: string = "share-getstatistics-headers"

type

type: object

className

className: string = "ShareGetStatisticsHeaders"

name

modelProperties

type

type: object

className

className: string = "ShareItem"

name

modelProperties

modelProperties: object

metadata

metadata: object

serializedName

serializedName: string = "Metadata"

xmlName

xmlName: string = "Metadata"

type

type: object

name

value

value: object

type

type: object

name

name

required

required: boolean = true

serializedName

serializedName: string = "Name"

xmlName

xmlName: string = "Name"

type

type: object

name

properties

properties: object

required

xmlName

xmlName: string = "permission"

type

type: object

name

Const ShareProperties

ShareProperties: object

serializedName

serializedName: string = "ShareProperties"

type

type: object

className

className: string = "ShareProperties"

name

modelProperties

className

className: string = "ShareSetMetadataHeaders"

name

modelProperties

className

className: string = "ShareSetQuotaHeaders"

name

modelProperties

className

className: string = "ShareStats"

name

modelProperties

modelProperties: object

shareUsageBytes

type

type: object

className

className: string = "AccessPolicy"

name

id

className

className: string = "StorageError"

name

modelProperties

modelProperties: object

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 comp0

comp0: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "properties"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp1

comp1: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "list"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp10

comp10: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "rangelist"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp11

comp11: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "copy"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp2

comp2: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "snapshot"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp3

comp3: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "filepermission"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp4

comp4: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "metadata"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp5

comp5: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "acl"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp6

comp6: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "stats"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp7

comp7: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "listhandles"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp8

comp8: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "forceclosehandles"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const comp9

comp9: object

parameterPath

parameterPath: string = "comp"

mapper

mapper: object

defaultValue

defaultValue: string = "range"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "comp"

type

type: object

name

Const contentLength

serializedName

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

type

type: object

name

Const fileLastWriteOn

type

type: object

name

Const filePermissionKey1

filePermissionKey1: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "x-ms-file-permission-key"

type

type: object

name

Const fileRangeWrite

fileRangeWrite: object

parameterPath

parameterPath: string = "fileRangeWrite"

mapper

mapper: object

defaultValue

defaultValue: string = "update"

required

required: boolean = true

serializedName

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

required

required: boolean = true

serializedName

serializedName: string = "x-ms-write"

type

type: object

name

Const fileTypeConstant

fileTypeConstant: object

parameterPath

name

element

element: object

type

type: object

allowedValues

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

name

Const marker

marker: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "marker"

type

type: object

name

Const maxResults

maxResults: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: 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"

type

type: object

name

value

value: object

type

type: object

name

Const prefix

prefix: object

parameterPath

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

mapper

mapper: object

serializedName

serializedName: string = "prefix"

type

type: object

name

Const quota

quota: object

parameterPath

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "restype"

type

type: object

name

Const restype1

restype1: object

parameterPath

parameterPath: string = "restype"

mapper

mapper: object

defaultValue

defaultValue: string = "share"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "restype"

type

type: object

name

Const restype2

restype2: object

parameterPath

parameterPath: string = "restype"

mapper

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

Const url

url: object

parameterPath

parameterPath: string = "url"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

defaultValue

defaultValue: string = ""

required

required: boolean = true

serializedName

serializedName: string = "url"

type

type: object

name

Const version

version: object

parameterPath

parameterPath: string = "version"

mapper

mapper: object

required

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

FileAttributesPreserveType

FileCreateResponse

FileDeleteResponse

FileForceCloseHandlesResponse

FileGetPropertiesResponse

FileGetRangeListResponse

FileListHandlesResponse

FilePermissionInheritType

FilePermissionPreserveType

FileRangeWriteType

FileSetHTTPHeadersResponse

FileSetMetadataResponse

FileStartCopyResponse

FileType

FileUploadRangeFromURLResponse

FileUploadRangeResponse

ListSharesIncludeType

Operation

Type declaration

Returns Promise<any>

OutgoingHandler

Type declaration

Parameters

buffer: Buffer

Optional offset: undefined | number

Returns Promise<any>

ReadableStreamGetter

Type declaration

Parameters

offset: number

Returns Promise<NodeJS.ReadableStream>

ServiceGetPropertiesResponse

ServiceListSharesSegmentResponse

ServiceSetPropertiesResponse

ShareCreatePermissionResponse

ShareCreateResponse

ShareCreateSnapshotResponse

ShareDeleteResponse

ShareGetAccessPolicyResponse

ShareGetPermissionResponse

ShareGetPropertiesResponse

ShareGetStatisticsResponse

ShareSetAccessPolicyResponse

ShareSetMetadataResponse

ShareSetQuotaResponse

StorageErrorCode

TimeNowType

TimePreserveType

Variables

Const DEFAULT_HIGH_LEVEL_CONCURRENCY

Const DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS

Const ETagAny

Const ETagNone

Const FILE_MAX_SIZE_BYTES