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

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

@@ -1,5 +1,5 @@
 import { __asyncDelegator, __asyncGenerator, __asyncValues, __await } from "tslib";
-import { getDefaultProxySettings, } from "@azure/core-rest-pipeline";
+import { getDefaultProxySettings } from "@azure/core-rest-pipeline";
 import { isNode } from "@azure/core-util";
 import { isTokenCredential } from "@azure/core-auth";
 import { AnonymousCredential } from "./credentials/AnonymousCredential";
@@ -10,7 +10,7 @@ import { tracingClient } from "./utils/tracing";
 import { appendToURLPath, appendToURLQuery, assertResponse, BlobNameToString, ConvertInternalResponseOfListBlobFlat, ConvertInternalResponseOfListBlobHierarchy, EscapePath, extractConnectionStringParts, isIpEndpointStyle, parseObjectReplicationRecord, toTags, truncatedISO8061Date, } from "./utils/utils.common";
 import { generateBlobSASQueryParameters, generateBlobSASQueryParametersInternal, } from "./sas/BlobSASSignatureValues";
 import { BlobLeaseClient } from "./BlobLeaseClient";
-import { AppendBlobClient, BlobClient, BlockBlobClient, PageBlobClient, } from "./Clients";
+import { AppendBlobClient, BlobClient, BlockBlobClient, PageBlobClient } from "./Clients";
 import { BlobBatchClient } from "./BlobBatchClient";
 /**
  * A ContainerClient represents a URL to the Azure Storage container allowing you to manipulate its blobs.
@@ -87,7 +87,7 @@ export class ContainerClient extends StorageClient {
     /**
      * Creates a new container under the specified account. If the container with
      * the same name already exists, the operation fails.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
      * Naming rules: @see https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
      *
      * @param options - Options to Container Create operation.
@@ -109,7 +109,7 @@ export class ContainerClient extends StorageClient {
     /**
      * Creates a new container under the specified account. If the container with
      * the same name already exists, it is not changed.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-container
      * Naming rules: @see https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
      *
      * @param options -
@@ -203,7 +203,7 @@ export class ContainerClient extends StorageClient {
     /**
      * Returns all user-defined metadata and system properties for the specified
      * container. The data returned does not include the container's list of blobs.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-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
@@ -223,7 +223,7 @@ export class ContainerClient extends StorageClient {
     /**
      * Marks the specified container for deletion. The container and any blobs
      * contained within it are later deleted during garbage collection.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container
      *
      * @param options - Options to Container Delete operation.
      */
@@ -243,7 +243,7 @@ export class ContainerClient extends StorageClient {
     /**
      * Marks the specified container for deletion if it exists. The container and any blobs
      * contained within it are later deleted during garbage collection.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-container
      *
      * @param options - Options to Container Delete operation.
      */
@@ -268,7 +268,7 @@ export class ContainerClient extends StorageClient {
      * If no option provided, or no metadata defined in the parameter, the container
      * metadata will be removed.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
      *
      * @param metadata - Replace existing metadata with this value.
      *                            If no value provided the existing metadata will be removed.
@@ -298,7 +298,7 @@ export class ContainerClient extends StorageClient {
      * WARNING: JavaScript Date will potentially lose precision when parsing startsOn and expiresOn strings.
      * 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-container-acl
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-container-acl
      *
      * @param options - Options to Container Get Access Policy operation.
      */
@@ -356,7 +356,7 @@ export class ContainerClient extends StorageClient {
      * When you establish a stored access policy on a container, it may take up to 30 seconds to take effect.
      * During this interval, a shared access signature that is associated with the stored access policy will
      * fail with status code 403 (Forbidden), until the access policy becomes active.
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-container-acl
      *
      * @param access - The level of public access to data in the container.
      * @param containerAcl - Array of elements each having a unique Id and details of the access policy.
@@ -411,7 +411,7 @@ export class ContainerClient extends StorageClient {
      * {@link BlockBlobClient.uploadStream} or {@link BlockBlobClient.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 blobName - Name of the block blob to create or update.
      * @param body - Blob, string, ArrayBuffer, ArrayBufferView or a function
@@ -436,7 +436,7 @@ export class ContainerClient 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 blobName -
      * @param options - Options to Blob Delete operation.
@@ -456,7 +456,7 @@ export class ContainerClient extends StorageClient {
      * specified Marker. Use an empty Marker to start enumeration from the beginning.
      * After getting a segment, process it, and then call listBlobsFlatSegment again
      * (passing the the previously-returned Marker) to get the next segment.
-     * @see https://docs.microsoft.com/rest/api/storageservices/list-blobs
+     * @see https://learn.microsoft.com/rest/api/storageservices/list-blobs
      *
      * @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
      * @param options - Options to Container List Blob Flat Segment operation.
@@ -476,7 +476,7 @@ export class ContainerClient extends StorageClient {
      * the specified Marker. Use an empty Marker to start enumeration from the
      * beginning. After getting a segment, process it, and then call listBlobsHierarchicalSegment
      * again (passing the the previously-returned Marker) to get the next segment.
-     * @see https://docs.microsoft.com/rest/api/storageservices/list-blobs
+     * @see https://learn.microsoft.com/rest/api/storageservices/list-blobs
      *
      * @param delimiter - The character or string used to define the virtual hierarchy
      * @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
@@ -1078,7 +1078,7 @@ export class ContainerClient 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.
@@ -1134,7 +1134,7 @@ export class ContainerClient extends StorageClient {
      * Generates a Blob Container 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.
@@ -1154,7 +1154,7 @@ export class ContainerClient extends StorageClient {
      * Generates string to sign for a Blob Container 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.
@@ -1170,7 +1170,7 @@ export class ContainerClient extends StorageClient {
      * Generates a Blob Container 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()`
@@ -1186,20 +1186,19 @@ export class ContainerClient extends StorageClient {
      * Generates string to sign for a Blob Container 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()`
      * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
      */
-    /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
     generateUserDelegationSasStringToSign(options, userDelegationKey) {
         return generateBlobSASQueryParametersInternal(Object.assign({ containerName: this._containerName }, options), userDelegationKey, this.accountName).stringToSign;
     }
     /**
      * Creates a BlobBatchClient object to conduct batch operations.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
      *
      * @returns A new BlobBatchClient object for this container.
      */