@azure/storage-blob 12.28.0-alpha.20250530.1 → 12.28.0-alpha.20250611.3

package/dist/commonjs/Clients.js

@@ -163,7 +163,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
      * * In Node.js, data returns in a Readable stream readableStreamBody
      * * In browsers, data returns in a promise blobBody
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-blob
      *
      * @param offset - From which position of the blob to download, greater than or equal to 0
      * @param count - How much data to be downloaded, greater than 0. Will download to the end when undefined
@@ -349,7 +349,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
     /**
      * Returns all user-defined metadata, standard HTTP properties, and system properties
      * for the blob. It does not return the content of the blob.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-blob-properties
      *
      * 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
@@ -378,7 +378,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
      * during garbage collection. Note that in order to delete a blob, you must delete
      * all of its snapshots. You can delete both at the same time with the Delete
      * Blob operation.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob
+     * @see https://learn.microsoft.com/rest/api/storageservices/delete-blob
      *
      * @param options - Optional options to Blob Delete operation.
      */
@@ -400,7 +400,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
      * during garbage collection. Note that in order to delete a blob, you must delete
      * all of its snapshots. You can delete both at the same time with the Delete
      * Blob operation.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob
+     * @see https://learn.microsoft.com/rest/api/storageservices/delete-blob
      *
      * @param options - Optional options to Blob Delete operation.
      */
@@ -423,7 +423,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
      * Restores the contents and metadata of soft deleted blob and any associated
      * soft deleted snapshots. Undelete Blob is supported only on version 2017-07-29
      * or later.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/undelete-blob
+     * @see https://learn.microsoft.com/rest/api/storageservices/undelete-blob
      *
      * @param options - Optional options to Blob Undelete operation.
      */
@@ -440,7 +440,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
      *
      * If no value provided, or no value provided for the specified blob HTTP headers,
      * these blob HTTP headers without a value will be cleared.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
      *
      * @param blobHTTPHeaders - If no value provided, or no value provided for
      *                                                   the specified blob HTTP headers, these blob HTTP
@@ -470,7 +470,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
      *
      * If no option provided, or no metadata defined in the parameter, the blob
      * metadata will be removed.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
      *
      * @param metadata - Replace existing metadata with this value.
      *                               If no value provided the existing metadata will be removed.
@@ -542,7 +542,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Creates a read-only snapshot of a blob.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
+     * @see https://learn.microsoft.com/rest/api/storageservices/snapshot-blob
      *
      * @param options - Optional options to the Blob Create Snapshot operation.
      */
@@ -576,7 +576,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
      * an Azure file in any Azure storage account.
      * Only storage accounts created on or after June 7th, 2012 allow the Copy Blob
      * operation to copy from another storage account.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob
