@azure/storage-blob 12.26.0-alpha.20241227.1 → 12.26.0-alpha.20250217.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +3 -3
- package/README.md +17 -19
- package/dist/index.js +104 -116
- package/dist/index.js.map +1 -1
- package/dist-esm/storage-blob/src/BatchResponseParser.js +1 -1
- package/dist-esm/storage-blob/src/BatchResponseParser.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobBatch.js +1 -1
- package/dist-esm/storage-blob/src/BlobBatch.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobBatchClient.js +2 -2
- package/dist-esm/storage-blob/src/BlobBatchClient.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobLeaseClient.js +10 -10
- package/dist-esm/storage-blob/src/BlobLeaseClient.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobServiceClient.js +11 -11
- package/dist-esm/storage-blob/src/BlobServiceClient.js.map +1 -1
- package/dist-esm/storage-blob/src/Clients.js +43 -43
- package/dist-esm/storage-blob/src/Clients.js.map +1 -1
- package/dist-esm/storage-blob/src/ContainerClient.js +18 -18
- package/dist-esm/storage-blob/src/ContainerClient.js.map +1 -1
- package/dist-esm/storage-blob/src/Range.js.map +1 -1
- package/dist-esm/storage-blob/src/StorageRetryPolicyFactory.js.map +1 -1
- package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js +1 -1
- package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js.map +1 -1
- package/dist-esm/storage-blob/src/models.js +2 -2
- package/dist-esm/storage-blob/src/models.js.map +1 -1
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js +2 -2
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js.map +1 -1
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js +2 -2
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js.map +1 -1
- package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js +2 -2
- package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js.map +1 -1
- package/dist-esm/storage-blob/src/sas/AccountSASResourceTypes.js +1 -1
- package/dist-esm/storage-blob/src/sas/AccountSASResourceTypes.js.map +1 -1
- package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js +1 -1
- package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js.map +1 -1
- package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js +1 -1
- package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js.map +1 -1
- package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js +1 -1
- package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js.map +1 -1
- package/dist-esm/storage-blob/src/sas/SASQueryParameters.js.map +1 -1
- package/dist-esm/storage-blob/src/utils/utils.common.js +3 -3
- package/dist-esm/storage-blob/src/utils/utils.common.js.map +1 -1
- package/package.json +4 -4
- package/types/latest/storage-blob.d.ts +131 -131
package/dist/index.js
CHANGED
@@ -107,22 +107,15 @@ const StorageOAuthScopes = "https://storage.azure.com/.default";
|
|
107
107
|
const URLConstants = {
|
108
108
|
Parameters: {
|
109
109
|
FORCE_BROWSER_NO_CACHE: "_",
|
110
|
-
SIGNATURE: "sig",
|
111
110
|
SNAPSHOT: "snapshot",
|
112
111
|
VERSIONID: "versionid",
|
113
112
|
TIMEOUT: "timeout",
|
114
113
|
},
|
115
114
|
};
|
116
115
|
const HTTPURLConnection = {
|
117
|
-
HTTP_ACCEPTED: 202
|
118
|
-
HTTP_CONFLICT: 409,
|
119
|
-
HTTP_NOT_FOUND: 404,
|
120
|
-
HTTP_PRECON_FAILED: 412,
|
121
|
-
HTTP_RANGE_NOT_SATISFIABLE: 416,
|
122
|
-
};
|
116
|
+
HTTP_ACCEPTED: 202};
|
123
117
|
const HeaderConstants = {
|
124
118
|
AUTHORIZATION: "Authorization",
|
125
|
-
AUTHORIZATION_SCHEME: "Bearer",
|
126
119
|
CONTENT_ENCODING: "Content-Encoding",
|
127
120
|
CONTENT_ID: "Content-ID",
|
128
121
|
CONTENT_LANGUAGE: "Content-Language",
|
@@ -138,14 +131,9 @@ const HeaderConstants = {
|
|
138
131
|
IF_UNMODIFIED_SINCE: "if-unmodified-since",
|
139
132
|
PREFIX_FOR_STORAGE: "x-ms-",
|
140
133
|
RANGE: "Range",
|
141
|
-
USER_AGENT: "User-Agent",
|
142
|
-
X_MS_CLIENT_REQUEST_ID: "x-ms-client-request-id",
|
143
|
-
X_MS_COPY_SOURCE: "x-ms-copy-source",
|
144
134
|
X_MS_DATE: "x-ms-date",
|
145
135
|
X_MS_ERROR_CODE: "x-ms-error-code",
|
146
|
-
X_MS_VERSION: "x-ms-version"
|
147
|
-
X_MS_CopySourceErrorCode: "x-ms-copy-source-error-code",
|
148
|
-
};
|
136
|
+
X_MS_VERSION: "x-ms-version"};
|
149
137
|
const ETagNone = "";
|
150
138
|
const ETagAny = "*";
|
151
139
|
const SIZE_1_MB = 1 * 1024 * 1024;
|
@@ -364,8 +352,8 @@ const PathStylePorts = [
|
|
364
352
|
*
|
365
353
|
* 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.
|
366
354
|
*
|
367
|
-
* @see https://
|
368
|
-
* @see https://
|
355
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
|
356
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-shares--directories--files--and-metadata
|
369
357
|
*
|
370
358
|
* @param url -
|
371
359
|
*/
|
@@ -379,7 +367,7 @@ function escapeURLPath(url) {
|
|
379
367
|
}
|
380
368
|
function getProxyUriFromDevConnString(connectionString) {
|
381
369
|
// Development Connection String
|
382
|
-
// https://
|
370
|
+
// https://learn.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string#connect-to-the-emulator-account-using-the-well-known-account-name-and-key
|
383
371
|
let proxyUri = "";
|
384
372
|
if (connectionString.search("DevelopmentStorageProxyUri=") !== -1) {
|
385
373
|
// CONNECTION_STRING=UseDevelopmentStorage=true;DevelopmentStorageProxyUri=http://myProxyUri
|
@@ -1420,7 +1408,7 @@ class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
1420
1408
|
}
|
1421
1409
|
/**
|
1422
1410
|
* Retrieve header value according to shared key sign rules.
|
1423
|
-
* @see https://
|
1411
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
|
1424
1412
|
*
|
1425
1413
|
* @param request -
|
1426
1414
|
* @param headerName -
|
@@ -1432,7 +1420,7 @@ class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
1432
1420
|
}
|
1433
1421
|
// When using version 2015-02-21 or later, if Content-Length is zero, then
|
1434
1422
|
// set the Content-Length part of the StringToSign to an empty string.
|
1435
|
-
// https://
|
1423
|
+
// https://learn.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
|
1436
1424
|
if (headerName === HeaderConstants.CONTENT_LENGTH && value === "0") {
|
1437
1425
|
return "";
|
1438
1426
|
}
|
@@ -1853,7 +1841,7 @@ function storageSharedKeyCredentialPolicy(options) {
|
|
1853
1841
|
}
|
1854
1842
|
/**
|
1855
1843
|
* Retrieve header value according to shared key sign rules.
|
1856
|
-
* @see https://
|
1844
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
|
1857
1845
|
*/
|
1858
1846
|
function getHeaderValueToSign(request, headerName) {
|
1859
1847
|
const value = request.headers.get(headerName);
|
@@ -1862,7 +1850,7 @@ function storageSharedKeyCredentialPolicy(options) {
|
|
1862
1850
|
}
|
1863
1851
|
// When using version 2015-02-21 or later, if Content-Length is zero, then
|
1864
1852
|
// set the Content-Length part of the StringToSign to an empty string.
|
1865
|
-
// https://
|
1853
|
+
// https://learn.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
|
1866
1854
|
if (headerName === HeaderConstants.CONTENT_LENGTH && value === "0") {
|
1867
1855
|
return "";
|
1868
1856
|
}
|
@@ -15829,7 +15817,7 @@ class ContainerSASPermissions {
|
|
15829
15817
|
* order accepted by the service.
|
15830
15818
|
*
|
15831
15819
|
* The order of the characters should be as specified here to ensure correctness.
|
15832
|
-
* @see https://
|
15820
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
15833
15821
|
*
|
15834
15822
|
*/
|
15835
15823
|
toString() {
|
@@ -15883,7 +15871,7 @@ class ContainerSASPermissions {
|
|
15883
15871
|
* ONLY AVAILABLE IN NODE.JS RUNTIME.
|
15884
15872
|
*
|
15885
15873
|
* UserDelegationKeyCredential is only used for generation of user delegation SAS.
|
15886
|
-
* @see https://
|
15874
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-user-delegation-sas
|
15887
15875
|
*/
|
15888
15876
|
class UserDelegationKeyCredential {
|
15889
15877
|
/**
|
@@ -16180,7 +16168,7 @@ function generateBlobSASQueryParametersInternal(blobSASSignatureValues, sharedKe
|
|
16180
16168
|
}
|
16181
16169
|
// Version 2019-12-12 adds support for the blob tags permission.
|
16182
16170
|
// Version 2018-11-09 adds support for the signed resource and signed blob snapshot time fields.
|
16183
|
-
// https://
|
16171
|
+
// https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas#constructing-the-signature-string
|
16184
16172
|
if (version >= "2018-11-09") {
|
16185
16173
|
if (sharedKeyCredential !== undefined) {
|
16186
16174
|
return generateBlobSASQueryParameters20181109(blobSASSignatureValues, sharedKeyCredential);
|
@@ -16767,9 +16755,9 @@ class BlobLeaseClient {
|
|
16767
16755
|
* Establishes and manages a lock on a container for delete operations, or on a blob
|
16768
16756
|
* for write and delete operations.
|
16769
16757
|
* The lock duration can be 15 to 60 seconds, or can be infinite.
|
16770
|
-
* @see https://
|
16758
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container
|
16771
16759
|
* and
|
16772
|
-
* @see https://
|
16760
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob
|
16773
16761
|
*
|
16774
16762
|
* @param duration - Must be between 15 to 60 seconds, or infinite (-1)
|
16775
16763
|
* @param options - option to configure lease management operations.
|
@@ -16796,9 +16784,9 @@ class BlobLeaseClient {
|
|
16796
16784
|
}
|
16797
16785
|
/**
|
16798
16786
|
* To change the ID of the lease.
|
16799
|
-
* @see https://
|
16787
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container
|
16800
16788
|
* and
|
16801
|
-
* @see https://
|
16789
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob
|
16802
16790
|
*
|
16803
16791
|
* @param proposedLeaseId - the proposed new lease Id.
|
16804
16792
|
* @param options - option to configure lease management operations.
|
@@ -16826,9 +16814,9 @@ class BlobLeaseClient {
|
|
16826
16814
|
/**
|
16827
16815
|
* To free the lease if it is no longer needed so that another client may
|
16828
16816
|
* immediately acquire a lease against the container or the blob.
|
16829
|
-
* @see https://
|
16817
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container
|
16830
16818
|
* and
|
16831
|
-
* @see https://
|
16819
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob
|
16832
16820
|
*
|
16833
16821
|
* @param options - option to configure lease management operations.
|
16834
16822
|
* @returns Response data for release lease operation.
|
@@ -16852,9 +16840,9 @@ class BlobLeaseClient {
|
|
16852
16840
|
}
|
16853
16841
|
/**
|
16854
16842
|
* To renew the lease.
|
16855
|
-
* @see https://
|
16843
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container
|
16856
16844
|
* and
|
16857
|
-
* @see https://
|
16845
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob
|
16858
16846
|
*
|
16859
16847
|
* @param options - Optional option to configure lease management operations.
|
16860
16848
|
* @returns Response data for renew lease operation.
|
@@ -16879,9 +16867,9 @@ class BlobLeaseClient {
|
|
16879
16867
|
/**
|
16880
16868
|
* To end the lease but ensure that another client cannot acquire a new lease
|
16881
16869
|
* until the current lease period has expired.
|
16882
|
-
* @see https://
|
16870
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container
|
16883
16871
|
* and
|
16884
|
-
* @see https://
|
16872
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob
|
16885
16873
|
*
|
16886
16874
|
* @param breakPeriod - Break period
|
16887
16875
|
* @param options - Optional options to configure lease management operations.
|
@@ -18491,7 +18479,7 @@ class BlobQueryResponse {
|
|
18491
18479
|
// Licensed under the MIT License.
|
18492
18480
|
/**
|
18493
18481
|
* Represents the access tier on a blob.
|
18494
|
-
* For detailed information about block blob level tiering see {@link https://
|
18482
|
+
* For detailed information about block blob level tiering see {@link https://learn.microsoft.com/azure/storage/blobs/storage-blob-storage-tiers|Hot, cool and archive storage tiers.}
|
18495
18483
|
*/
|
18496
18484
|
exports.BlockBlobTier = void 0;
|
18497
18485
|
(function (BlockBlobTier) {
|
@@ -18515,7 +18503,7 @@ exports.BlockBlobTier = void 0;
|
|
18515
18503
|
})(exports.BlockBlobTier || (exports.BlockBlobTier = {}));
|
18516
18504
|
/**
|
18517
18505
|
* Specifies the page blob tier to set the blob to. This is only applicable to page blobs on premium storage accounts.
|
18518
|
-
* Please see {@link https://
|
18506
|
+
* Please see {@link https://learn.microsoft.com/azure/storage/storage-premium-storage#scalability-and-performance-targets|here}
|
18519
18507
|
* for detailed information on the corresponding IOPS and throughput per PageBlobTier.
|
18520
18508
|
*/
|
18521
18509
|
exports.PremiumPageBlobTier = void 0;
|
@@ -19558,7 +19546,7 @@ class BlobClient extends StorageClient {
|
|
19558
19546
|
* * In Node.js, data returns in a Readable stream readableStreamBody
|
19559
19547
|
* * In browsers, data returns in a promise blobBody
|
19560
19548
|
*
|
19561
|
-
* @see https://
|
19549
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob
|
19562
19550
|
*
|
19563
19551
|
* @param offset - From which position of the blob to download, greater than or equal to 0
|
19564
19552
|
* @param count - How much data to be downloaded, greater than 0. Will download to the end when undefined
|
@@ -19722,7 +19710,7 @@ class BlobClient extends StorageClient {
|
|
19722
19710
|
/**
|
19723
19711
|
* Returns all user-defined metadata, standard HTTP properties, and system properties
|
19724
19712
|
* for the blob. It does not return the content of the blob.
|
19725
|
-
* @see https://
|
19713
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
|
19726
19714
|
*
|
19727
19715
|
* WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
|
19728
19716
|
* they originally contained uppercase characters. This differs from the metadata keys returned by
|
@@ -19751,7 +19739,7 @@ class BlobClient extends StorageClient {
|
|
19751
19739
|
* during garbage collection. Note that in order to delete a blob, you must delete
|
19752
19740
|
* all of its snapshots. You can delete both at the same time with the Delete
|
19753
19741
|
* Blob operation.
|
19754
|
-
* @see https://
|
19742
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob
|
19755
19743
|
*
|
19756
19744
|
* @param options - Optional options to Blob Delete operation.
|
19757
19745
|
*/
|
@@ -19773,7 +19761,7 @@ class BlobClient extends StorageClient {
|
|
19773
19761
|
* during garbage collection. Note that in order to delete a blob, you must delete
|
19774
19762
|
* all of its snapshots. You can delete both at the same time with the Delete
|
19775
19763
|
* Blob operation.
|
19776
|
-
* @see https://
|
19764
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob
|
19777
19765
|
*
|
19778
19766
|
* @param options - Optional options to Blob Delete operation.
|
19779
19767
|
*/
|
@@ -19796,7 +19784,7 @@ class BlobClient extends StorageClient {
|
|
19796
19784
|
* Restores the contents and metadata of soft deleted blob and any associated
|
19797
19785
|
* soft deleted snapshots. Undelete Blob is supported only on version 2017-07-29
|
19798
19786
|
* or later.
|
19799
|
-
* @see https://
|
19787
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/undelete-blob
|
19800
19788
|
*
|
19801
19789
|
* @param options - Optional options to Blob Undelete operation.
|
19802
19790
|
*/
|
@@ -19813,7 +19801,7 @@ class BlobClient extends StorageClient {
|
|
19813
19801
|
*
|
19814
19802
|
* If no value provided, or no value provided for the specified blob HTTP headers,
|
19815
19803
|
* these blob HTTP headers without a value will be cleared.
|
19816
|
-
* @see https://
|
19804
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
|
19817
19805
|
*
|
19818
19806
|
* @param blobHTTPHeaders - If no value provided, or no value provided for
|
19819
19807
|
* the specified blob HTTP headers, these blob HTTP
|
@@ -19843,7 +19831,7 @@ class BlobClient extends StorageClient {
|
|
19843
19831
|
*
|
19844
19832
|
* If no option provided, or no metadata defined in the parameter, the blob
|
19845
19833
|
* metadata will be removed.
|
19846
|
-
* @see https://
|
19834
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
|
19847
19835
|
*
|
19848
19836
|
* @param metadata - Replace existing metadata with this value.
|
19849
19837
|
* If no value provided the existing metadata will be removed.
|
@@ -19915,7 +19903,7 @@ class BlobClient extends StorageClient {
|
|
19915
19903
|
}
|
19916
19904
|
/**
|
19917
19905
|
* Creates a read-only snapshot of a blob.
|
19918
|
-
* @see https://
|
19906
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
|
19919
19907
|
*
|
19920
19908
|
* @param options - Optional options to the Blob Create Snapshot operation.
|
19921
19909
|
*/
|
@@ -19949,7 +19937,7 @@ class BlobClient extends StorageClient {
|
|
19949
19937
|
* an Azure file in any Azure storage account.
|
19950
19938
|
* Only storage accounts created on or after June 7th, 2012 allow the Copy Blob
|
19951
19939
|
* operation to copy from another storage account.
|
19952
|
-
* @see https://
|
19940
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob
|
19953
19941
|
*
|
19954
19942
|
* Example using automatic polling:
|
19955
19943
|
*
|
@@ -20029,7 +20017,7 @@ class BlobClient extends StorageClient {
|
|
20029
20017
|
/**
|
20030
20018
|
* Aborts a pending asynchronous Copy Blob operation, and leaves a destination blob with zero
|
20031
20019
|
* length and full metadata. Version 2012-02-12 and newer.
|
20032
|
-
* @see https://
|
20020
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
|
20033
20021
|
*
|
20034
20022
|
* @param copyId - Id of the Copy From URL operation.
|
20035
20023
|
* @param options - Optional options to the Blob Abort Copy From URL operation.
|
@@ -20046,7 +20034,7 @@ class BlobClient extends StorageClient {
|
|
20046
20034
|
/**
|
20047
20035
|
* The synchronous Copy From URL operation copies a blob or an internet resource to a new blob. It will not
|
20048
20036
|
* return a response until the copy is complete.
|
20049
|
-
* @see https://
|
20037
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
|
20050
20038
|
*
|
20051
20039
|
* @param copySource - The source URL to copy from, Shared Access Signature(SAS) maybe needed for authentication
|
20052
20040
|
* @param options -
|
@@ -20086,7 +20074,7 @@ class BlobClient extends StorageClient {
|
|
20086
20074
|
* storage only). A premium page blob's tier determines the allowed size, IOPS,
|
20087
20075
|
* and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive
|
20088
20076
|
* storage type. This operation does not update the blob's ETag.
|
20089
|
-
* @see https://
|
20077
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
|
20090
20078
|
*
|
20091
20079
|
* @param tier - The tier to be set on the blob. Valid values are Hot, Cool, or Archive.
|
20092
20080
|
* @param options - Optional options to the Blob Set Tier operation.
|
@@ -20271,7 +20259,7 @@ class BlobClient extends StorageClient {
|
|
20271
20259
|
* an Azure file in any Azure storage account.
|
20272
20260
|
* Only storage accounts created on or after June 7th, 2012 allow the Copy Blob
|
20273
20261
|
* operation to copy from another storage account.
|
20274
|
-
* @see https://
|
20262
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob
|
20275
20263
|
*
|
20276
20264
|
* @param copySource - url to the source Azure Blob/File.
|
20277
20265
|
* @param options - Optional options to the Blob Start Copy From URL operation.
|
@@ -20310,7 +20298,7 @@ class BlobClient extends StorageClient {
|
|
20310
20298
|
* Generates a Blob Service Shared Access Signature (SAS) URI based on the client properties
|
20311
20299
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
20312
20300
|
*
|
20313
|
-
* @see https://
|
20301
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
20314
20302
|
*
|
20315
20303
|
* @param options - Optional parameters.
|
20316
20304
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
@@ -20330,7 +20318,7 @@ class BlobClient extends StorageClient {
|
|
20330
20318
|
* Generates string to sign for a Blob Service Shared Access Signature (SAS) URI based on
|
20331
20319
|
* the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
|
20332
20320
|
*
|
20333
|
-
* @see https://
|
20321
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
20334
20322
|
*
|
20335
20323
|
* @param options - Optional parameters.
|
20336
20324
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
@@ -20347,7 +20335,7 @@ class BlobClient extends StorageClient {
|
|
20347
20335
|
* Generates a Blob Service Shared Access Signature (SAS) URI based on
|
20348
20336
|
* the client properties and parameters passed in. The SAS is signed by the input user delegation key.
|
20349
20337
|
*
|
20350
|
-
* @see https://
|
20338
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
20351
20339
|
*
|
20352
20340
|
* @param options - Optional parameters.
|
20353
20341
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
@@ -20365,7 +20353,7 @@ class BlobClient extends StorageClient {
|
|
20365
20353
|
* Generates string to sign for a Blob Service Shared Access Signature (SAS) URI based on
|
20366
20354
|
* the client properties and parameters passed in. The SAS is signed by the input user delegation key.
|
20367
20355
|
*
|
20368
|
-
* @see https://
|
20356
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
20369
20357
|
*
|
20370
20358
|
* @param options - Optional parameters.
|
20371
20359
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
@@ -20417,7 +20405,7 @@ class BlobClient extends StorageClient {
|
|
20417
20405
|
* for the specified account.
|
20418
20406
|
* The Get Account Information operation is available on service versions beginning
|
20419
20407
|
* with version 2018-03-28.
|
20420
|
-
* @see https://
|
20408
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information
|
20421
20409
|
*
|
20422
20410
|
* @param options - Options to the Service Get Account Info operation.
|
20423
20411
|
* @returns Response data for the Service Get Account Info operation.
|
@@ -20515,7 +20503,7 @@ class AppendBlobClient extends BlobClient {
|
|
20515
20503
|
}
|
20516
20504
|
/**
|
20517
20505
|
* Creates a 0-length append blob. Call AppendBlock to append data to an append blob.
|
20518
|
-
* @see https://
|
20506
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-blob
|
20519
20507
|
*
|
20520
20508
|
* @param options - Options to the Append Block Create operation.
|
20521
20509
|
*
|
@@ -20551,7 +20539,7 @@ class AppendBlobClient extends BlobClient {
|
|
20551
20539
|
/**
|
20552
20540
|
* Creates a 0-length append blob. Call AppendBlock to append data to an append blob.
|
20553
20541
|
* If the blob with the same name already exists, the content of the existing blob will remain unchanged.
|
20554
|
-
* @see https://
|
20542
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-blob
|
20555
20543
|
*
|
20556
20544
|
* @param options -
|
20557
20545
|
*/
|
@@ -20591,7 +20579,7 @@ class AppendBlobClient extends BlobClient {
|
|
20591
20579
|
}
|
20592
20580
|
/**
|
20593
20581
|
* Commits a new block of data to the end of the existing append blob.
|
20594
|
-
* @see https://
|
20582
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/append-block
|
20595
20583
|
*
|
20596
20584
|
* @param body - Data to be appended.
|
20597
20585
|
* @param contentLength - Length of the body in bytes.
|
@@ -20637,7 +20625,7 @@ class AppendBlobClient extends BlobClient {
|
|
20637
20625
|
/**
|
20638
20626
|
* The Append Block operation commits a new block of data to the end of an existing append blob
|
20639
20627
|
* where the contents are read from a source url.
|
20640
|
-
* @see https://
|
20628
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/append-block-from-url
|
20641
20629
|
*
|
20642
20630
|
* @param sourceURL -
|
20643
20631
|
* The url to the blob that will be the source of the copy. A source blob in the same storage account can
|
@@ -20830,7 +20818,7 @@ class BlockBlobClient extends BlobClient {
|
|
20830
20818
|
* {@link uploadStream} or {@link uploadBrowserData} for better performance
|
20831
20819
|
* with concurrency uploading.
|
20832
20820
|
*
|
20833
|
-
* @see https://
|
20821
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-blob
|
20834
20822
|
*
|
20835
20823
|
* @param body - Blob, string, ArrayBuffer, ArrayBufferView or a function
|
20836
20824
|
* which returns a new Readable stream whose offset is from data source beginning.
|
@@ -20906,7 +20894,7 @@ class BlockBlobClient extends BlobClient {
|
|
20906
20894
|
/**
|
20907
20895
|
* Uploads the specified block to the block blob's "staging area" to be later
|
20908
20896
|
* committed by a call to commitBlockList.
|
20909
|
-
* @see https://
|
20897
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-block
|
20910
20898
|
*
|
20911
20899
|
* @param blockId - A 64-byte value that is base64-encoded
|
20912
20900
|
* @param body - Data to upload to the staging area.
|
@@ -20935,7 +20923,7 @@ class BlockBlobClient extends BlobClient {
|
|
20935
20923
|
* The Stage Block From URL operation creates a new block to be committed as part
|
20936
20924
|
* of a blob where the contents are read from a URL.
|
20937
20925
|
* This API is available starting in version 2018-03-28.
|
20938
|
-
* @see https://
|
20926
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
|
20939
20927
|
*
|
20940
20928
|
* @param blockId - A 64-byte value that is base64-encoded
|
20941
20929
|
* @param sourceURL - Specifies the URL of the blob. The value
|
@@ -20974,7 +20962,7 @@ class BlockBlobClient extends BlobClient {
|
|
20974
20962
|
* to the server in a prior {@link stageBlock} operation. You can call {@link commitBlockList} to
|
20975
20963
|
* update a blob by uploading only those blocks that have changed, then committing the new and existing
|
20976
20964
|
* blocks together. Any blocks not specified in the block list and permanently deleted.
|
20977
|
-
* @see https://
|
20965
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-block-list
|
20978
20966
|
*
|
20979
20967
|
* @param blocks - Array of 64-byte value that is base64-encoded
|
20980
20968
|
* @param options - Options to the Block Blob Commit Block List operation.
|
@@ -21005,7 +20993,7 @@ class BlockBlobClient extends BlobClient {
|
|
21005
20993
|
/**
|
21006
20994
|
* Returns the list of blocks that have been uploaded as part of a block blob
|
21007
20995
|
* using the specified block list filter.
|
21008
|
-
* @see https://
|
20996
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-block-list
|
21009
20997
|
*
|
21010
20998
|
* @param listType - Specifies whether to return the list of committed blocks,
|
21011
20999
|
* the list of uncommitted blocks, or both lists together.
|
@@ -21339,7 +21327,7 @@ class PageBlobClient extends BlobClient {
|
|
21339
21327
|
/**
|
21340
21328
|
* Creates a page blob of the specified length. Call uploadPages to upload data
|
21341
21329
|
* data to a page blob.
|
21342
|
-
* @see https://
|
21330
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-blob
|
21343
21331
|
*
|
21344
21332
|
* @param size - size of the page blob.
|
21345
21333
|
* @param options - Options to the Page Blob Create operation.
|
@@ -21372,7 +21360,7 @@ class PageBlobClient extends BlobClient {
|
|
21372
21360
|
* Creates a page blob of the specified length. Call uploadPages to upload data
|
21373
21361
|
* data to a page blob. If the blob with the same name already exists, the content
|
21374
21362
|
* of the existing blob will remain unchanged.
|
21375
|
-
* @see https://
|
21363
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-blob
|
21376
21364
|
*
|
21377
21365
|
* @param size - size of the page blob.
|
21378
21366
|
* @param options -
|
@@ -21395,7 +21383,7 @@ class PageBlobClient extends BlobClient {
|
|
21395
21383
|
}
|
21396
21384
|
/**
|
21397
21385
|
* Writes 1 or more pages to the page blob. The start and end offsets must be a multiple of 512.
|
21398
|
-
* @see https://
|
21386
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-page
|
21399
21387
|
*
|
21400
21388
|
* @param body - Data to upload
|
21401
21389
|
* @param offset - Offset of destination page blob
|
@@ -21428,7 +21416,7 @@ class PageBlobClient extends BlobClient {
|
|
21428
21416
|
/**
|
21429
21417
|
* The Upload Pages operation writes a range of pages to a page blob where the
|
21430
21418
|
* contents are read from a URL.
|
21431
|
-
* @see https://
|
21419
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/put-page-from-url
|
21432
21420
|
*
|
21433
21421
|
* @param sourceURL - Specify a URL to the copy source, Shared Access Signature(SAS) maybe needed for authentication
|
21434
21422
|
* @param sourceOffset - The source offset to copy from. Pass 0 to copy from the beginning of source page blob
|
@@ -21464,7 +21452,7 @@ class PageBlobClient extends BlobClient {
|
|
21464
21452
|
}
|
21465
21453
|
/**
|
21466
21454
|
* Frees the specified pages from the page blob.
|
21467
|
-
* @see https://
|
21455
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-page
|
21468
21456
|
*
|
21469
21457
|
* @param offset - Starting byte position of the pages to clear.
|
21470
21458
|
* @param count - Number of bytes to clear.
|
@@ -21489,7 +21477,7 @@ class PageBlobClient extends BlobClient {
|
|
21489
21477
|
}
|
21490
21478
|
/**
|
21491
21479
|
* Returns the list of valid page ranges for a page blob or snapshot of a page blob.
|
21492
|
-
* @see https://
|
21480
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
|
21493
21481
|
*
|
21494
21482
|
* @param offset - Starting byte position of the page ranges.
|
21495
21483
|
* @param count - Number of bytes to get.
|
@@ -21515,7 +21503,7 @@ class PageBlobClient extends BlobClient {
|
|
21515
21503
|
* specified Marker. Use an empty Marker to start enumeration from the beginning.
|
21516
21504
|
* After getting a segment, process it, and then call getPageRangesSegment again
|
21517
21505
|
* (passing the the previously-returned Marker) to get the next segment.
|
21518
|
-
* @see https://
|
21506
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
|
21519
21507
|
*
|
21520
21508
|
* @param offset - Starting byte position of the page ranges.
|
21521
21509
|
* @param count - Number of bytes to get.
|
@@ -21592,7 +21580,7 @@ class PageBlobClient extends BlobClient {
|
|
21592
21580
|
}
|
21593
21581
|
/**
|
21594
21582
|
* Returns an async iterable iterator to list of page ranges for a page blob.
|
21595
|
-
* @see https://
|
21583
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
|
21596
21584
|
*
|
21597
21585
|
* .byPage() returns an async iterable iterator to list of page ranges for a page blob.
|
21598
21586
|
*
|
@@ -21688,7 +21676,7 @@ class PageBlobClient extends BlobClient {
|
|
21688
21676
|
}
|
21689
21677
|
/**
|
21690
21678
|
* Gets the collection of page ranges that differ between a specified snapshot and this page blob.
|
21691
|
-
* @see https://
|
21679
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
|
21692
21680
|
*
|
21693
21681
|
* @param offset - Starting byte position of the page blob
|
21694
21682
|
* @param count - Number of bytes to get ranges diff.
|
@@ -21717,7 +21705,7 @@ class PageBlobClient extends BlobClient {
|
|
21717
21705
|
* Use an empty Marker to start enumeration from the beginning.
|
21718
21706
|
* After getting a segment, process it, and then call getPageRangesDiffSegment again
|
21719
21707
|
* (passing the the previously-returned Marker) to get the next segment.
|
21720
|
-
* @see https://
|
21708
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
|
21721
21709
|
*
|
21722
21710
|
* @param offset - Starting byte position of the page ranges.
|
21723
21711
|
* @param count - Number of bytes to get.
|
@@ -21802,7 +21790,7 @@ class PageBlobClient extends BlobClient {
|
|
21802
21790
|
}
|
21803
21791
|
/**
|
21804
21792
|
* Returns an async iterable iterator to list of page ranges that differ between a specified snapshot and this page blob.
|
21805
|
-
* @see https://
|
21793
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
|
21806
21794
|
*
|
21807
21795
|
* .byPage() returns an async iterable iterator to list of page ranges that differ between a specified snapshot and this page blob.
|
21808
21796
|
*
|
@@ -21899,7 +21887,7 @@ class PageBlobClient extends BlobClient {
|
|
21899
21887
|
}
|
21900
21888
|
/**
|
21901
21889
|
* Gets the collection of page ranges that differ between a specified snapshot and this page blob for managed disks.
|
21902
|
-
* @see https://
|
21890
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
|
21903
21891
|
*
|
21904
21892
|
* @param offset - Starting byte position of the page blob
|
21905
21893
|
* @param count - Number of bytes to get ranges diff.
|
@@ -21924,7 +21912,7 @@ class PageBlobClient extends BlobClient {
|
|
21924
21912
|
}
|
21925
21913
|
/**
|
21926
21914
|
* Resizes the page blob to the specified size (which must be a multiple of 512).
|
21927
|
-
* @see https://
|
21915
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
|
21928
21916
|
*
|
21929
21917
|
* @param size - Target size
|
21930
21918
|
* @param options - Options to the Page Blob Resize operation.
|
@@ -21945,7 +21933,7 @@ class PageBlobClient extends BlobClient {
|
|
21945
21933
|
}
|
21946
21934
|
/**
|
21947
21935
|
* Sets a page blob's sequence number.
|
21948
|
-
* @see https://
|
21936
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
|
21949
21937
|
*
|
21950
21938
|
* @param sequenceNumberAction - Indicates how the service should modify the blob's sequence number.
|
21951
21939
|
* @param sequenceNumber - Required if sequenceNumberAction is max or update
|
@@ -21970,8 +21958,8 @@ class PageBlobClient extends BlobClient {
|
|
21970
21958
|
* The snapshot is copied such that only the differential changes between the previously
|
21971
21959
|
* copied snapshot are transferred to the destination.
|
21972
21960
|
* The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual.
|
21973
|
-
* @see https://
|
21974
|
-
* @see https://
|
21961
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/incremental-copy-blob
|
21962
|
+
* @see https://learn.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
|
21975
21963
|
*
|
21976
21964
|
* @param copySource - Specifies the name of the source page blob snapshot. For example,
|
21977
21965
|
* https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=<DateTime>
|
@@ -22027,7 +22015,7 @@ class BatchResponseParser {
|
|
22027
22015
|
this.perResponsePrefix = `--${this.responseBatchBoundary}${HTTP_LINE_ENDING}`;
|
22028
22016
|
this.batchResponseEnding = `--${this.responseBatchBoundary}--`;
|
22029
22017
|
}
|
22030
|
-
// For example of response, please refer to https://
|
22018
|
+
// For example of response, please refer to https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#response
|
22031
22019
|
async parseBatchResponse() {
|
22032
22020
|
// When logic reach here, suppose batch request has already succeeded with 202, so we can further parse
|
22033
22021
|
// sub request's response.
|
@@ -22322,7 +22310,7 @@ class BlobBatch {
|
|
22322
22310
|
}
|
22323
22311
|
/**
|
22324
22312
|
* Inner batch request class which is responsible for assembling and serializing sub requests.
|
22325
|
-
* See https://
|
22313
|
+
* See https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#request-body for how requests are assembled.
|
22326
22314
|
*/
|
22327
22315
|
class InnerBatchRequest {
|
22328
22316
|
constructor() {
|
@@ -22457,7 +22445,7 @@ function batchHeaderFilterPolicy() {
|
|
22457
22445
|
/**
|
22458
22446
|
* A BlobBatchClient allows you to make batched requests to the Azure Storage Blob service.
|
22459
22447
|
*
|
22460
|
-
* @see https://
|
22448
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
|
22461
22449
|
*/
|
22462
22450
|
class BlobBatchClient {
|
22463
22451
|
constructor(url, credentialOrPipeline,
|
@@ -22552,7 +22540,7 @@ class BlobBatchClient {
|
|
22552
22540
|
* console.log(batchResp.subResponsesSucceededCount);
|
22553
22541
|
* ```
|
22554
22542
|
*
|
22555
|
-
* @see https://
|
22543
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
|
22556
22544
|
*
|
22557
22545
|
* @param batchRequest - A set of Delete or SetTier operations.
|
22558
22546
|
* @param options -
|
@@ -22659,7 +22647,7 @@ class ContainerClient extends StorageClient {
|
|
22659
22647
|
/**
|
22660
22648
|
* Creates a new container under the specified account. If the container with
|
22661
22649
|
* the same name already exists, the operation fails.
|
22662
|
-
* @see https://
|
22650
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
|
22663
22651
|
* Naming rules: @see https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
|
22664
22652
|
*
|
22665
22653
|
* @param options - Options to Container Create operation.
|
@@ -22681,7 +22669,7 @@ class ContainerClient extends StorageClient {
|
|
22681
22669
|
/**
|
22682
22670
|
* Creates a new container under the specified account. If the container with
|
22683
22671
|
* the same name already exists, it is not changed.
|
22684
|
-
* @see https://
|
22672
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
|
22685
22673
|
* Naming rules: @see https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
|
22686
22674
|
*
|
22687
22675
|
* @param options -
|
@@ -22775,7 +22763,7 @@ class ContainerClient extends StorageClient {
|
|
22775
22763
|
/**
|
22776
22764
|
* Returns all user-defined metadata and system properties for the specified
|
22777
22765
|
* container. The data returned does not include the container's list of blobs.
|
22778
|
-
* @see https://
|
22766
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-properties
|
22779
22767
|
*
|
22780
22768
|
* WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
|
22781
22769
|
* they originally contained uppercase characters. This differs from the metadata keys returned by
|
@@ -22795,7 +22783,7 @@ class ContainerClient extends StorageClient {
|
|
22795
22783
|
/**
|
22796
22784
|
* Marks the specified container for deletion. The container and any blobs
|
22797
22785
|
* contained within it are later deleted during garbage collection.
|
22798
|
-
* @see https://
|
22786
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container
|
22799
22787
|
*
|
22800
22788
|
* @param options - Options to Container Delete operation.
|
22801
22789
|
*/
|
@@ -22815,7 +22803,7 @@ class ContainerClient extends StorageClient {
|
|
22815
22803
|
/**
|
22816
22804
|
* Marks the specified container for deletion if it exists. The container and any blobs
|
22817
22805
|
* contained within it are later deleted during garbage collection.
|
22818
|
-
* @see https://
|
22806
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container
|
22819
22807
|
*
|
22820
22808
|
* @param options - Options to Container Delete operation.
|
22821
22809
|
*/
|
@@ -22840,7 +22828,7 @@ class ContainerClient extends StorageClient {
|
|
22840
22828
|
* If no option provided, or no metadata defined in the parameter, the container
|
22841
22829
|
* metadata will be removed.
|
22842
22830
|
*
|
22843
|
-
* @see https://
|
22831
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
|
22844
22832
|
*
|
22845
22833
|
* @param metadata - Replace existing metadata with this value.
|
22846
22834
|
* If no value provided the existing metadata will be removed.
|
@@ -22870,7 +22858,7 @@ class ContainerClient extends StorageClient {
|
|
22870
22858
|
* WARNING: JavaScript Date will potentially lose precision when parsing startsOn and expiresOn strings.
|
22871
22859
|
* For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
|
22872
22860
|
*
|
22873
|
-
* @see https://
|
22861
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-acl
|
22874
22862
|
*
|
22875
22863
|
* @param options - Options to Container Get Access Policy operation.
|
22876
22864
|
*/
|
@@ -22928,7 +22916,7 @@ class ContainerClient extends StorageClient {
|
|
22928
22916
|
* When you establish a stored access policy on a container, it may take up to 30 seconds to take effect.
|
22929
22917
|
* During this interval, a shared access signature that is associated with the stored access policy will
|
22930
22918
|
* fail with status code 403 (Forbidden), until the access policy becomes active.
|
22931
|
-
* @see https://
|
22919
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-acl
|
22932
22920
|
*
|
22933
22921
|
* @param access - The level of public access to data in the container.
|
22934
22922
|
* @param containerAcl - Array of elements each having a unique Id and details of the access policy.
|
@@ -22983,7 +22971,7 @@ class ContainerClient extends StorageClient {
|
|
22983
22971
|
* {@link BlockBlobClient.uploadStream} or {@link BlockBlobClient.uploadBrowserData} for better
|
22984
22972
|
* performance with concurrency uploading.
|
22985
22973
|
*
|
22986
|
-
* @see https://
|
22974
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-blob
|
22987
22975
|
*
|
22988
22976
|
* @param blobName - Name of the block blob to create or update.
|
22989
22977
|
* @param body - Blob, string, ArrayBuffer, ArrayBufferView or a function
|
@@ -23008,7 +22996,7 @@ class ContainerClient extends StorageClient {
|
|
23008
22996
|
* during garbage collection. Note that in order to delete a blob, you must delete
|
23009
22997
|
* all of its snapshots. You can delete both at the same time with the Delete
|
23010
22998
|
* Blob operation.
|
23011
|
-
* @see https://
|
22999
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob
|
23012
23000
|
*
|
23013
23001
|
* @param blobName -
|
23014
23002
|
* @param options - Options to Blob Delete operation.
|
@@ -23028,7 +23016,7 @@ class ContainerClient extends StorageClient {
|
|
23028
23016
|
* specified Marker. Use an empty Marker to start enumeration from the beginning.
|
23029
23017
|
* After getting a segment, process it, and then call listBlobsFlatSegment again
|
23030
23018
|
* (passing the the previously-returned Marker) to get the next segment.
|
23031
|
-
* @see https://
|
23019
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/list-blobs
|
23032
23020
|
*
|
23033
23021
|
* @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
|
23034
23022
|
* @param options - Options to Container List Blob Flat Segment operation.
|
@@ -23048,7 +23036,7 @@ class ContainerClient extends StorageClient {
|
|
23048
23036
|
* the specified Marker. Use an empty Marker to start enumeration from the
|
23049
23037
|
* beginning. After getting a segment, process it, and then call listBlobsHierarchicalSegment
|
23050
23038
|
* again (passing the the previously-returned Marker) to get the next segment.
|
23051
|
-
* @see https://
|
23039
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/list-blobs
|
23052
23040
|
*
|
23053
23041
|
* @param delimiter - The character or string used to define the virtual hierarchy
|
23054
23042
|
* @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
|
@@ -23650,7 +23638,7 @@ class ContainerClient extends StorageClient {
|
|
23650
23638
|
* for the specified account.
|
23651
23639
|
* The Get Account Information operation is available on service versions beginning
|
23652
23640
|
* with version 2018-03-28.
|
23653
|
-
* @see https://
|
23641
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information
|
23654
23642
|
*
|
23655
23643
|
* @param options - Options to the Service Get Account Info operation.
|
23656
23644
|
* @returns Response data for the Service Get Account Info operation.
|
@@ -23706,7 +23694,7 @@ class ContainerClient extends StorageClient {
|
|
23706
23694
|
* Generates a Blob Container Service Shared Access Signature (SAS) URI based on the client properties
|
23707
23695
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
23708
23696
|
*
|
23709
|
-
* @see https://
|
23697
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
23710
23698
|
*
|
23711
23699
|
* @param options - Optional parameters.
|
23712
23700
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
@@ -23726,7 +23714,7 @@ class ContainerClient extends StorageClient {
|
|
23726
23714
|
* Generates string to sign for a Blob Container Service Shared Access Signature (SAS) URI
|
23727
23715
|
* based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
|
23728
23716
|
*
|
23729
|
-
* @see https://
|
23717
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
23730
23718
|
*
|
23731
23719
|
* @param options - Optional parameters.
|
23732
23720
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
@@ -23742,7 +23730,7 @@ class ContainerClient extends StorageClient {
|
|
23742
23730
|
* Generates a Blob Container Service Shared Access Signature (SAS) URI based on the client properties
|
23743
23731
|
* and parameters passed in. The SAS is signed by the input user delegation key.
|
23744
23732
|
*
|
23745
|
-
* @see https://
|
23733
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
23746
23734
|
*
|
23747
23735
|
* @param options - Optional parameters.
|
23748
23736
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
@@ -23758,7 +23746,7 @@ class ContainerClient extends StorageClient {
|
|
23758
23746
|
* Generates string to sign for a Blob Container Service Shared Access Signature (SAS) URI
|
23759
23747
|
* based on the client properties and parameters passed in. The SAS is signed by the input user delegation key.
|
23760
23748
|
*
|
23761
|
-
* @see https://
|
23749
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
23762
23750
|
*
|
23763
23751
|
* @param options - Optional parameters.
|
23764
23752
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
@@ -23770,7 +23758,7 @@ class ContainerClient extends StorageClient {
|
|
23770
23758
|
/**
|
23771
23759
|
* Creates a BlobBatchClient object to conduct batch operations.
|
23772
23760
|
*
|
23773
|
-
* @see https://
|
23761
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
|
23774
23762
|
*
|
23775
23763
|
* @returns A new BlobBatchClient object for this container.
|
23776
23764
|
*/
|
@@ -23955,12 +23943,12 @@ class AccountSASPermissions {
|
|
23955
23943
|
* Using this method will guarantee the resource types are in
|
23956
23944
|
* an order accepted by the service.
|
23957
23945
|
*
|
23958
|
-
* @see https://
|
23946
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
23959
23947
|
*
|
23960
23948
|
*/
|
23961
23949
|
toString() {
|
23962
23950
|
// The order of the characters should be as specified here to ensure correctness:
|
23963
|
-
// https://
|
23951
|
+
// https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
23964
23952
|
// Use a string array instead of string concatenating += operator for performance
|
23965
23953
|
const permissions = [];
|
23966
23954
|
if (this.read) {
|
@@ -24060,7 +24048,7 @@ class AccountSASResourceTypes {
|
|
24060
24048
|
/**
|
24061
24049
|
* Converts the given resource types to a string.
|
24062
24050
|
*
|
24063
|
-
* @see https://
|
24051
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
24064
24052
|
*
|
24065
24053
|
*/
|
24066
24054
|
toString() {
|
@@ -24166,7 +24154,7 @@ class AccountSASServices {
|
|
24166
24154
|
* Generates a {@link SASQueryParameters} object which contains all SAS query parameters needed to make an actual
|
24167
24155
|
* REST request.
|
24168
24156
|
*
|
24169
|
-
* @see https://
|
24157
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
24170
24158
|
*
|
24171
24159
|
* @param accountSASSignatureValues -
|
24172
24160
|
* @param sharedKeyCredential -
|
@@ -24331,7 +24319,7 @@ class BlobServiceClient extends StorageClient {
|
|
24331
24319
|
return new ContainerClient(appendToURLPath(this.url, encodeURIComponent(containerName)), this.pipeline);
|
24332
24320
|
}
|
24333
24321
|
/**
|
24334
|
-
* Create a Blob container. @see https://
|
24322
|
+
* Create a Blob container. @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
|
24335
24323
|
*
|
24336
24324
|
* @param containerName - Name of the container to create.
|
24337
24325
|
* @param options - Options to configure Container Create operation.
|
@@ -24404,7 +24392,7 @@ class BlobServiceClient extends StorageClient {
|
|
24404
24392
|
/**
|
24405
24393
|
* Gets the properties of a storage account’s Blob service, including properties
|
24406
24394
|
* for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
|
24407
|
-
* @see https://
|
24395
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
|
24408
24396
|
*
|
24409
24397
|
* @param options - Options to the Service Get Properties operation.
|
24410
24398
|
* @returns Response data for the Service Get Properties operation.
|
@@ -24420,7 +24408,7 @@ class BlobServiceClient extends StorageClient {
|
|
24420
24408
|
/**
|
24421
24409
|
* Sets properties for a storage account’s Blob service endpoint, including properties
|
24422
24410
|
* for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.
|
24423
|
-
* @see https://
|
24411
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties
|
24424
24412
|
*
|
24425
24413
|
* @param properties -
|
24426
24414
|
* @param options - Options to the Service Set Properties operation.
|
@@ -24438,7 +24426,7 @@ class BlobServiceClient extends StorageClient {
|
|
24438
24426
|
* Retrieves statistics related to replication for the Blob service. It is only
|
24439
24427
|
* available on the secondary location endpoint when read-access geo-redundant
|
24440
24428
|
* replication is enabled for the storage account.
|
24441
|
-
* @see https://
|
24429
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats
|
24442
24430
|
*
|
24443
24431
|
* @param options - Options to the Service Get Statistics operation.
|
24444
24432
|
* @returns Response data for the Service Get Statistics operation.
|
@@ -24456,7 +24444,7 @@ class BlobServiceClient extends StorageClient {
|
|
24456
24444
|
* for the specified account.
|
24457
24445
|
* The Get Account Information operation is available on service versions beginning
|
24458
24446
|
* with version 2018-03-28.
|
24459
|
-
* @see https://
|
24447
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information
|
24460
24448
|
*
|
24461
24449
|
* @param options - Options to the Service Get Account Info operation.
|
24462
24450
|
* @returns Response data for the Service Get Account Info operation.
|
@@ -24471,7 +24459,7 @@ class BlobServiceClient extends StorageClient {
|
|
24471
24459
|
}
|
24472
24460
|
/**
|
24473
24461
|
* Returns a list of the containers under the specified account.
|
24474
|
-
* @see https://
|
24462
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-containers2
|
24475
24463
|
*
|
24476
24464
|
* @param marker - A string value that identifies the portion of
|
24477
24465
|
* the list of containers to be returned with the next listing operation. The
|
@@ -24591,7 +24579,7 @@ class BlobServiceClient extends StorageClient {
|
|
24591
24579
|
*
|
24592
24580
|
* .byPage() returns an async iterable iterator to list the blobs in pages.
|
24593
24581
|
*
|
24594
|
-
* @see https://
|
24582
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
|
24595
24583
|
*
|
24596
24584
|
* Example using `for await` syntax:
|
24597
24585
|
*
|
@@ -24859,7 +24847,7 @@ class BlobServiceClient extends StorageClient {
|
|
24859
24847
|
* Retrieves a user delegation key for the Blob service. This is only a valid operation when using
|
24860
24848
|
* bearer token authentication.
|
24861
24849
|
*
|
24862
|
-
* @see https://
|
24850
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
|
24863
24851
|
*
|
24864
24852
|
* @param startsOn - The start time for the user delegation SAS. Must be within 7 days of the current time
|
24865
24853
|
* @param expiresOn - The end time for the user delegation SAS. Must be within 7 days of the current time
|
@@ -24889,7 +24877,7 @@ class BlobServiceClient extends StorageClient {
|
|
24889
24877
|
/**
|
24890
24878
|
* Creates a BlobBatchClient object to conduct batch operations.
|
24891
24879
|
*
|
24892
|
-
* @see https://
|
24880
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
|
24893
24881
|
*
|
24894
24882
|
* @returns A new BlobBatchClient object for this service.
|
24895
24883
|
*/
|
@@ -24902,7 +24890,7 @@ class BlobServiceClient extends StorageClient {
|
|
24902
24890
|
* Generates a Blob account Shared Access Signature (SAS) URI based on the client properties
|
24903
24891
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
24904
24892
|
*
|
24905
|
-
* @see https://
|
24893
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
|
24906
24894
|
*
|
24907
24895
|
* @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not provided.
|
24908
24896
|
* @param permissions - Specifies the list of permissions to be associated with the SAS.
|
@@ -24929,7 +24917,7 @@ class BlobServiceClient extends StorageClient {
|
|
24929
24917
|
* Generates string to sign for a Blob account Shared Access Signature (SAS) URI based on
|
24930
24918
|
* the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
|
24931
24919
|
*
|
24932
|
-
* @see https://
|
24920
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
|
24933
24921
|
*
|
24934
24922
|
* @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not provided.
|
24935
24923
|
* @param permissions - Specifies the list of permissions to be associated with the SAS.
|