@azure/storage-queue 12.25.0 → 12.26.0-alpha.20250319.1

package/types/latest/storage-queue.d.ts

@@ -83,7 +83,7 @@ export declare class AccountSASPermissions {
      * Using this method will guarantee the resource types are in
      * an order accepted by the service.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
      *
      */
     toString(): string;
@@ -121,7 +121,7 @@ export declare class AccountSASResourceTypes {
     /**
      * Converts the given resource types to a string.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
      *
      */
     toString(): string;
@@ -176,10 +176,10 @@ export declare class AccountSASServices {
  * the former is mutable and a logical representation while the latter is immutable and used to generate actual REST
  * requests.
  *
- * @see https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1
+ * @see https://learn.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1
  * for more conceptual information on SAS
  *
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
  * for descriptions of the parameters, including which are required
  */
 export declare interface AccountSASSignatureValues {
@@ -395,7 +395,7 @@ export declare interface EnqueuedMessage {
  * Generates a {@link SASQueryParameters} object which contains all SAS query parameters needed to make an actual
  * REST request.
  *
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
  *
  * @param accountSASSignatureValues - SAS Signature values of the account
  * @param sharedKeyCredential - Shared key credential.
@@ -665,7 +665,7 @@ export declare interface MessagesDequeueHeaders {
 
 /** Optional parameters. */
 export declare interface MessagesDequeueOptionalParams extends CommonOptions {
-    /** The The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a> */
+    /** The The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a> */
     timeoutInSeconds?: number;
     /** 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. */
     requestId?: string;
@@ -706,7 +706,7 @@ export declare interface MessagesEnqueueHeaders {
 
 /** Optional parameters. */
 export declare interface MessagesEnqueueOptionalParams extends CommonOptions {
-    /** The The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a> */
+    /** The The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a> */
     timeoutInSeconds?: number;
     /** 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. */
     requestId?: string;
@@ -747,7 +747,7 @@ export declare interface MessagesPeekHeaders {
 
 /** Optional parameters. */
 export declare interface MessagesPeekOptionalParams extends CommonOptions {
-    /** The The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a> */
+    /** The The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-queue-service-operations">Setting Timeouts for Queue Service Operations.</a> */
     timeoutInSeconds?: number;
     /** 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. */
     requestId?: string;
@@ -991,7 +991,7 @@ export declare class QueueClient extends StorageClient {
     private getMessageIdContext;
     /**
      * Creates a new queue under the specified account.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-queue4
      *
      * @param options - Options to Queue create operation.
      * @returns Response data for the Queue create operation.
@@ -1007,21 +1007,21 @@ export declare class QueueClient extends StorageClient {
     /**
      * Creates a new queue under the specified account if it doesn't already exist.
      * If the queue already exists, it is not changed.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-queue4
      *
      * @param options -
      */
     createIfNotExists(options?: QueueCreateOptions): Promise<QueueCreateIfNotExistsResponse>;
     /**
      * Deletes the specified queue permanently if it exists.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-queue3
      *
      * @param options -
      */
     deleteIfExists(options?: QueueDeleteOptions): Promise<QueueDeleteIfExistsResponse>;
     /**
      * Deletes the specified queue permanently.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-queue3
      *
      * @param options - Options to Queue delete operation.
      * @returns Response data for the Queue delete operation.
@@ -1049,7 +1049,7 @@ export declare class QueueClient extends StorageClient {
     /**
      * Gets all user-defined metadata and system properties for the specified
      * queue. Metadata is associated with the queue as name-values pairs.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-metadata
      *
      * WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
      * they originally contained uppercase characters. This differs from the metadata keys returned by
@@ -1065,7 +1065,7 @@ export declare class QueueClient extends StorageClient {
      *
      * If no option provided, or no metadata defined in the option parameter, the queue
      * metadata will be removed.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-metadata
      *
      * @param metadata - If no metadata provided, all existing metadata will be removed.
      * @param options - Options to Queue set metadata operation.
@@ -1078,7 +1078,7 @@ export declare class QueueClient extends StorageClient {
      * WARNING: JavaScript Date will potential lost precision when parsing start and expiry string.
      * For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-acl
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-acl
      *
      * @param options - Options to Queue get access policy operation.
      * @returns Response data for the Queue get access policy operation.
@@ -1086,7 +1086,7 @@ export declare class QueueClient extends StorageClient {
     getAccessPolicy(options?: QueueGetAccessPolicyOptions): Promise<QueueGetAccessPolicyResponse>;
     /**
      * Sets stored access policies for the queue that may be used with Shared Access Signatures.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-acl
      *
      * @param queueAcl -
      * @param options - Options to Queue set access policy operation.
@@ -1095,7 +1095,7 @@ export declare class QueueClient extends StorageClient {
     setAccessPolicy(queueAcl?: SignedIdentifier[], options?: QueueSetAccessPolicyOptions): Promise<QueueSetAccessPolicyResponse>;
     /**
      * Clear deletes all messages from a queue.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/clear-messages
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/clear-messages
      *
      * @param options - Options to clear messages operation.
      * @returns Response data for the clear messages operation.
@@ -1106,7 +1106,7 @@ export declare class QueueClient extends StorageClient {
      * the message should be invisible to Dequeue and Peek operations.
      * 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.
      * To include markup in the message, the contents of the message must either be XML-escaped or Base64-encode.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/put-message
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/put-message
      *
      * @param messageText - Text of the message to send
      * @param options - Options to send messages operation.
@@ -1125,7 +1125,7 @@ export declare class QueueClient extends StorageClient {
     sendMessage(messageText: string, options?: QueueSendMessageOptions): Promise<QueueSendMessageResponse>;
     /**
      * receiveMessages retrieves one or more messages from the front of the queue.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-messages
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-messages
      *
      * @param options - Options to receive messages operation.
      * @returns Response data for the receive messages operation.
@@ -1151,7 +1151,7 @@ export declare class QueueClient extends StorageClient {
     receiveMessages(options?: QueueReceiveMessageOptions): Promise<QueueReceiveMessageResponse>;
     /**
      * peekMessages retrieves one or more messages from the front of the queue but does not alter the visibility of the message.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/peek-messages
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/peek-messages
      *
      * @param options - Options to peek messages operation.
      * @returns Response data for the peek messages operation.
@@ -1166,7 +1166,7 @@ export declare class QueueClient extends StorageClient {
     peekMessages(options?: QueuePeekMessagesOptions): Promise<QueuePeekMessagesResponse>;
     /**
      * deleteMessage permanently removes the specified message from its queue.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-message2
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-message2
      *
      * @param messageId - Id of the message.
      * @param popReceipt - A valid pop receipt value returned from an earlier call to the receive messages or update message operation.
@@ -1178,7 +1178,7 @@ export declare class QueueClient extends StorageClient {
      * Update changes a message's visibility timeout and contents.
      * 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.
      * To include markup in the message, the contents of the message must either be XML-escaped or Base64-encode.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/update-message
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/update-message
      *
      * @param messageId - Id of the message
      * @param popReceipt - A valid pop receipt value returned from an earlier call to the receive messages or update message operation.
@@ -1199,7 +1199,7 @@ export declare class QueueClient extends StorageClient {
      * Generates a Service 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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
      *
      * @param options - Optional parameters.
      * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
@@ -1211,7 +1211,7 @@ export declare class QueueClient extends StorageClient {
      * Generates string to sign for a Service 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://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
      *
      * @param options - Optional parameters.
      * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
@@ -1388,7 +1388,7 @@ export declare interface QueueGenerateSasUrlOptions {
     /**
      * Optional. The name of the access policy on the queue this SAS references if any.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
      */
     identifier?: string;
 }
@@ -1614,7 +1614,7 @@ export declare interface QueueSASSignatureValues {
     /**
      * Optional. The name of the access policy on the queue this SAS references if any.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
      */
     identifier?: string;
 }
@@ -1749,7 +1749,7 @@ export declare class QueueServiceClient extends StorageClient {
     getQueueClient(queueName: string): QueueClient;
     /**
      * Returns a list of the queues under the specified account.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/list-queues1
+     * @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
@@ -1862,7 +1862,7 @@ export declare class QueueServiceClient extends StorageClient {
     /**
      * Gets the properties of a storage account’s Queue service, including properties
      * for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties
+     * @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.
@@ -1871,7 +1871,7 @@ export declare class QueueServiceClient extends StorageClient {
     /**
      * 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://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties
      *
      * @param properties -
      * @param options - Options to set properties operation.
@@ -1882,7 +1882,7 @@ export declare class QueueServiceClient extends StorageClient {
      * 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://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats
+     * @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.
@@ -1890,7 +1890,7 @@ export declare class QueueServiceClient extends StorageClient {
     getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>;
     /**
      * Creates a new queue under the specified account.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-queue4
+     * @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.
@@ -1899,7 +1899,7 @@ export declare class QueueServiceClient extends StorageClient {
     createQueue(queueName: string, options?: QueueCreateOptions): Promise<QueueCreateResponse>;
     /**
      * Deletes the specified queue permanently.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-queue3
+     * @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.
@@ -1912,7 +1912,7 @@ export declare class QueueServiceClient extends StorageClient {
      * 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://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
+     * @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.
@@ -1927,7 +1927,7 @@ export declare class QueueServiceClient extends StorageClient {
      * 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://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
+     * @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.
@@ -2204,7 +2204,7 @@ export declare class SASQueryParameters {
     /**
      * Optional. The signed identifier (only for {@link QueueSASSignatureValues}).
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
      */
     readonly identifier?: string;
     /**
@@ -2514,7 +2514,7 @@ export declare interface SignedIdentifier {
         expiresOn?: Date;
         /**
          * the permissions for the acl policy
-         * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-acl
+         * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-acl
          */
         permissions?: string;
     };
@@ -2680,7 +2680,7 @@ export declare interface StorageRetryOptions {
      * A value of zero or undefined means no default timeout on SDK client, Azure
      * Storage server's default timeout policy will be used.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations
      */
     readonly tryTimeoutInMs?: number;
     /**
@@ -2700,7 +2700,7 @@ export declare interface StorageRetryOptions {
      *
      * NOTE: Before setting this field, make sure you understand the issues around
      * reading stale and potentially-inconsistent data at
-     * {@link https://docs.microsoft.com/en-us/azure/storage/common/storage-designing-ha-apps-with-ragrs}
+     * {@link https://learn.microsoft.com/en-us/azure/storage/common/storage-designing-ha-apps-with-ragrs}
      */
     readonly secondaryHost?: string;
 }
@@ -2848,7 +2848,7 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
     protected signRequest(request: WebResource): WebResource;
     /**
      * Retrieve header value according to shared key sign rules.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
      *
      * @param request -
      * @param headerName -