@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.
Files changed (43) hide show
  1. package/LICENSE +3 -3
  2. package/README.md +17 -19
  3. package/dist/index.js +104 -116
  4. package/dist/index.js.map +1 -1
  5. package/dist-esm/storage-blob/src/BatchResponseParser.js +1 -1
  6. package/dist-esm/storage-blob/src/BatchResponseParser.js.map +1 -1
  7. package/dist-esm/storage-blob/src/BlobBatch.js +1 -1
  8. package/dist-esm/storage-blob/src/BlobBatch.js.map +1 -1
  9. package/dist-esm/storage-blob/src/BlobBatchClient.js +2 -2
  10. package/dist-esm/storage-blob/src/BlobBatchClient.js.map +1 -1
  11. package/dist-esm/storage-blob/src/BlobLeaseClient.js +10 -10
  12. package/dist-esm/storage-blob/src/BlobLeaseClient.js.map +1 -1
  13. package/dist-esm/storage-blob/src/BlobServiceClient.js +11 -11
  14. package/dist-esm/storage-blob/src/BlobServiceClient.js.map +1 -1
  15. package/dist-esm/storage-blob/src/Clients.js +43 -43
  16. package/dist-esm/storage-blob/src/Clients.js.map +1 -1
  17. package/dist-esm/storage-blob/src/ContainerClient.js +18 -18
  18. package/dist-esm/storage-blob/src/ContainerClient.js.map +1 -1
  19. package/dist-esm/storage-blob/src/Range.js.map +1 -1
  20. package/dist-esm/storage-blob/src/StorageRetryPolicyFactory.js.map +1 -1
  21. package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js +1 -1
  22. package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js.map +1 -1
  23. package/dist-esm/storage-blob/src/models.js +2 -2
  24. package/dist-esm/storage-blob/src/models.js.map +1 -1
  25. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js +2 -2
  26. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js.map +1 -1
  27. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js +2 -2
  28. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js.map +1 -1
  29. package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js +2 -2
  30. package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js.map +1 -1
  31. package/dist-esm/storage-blob/src/sas/AccountSASResourceTypes.js +1 -1
  32. package/dist-esm/storage-blob/src/sas/AccountSASResourceTypes.js.map +1 -1
  33. package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js +1 -1
  34. package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js.map +1 -1
  35. package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js +1 -1
  36. package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js.map +1 -1
  37. package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js +1 -1
  38. package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js.map +1 -1
  39. package/dist-esm/storage-blob/src/sas/SASQueryParameters.js.map +1 -1
  40. package/dist-esm/storage-blob/src/utils/utils.common.js +3 -3
  41. package/dist-esm/storage-blob/src/utils/utils.common.js.map +1 -1
  42. package/package.json +4 -4
  43. package/types/latest/storage-blob.d.ts +131 -131
