@azure/storage-queue 12.25.0 → 12.26.0-alpha.20250319.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 (73) hide show
  1. package/LICENSE +3 -3
  2. package/README.md +24 -28
  3. package/dist/index.js +40 -53
  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 +54 -54
  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/generated/src/models/parameters.js +1 -1
  24. package/dist-esm/storage-blob/src/generated/src/models/parameters.js.map +1 -1
  25. package/dist-esm/storage-blob/src/generated/src/storageClient.js +2 -2
  26. package/dist-esm/storage-blob/src/generated/src/storageClient.js.map +1 -1
  27. package/dist-esm/storage-blob/src/models.js +2 -2
  28. package/dist-esm/storage-blob/src/models.js.map +1 -1
  29. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js +2 -2
  30. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js.map +1 -1
  31. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js +2 -2
  32. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js.map +1 -1
  33. package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js +2 -2
  34. package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js.map +1 -1
  35. package/dist-esm/storage-blob/src/sas/AccountSASResourceTypes.js +1 -1
  36. package/dist-esm/storage-blob/src/sas/AccountSASResourceTypes.js.map +1 -1
  37. package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js +1 -1
  38. package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js.map +1 -1
  39. package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js +1 -1
  40. package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js.map +1 -1
  41. package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js +1 -1
  42. package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js.map +1 -1
  43. package/dist-esm/storage-blob/src/sas/SASQueryParameters.js.map +1 -1
  44. package/dist-esm/storage-blob/src/utils/constants.js +2 -2
  45. package/dist-esm/storage-blob/src/utils/constants.js.map +1 -1
  46. package/dist-esm/storage-blob/src/utils/utils.common.js +3 -3
  47. package/dist-esm/storage-blob/src/utils/utils.common.js.map +1 -1
  48. package/dist-esm/storage-blob/src/utils/utils.node.js +1 -1
  49. package/dist-esm/storage-blob/src/utils/utils.node.js.map +1 -1
  50. package/dist-esm/storage-queue/src/AccountSASPermissions.js +2 -2
  51. package/dist-esm/storage-queue/src/AccountSASPermissions.js.map +1 -1
  52. package/dist-esm/storage-queue/src/AccountSASResourceTypes.js +1 -1
  53. package/dist-esm/storage-queue/src/AccountSASResourceTypes.js.map +1 -1
  54. package/dist-esm/storage-queue/src/AccountSASSignatureValues.js +1 -1
  55. package/dist-esm/storage-queue/src/AccountSASSignatureValues.js.map +1 -1
  56. package/dist-esm/storage-queue/src/QueueClient.js +16 -16
  57. package/dist-esm/storage-queue/src/QueueClient.js.map +1 -1
  58. package/dist-esm/storage-queue/src/QueueSASSignatureValues.js.map +1 -1
  59. package/dist-esm/storage-queue/src/QueueServiceClient.js +8 -8
  60. package/dist-esm/storage-queue/src/QueueServiceClient.js.map +1 -1
  61. package/dist-esm/storage-queue/src/SASQueryParameters.js.map +1 -1
  62. package/dist-esm/storage-queue/src/StorageClient.js +1 -1
  63. package/dist-esm/storage-queue/src/StorageClient.js.map +1 -1
  64. package/dist-esm/storage-queue/src/generated/src/models/parameters.js +1 -1
  65. package/dist-esm/storage-queue/src/generated/src/models/parameters.js.map +1 -1
  66. package/dist-esm/storage-queue/src/generated/src/storageClient.js +2 -2
  67. package/dist-esm/storage-queue/src/generated/src/storageClient.js.map +1 -1
  68. package/dist-esm/storage-queue/src/utils/constants.js +2 -2
  69. package/dist-esm/storage-queue/src/utils/constants.js.map +1 -1
  70. package/dist-esm/storage-queue/src/utils/utils.common.js +1 -1
  71. package/dist-esm/storage-queue/src/utils/utils.common.js.map +1 -1
  72. package/package.json +10 -10
  73. package/types/latest/storage-queue.d.ts +39 -39
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
- The MIT License (MIT)
1
+ Copyright (c) Microsoft Corporation.
2
2
 
