@azure/storage-queue 12.26.0 → 12.27.0-beta.1

package/dist/commonjs/QueueServiceClient.js

@@ -0,0 +1,443 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueueServiceClient = void 0;
+const tslib_1 = require("tslib");
+const core_auth_1 = require("@azure/core-auth");
+const core_util_1 = require("@azure/core-util");
+const Pipeline_js_1 = require("./Pipeline.js");
+const StorageClient_js_1 = require("./StorageClient.js");
+const utils_common_js_1 = require("./utils/utils.common.js");
+const storage_blob_1 = require("@azure/storage-blob");
+const storage_blob_2 = require("@azure/storage-blob");
+const tracing_js_1 = require("./utils/tracing.js");
+const QueueClient_js_1 = require("./QueueClient.js");
+const AccountSASPermissions_js_1 = require("./AccountSASPermissions.js");
+const AccountSASSignatureValues_js_1 = require("./AccountSASSignatureValues.js");
+const AccountSASServices_js_1 = require("./AccountSASServices.js");
+const core_rest_pipeline_1 = require("@azure/core-rest-pipeline");
+/**
+ * A QueueServiceClient represents a URL to the Azure Storage Queue service allowing you
+ * to manipulate queues.
+ */
+class QueueServiceClient extends StorageClient_js_1.StorageClient {
+    /**
+     * Creates an instance of QueueServiceClient.
+     *
+     * @param connectionString - Account connection string or a SAS connection string of an Azure storage account.
+     *                                  [ Note - Account connection string can only be used in NODE.JS runtime. ]
+     *                                  Account connection string example -
+     *                                  `DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`
+     *                                  SAS connection string example -
+     *                                  `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString`
+     * @param options - Options to configure the HTTP pipeline.
+     * @returns A new QueueServiceClient object from the given connection string.
+     */
+    static fromConnectionString(connectionString, 
+    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */
+    options) {
+        options = options || {};
+        const extractedCreds = (0, utils_common_js_1.extractConnectionStringParts)(connectionString);
+        if (extractedCreds.kind === "AccountConnString") {
+            if (core_util_1.isNodeLike) {
+                const sharedKeyCredential = new storage_blob_1.StorageSharedKeyCredential(extractedCreds.accountName, extractedCreds.accountKey);
+                if (!options.proxyOptions) {
+                    options.proxyOptions = (0, core_rest_pipeline_1.getDefaultProxySettings)(extractedCreds.proxyUri);
+                }
+                const pipeline = (0, Pipeline_js_1.newPipeline)(sharedKeyCredential, options);
+                return new QueueServiceClient(extractedCreds.url, pipeline);
+            }
+            else {
+                throw new Error("Account connection string is only supported in Node.js environment");
+            }
+        }
+        else if (extractedCreds.kind === "SASConnString") {
+            const pipeline = (0, Pipeline_js_1.newPipeline)(new storage_blob_2.AnonymousCredential(), options);
+            return new QueueServiceClient(extractedCreds.url + "?" + extractedCreds.accountSas, pipeline);
+        }
+        else {
+            throw new Error("Connection string must be either an Account connection string or a SAS connection string");
+        }
+    }
+    constructor(url, credentialOrPipeline, 
+    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.
+    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */
+    options) {
+        let pipeline;
+        if ((0, Pipeline_js_1.isPipelineLike)(credentialOrPipeline)) {
+            pipeline = credentialOrPipeline;
+        }
+        else if ((core_util_1.isNodeLike && credentialOrPipeline instanceof storage_blob_1.StorageSharedKeyCredential) ||
+            credentialOrPipeline instanceof storage_blob_2.AnonymousCredential ||
+            (0, core_auth_1.isTokenCredential)(credentialOrPipeline)) {
+            pipeline = (0, Pipeline_js_1.newPipeline)(credentialOrPipeline, options);
+        }
+        else {
+            // The second parameter is undefined. Use anonymous credential.
+            pipeline = (0, Pipeline_js_1.newPipeline)(new storage_blob_2.AnonymousCredential(), options);
+        }
+        super(url, pipeline);
+        this.serviceContext = this.storageClientContext.service;
+    }
+    /**
+     * Creates a {@link QueueClient} object.
+     *
+     * @param queueName -
+     * @returns a new QueueClient
+     *
+     * Example usage:
+     *
+     * ```ts snippet:ReadmeSampleCreateQueue
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * const queueName = "<valid queue name>";
+     * const queueClient = queueServiceClient.getQueueClient(queueName);
+     * const createQueueResponse = await queueClient.create();
+     * console.log(
+     *   `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`,
+     * );
+     * ```
+     */
+    getQueueClient(queueName) {
+        return new QueueClient_js_1.QueueClient((0, utils_common_js_1.appendToURLPath)(this.url, queueName), this.pipeline);
+    }
+    /**
+     * Returns a list of the queues under the specified account.
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-queues1
+     *
+     * @param marker - A string value that identifies the portion of
+     *                        the list of queues to be returned with the next listing operation. The
+     *                        operation returns the continuationToken value within the response body if the
+     *                        listing operation did not return all queues remaining to be listed
+     *                        with the current page. The continuationToken value can be used as the value for
+     *                        the marker parameter in a subsequent call to request the next page of list
+     *                        items. The marker value is opaque to the client.
+     * @param options - Options to list queues operation.
+     * @returns Response data for the list queues segment operation.
+     */
+    async listQueuesSegment(marker, options = {}) {
+        if (options.prefix === "") {
+            options.prefix = undefined;
+        }
+        return tracing_js_1.tracingClient.withSpan("QueueServiceClient-listQueuesSegment", options, async (updatedOptions) => {
+            return (0, utils_common_js_1.assertResponse)(await this.serviceContext.listQueuesSegment(Object.assign(Object.assign({}, updatedOptions), { marker, include: options.include === undefined ? undefined : [options.include] })));
+        });
+    }
+    /**
+     * Returns an AsyncIterableIterator for {@link ServiceListQueuesSegmentResponse} objects
+     *
+     * @param marker - A string value that identifies the portion of
+     *                        the list of queues to be returned with the next listing operation. The
+     *                        operation returns the continuationToken value within the response body if the
+     *                        listing operation did not return all queues remaining to be listed
+     *                        with the current page. The continuationToken value can be used as the value for
+     *                        the marker parameter in a subsequent call to request the next page of list
+     *                        items. The marker value is opaque to the client.
+     * @param options - Options to list queues operation.
+     */
+    listSegments(marker_1) {
+        return tslib_1.__asyncGenerator(this, arguments, function* listSegments_1(marker, options = {}) {
+            if (options.prefix === "") {
+                options.prefix = undefined;
+            }
+            let listQueuesResponse;
+            do {
+                listQueuesResponse = yield tslib_1.__await(this.listQueuesSegment(marker, options));
+                marker = listQueuesResponse.continuationToken;
+                yield yield tslib_1.__await(yield tslib_1.__await(listQueuesResponse));
+            } while (marker);
+        });
+    }
+    /**
+     * Returns an AsyncIterableIterator for {@link QueueItem} objects
+     *
+     * @param options - Options to list queues operation.
+     */
+    listItems() {
+        return tslib_1.__asyncGenerator(this, arguments, function* listItems_1(options = {}) {
+            var _a, e_1, _b, _c;
+            if (options.prefix === "") {
+                options.prefix = undefined;
+            }
+            let marker;
+            try {
+                for (var _d = true, _e = tslib_1.__asyncValues(this.listSegments(marker, options)), _f; _f = yield tslib_1.__await(_e.next()), _a = _f.done, !_a; _d = true) {
+                    _c = _f.value;
+                    _d = false;
+                    const segment = _c;
+                    if (segment.queueItems) {
+                        yield tslib_1.__await(yield* tslib_1.__asyncDelegator(tslib_1.__asyncValues(segment.queueItems)));
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_d && !_a && (_b = _e.return)) yield tslib_1.__await(_b.call(_e));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        });
+    }
+    /**
+     * Returns an async iterable iterator to list all the queues
+     * under the specified account.
+     *
+     * .byPage() returns an async iterable iterator to list the queues in pages.
+     *
+     * Example using `for await` syntax:
+     *
+     * ```ts snippet:ReadmeSampleListQueues
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * let i = 1;
+     * for await (const item of queueServiceClient.listQueues()) {
+     *   console.log(`Queue${i++}: ${item.name}`);
+     * }
+     * ```
+     *
+     * Example using `iter.next()`:
+     *
+     * ```ts snippet:ReadmeSampleListQueues_Iterator
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * let i = 1;
+     * const iterator = queueServiceClient.listQueues();
+     * let { done, value } = await iterator.next();
+     * while (!done) {
+     *   console.log(`Queue${i++}: ${value.name}`);
+     *   ({ done, value } = await iterator.next());
+     * }
+     * ```
+     *
+     * Example using `byPage()`:
+     *
+     * ```ts snippet:ReadmeSampleListQueues_ByPage
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * let i = 1;
+     * for await (const page of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
+     *   for (const item of page.queueItems || []) {
+     *     console.log(`Queue${i++}: ${item.name}`);
+     *   }
+     * }
+     * ```
+     *
+     * Example using paging with a marker:
+     *
+     * ```ts snippet:ReadmeSampleListQueues_Continuation
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * let i = 1;
+     * let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });
+     * let response = (await iterator.next()).value;
+     * // Prints 2 queues
+     * if (response.queueItems) {
+     *   for (const item of response.queueItems) {
+     *     console.log(`Queue${i++}: ${item.name}`);
+     *   }
+     * }
+     * // Gets next marker
+     * let marker = response.continuationToken;
+     * // Passing next marker as continuationToken
+     * iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });
+     * response = (await iterator.next()).value;
+     * // Prints 10 queues
+     * if (response.queueItems) {
+     *   for (const item of response.queueItems) {
+     *     console.log(`Queue${i++}: ${item.name}`);
+     *   }
+     * }
+     * ```
+     *
+     * @param options - Options to list queues operation.
+     * @returns An asyncIterableIterator that supports paging.
+     */
+    listQueues(options = {}) {
+        if (options.prefix === "") {
+            options.prefix = undefined;
+        }
+        const updatedOptions = Object.assign(Object.assign({}, options), (options.includeMetadata ? { include: "metadata" } : {}));
+        // AsyncIterableIterator to iterate over queues
+        const iter = this.listItems(updatedOptions);
+        return {
+            /**
+             * The next method, part of the iteration protocol
+             */
+            next() {
+                return iter.next();
+            },
+            /**
+             * The connection to the async iterator, part of the iteration protocol
+             */
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            /**
+             * Return an AsyncIterableIterator that works a page at a time
+             */
+            byPage: (settings = {}) => {
+                return this.listSegments(settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, updatedOptions));
+            },
+        };
+    }
+    /**
+     * Gets the properties of a storage account’s Queue service, including properties
+     * for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties
+     *
+     * @param options - Options to get properties operation.
+     * @returns Response data including the queue service properties.
+     */
+    async getProperties(options = {}) {
+        return tracing_js_1.tracingClient.withSpan("QueueServiceClient-getProperties", options, async (updatedOptions) => {
+            return (0, utils_common_js_1.assertResponse)(await this.serviceContext.getProperties(updatedOptions));
+        });
+    }
+    /**
+     * Sets properties for a storage account’s Queue service endpoint, including properties
+     * for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties
+     *
+     * @param properties -
+     * @param options - Options to set properties operation.
+     * @returns Response data for the Set Properties operation.
+     */
+    async setProperties(properties, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("QueueServiceClient-setProperties", options, async (updatedOptions) => {
+            return (0, utils_common_js_1.assertResponse)(await this.serviceContext.setProperties(properties, updatedOptions));
+        });
+    }
+    /**
+     * Retrieves statistics related to replication for the Queue service. It is only
+     * available on the secondary location endpoint when read-access geo-redundant
+     * replication is enabled for the storage account.
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats
+     *
+     * @param options - Options to get statistics operation.
+     * @returns Response data for get statistics the operation.
+     */
+    async getStatistics(options = {}) {
+        return tracing_js_1.tracingClient.withSpan("QueueServiceClient-getStatistics", options, async (updatedOptions) => {
+            return (0, utils_common_js_1.assertResponse)(await this.serviceContext.getStatistics(updatedOptions));
+        });
+    }
+    /**
+     * Creates a new queue under the specified account.
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-queue4
+     *
+     * @param queueName - name of the queue to create
+     * @param options - Options to Queue create operation.
+     * @returns Response data for the Queue create operation.
+     */
+    async createQueue(queueName, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("QueueServiceClient-createQueue", options, async (updatedOptions) => {
+            return this.getQueueClient(queueName).create(updatedOptions);
+        });
+    }
+    /**
+     * Deletes the specified queue permanently.
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-queue3
+     *
+     * @param queueName - name of the queue to delete.
+     * @param options - Options to Queue delete operation.
+     * @returns Response data for the Queue delete operation.
+     */
+    async deleteQueue(queueName, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("QueueServiceClient-deleteQueue", options, async (updatedOptions) => {
+            return this.getQueueClient(queueName).delete(updatedOptions);
+        });
+    }
+    /**
+     * Only available for QueueServiceClient constructed with a shared key credential.
+     *
+     * Generates an account Shared Access Signature (SAS) URI based on the client properties
+     * and parameters passed in. The SAS is signed by the shared key credential of the client.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
+     *
+     * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.
+     * @param permissions - Specifies the list of permissions to be associated with the SAS.
+     * @param resourceTypes - Specifies the resource types associated with the shared access signature.
+     * @param options - Optional parameters.
+     * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
+     */
+    generateAccountSasUrl(expiresOn, permissions = AccountSASPermissions_js_1.AccountSASPermissions.parse("r"), resourceTypes = "sco", options = {}) {
+        if (!(this.credential instanceof storage_blob_1.StorageSharedKeyCredential)) {
+            throw RangeError("Can only generate the account SAS when the client is initialized with a shared key credential");
+        }
+        if (expiresOn === undefined) {
+            const now = new Date();
+            expiresOn = new Date(now.getTime() + 3600 * 1000);
+        }
+        const sas = (0, AccountSASSignatureValues_js_1.generateAccountSASQueryParameters)(Object.assign({ permissions,
+            expiresOn,
+            resourceTypes, services: AccountSASServices_js_1.AccountSASServices.parse("q").toString() }, options), this.credential).toString();
+        return (0, utils_common_js_1.appendToURLQuery)(this.url, sas);
+    }
+    /**
+     * Only available for QueueServiceClient constructed with a shared key credential.
+     *
+     * Generates string to sign for an account Shared Access Signature (SAS) URI based on the client properties
+     * and parameters passed in. The SAS is signed by the shared key credential of the client.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
+     *
+     * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.
+     * @param permissions - Specifies the list of permissions to be associated with the SAS.
+     * @param resourceTypes - Specifies the resource types associated with the shared access signature.
+     * @param options - Optional parameters.
+     * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
+     */
+    generateSasStringToSign(expiresOn, permissions = AccountSASPermissions_js_1.AccountSASPermissions.parse("r"), resourceTypes = "sco", options = {}) {
+        if (!(this.credential instanceof storage_blob_1.StorageSharedKeyCredential)) {
+            throw RangeError("Can only generate the account SAS when the client is initialized with a shared key credential");
+        }
+        if (expiresOn === undefined) {
+            const now = new Date();
+            expiresOn = new Date(now.getTime() + 3600 * 1000);
+        }
+        return (0, AccountSASSignatureValues_js_1.generateAccountSASQueryParametersInternal)(Object.assign({ permissions,
+            expiresOn,
+            resourceTypes, services: AccountSASServices_js_1.AccountSASServices.parse("q").toString() }, options), this.credential).stringToSign;
+    }
+}
+exports.QueueServiceClient = QueueServiceClient;
+//# sourceMappingURL=QueueServiceClient.js.map

package/dist/commonjs/QueueServiceClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueueServiceClient.js","sourceRoot":"","sources":["../../src/QueueServiceClient.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAGlC,gDAAqD;AACrD,gDAA8C;AAoB9C,+CAA4D;AAE5D,yDAAmD;AAEnD,6DAKiC;AACjC,sDAAiE;AACjE,sDAA0D;AAC1D,mDAAmD;AAEnD,qDAA+C;AAC/C,yEAAmE;AACnE,iFAGwC;AACxC,mEAA6D;AAG7D,kEAAoE;AAsHpE;;;GAGG;AACH,MAAa,kBAAmB,SAAQ,gCAAa;IACnD;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,oBAAoB,CAChC,gBAAwB;IACxB,2FAA2F;IAC3F,iEAAiE;IACjE,OAAgC;QAEhC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,MAAM,cAAc,GAAG,IAAA,8CAA4B,EAAC,gBAAgB,CAAC,CAAC;QACtE,IAAI,cAAc,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;YAChD,IAAI,sBAAU,EAAE,CAAC;gBACf,MAAM,mBAAmB,GAAG,IAAI,yCAA0B,CACxD,cAAc,CAAC,WAAY,EAC3B,cAAc,CAAC,UAAU,CAC1B,CAAC;gBACF,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;oBAC1B,OAAO,CAAC,YAAY,GAAG,IAAA,4CAAuB,EAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;gBAC1E,CAAC;gBACD,MAAM,QAAQ,GAAG,IAAA,yBAAW,EAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;gBAC3D,OAAO,IAAI,kBAAkB,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YAC9D,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;YACxF,CAAC;QACH,CAAC;aAAM,IAAI,cAAc,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;YACnD,MAAM,QAAQ,GAAG,IAAA,yBAAW,EAAC,IAAI,kCAAmB,EAAE,EAAE,OAAO,CAAC,CAAC;YACjE,OAAO,IAAI,kBAAkB,CAAC,cAAc,CAAC,GAAG,GAAG,GAAG,GAAG,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAChG,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CACb,0FAA0F,CAC3F,CAAC;QACJ,CAAC;IACH,CAAC;IAyED,YACE,GAAW,EACX,oBAIY;IACZ,2FAA2F;IAC3F,iEAAiE;IACjE,OAAgC;QAEhC,IAAI,QAAkB,CAAC;QACvB,IAAI,IAAA,4BAAc,EAAC,oBAAoB,CAAC,EAAE,CAAC;YACzC,QAAQ,GAAG,oBAAoB,CAAC;QAClC,CAAC;aAAM,IACL,CAAC,sBAAU,IAAI,oBAAoB,YAAY,yCAA0B,CAAC;YAC1E,oBAAoB,YAAY,kCAAmB;YACnD,IAAA,6BAAiB,EAAC,oBAAoB,CAAC,EACvC,CAAC;YACD,QAAQ,GAAG,IAAA,yBAAW,EAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,+DAA+D;YAC/D,QAAQ,GAAG,IAAA,yBAAW,EAAC,IAAI,kCAAmB,EAAE,EAAE,OAAO,CAAC,CAAC;QAC7D,CAAC;QACD,KAAK,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,cAAc,CAAC,SAAiB;QACrC,OAAO,IAAI,4BAAW,CAAC,IAAA,iCAAe,EAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACK,KAAK,CAAC,iBAAiB,CAC7B,MAAe,EACf,UAA2C,EAAE;QAE7C,IAAI,OAAO,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAC1B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;QAC7B,CAAC;QAED,OAAO,0BAAa,CAAC,QAAQ,CAC3B,sCAAsC,EACtC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,OAAO,IAAA,gCAAc,EAKnB,MAAM,IAAI,CAAC,cAAc,CAAC,iBAAiB,iCACtC,cAAc,KACjB,MAAM,EACN,OAAO,EAAE,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IACtE,CACH,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACY,YAAY;kFACzB,MAAe,EACf,UAA2C,EAAE;YAE7C,IAAI,OAAO,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;gBAC1B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;YAC7B,CAAC;YAED,IAAI,kBAAkB,CAAC;YACvB,GAAG,CAAC;gBACF,kBAAkB,GAAG,sBAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA,CAAC;gBACnE,MAAM,GAAG,kBAAkB,CAAC,iBAAiB,CAAC;gBAC9C,4BAAM,sBAAM,kBAAkB,CAAA,CAAA,CAAC;YACjC,CAAC,QAAQ,MAAM,EAAE;QACnB,CAAC;KAAA;IAED;;;;OAIG;IACY,SAAS;+EACtB,UAA2C,EAAE;;YAE7C,IAAI,OAAO,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;gBAC1B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;YAC7B,CAAC;YAED,IAAI,MAA0B,CAAC;;gBAC/B,KAA4B,eAAA,KAAA,sBAAA,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA,IAAA,uEAAE,CAAC;oBAArC,cAAkC;oBAAlC,WAAkC;oBAAnD,MAAM,OAAO,KAAA,CAAA;oBACtB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;wBACvB,sBAAA,KAAK,CAAC,CAAC,yBAAA,sBAAA,OAAO,CAAC,UAAU,CAAA,CAAA,CAAA,CAAC;oBAC5B,CAAC;gBACH,CAAC;;;;;;;;;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqGG;IACI,UAAU,CACf,UAAoC,EAAE;QAEtC,IAAI,OAAO,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAC1B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;QAC7B,CAAC;QAED,MAAM,cAAc,mCACf,OAAO,GACP,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAC5D,CAAC;QAEF,+CAA+C;QAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QAC5C,OAAO;YACL;;eAEG;YACH,IAAI;gBACF,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;YACrB,CAAC;YACD;;eAEG;YACH,CAAC,MAAM,CAAC,aAAa,CAAC;gBACpB,OAAO,IAAI,CAAC;YACd,CAAC;YACD;;eAEG;YACH,MAAM,EAAE,CAAC,WAAyB,EAAE,EAAE,EAAE;gBACtC,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,iBAAiB,kBACjD,WAAW,EAAE,QAAQ,CAAC,WAAW,IAC9B,cAAc,EACjB,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,aAAa,CACxB,UAAuC,EAAE;QAEzC,OAAO,0BAAa,CAAC,QAAQ,CAC3B,kCAAkC,EAClC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,OAAO,IAAA,gCAAc,EAInB,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC;QAC7D,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,aAAa,CACxB,UAAkC,EAClC,UAAuC,EAAE;QAEzC,OAAO,0BAAa,CAAC,QAAQ,CAC3B,kCAAkC,EAClC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,OAAO,IAAA,gCAAc,EACnB,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,UAAU,EAAE,cAAc,CAAC,CACpE,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,aAAa,CACxB,UAAuC,EAAE;QAEzC,OAAO,0BAAa,CAAC,QAAQ,CAC3B,kCAAkC,EAClC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,OAAO,IAAA,gCAAc,EAInB,MAAM,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC;QAC7D,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,WAAW,CACtB,SAAiB,EACjB,UAA8B,EAAE;QAEhC,OAAO,0BAAa,CAAC,QAAQ,CAC3B,gCAAgC,EAChC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,OAAO,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAC/D,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,WAAW,CACtB,SAAiB,EACjB,UAA8B,EAAE;QAEhC,OAAO,0BAAa,CAAC,QAAQ,CAC3B,gCAAgC,EAChC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,OAAO,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAC/D,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,qBAAqB,CAC1B,SAAgB,EAChB,cAAqC,gDAAqB,CAAC,KAAK,CAAC,GAAG,CAAC,EACrE,gBAAwB,KAAK,EAC7B,UAA+C,EAAE;QAEjD,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,YAAY,yCAA0B,CAAC,EAAE,CAAC;YAC7D,MAAM,UAAU,CACd,+FAA+F,CAChG,CAAC;QACJ,CAAC;QAED,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,SAAS,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,GAAG,GAAG,IAAA,gEAAiC,kBAEzC,WAAW;YACX,SAAS;YACT,aAAa,EACb,QAAQ,EAAE,0CAAkB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,IAC/C,OAAO,GAEZ,IAAI,CAAC,UAAU,CAChB,CAAC,QAAQ,EAAE,CAAC;QAEb,OAAO,IAAA,kCAAgB,EAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,uBAAuB,CAC5B,SAAgB,EAChB,cAAqC,gDAAqB,CAAC,KAAK,CAAC,GAAG,CAAC,EACrE,gBAAwB,KAAK,EAC7B,UAA+C,EAAE;QAEjD,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,YAAY,yCAA0B,CAAC,EAAE,CAAC;YAC7D,MAAM,UAAU,CACd,+FAA+F,CAChG,CAAC;QACJ,CAAC;QAED,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,SAAS,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;QACpD,CAAC;QAED,OAAO,IAAA,wEAAyC,kBAE5C,WAAW;YACX,SAAS;YACT,aAAa,EACb,QAAQ,EAAE,0CAAkB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,IAC/C,OAAO,GAEZ,IAAI,CAAC,UAAU,CAChB,CAAC,YAAY,CAAC;IACjB,CAAC;CACF;AA9lBD,gDA8lBC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { TokenCredential } from \"@azure/core-auth\";\nimport { isTokenCredential } from \"@azure/core-auth\";\nimport { isNodeLike } from \"@azure/core-util\";\nimport type {\n  QueueCreateResponse,\n  QueueDeleteResponse,\n  QueueItem,\n  QueueServiceProperties,\n  ServiceGetPropertiesResponse,\n  ServiceGetPropertiesHeaders,\n  ServiceGetStatisticsResponse,\n  ServiceListQueuesSegmentResponse,\n  ServiceSetPropertiesResponse,\n  ServiceListQueuesSegmentHeaders,\n  ListQueuesSegmentResponse,\n  ServiceSetPropertiesHeaders,\n  ServiceGetStatisticsHeaders,\n  QueueServiceStatistics,\n} from \"./generatedModels.js\";\nimport type { AbortSignalLike } from \"@azure/abort-controller\";\nimport type { Service } from \"./generated/src/operationsInterfaces/index.js\";\nimport type { StoragePipelineOptions, Pipeline } from \"./Pipeline.js\";\nimport { newPipeline, isPipelineLike } from \"./Pipeline.js\";\nimport type { CommonOptions } from \"./StorageClient.js\";\nimport { StorageClient } from \"./StorageClient.js\";\nimport type { PageSettings, PagedAsyncIterableIterator } from \"@azure/core-paging\";\nimport {\n  appendToURLPath,\n  appendToURLQuery,\n  extractConnectionStringParts,\n  assertResponse,\n} from \"./utils/utils.common.js\";\nimport { StorageSharedKeyCredential } from \"@azure/storage-blob\";\nimport { AnonymousCredential } from \"@azure/storage-blob\";\nimport { tracingClient } from \"./utils/tracing.js\";\nimport type { QueueCreateOptions, QueueDeleteOptions } from \"./QueueClient.js\";\nimport { QueueClient } from \"./QueueClient.js\";\nimport { AccountSASPermissions } from \"./AccountSASPermissions.js\";\nimport {\n  generateAccountSASQueryParameters,\n  generateAccountSASQueryParametersInternal,\n} from \"./AccountSASSignatureValues.js\";\nimport { AccountSASServices } from \"./AccountSASServices.js\";\nimport type { SASProtocol } from \"./SASQueryParameters.js\";\nimport type { SasIPRange } from \"./SasIPRange.js\";\nimport { getDefaultProxySettings } from \"@azure/core-rest-pipeline\";\n\n/**\n * Options to configure {@link QueueServiceClient.getProperties} operation\n */\nexport interface ServiceGetPropertiesOptions extends CommonOptions {\n  /**\n   * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.\n   * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.\n   */\n  abortSignal?: AbortSignalLike;\n}\n\n/**\n * Options to configure {@link QueueServiceClient.setProperties} operation\n */\nexport interface ServiceSetPropertiesOptions extends CommonOptions {\n  /**\n   * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.\n   * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.\n   */\n  abortSignal?: AbortSignalLike;\n}\n\n/**\n * Options to configure {@link QueueServiceClient.getStatistics} operation\n */\nexport interface ServiceGetStatisticsOptions extends CommonOptions {\n  /**\n   * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.\n   * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.\n   */\n  abortSignal?: AbortSignalLike;\n}\n\n/**\n * Options to configure Queue Service - List Queues Segment operation\n *\n * See:\n * - {@link QueueServiceClient.listSegments}\n * - {@link QueueServiceClient.listQueuesSegment}\n * - {@link QueueServiceClient.listItems}\n */\ninterface ServiceListQueuesSegmentOptions extends CommonOptions {\n  /**\n   * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.\n   * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.\n   */\n  abortSignal?: AbortSignalLike;\n  /**\n   * Filters the results to return only queues\n   * whose name begins with the specified prefix.\n   */\n  prefix?: string;\n  /**\n   * Specifies the maximum number of queues\n   * to return. If the request does not specify maxPageSize, or specifies a\n   * value greater than 5000, the server will return up to 5000 items. Note\n   * that if the listing operation crosses a partition boundary, then the\n   * service will return a continuation token for retrieving the remainder of\n   * the results. For this reason, it is possible that the service will return\n   * fewer results than specified by maxPageSize, or than the default of 5000.\n   */\n  maxPageSize?: number;\n  /**\n   * Include this parameter to\n   * specify that the queue's metadata be returned as part of the response\n   * body. Possible values include: 'metadata'\n   */\n  include?: string;\n}\n\n/**\n * Options to configure {@link QueueServiceClient.listQueues} operation\n */\nexport interface ServiceListQueuesOptions extends CommonOptions {\n  /**\n   * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.\n   * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.\n   */\n  abortSignal?: AbortSignalLike;\n  /**\n   * Filters the results to return only queues\n   * whose name begins with the specified prefix.\n   */\n  prefix?: string;\n  /**\n   * Specifies whether the queue's metadata be returned as part of the response\n   * body.\n   */\n  includeMetadata?: boolean;\n}\n\n/**\n * Options to configure {@link QueueServiceClient.generateAccountSasUrl} operation.\n */\nexport interface ServiceGenerateAccountSasUrlOptions {\n  /**\n   * The version of the service this SAS will target. If not specified, it will default to the version targeted by the\n   * 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   * Optional. IP range allowed.\n   */\n  ipRange?: SasIPRange;\n}\n\n/**\n * A QueueServiceClient represents a URL to the Azure Storage Queue service allowing you\n * to manipulate queues.\n */\nexport class QueueServiceClient extends StorageClient {\n  /**\n   * Creates an instance of QueueServiceClient.\n   *\n   * @param connectionString - Account connection string or a SAS connection string of an Azure storage account.\n   *                                  [ Note - Account connection string can only be used in NODE.JS runtime. ]\n   *                                  Account connection string example -\n   *                                  `DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`\n   *                                  SAS connection string example -\n   *                                  `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString`\n   * @param options - Options to configure the HTTP pipeline.\n   * @returns A new QueueServiceClient object from the given connection string.\n   */\n  public static fromConnectionString(\n    connectionString: string,\n    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.\n    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */\n    options?: StoragePipelineOptions,\n  ): QueueServiceClient {\n    options = options || {};\n    const extractedCreds = extractConnectionStringParts(connectionString);\n    if (extractedCreds.kind === \"AccountConnString\") {\n      if (isNodeLike) {\n        const sharedKeyCredential = new StorageSharedKeyCredential(\n          extractedCreds.accountName!,\n          extractedCreds.accountKey,\n        );\n        if (!options.proxyOptions) {\n          options.proxyOptions = getDefaultProxySettings(extractedCreds.proxyUri);\n        }\n        const pipeline = newPipeline(sharedKeyCredential, options);\n        return new QueueServiceClient(extractedCreds.url, pipeline);\n      } else {\n        throw new Error(\"Account connection string is only supported in Node.js environment\");\n      }\n    } else if (extractedCreds.kind === \"SASConnString\") {\n      const pipeline = newPipeline(new AnonymousCredential(), options);\n      return new QueueServiceClient(extractedCreds.url + \"?\" + extractedCreds.accountSas, pipeline);\n    } else {\n      throw new Error(\n        \"Connection string must be either an Account connection string or a SAS connection string\",\n      );\n    }\n  }\n\n  /**\n   * serviceContext provided by protocol layer.\n   */\n  private serviceContext: Service;\n\n  /**\n   * Creates an instance of QueueServiceClient.\n   *\n   * @param url - A URL string pointing to Azure Storage queue service, such as\n   *                     \"https://myaccount.queue.core.windows.net\". You can append a SAS\n   *                     if using AnonymousCredential, such as \"https://myaccount.queue.core.windows.net?sasString\".\n   * @param credential -  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.\n   * @param options - Options to configure the HTTP pipeline.\n   *\n   * Example using DefaultAzureCredential from `@azure/identity`:\n   *\n   * ```ts snippet:ReadmeSampleCreateClient_DefaultAzureCredential\n   * import { DefaultAzureCredential } from \"@azure/identity\";\n   * import { QueueServiceClient } from \"@azure/storage-queue\";\n   *\n   * const account = \"<account>\";\n   * const credential = new DefaultAzureCredential();\n   *\n   * const queueServiceClient = new QueueServiceClient(\n   *   `https://${account}.queue.core.windows.net`,\n   *   credential,\n   * );\n   * ```\n   *\n   * Example using an account name/key:\n   *\n   * ```ts snippet:ReadmeSampleCreateClient_StorageSharedKeyCredential\n   * import { StorageSharedKeyCredential, QueueServiceClient } from \"@azure/storage-queue\";\n   *\n   * // Enter your storage account name and shared key\n   * const account = \"<account>\";\n   * const accountKey = \"<accountkey>\";\n   *\n   * // Use StorageSharedKeyCredential with storage account and account key\n   * // StorageSharedKeyCredential is only available in Node.js runtime, not in browsers\n   * const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);\n   *\n   * const queueServiceClient = new QueueServiceClient(\n   *   `https://${account}.queue.core.windows.net`,\n   *   sharedKeyCredential,\n   *   {\n   *     retryOptions: { maxTries: 4 }, // Retry options\n   *     userAgentOptions: {\n   *       userAgentPrefix: \"BasicSample V10.0.0\",\n   *     }, // Customized telemetry string\n   *   },\n   * );\n   * ```\n   */\n  constructor(\n    url: string,\n    credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential,\n    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.\n    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */\n    options?: StoragePipelineOptions,\n  );\n  /**\n   * Creates an instance of QueueServiceClient.\n   *\n   * @param url - A URL string pointing to Azure Storage queue service, such as\n   *                     \"https://myaccount.queue.core.windows.net\". You can append a SAS\n   *                     if using AnonymousCredential, such as \"https://myaccount.queue.core.windows.net?sasString\".\n   * @param pipeline - Call newPipeline() to create a default\n   *                            pipeline, or provide a customized pipeline.\n   */\n  constructor(url: string, pipeline: Pipeline);\n  constructor(\n    url: string,\n    credentialOrPipeline?:\n      | StorageSharedKeyCredential\n      | AnonymousCredential\n      | TokenCredential\n      | Pipeline,\n    // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line.\n    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */\n    options?: StoragePipelineOptions,\n  ) {\n    let pipeline: Pipeline;\n    if (isPipelineLike(credentialOrPipeline)) {\n      pipeline = credentialOrPipeline;\n    } else if (\n      (isNodeLike && credentialOrPipeline instanceof StorageSharedKeyCredential) ||\n      credentialOrPipeline instanceof AnonymousCredential ||\n      isTokenCredential(credentialOrPipeline)\n    ) {\n      pipeline = newPipeline(credentialOrPipeline, options);\n    } else {\n      // The second parameter is undefined. Use anonymous credential.\n      pipeline = newPipeline(new AnonymousCredential(), options);\n    }\n    super(url, pipeline);\n    this.serviceContext = this.storageClientContext.service;\n  }\n\n  /**\n   * Creates a {@link QueueClient} object.\n   *\n   * @param queueName -\n   * @returns a new QueueClient\n   *\n   * Example usage:\n   *\n   * ```ts snippet:ReadmeSampleCreateQueue\n   * import { QueueServiceClient } from \"@azure/storage-queue\";\n   * import { DefaultAzureCredential } from \"@azure/identity\";\n   *\n   * const account = \"<account>\";\n   * const queueServiceClient = new QueueServiceClient(\n   *   `https://${account}.queue.core.windows.net`,\n   *   new DefaultAzureCredential(),\n   * );\n   *\n   * const queueName = \"<valid queue name>\";\n   * const queueClient = queueServiceClient.getQueueClient(queueName);\n   * const createQueueResponse = await queueClient.create();\n   * console.log(\n   *   `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`,\n   * );\n   * ```\n   */\n  public getQueueClient(queueName: string): QueueClient {\n    return new QueueClient(appendToURLPath(this.url, queueName), this.pipeline);\n  }\n\n  /**\n   * Returns a list of the queues under the specified account.\n   * @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-queues1\n   *\n   * @param marker - A string value that identifies the portion of\n   *                        the list of queues to be returned with the next listing operation. The\n   *                        operation returns the continuationToken value within the response body if the\n   *                        listing operation did not return all queues remaining to be listed\n   *                        with the current page. The continuationToken value can be used as the value for\n   *                        the marker parameter in a subsequent call to request the next page of list\n   *                        items. The marker value is opaque to the client.\n   * @param options - Options to list queues operation.\n   * @returns Response data for the list queues segment operation.\n   */\n  private async listQueuesSegment(\n    marker?: string,\n    options: ServiceListQueuesSegmentOptions = {},\n  ): Promise<ServiceListQueuesSegmentResponse> {\n    if (options.prefix === \"\") {\n      options.prefix = undefined;\n    }\n\n    return tracingClient.withSpan(\n      \"QueueServiceClient-listQueuesSegment\",\n      options,\n      async (updatedOptions) => {\n        return assertResponse<\n          ServiceListQueuesSegmentHeaders & ListQueuesSegmentResponse,\n          ServiceListQueuesSegmentHeaders,\n          ListQueuesSegmentResponse\n        >(\n          await this.serviceContext.listQueuesSegment({\n            ...updatedOptions,\n            marker,\n            include: options.include === undefined ? undefined : [options.include],\n          }),\n        );\n      },\n    );\n  }\n\n  /**\n   * Returns an AsyncIterableIterator for {@link ServiceListQueuesSegmentResponse} objects\n   *\n   * @param marker - A string value that identifies the portion of\n   *                        the list of queues to be returned with the next listing operation. The\n   *                        operation returns the continuationToken value within the response body if the\n   *                        listing operation did not return all queues remaining to be listed\n   *                        with the current page. The continuationToken value can be used as the value for\n   *                        the marker parameter in a subsequent call to request the next page of list\n   *                        items. The marker value is opaque to the client.\n   * @param options - Options to list queues operation.\n   */\n  private async *listSegments(\n    marker?: string,\n    options: ServiceListQueuesSegmentOptions = {},\n  ): AsyncIterableIterator<ServiceListQueuesSegmentResponse> {\n    if (options.prefix === \"\") {\n      options.prefix = undefined;\n    }\n\n    let listQueuesResponse;\n    do {\n      listQueuesResponse = await this.listQueuesSegment(marker, options);\n      marker = listQueuesResponse.continuationToken;\n      yield await listQueuesResponse;\n    } while (marker);\n  }\n\n  /**\n   * Returns an AsyncIterableIterator for {@link QueueItem} objects\n   *\n   * @param options - Options to list queues operation.\n   */\n  private async *listItems(\n    options: ServiceListQueuesSegmentOptions = {},\n  ): AsyncIterableIterator<QueueItem> {\n    if (options.prefix === \"\") {\n      options.prefix = undefined;\n    }\n\n    let marker: string | undefined;\n    for await (const segment of this.listSegments(marker, options)) {\n      if (segment.queueItems) {\n        yield* segment.queueItems;\n      }\n    }\n  }\n\n  /**\n   * Returns an async iterable iterator to list all the queues\n   * under the specified account.\n   *\n   * .byPage() returns an async iterable iterator to list the queues in pages.\n   *\n   * Example using `for await` syntax:\n   *\n   * ```ts snippet:ReadmeSampleListQueues\n   * import { QueueServiceClient } from \"@azure/storage-queue\";\n   * import { DefaultAzureCredential } from \"@azure/identity\";\n   *\n   * const account = \"<account>\";\n   * const queueServiceClient = new QueueServiceClient(\n   *   `https://${account}.queue.core.windows.net`,\n   *   new DefaultAzureCredential(),\n   * );\n   *\n   * let i = 1;\n   * for await (const item of queueServiceClient.listQueues()) {\n   *   console.log(`Queue${i++}: ${item.name}`);\n   * }\n   * ```\n   *\n   * Example using `iter.next()`:\n   *\n   * ```ts snippet:ReadmeSampleListQueues_Iterator\n   * import { QueueServiceClient } from \"@azure/storage-queue\";\n   * import { DefaultAzureCredential } from \"@azure/identity\";\n   *\n   * const account = \"<account>\";\n   * const queueServiceClient = new QueueServiceClient(\n   *   `https://${account}.queue.core.windows.net`,\n   *   new DefaultAzureCredential(),\n   * );\n   *\n   * let i = 1;\n   * const iterator = queueServiceClient.listQueues();\n   * let { done, value } = await iterator.next();\n   * while (!done) {\n   *   console.log(`Queue${i++}: ${value.name}`);\n   *   ({ done, value } = await iterator.next());\n   * }\n   * ```\n   *\n   * Example using `byPage()`:\n   *\n   * ```ts snippet:ReadmeSampleListQueues_ByPage\n   * import { QueueServiceClient } from \"@azure/storage-queue\";\n   * import { DefaultAzureCredential } from \"@azure/identity\";\n   *\n   * const account = \"<account>\";\n   * const queueServiceClient = new QueueServiceClient(\n   *   `https://${account}.queue.core.windows.net`,\n   *   new DefaultAzureCredential(),\n   * );\n   *\n   * let i = 1;\n   * for await (const page of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {\n   *   for (const item of page.queueItems || []) {\n   *     console.log(`Queue${i++}: ${item.name}`);\n   *   }\n   * }\n   * ```\n   *\n   * Example using paging with a marker:\n   *\n   * ```ts snippet:ReadmeSampleListQueues_Continuation\n   * import { QueueServiceClient } from \"@azure/storage-queue\";\n   * import { DefaultAzureCredential } from \"@azure/identity\";\n   *\n   * const account = \"<account>\";\n   * const queueServiceClient = new QueueServiceClient(\n   *   `https://${account}.queue.core.windows.net`,\n   *   new DefaultAzureCredential(),\n   * );\n   *\n   * let i = 1;\n   * let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });\n   * let response = (await iterator.next()).value;\n   * // Prints 2 queues\n   * if (response.queueItems) {\n   *   for (const item of response.queueItems) {\n   *     console.log(`Queue${i++}: ${item.name}`);\n   *   }\n   * }\n   * // Gets next marker\n   * let marker = response.continuationToken;\n   * // Passing next marker as continuationToken\n   * iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });\n   * response = (await iterator.next()).value;\n   * // Prints 10 queues\n   * if (response.queueItems) {\n   *   for (const item of response.queueItems) {\n   *     console.log(`Queue${i++}: ${item.name}`);\n   *   }\n   * }\n   * ```\n   *\n   * @param options - Options to list queues operation.\n   * @returns An asyncIterableIterator that supports paging.\n   */\n  public listQueues(\n    options: ServiceListQueuesOptions = {},\n  ): PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse> {\n    if (options.prefix === \"\") {\n      options.prefix = undefined;\n    }\n\n    const updatedOptions: ServiceListQueuesSegmentOptions = {\n      ...options,\n      ...(options.includeMetadata ? { include: \"metadata\" } : {}),\n    };\n\n    // AsyncIterableIterator to iterate over queues\n    const iter = this.listItems(updatedOptions);\n    return {\n      /**\n       * The next method, part of the iteration protocol\n       */\n      next() {\n        return iter.next();\n      },\n      /**\n       * The connection to the async iterator, part of the iteration protocol\n       */\n      [Symbol.asyncIterator]() {\n        return this;\n      },\n      /**\n       * Return an AsyncIterableIterator that works a page at a time\n       */\n      byPage: (settings: PageSettings = {}) => {\n        return this.listSegments(settings.continuationToken, {\n          maxPageSize: settings.maxPageSize,\n          ...updatedOptions,\n        });\n      },\n    };\n  }\n\n  /**\n   * Gets the properties of a storage account’s Queue service, including properties\n   * for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.\n   * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties\n   *\n   * @param options - Options to get properties operation.\n   * @returns Response data including the queue service properties.\n   */\n  public async getProperties(\n    options: ServiceGetPropertiesOptions = {},\n  ): Promise<ServiceGetPropertiesResponse> {\n    return tracingClient.withSpan(\n      \"QueueServiceClient-getProperties\",\n      options,\n      async (updatedOptions) => {\n        return assertResponse<\n          ServiceGetPropertiesHeaders & QueueServiceProperties,\n          ServiceGetPropertiesHeaders,\n          QueueServiceProperties\n        >(await this.serviceContext.getProperties(updatedOptions));\n      },\n    );\n  }\n\n  /**\n   * Sets properties for a storage account’s Queue service endpoint, including properties\n   * for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.\n   * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties\n   *\n   * @param properties -\n   * @param options - Options to set properties operation.\n   * @returns Response data for the Set Properties operation.\n   */\n  public async setProperties(\n    properties: QueueServiceProperties,\n    options: ServiceGetPropertiesOptions = {},\n  ): Promise<ServiceSetPropertiesResponse> {\n    return tracingClient.withSpan(\n      \"QueueServiceClient-setProperties\",\n      options,\n      async (updatedOptions) => {\n        return assertResponse<ServiceSetPropertiesHeaders, ServiceSetPropertiesHeaders>(\n          await this.serviceContext.setProperties(properties, updatedOptions),\n        );\n      },\n    );\n  }\n\n  /**\n   * Retrieves statistics related to replication for the Queue service. It is only\n   * available on the secondary location endpoint when read-access geo-redundant\n   * replication is enabled for the storage account.\n   * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats\n   *\n   * @param options - Options to get statistics operation.\n   * @returns Response data for get statistics the operation.\n   */\n  public async getStatistics(\n    options: ServiceGetStatisticsOptions = {},\n  ): Promise<ServiceGetStatisticsResponse> {\n    return tracingClient.withSpan(\n      \"QueueServiceClient-getStatistics\",\n      options,\n      async (updatedOptions) => {\n        return assertResponse<\n          ServiceGetStatisticsHeaders & QueueServiceStatistics,\n          ServiceGetStatisticsHeaders,\n          QueueServiceStatistics\n        >(await this.serviceContext.getStatistics(updatedOptions));\n      },\n    );\n  }\n\n  /**\n   * Creates a new queue under the specified account.\n   * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-queue4\n   *\n   * @param queueName - name of the queue to create\n   * @param options - Options to Queue create operation.\n   * @returns Response data for the Queue create operation.\n   */\n  public async createQueue(\n    queueName: string,\n    options: QueueCreateOptions = {},\n  ): Promise<QueueCreateResponse> {\n    return tracingClient.withSpan(\n      \"QueueServiceClient-createQueue\",\n      options,\n      async (updatedOptions) => {\n        return this.getQueueClient(queueName).create(updatedOptions);\n      },\n    );\n  }\n\n  /**\n   * Deletes the specified queue permanently.\n   * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-queue3\n   *\n   * @param queueName - name of the queue to delete.\n   * @param options - Options to Queue delete operation.\n   * @returns Response data for the Queue delete operation.\n   */\n  public async deleteQueue(\n    queueName: string,\n    options: QueueDeleteOptions = {},\n  ): Promise<QueueDeleteResponse> {\n    return tracingClient.withSpan(\n      \"QueueServiceClient-deleteQueue\",\n      options,\n      async (updatedOptions) => {\n        return this.getQueueClient(queueName).delete(updatedOptions);\n      },\n    );\n  }\n\n  /**\n   * Only available for QueueServiceClient constructed with a shared key credential.\n   *\n   * Generates an account Shared Access Signature (SAS) URI based on the client properties\n   * and parameters passed in. The SAS is signed by the shared key credential of the client.\n   *\n   * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas\n   *\n   * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.\n   * @param permissions - Specifies the list of permissions to be associated with the SAS.\n   * @param resourceTypes - Specifies the resource types associated with the shared access signature.\n   * @param options - Optional parameters.\n   * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.\n   */\n  public generateAccountSasUrl(\n    expiresOn?: Date,\n    permissions: AccountSASPermissions = AccountSASPermissions.parse(\"r\"),\n    resourceTypes: string = \"sco\",\n    options: ServiceGenerateAccountSasUrlOptions = {},\n  ): string {\n    if (!(this.credential instanceof StorageSharedKeyCredential)) {\n      throw RangeError(\n        \"Can only generate the account SAS when the client is initialized with a shared key credential\",\n      );\n    }\n\n    if (expiresOn === undefined) {\n      const now = new Date();\n      expiresOn = new Date(now.getTime() + 3600 * 1000);\n    }\n\n    const sas = generateAccountSASQueryParameters(\n      {\n        permissions,\n        expiresOn,\n        resourceTypes,\n        services: AccountSASServices.parse(\"q\").toString(),\n        ...options,\n      },\n      this.credential,\n    ).toString();\n\n    return appendToURLQuery(this.url, sas);\n  }\n\n  /**\n   * Only available for QueueServiceClient constructed with a shared key credential.\n   *\n   * Generates string to sign for an account Shared Access Signature (SAS) URI based on the client properties\n   * and parameters passed in. The SAS is signed by the shared key credential of the client.\n   *\n   * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas\n   *\n   * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.\n   * @param permissions - Specifies the list of permissions to be associated with the SAS.\n   * @param resourceTypes - Specifies the resource types associated with the shared access signature.\n   * @param options - Optional parameters.\n   * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.\n   */\n  public generateSasStringToSign(\n    expiresOn?: Date,\n    permissions: AccountSASPermissions = AccountSASPermissions.parse(\"r\"),\n    resourceTypes: string = \"sco\",\n    options: ServiceGenerateAccountSasUrlOptions = {},\n  ): string {\n    if (!(this.credential instanceof StorageSharedKeyCredential)) {\n      throw RangeError(\n        \"Can only generate the account SAS when the client is initialized with a shared key credential\",\n      );\n    }\n\n    if (expiresOn === undefined) {\n      const now = new Date();\n      expiresOn = new Date(now.getTime() + 3600 * 1000);\n    }\n\n    return generateAccountSASQueryParametersInternal(\n      {\n        permissions,\n        expiresOn,\n        resourceTypes,\n        services: AccountSASServices.parse(\"q\").toString(),\n        ...options,\n      },\n      this.credential,\n    ).stringToSign;\n  }\n}\n"]}

