@azure/storage-queue 12.27.0-alpha.20250530.1 → 12.27.0-alpha.20250611.3
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/README.md +1 -1
- package/dist/browser/AccountSASPermissions.d.ts +1 -1
- package/dist/browser/AccountSASPermissions.js +2 -2
- package/dist/browser/AccountSASPermissions.js.map +1 -1
- package/dist/browser/AccountSASResourceTypes.d.ts +1 -1
- package/dist/browser/AccountSASResourceTypes.js +1 -1
- package/dist/browser/AccountSASResourceTypes.js.map +1 -1
- package/dist/browser/AccountSASSignatureValues.d.ts +3 -3
- package/dist/browser/AccountSASSignatureValues.js +1 -1
- package/dist/browser/AccountSASSignatureValues.js.map +1 -1
- package/dist/browser/QueueClient.d.ts +21 -21
- package/dist/browser/QueueClient.d.ts.map +1 -1
- package/dist/browser/QueueClient.js +16 -16
- package/dist/browser/QueueClient.js.map +1 -1
- package/dist/browser/QueueSASSignatureValues.d.ts +1 -1
- package/dist/browser/QueueSASSignatureValues.js.map +1 -1
- package/dist/browser/QueueServiceClient.d.ts +8 -8
- package/dist/browser/QueueServiceClient.js +8 -8
- package/dist/browser/QueueServiceClient.js.map +1 -1
- package/dist/browser/SASQueryParameters.d.ts +1 -1
- package/dist/browser/SASQueryParameters.js.map +1 -1
- package/dist/browser/StorageClient.js +1 -1
- package/dist/browser/StorageClient.js.map +1 -1
- package/dist/browser/utils/utils.common.js +1 -1
- package/dist/browser/utils/utils.common.js.map +1 -1
- package/dist/commonjs/AccountSASPermissions.d.ts +1 -1
- package/dist/commonjs/AccountSASPermissions.js +2 -2
- package/dist/commonjs/AccountSASPermissions.js.map +1 -1
- package/dist/commonjs/AccountSASResourceTypes.d.ts +1 -1
- package/dist/commonjs/AccountSASResourceTypes.js +1 -1
- package/dist/commonjs/AccountSASResourceTypes.js.map +1 -1
- package/dist/commonjs/AccountSASSignatureValues.d.ts +3 -3
- package/dist/commonjs/AccountSASSignatureValues.js +1 -1
- package/dist/commonjs/AccountSASSignatureValues.js.map +1 -1
- package/dist/commonjs/QueueClient.d.ts +21 -21
- package/dist/commonjs/QueueClient.d.ts.map +1 -1
- package/dist/commonjs/QueueClient.js +16 -16
- package/dist/commonjs/QueueClient.js.map +1 -1
- package/dist/commonjs/QueueSASSignatureValues.d.ts +1 -1
- package/dist/commonjs/QueueSASSignatureValues.js.map +1 -1
- package/dist/commonjs/QueueServiceClient.d.ts +8 -8
- package/dist/commonjs/QueueServiceClient.js +8 -8
- package/dist/commonjs/QueueServiceClient.js.map +1 -1
- package/dist/commonjs/SASQueryParameters.d.ts +1 -1
- package/dist/commonjs/SASQueryParameters.js.map +1 -1
- package/dist/commonjs/StorageClient.js +1 -1
- package/dist/commonjs/StorageClient.js.map +1 -1
- package/dist/commonjs/utils/utils.common.js +1 -1
- package/dist/commonjs/utils/utils.common.js.map +1 -1
- package/dist/esm/AccountSASPermissions.d.ts +1 -1
- package/dist/esm/AccountSASPermissions.js +2 -2
- package/dist/esm/AccountSASPermissions.js.map +1 -1
- package/dist/esm/AccountSASResourceTypes.d.ts +1 -1
- package/dist/esm/AccountSASResourceTypes.js +1 -1
- package/dist/esm/AccountSASResourceTypes.js.map +1 -1
- package/dist/esm/AccountSASSignatureValues.d.ts +3 -3
- package/dist/esm/AccountSASSignatureValues.js +1 -1
- package/dist/esm/AccountSASSignatureValues.js.map +1 -1
- package/dist/esm/QueueClient.d.ts +21 -21
- package/dist/esm/QueueClient.d.ts.map +1 -1
- package/dist/esm/QueueClient.js +16 -16
- package/dist/esm/QueueClient.js.map +1 -1
- package/dist/esm/QueueSASSignatureValues.d.ts +1 -1
- package/dist/esm/QueueSASSignatureValues.js.map +1 -1
- package/dist/esm/QueueServiceClient.d.ts +8 -8
- package/dist/esm/QueueServiceClient.js +8 -8
- package/dist/esm/QueueServiceClient.js.map +1 -1
- package/dist/esm/SASQueryParameters.d.ts +1 -1
- package/dist/esm/SASQueryParameters.js.map +1 -1
- package/dist/esm/StorageClient.js +1 -1
- package/dist/esm/StorageClient.js.map +1 -1
- package/dist/esm/utils/utils.common.js +1 -1
- package/dist/esm/utils/utils.common.js.map +1 -1
- package/dist/react-native/AccountSASPermissions.d.ts +1 -1
- package/dist/react-native/AccountSASPermissions.js +2 -2
- package/dist/react-native/AccountSASPermissions.js.map +1 -1
- package/dist/react-native/AccountSASResourceTypes.d.ts +1 -1
- package/dist/react-native/AccountSASResourceTypes.js +1 -1
- package/dist/react-native/AccountSASResourceTypes.js.map +1 -1
- package/dist/react-native/AccountSASSignatureValues.d.ts +3 -3
- package/dist/react-native/AccountSASSignatureValues.js +1 -1
- package/dist/react-native/AccountSASSignatureValues.js.map +1 -1
- package/dist/react-native/QueueClient.d.ts +21 -21
- package/dist/react-native/QueueClient.d.ts.map +1 -1
- package/dist/react-native/QueueClient.js +16 -16
- package/dist/react-native/QueueClient.js.map +1 -1
- package/dist/react-native/QueueSASSignatureValues.d.ts +1 -1
- package/dist/react-native/QueueSASSignatureValues.js.map +1 -1
- package/dist/react-native/QueueServiceClient.d.ts +8 -8
- package/dist/react-native/QueueServiceClient.js +8 -8
- package/dist/react-native/QueueServiceClient.js.map +1 -1
- package/dist/react-native/SASQueryParameters.d.ts +1 -1
- package/dist/react-native/SASQueryParameters.js.map +1 -1
- package/dist/react-native/StorageClient.js +1 -1
- package/dist/react-native/StorageClient.js.map +1 -1
- package/dist/react-native/utils/utils.common.js +1 -1
- package/dist/react-native/utils/utils.common.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -178,7 +178,7 @@ const queueServiceClient = QueueServiceClient.fromConnectionString(connectionStr
|
|
|
178
178
|
|
|
179
179
|
#### with `StorageSharedKeyCredential`
|
|
180
180
|
|
|
181
|
-
Alternatively, you instantiate a `QueueServiceClient` with a `StorageSharedKeyCredential` by passing
|
|
181
|
+
Alternatively, you instantiate a `QueueServiceClient` with a `StorageSharedKeyCredential` by passing `accountName` and `accountKey` as arguments. (The values of account name and account key can be obtained from the azure portal.)
|
|
182
182
|
[ONLY AVAILABLE IN NODE.JS RUNTIME]
|
|
183
183
|
|
|
184
184
|
```ts snippet:ReadmeSampleCreateClient_StorageSharedKeyCredential
|
|
@@ -53,7 +53,7 @@ export declare class AccountSASPermissions {
|
|
|
53
53
|
* Using this method will guarantee the resource types are in
|
|
54
54
|
* an order accepted by the service.
|
|
55
55
|
*
|
|
56
|
-
* @see https://learn.microsoft.com/
|
|
56
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
|
|
57
57
|
*
|
|
58
58
|
*/
|
|
59
59
|
toString(): string;
|
|
@@ -90,12 +90,12 @@ export class AccountSASPermissions {
|
|
|
90
90
|
* Using this method will guarantee the resource types are in
|
|
91
91
|
* an order accepted by the service.
|
|
92
92
|
*
|
|
93
|
-
* @see https://learn.microsoft.com/
|
|
93
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
|
|
94
94
|
*
|
|
95
95
|
*/
|
|
96
96
|
toString() {
|
|
97
97
|
// The order of the characters should be as specified here to ensure correctness:
|
|
98
|
-
// https://learn.microsoft.com/
|
|
98
|
+
// https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
|
|
99
99
|
// Use a string array instead of string concatenating += operator for performance
|
|
100
100
|
const permissions = [];
|
|
101
101
|
if (this.read) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AccountSASPermissions.js","sourceRoot":"","sources":["../../src/AccountSASPermissions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;;;;GAQG;AACH,MAAM,OAAO,qBAAqB;IAAlC;QA2CE;;WAEG;QACI,SAAI,GAAY,KAAK,CAAC;QAE7B;;WAEG;QACI,UAAK,GAAY,KAAK,CAAC;QAE9B;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;QAE/B;;WAEG;QACI,SAAI,GAAY,KAAK,CAAC;QAE7B;;WAEG;QACI,QAAG,GAAY,KAAK,CAAC;QAE5B;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;QAE/B;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;QAE/B;;WAEG;QACI,YAAO,GAAY,KAAK,CAAC;IA2ClC,CAAC;IA3HC;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,WAAmB;QACrC,MAAM,qBAAqB,GAAG,IAAI,qBAAqB,EAAE,CAAC;QAE1D,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;YAC5B,QAAQ,CAAC,EAAE,CAAC;gBACV,KAAK,GAAG;oBACN,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC;oBAClC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,KAAK,GAAG,IAAI,CAAC;oBACnC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACpC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC;oBAClC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,GAAG,GAAG,IAAI,CAAC;oBACjC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACpC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACpC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC;oBACrC,MAAM;gBACR;oBACE,MAAM,IAAI,UAAU,CAAC,iCAAiC,CAAC,EAAE,CAAC,CAAC;YAC/D,CAAC;QACH,CAAC;QAED,OAAO,qBAAqB,CAAC;IAC/B,CAAC;IA0CD;;;;;;;;;OASG;IACI,QAAQ;QACb,iFAAiF;QACjF,
|
|
1
|
+
{"version":3,"file":"AccountSASPermissions.js","sourceRoot":"","sources":["../../src/AccountSASPermissions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;;;;GAQG;AACH,MAAM,OAAO,qBAAqB;IAAlC;QA2CE;;WAEG;QACI,SAAI,GAAY,KAAK,CAAC;QAE7B;;WAEG;QACI,UAAK,GAAY,KAAK,CAAC;QAE9B;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;QAE/B;;WAEG;QACI,SAAI,GAAY,KAAK,CAAC;QAE7B;;WAEG;QACI,QAAG,GAAY,KAAK,CAAC;QAE5B;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;QAE/B;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;QAE/B;;WAEG;QACI,YAAO,GAAY,KAAK,CAAC;IA2ClC,CAAC;IA3HC;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,WAAmB;QACrC,MAAM,qBAAqB,GAAG,IAAI,qBAAqB,EAAE,CAAC;QAE1D,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;YAC5B,QAAQ,CAAC,EAAE,CAAC;gBACV,KAAK,GAAG;oBACN,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC;oBAClC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,KAAK,GAAG,IAAI,CAAC;oBACnC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACpC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC;oBAClC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,GAAG,GAAG,IAAI,CAAC;oBACjC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACpC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACpC,MAAM;gBACR,KAAK,GAAG;oBACN,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC;oBACrC,MAAM;gBACR;oBACE,MAAM,IAAI,UAAU,CAAC,iCAAiC,CAAC,EAAE,CAAC,CAAC;YAC/D,CAAC;QACH,CAAC;QAED,OAAO,qBAAqB,CAAC;IAC/B,CAAC;IA0CD;;;;;;;;;OASG;IACI,QAAQ;QACb,iFAAiF;QACjF,mFAAmF;QACnF,iFAAiF;QACjF,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACb,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,OAAO,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * ONLY AVAILABLE IN NODE.JS RUNTIME.\n *\n * This is a helper class to construct a string representing the permissions granted by an AccountSAS. Setting a value\n * to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the\n * values are set, this should be serialized with toString and set as the permissions field on an\n * {@link AccountSASSignatureValues} object. It is possible to construct the permissions string without this class, but\n * the order of the permissions is particular and this class guarantees correctness.\n */\nexport class AccountSASPermissions {\n /**\n * Parse initializes the AccountSASPermissions fields from a string.\n *\n * @param permissions -\n */\n public static parse(permissions: string): AccountSASPermissions {\n const accountSASPermissions = new AccountSASPermissions();\n\n for (const c of permissions) {\n switch (c) {\n case \"r\":\n accountSASPermissions.read = true;\n break;\n case \"w\":\n accountSASPermissions.write = true;\n break;\n case \"d\":\n accountSASPermissions.delete = true;\n break;\n case \"l\":\n accountSASPermissions.list = true;\n break;\n case \"a\":\n accountSASPermissions.add = true;\n break;\n case \"c\":\n accountSASPermissions.create = true;\n break;\n case \"u\":\n accountSASPermissions.update = true;\n break;\n case \"p\":\n accountSASPermissions.process = true;\n break;\n default:\n throw new RangeError(`Invalid permission character: ${c}`);\n }\n }\n\n return accountSASPermissions;\n }\n\n /**\n * Permission to read resources granted.\n */\n public read: boolean = false;\n\n /**\n * Permission to write resources granted.\n */\n public write: boolean = false;\n\n /**\n * Permission to delete queues and messages granted.\n */\n public delete: boolean = false;\n\n /**\n * Permission to list queues granted.\n */\n public list: boolean = false;\n\n /**\n * Permission to add messages, table entities, and append to blobs granted.\n */\n public add: boolean = false;\n\n /**\n * Permission to create queues, blobs and files granted.\n */\n public create: boolean = false;\n\n /**\n * Permissions to update messages and table entities granted.\n */\n public update: boolean = false;\n\n /**\n * Permission to get and delete messages granted.\n */\n public process: boolean = false;\n\n /**\n * Produces the SAS permissions string for an Azure Storage account.\n * Call this method to set AccountSASSignatureValues Permissions field.\n *\n * Using this method will guarantee the resource types are in\n * an order accepted by the service.\n *\n * @see https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas\n *\n */\n public toString(): string {\n // The order of the characters should be as specified here to ensure correctness:\n // https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas\n // Use a string array instead of string concatenating += operator for performance\n const permissions: string[] = [];\n if (this.read) {\n permissions.push(\"r\");\n }\n if (this.write) {\n permissions.push(\"w\");\n }\n if (this.delete) {\n permissions.push(\"d\");\n }\n if (this.list) {\n permissions.push(\"l\");\n }\n if (this.add) {\n permissions.push(\"a\");\n }\n if (this.create) {\n permissions.push(\"c\");\n }\n if (this.update) {\n permissions.push(\"u\");\n }\n if (this.process) {\n permissions.push(\"p\");\n }\n return permissions.join(\"\");\n }\n}\n"]}
|
|
@@ -30,7 +30,7 @@ export declare class AccountSASResourceTypes {
|
|
|
30
30
|
/**
|
|
31
31
|
* Converts the given resource types to a string.
|
|
32
32
|
*
|
|
33
|
-
* @see https://learn.microsoft.com/
|
|
33
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
|
|
34
34
|
*
|
|
35
35
|
*/
|
|
36
36
|
toString(): string;
|
|
@@ -52,7 +52,7 @@ export class AccountSASResourceTypes {
|
|
|
52
52
|
/**
|
|
53
53
|
* Converts the given resource types to a string.
|
|
54
54
|
*
|
|
55
|
-
* @see https://learn.microsoft.com/
|
|
55
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
|
|
56
56
|
*
|
|
57
57
|
*/
|
|
58
58
|
toString() {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AccountSASResourceTypes.js","sourceRoot":"","sources":["../../src/AccountSASResourceTypes.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;;;;GAQG;AACH,MAAM,OAAO,uBAAuB;IAApC;QA6BE;;WAEG;QACI,YAAO,GAAY,KAAK,CAAC;QAEhC;;WAEG;QACI,cAAS,GAAY,KAAK,CAAC;QAElC;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;IAqBjC,CAAC;IA9DC;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,aAAqB;QACvC,MAAM,uBAAuB,GAAG,IAAI,uBAAuB,EAAE,CAAC;QAE9D,KAAK,MAAM,CAAC,IAAI,aAAa,EAAE,CAAC;YAC9B,QAAQ,CAAC,EAAE,CAAC;gBACV,KAAK,GAAG;oBACN,uBAAuB,CAAC,OAAO,GAAG,IAAI,CAAC;oBACvC,MAAM;gBACR,KAAK,GAAG;oBACN,uBAAuB,CAAC,SAAS,GAAG,IAAI,CAAC;oBACzC,MAAM;gBACR,KAAK,GAAG;oBACN,uBAAuB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACtC,MAAM;gBACR;oBACE,MAAM,IAAI,UAAU,CAAC,0BAA0B,CAAC,EAAE,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QAED,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAiBD;;;;;OAKG;IACI,QAAQ;QACb,MAAM,aAAa,GAAa,EAAE,CAAC;QACnC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;QACD,OAAO,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * ONLY AVAILABLE IN NODE.JS RUNTIME.\n *\n * This is a helper class to construct a string representing the resources accessible by an AccountSAS. Setting a value\n * to true means that any SAS which uses these permissions will grant access to that resource type. Once all the\n * values are set, this should be serialized with toString and set as the resources field on an\n * {@link AccountSASSignatureValues} object. It is possible to construct the resources string without this class, but\n * the order of the resources is particular and this class guarantees correctness.\n */\nexport class AccountSASResourceTypes {\n /**\n * Creates an {@link AccountSASResourceTypes} from the specified resource types string. This method will throw an\n * Error if it encounters a character that does not correspond to a valid resource type.\n *\n * @param resourceTypes -\n */\n public static parse(resourceTypes: string): AccountSASResourceTypes {\n const accountSASResourceTypes = new AccountSASResourceTypes();\n\n for (const c of resourceTypes) {\n switch (c) {\n case \"s\":\n accountSASResourceTypes.service = true;\n break;\n case \"c\":\n accountSASResourceTypes.container = true;\n break;\n case \"o\":\n accountSASResourceTypes.object = true;\n break;\n default:\n throw new RangeError(`Invalid resource type: ${c}`);\n }\n }\n\n return accountSASResourceTypes;\n }\n\n /**\n * Permission to access service level APIs granted.\n */\n public service: boolean = false;\n\n /**\n * Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted.\n */\n public container: boolean = false;\n\n /**\n * Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted.\n */\n public object: boolean = false;\n\n /**\n * Converts the given resource types to a string.\n *\n * @see https://learn.microsoft.com/
|
|
1
|
+
{"version":3,"file":"AccountSASResourceTypes.js","sourceRoot":"","sources":["../../src/AccountSASResourceTypes.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;;;;GAQG;AACH,MAAM,OAAO,uBAAuB;IAApC;QA6BE;;WAEG;QACI,YAAO,GAAY,KAAK,CAAC;QAEhC;;WAEG;QACI,cAAS,GAAY,KAAK,CAAC;QAElC;;WAEG;QACI,WAAM,GAAY,KAAK,CAAC;IAqBjC,CAAC;IA9DC;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,aAAqB;QACvC,MAAM,uBAAuB,GAAG,IAAI,uBAAuB,EAAE,CAAC;QAE9D,KAAK,MAAM,CAAC,IAAI,aAAa,EAAE,CAAC;YAC9B,QAAQ,CAAC,EAAE,CAAC;gBACV,KAAK,GAAG;oBACN,uBAAuB,CAAC,OAAO,GAAG,IAAI,CAAC;oBACvC,MAAM;gBACR,KAAK,GAAG;oBACN,uBAAuB,CAAC,SAAS,GAAG,IAAI,CAAC;oBACzC,MAAM;gBACR,KAAK,GAAG;oBACN,uBAAuB,CAAC,MAAM,GAAG,IAAI,CAAC;oBACtC,MAAM;gBACR;oBACE,MAAM,IAAI,UAAU,CAAC,0BAA0B,CAAC,EAAE,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QAED,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAiBD;;;;;OAKG;IACI,QAAQ;QACb,MAAM,aAAa,GAAa,EAAE,CAAC;QACnC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;QACD,OAAO,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * ONLY AVAILABLE IN NODE.JS RUNTIME.\n *\n * This is a helper class to construct a string representing the resources accessible by an AccountSAS. Setting a value\n * to true means that any SAS which uses these permissions will grant access to that resource type. Once all the\n * values are set, this should be serialized with toString and set as the resources field on an\n * {@link AccountSASSignatureValues} object. It is possible to construct the resources string without this class, but\n * the order of the resources is particular and this class guarantees correctness.\n */\nexport class AccountSASResourceTypes {\n /**\n * Creates an {@link AccountSASResourceTypes} from the specified resource types string. This method will throw an\n * Error if it encounters a character that does not correspond to a valid resource type.\n *\n * @param resourceTypes -\n */\n public static parse(resourceTypes: string): AccountSASResourceTypes {\n const accountSASResourceTypes = new AccountSASResourceTypes();\n\n for (const c of resourceTypes) {\n switch (c) {\n case \"s\":\n accountSASResourceTypes.service = true;\n break;\n case \"c\":\n accountSASResourceTypes.container = true;\n break;\n case \"o\":\n accountSASResourceTypes.object = true;\n break;\n default:\n throw new RangeError(`Invalid resource type: ${c}`);\n }\n }\n\n return accountSASResourceTypes;\n }\n\n /**\n * Permission to access service level APIs granted.\n */\n public service: boolean = false;\n\n /**\n * Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted.\n */\n public container: boolean = false;\n\n /**\n * Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted.\n */\n public object: boolean = false;\n\n /**\n * Converts the given resource types to a string.\n *\n * @see https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas\n *\n */\n public toString(): string {\n const resourceTypes: string[] = [];\n if (this.service) {\n resourceTypes.push(\"s\");\n }\n if (this.container) {\n resourceTypes.push(\"c\");\n }\n if (this.object) {\n resourceTypes.push(\"o\");\n }\n return resourceTypes.join(\"\");\n }\n}\n"]}
|
|
@@ -12,10 +12,10 @@ import { SASQueryParameters } from "./SASQueryParameters.js";
|
|
|
12
12
|
* the former is mutable and a logical representation while the latter is immutable and used to generate actual REST
|
|
13
13
|
* requests.
|
|
14
14
|
*
|
|
15
|
-
* @see https://learn.microsoft.com/
|
|
15
|
+
* @see https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1
|
|
16
16
|
* for more conceptual information on SAS
|
|
17
17
|
*
|
|
18
|
-
* @see https://learn.microsoft.com/
|
|
18
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
|
|
19
19
|
* for descriptions of the parameters, including which are required
|
|
20
20
|
*/
|
|
21
21
|
export interface AccountSASSignatureValues {
|
|
@@ -61,7 +61,7 @@ export interface AccountSASSignatureValues {
|
|
|
61
61
|
* Generates a {@link SASQueryParameters} object which contains all SAS query parameters needed to make an actual
|
|
62
62
|
* REST request.
|
|
63
63
|
*
|
|
64
|
-
* @see https://learn.microsoft.com/
|
|
64
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
|
|
65
65
|
*
|
|
66
66
|
* @param accountSASSignatureValues - SAS Signature values of the account
|
|
67
67
|
* @param sharedKeyCredential - Shared key credential.
|
|
@@ -13,7 +13,7 @@ import { truncatedISO8061Date } from "./utils/utils.common.js";
|
|
|
13
13
|
* Generates a {@link SASQueryParameters} object which contains all SAS query parameters needed to make an actual
|
|
14
14
|
* REST request.
|
|
15
15
|
*
|
|
16
|
-
* @see https://learn.microsoft.com/
|
|
16
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas
|
|
17
17
|
*
|
|
18
18
|
* @param accountSASSignatureValues - SAS Signature values of the account
|
|
19
19
|
* @param sharedKeyCredential - Shared key credential.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AccountSASSignatureValues.js","sourceRoot":"","sources":["../../src/AccountSASSignatureValues.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAG7D,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AA8D/D;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iCAAiC,CAC/C,yBAAoD,EACpD,mBAA+C;IAE/C,OAAO,yCAAyC,CAAC,yBAAyB,EAAE,mBAAmB,CAAC;SAC7F,kBAAkB,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,yCAAyC,CACvD,yBAAoD,EACpD,mBAA+C;IAE/C,MAAM,OAAO,GAAG,yBAAyB,CAAC,OAAO;QAC/C,CAAC,CAAC,yBAAyB,CAAC,OAAO;QACnC,CAAC,CAAC,eAAe,CAAC;IAEpB,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,KAAK,CACnD,yBAAyB,CAAC,WAAW,CAAC,QAAQ,EAAE,CACjD,CAAC,QAAQ,EAAE,CAAC;IACb,MAAM,cAAc,GAAG,kBAAkB,CAAC,KAAK,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC/F,MAAM,mBAAmB,GAAG,uBAAuB,CAAC,KAAK,CACvD,yBAAyB,CAAC,aAAa,CACxC,CAAC,QAAQ,EAAE,CAAC;IAEb,IAAI,YAAoB,CAAC;IAEzB,IAAI,OAAO,IAAI,YAAY,EAAE,CAAC;QAC5B,YAAY,GAAG;YACb,mBAAmB,CAAC,WAAW;YAC/B,iBAAiB;YACjB,cAAc;YACd,mBAAmB;YACnB,yBAAyB,CAAC,QAAQ;gBAChC,CAAC,CAAC,oBAAoB,CAAC,yBAAyB,CAAC,QAAQ,EAAE,KAAK,CAAC;gBACjE,CAAC,CAAC,EAAE;YACN,oBAAoB,CAAC,yBAAyB,CAAC,SAAS,EAAE,KAAK,CAAC;YAChE,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE;YAC3F,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YAC5E,OAAO;YACP,EAAE,EAAE,gCAAgC;YACpC,EAAE,EAAE,uDAAuD;SAC5D,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;SAAM,CAAC;QACN,YAAY,GAAG;YACb,mBAAmB,CAAC,WAAW;YAC/B,iBAAiB;YACjB,cAAc;YACd,mBAAmB;YACnB,yBAAyB,CAAC,QAAQ;gBAChC,CAAC,CAAC,oBAAoB,CAAC,yBAAyB,CAAC,QAAQ,EAAE,KAAK,CAAC;gBACjE,CAAC,CAAC,EAAE;YACN,oBAAoB,CAAC,yBAAyB,CAAC,SAAS,EAAE,KAAK,CAAC;YAChE,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE;YAC3F,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YAC5E,OAAO;YACP,EAAE,EAAE,uDAAuD;SAC5D,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;IAED,MAAM,SAAS,GAAW,mBAAmB,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;IAE9E,OAAO;QACL,kBAAkB,EAAE,IAAI,kBAAkB,CACxC,OAAO,EACP,SAAS,EACT,iBAAiB,EACjB,cAAc,EACd,mBAAmB,EACnB,yBAAyB,CAAC,QAAQ,EAClC,yBAAyB,CAAC,QAAQ,EAClC,yBAAyB,CAAC,SAAS,EACnC,yBAAyB,CAAC,OAAO,CAClC;QACD,YAAY,EAAE,YAAY;KAC3B,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { AccountSASPermissions } from \"./AccountSASPermissions.js\";\nimport { AccountSASResourceTypes } from \"./AccountSASResourceTypes.js\";\nimport { AccountSASServices } from \"./AccountSASServices.js\";\nimport type { StorageSharedKeyCredential } from \"@azure/storage-blob\";\nimport type { SasIPRange } from \"./SasIPRange.js\";\nimport { ipRangeToString } from \"./SasIPRange.js\";\nimport type { SASProtocol } from \"./SASQueryParameters.js\";\nimport { SASQueryParameters } from \"./SASQueryParameters.js\";\nimport { SERVICE_VERSION } from \"./utils/constants.js\";\nimport { truncatedISO8061Date } from \"./utils/utils.common.js\";\n\n/**\n * ONLY AVAILABLE IN NODE.JS RUNTIME.\n *\n * AccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account. Once\n * all the values here are set appropriately, call generateSASQueryParameters() to obtain a representation of the SAS\n * which can actually be applied to queue urls. Note: that both this class and {@link SASQueryParameters} exist because\n * the former is mutable and a logical representation while the latter is immutable and used to generate actual REST\n * requests.\n *\n * @see https://learn.microsoft.com/
|
|
1
|
+
{"version":3,"file":"AccountSASSignatureValues.js","sourceRoot":"","sources":["../../src/AccountSASSignatureValues.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAG7D,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AA8D/D;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iCAAiC,CAC/C,yBAAoD,EACpD,mBAA+C;IAE/C,OAAO,yCAAyC,CAAC,yBAAyB,EAAE,mBAAmB,CAAC;SAC7F,kBAAkB,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,yCAAyC,CACvD,yBAAoD,EACpD,mBAA+C;IAE/C,MAAM,OAAO,GAAG,yBAAyB,CAAC,OAAO;QAC/C,CAAC,CAAC,yBAAyB,CAAC,OAAO;QACnC,CAAC,CAAC,eAAe,CAAC;IAEpB,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,KAAK,CACnD,yBAAyB,CAAC,WAAW,CAAC,QAAQ,EAAE,CACjD,CAAC,QAAQ,EAAE,CAAC;IACb,MAAM,cAAc,GAAG,kBAAkB,CAAC,KAAK,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC/F,MAAM,mBAAmB,GAAG,uBAAuB,CAAC,KAAK,CACvD,yBAAyB,CAAC,aAAa,CACxC,CAAC,QAAQ,EAAE,CAAC;IAEb,IAAI,YAAoB,CAAC;IAEzB,IAAI,OAAO,IAAI,YAAY,EAAE,CAAC;QAC5B,YAAY,GAAG;YACb,mBAAmB,CAAC,WAAW;YAC/B,iBAAiB;YACjB,cAAc;YACd,mBAAmB;YACnB,yBAAyB,CAAC,QAAQ;gBAChC,CAAC,CAAC,oBAAoB,CAAC,yBAAyB,CAAC,QAAQ,EAAE,KAAK,CAAC;gBACjE,CAAC,CAAC,EAAE;YACN,oBAAoB,CAAC,yBAAyB,CAAC,SAAS,EAAE,KAAK,CAAC;YAChE,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE;YAC3F,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YAC5E,OAAO;YACP,EAAE,EAAE,gCAAgC;YACpC,EAAE,EAAE,uDAAuD;SAC5D,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;SAAM,CAAC;QACN,YAAY,GAAG;YACb,mBAAmB,CAAC,WAAW;YAC/B,iBAAiB;YACjB,cAAc;YACd,mBAAmB;YACnB,yBAAyB,CAAC,QAAQ;gBAChC,CAAC,CAAC,oBAAoB,CAAC,yBAAyB,CAAC,QAAQ,EAAE,KAAK,CAAC;gBACjE,CAAC,CAAC,EAAE;YACN,oBAAoB,CAAC,yBAAyB,CAAC,SAAS,EAAE,KAAK,CAAC;YAChE,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE;YAC3F,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YAC5E,OAAO;YACP,EAAE,EAAE,uDAAuD;SAC5D,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;IAED,MAAM,SAAS,GAAW,mBAAmB,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;IAE9E,OAAO;QACL,kBAAkB,EAAE,IAAI,kBAAkB,CACxC,OAAO,EACP,SAAS,EACT,iBAAiB,EACjB,cAAc,EACd,mBAAmB,EACnB,yBAAyB,CAAC,QAAQ,EAClC,yBAAyB,CAAC,QAAQ,EAClC,yBAAyB,CAAC,SAAS,EACnC,yBAAyB,CAAC,OAAO,CAClC;QACD,YAAY,EAAE,YAAY;KAC3B,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { AccountSASPermissions } from \"./AccountSASPermissions.js\";\nimport { AccountSASResourceTypes } from \"./AccountSASResourceTypes.js\";\nimport { AccountSASServices } from \"./AccountSASServices.js\";\nimport type { StorageSharedKeyCredential } from \"@azure/storage-blob\";\nimport type { SasIPRange } from \"./SasIPRange.js\";\nimport { ipRangeToString } from \"./SasIPRange.js\";\nimport type { SASProtocol } from \"./SASQueryParameters.js\";\nimport { SASQueryParameters } from \"./SASQueryParameters.js\";\nimport { SERVICE_VERSION } from \"./utils/constants.js\";\nimport { truncatedISO8061Date } from \"./utils/utils.common.js\";\n\n/**\n * ONLY AVAILABLE IN NODE.JS RUNTIME.\n *\n * AccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account. Once\n * all the values here are set appropriately, call generateSASQueryParameters() to obtain a representation of the SAS\n * which can actually be applied to queue urls. Note: that both this class and {@link SASQueryParameters} exist because\n * the former is mutable and a logical representation while the latter is immutable and used to generate actual REST\n * requests.\n *\n * @see https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1\n * for more conceptual information on SAS\n *\n * @see https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas\n * for descriptions of the parameters, including which are required\n */\nexport interface AccountSASSignatureValues {\n /**\n * If not provided, this defaults to the service version targeted by this version of the library.\n */\n version?: string;\n\n /**\n * Optional. SAS protocols allowed.\n */\n protocol?: SASProtocol;\n\n /**\n * Optional. When the SAS will take effect.\n */\n startsOn?: Date;\n\n /**\n * The time after which the SAS will no longer work.\n */\n expiresOn: Date;\n\n /**\n * Specifies which operations the SAS user may perform. Please refer to {@link AccountSASPermissions} for help\n * constructing the permissions string.\n */\n permissions: AccountSASPermissions;\n\n /**\n * Optional. IP range allowed.\n */\n ipRange?: SasIPRange;\n\n /**\n * The values that indicate the services accessible with this SAS. Please refer to {@link AccountSASServices} to\n * construct this value.\n */\n services: string;\n\n /**\n * The values that indicate the resource types accessible with this SAS. Please refer\n * to {@link AccountSASResourceTypes} to construct this value.\n */\n resourceTypes: string;\n}\n\n/**\n * ONLY AVAILABLE IN NODE.JS RUNTIME.\n *\n * Generates a {@link SASQueryParameters} object which contains all SAS query parameters needed to make an actual\n * REST request.\n *\n * @see https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas\n *\n * @param accountSASSignatureValues - SAS Signature values of the account\n * @param sharedKeyCredential - Shared key credential.\n */\nexport function generateAccountSASQueryParameters(\n accountSASSignatureValues: AccountSASSignatureValues,\n sharedKeyCredential: StorageSharedKeyCredential,\n): SASQueryParameters {\n return generateAccountSASQueryParametersInternal(accountSASSignatureValues, sharedKeyCredential)\n .sasQueryParameters;\n}\n\nexport function generateAccountSASQueryParametersInternal(\n accountSASSignatureValues: AccountSASSignatureValues,\n sharedKeyCredential: StorageSharedKeyCredential,\n): { sasQueryParameters: SASQueryParameters; stringToSign: string } {\n const version = accountSASSignatureValues.version\n ? accountSASSignatureValues.version\n : SERVICE_VERSION;\n\n const parsedPermissions = AccountSASPermissions.parse(\n accountSASSignatureValues.permissions.toString(),\n ).toString();\n const parsedServices = AccountSASServices.parse(accountSASSignatureValues.services).toString();\n const parsedResourceTypes = AccountSASResourceTypes.parse(\n accountSASSignatureValues.resourceTypes,\n ).toString();\n\n let stringToSign: string;\n\n if (version >= \"2020-12-06\") {\n stringToSign = [\n sharedKeyCredential.accountName,\n parsedPermissions,\n parsedServices,\n parsedResourceTypes,\n accountSASSignatureValues.startsOn\n ? truncatedISO8061Date(accountSASSignatureValues.startsOn, false)\n : \"\",\n truncatedISO8061Date(accountSASSignatureValues.expiresOn, false),\n accountSASSignatureValues.ipRange ? ipRangeToString(accountSASSignatureValues.ipRange) : \"\",\n accountSASSignatureValues.protocol ? accountSASSignatureValues.protocol : \"\",\n version,\n \"\", // Reserved for encryption scope\n \"\", // Account SAS requires an additional newline character\n ].join(\"\\n\");\n } else {\n stringToSign = [\n sharedKeyCredential.accountName,\n parsedPermissions,\n parsedServices,\n parsedResourceTypes,\n accountSASSignatureValues.startsOn\n ? truncatedISO8061Date(accountSASSignatureValues.startsOn, false)\n : \"\",\n truncatedISO8061Date(accountSASSignatureValues.expiresOn, false),\n accountSASSignatureValues.ipRange ? ipRangeToString(accountSASSignatureValues.ipRange) : \"\",\n accountSASSignatureValues.protocol ? accountSASSignatureValues.protocol : \"\",\n version,\n \"\", // Account SAS requires an additional newline character\n ].join(\"\\n\");\n }\n\n const signature: string = sharedKeyCredential.computeHMACSHA256(stringToSign);\n\n return {\n sasQueryParameters: new SASQueryParameters(\n version,\n signature,\n parsedPermissions,\n parsedServices,\n parsedResourceTypes,\n accountSASSignatureValues.protocol,\n accountSASSignatureValues.startsOn,\n accountSASSignatureValues.expiresOn,\n accountSASSignatureValues.ipRange,\n ),\n stringToSign: stringToSign,\n };\n}\n"]}
|
|
@@ -108,7 +108,7 @@ export interface SignedIdentifier {
|
|
|
108
108
|
expiresOn?: Date;
|
|
109
109
|
/**
|
|
110
110
|
* the permissions for the acl policy
|
|
111
|
-
* @see https://learn.microsoft.com/
|
|
111
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/set-queue-acl
|
|
112
112
|
*/
|
|
113
113
|
permissions?: string;
|
|
114
114
|
};
|
|
@@ -131,7 +131,7 @@ export interface QueueClearMessagesOptions extends CommonOptions {
|
|
|
131
131
|
}
|
|
132
132
|
/** Optional parameters. */
|
|
133
133
|
export interface MessagesEnqueueOptionalParams extends CommonOptions {
|
|
134
|
-
/** The The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/
|
|
134
|
+
/** The The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a> */
|
|
135
135
|
timeoutInSeconds?: number;
|
|
136
136
|
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
|
137
137
|
requestId?: string;
|
|
@@ -152,7 +152,7 @@ export interface QueueSendMessageOptions extends MessagesEnqueueOptionalParams,
|
|
|
152
152
|
}
|
|
153
153
|
/** Optional parameters. */
|
|
154
154
|
export interface MessagesDequeueOptionalParams extends CommonOptions {
|
|
155
|
-
/** The The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/
|
|
155
|
+
/** The The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a> */
|
|
156
156
|
timeoutInSeconds?: number;
|
|
157
157
|
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
|
158
158
|
requestId?: string;
|
|
@@ -173,7 +173,7 @@ export interface QueueReceiveMessageOptions extends MessagesDequeueOptionalParam
|
|
|
173
173
|
}
|
|
174
174
|
/** Optional parameters. */
|
|
175
175
|
export interface MessagesPeekOptionalParams extends CommonOptions {
|
|
176
|
-
/** The The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/
|
|
176
|
+
/** The The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a> */
|
|
177
177
|
timeoutInSeconds?: number;
|
|
178
178
|
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
|
179
179
|
requestId?: string;
|
|
@@ -321,7 +321,7 @@ export interface QueueGenerateSasUrlOptions {
|
|
|
321
321
|
/**
|
|
322
322
|
* Optional. The name of the access policy on the queue this SAS references if any.
|
|
323
323
|
*
|
|
324
|
-
* @see https://learn.microsoft.com/
|
|
324
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
|
|
325
325
|
*/
|
|
326
326
|
identifier?: string;
|
|
327
327
|
}
|
|
@@ -381,7 +381,7 @@ export declare class QueueClient extends StorageClient {
|
|
|
381
381
|
private getMessageIdContext;
|
|
382
382
|
/**
|
|
383
383
|
* Creates a new queue under the specified account.
|
|
384
|
-
* @see https://learn.microsoft.com/
|
|
384
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/create-queue4
|
|
385
385
|
*
|
|
386
386
|
* @param options - Options to Queue create operation.
|
|
387
387
|
* @returns Response data for the Queue create operation.
|
|
@@ -410,21 +410,21 @@ export declare class QueueClient extends StorageClient {
|
|
|
410
410
|
/**
|
|
411
411
|
* Creates a new queue under the specified account if it doesn't already exist.
|
|
412
412
|
* If the queue already exists, it is not changed.
|
|
413
|
-
* @see https://learn.microsoft.com/
|
|
413
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/create-queue4
|
|
414
414
|
*
|
|
415
415
|
* @param options -
|
|
416
416
|
*/
|
|
417
417
|
createIfNotExists(options?: QueueCreateOptions): Promise<QueueCreateIfNotExistsResponse>;
|
|
418
418
|
/**
|
|
419
419
|
* Deletes the specified queue permanently if it exists.
|
|
420
|
-
* @see https://learn.microsoft.com/
|
|
420
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/delete-queue3
|
|
421
421
|
*
|
|
422
422
|
* @param options -
|
|
423
423
|
*/
|
|
424
424
|
deleteIfExists(options?: QueueDeleteOptions): Promise<QueueDeleteIfExistsResponse>;
|
|
425
425
|
/**
|
|
426
426
|
* Deletes the specified queue permanently.
|
|
427
|
-
* @see https://learn.microsoft.com/
|
|
427
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/delete-queue3
|
|
428
428
|
*
|
|
429
429
|
* @param options - Options to Queue delete operation.
|
|
430
430
|
* @returns Response data for the Queue delete operation.
|
|
@@ -463,7 +463,7 @@ export declare class QueueClient extends StorageClient {
|
|
|
463
463
|
/**
|
|
464
464
|
* Gets all user-defined metadata and system properties for the specified
|
|
465
465
|
* queue. Metadata is associated with the queue as name-values pairs.
|
|
466
|
-
* @see https://learn.microsoft.com/
|
|
466
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-queue-metadata
|
|
467
467
|
*
|
|
468
468
|
* WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
|
|
469
469
|
* they originally contained uppercase characters. This differs from the metadata keys returned by
|
|
@@ -479,7 +479,7 @@ export declare class QueueClient extends StorageClient {
|
|
|
479
479
|
*
|
|
480
480
|
* If no option provided, or no metadata defined in the option parameter, the queue
|
|
481
481
|
* metadata will be removed.
|
|
482
|
-
* @see https://learn.microsoft.com/
|
|
482
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/set-queue-metadata
|
|
483
483
|
*
|
|
484
484
|
* @param metadata - If no metadata provided, all existing metadata will be removed.
|
|
485
485
|
* @param options - Options to Queue set metadata operation.
|
|
@@ -492,7 +492,7 @@ export declare class QueueClient extends StorageClient {
|
|
|
492
492
|
* WARNING: JavaScript Date will potential lost precision when parsing start and expiry string.
|
|
493
493
|
* For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
|
|
494
494
|
*
|
|
495
|
-
* @see https://learn.microsoft.com/
|
|
495
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-queue-acl
|
|
496
496
|
*
|
|
497
497
|
* @param options - Options to Queue get access policy operation.
|
|
498
498
|
* @returns Response data for the Queue get access policy operation.
|
|
@@ -500,7 +500,7 @@ export declare class QueueClient extends StorageClient {
|
|
|
500
500
|
getAccessPolicy(options?: QueueGetAccessPolicyOptions): Promise<QueueGetAccessPolicyResponse>;
|
|
501
501
|
/**
|
|
502
502
|
* Sets stored access policies for the queue that may be used with Shared Access Signatures.
|
|
503
|
-
* @see https://learn.microsoft.com/
|
|
503
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/set-queue-acl
|
|
504
504
|
*
|
|
505
505
|
* @param queueAcl -
|
|
506
506
|
* @param options - Options to Queue set access policy operation.
|
|
@@ -509,7 +509,7 @@ export declare class QueueClient extends StorageClient {
|
|
|
509
509
|
setAccessPolicy(queueAcl?: SignedIdentifier[], options?: QueueSetAccessPolicyOptions): Promise<QueueSetAccessPolicyResponse>;
|
|
510
510
|
/**
|
|
511
511
|
* Clear deletes all messages from a queue.
|
|
512
|
-
* @see https://learn.microsoft.com/
|
|
512
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/clear-messages
|
|
513
513
|
*
|
|
514
514
|
* @param options - Options to clear messages operation.
|
|
515
515
|
* @returns Response data for the clear messages operation.
|
|
@@ -520,7 +520,7 @@ export declare class QueueClient extends StorageClient {
|
|
|
520
520
|
* the message should be invisible to Dequeue and Peek operations.
|
|
521
521
|
* 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.
|
|
522
522
|
* To include markup in the message, the contents of the message must either be XML-escaped or Base64-encode.
|
|
523
|
-
* @see https://learn.microsoft.com/
|
|
523
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-message
|
|
524
524
|
*
|
|
525
525
|
* @param messageText - Text of the message to send
|
|
526
526
|
* @param options - Options to send messages operation.
|
|
@@ -550,7 +550,7 @@ export declare class QueueClient extends StorageClient {
|
|
|
550
550
|
sendMessage(messageText: string, options?: QueueSendMessageOptions): Promise<QueueSendMessageResponse>;
|
|
551
551
|
/**
|
|
552
552
|
* receiveMessages retrieves one or more messages from the front of the queue.
|
|
553
|
-
* @see https://learn.microsoft.com/
|
|
553
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-messages
|
|
554
554
|
*
|
|
555
555
|
* @param options - Options to receive messages operation.
|
|
556
556
|
* @returns Response data for the receive messages operation.
|
|
@@ -586,7 +586,7 @@ export declare class QueueClient extends StorageClient {
|
|
|
586
586
|
receiveMessages(options?: QueueReceiveMessageOptions): Promise<QueueReceiveMessageResponse>;
|
|
587
587
|
/**
|
|
588
588
|
* peekMessages retrieves one or more messages from the front of the queue but does not alter the visibility of the message.
|
|
589
|
-
* @see https://learn.microsoft.com/
|
|
589
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/peek-messages
|
|
590
590
|
*
|
|
591
591
|
* @param options - Options to peek messages operation.
|
|
592
592
|
* @returns Response data for the peek messages operation.
|
|
@@ -612,7 +612,7 @@ export declare class QueueClient extends StorageClient {
|
|
|
612
612
|
peekMessages(options?: QueuePeekMessagesOptions): Promise<QueuePeekMessagesResponse>;
|
|
613
613
|
/**
|
|
614
614
|
* deleteMessage permanently removes the specified message from its queue.
|
|
615
|
-
* @see https://learn.microsoft.com/
|
|
615
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/delete-message2
|
|
616
616
|
*
|
|
617
617
|
* @param messageId - Id of the message.
|
|
618
618
|
* @param popReceipt - A valid pop receipt value returned from an earlier call to the receive messages or update message operation.
|
|
@@ -624,7 +624,7 @@ export declare class QueueClient extends StorageClient {
|
|
|
624
624
|
* Update changes a message's visibility timeout and contents.
|
|
625
625
|
* 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.
|
|
626
626
|
* To include markup in the message, the contents of the message must either be XML-escaped or Base64-encode.
|
|
627
|
-
* @see https://learn.microsoft.com/
|
|
627
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/update-message
|
|
628
628
|
*
|
|
629
629
|
* @param messageId - Id of the message
|
|
630
630
|
* @param popReceipt - A valid pop receipt value returned from an earlier call to the receive messages or update message operation.
|
|
@@ -645,7 +645,7 @@ export declare class QueueClient extends StorageClient {
|
|
|
645
645
|
* Generates a Service Shared Access Signature (SAS) URI based on the client properties
|
|
646
646
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
|
647
647
|
*
|
|
648
|
-
* @see https://learn.microsoft.com/
|
|
648
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
649
649
|
*
|
|
650
650
|
* @param options - Optional parameters.
|
|
651
651
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
@@ -657,7 +657,7 @@ export declare class QueueClient extends StorageClient {
|
|
|
657
657
|
* Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
|
|
658
658
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
|
659
659
|
*
|
|
660
|
-
* @see https://learn.microsoft.com/
|
|
660
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
661
661
|
*
|
|
662
662
|
* @param options - Optional parameters.
|
|
663
663
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"QueueClient.d.ts","sourceRoot":"","sources":["../../src/QueueClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGxD,OAAO,KAAK,EACV,eAAe,EACf,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,EACtB,mBAAmB,EACnB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACrB,iBAAiB,EAEjB,mBAAmB,EACnB,2BAA2B,EAC3B,0BAA0B,EAC1B,4BAA4B,EAC5B,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EAQpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE/D,OAAO,KAAK,EAAE,sBAAsB,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEtE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,aAAa,EAA2B,MAAM,oBAAoB,CAAC;AAC5E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAS5D,OAAO,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAK5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAG3D;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,aAAa;IAC9D;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,aAAa;IAChE;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,aAAa;IAChE;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC5D;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,YAAY,EAAE;QACZ;;WAEG;QACH,QAAQ,CAAC,EAAE,IAAI,CAAC;QAChB;;WAEG;QACH,SAAS,CAAC,EAAE,IAAI,CAAC;QACjB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,MAAM,4BAA4B,GAAG,YAAY,CAC7D;IACE,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;CACvC,GAAG,2BAA2B,EAC/B,2BAA2B,EAC3B,qBAAqB,EAAE,CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,aAAa;IAC9D;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED,2BAA2B;AAC3B,MAAM,WAAW,6BAA8B,SAAQ,aAAa;IAClE,
|
|
1
|
+
{"version":3,"file":"QueueClient.d.ts","sourceRoot":"","sources":["../../src/QueueClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGxD,OAAO,KAAK,EACV,eAAe,EACf,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,EACtB,mBAAmB,EACnB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACrB,iBAAiB,EAEjB,mBAAmB,EACnB,2BAA2B,EAC3B,0BAA0B,EAC1B,4BAA4B,EAC5B,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EAQpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE/D,OAAO,KAAK,EAAE,sBAAsB,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEtE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,aAAa,EAA2B,MAAM,oBAAoB,CAAC;AAC5E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAS5D,OAAO,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAK5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAG3D;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,aAAa;IAC9D;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,aAAa;IAChE;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,aAAa;IAChE;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC5D;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,YAAY,EAAE;QACZ;;WAEG;QACH,QAAQ,CAAC,EAAE,IAAI,CAAC;QAChB;;WAEG;QACH,SAAS,CAAC,EAAE,IAAI,CAAC;QACjB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,MAAM,4BAA4B,GAAG,YAAY,CAC7D;IACE,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;CACvC,GAAG,2BAA2B,EAC/B,2BAA2B,EAC3B,qBAAqB,EAAE,CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,aAAa;IAC9D;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED,2BAA2B;AAC3B,MAAM,WAAW,6BAA8B,SAAQ,aAAa;IAClE,mPAAmP;IACnP,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,8JAA8J;IAC9J,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4dAA4d;IAC5d,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,6WAA6W;IAC7W,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,6BAA6B,EAAE,aAAa;IAC3F;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED,2BAA2B;AAC3B,MAAM,WAAW,6BAA8B,SAAQ,aAAa;IAClE,mPAAmP;IACnP,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,8JAA8J;IAC9J,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wQAAwQ;IACxQ,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,oYAAoY;IACpY,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,6BAA6B,EAAE,aAAa;IAC9F;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED,2BAA2B;AAC3B,MAAM,WAAW,0BAA2B,SAAQ,aAAa;IAC/D,mPAAmP;IACnP,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,8JAA8J;IAC9J,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wQAAwQ;IACxQ,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,0BAA0B,EAAE,aAAa;IACzF;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG,YAAY,CACzD;IACE;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,UAAU,EAAE,IAAI,CAAC;IACjB;;;OAGG;IACH,SAAS,EAAE,IAAI,CAAC;IAChB;;;OAGG;IACH,aAAa,EAAE,IAAI,CAAC;CACrB,GAAG,sBAAsB,EAC1B,sBAAsB,EACtB,eAAe,EAAE,CAClB,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,MAAM,mBAAmB,GAAG,mBAAmB,CAAC;AAE9D;;GAEG;AACH,MAAM,CAAC,OAAO,MAAM,2BAA2B,GAAG,YAAY,CAC5D;IACE,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;CAC7C,GAAG,sBAAsB,EAC1B,sBAAsB,EACtB,mBAAmB,EAAE,CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,MAAM,yBAAyB,GAAG,YAAY,CAC1D;IACE,kBAAkB,EAAE,iBAAiB,EAAE,CAAC;CACzC,GAAG,mBAAmB,EACvB,mBAAmB,EACnB,iBAAiB,EAAE,CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,aAAa;IAC9D;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,MAAM,0BAA0B,GAAG,uBAAuB,CAAC;AAEzE;;GAEG;AACH,MAAM,CAAC,OAAO,MAAM,0BAA0B,GAAG,uBAAuB,CAAC;AAEzE;;GAEG;AACH,MAAM,CAAC,OAAO,MAAM,0BAA0B,GAAG,qBAAqB,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,aAAa;IAC9D;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,mBAAmB;IACzE;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB;IACtE;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;;OAGG;IACH,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAC;IAErB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,aAAa;IAC5C;;OAEG;IACH,OAAO,CAAC,eAAe,CAAW;IAClC;;OAEG;IACH,OAAO,CAAC,YAAY,CAAQ;IAC5B,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,YAAY,CAAS;IAE7B;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;;;;;;;;;OAWG;gBAGS,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB;IACzF;;;;;;;;;OASG;gBAED,GAAG,EAAE,MAAM,EACX,UAAU,CAAC,EAAE,0BAA0B,GAAG,mBAAmB,GAAG,eAAe,EAG/E,OAAO,CAAC,EAAE,sBAAsB;IAElC;;;;;;;;;OASG;gBACS,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ;IAqF3C,OAAO,CAAC,mBAAmB;IAU3B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,MAAM,CAAC,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAQnF;;;;;;OAMG;IACU,iBAAiB,CAC5B,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,8BAA8B,CAAC;IAoC1C;;;;;OAKG;IACU,cAAc,CACzB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,2BAA2B,CAAC;IAqBvC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,MAAM,CAAC,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAWnF;;;;;;;;OAQG;IACU,MAAM,CAAC,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,OAAO,CAAC;IAcvE;;;;;;;;;;;;OAYG;IACU,aAAa,CACxB,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,0BAA0B,CAAC;IAQtC;;;;;;;;;;OAUG;IACU,WAAW,CACtB,QAAQ,CAAC,EAAE,QAAQ,EACnB,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,wBAAwB,CAAC;IAWpC;;;;;;;;;;OAUG;IACU,eAAe,CAC1B,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,4BAA4B,CAAC;IAqDxC;;;;;;;OAOG;IACU,eAAe,CAC1B,QAAQ,CAAC,EAAE,gBAAgB,EAAE,EAC7B,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,4BAA4B,CAAC;IA+BxC;;;;;;OAMG;IACU,aAAa,CACxB,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,0BAA0B,CAAC;IAQtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACU,WAAW,CACtB,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,wBAAwB,CAAC;IA+BpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACU,eAAe,CAC1B,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC,2BAA2B,CAAC;IA8BvC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,YAAY,CACvB,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,yBAAyB,CAAC;IA0BrC;;;;;;;;OAQG;IACU,aAAa,CACxB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,0BAA0B,CAAC;IAQtC;;;;;;;;;;;;;;;;OAgBG;IACU,aAAa,CACxB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,MAAM,EAChB,iBAAiB,CAAC,EAAE,MAAM,EAC1B,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,0BAA0B,CAAC;IAgBtC,OAAO,CAAC,mBAAmB;IAoC3B;;;;;;;;;;OAUG;IACI,cAAc,CAAC,OAAO,EAAE,0BAA0B,GAAG,MAAM;IAkBlE;;;;;;;;;;OAUG;IAEI,uBAAuB,CAAC,OAAO,EAAE,0BAA0B,GAAG,MAAM;CAe5E"}
|
|
@@ -97,7 +97,7 @@ export class QueueClient extends StorageClient {
|
|
|
97
97
|
}
|
|
98
98
|
/**
|
|
99
99
|
* Creates a new queue under the specified account.
|
|
100
|
-
* @see https://learn.microsoft.com/
|
|
100
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/create-queue4
|
|
101
101
|
*
|
|
102
102
|
* @param options - Options to Queue create operation.
|
|
103
103
|
* @returns Response data for the Queue create operation.
|
|
@@ -130,7 +130,7 @@ export class QueueClient extends StorageClient {
|
|
|
130
130
|
/**
|
|
131
131
|
* Creates a new queue under the specified account if it doesn't already exist.
|
|
132
132
|
* If the queue already exists, it is not changed.
|
|
133
|
-
* @see https://learn.microsoft.com/
|
|
133
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/create-queue4
|
|
134
134
|
*
|
|
135
135
|
* @param options -
|
|
136
136
|
*/
|
|
@@ -157,7 +157,7 @@ export class QueueClient extends StorageClient {
|
|
|
157
157
|
}
|
|
158
158
|
/**
|
|
159
159
|
* Deletes the specified queue permanently if it exists.
|
|
160
|
-
* @see https://learn.microsoft.com/
|
|
160
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/delete-queue3
|
|
161
161
|
*
|
|
162
162
|
* @param options -
|
|
163
163
|
*/
|
|
@@ -178,7 +178,7 @@ export class QueueClient extends StorageClient {
|
|
|
178
178
|
}
|
|
179
179
|
/**
|
|
180
180
|
* Deletes the specified queue permanently.
|
|
181
|
-
* @see https://learn.microsoft.com/
|
|
181
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/delete-queue3
|
|
182
182
|
*
|
|
183
183
|
* @param options - Options to Queue delete operation.
|
|
184
184
|
* @returns Response data for the Queue delete operation.
|
|
@@ -237,7 +237,7 @@ export class QueueClient extends StorageClient {
|
|
|
237
237
|
/**
|
|
238
238
|
* Gets all user-defined metadata and system properties for the specified
|
|
239
239
|
* queue. Metadata is associated with the queue as name-values pairs.
|
|
240
|
-
* @see https://learn.microsoft.com/
|
|
240
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-queue-metadata
|
|
241
241
|
*
|
|
242
242
|
* WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
|
|
243
243
|
* they originally contained uppercase characters. This differs from the metadata keys returned by
|
|
@@ -257,7 +257,7 @@ export class QueueClient extends StorageClient {
|
|
|
257
257
|
*
|
|
258
258
|
* If no option provided, or no metadata defined in the option parameter, the queue
|
|
259
259
|
* metadata will be removed.
|
|
260
|
-
* @see https://learn.microsoft.com/
|
|
260
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/set-queue-metadata
|
|
261
261
|
*
|
|
262
262
|
* @param metadata - If no metadata provided, all existing metadata will be removed.
|
|
263
263
|
* @param options - Options to Queue set metadata operation.
|
|
@@ -274,7 +274,7 @@ export class QueueClient extends StorageClient {
|
|
|
274
274
|
* WARNING: JavaScript Date will potential lost precision when parsing start and expiry string.
|
|
275
275
|
* For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
|
|
276
276
|
*
|
|
277
|
-
* @see https://learn.microsoft.com/
|
|
277
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-queue-acl
|
|
278
278
|
*
|
|
279
279
|
* @param options - Options to Queue get access policy operation.
|
|
280
280
|
* @returns Response data for the Queue get access policy operation.
|
|
@@ -317,7 +317,7 @@ export class QueueClient extends StorageClient {
|
|
|
317
317
|
}
|
|
318
318
|
/**
|
|
319
319
|
* Sets stored access policies for the queue that may be used with Shared Access Signatures.
|
|
320
|
-
* @see https://learn.microsoft.com/
|
|
320
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/set-queue-acl
|
|
321
321
|
*
|
|
322
322
|
* @param queueAcl -
|
|
323
323
|
* @param options - Options to Queue set access policy operation.
|
|
@@ -345,7 +345,7 @@ export class QueueClient extends StorageClient {
|
|
|
345
345
|
}
|
|
346
346
|
/**
|
|
347
347
|
* Clear deletes all messages from a queue.
|
|
348
|
-
* @see https://learn.microsoft.com/
|
|
348
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/clear-messages
|
|
349
349
|
*
|
|
350
350
|
* @param options - Options to clear messages operation.
|
|
351
351
|
* @returns Response data for the clear messages operation.
|
|
@@ -360,7 +360,7 @@ export class QueueClient extends StorageClient {
|
|
|
360
360
|
* the message should be invisible to Dequeue and Peek operations.
|
|
361
361
|
* 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.
|
|
362
362
|
* To include markup in the message, the contents of the message must either be XML-escaped or Base64-encode.
|
|
363
|
-
* @see https://learn.microsoft.com/
|
|
363
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/put-message
|
|
364
364
|
*
|
|
365
365
|
* @param messageText - Text of the message to send
|
|
366
366
|
* @param options - Options to send messages operation.
|
|
@@ -410,7 +410,7 @@ export class QueueClient extends StorageClient {
|
|
|
410
410
|
}
|
|
411
411
|
/**
|
|
412
412
|
* receiveMessages retrieves one or more messages from the front of the queue.
|
|
413
|
-
* @see https://learn.microsoft.com/
|
|
413
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-messages
|
|
414
414
|
*
|
|
415
415
|
* @param options - Options to receive messages operation.
|
|
416
416
|
* @returns Response data for the receive messages operation.
|
|
@@ -463,7 +463,7 @@ export class QueueClient extends StorageClient {
|
|
|
463
463
|
}
|
|
464
464
|
/**
|
|
465
465
|
* peekMessages retrieves one or more messages from the front of the queue but does not alter the visibility of the message.
|
|
466
|
-
* @see https://learn.microsoft.com/
|
|
466
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/peek-messages
|
|
467
467
|
*
|
|
468
468
|
* @param options - Options to peek messages operation.
|
|
469
469
|
* @returns Response data for the peek messages operation.
|
|
@@ -506,7 +506,7 @@ export class QueueClient extends StorageClient {
|
|
|
506
506
|
}
|
|
507
507
|
/**
|
|
508
508
|
* deleteMessage permanently removes the specified message from its queue.
|
|
509
|
-
* @see https://learn.microsoft.com/
|
|
509
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/delete-message2
|
|
510
510
|
*
|
|
511
511
|
* @param messageId - Id of the message.
|
|
512
512
|
* @param popReceipt - A valid pop receipt value returned from an earlier call to the receive messages or update message operation.
|
|
@@ -522,7 +522,7 @@ export class QueueClient extends StorageClient {
|
|
|
522
522
|
* Update changes a message's visibility timeout and contents.
|
|
523
523
|
* 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.
|
|
524
524
|
* To include markup in the message, the contents of the message must either be XML-escaped or Base64-encode.
|
|
525
|
-
* @see https://learn.microsoft.com/
|
|
525
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/update-message
|
|
526
526
|
*
|
|
527
527
|
* @param messageId - Id of the message
|
|
528
528
|
* @param popReceipt - A valid pop receipt value returned from an earlier call to the receive messages or update message operation.
|
|
@@ -588,7 +588,7 @@ export class QueueClient extends StorageClient {
|
|
|
588
588
|
* Generates a Service Shared Access Signature (SAS) URI based on the client properties
|
|
589
589
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
|
590
590
|
*
|
|
591
|
-
* @see https://learn.microsoft.com/
|
|
591
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
592
592
|
*
|
|
593
593
|
* @param options - Optional parameters.
|
|
594
594
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
@@ -606,7 +606,7 @@ export class QueueClient extends StorageClient {
|
|
|
606
606
|
* Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
|
|
607
607
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
|
608
608
|
*
|
|
609
|
-
* @see https://learn.microsoft.com/
|
|
609
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
610
610
|
*
|
|
611
611
|
* @param options - Optional parameters.
|
|
612
612
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|