+     * @see https://learn.microsoft.com/rest/api/storageservices/copy-blob
      *
      * ```ts snippet:ClientsBeginCopyFromURL
      * import { BlobServiceClient } from "@azure/storage-blob";
@@ -657,7 +657,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
     /**
      * Aborts a pending asynchronous Copy Blob operation, and leaves a destination blob with zero
      * length and full metadata. Version 2012-02-12 and newer.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
+     * @see https://learn.microsoft.com/rest/api/storageservices/abort-copy-blob
      *
      * @param copyId - Id of the Copy From URL operation.
      * @param options - Optional options to the Blob Abort Copy From URL operation.
@@ -674,7 +674,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
     /**
      * The synchronous Copy From URL operation copies a blob or an internet resource to a new blob. It will not
      * return a response until the copy is complete.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
+     * @see https://learn.microsoft.com/rest/api/storageservices/copy-blob-from-url
      *
      * @param copySource - The source URL to copy from, Shared Access Signature(SAS) maybe needed for authentication
      * @param options -
@@ -715,7 +715,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
      * storage only). A premium page blob's tier determines the allowed size, IOPS,
      * and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive
      * storage type. This operation does not update the blob's ETag.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-blob-tier
      *
      * @param tier - The tier to be set on the blob. Valid values are Hot, Cool, or Archive.
      * @param options - Optional options to the Blob Set Tier operation.
@@ -900,7 +900,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
      * an Azure file in any Azure storage account.
      * Only storage accounts created on or after June 7th, 2012 allow the Copy Blob
      * operation to copy from another storage account.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob
+     * @see https://learn.microsoft.com/rest/api/storageservices/copy-blob
      *
      * @param copySource - url to the source Azure Blob/File.
      * @param options - Optional options to the Blob Start Copy From URL operation.
@@ -939,7 +939,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
      * Generates a Blob 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://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+     * @see https://learn.microsoft.com/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.
@@ -959,7 +959,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
      * Generates string to sign for a Blob 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://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+     * @see https://learn.microsoft.com/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.
@@ -976,7 +976,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
      * Generates a Blob Service Shared Access Signature (SAS) URI based on
      * the client properties and parameters passed in. The SAS is signed by the input user delegation key.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+     * @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
      *
      * @param options - Optional parameters.
      * @param userDelegationKey -  Return value of `blobServiceClient.getUserDelegationKey()`
@@ -994,7 +994,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
      * Generates string to sign for a Blob Service Shared Access Signature (SAS) URI based on
      * the client properties and parameters passed in. The SAS is signed by the input user delegation key.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+     * @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
      *
      * @param options - Optional parameters.
      * @param userDelegationKey -  Return value of `blobServiceClient.getUserDelegationKey()`
@@ -1046,7 +1046,7 @@ class BlobClient extends StorageClient_js_1.StorageClient {
      * for the specified account.
      * The Get Account Information operation is available on service versions beginning
      * with version 2018-03-28.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-account-information
      *
      * @param options - Options to the Service Get Account Info operation.
      * @returns Response data for the Service Get Account Info operation.
@@ -1293,7 +1293,7 @@ class AppendBlobClient extends BlobClient {
     /**
      * The Append Block operation commits a new block of data to the end of an existing append blob
      * where the contents are read from a source url.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/append-block-from-url
+     * @see https://learn.microsoft.com/rest/api/storageservices/append-block-from-url
      *
      * @param sourceURL -
      *                 The url to the blob that will be the source of the copy. A source blob in the same storage account can
@@ -1624,7 +1624,7 @@ class BlockBlobClient extends BlobClient {
      * The Stage Block From URL operation creates a new block to be committed as part
      * of a blob where the contents are read from a URL.
      * This API is available starting in version 2018-03-28.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
+     * @see https://learn.microsoft.com/rest/api/storageservices/put-block-from-url
      *
      * @param blockId - A 64-byte value that is base64-encoded
      * @param sourceURL - Specifies the URL of the blob. The value
@@ -2119,7 +2119,7 @@ class PageBlobClient extends BlobClient {
     /**
      * The Upload Pages operation writes a range of pages to a page blob where the
      * contents are read from a URL.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/put-page-from-url
+     * @see https://learn.microsoft.com/rest/api/storageservices/put-page-from-url
      *
      * @param sourceURL - Specify a URL to the copy source, Shared Access Signature(SAS) maybe needed for authentication
      * @param sourceOffset - The source offset to copy from. Pass 0 to copy from the beginning of source page blob
@@ -2648,7 +2648,7 @@ class PageBlobClient extends BlobClient {
     }
     /**
      * Sets a page blob's sequence number.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
      *
      * @param sequenceNumberAction - Indicates how the service should modify the blob's sequence number.
      * @param sequenceNumber - Required if sequenceNumberAction is max or update
@@ -2674,7 +2674,7 @@ class PageBlobClient extends BlobClient {
      * copied snapshot are transferred to the destination.
      * The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual.
      * @see https://learn.microsoft.com/rest/api/storageservices/incremental-copy-blob
-     * @see https://learn.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
+     * @see https://learn.microsoft.com/azure/virtual-machines/windows/incremental-snapshots
      *
      * @param copySource - Specifies the name of the source page blob snapshot. For example,
      *                            https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=<DateTime>