@azure/storage-blob 12.26.0-alpha.20241230.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
@@ -122,7 +122,7 @@ export declare class AccountSASPermissions {
|
|
122
122
|
* Using this method will guarantee the resource types are in
|
123
123
|
* an order accepted by the service.
|
124
124
|
*
|
125
|
-
* @see https://
|
125
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
126
126
|
*
|
127
127
|
*/
|
128
128
|
toString(): string;
|
@@ -219,7 +219,7 @@ export declare class AccountSASResourceTypes {
|
|
219
219
|
/**
|
220
220
|
* Converts the given resource types to a string.
|
221
221
|
*
|
222
|
-
* @see https://
|
222
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
223
223
|
*
|
224
224
|
*/
|
225
225
|
toString(): string;
|
@@ -274,10 +274,10 @@ export declare class AccountSASServices {
|
|
274
274
|
* exist because the former is mutable and a logical representation while the latter is immutable and used to generate
|
275
275
|
* actual REST requests.
|
276
276
|
*
|
277
|
-
* @see https://
|
277
|
+
* @see https://learn.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1
|
278
278
|
* for more conceptual information on SAS
|
279
279
|
*
|
280
|
-
* @see https://
|
280
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
281
281
|
* for descriptions of the parameters, including which are required
|
282
282
|
*/
|
283
283
|
export declare interface AccountSASSignatureValues {
|
@@ -676,7 +676,7 @@ export declare class AppendBlobClient extends BlobClient {
|
|
676
676
|
withSnapshot(snapshot: string): AppendBlobClient;
|
677
677
|
/**
|
678
678
|
* Creates a 0-length append blob. Call AppendBlock to append data to an append blob.
|
679
|
-
* @see https://
|
679
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-blob
|
680
680
|
*
|
681
681
|
* @param options - Options to the Append Block Create operation.
|
682
682
|
*
|
@@ -692,7 +692,7 @@ export declare class AppendBlobClient extends BlobClient {
|
|
692
692
|
/**
|
693
693
|
* Creates a 0-length append blob. Call AppendBlock to append data to an append blob.
|
694
694
|
* If the blob with the same name already exists, the content of the existing blob will remain unchanged.
|
695
|
-
* @see https://
|
695
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-blob
|
696
696
|
*
|
697
697
|
* @param options -
|
698
698
|
*/
|
@@ -705,7 +705,7 @@ export declare class AppendBlobClient extends BlobClient {
|
|
705
705
|
seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>;
|
706
706
|
/**
|
707
707
|
* Commits a new block of data to the end of the existing append blob.
|
708
|
-
* @see https://
|
708
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/append-block
|
709
709
|
*
|
710
710
|
* @param body - Data to be appended.
|
711
711
|
* @param contentLength - Length of the body in bytes.
|
@@ -731,7 +731,7 @@ export declare class AppendBlobClient extends BlobClient {
|
|
731
731
|
/**
|
732
732
|
* The Append Block operation commits a new block of data to the end of an existing append blob
|
733
733
|
* where the contents are read from a source url.
|
734
|
-
* @see https://
|
734
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/append-block-from-url
|
735
735
|
*
|
736
736
|
* @param sourceURL -
|
737
737
|
* The url to the blob that will be the source of the copy. A source blob in the same storage account can
|
@@ -1383,9 +1383,9 @@ export declare class BlobBatch {
|
|
1383
1383
|
* Only one kind of operation is allowed per batch request.
|
1384
1384
|
*
|
1385
1385
|
* Note that in order to delete a blob, you must delete all of its snapshots.
|
1386
|
-
* You can delete both at the same time. See [delete operation details](https://
|
1386
|
+
* You can delete both at the same time. See [delete operation details](https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob).
|
1387
1387
|
* The operation will be authenticated and authorized with specified credential.
|
1388
|
-
* See [blob batch authorization details](https://
|
1388
|
+
* See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
|
1389
1389
|
*
|
1390
1390
|
* @param url - The url of the blob resource to delete.
|
1391
1391
|
* @param credential - 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.
|
@@ -1398,9 +1398,9 @@ export declare class BlobBatch {
|
|
1398
1398
|
* Only one kind of operation is allowed per batch request.
|
1399
1399
|
*
|
1400
1400
|
* Note that in order to delete a blob, you must delete all of its snapshots.
|
1401
|
-
* You can delete both at the same time. See [delete operation details](https://
|
1401
|
+
* You can delete both at the same time. See [delete operation details](https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob).
|
1402
1402
|
* The operation will be authenticated and authorized with specified credential.
|
1403
|
-
* See [blob batch authorization details](https://
|
1403
|
+
* See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
|
1404
1404
|
*
|
1405
1405
|
* @param blobClient - The BlobClient.
|
1406
1406
|
* @param options -
|
@@ -1414,9 +1414,9 @@ export declare class BlobBatch {
|
|
1414
1414
|
* A block blob's tier determines Hot/Cool/Archive storage type.
|
1415
1415
|
* This operation does not update the blob's ETag.
|
1416
1416
|
* For detailed information about block blob level tiering
|
1417
|
-
* see [hot, cool, and archive access tiers](https://
|
1417
|
+
* see [hot, cool, and archive access tiers](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers).
|
1418
1418
|
* The operation will be authenticated and authorized
|
1419
|
-
* with specified credential. See [blob batch authorization details](https://
|
1419
|
+
* with specified credential. See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
|
1420
1420
|
*
|
1421
1421
|
* @param url - The url of the blob resource to delete.
|
1422
1422
|
* @param credential - 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.
|
@@ -1432,9 +1432,9 @@ export declare class BlobBatch {
|
|
1432
1432
|
* A block blob's tier determines Hot/Cool/Archive storage type.
|
1433
1433
|
* This operation does not update the blob's ETag.
|
1434
1434
|
* For detailed information about block blob level tiering
|
1435
|
-
* see [hot, cool, and archive access tiers](https://
|
1435
|
+
* see [hot, cool, and archive access tiers](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers).
|
1436
1436
|
* The operation will be authenticated and authorized
|
1437
|
-
* with specified credential. See [blob batch authorization details](https://
|
1437
|
+
* with specified credential. See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
|
1438
1438
|
*
|
1439
1439
|
* @param blobClient - The BlobClient.
|
1440
1440
|
* @param tier -
|
@@ -1446,7 +1446,7 @@ export declare class BlobBatch {
|
|
1446
1446
|
/**
|
1447
1447
|
* A BlobBatchClient allows you to make batched requests to the Azure Storage Blob service.
|
1448
1448
|
*
|
1449
|
-
* @see https://
|
1449
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
|
1450
1450
|
*/
|
1451
1451
|
export declare class BlobBatchClient {
|
1452
1452
|
private serviceOrContainerContext;
|
@@ -1478,9 +1478,9 @@ export declare class BlobBatchClient {
|
|
1478
1478
|
/**
|
1479
1479
|
* Create multiple delete operations to mark the specified blobs or snapshots for deletion.
|
1480
1480
|
* Note that in order to delete a blob, you must delete all of its snapshots.
|
1481
|
-
* You can delete both at the same time. See [delete operation details](https://
|
1481
|
+
* You can delete both at the same time. See [delete operation details](https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob).
|
1482
1482
|
* The operations will be authenticated and authorized with specified credential.
|
1483
|
-
* See [blob batch authorization details](https://
|
1483
|
+
* See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
|
1484
1484
|
*
|
1485
1485
|
* @param urls - The urls of the blob resources to delete.
|
1486
1486
|
* @param credential - 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.
|
@@ -1490,9 +1490,9 @@ export declare class BlobBatchClient {
|
|
1490
1490
|
/**
|
1491
1491
|
* Create multiple delete operations to mark the specified blobs or snapshots for deletion.
|
1492
1492
|
* Note that in order to delete a blob, you must delete all of its snapshots.
|
1493
|
-
* You can delete both at the same time. See [delete operation details](https://
|
1493
|
+
* You can delete both at the same time. See [delete operation details](https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob).
|
1494
1494
|
* The operation(subrequest) will be authenticated and authorized with specified credential.
|
1495
|
-
* See [blob batch authorization details](https://
|
1495
|
+
* See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
|
1496
1496
|
*
|
1497
1497
|
* @param blobClients - The BlobClients for the blobs to delete.
|
1498
1498
|
* @param options -
|
@@ -1505,9 +1505,9 @@ export declare class BlobBatchClient {
|
|
1505
1505
|
* storage only). A premium page blob's tier determines the allowed size, IOPS,
|
1506
1506
|
* and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive
|
1507
1507
|
* storage type. This operation does not update the blob's ETag.
|
1508
|
-
* See [set blob tier details](https://
|
1508
|
+
* See [set blob tier details](https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-tier).
|
1509
1509
|
* The operation(subrequest) will be authenticated and authorized
|
1510
|
-
* with specified credential.See [blob batch authorization details](https://
|
1510
|
+
* with specified credential.See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
|
1511
1511
|
*
|
1512
1512
|
* @param urls - The urls of the blob resource to delete.
|
1513
1513
|
* @param credential - 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.
|
@@ -1522,9 +1522,9 @@ export declare class BlobBatchClient {
|
|
1522
1522
|
* storage only). A premium page blob's tier determines the allowed size, IOPS,
|
1523
1523
|
* and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive
|
1524
1524
|
* storage type. This operation does not update the blob's ETag.
|
1525
|
-
* See [set blob tier details](https://
|
1525
|
+
* See [set blob tier details](https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-tier).
|
1526
1526
|
* The operation(subrequest) will be authenticated and authorized
|
1527
|
-
* with specified credential.See [blob batch authorization details](https://
|
1527
|
+
* with specified credential.See [blob batch authorization details](https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
|
1528
1528
|
*
|
1529
1529
|
* @param blobClients - The BlobClients for the blobs which should have a new tier set.
|
1530
1530
|
* @param tier -
|
@@ -1561,7 +1561,7 @@ export declare class BlobBatchClient {
|
|
1561
1561
|
* console.log(batchResp.subResponsesSucceededCount);
|
1562
1562
|
* ```
|
1563
1563
|
*
|
1564
|
-
* @see https://
|
1564
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
|
1565
1565
|
*
|
1566
1566
|
* @param batchRequest - A set of Delete or SetTier operations.
|
1567
1567
|
* @param options -
|
@@ -1850,7 +1850,7 @@ export declare class BlobClient extends StorageClient {
|
|
1850
1850
|
* * In Node.js, data returns in a Readable stream readableStreamBody
|
1851
1851
|
* * In browsers, data returns in a promise blobBody
|
1852
1852
|
*
|
1853
|
-
* @see https://
|
1853
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob
|
1854
1854
|
*
|
1855
1855
|
* @param offset - From which position of the blob to download, greater than or equal to 0
|
1856
1856
|
* @param count - How much data to be downloaded, greater than 0. Will download to the end when undefined
|
@@ -1916,7 +1916,7 @@ export declare class BlobClient extends StorageClient {
|
|
1916
1916
|
/**
|
1917
1917
|
* Returns all user-defined metadata, standard HTTP properties, and system properties
|
1918
1918
|
* for the blob. It does not return the content of the blob.
|
1919
|
-
* @see https://
|
1919
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
|
1920
1920
|
*
|
1921
1921
|
* WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
|
1922
1922
|
* they originally contained uppercase characters. This differs from the metadata keys returned by
|
@@ -1931,7 +1931,7 @@ export declare class BlobClient extends StorageClient {
|
|
1931
1931
|
* during garbage collection. Note that in order to delete a blob, you must delete
|
1932
1932
|
* all of its snapshots. You can delete both at the same time with the Delete
|
1933
1933
|
* Blob operation.
|
1934
|
-
* @see https://
|
1934
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob
|
1935
1935
|
*
|
1936
1936
|
* @param options - Optional options to Blob Delete operation.
|
1937
1937
|
*/
|
@@ -1941,7 +1941,7 @@ export declare class BlobClient extends StorageClient {
|
|
1941
1941
|
* during garbage collection. Note that in order to delete a blob, you must delete
|
1942
1942
|
* all of its snapshots. You can delete both at the same time with the Delete
|
1943
1943
|
* Blob operation.
|
1944
|
-
* @see https://
|
1944
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob
|
1945
1945
|
*
|
1946
1946
|
* @param options - Optional options to Blob Delete operation.
|
1947
1947
|
*/
|
@@ -1950,7 +1950,7 @@ export declare class BlobClient extends StorageClient {
|
|
1950
1950
|
* Restores the contents and metadata of soft deleted blob and any associated
|
1951
1951
|
* soft deleted snapshots. Undelete Blob is supported only on version 2017-07-29
|
1952
1952
|
* or later.
|
1953
|
-
* @see https://
|
1953
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/undelete-blob
|
1954
1954
|
*
|
1955
1955
|
* @param options - Optional options to Blob Undelete operation.
|
1956
1956
|
*/
|
@@ -1960,7 +1960,7 @@ export declare class BlobClient extends StorageClient {
|
|
1960
1960
|
*
|
1961
1961
|
* If no value provided, or no value provided for the specified blob HTTP headers,
|
1962
1962
|
* these blob HTTP headers without a value will be cleared.
|
1963
|
-
* @see https://
|
1963
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
|
1964
1964
|
*
|
1965
1965
|
* @param blobHTTPHeaders - If no value provided, or no value provided for
|
1966
1966
|
* the specified blob HTTP headers, these blob HTTP
|
@@ -1976,7 +1976,7 @@ export declare class BlobClient extends StorageClient {
|
|
1976
1976
|
*
|
1977
1977
|
* If no option provided, or no metadata defined in the parameter, the blob
|
1978
1978
|
* metadata will be removed.
|
1979
|
-
* @see https://
|
1979
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
|
1980
1980
|
*
|
1981
1981
|
* @param metadata - Replace existing metadata with this value.
|
1982
1982
|
* If no value provided the existing metadata will be removed.
|
@@ -2008,7 +2008,7 @@ export declare class BlobClient extends StorageClient {
|
|
2008
2008
|
getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient;
|
2009
2009
|
/**
|
2010
2010
|
* Creates a read-only snapshot of a blob.
|
2011
|
-
* @see https://
|
2011
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
|
2012
2012
|
*
|
2013
2013
|
* @param options - Optional options to the Blob Create Snapshot operation.
|
2014
2014
|
*/
|
@@ -2027,7 +2027,7 @@ export declare class BlobClient extends StorageClient {
|
|
2027
2027
|
* an Azure file in any Azure storage account.
|
2028
2028
|
* Only storage accounts created on or after June 7th, 2012 allow the Copy Blob
|
2029
2029
|
* operation to copy from another storage account.
|
2030
|
-
* @see https://
|
2030
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob
|
2031
2031
|
*
|
2032
2032
|
* Example using automatic polling:
|
2033
2033
|
*
|
@@ -2089,7 +2089,7 @@ export declare class BlobClient extends StorageClient {
|
|
2089
2089
|
/**
|
2090
2090
|
* Aborts a pending asynchronous Copy Blob operation, and leaves a destination blob with zero
|
2091
2091
|
* length and full metadata. Version 2012-02-12 and newer.
|
2092
|
-
* @see https://
|
2092
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
|
2093
2093
|
*
|
2094
2094
|
* @param copyId - Id of the Copy From URL operation.
|
2095
2095
|
* @param options - Optional options to the Blob Abort Copy From URL operation.
|
@@ -2098,7 +2098,7 @@ export declare class BlobClient extends StorageClient {
|
|
2098
2098
|
/**
|
2099
2099
|
* The synchronous Copy From URL operation copies a blob or an internet resource to a new blob. It will not
|
2100
2100
|
* return a response until the copy is complete.
|
2101
|
-
* @see https://
|
2101
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
|
2102
2102
|
*
|
2103
2103
|
* @param copySource - The source URL to copy from, Shared Access Signature(SAS) maybe needed for authentication
|
2104
2104
|
* @param options -
|
@@ -2110,7 +2110,7 @@ export declare class BlobClient extends StorageClient {
|
|
2110
2110
|
* storage only). A premium page blob's tier determines the allowed size, IOPS,
|
2111
2111
|
* and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive
|
2112
2112
|
* storage type. This operation does not update the blob's ETag.
|
2113
|
-
* @see https://
|
2113
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
|
2114
2114
|
*
|
2115
2115
|
* @param tier - The tier to be set on the blob. Valid values are Hot, Cool, or Archive.
|
2116
2116
|
* @param options - Optional options to the Blob Set Tier operation.
|
@@ -2173,7 +2173,7 @@ export declare class BlobClient extends StorageClient {
|
|
2173
2173
|
* an Azure file in any Azure storage account.
|
2174
2174
|
* Only storage accounts created on or after June 7th, 2012 allow the Copy Blob
|
2175
2175
|
* operation to copy from another storage account.
|
2176
|
-
* @see https://
|
2176
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob
|
2177
2177
|
*
|
2178
2178
|
* @param copySource - url to the source Azure Blob/File.
|
2179
2179
|
* @param options - Optional options to the Blob Start Copy From URL operation.
|
@@ -2185,7 +2185,7 @@ export declare class BlobClient extends StorageClient {
|
|
2185
2185
|
* Generates a Blob Service Shared Access Signature (SAS) URI based on the client properties
|
2186
2186
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
2187
2187
|
*
|
2188
|
-
* @see https://
|
2188
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
2189
2189
|
*
|
2190
2190
|
* @param options - Optional parameters.
|
2191
2191
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
@@ -2197,7 +2197,7 @@ export declare class BlobClient extends StorageClient {
|
|
2197
2197
|
* Generates string to sign for a Blob Service Shared Access Signature (SAS) URI based on
|
2198
2198
|
* the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
|
2199
2199
|
*
|
2200
|
-
* @see https://
|
2200
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
2201
2201
|
*
|
2202
2202
|
* @param options - Optional parameters.
|
2203
2203
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
@@ -2208,7 +2208,7 @@ export declare class BlobClient extends StorageClient {
|
|
2208
2208
|
* Generates a Blob Service Shared Access Signature (SAS) URI based on
|
2209
2209
|
* the client properties and parameters passed in. The SAS is signed by the input user delegation key.
|
2210
2210
|
*
|
2211
|
-
* @see https://
|
2211
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
2212
2212
|
*
|
2213
2213
|
* @param options - Optional parameters.
|
2214
2214
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
@@ -2221,7 +2221,7 @@ export declare class BlobClient extends StorageClient {
|
|
2221
2221
|
* Generates string to sign for a Blob Service Shared Access Signature (SAS) URI based on
|
2222
2222
|
* the client properties and parameters passed in. The SAS is signed by the input user delegation key.
|
2223
2223
|
*
|
2224
|
-
* @see https://
|
2224
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
2225
2225
|
*
|
2226
2226
|
* @param options - Optional parameters.
|
2227
2227
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
@@ -2251,7 +2251,7 @@ export declare class BlobClient extends StorageClient {
|
|
2251
2251
|
* for the specified account.
|
2252
2252
|
* The Get Account Information operation is available on service versions beginning
|
2253
2253
|
* with version 2018-03-28.
|
2254
|
-
* @see https://
|
2254
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information
|
2255
2255
|
*
|
2256
2256
|
* @param options - Options to the Service Get Account Info operation.
|
2257
2257
|
* @returns Response data for the Service Get Account Info operation.
|
@@ -3250,9 +3250,9 @@ export declare class BlobLeaseClient {
|
|
3250
3250
|
* Establishes and manages a lock on a container for delete operations, or on a blob
|
3251
3251
|
* for write and delete operations.
|
3252
3252
|
* The lock duration can be 15 to 60 seconds, or can be infinite.
|
3253
|
-
* @see https://
|
3253
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container
|
3254
3254
|
* and
|
3255
|
-
* @see https://
|
3255
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob
|
3256
3256
|
*
|
3257
3257
|
* @param duration - Must be between 15 to 60 seconds, or infinite (-1)
|
3258
3258
|
* @param options - option to configure lease management operations.
|
@@ -3261,9 +3261,9 @@ export declare class BlobLeaseClient {
|
|
3261
3261
|
acquireLease(duration: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>;
|
3262
3262
|
/**
|
3263
3263
|
* To change the ID of the lease.
|
3264
|
-
* @see https://
|
3264
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container
|
3265
3265
|
* and
|
3266
|
-
* @see https://
|
3266
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob
|
3267
3267
|
*
|
3268
3268
|
* @param proposedLeaseId - the proposed new lease Id.
|
3269
3269
|
* @param options - option to configure lease management operations.
|
@@ -3273,9 +3273,9 @@ export declare class BlobLeaseClient {
|
|
3273
3273
|
/**
|
3274
3274
|
* To free the lease if it is no longer needed so that another client may
|
3275
3275
|
* immediately acquire a lease against the container or the blob.
|
3276
|
-
* @see https://
|
3276
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container
|
3277
3277
|
* and
|
3278
|
-
* @see https://
|
3278
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob
|
3279
3279
|
*
|
3280
3280
|
* @param options - option to configure lease management operations.
|
3281
3281
|
* @returns Response data for release lease operation.
|
@@ -3283,9 +3283,9 @@ export declare class BlobLeaseClient {
|
|
3283
3283
|
releaseLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>;
|
3284
3284
|
/**
|
3285
3285
|
* To renew the lease.
|
3286
|
-
* @see https://
|
3286
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container
|
3287
3287
|
* and
|
3288
|
-
* @see https://
|
3288
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob
|
3289
3289
|
*
|
3290
3290
|
* @param options - Optional option to configure lease management operations.
|
3291
3291
|
* @returns Response data for renew lease operation.
|
@@ -3294,9 +3294,9 @@ export declare class BlobLeaseClient {
|
|
3294
3294
|
/**
|
3295
3295
|
* To end the lease but ensure that another client cannot acquire a new lease
|
3296
3296
|
* until the current lease period has expired.
|
3297
|
-
* @see https://
|
3297
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-container
|
3298
3298
|
* and
|
3299
|
-
* @see https://
|
3299
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/lease-blob
|
3300
3300
|
*
|
3301
3301
|
* @param breakPeriod - Break period
|
3302
3302
|
* @param options - Optional options to configure lease management operations.
|
@@ -3875,7 +3875,7 @@ export declare interface BlobSASSignatureValues {
|
|
3875
3875
|
/**
|
3876
3876
|
* Optional. The name of the access policy on the container this SAS references if any.
|
3877
3877
|
*
|
3878
|
-
* @see https://
|
3878
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
|
3879
3879
|
*/
|
3880
3880
|
identifier?: string;
|
3881
3881
|
/**
|
@@ -3997,7 +3997,7 @@ export declare class BlobServiceClient extends StorageClient {
|
|
3997
3997
|
*/
|
3998
3998
|
getContainerClient(containerName: string): ContainerClient;
|
3999
3999
|
/**
|
4000
|
-
* Create a Blob container. @see https://
|
4000
|
+
* Create a Blob container. @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
|
4001
4001
|
*
|
4002
4002
|
* @param containerName - Name of the container to create.
|
4003
4003
|
* @param options - Options to configure Container Create operation.
|
@@ -4039,7 +4039,7 @@ export declare class BlobServiceClient extends StorageClient {
|
|
4039
4039
|
/**
|
4040
4040
|
* Gets the properties of a storage account’s Blob service, including properties
|
4041
4041
|
* for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
|
4042
|
-
* @see https://
|
4042
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
|
4043
4043
|
*
|
4044
4044
|
* @param options - Options to the Service Get Properties operation.
|
4045
4045
|
* @returns Response data for the Service Get Properties operation.
|
@@ -4048,7 +4048,7 @@ export declare class BlobServiceClient extends StorageClient {
|
|
4048
4048
|
/**
|
4049
4049
|
* Sets properties for a storage account’s Blob service endpoint, including properties
|
4050
4050
|
* for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.
|
4051
|
-
* @see https://
|
4051
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties
|
4052
4052
|
*
|
4053
4053
|
* @param properties -
|
4054
4054
|
* @param options - Options to the Service Set Properties operation.
|
@@ -4059,7 +4059,7 @@ export declare class BlobServiceClient extends StorageClient {
|
|
4059
4059
|
* Retrieves statistics related to replication for the Blob service. It is only
|
4060
4060
|
* available on the secondary location endpoint when read-access geo-redundant
|
4061
4061
|
* replication is enabled for the storage account.
|
4062
|
-
* @see https://
|
4062
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats
|
4063
4063
|
*
|
4064
4064
|
* @param options - Options to the Service Get Statistics operation.
|
4065
4065
|
* @returns Response data for the Service Get Statistics operation.
|
@@ -4070,7 +4070,7 @@ export declare class BlobServiceClient extends StorageClient {
|
|
4070
4070
|
* for the specified account.
|
4071
4071
|
* The Get Account Information operation is available on service versions beginning
|
4072
4072
|
* with version 2018-03-28.
|
4073
|
-
* @see https://
|
4073
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information
|
4074
4074
|
*
|
4075
4075
|
* @param options - Options to the Service Get Account Info operation.
|
4076
4076
|
* @returns Response data for the Service Get Account Info operation.
|
@@ -4078,7 +4078,7 @@ export declare class BlobServiceClient extends StorageClient {
|
|
4078
4078
|
getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>;
|
4079
4079
|
/**
|
4080
4080
|
* Returns a list of the containers under the specified account.
|
4081
|
-
* @see https://
|
4081
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-containers2
|
4082
4082
|
*
|
4083
4083
|
* @param marker - A string value that identifies the portion of
|
4084
4084
|
* the list of containers to be returned with the next listing operation. The
|
@@ -4143,7 +4143,7 @@ export declare class BlobServiceClient extends StorageClient {
|
|
4143
4143
|
*
|
4144
4144
|
* .byPage() returns an async iterable iterator to list the blobs in pages.
|
4145
4145
|
*
|
4146
|
-
* @see https://
|
4146
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
|
4147
4147
|
*
|
4148
4148
|
* Example using `for await` syntax:
|
4149
4149
|
*
|
@@ -4317,7 +4317,7 @@ export declare class BlobServiceClient extends StorageClient {
|
|
4317
4317
|
* Retrieves a user delegation key for the Blob service. This is only a valid operation when using
|
4318
4318
|
* bearer token authentication.
|
4319
4319
|
*
|
4320
|
-
* @see https://
|
4320
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
|
4321
4321
|
*
|
4322
4322
|
* @param startsOn - The start time for the user delegation SAS. Must be within 7 days of the current time
|
4323
4323
|
* @param expiresOn - The end time for the user delegation SAS. Must be within 7 days of the current time
|
@@ -4326,7 +4326,7 @@ export declare class BlobServiceClient extends StorageClient {
|
|
4326
4326
|
/**
|
4327
4327
|
* Creates a BlobBatchClient object to conduct batch operations.
|
4328
4328
|
*
|
4329
|
-
* @see https://
|
4329
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
|
4330
4330
|
*
|
4331
4331
|
* @returns A new BlobBatchClient object for this service.
|
4332
4332
|
*/
|
@@ -4337,7 +4337,7 @@ export declare class BlobServiceClient extends StorageClient {
|
|
4337
4337
|
* Generates a Blob account Shared Access Signature (SAS) URI based on the client properties
|
4338
4338
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
4339
4339
|
*
|
4340
|
-
* @see https://
|
4340
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
|
4341
4341
|
*
|
4342
4342
|
* @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not provided.
|
4343
4343
|
* @param permissions - Specifies the list of permissions to be associated with the SAS.
|
@@ -4352,7 +4352,7 @@ export declare class BlobServiceClient extends StorageClient {
|
|
4352
4352
|
* Generates string to sign for a Blob account Shared Access Signature (SAS) URI based on
|
4353
4353
|
* the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
|
4354
4354
|
*
|
4355
|
-
* @see https://
|
4355
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
|
4356
4356
|
*
|
4357
4357
|
* @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not provided.
|
4358
4358
|
* @param permissions - Specifies the list of permissions to be associated with the SAS.
|
@@ -4749,7 +4749,7 @@ export declare interface BlobSetTierOptions extends CommonOptions {
|
|
4749
4749
|
conditions?: LeaseAccessConditions & TagConditions;
|
4750
4750
|
/**
|
4751
4751
|
* Rehydrate Priority - possible values include 'High', 'Standard'.
|
4752
|
-
* More Details - https://
|
4752
|
+
* More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-rehydration#rehydrate-an-archived-blob-to-an-online-tier
|
4753
4753
|
*/
|
4754
4754
|
rehydratePriority?: RehydratePriority;
|
4755
4755
|
}
|
@@ -4839,12 +4839,12 @@ export declare interface BlobStartCopyFromURLOptions extends CommonOptions {
|
|
4839
4839
|
sourceConditions?: ModifiedAccessConditions;
|
4840
4840
|
/**
|
4841
4841
|
* Access tier.
|
4842
|
-
* More Details - https://
|
4842
|
+
* More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers
|
4843
4843
|
*/
|
4844
4844
|
tier?: BlockBlobTier | PremiumPageBlobTier | string;
|
4845
4845
|
/**
|
4846
4846
|
* Rehydrate Priority - possible values include 'High', 'Standard'.
|
4847
|
-
* More Details - https://
|
4847
|
+
* More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-rehydration#rehydrate-an-archived-blob-to-an-online-tier
|
4848
4848
|
*/
|
4849
4849
|
rehydratePriority?: RehydratePriority;
|
4850
4850
|
/**
|
@@ -4898,7 +4898,7 @@ export declare interface BlobSyncCopyFromURLOptions extends CommonOptions {
|
|
4898
4898
|
sourceConditions?: MatchConditions & ModificationConditions;
|
4899
4899
|
/**
|
4900
4900
|
* Access tier.
|
4901
|
-
* More Details - https://
|
4901
|
+
* More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers
|
4902
4902
|
*/
|
4903
4903
|
tier?: BlockBlobTier | PremiumPageBlobTier | string;
|
4904
4904
|
/**
|
@@ -5191,7 +5191,7 @@ export declare class BlockBlobClient extends BlobClient {
|
|
5191
5191
|
* {@link uploadStream} or {@link uploadBrowserData} for better performance
|
5192
5192
|
* with concurrency uploading.
|
5193
5193
|
*
|
5194
|
-
* @see https://
|
5194
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-blob
|
5195
5195
|
*
|
5196
5196
|
* @param body - Blob, string, ArrayBuffer, ArrayBufferView or a function
|
5197
5197
|
* which returns a new Readable stream whose offset is from data source beginning.
|
@@ -5230,7 +5230,7 @@ export declare class BlockBlobClient extends BlobClient {
|
|
5230
5230
|
/**
|
5231
5231
|
* Uploads the specified block to the block blob's "staging area" to be later
|
5232
5232
|
* committed by a call to commitBlockList.
|
5233
|
-
* @see https://
|
5233
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-block
|
5234
5234
|
*
|
5235
5235
|
* @param blockId - A 64-byte value that is base64-encoded
|
5236
5236
|
* @param body - Data to upload to the staging area.
|
@@ -5243,7 +5243,7 @@ export declare class BlockBlobClient extends BlobClient {
|
|
5243
5243
|
* The Stage Block From URL operation creates a new block to be committed as part
|
5244
5244
|
* of a blob where the contents are read from a URL.
|
5245
5245
|
* This API is available starting in version 2018-03-28.
|
5246
|
-
* @see https://
|
5246
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
|
5247
5247
|
*
|
5248
5248
|
* @param blockId - A 64-byte value that is base64-encoded
|
5249
5249
|
* @param sourceURL - Specifies the URL of the blob. The value
|
@@ -5267,7 +5267,7 @@ export declare class BlockBlobClient extends BlobClient {
|
|
5267
5267
|
* to the server in a prior {@link stageBlock} operation. You can call {@link commitBlockList} to
|
5268
5268
|
* update a blob by uploading only those blocks that have changed, then committing the new and existing
|
5269
5269
|
* blocks together. Any blocks not specified in the block list and permanently deleted.
|
5270
|
-
* @see https://
|
5270
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-block-list
|
5271
5271
|
*
|
5272
5272
|
* @param blocks - Array of 64-byte value that is base64-encoded
|
5273
5273
|
* @param options - Options to the Block Blob Commit Block List operation.
|
@@ -5277,7 +5277,7 @@ export declare class BlockBlobClient extends BlobClient {
|
|
5277
5277
|
/**
|
5278
5278
|
* Returns the list of blocks that have been uploaded as part of a block blob
|
5279
5279
|
* using the specified block list filter.
|
5280
|
-
* @see https://
|
5280
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-block-list
|
5281
5281
|
*
|
5282
5282
|
* @param listType - Specifies whether to return the list of committed blocks,
|
5283
5283
|
* the list of uncommitted blocks, or both lists together.
|
@@ -5482,7 +5482,7 @@ export declare interface BlockBlobCommitBlockListOptions extends CommonOptions {
|
|
5482
5482
|
legalHold?: boolean;
|
5483
5483
|
/**
|
5484
5484
|
* Access tier.
|
5485
|
-
* More Details - https://
|
5485
|
+
* More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers
|
5486
5486
|
*/
|
5487
5487
|
tier?: BlockBlobTier | string;
|
5488
5488
|
/**
|
@@ -5613,7 +5613,7 @@ export declare interface BlockBlobParallelUploadOptions extends CommonOptions {
|
|
5613
5613
|
tags?: Tags;
|
5614
5614
|
/**
|
5615
5615
|
* Access tier.
|
5616
|
-
* More Details - https://
|
5616
|
+
* More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers
|
5617
5617
|
*/
|
5618
5618
|
tier?: BlockBlobTier | string;
|
5619
5619
|
}
|
@@ -5930,7 +5930,7 @@ declare type BlockBlobStageBlockResponse_2 = BlockBlobStageBlockHeaders;
|
|
5930
5930
|
export declare interface BlockBlobSyncUploadFromURLOptions extends CommonOptions {
|
5931
5931
|
/**
|
5932
5932
|
* Server timeout in seconds.
|
5933
|
-
* For more information, @see https://
|
5933
|
+
* For more information, @see https://learn.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations
|
5934
5934
|
*/
|
5935
5935
|
timeoutInSeconds?: number;
|
5936
5936
|
/**
|
@@ -5957,7 +5957,7 @@ export declare interface BlockBlobSyncUploadFromURLOptions extends CommonOptions
|
|
5957
5957
|
encryptionScope?: string;
|
5958
5958
|
/**
|
5959
5959
|
* Access tier.
|
5960
|
-
* More Details - https://
|
5960
|
+
* More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers
|
5961
5961
|
*/
|
5962
5962
|
tier?: BlockBlobTier | string;
|
5963
5963
|
/**
|
@@ -6004,7 +6004,7 @@ export declare interface BlockBlobSyncUploadFromURLOptions extends CommonOptions
|
|
6004
6004
|
|
6005
6005
|
/**
|
6006
6006
|
* Represents the access tier on a blob.
|
6007
|
-
* For detailed information about block blob level tiering see {@link https://
|
6007
|
+
* 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.}
|
6008
6008
|
*/
|
6009
6009
|
export declare enum BlockBlobTier {
|
6010
6010
|
/**
|
@@ -6131,7 +6131,7 @@ export declare interface BlockBlobUploadOptions extends CommonOptions {
|
|
6131
6131
|
encryptionScope?: string;
|
6132
6132
|
/**
|
6133
6133
|
* Access tier.
|
6134
|
-
* More Details - https://
|
6134
|
+
* More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers
|
6135
6135
|
*/
|
6136
6136
|
tier?: BlockBlobTier | string;
|
6137
6137
|
/**
|
@@ -6206,7 +6206,7 @@ export declare interface BlockBlobUploadStreamOptions extends CommonOptions {
|
|
6206
6206
|
tags?: Tags;
|
6207
6207
|
/**
|
6208
6208
|
* Access tier.
|
6209
|
-
* More Details - https://
|
6209
|
+
* More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers
|
6210
6210
|
*/
|
6211
6211
|
tier?: BlockBlobTier | string;
|
6212
6212
|
}
|
@@ -6258,7 +6258,7 @@ export declare interface CommonGenerateSasUrlOptions {
|
|
6258
6258
|
/**
|
6259
6259
|
* Optional. The name of the access policy on the container this SAS references if any.
|
6260
6260
|
*
|
6261
|
-
* @see https://
|
6261
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
|
6262
6262
|
*/
|
6263
6263
|
identifier?: string;
|
6264
6264
|
/**
|
@@ -6619,7 +6619,7 @@ export declare class ContainerClient extends StorageClient {
|
|
6619
6619
|
/**
|
6620
6620
|
* Creates a new container under the specified account. If the container with
|
6621
6621
|
* the same name already exists, the operation fails.
|
6622
|
-
* @see https://
|
6622
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
|
6623
6623
|
* Naming rules: @see https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
|
6624
6624
|
*
|
6625
6625
|
* @param options - Options to Container Create operation.
|
@@ -6637,7 +6637,7 @@ export declare class ContainerClient extends StorageClient {
|
|
6637
6637
|
/**
|
6638
6638
|
* Creates a new container under the specified account. If the container with
|
6639
6639
|
* the same name already exists, it is not changed.
|
6640
|
-
* @see https://
|
6640
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
|
6641
6641
|
* Naming rules: @see https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
|
6642
6642
|
*
|
6643
6643
|
* @param options -
|
@@ -6691,7 +6691,7 @@ export declare class ContainerClient extends StorageClient {
|
|
6691
6691
|
/**
|
6692
6692
|
* Returns all user-defined metadata and system properties for the specified
|
6693
6693
|
* container. The data returned does not include the container's list of blobs.
|
6694
|
-
* @see https://
|
6694
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-properties
|
6695
6695
|
*
|
6696
6696
|
* WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
|
6697
6697
|
* they originally contained uppercase characters. This differs from the metadata keys returned by
|
@@ -6704,7 +6704,7 @@ export declare class ContainerClient extends StorageClient {
|
|
6704
6704
|
/**
|
6705
6705
|
* Marks the specified container for deletion. The container and any blobs
|
6706
6706
|
* contained within it are later deleted during garbage collection.
|
6707
|
-
* @see https://
|
6707
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container
|
6708
6708
|
*
|
6709
6709
|
* @param options - Options to Container Delete operation.
|
6710
6710
|
*/
|
@@ -6712,7 +6712,7 @@ export declare class ContainerClient extends StorageClient {
|
|
6712
6712
|
/**
|
6713
6713
|
* Marks the specified container for deletion if it exists. The container and any blobs
|
6714
6714
|
* contained within it are later deleted during garbage collection.
|
6715
|
-
* @see https://
|
6715
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container
|
6716
6716
|
*
|
6717
6717
|
* @param options - Options to Container Delete operation.
|
6718
6718
|
*/
|
@@ -6723,7 +6723,7 @@ export declare class ContainerClient extends StorageClient {
|
|
6723
6723
|
* If no option provided, or no metadata defined in the parameter, the container
|
6724
6724
|
* metadata will be removed.
|
6725
6725
|
*
|
6726
|
-
* @see https://
|
6726
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
|
6727
6727
|
*
|
6728
6728
|
* @param metadata - Replace existing metadata with this value.
|
6729
6729
|
* If no value provided the existing metadata will be removed.
|
@@ -6737,7 +6737,7 @@ export declare class ContainerClient extends StorageClient {
|
|
6737
6737
|
* WARNING: JavaScript Date will potentially lose precision when parsing startsOn and expiresOn strings.
|
6738
6738
|
* For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
|
6739
6739
|
*
|
6740
|
-
* @see https://
|
6740
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-acl
|
6741
6741
|
*
|
6742
6742
|
* @param options - Options to Container Get Access Policy operation.
|
6743
6743
|
*/
|
@@ -6753,7 +6753,7 @@ export declare class ContainerClient extends StorageClient {
|
|
6753
6753
|
* When you establish a stored access policy on a container, it may take up to 30 seconds to take effect.
|
6754
6754
|
* During this interval, a shared access signature that is associated with the stored access policy will
|
6755
6755
|
* fail with status code 403 (Forbidden), until the access policy becomes active.
|
6756
|
-
* @see https://
|
6756
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-acl
|
6757
6757
|
*
|
6758
6758
|
* @param access - The level of public access to data in the container.
|
6759
6759
|
* @param containerAcl - Array of elements each having a unique Id and details of the access policy.
|
@@ -6779,7 +6779,7 @@ export declare class ContainerClient extends StorageClient {
|
|
6779
6779
|
* {@link BlockBlobClient.uploadStream} or {@link BlockBlobClient.uploadBrowserData} for better
|
6780
6780
|
* performance with concurrency uploading.
|
6781
6781
|
*
|
6782
|
-
* @see https://
|
6782
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-blob
|
6783
6783
|
*
|
6784
6784
|
* @param blobName - Name of the block blob to create or update.
|
6785
6785
|
* @param body - Blob, string, ArrayBuffer, ArrayBufferView or a function
|
@@ -6798,7 +6798,7 @@ export declare class ContainerClient extends StorageClient {
|
|
6798
6798
|
* during garbage collection. Note that in order to delete a blob, you must delete
|
6799
6799
|
* all of its snapshots. You can delete both at the same time with the Delete
|
6800
6800
|
* Blob operation.
|
6801
|
-
* @see https://
|
6801
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob
|
6802
6802
|
*
|
6803
6803
|
* @param blobName -
|
6804
6804
|
* @param options - Options to Blob Delete operation.
|
@@ -6810,7 +6810,7 @@ export declare class ContainerClient extends StorageClient {
|
|
6810
6810
|
* specified Marker. Use an empty Marker to start enumeration from the beginning.
|
6811
6811
|
* After getting a segment, process it, and then call listBlobsFlatSegment again
|
6812
6812
|
* (passing the the previously-returned Marker) to get the next segment.
|
6813
|
-
* @see https://
|
6813
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/list-blobs
|
6814
6814
|
*
|
6815
6815
|
* @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
|
6816
6816
|
* @param options - Options to Container List Blob Flat Segment operation.
|
@@ -6821,7 +6821,7 @@ export declare class ContainerClient extends StorageClient {
|
|
6821
6821
|
* the specified Marker. Use an empty Marker to start enumeration from the
|
6822
6822
|
* beginning. After getting a segment, process it, and then call listBlobsHierarchicalSegment
|
6823
6823
|
* again (passing the the previously-returned Marker) to get the next segment.
|
6824
|
-
* @see https://
|
6824
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/list-blobs
|
6825
6825
|
*
|
6826
6826
|
* @param delimiter - The character or string used to define the virtual hierarchy
|
6827
6827
|
* @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
|
@@ -7150,7 +7150,7 @@ export declare class ContainerClient extends StorageClient {
|
|
7150
7150
|
* for the specified account.
|
7151
7151
|
* The Get Account Information operation is available on service versions beginning
|
7152
7152
|
* with version 2018-03-28.
|
7153
|
-
* @see https://
|
7153
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information
|
7154
7154
|
*
|
7155
7155
|
* @param options - Options to the Service Get Account Info operation.
|
7156
7156
|
* @returns Response data for the Service Get Account Info operation.
|
@@ -7163,7 +7163,7 @@ export declare class ContainerClient extends StorageClient {
|
|
7163
7163
|
* Generates a Blob Container Service Shared Access Signature (SAS) URI based on the client properties
|
7164
7164
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
7165
7165
|
*
|
7166
|
-
* @see https://
|
7166
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
7167
7167
|
*
|
7168
7168
|
* @param options - Optional parameters.
|
7169
7169
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
@@ -7175,7 +7175,7 @@ export declare class ContainerClient extends StorageClient {
|
|
7175
7175
|
* Generates string to sign for a Blob Container Service Shared Access Signature (SAS) URI
|
7176
7176
|
* based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
|
7177
7177
|
*
|
7178
|
-
* @see https://
|
7178
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
7179
7179
|
*
|
7180
7180
|
* @param options - Optional parameters.
|
7181
7181
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
@@ -7185,7 +7185,7 @@ export declare class ContainerClient extends StorageClient {
|
|
7185
7185
|
* Generates a Blob Container Service Shared Access Signature (SAS) URI based on the client properties
|
7186
7186
|
* and parameters passed in. The SAS is signed by the input user delegation key.
|
7187
7187
|
*
|
7188
|
-
* @see https://
|
7188
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
7189
7189
|
*
|
7190
7190
|
* @param options - Optional parameters.
|
7191
7191
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
@@ -7196,7 +7196,7 @@ export declare class ContainerClient extends StorageClient {
|
|
7196
7196
|
* Generates string to sign for a Blob Container Service Shared Access Signature (SAS) URI
|
7197
7197
|
* based on the client properties and parameters passed in. The SAS is signed by the input user delegation key.
|
7198
7198
|
*
|
7199
|
-
* @see https://
|
7199
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
7200
7200
|
*
|
7201
7201
|
* @param options - Optional parameters.
|
7202
7202
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
@@ -7206,7 +7206,7 @@ export declare class ContainerClient extends StorageClient {
|
|
7206
7206
|
/**
|
7207
7207
|
* Creates a BlobBatchClient object to conduct batch operations.
|
7208
7208
|
*
|
7209
|
-
* @see https://
|
7209
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
|
7210
7210
|
*
|
7211
7211
|
* @returns A new BlobBatchClient object for this container.
|
7212
7212
|
*/
|
@@ -7991,7 +7991,7 @@ export declare class ContainerSASPermissions {
|
|
7991
7991
|
* order accepted by the service.
|
7992
7992
|
*
|
7993
7993
|
* The order of the characters should be as specified here to ensure correctness.
|
7994
|
-
* @see https://
|
7994
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
7995
7995
|
*
|
7996
7996
|
*/
|
7997
7997
|
toString(): string;
|
@@ -8377,7 +8377,7 @@ export declare interface FilterBlobSegmentModel {
|
|
8377
8377
|
* Generates a {@link SASQueryParameters} object which contains all SAS query parameters needed to make an actual
|
8378
8378
|
* REST request.
|
8379
8379
|
*
|
8380
|
-
* @see https://
|
8380
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
8381
8381
|
*
|
8382
8382
|
* @param accountSASSignatureValues -
|
8383
8383
|
* @param sharedKeyCredential -
|
@@ -9113,7 +9113,7 @@ export declare class PageBlobClient extends BlobClient {
|
|
9113
9113
|
/**
|
9114
9114
|
* Creates a page blob of the specified length. Call uploadPages to upload data
|
9115
9115
|
* data to a page blob.
|
9116
|
-
* @see https://
|
9116
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-blob
|
9117
9117
|
*
|
9118
9118
|
* @param size - size of the page blob.
|
9119
9119
|
* @param options - Options to the Page Blob Create operation.
|
@@ -9124,7 +9124,7 @@ export declare class PageBlobClient extends BlobClient {
|
|
9124
9124
|
* Creates a page blob of the specified length. Call uploadPages to upload data
|
9125
9125
|
* data to a page blob. If the blob with the same name already exists, the content
|
9126
9126
|
* of the existing blob will remain unchanged.
|
9127
|
-
* @see https://
|
9127
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-blob
|
9128
9128
|
*
|
9129
9129
|
* @param size - size of the page blob.
|
9130
9130
|
* @param options -
|
@@ -9132,7 +9132,7 @@ export declare class PageBlobClient extends BlobClient {
|
|
9132
9132
|
createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions): Promise<PageBlobCreateIfNotExistsResponse>;
|
9133
9133
|
/**
|
9134
9134
|
* Writes 1 or more pages to the page blob. The start and end offsets must be a multiple of 512.
|
9135
|
-
* @see https://
|
9135
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-page
|
9136
9136
|
*
|
9137
9137
|
* @param body - Data to upload
|
9138
9138
|
* @param offset - Offset of destination page blob
|
@@ -9144,7 +9144,7 @@ export declare class PageBlobClient extends BlobClient {
|
|
9144
9144
|
/**
|
9145
9145
|
* The Upload Pages operation writes a range of pages to a page blob where the
|
9146
9146
|
* contents are read from a URL.
|
9147
|
-
* @see https://
|
9147
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/put-page-from-url
|
9148
9148
|
*
|
9149
9149
|
* @param sourceURL - Specify a URL to the copy source, Shared Access Signature(SAS) maybe needed for authentication
|
9150
9150
|
* @param sourceOffset - The source offset to copy from. Pass 0 to copy from the beginning of source page blob
|
@@ -9155,7 +9155,7 @@ export declare class PageBlobClient extends BlobClient {
|
|
9155
9155
|
uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions): Promise<PageBlobUploadPagesFromURLResponse>;
|
9156
9156
|
/**
|
9157
9157
|
* Frees the specified pages from the page blob.
|
9158
|
-
* @see https://
|
9158
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-page
|
9159
9159
|
*
|
9160
9160
|
* @param offset - Starting byte position of the pages to clear.
|
9161
9161
|
* @param count - Number of bytes to clear.
|
@@ -9165,7 +9165,7 @@ export declare class PageBlobClient extends BlobClient {
|
|
9165
9165
|
clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>;
|
9166
9166
|
/**
|
9167
9167
|
* Returns the list of valid page ranges for a page blob or snapshot of a page blob.
|
9168
|
-
* @see https://
|
9168
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
|
9169
9169
|
*
|
9170
9170
|
* @param offset - Starting byte position of the page ranges.
|
9171
9171
|
* @param count - Number of bytes to get.
|
@@ -9178,7 +9178,7 @@ export declare class PageBlobClient extends BlobClient {
|
|
9178
9178
|
* specified Marker. Use an empty Marker to start enumeration from the beginning.
|
9179
9179
|
* After getting a segment, process it, and then call getPageRangesSegment again
|
9180
9180
|
* (passing the the previously-returned Marker) to get the next segment.
|
9181
|
-
* @see https://
|
9181
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
|
9182
9182
|
*
|
9183
9183
|
* @param offset - Starting byte position of the page ranges.
|
9184
9184
|
* @param count - Number of bytes to get.
|
@@ -9211,7 +9211,7 @@ export declare class PageBlobClient extends BlobClient {
|
|
9211
9211
|
private listPageRangeItems;
|
9212
9212
|
/**
|
9213
9213
|
* Returns an async iterable iterator to list of page ranges for a page blob.
|
9214
|
-
* @see https://
|
9214
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
|
9215
9215
|
*
|
9216
9216
|
* .byPage() returns an async iterable iterator to list of page ranges for a page blob.
|
9217
9217
|
*
|
@@ -9283,7 +9283,7 @@ export declare class PageBlobClient extends BlobClient {
|
|
9283
9283
|
listPageRanges(offset?: number, count?: number, options?: PageBlobListPageRangesOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel>;
|
9284
9284
|
/**
|
9285
9285
|
* Gets the collection of page ranges that differ between a specified snapshot and this page blob.
|
9286
|
-
* @see https://
|
9286
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
|
9287
9287
|
*
|
9288
9288
|
* @param offset - Starting byte position of the page blob
|
9289
9289
|
* @param count - Number of bytes to get ranges diff.
|
@@ -9298,7 +9298,7 @@ export declare class PageBlobClient extends BlobClient {
|
|
9298
9298
|
* Use an empty Marker to start enumeration from the beginning.
|
9299
9299
|
* After getting a segment, process it, and then call getPageRangesDiffSegment again
|
9300
9300
|
* (passing the the previously-returned Marker) to get the next segment.
|
9301
|
-
* @see https://
|
9301
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
|
9302
9302
|
*
|
9303
9303
|
* @param offset - Starting byte position of the page ranges.
|
9304
9304
|
* @param count - Number of bytes to get.
|
@@ -9335,7 +9335,7 @@ export declare class PageBlobClient extends BlobClient {
|
|
9335
9335
|
private listPageRangeDiffItems;
|
9336
9336
|
/**
|
9337
9337
|
* Returns an async iterable iterator to list of page ranges that differ between a specified snapshot and this page blob.
|
9338
|
-
* @see https://
|
9338
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
|
9339
9339
|
*
|
9340
9340
|
* .byPage() returns an async iterable iterator to list of page ranges that differ between a specified snapshot and this page blob.
|
9341
9341
|
*
|
@@ -9408,7 +9408,7 @@ export declare class PageBlobClient extends BlobClient {
|
|
9408
9408
|
listPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobListPageRangesDiffOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel>;
|
9409
9409
|
/**
|
9410
9410
|
* Gets the collection of page ranges that differ between a specified snapshot and this page blob for managed disks.
|
9411
|
-
* @see https://
|
9411
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
|
9412
9412
|
*
|
9413
9413
|
* @param offset - Starting byte position of the page blob
|
9414
9414
|
* @param count - Number of bytes to get ranges diff.
|
@@ -9419,7 +9419,7 @@ export declare class PageBlobClient extends BlobClient {
|
|
9419
9419
|
getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>;
|
9420
9420
|
/**
|
9421
9421
|
* Resizes the page blob to the specified size (which must be a multiple of 512).
|
9422
|
-
* @see https://
|
9422
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
|
9423
9423
|
*
|
9424
9424
|
* @param size - Target size
|
9425
9425
|
* @param options - Options to the Page Blob Resize operation.
|
@@ -9428,7 +9428,7 @@ export declare class PageBlobClient extends BlobClient {
|
|
9428
9428
|
resize(size: number, options?: PageBlobResizeOptions): Promise<PageBlobResizeResponse>;
|
9429
9429
|
/**
|
9430
9430
|
* Sets a page blob's sequence number.
|
9431
|
-
* @see https://
|
9431
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
|
9432
9432
|
*
|
9433
9433
|
* @param sequenceNumberAction - Indicates how the service should modify the blob's sequence number.
|
9434
9434
|
* @param sequenceNumber - Required if sequenceNumberAction is max or update
|
@@ -9441,8 +9441,8 @@ export declare class PageBlobClient extends BlobClient {
|
|
9441
9441
|
* The snapshot is copied such that only the differential changes between the previously
|
9442
9442
|
* copied snapshot are transferred to the destination.
|
9443
9443
|
* The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual.
|
9444
|
-
* @see https://
|
9445
|
-
* @see https://
|
9444
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/incremental-copy-blob
|
9445
|
+
* @see https://learn.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
|
9446
9446
|
*
|
9447
9447
|
* @param copySource - Specifies the name of the source page blob snapshot. For example,
|
9448
9448
|
* https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=<DateTime>
|
@@ -9565,7 +9565,7 @@ export declare interface PageBlobCreateIfNotExistsOptions extends CommonOptions
|
|
9565
9565
|
legalHold?: boolean;
|
9566
9566
|
/**
|
9567
9567
|
* Access tier.
|
9568
|
-
* More Details - https://
|
9568
|
+
* More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers
|
9569
9569
|
*/
|
9570
9570
|
tier?: PremiumPageBlobTier | string;
|
9571
9571
|
}
|
@@ -9665,7 +9665,7 @@ export declare interface PageBlobCreateOptions extends CommonOptions {
|
|
9665
9665
|
legalHold?: boolean;
|
9666
9666
|
/**
|
9667
9667
|
* Access tier.
|
9668
|
-
* More Details - https://
|
9668
|
+
* More Details - https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-storage-tiers
|
9669
9669
|
*/
|
9670
9670
|
tier?: PremiumPageBlobTier | string;
|
9671
9671
|
/**
|
@@ -10392,7 +10392,7 @@ export { PollOperationState }
|
|
10392
10392
|
|
10393
10393
|
/**
|
10394
10394
|
* Specifies the page blob tier to set the blob to. This is only applicable to page blobs on premium storage accounts.
|
10395
|
-
* Please see {@link https://
|
10395
|
+
* Please see {@link https://learn.microsoft.com/azure/storage/storage-premium-storage#scalability-and-performance-targets|here}
|
10396
10396
|
* for detailed information on the corresponding IOPS and throughput per PageBlobTier.
|
10397
10397
|
*/
|
10398
10398
|
export declare enum PremiumPageBlobTier {
|
@@ -10477,7 +10477,7 @@ declare interface QuerySerialization {
|
|
10477
10477
|
|
10478
10478
|
/**
|
10479
10479
|
* Range for Blob Service Operations.
|
10480
|
-
* @see https://
|
10480
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations
|
10481
10481
|
*/
|
10482
10482
|
declare interface Range_2 {
|
10483
10483
|
/**
|
@@ -10637,7 +10637,7 @@ export declare class SASQueryParameters {
|
|
10637
10637
|
/**
|
10638
10638
|
* Optional. The signed identifier (only for {@link BlobSASSignatureValues}).
|
10639
10639
|
*
|
10640
|
-
* @see https://
|
10640
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
|
10641
10641
|
*/
|
10642
10642
|
readonly identifier?: string;
|
10643
10643
|
/**
|
@@ -10646,7 +10646,7 @@ export declare class SASQueryParameters {
|
|
10646
10646
|
readonly encryptionScope?: string;
|
10647
10647
|
/**
|
10648
10648
|
* Optional. Specifies which resources are accessible via the SAS (only for {@link BlobSASSignatureValues}).
|
10649
|
-
* @see https://
|
10649
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only
|
10650
10650
|
*/
|
10651
10651
|
readonly resource?: string;
|
10652
10652
|
/**
|
@@ -10812,7 +10812,7 @@ export declare interface SASQueryParametersOptions {
|
|
10812
10812
|
/**
|
10813
10813
|
* Optional. The signed identifier (only for {@link BlobSASSignatureValues}).
|
10814
10814
|
*
|
10815
|
-
* @see https://
|
10815
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
|
10816
10816
|
*/
|
10817
10817
|
identifier?: string;
|
10818
10818
|
/**
|
@@ -10821,7 +10821,7 @@ export declare interface SASQueryParametersOptions {
|
|
10821
10821
|
encryptionScope?: string;
|
10822
10822
|
/**
|
10823
10823
|
* Optional. Specifies which resources are accessible via the SAS (only for {@link BlobSASSignatureValues}).
|
10824
|
-
* @see https://
|
10824
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only
|
10825
10825
|
*/
|
10826
10826
|
resource?: string;
|
10827
10827
|
/**
|
@@ -11380,7 +11380,7 @@ export declare interface SignedIdentifier {
|
|
11380
11380
|
expiresOn?: Date;
|
11381
11381
|
/**
|
11382
11382
|
* The permissions for the acl policy
|
11383
|
-
* @see https://
|
11383
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-acl
|
11384
11384
|
*/
|
11385
11385
|
permissions?: string;
|
11386
11386
|
};
|
@@ -11588,7 +11588,7 @@ export declare interface StorageRetryOptions {
|
|
11588
11588
|
* A value of zero or undefined means no default timeout on SDK client, Azure
|
11589
11589
|
* Storage server's default timeout policy will be used.
|
11590
11590
|
*
|
11591
|
-
* @see https://
|
11591
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations
|
11592
11592
|
*/
|
11593
11593
|
readonly tryTimeoutInMs?: number;
|
11594
11594
|
/**
|
@@ -11608,7 +11608,7 @@ export declare interface StorageRetryOptions {
|
|
11608
11608
|
*
|
11609
11609
|
* NOTE: Before setting this field, make sure you understand the issues around
|
11610
11610
|
* reading stale and potentially-inconsistent data at
|
11611
|
-
* {@link https://
|
11611
|
+
* {@link https://learn.microsoft.com/en-us/azure/storage/common/storage-designing-ha-apps-with-ragrs}
|
11612
11612
|
*/
|
11613
11613
|
readonly secondaryHost?: string;
|
11614
11614
|
}
|
@@ -11756,7 +11756,7 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
11756
11756
|
protected signRequest(request: WebResource): WebResource;
|
11757
11757
|
/**
|
11758
11758
|
* Retrieve header value according to shared key sign rules.
|
11759
|
-
* @see https://
|
11759
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
|
11760
11760
|
*
|
11761
11761
|
* @param request -
|
11762
11762
|
* @param headerName -
|