Package version
Options to query file with Apache Arrow format. Only valid for FileQueryOptions.outputTextConfiguration.
Contains response data for the create operation.
Contains response data for the deleteMethod operation.
Contains response data for the getProperties operation.
Contains response data for the listPaths operation.
Contains response data for the setProperties operation.
Operation is an async function to be executed and managed by Batch.
OutgoingHandler is an async function triggered by BufferScheduler. OutgoingHandler is an async function triggered by BufferScheduler.
Contains response data for the appendData operation.
Contains response data for the create operation.
Contains response data for the deleteMethod operation.
Defines values for PathExpiryOptions. Possible values include: 'NeverExpire', 'RelativeToCreation', 'RelativeToNow', 'Absolute'
Contains response data for the flushData operation.
Contains response data for the getProperties operation.
Defines values for PathLeaseAction. Possible values include: 'acquire', 'break', 'change', 'renew', 'release'
Contains response data for the lease operation.
Contains response data for the read operation.
Defines values for PathSetAccessControlRecursiveMode. Possible values include: 'set', 'modify', 'remove'
Contains response data for the setAccessControlRecursive operation.
Contains response data for the setAccessControl operation.
Contains response data for the setExpiry operation.
Defines values for PathUpdateAction. Possible values include: 'append', 'flush', 'setProperties', 'setAccessControl', 'setAccessControlRecursive'
Contains response data for the update operation.
Contains response data for the listFileSystems operation.
The @azure/logger configuration for this package.
maxBufferLength is max size of each buffer in the pooled buffers.
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.
Convert a Browser Blob object into string.
Creates a span using the global tracer.
The options 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 constructors, 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" instead 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. IMPLEMENTATION FOR API VERSION FROM 2015-04-05 AND BEFORE 2018-11-09.
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.
ONLY AVAILABLE IN NODE.JS RUNTIME. IMPLEMENTATION FOR API VERSION FROM 2018-11-09.
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.
ONLY AVAILABLE IN NODE.JS RUNTIME. IMPLEMENTATION FOR API VERSION FROM 2018-11-09.
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.
WARNING: identifier will be ignored, permissions and expiresOn are required.
ONLY AVAILABLE IN NODE.JS RUNTIME. IMPLEMENTATION FOR API VERSION FROM 2020-02-10.
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.
WARNING: identifier will be ignored, permissions and expiresOn are required.
Generate a 64 bytes base64 block ID string.
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.
Fill in the required details before running the following snippets.
ONLY AVAILABLE IN NODE.JS RUNTIME.
Creates an instance of SASQueryParameters. WARNING: identifier will be ignored when generating user delegation SAS, permissions and expiresOn are required.
Return value of blobServiceClient.getUserDelegationKey()
Extracts account name from the blobEndpointUrl
blobEndpointUrl to extract the account name from
account name
Get URL parameter by name.
Get URL path from an URL string.
Source URL string
Get URL path and query from an URL string.
Source URL string
Get URL query key value pairs from an URL string.
Get URL scheme from an URL string.
Source URL string
If two strings are equal when compared case insensitive.
Generate SasIPRange format string. For example:
"8.8.8.8" or "1.1.1.1-255.255.255.255"
Creates a new Pipeline object with Credential provided.
Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
A new Pipeline object.
String.prototype.padStart()
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
Set URL path.
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
Reads a readable stream into buffer entirely.
A Node.js Readable stream
Buffer to be filled, length must >= offset
with the count of bytes read.
Get a blob endpoint URL from incoming blob or dfs endpoint URLs. Only handle known host name pair patterns, add more patterns into ToBlobEndpointHostMappings in constants.ts.
Expected input and outputs: http://account.blob.core.windows.net => http://account.blob.core.windows.net http://account.dfs.core.windows.net => http://account.blob.core.windows.net http://127.0.0.1:10000 => http://127.0.0.1:10000 http://account.blob.core.windows.net/abc => http://account.blob.core.windows.net/abc http://account.dfs.core.windows.net/abc => http://account.blob.core.windows.net/abc http://127.0.0.1:10000/abc => http://127.0.0.1:10000/abc
Get a dfs endpoint URL from incoming blob or dfs endpoint URLs. Only handle known host name pair patterns, add more patterns into ToDfsEndpointHostMappings in constants.ts.
Expected input and outputs: http://account.blob.core.windows.net => http://account.dfs.core.windows.net http://account.dfs.core.windows.net => http://account.dfs.core.windows.net http://127.0.0.1:10000 => http://127.0.0.1:10000 http://account.blob.core.windows.net/abc => http://account.dfs.core.windows.net/abc http://account.dfs.core.windows.net/abc => http://account.dfs.core.windows.net/abc http://127.0.0.1:10000/abc => http://127.0.0.1:10000/abc
Rounds a date off to seconds.
Date string in ISO8061 format, with or without 7 milliseconds component
Generated using TypeDoc
A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.