package/dist/commonjs/SASQueryParameters.d.ts

@@ -0,0 +1,110 @@
+import type { SasIPRange } from "./SasIPRange.js";
+/**
+ * Protocols for generated SAS.
+ */
+export declare enum SASProtocol {
+    /**
+     * Protocol that allows HTTPS only
+     */
+    Https = "https",
+    /**
+     * Protocol that allows both HTTPS and HTTP
+     */
+    HttpsAndHttp = "https,http"
+}
+/**
+ * Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly
+ * by the user; it is only generated by the {@link AccountSASSignatureValues} and {@link QueueSASSignatureValues}
+ * types. Once generated, it can be encoded into a {@link String} and appended to a URL directly (though caution should
+ * be taken here in case there are existing query parameters, which might affect the appropriate means of appending
+ * these query parameters).
+ *
+ * NOTE: Instances of this class are immutable.
+ */
+export declare class SASQueryParameters {
+    /**
+     * The storage API version.
+     */
+    readonly version: string;
+    /**
+     * Optional. The allowed HTTP protocol(s).
+     */
+    readonly protocol?: SASProtocol;
+    /**
+     * Optional. The start time for this SAS token.
+     */
+    readonly startsOn?: Date;
+    /**
+     * Optional only when identifier is provided. The expiry time for this SAS token.
+     */
+    readonly expiresOn?: Date;
+    /**
+     * Optional only when identifier is provided.
+     * Please refer to {@link AccountSASPermissions}, {@link QueueSASPermissions} for more details.
+     */
+    readonly permissions?: string;
+    /**
+     * Optional. The storage services being accessed (only for Account SAS). Please refer to {@link AccountSASServices}
+     * for more details.
+     */
+    readonly services?: string;
+    /**
+     * Optional. The storage resource types being accessed (only for Account SAS). Please refer to
+     * {@link AccountSASResourceTypes} for more details.
+     */
+    readonly resourceTypes?: string;
+    /**
+     * Optional. The signed identifier (only for {@link QueueSASSignatureValues}).
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
+     */
+    readonly identifier?: string;
+    /**
+     * Optional. The storage queue (only for {@link QueueSASSignatureValues}).
+     */
+    readonly resource?: string;
+    /**
+     * The signature for the SAS token.
+     */
+    readonly signature: string;
+    /**
+     * Inner value of getter ipRange.
+     */
+    private readonly ipRangeInner?;
+    /**
+     * Optional. IP range allowed for this SAS.
+     *
+     * @readonly
+     */
+    get ipRange(): SasIPRange | undefined;
+    /**
+     * Creates an instance of SASQueryParameters.
+     *
+     * @param version - Representing the storage version
+     * @param signature - Representing the signature for the SAS token
+     * @param permissions - Representing the storage permissions
+     * @param services - Representing the storage services being accessed (only for Account SAS)
+     * @param resourceTypes - Representing the storage resource types being accessed (only for Account SAS)
+     * @param protocol - Representing the allowed HTTP protocol(s)
+     * @param startsOn - Representing the start time for this SAS token
+     * @param expiresOn - Representing the expiry time for this SAS token
+     * @param ipRange - Representing the range of valid IP addresses for this SAS token
+     * @param identifier - Representing the signed identifier (only for Service SAS)
+     * @param resource - Representing the storage queue (only for Service SAS)
+     */
+    constructor(version: string, signature: string, permissions?: string, services?: string, resourceTypes?: string, protocol?: SASProtocol, startsOn?: Date, expiresOn?: Date, ipRange?: SasIPRange, identifier?: string, resource?: string);
+    /**
+     * Encodes all SAS query parameters into a string that can be appended to a URL.
+     *
+     */
+    toString(): string;
+    /**
+     * A private helper method used to filter and append query key/value pairs into an array.
+     *
+     * @param queries -
+     * @param key -
+     * @param value -
+     */
+    private tryAppendQueryParameter;
+}
+//# sourceMappingURL=SASQueryParameters.d.ts.map

