@azure/storage-file-datalake 12.25.0-beta.1 → 12.26.0-alpha.20250319.1

package/dist-esm/storage-file-datalake/src/clients.js

@@ -1,5 +1,3 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
 import { isTokenCredential } from "@azure/core-auth";
 import { isNode } from "@azure/core-util";
 import { isPipelineLike, newPipeline } from "./Pipeline";
@@ -152,7 +150,7 @@ export class DataLakePathClient extends StorageClient {
     /**
      * Create a directory or path.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
      *
      * @param resourceType - Resource type, "directory" or "file".
      * @param options - Optional. Options when creating path.
@@ -181,7 +179,7 @@ export class DataLakePathClient extends StorageClient {
     /**
      * Create a directory or file. If the resource already exists, it is not changed.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
      *
      * @param resourceType - Resource type, "directory" or "file".
      * @param options -
@@ -219,7 +217,7 @@ export class DataLakePathClient extends StorageClient {
     /**
      * Delete current path (directory or file).
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
      *
      * @param recursive - Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted.
      * @param options - Optional. Options when deleting path.
@@ -253,7 +251,7 @@ export class DataLakePathClient extends StorageClient {
     /**
      * Delete current path (directory or file) if it exists.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
      *
      * @param recursive - Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted.
      * @param options -
@@ -277,7 +275,7 @@ export class DataLakePathClient extends StorageClient {
     /**
      * Returns the access control data for a path (directory of file).
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties
      *
      * @param options - Optional. Options when getting file access control.
      */
@@ -291,7 +289,7 @@ export class DataLakePathClient extends StorageClient {
     /**
      * Set the access control data for a path (directory of file).
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
      *
      * @param acl - The POSIX access control list for the file or directory.
      * @param options - Optional. Options when setting path access control.
@@ -305,7 +303,7 @@ export class DataLakePathClient extends StorageClient {
     /**
      * Sets the Access Control on a path and sub paths.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
      *
      * @param acl - The POSIX access control list for the file or directory.
      * @param options - Optional. Options
@@ -318,7 +316,7 @@ export class DataLakePathClient extends StorageClient {
     /**
      * Modifies the Access Control on a path and sub paths.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
      *
      * @param acl - The POSIX access control list for the file or directory.
      * @param options - Optional. Options
@@ -331,7 +329,7 @@ export class DataLakePathClient extends StorageClient {
     /**
      * Removes the Access Control on a path and sub paths.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
      *
      * @param acl - The POSIX access control list for the file or directory.
      * @param options - Optional. Options
@@ -344,7 +342,7 @@ export class DataLakePathClient extends StorageClient {
     /**
      * Sets the file permissions on a path.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
      *
      * @param permissions - The POSIX access permissions for the file owner, the file owning group, and others.
      * @param options - Optional. Options when setting path permissions.
@@ -364,7 +362,7 @@ export class DataLakePathClient extends StorageClient {
      * the methods of {@link DataLakeFileSystemClient} that list paths using the `includeMetadata` option, which
      * will retain their original casing.
      *
-     * @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
      *
      * @param options - Optional. Options when getting path properties.
      */
@@ -379,7 +377,7 @@ export class DataLakePathClient 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 httpHeaders -
      * @param options -
@@ -402,7 +400,7 @@ export class DataLakePathClient extends StorageClient {
      * If no option provided, or no metadata defined in the parameter, the path
      * 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 - Optional. Replace existing metadata with this value.
      *                              If no value provided the existing metadata will be removed.
@@ -507,7 +505,7 @@ export class DataLakeDirectoryClient extends DataLakePathClient {
      * 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.
@@ -525,7 +523,7 @@ export class DataLakeDirectoryClient extends DataLakePathClient {
      * Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
      * and parameters passed in.
      *
-     * @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.
@@ -541,7 +539,7 @@ export class DataLakeDirectoryClient extends DataLakePathClient {
      * Generates a 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()`
@@ -557,13 +555,12 @@ export class DataLakeDirectoryClient extends DataLakePathClient {
      * 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 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 generateDataLakeSASQueryParametersInternal(Object.assign({ fileSystemName: this.fileSystemName, pathName: this.name, isDirectory: true }, options), userDelegationKey, this.accountName).stringToSign;
     }
@@ -626,7 +623,7 @@ export class DataLakeFileClient extends DataLakePathClient {
      * * In Node.js, data returns in a Readable stream readableStreamBody
      * * In browsers, data returns in a promise contentAsBlob
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob
      *
      * * Example usage (Node.js):
      *
@@ -640,7 +637,7 @@ export class DataLakeFileClient extends DataLakePathClient {
      *   return new Promise((resolve, reject) => {
      *     const chunks = [];
      *     readableStream.on("data", (data) => {
-     *       chunks.push(data instanceof Buffer ? data : Buffer.from(data));
+     *       chunks.push(typeof data === "string" ? Buffer.from(data) : data);
      *     });
      *     readableStream.on("end", () => {
      *       resolve(Buffer.concat(chunks));
@@ -693,7 +690,7 @@ export class DataLakeFileClient extends DataLakePathClient {
      * Uploads data to be appended to a file. Data can only be appended to a file.
      * To apply perviously uploaded data to a file, call flush.
      *
-     * @see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
      *
      * @param body - Content to be uploaded.
      * @param offset - Append offset in bytes.
@@ -1020,7 +1017,7 @@ export class DataLakeFileClient extends DataLakePathClient {
      *   return new Promise((resolve, reject) => {
      *     const chunks = [];
      *     readableStream.on("data", (data) => {
-     *       chunks.push(data instanceof Buffer ? data : Buffer.from(data));
+     *       chunks.push(typeof data === "string" ? Buffer.from(data) : data);
      *     });
      *     readableStream.on("end", () => {
      *       resolve(Buffer.concat(chunks));
@@ -1085,7 +1082,7 @@ export class DataLakeFileClient extends DataLakePathClient {
      * 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.
@@ -1105,7 +1102,7 @@ export class DataLakeFileClient extends DataLakePathClient {
      * 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.
@@ -1121,7 +1118,7 @@ export class DataLakeFileClient extends DataLakePathClient {
      * Generates a 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()`
@@ -1137,13 +1134,12 @@ export class DataLakeFileClient extends DataLakePathClient {
      * 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 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 generateDataLakeSASQueryParametersInternal(Object.assign({ fileSystemName: this.fileSystemName, pathName: this.name }, options), userDelegationKey, this.accountName).stringToSign;
     }