@azure/storage-file-share 12.26.0 → 12.27.0-alpha.20250217.1

package/dist-esm/storage-blob/src/Clients.js

@@ -160,7 +160,7 @@ export class BlobClient extends StorageClient {
      * * In Node.js, data returns in a Readable stream readableStreamBody
      * * In browsers, data returns in a promise blobBody
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
+     * @see https://learn.microsoft.com/en-us/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
@@ -324,7 +324,7 @@ export class BlobClient extends 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://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
+     * @see https://learn.microsoft.com/en-us/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
@@ -353,7 +353,7 @@ export class BlobClient extends 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://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob
      *
      * @param options - Optional options to Blob Delete operation.
      */
@@ -375,7 +375,7 @@ export class BlobClient extends 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://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-blob
      *
      * @param options - Optional options to Blob Delete operation.
      */
@@ -398,7 +398,7 @@ export class BlobClient extends 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://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/undelete-blob
      *
      * @param options - Optional options to Blob Undelete operation.
      */
@@ -415,7 +415,7 @@ export class BlobClient extends 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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
+     * @see https://learn.microsoft.com/en-us/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
@@ -445,7 +445,7 @@ export class BlobClient extends StorageClient {
      *
      * If no option provided, or no metadata defined in the parameter, the blob
      * metadata will be removed.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
      *
      * @param metadata - Replace existing metadata with this value.
      *                               If no value provided the existing metadata will be removed.
@@ -517,7 +517,7 @@ export class BlobClient extends StorageClient {
     }
     /**
      * Creates a read-only snapshot of a blob.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
      *
      * @param options - Optional options to the Blob Create Snapshot operation.
      */
@@ -551,7 +551,7 @@ export class BlobClient extends 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://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/copy-blob
      *
      * Example using automatic polling:
      *
@@ -631,7 +631,7 @@ export class BlobClient extends 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://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
+     * @see https://learn.microsoft.com/en-us/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.
@@ -648,7 +648,7 @@ export class BlobClient extends 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://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
+     * @see https://learn.microsoft.com/en-us/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 -
@@ -688,7 +688,7 @@ export class BlobClient extends 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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
+     * @see https://learn.microsoft.com/en-us/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.
@@ -873,7 +873,7 @@ export class BlobClient extends 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://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob
+     * @see https://learn.microsoft.com/en-us/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.
@@ -912,7 +912,7 @@ export class BlobClient extends 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://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.
@@ -932,7 +932,7 @@ export class BlobClient extends 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://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.
@@ -949,7 +949,7 @@ export class BlobClient extends 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://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.
      * @param userDelegationKey -  Return value of `blobServiceClient.getUserDelegationKey()`
@@ -967,7 +967,7 @@ export class BlobClient extends 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://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.
      * @param userDelegationKey -  Return value of `blobServiceClient.getUserDelegationKey()`
@@ -1019,7 +1019,7 @@ export class BlobClient extends StorageClient {
      * for the specified account.
      * The Get Account Information operation is available on service versions beginning
      * with version 2018-03-28.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
+     * @see https://learn.microsoft.com/en-us/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.
@@ -1117,7 +1117,7 @@ export class AppendBlobClient extends BlobClient {
     }
     /**
      * Creates a 0-length append blob. Call AppendBlock to append data to an append blob.
-     * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
+     * @see https://learn.microsoft.com/rest/api/storageservices/put-blob
      *
      * @param options - Options to the Append Block Create operation.
      *
@@ -1153,7 +1153,7 @@ export class AppendBlobClient extends BlobClient {
     /**
      * Creates a 0-length append blob. Call AppendBlock to append data to an append blob.
      * If the blob with the same name already exists, the content of the existing blob will remain unchanged.
-     * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
+     * @see https://learn.microsoft.com/rest/api/storageservices/put-blob
      *
      * @param options -
      */
@@ -1193,7 +1193,7 @@ export class AppendBlobClient extends BlobClient {
     }
     /**
      * Commits a new block of data to the end of the existing append blob.
-     * @see https://docs.microsoft.com/rest/api/storageservices/append-block
+     * @see https://learn.microsoft.com/rest/api/storageservices/append-block
      *
      * @param body - Data to be appended.
      * @param contentLength - Length of the body in bytes.
@@ -1239,7 +1239,7 @@ export 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://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url
+     * @see https://learn.microsoft.com/en-us/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
@@ -1432,7 +1432,7 @@ export class BlockBlobClient extends BlobClient {
      * {@link uploadStream} or {@link uploadBrowserData} for better performance
      * with concurrency uploading.
      *
-     * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
+     * @see https://learn.microsoft.com/rest/api/storageservices/put-blob
      *
      * @param body - Blob, string, ArrayBuffer, ArrayBufferView or a function
      *                               which returns a new Readable stream whose offset is from data source beginning.
@@ -1508,7 +1508,7 @@ export class BlockBlobClient extends BlobClient {
     /**
      * Uploads the specified block to the block blob's "staging area" to be later
      * committed by a call to commitBlockList.
-     * @see https://docs.microsoft.com/rest/api/storageservices/put-block
+     * @see https://learn.microsoft.com/rest/api/storageservices/put-block
      *
      * @param blockId - A 64-byte value that is base64-encoded
      * @param body - Data to upload to the staging area.
@@ -1537,7 +1537,7 @@ export 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://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
+     * @see https://learn.microsoft.com/en-us/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
@@ -1576,7 +1576,7 @@ export class BlockBlobClient extends BlobClient {
      * to the server in a prior {@link stageBlock} operation. You can call {@link commitBlockList} to
      * update a blob by uploading only those blocks that have changed, then committing the new and existing
      * blocks together. Any blocks not specified in the block list and permanently deleted.
-     * @see https://docs.microsoft.com/rest/api/storageservices/put-block-list
+     * @see https://learn.microsoft.com/rest/api/storageservices/put-block-list
      *
      * @param blocks -  Array of 64-byte value that is base64-encoded
      * @param options - Options to the Block Blob Commit Block List operation.
@@ -1607,7 +1607,7 @@ export class BlockBlobClient extends BlobClient {
     /**
      * Returns the list of blocks that have been uploaded as part of a block blob
      * using the specified block list filter.
-     * @see https://docs.microsoft.com/rest/api/storageservices/get-block-list
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-block-list
      *
      * @param listType - Specifies whether to return the list of committed blocks,
      *                                        the list of uncommitted blocks, or both lists together.
@@ -1941,7 +1941,7 @@ export class PageBlobClient extends BlobClient {
     /**
      * Creates a page blob of the specified length. Call uploadPages to upload data
      * data to a page blob.
-     * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
+     * @see https://learn.microsoft.com/rest/api/storageservices/put-blob
      *
      * @param size - size of the page blob.
      * @param options - Options to the Page Blob Create operation.
@@ -1974,7 +1974,7 @@ export class PageBlobClient extends BlobClient {
      * Creates a page blob of the specified length. Call uploadPages to upload data
      * data to a page blob. If the blob with the same name already exists, the content
      * of the existing blob will remain unchanged.
-     * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
+     * @see https://learn.microsoft.com/rest/api/storageservices/put-blob
      *
      * @param size - size of the page blob.
      * @param options -
@@ -1997,7 +1997,7 @@ export class PageBlobClient extends BlobClient {
     }
     /**
      * Writes 1 or more pages to the page blob. The start and end offsets must be a multiple of 512.
-     * @see https://docs.microsoft.com/rest/api/storageservices/put-page
+     * @see https://learn.microsoft.com/rest/api/storageservices/put-page
      *
      * @param body - Data to upload
      * @param offset - Offset of destination page blob
@@ -2030,7 +2030,7 @@ export 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://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url
+     * @see https://learn.microsoft.com/en-us/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
@@ -2066,7 +2066,7 @@ export class PageBlobClient extends BlobClient {
     }
     /**
      * Frees the specified pages from the page blob.
-     * @see https://docs.microsoft.com/rest/api/storageservices/put-page
+     * @see https://learn.microsoft.com/rest/api/storageservices/put-page
      *
      * @param offset - Starting byte position of the pages to clear.
      * @param count - Number of bytes to clear.
@@ -2091,7 +2091,7 @@ export class PageBlobClient extends BlobClient {
     }
     /**
      * Returns the list of valid page ranges for a page blob or snapshot of a page blob.
-     * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
      *
      * @param offset - Starting byte position of the page ranges.
      * @param count - Number of bytes to get.
@@ -2117,7 +2117,7 @@ export class PageBlobClient extends BlobClient {
      * specified Marker. Use an empty Marker to start enumeration from the beginning.
      * After getting a segment, process it, and then call getPageRangesSegment again
      * (passing the the previously-returned Marker) to get the next segment.
-     * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
      *
      * @param offset - Starting byte position of the page ranges.
      * @param count - Number of bytes to get.
@@ -2194,7 +2194,7 @@ export class PageBlobClient extends BlobClient {
     }
     /**
      * Returns an async iterable iterator to list of page ranges for a page blob.
-     * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
      *
      *  .byPage() returns an async iterable iterator to list of page ranges for a page blob.
      *
@@ -2290,7 +2290,7 @@ export class PageBlobClient extends BlobClient {
     }
     /**
      * Gets the collection of page ranges that differ between a specified snapshot and this page blob.
-     * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
      *
      * @param offset - Starting byte position of the page blob
      * @param count - Number of bytes to get ranges diff.
@@ -2319,7 +2319,7 @@ export class PageBlobClient extends BlobClient {
      * Use an empty Marker to start enumeration from the beginning.
      * After getting a segment, process it, and then call getPageRangesDiffSegment again
      * (passing the the previously-returned Marker) to get the next segment.
-     * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
      *
      * @param offset - Starting byte position of the page ranges.
      * @param count - Number of bytes to get.
@@ -2404,7 +2404,7 @@ export class PageBlobClient extends BlobClient {
     }
     /**
      * Returns an async iterable iterator to list of page ranges that differ between a specified snapshot and this page blob.
-     * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
      *
      *  .byPage() returns an async iterable iterator to list of page ranges that differ between a specified snapshot and this page blob.
      *
@@ -2501,7 +2501,7 @@ export class PageBlobClient extends BlobClient {
     }
     /**
      * Gets the collection of page ranges that differ between a specified snapshot and this page blob for managed disks.
-     * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-page-ranges
      *
      * @param offset - Starting byte position of the page blob
      * @param count - Number of bytes to get ranges diff.
@@ -2526,7 +2526,7 @@ export class PageBlobClient extends BlobClient {
     }
     /**
      * Resizes the page blob to the specified size (which must be a multiple of 512).
-     * @see https://docs.microsoft.com/rest/api/storageservices/set-blob-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
      *
      * @param size - Target size
      * @param options - Options to the Page Blob Resize operation.
@@ -2547,7 +2547,7 @@ export class PageBlobClient extends BlobClient {
     }
     /**
      * Sets a page blob's sequence number.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
+     * @see https://learn.microsoft.com/en-us/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
@@ -2572,8 +2572,8 @@ export class PageBlobClient extends BlobClient {
      * The snapshot is copied such that only the differential changes between the previously
      * 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://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob
-     * @see https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
+     * @see https://learn.microsoft.com/rest/api/storageservices/incremental-copy-blob
+     * @see https://learn.microsoft.com/en-us/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>