A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
Defines values for DeleteSnapshotsOptionType. Possible values include: 'include'
Contains response data for the create operation.
Contains response data for the deleteMethod operation.
Contains response data for the forceCloseHandles operation. Response type for ShareDirectoryClient.forceCloseHandle.
Contains response data for the getProperties operation.
Contains response data for the listFilesAndDirectoriesSegment operation.
Contains response data for the listHandles operation.
Contains response data for the setMetadata operation.
Contains response data for the setProperties operation.
Contains response data for the abortCopy operation.
Contains response data for the acquireLease operation.
Indicates keep existing file attributes unchanged.
Contains response data for the breakLease operation.
Contains response data for the changeLease operation.
Contains response data for the create operation.
Contains response data for the deleteMethod operation.
Contains response data for the forceCloseHandles operation. Response type for ShareFileClient.forceCloseHandle.
Contains response data for the getProperties operation.
Contains response data for the getRangeList operation. Contains response data for the ShareFileClient.getRangeList operation.
Contains response data for the listHandles operation.
Indicates inherit file permission from the parent directory.
Indicates keep existing file permission value unchanged.
Defines values for FileRangeWriteType. Possible values include: 'update', 'clear'
Contains response data for the releaseLease operation.
Contains response data for the setHTTPHeaders operation.
Contains response data for the setMetadata operation.
Contains response data for the startCopy operation.
Defines values for FileType. Possible values include: 'File'
Contains response data for the uploadRangeFromURL operation.
Contains response data for the uploadRange operation.
Defines values for LeaseDurationType. Possible values include: 'infinite', 'fixed'
Contains the response data for operations that acquire, change, break or release a lease.
See ShareLeaseClient.
Defines values for LeaseStateType. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'
Defines values for LeaseStatusType. Possible values include: 'locked', 'unlocked'
Defines values for ListSharesIncludeType. Possible values include: 'snapshots', 'metadata', 'deleted'
Operation is an async function to be executed and managed by Batch.
OutgoingHandler is an async function triggered by BufferScheduler.
Defines values for PermissionCopyModeType. Possible values include: 'source', 'override'
Contains response data for the getProperties operation.
Contains response data for the listSharesSegment operation.
Contains response data for the setProperties operation.
Contains response data for the createPermission operation.
Contains response data for the create operation.
Contains response data for the createSnapshot operation.
Contains response data for the deleteMethod operation.
Contains response data for the getAccessPolicy operation.
Contains response data for the getPermission operation.
Contains response data for the getProperties operation.
Contains response data for the getStatistics operation. Response data for the ShareClient.getStatistics Operation.
Contains response data for the restore operation.
Contains response data for the setAccessPolicy operation.
Contains response data for the setMetadata operation.
Contains response data for the setQuota operation.
Defines values for StorageErrorCode. Possible values include: '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'
Indicates setting as the time of the request.
Indicates keep existing time value unchanged.
The @azure/logger configuration for this package.
A factory method used to generated a RetryPolicy factory.
Append a string to URL path. Will remove duplicated "/" in front of the string when URL path ends with a "/".
Source URL string
String to be appended to URL
An updated URL string
Base64 decode.
Base64 encode.
Convert a Browser Blob object into ArrayBuffer.
Creates a span using the global tracer.
The tracingOptions for the underlying http request.
Delay specified time interval.
Internal escape method implemented Strategy Two mentioned in escapeURL() description.
Reserved URL characters must be properly escaped for Storage services like Blob or File.
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.
This is what legacy V2 SDK does, simple and works for most of the cases.
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:
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.
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.
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.
Extracts the parts of an Azure Storage account connection string.
Connection string.
String key value pairs of the storage account's url and credentials.
ONLY AVAILABLE IN NODE.JS RUNTIME.
Promisified version of fs.stat().
ONLY AVAILABLE IN NODE.JS RUNTIME.
Generates a SASQueryParameters object which contains all SAS query parameters needed to make an actual REST request.
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.
Extracts account name from the url
url to extract the account name from
with the account name
Get URL parameter by name.
Get URL path from an URL string.
Source URL string
Get URL query key value pairs from an URL string.
Generate SasIPRange format string. For example:
"8.8.8.8" or "1.1.1.1-255.255.255.255"
A range of IP addresses.
string representation of the IP range.
Creates a new Pipeline object with Credential provided.
Such as AnonymousCredential, StorageSharedKeyCredential.
A new Pipeline object.
String.prototype.padStart()
Generate a range string. For example:
"bytes=255-" or "bytes=0-511"
A range of byte positions.
The string representation for the byte range.
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.
The read stream.
Destination file path.
Set URL host.
Source URL string
New host string
An updated URL string
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.
Source URL string
Parameter name
An updated URL string
Reads a readable stream into buffer. Fill the buffer from offset to end.
A Node.js Readable stream
Buffer to be filled, length must >= offset
From which position in the buffer to be filled, inclusive
To which position in the buffer to be filled, exclusive
Rounds a date off to seconds.
Date string in ISO8061 format, with or without 7 milliseconds component
Generated using TypeDoc
Defines values for CopyStatusType. Possible values include: 'pending', 'success', 'aborted', 'failed'