@@ -87,7 +87,7 @@ export class ContainerClient extends StorageClient {
87
87
  /**
88
88
  * Creates a new container under the specified account. If the container with
89
89
  * the same name already exists, the operation fails.
90
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
90
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
91
91
  * Naming rules: @see https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
92
92
  *
93
93
  * @param options - Options to Container Create operation.
@@ -109,7 +109,7 @@ export class ContainerClient extends StorageClient {
109
109
  /**
110
110
  * Creates a new container under the specified account. If the container with
111
111
  * the same name already exists, it is not changed.
112
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
112
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
113
113
  * Naming rules: @see https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
114
114
  *
115
115
  * @param options -
@@ -203,7 +203,7 @@ export class ContainerClient extends StorageClient {
203
203
  /**
204
204
  * Returns all user-defined metadata and system properties for the specified
205
205
  * container. The data returned does not include the container's list of blobs.
206
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties
206
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-properties
207
207
  *
208
208
  * WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
209
209
  * they originally contained uppercase characters. This differs from the metadata keys returned by
@@ -223,7 +223,7 @@ export class ContainerClient extends StorageClient {
223
223
  /**
224
224
  * Marks the specified container for deletion. The container and any blobs
225
225
  * contained within it are later deleted during garbage collection.
226
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
226
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container
227
227
  *
228
228
  * @param options - Options to Container Delete operation.
229
229
  */
@@ -243,7 +243,7 @@ export class ContainerClient extends StorageClient {
243
243
  /**
244
244
  * Marks the specified container for deletion if it exists. The container and any blobs
245
245
  * contained within it are later deleted during garbage collection.
246
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
246
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container
247
247
  *
248
248
  * @param options - Options to Container Delete operation.
249
249
  */
@@ -268,7 +268,7 @@ export class ContainerClient extends StorageClient {
268
268
  * If no option provided, or no metadata defined in the parameter, the container
269
269
  * metadata will be removed.
270
270
  *
271
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
271
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
272
272
  *
273
273
  * @param metadata - Replace existing metadata with this value.
274
274
  * If no value provided the existing metadata will be removed.
@@ -298,7 +298,7 @@ export class ContainerClient extends StorageClient {
298
298
  * WARNING: JavaScript Date will potentially lose precision when parsing startsOn and expiresOn strings.
299
299
  * For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
300
300
  *
301
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl
301
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-acl
302
302
  *
303
303
  * @param options - Options to Container Get Access Policy operation.
304
304
  */
@@ -356,7 +356,7 @@ export class ContainerClient extends StorageClient {
356
356
  * When you establish a stored access policy on a container, it may take up to 30 seconds to take effect.
357
357
  * During this interval, a shared access signature that is associated with the stored access policy will
358
358
  * fail with status code 403 (Forbidden), until the access policy becomes active.
359
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl
359
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-acl
360
360
  *
361
361
  * @param access - The level of public access to data in the container.
362
362
  * @param containerAcl - Array of elements each having a unique Id and details of the access policy.
@@ -411,7 +411,7 @@ export class ContainerClient extends StorageClient {
411
411
  * {@link BlockBlobClient.uploadStream} or {@link BlockBlobClient.uploadBrowserData} for better
412
412
  * performance with concurrency uploading.
413
413
  *
414
- * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
414
+ * @see https://learn.microsoft.com/rest/api/storageservices/put-blob
415
415
  *
416
416
  * @param blobName - Name of the block blob to create or update.
417
417
  * @param body - Blob, string, ArrayBuffer, ArrayBufferView or a function
@@ -436,7 +436,7 @@ export class ContainerClient extends StorageClient {
436
436
  * during garbage collection. Note that in order to delete a blob, you must delete
437
437
  * all of its snapshots. You can delete both at the same time with the Delete
438
438
  * Blob operation.
439
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
439
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob
440
440
  *
441
441
  * @param blobName -
442
442
  * @param options - Options to Blob Delete operation.
@@ -456,7 +456,7 @@ export class ContainerClient extends StorageClient {
456
456
  * specified Marker. Use an empty Marker to start enumeration from the beginning.
457
457
  * After getting a segment, process it, and then call listBlobsFlatSegment again
458
458
  * (passing the the previously-returned Marker) to get the next segment.
459
- * @see https://docs.microsoft.com/rest/api/storageservices/list-blobs
459
+ * @see https://learn.microsoft.com/rest/api/storageservices/list-blobs
460
460
  *
461
461
  * @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
462
462
  * @param options - Options to Container List Blob Flat Segment operation.
@@ -476,7 +476,7 @@ export class ContainerClient extends StorageClient {
476
476
  * the specified Marker. Use an empty Marker to start enumeration from the
477
477
  * beginning. After getting a segment, process it, and then call listBlobsHierarchicalSegment
478
478
  * again (passing the the previously-returned Marker) to get the next segment.
479
- * @see https://docs.microsoft.com/rest/api/storageservices/list-blobs
479
+ * @see https://learn.microsoft.com/rest/api/storageservices/list-blobs
480
480
  *
481
481
  * @param delimiter - The character or string used to define the virtual hierarchy
482
482
  * @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
@@ -1078,7 +1078,7 @@ export class ContainerClient extends StorageClient {
1078
1078
  * for the specified account.
1079
1079
  * The Get Account Information operation is available on service versions beginning
1080
1080
  * with version 2018-03-28.
1081
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
1081
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information
1082
1082
  *
1083
1083
  * @param options - Options to the Service Get Account Info operation.
1084
1084
  * @returns Response data for the Service Get Account Info operation.
@@ -1134,7 +1134,7 @@ export class ContainerClient extends StorageClient {
1134
1134
  * Generates a Blob Container Service Shared Access Signature (SAS) URI based on the client properties
1135
1135
  * and parameters passed in. The SAS is signed by the shared key credential of the client.
1136
1136
  *
1137
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
1137
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
1138
1138
  *
1139
1139
  * @param options - Optional parameters.
1140
1140
  * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
@@ -1154,7 +1154,7 @@ export class ContainerClient extends StorageClient {
1154
1154
  * Generates string to sign for a Blob Container Service Shared Access Signature (SAS) URI
1155
1155
  * based on the client properties and parameters passed in. The SAS is signed by the shared key credential of the client.
1156
1156
  *
1157
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
1157
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
1158
1158
  *
1159
1159
  * @param options - Optional parameters.
1160
1160
  * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
@@ -1170,7 +1170,7 @@ export class ContainerClient extends StorageClient {
1170
1170
  * Generates a Blob Container Service Shared Access Signature (SAS) URI based on the client properties
1171
1171
  * and parameters passed in. The SAS is signed by the input user delegation key.
1172
1172
  *
1173
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
1173
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
1174
1174
  *
1175
1175
  * @param options - Optional parameters.
1176
1176
  * @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
@@ -1186,7 +1186,7 @@ export class ContainerClient extends StorageClient {
1186
1186
  * Generates string to sign for a Blob Container Service Shared Access Signature (SAS) URI
1187
1187
  * based on the client properties and parameters passed in. The SAS is signed by the input user delegation key.
1188
1188
  *
1189
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
1189
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
1190
1190
  *
1191
1191
  * @param options - Optional parameters.
1192
1192
  * @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
@@ -1198,7 +1198,7 @@ export class ContainerClient extends StorageClient {
1198
1198
  /**
1199
1199
  * Creates a BlobBatchClient object to conduct batch operations.
1200
1200
  *
1201
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
1201
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
1202
1202
  *
1203
1203
  * @returns A new BlobBatchClient object for this container.
1204
1204
  */