package/dist/commonjs/SASQueryParameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SASQueryParameters.d.ts","sourceRoot":"","sources":["../../src/SASQueryParameters.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAIlD;;GAEG;AACH,oBAAY,WAAW;IACrB;;OAEG;IACH,KAAK,UAAU;IAEf;;OAEG;IACH,YAAY,eAAe;CAC5B;AAED;;;;;;;;GAQG;AACH,qBAAa,kBAAkB;IAC7B;;OAEG;IACH,SAAgB,OAAO,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,SAAgB,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvC;;OAEG;IACH,SAAgB,QAAQ,CAAC,EAAE,IAAI,CAAC;IAEhC;;OAEG;IACH,SAAgB,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjC;;;OAGG;IACH,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErC;;;OAGG;IACH,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,SAAgB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvC;;;;OAIG;IACH,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAa;IAE3C;;;;OAIG;IACH,IAAW,OAAO,IAAI,UAAU,GAAG,SAAS,CAQ3C;IAED;;;;;;;;;;;;;;OAcG;gBAED,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,MAAM,EACpB,QAAQ,CAAC,EAAE,MAAM,EACjB,aAAa,CAAC,EAAE,MAAM,EACtB,QAAQ,CAAC,EAAE,WAAW,EACtB,QAAQ,CAAC,EAAE,IAAI,EACf,SAAS,CAAC,EAAE,IAAI,EAChB,OAAO,CAAC,EAAE,UAAU,EACpB,UAAU,CAAC,EAAE,MAAM,EACnB,QAAQ,CAAC,EAAE,MAAM;IAenB;;;OAGG;IACI,QAAQ,IAAI,MAAM;IAwDzB;;;;;;OAMG;IACH,OAAO,CAAC,uBAAuB;CAWhC"}