3
- Copyright (c) 2020 Microsoft
3
+ MIT License
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
@@ -12,7 +12,7 @@ furnished to do so, subject to the following conditions:
12
12
  The above copyright notice and this permission notice shall be included in all
13
13
  copies or substantial portions of the Software.
14
14
 
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
+ THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
16
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
17
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
18
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
package/README.md CHANGED
@@ -14,10 +14,10 @@ Key links:
14
14
 
15
15
  - [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-queue)
16
16
  - [Package (npm)](https://www.npmjs.com/package/@azure/storage-queue)
17
- - [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/storage-queue)
18
- - [Product documentation](https://docs.microsoft.com/azure/storage/queues/storage-queues-introduction)
17
+ - [API Reference Documentation](https://learn.microsoft.com/javascript/api/@azure/storage-queue)
18
+ - [Product documentation](https://learn.microsoft.com/azure/storage/queues/storage-queues-introduction)
19
19
  - [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-queue/samples)
20
- - [Azure Storage Queue REST APIs](https://docs.microsoft.com/rest/api/storageservices/queue-service-rest-api)
20
+ - [Azure Storage Queue REST APIs](https://learn.microsoft.com/rest/api/storageservices/queue-service-rest-api)
21
21
 
22
22
  ## Getting started
23
23
 
@@ -31,7 +31,7 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP
31
31
  ### Prerequisites
32
32
 
33
33
  - An [Azure subscription](https://azure.microsoft.com/free/)
34
- - A [Storage Account](https://docs.microsoft.com/azure/storage/common/storage-account-create)
34
+ - A [Storage Account](https://learn.microsoft.com/azure/storage/common/storage-account-create)
35
35
 
36
36
  ### Install the package
37
37
 
@@ -88,7 +88,7 @@ To use this client library in the browser, first you need to use a bundler. For
88
88
 
89
89
  ### CORS
90
90
 
91
- You need to set up [Cross-Origin Resource Sharing (CORS)](https://docs.microsoft.com/rest/api/storageservices/cross-origin-resource-sharing--cors--support-for-the-azure-storage-services) rules for your storage account if you need to develop for browsers. Go to Azure portal and Azure Storage Explorer, find your storage account, create new CORS rules for blob/queue/file/table service(s).
91
+ You need to set up [Cross-Origin Resource Sharing (CORS)](https://learn.microsoft.com/rest/api/storageservices/cross-origin-resource-sharing--cors--support-for-the-azure-storage-services) rules for your storage account if you need to develop for browsers. Go to Azure portal and Azure Storage Explorer, find your storage account, create new CORS rules for blob/queue/file/table service(s).
92
92
 
93
93
  For example, you can create following CORS settings for debugging. But please customize the settings carefully according to your requirements in production environment.
94
94
 
@@ -132,17 +132,17 @@ The `QueueServiceClient` requires an URL to the queue service and an access cred
132
132
 
133
133
  **Recommended way to instantiate a `QueueServiceClient`**
134
134
 
135
- Setup : Reference - Authorize access to blobs and queues with Azure Active Directory from a client application - https://docs.microsoft.com/azure/storage/common/storage-auth-aad-app
135
+ Setup : Reference - Authorize access to blobs and queues with Azure Active Directory from a client application - https://learn.microsoft.com/azure/storage/common/storage-auth-aad-app
136
136
 
137
137
  - Register a new AAD application and give permissions to access Azure Storage on behalf of the signed-in user
138
138
 
139
- - Register a new application in the Azure Active Directory(in the azure-portal) - https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app
139
+ - Register a new application in the Azure Active Directory(in the azure-portal) - https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app
140
140
  - In the `API permissions` section, select `Add a permission` and choose `Microsoft APIs`.
141
141
  - Pick `Azure Storage` and select the checkbox next to `user_impersonation` and then click `Add permissions`. This would allow the application to access Azure Storage on behalf of the signed-in user.
142
142
 
143
143
  - Grant access to Azure Storage Queue data with RBAC in the Azure Portal
144
144
 
145
- - RBAC roles for blobs and queues - https://docs.microsoft.com/azure/storage/common/storage-auth-aad-rbac-portal.
145
+ - RBAC roles for blobs and queues - https://learn.microsoft.com/azure/storage/common/storage-auth-aad-rbac-portal.
146
146
  - In the azure portal, go to your storage-account and assign **Storage Queue Data Contributor** role to the registered AAD application from `Access control (IAM)` tab (in the left-side-navbar of your storage account in the azure-portal).
147
147
 
148
148
  - Environment setup for the sample
@@ -158,7 +158,7 @@ const credential = new DefaultAzureCredential();
158
158
 
159
159
  const queueServiceClient = new QueueServiceClient(
160
160
  `https://${account}.queue.core.windows.net`,
161
- credential
161
+ credential,
162
162
  );
163
163
  ```
164
164
 
@@ -197,8 +197,8 @@ const queueServiceClient = new QueueServiceClient(
197
197
  sharedKeyCredential,
198
198
  {
199
199
  retryOptions: { maxTries: 4 }, // Retry options
200
- telemetry: { value: "BasicSample/V11.0.0" } // Customized telemetry string
201
- }
200
+ telemetry: { value: "BasicSample/V11.0.0" }, // Customized telemetry string
201
+ },
202
202
  );
203
203
  ```
204
204
 
@@ -210,9 +210,7 @@ Also, You can instantiate a `QueueServiceClient` with a shared access signatures
210
210
  const { QueueServiceClient } = require("@azure/storage-queue");
211
211
  const account = "<account name>";
212
212
  const sas = "<service Shared Access Signature Token>";
213
- const queueServiceClient = new QueueServiceClient(
214
- `https://${account}.queue.core.windows.net${sas}`
215
- );
213
+ const queueServiceClient = new QueueServiceClient(`https://${account}.queue.core.windows.net?${sas}`);
216
214
  ```
217
215
 
218
216
  ### List queues in this account
@@ -229,7 +227,7 @@ const credential = new DefaultAzureCredential();
229
227
 
230
228
  const queueServiceClient = new QueueServiceClient(
231
229
  `https://${account}.queue.core.windows.net`,
232
- credential
230
+ credential,
233
231
  );
234
232
 
235
233
  async function main() {
@@ -255,7 +253,7 @@ const credential = new DefaultAzureCredential();
255
253
 
256
254
  const queueServiceClient = new QueueServiceClient(
257
255
  `https://${account}.queue.core.windows.net`,
258
- credential
256
+ credential,
259
257
  );
260
258
 
261
259
  async function main() {
@@ -286,7 +284,7 @@ const credential = new DefaultAzureCredential();
286
284
 
287
285
  const queueServiceClient = new QueueServiceClient(
288
286
  `https://${account}.queue.core.windows.net`,
289
- credential
287
+ credential,
290
288
  );
291
289
 
292
290
  const queueName = "<valid queue name>";
@@ -295,7 +293,7 @@ async function main() {
295
293
  const queueClient = queueServiceClient.getQueueClient(queueName);
296
294
  const createQueueResponse = await queueClient.create();
297
295
  console.log(
298
- `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`
296
+ `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`,
299
297
  );
300
298
  }
301
299
 
@@ -315,7 +313,7 @@ const credential = new DefaultAzureCredential();
315
313
 
316
314
  const queueServiceClient = new QueueServiceClient(
317
315
  `https://${account}.queue.core.windows.net`,
318
- credential
316
+ credential,
319
317
  );
320
318
 
321
319
  const queueName = "<valid queue name>";
@@ -325,7 +323,7 @@ async function main() {
325
323
  // Send a message into the queue using the sendMessage method.
326
324
  const sendMessageResponse = await queueClient.sendMessage("Hello World!");
327
325
  console.log(
328
- `Sent message successfully, service assigned message Id: ${sendMessageResponse.messageId}, service assigned request Id: ${sendMessageResponse.requestId}`
326
+ `Sent message successfully, service assigned message Id: ${sendMessageResponse.messageId}, service assigned request Id: ${sendMessageResponse.requestId}`,
329
327
  );
330
328
  }
331
329
 
@@ -346,7 +344,7 @@ const credential = new DefaultAzureCredential();
346
344
 
347
345
  const queueServiceClient = new QueueServiceClient(
348
346
  `https://${account}.queue.core.windows.net`,
349
- credential
347
+ credential,
350
348
  );
351
349
 
352
350
  const queueName = "<valid queue name>";
@@ -378,7 +376,7 @@ const credential = new DefaultAzureCredential();
378
376
 
379
377
  const queueServiceClient = new QueueServiceClient(
380
378
  `https://${account}.queue.core.windows.net`,
381
- credential
379
+ credential,
382
380
  );
383
381
 
384
382
  const queueName = "<valid queue name>";
@@ -391,10 +389,10 @@ async function main() {
391
389
  console.log(`Processing & deleting message with content: ${receivedMessageItem.messageText}`);
392
390
  const deleteMessageResponse = await queueClient.deleteMessage(
393
391
  receivedMessageItem.messageId,
394
- receivedMessageItem.popReceipt
392
+ receivedMessageItem.popReceipt,
395
393
  );
396
394
  console.log(
397
- `Delete message successfully, service assigned request Id: ${deleteMessageResponse.requestId}`
395
+ `Delete message successfully, service assigned request Id: ${deleteMessageResponse.requestId}`,
398
396
  );
399
397
  }
400
398
  }
@@ -413,7 +411,7 @@ const credential = new DefaultAzureCredential();
413
411
 
414
412
  const queueServiceClient = new QueueServiceClient(
415
413
  `https://${account}.queue.core.windows.net`,
416
- credential
414
+ credential,
417
415
  );
418
416
 
419
417
  const queueName = "<valid queue name>";
@@ -422,7 +420,7 @@ async function main() {
422
420
  const queueClient = queueServiceClient.getQueueClient(queueName);
423
421
  const deleteQueueResponse = await queueClient.delete();
424
422
  console.log(
425
- `Deleted queue successfully, service assigned request Id: ${deleteQueueResponse.requestId}`
423
+ `Deleted queue successfully, service assigned request Id: ${deleteQueueResponse.requestId}`,
426
424
  );
427
425
  }
428
426
 
@@ -453,5 +451,3 @@ More code samples
453
451
  If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
454
452
 
455
453
  Also refer to [Storage specific guide](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/CONTRIBUTING.md) for additional information on setting up the test environment for storage libraries.
456
-
457
- ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fstorage%2Fstorage-queue%2FREADME.png)
package/dist/index.js CHANGED
@@ -126,12 +126,12 @@ class AccountSASPermissions {
126
126
  * Using this method will guarantee the resource types are in
127
127
  * an order accepted by the service.
128
128
  *
129
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
129
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
130
130
  *
131
131
  */
132
132
  toString() {
133
133
  // The order of the characters should be as specified here to ensure correctness:
134
- // https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
134
+ // https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
135
135
  // Use a string array instead of string concatenating += operator for performance
136
136
  const permissions = [];
137
137
  if (this.read) {
@@ -216,7 +216,7 @@ class AccountSASResourceTypes {
216
216
  /**
217
217
  * Converts the given resource types to a string.
218
218
  *
219
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
219
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
220
220
  *
221
221
  */
222
222
  toString() {
@@ -329,8 +329,8 @@ function ipRangeToString(ipRange) {
329
329
 
330
330
  // Copyright (c) Microsoft Corporation.
331
331
  // Licensed under the MIT License.
332
- const SDK_VERSION = "12.25.0";
333
- const SERVICE_VERSION = "2025-01-05";
332
+ const SDK_VERSION = "12.26.0";
333
+ const SERVICE_VERSION = "2025-05-05";
334
334
  /**
335
335
  * The OAuth scope to use with Azure Storage.
336
336
  */
@@ -427,7 +427,7 @@ function appendToURLPath(url, name) {
427
427
  }
428
428
  function getProxyUriFromDevConnString(connectionString) {
429
429
  // Development Connection String
430
- // https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string#connect-to-the-emulator-account-using-the-well-known-account-name-and-key
430
+ // 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
431
431
  let proxyUri = "";
432
432
  if (connectionString.search("DevelopmentStorageProxyUri=") !== -1) {
433
433
  // CONNECTION_STRING=UseDevelopmentStorage=true;DevelopmentStorageProxyUri=http://myProxyUri
@@ -754,7 +754,7 @@ class SASQueryParameters {
754
754
  * Generates a {@link SASQueryParameters} object which contains all SAS query parameters needed to make an actual
755
755
  * REST request.
756
756
  *
757
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
757
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
758
758
  *
759
759
  * @param accountSASSignatureValues - SAS Signature values of the account
760
760
  * @param sharedKeyCredential - Shared key credential.
@@ -941,21 +941,15 @@ class AnonymousCredential extends Credential {
941
941
  const URLConstants = {
942
942
  Parameters: {
943
943
  FORCE_BROWSER_NO_CACHE: "_",
944
- SIGNATURE: "sig",
945
- SNAPSHOT: "snapshot",
946
- VERSIONID: "versionid",
947
944
  TIMEOUT: "timeout",
948
945
  },
949
946
  };
950
947
  const HeaderConstants = {
951
948
  AUTHORIZATION: "Authorization",
952
- AUTHORIZATION_SCHEME: "Bearer",
953
949
  CONTENT_ENCODING: "Content-Encoding",
954
- CONTENT_ID: "Content-ID",
955
950
  CONTENT_LANGUAGE: "Content-Language",
956
951
  CONTENT_LENGTH: "Content-Length",
957
952
  CONTENT_MD5: "Content-Md5",
958
- CONTENT_TRANSFER_ENCODING: "Content-Transfer-Encoding",
959
953
  CONTENT_TYPE: "Content-Type",
960
954
  COOKIE: "Cookie",
961
955
  DATE: "date",
@@ -965,14 +959,7 @@ const HeaderConstants = {
965
959
  IF_UNMODIFIED_SINCE: "if-unmodified-since",
966
960
  PREFIX_FOR_STORAGE: "x-ms-",
967
961
  RANGE: "Range",
968
- USER_AGENT: "User-Agent",
969
- X_MS_CLIENT_REQUEST_ID: "x-ms-client-request-id",
970
- X_MS_COPY_SOURCE: "x-ms-copy-source",
971
- X_MS_DATE: "x-ms-date",
972
- X_MS_ERROR_CODE: "x-ms-error-code",
973
- X_MS_VERSION: "x-ms-version",
974
- X_MS_CopySourceErrorCode: "x-ms-copy-source-error-code",
975
- };
962
+ X_MS_DATE: "x-ms-date"};
976
963
 
977
964
  // Copyright (c) Microsoft Corporation.
978
965
  // Licensed under the MIT License.
@@ -1217,7 +1204,7 @@ class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
1217
1204
  }
1218
1205
  /**
1219
1206
  * Retrieve header value according to shared key sign rules.
1220
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
1207
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
1221
1208
  *
1222
1209
  * @param request -
1223
1210
  * @param headerName -
@@ -1229,7 +1216,7 @@ class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
1229
1216
  }
1230
1217
  // When using version 2015-02-21 or later, if Content-Length is zero, then
1231
1218
  // set the Content-Length part of the StringToSign to an empty string.
1232
- // https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
1219
+ // https://learn.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
1233
1220
  if (headerName === HeaderConstants.CONTENT_LENGTH && value === "0") {
1234
1221
  return "";
1235
1222
  }
@@ -1843,7 +1830,7 @@ function storageSharedKeyCredentialPolicy(options) {
1843
1830
  }
1844
1831
  /**
1845
1832
  * Retrieve header value according to shared key sign rules.
1846
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
1833
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
1847
1834
  */
1848
1835
  function getHeaderValueToSign(request, headerName) {
1849
1836
  const value = request.headers.get(headerName);
@@ -1852,7 +1839,7 @@ function storageSharedKeyCredentialPolicy(options) {
1852
1839
  }
1853
1840
  // When using version 2015-02-21 or later, if Content-Length is zero, then
1854
1841
  // set the Content-Length part of the StringToSign to an empty string.
1855
- // https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
1842
+ // https://learn.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
1856
1843
  if (headerName === HeaderConstants.CONTENT_LENGTH && value === "0") {
1857
1844
  return "";
1858
1845
  }
@@ -4125,7 +4112,7 @@ const timeoutInSeconds = {
4125
4112
  const version = {
4126
4113
  parameterPath: "version",
4127
4114
  mapper: {
4128
- defaultValue: "2025-01-05",
4115
+ defaultValue: "2025-05-05",
4129
4116
  isConstant: true,
4130
4117
  serializedName: "x-ms-version",
4131
4118
  type: {
@@ -5066,7 +5053,7 @@ let StorageClient$1 = class StorageClient extends coreHttpCompat__namespace.Exte
5066
5053
  const defaults = {
5067
5054
  requestContentType: "application/json; charset=utf-8"
5068
5055
  };
5069
- const packageDetails = `azsdk-js-azure-storage-queue/12.25.0`;
5056
+ const packageDetails = `azsdk-js-azure-storage-queue/12.26.0`;
5070
5057
  const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
5071
5058
  ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
5072
5059
  : `${packageDetails}`;
@@ -5077,7 +5064,7 @@ let StorageClient$1 = class StorageClient extends coreHttpCompat__namespace.Exte
5077
5064
  // Parameter assignments
5078
5065
  this.url = url;
5079
5066
  // Assigning values to Constant parameters
5080
- this.version = options.version || "2025-01-05";
5067
+ this.version = options.version || "2025-05-05";
5081
5068
  this.service = new ServiceImpl(this);
5082
5069
  this.queue = new QueueImpl(this);
5083
5070
  this.messages = new MessagesImpl(this);
@@ -5128,7 +5115,7 @@ function getStorageClientContext(url, pipeline) {
5128
5115
  const pipelineOptions = pipeline.options;
5129
5116
  // Set maximum timeout for queue operations.
5130
5117
  // This was previously set manually in the retry policy specific to this package.
5131
- // https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations
5118
+ // https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations
5132
5119
  if (pipelineOptions.retryOptions === undefined) {
5133
5120
  pipelineOptions.retryOptions = {
5134
5121
  tryTimeoutInMs: 30 * 1000,
@@ -5383,7 +5370,7 @@ class QueueClient extends StorageClient {
5383
5370
  }
5384
5371
  /**
5385
5372
  * Creates a new queue under the specified account.
5386
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
5373
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-queue4
5387
5374
  *
5388
5375
  * @param options - Options to Queue create operation.
5389
5376
  * @returns Response data for the Queue create operation.
@@ -5403,7 +5390,7 @@ class QueueClient extends StorageClient {
5403
5390
  /**
5404
5391
  * Creates a new queue under the specified account if it doesn't already exist.
5405
5392
  * If the queue already exists, it is not changed.
5406
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
5393
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-queue4
5407
5394
  *
5408
5395
  * @param options -
5409
5396
  */
@@ -5430,7 +5417,7 @@ class QueueClient extends StorageClient {
5430
5417
  }
5431
5418
  /**
5432
5419
  * Deletes the specified queue permanently if it exists.
5433
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
5420
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-queue3
5434
5421
  *
5435
5422
  * @param options -
5436
5423
  */
@@ -5451,7 +5438,7 @@ class QueueClient extends StorageClient {
5451
5438
  }
5452
5439
  /**
5453
5440
  * Deletes the specified queue permanently.
5454
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
5441
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-queue3
5455
5442
  *
5456
5443
  * @param options - Options to Queue delete operation.
5457
5444
  * @returns Response data for the Queue delete operation.
@@ -5499,7 +5486,7 @@ class QueueClient extends StorageClient {
5499
5486
  /**
5500
5487
  * Gets all user-defined metadata and system properties for the specified
5501
5488
  * queue. Metadata is associated with the queue as name-values pairs.
5502
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata
5489
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata
5503
5490
  *
5504
5491
  * WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
5505
5492
  * they originally contained uppercase characters. This differs from the metadata keys returned by
@@ -5519,7 +5506,7 @@ class QueueClient extends StorageClient {
5519
5506
  *
5520
5507
  * If no option provided, or no metadata defined in the option parameter, the queue
5521
5508
  * metadata will be removed.
5522
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata
5509
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata
5523
5510
  *
5524
5511
  * @param metadata - If no metadata provided, all existing metadata will be removed.
5525
5512
  * @param options - Options to Queue set metadata operation.
@@ -5536,7 +5523,7 @@ class QueueClient extends StorageClient {
5536
5523
  * WARNING: JavaScript Date will potential lost precision when parsing start and expiry string.
5537
5524
  * For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
5538
5525
  *
5539
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl
5526
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-acl
5540
5527
  *
5541
5528
  * @param options - Options to Queue get access policy operation.
5542
5529
  * @returns Response data for the Queue get access policy operation.
@@ -5579,7 +5566,7 @@ class QueueClient extends StorageClient {
5579
5566
  }
5580
5567
  /**
5581
5568
  * Sets stored access policies for the queue that may be used with Shared Access Signatures.
5582
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl
5569
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-acl
5583
5570
  *
5584
5571
  * @param queueAcl -
5585
5572
  * @param options - Options to Queue set access policy operation.
@@ -5607,7 +5594,7 @@ class QueueClient extends StorageClient {
5607
5594
  }
5608
5595
  /**
5609
5596
  * Clear deletes all messages from a queue.
5610
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages
5597
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/clear-messages
5611
5598
  *
5612
5599
  * @param options - Options to clear messages operation.
5613
5600
  * @returns Response data for the clear messages operation.
@@ -5622,7 +5609,7 @@ class QueueClient extends StorageClient {
5622
5609
  * the message should be invisible to Dequeue and Peek operations.
5623
5610
  * The message content is up to 64KB in size, and must be in a format that can be included in an XML request with UTF-8 encoding.
5624
5611
  * To include markup in the message, the contents of the message must either be XML-escaped or Base64-encode.
5625
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/put-message
5612
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/put-message
5626
5613
  *
5627
5614
  * @param messageText - Text of the message to send
5628
5615
  * @param options - Options to send messages operation.
@@ -5661,7 +5648,7 @@ class QueueClient extends StorageClient {
5661
5648
  }
5662
5649
  /**
5663
5650
  * receiveMessages retrieves one or more messages from the front of the queue.
5664
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages
5651
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-messages
5665
5652
  *
5666
5653
  * @param options - Options to receive messages operation.
5667
5654
  * @returns Response data for the receive messages operation.
@@ -5704,7 +5691,7 @@ class QueueClient extends StorageClient {
5704
5691
  }
5705
5692
  /**
5706
5693
  * peekMessages retrieves one or more messages from the front of the queue but does not alter the visibility of the message.
5707
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages
5694
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/peek-messages
5708
5695
  *
5709
5696
  * @param options - Options to peek messages operation.
5710
5697
  * @returns Response data for the peek messages operation.
@@ -5736,7 +5723,7 @@ class QueueClient extends StorageClient {
5736
5723
  }
5737
5724
  /**
5738
5725
  * deleteMessage permanently removes the specified message from its queue.
5739
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2
5726
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-message2
5740
5727
  *
5741
5728
  * @param messageId - Id of the message.
5742
5729
  * @param popReceipt - A valid pop receipt value returned from an earlier call to the receive messages or update message operation.
@@ -5752,7 +5739,7 @@ class QueueClient extends StorageClient {
5752
5739
  * Update changes a message's visibility timeout and contents.
5753
5740
  * The message content is up to 64KB in size, and must be in a format that can be included in an XML request with UTF-8 encoding.
5754
5741
  * To include markup in the message, the contents of the message must either be XML-escaped or Base64-encode.
5755
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/update-message
5742
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/update-message
5756
5743
  *
5757
5744
  * @param messageId - Id of the message
5758
5745
  * @param popReceipt - A valid pop receipt value returned from an earlier call to the receive messages or update message operation.
@@ -5818,7 +5805,7 @@ class QueueClient extends StorageClient {
5818
5805
  * Generates a Service Shared Access Signature (SAS) URI based on the client properties
5819
5806
  * and parameters passed in. The SAS is signed by the shared key credential of the client.
5820
5807
  *
5821
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
5808
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
5822
5809
  *
5823
5810
  * @param options - Optional parameters.
5824
5811
  * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
@@ -5836,7 +5823,7 @@ class QueueClient extends StorageClient {
5836
5823
  * Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
5837
5824
  * and parameters passed in. The SAS is signed by the shared key credential of the client.
5838
5825
  *
5839
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
5826
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
5840
5827
  *
5841
5828
  * @param options - Optional parameters.
5842
5829
  * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
@@ -5934,7 +5921,7 @@ class QueueServiceClient extends StorageClient {
5934
5921
  }
5935
5922
  /**
5936
5923
  * Returns a list of the queues under the specified account.
5937
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/list-queues1
5924
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-queues1
5938
5925
  *
5939
5926
  * @param marker - A string value that identifies the portion of
5940
5927
  * the list of queues to be returned with the next listing operation. The
@@ -6118,7 +6105,7 @@ class QueueServiceClient extends StorageClient {
6118
6105
  /**
6119
6106
  * Gets the properties of a storage account’s Queue service, including properties
6120
6107
  * for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
6121
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties
6108
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties
6122
6109
  *
6123
6110
  * @param options - Options to get properties operation.
6124
6111
  * @returns Response data including the queue service properties.
@@ -6131,7 +6118,7 @@ class QueueServiceClient extends StorageClient {
6131
6118
  /**
6132
6119
  * Sets properties for a storage account’s Queue service endpoint, including properties
6133
6120
  * for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.
6134
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties
6121
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties
6135
6122
  *
6136
6123
  * @param properties -
6137
6124
  * @param options - Options to set properties operation.
@@ -6146,7 +6133,7 @@ class QueueServiceClient extends StorageClient {
6146
6133
  * Retrieves statistics related to replication for the Queue service. It is only
6147
6134
  * available on the secondary location endpoint when read-access geo-redundant
6148
6135
  * replication is enabled for the storage account.
6149
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats
6136
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats
6150
6137
  *
6151
6138
  * @param options - Options to get statistics operation.
6152
6139
  * @returns Response data for get statistics the operation.
@@ -6158,7 +6145,7 @@ class QueueServiceClient extends StorageClient {
6158
6145
  }
6159
6146
  /**
6160
6147
  * Creates a new queue under the specified account.
6161
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
6148
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-queue4
6162
6149
  *
6163
6150
  * @param queueName - name of the queue to create
6164
6151
  * @param options - Options to Queue create operation.
@@ -6171,7 +6158,7 @@ class QueueServiceClient extends StorageClient {
6171
6158
  }
6172
6159
  /**
6173
6160
  * Deletes the specified queue permanently.
6174
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
6161
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-queue3
6175
6162
  *
6176
6163
  * @param queueName - name of the queue to delete.
6177
6164
  * @param options - Options to Queue delete operation.
@@ -6188,7 +6175,7 @@ class QueueServiceClient extends StorageClient {
6188
6175
  * Generates an account Shared Access Signature (SAS) URI based on the client properties
6189
6176
  * and parameters passed in. The SAS is signed by the shared key credential of the client.
6190
6177
  *
6191
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
6178
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
6192
6179
  *
6193
6180
  * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.
6194
6181
  * @param permissions - Specifies the list of permissions to be associated with the SAS.
@@ -6215,7 +6202,7 @@ class QueueServiceClient extends StorageClient {
6215
6202
  * Generates string to sign for an account Shared Access Signature (SAS) URI based on the client properties
6216
6203
  * and parameters passed in. The SAS is signed by the shared key credential of the client.
6217
6204
  *
6218
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
6205
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
6219
6206
  *
6220
6207
  * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.
6221
6208
  * @param permissions - Specifies the list of permissions to be associated with the SAS.