@azure/storage-file-share 12.28.0-alpha.20250530.1 → 12.28.0-alpha.20250611.3

package/dist/commonjs/Clients.js

@@ -99,7 +99,7 @@ class ShareClient extends StorageClient_js_1.StorageClient {
     /**
      * Creates a new share under the specified account. If the share with
      * the same name already exists, the operation fails.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-share
+     * @see https://learn.microsoft.com/rest/api/storageservices/create-share
      *
      * @param options - Options to Share Create operation.
      * @returns Response data for the Share Create operation.
@@ -112,7 +112,7 @@ class ShareClient extends StorageClient_js_1.StorageClient {
     /**
      * Creates a new share under the specified account. If the share with
      * the same name already exists, it is not changed.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-share
+     * @see https://learn.microsoft.com/rest/api/storageservices/create-share
      *
      * @param options -
      */
@@ -155,7 +155,7 @@ class ShareClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Creates a new subdirectory under this share.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
+     * @see https://learn.microsoft.com/rest/api/storageservices/create-directory
      *
      * @param directoryName -
      * @param options - Options to Directory Create operation.
@@ -174,7 +174,7 @@ class ShareClient extends StorageClient_js_1.StorageClient {
     /**
      * Removes the specified empty sub directory under this share.
      * Note that the directory must be empty before it can be deleted.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
+     * @see https://learn.microsoft.com/rest/api/storageservices/delete-directory
      *
      * @param directoryName -
      * @param options - Options to Directory Delete operation.
@@ -189,7 +189,7 @@ class ShareClient extends StorageClient_js_1.StorageClient {
     /**
      * Creates a new file or replaces a file under the root directory of this share.
      * Note it only initializes the file with no content.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-file
+     * @see https://learn.microsoft.com/rest/api/storageservices/create-file
      *
      * @param fileName -
      * @param size - Specifies the maximum size in bytes for the file, up to 4 TB.
@@ -220,7 +220,7 @@ class ShareClient extends StorageClient_js_1.StorageClient {
      * a share. An attempt to perform this operation on a share snapshot will fail with 400
      * (`InvalidQueryParameterValue`)
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2
+     * @see https://learn.microsoft.com/rest/api/storageservices/delete-file2
      *
      * @param directoryName -
      * @param fileName -
@@ -260,7 +260,7 @@ class ShareClient extends StorageClient_js_1.StorageClient {
     /**
      * Returns all user-defined metadata and system properties for the specified
      * share.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-share-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-share-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
@@ -278,7 +278,7 @@ class ShareClient extends StorageClient_js_1.StorageClient {
     /**
      * Marks the specified share for deletion. The share and any directories or files
      * contained within it are later deleted during garbage collection.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-share
+     * @see https://learn.microsoft.com/rest/api/storageservices/delete-share
      *
      * @param options - Options to Share Delete operation.
      * @returns Response data for the Share Delete operation.
@@ -291,7 +291,7 @@ class ShareClient extends StorageClient_js_1.StorageClient {
     /**
      * Marks the specified share for deletion if it exists. The share and any directories or files
      * contained within it are later deleted during garbage collection.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-share
+     * @see https://learn.microsoft.com/rest/api/storageservices/delete-share
      *
      * @param options -
      */
@@ -315,7 +315,7 @@ class ShareClient extends StorageClient_js_1.StorageClient {
      *
      * If no option provided, or no metadata defined in the option parameter, the share
      * metadata will be removed.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-share-metadata
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-share-metadata
      *
      * @param metadata - If no metadata provided, all existing directory metadata will be removed.
      * @param option - Options to Share Set Metadata operation.
@@ -333,7 +333,7 @@ class ShareClient extends StorageClient_js_1.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://learn.microsoft.com/en-us/rest/api/storageservices/get-share-acl
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-share-acl
      *
      * @param option - Options to Share Get Access Policy operation.
      * @returns Response data for the Share Get Access Policy operation.
@@ -382,7 +382,7 @@ class ShareClient extends StorageClient_js_1.StorageClient {
      * When you establish a stored access policy on a share, 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://learn.microsoft.com/en-us/rest/api/storageservices/set-share-acl
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-share-acl
      *
      * @param shareAcl - Array of signed identifiers, each having a unique Id and details of access policy.
      * @param option - Options to Share Set Access Policy operation.
@@ -461,7 +461,7 @@ class ShareClient extends StorageClient_js_1.StorageClient {
     /**
      * Creates a file permission (a security descriptor) at the share level.
      * The created security descriptor can be used for the files/directories in the share.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-permission
+     * @see https://learn.microsoft.com/rest/api/storageservices/create-permission
      *
      * @param options - Options to Share Create Permission operation.
      * @param filePermission - File permission described in the SDDL
@@ -474,7 +474,7 @@ class ShareClient extends StorageClient_js_1.StorageClient {
     /**
      * Gets the Security Descriptor Definition Language (SDDL) for a given file permission key
      * which indicates a security descriptor.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-permission
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-permission
      *
      * @param options - Options to Share Create Permission operation.
      * @param filePermissionKey - File permission key which indicates the security descriptor of the permission.
@@ -499,7 +499,7 @@ class ShareClient extends StorageClient_js_1.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://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.
@@ -517,7 +517,7 @@ class ShareClient extends StorageClient_js_1.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://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.
@@ -580,7 +580,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Creates a new directory under the specified share or parent directory.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
+     * @see https://learn.microsoft.com/rest/api/storageservices/create-directory
      *
      * @param options - Options to Directory Create operation.
      * @returns Response data for the Directory  operation.
@@ -606,7 +606,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
     /**
      * Creates a new directory under the specified share or parent directory if it does not already exists.
      * If the directory already exists, it is not modified.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
+     * @see https://learn.microsoft.com/rest/api/storageservices/create-directory
      *
      * @param options -
      */
@@ -627,7 +627,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Sets properties on the directory.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-directory-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-directory-properties
      *
      * @param DirectoryProperties - Directory properties. If no values are provided,
      *                                            existing values will be preserved.
@@ -678,7 +678,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Creates a new subdirectory under this directory.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
+     * @see https://learn.microsoft.com/rest/api/storageservices/create-directory
      *
      * @param directoryName -
      * @param options - Options to Directory Create operation.
@@ -697,7 +697,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
     /**
      * Removes the specified empty sub directory under this directory.
      * Note that the directory must be empty before it can be deleted.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
+     * @see https://learn.microsoft.com/rest/api/storageservices/delete-directory
      *
      * @param directoryName -
      * @param options - Options to Directory Delete operation.
@@ -711,7 +711,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Creates a new file or replaces a file under this directory. Note it only initializes the file with no content.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-file
+     * @see https://learn.microsoft.com/rest/api/storageservices/create-file
      *
      * @param fileName -
      * @param size - Specifies the maximum size in bytes for the file, up to 4 TB.
@@ -740,7 +740,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
      * Delete File is not supported on a share snapshot, which is a read-only copy of
      * a share. An attempt to perform this operation on a share snapshot will fail with 400 (InvalidQueryParameterValue)
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2
+     * @see https://learn.microsoft.com/rest/api/storageservices/delete-file2
      *
      * @param fileName - Name of the file to delete
      * @param options - Options to File Delete operation.
@@ -819,7 +819,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
      * Returns all system properties for the specified directory, and can also be used to check the
      * existence of a directory. The data returned does not include the files in the directory or any
      * subdirectories.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-directory-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-directory-properties
      *
      * @param options - Options to Directory Get Properties operation.
      * @returns Response data for the Directory Get Properties operation.
@@ -838,7 +838,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
     /**
      * Removes the specified empty directory. Note that the directory must be empty before it can be
      * deleted.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
+     * @see https://learn.microsoft.com/rest/api/storageservices/delete-directory
      *
      * @param options - Options to Directory Delete operation.
      * @returns Response data for the Directory Delete operation.
@@ -851,7 +851,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
     /**
      * Removes the specified empty directory if it exists. Note that the directory must be empty before it can be
      * deleted.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
+     * @see https://learn.microsoft.com/rest/api/storageservices/delete-directory
      *
      * @param options -
      */
@@ -873,7 +873,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Updates user defined metadata for the specified directory.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-directory-metadata
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-directory-metadata
      *
      * @param metadata - If no metadata provided, all existing directory metadata will be removed
      * @param options - Options to Directory Set Metadata operation.
@@ -1136,7 +1136,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
     /**
      * Returns a list of files or directories under the specified share or directory. It lists the
      * contents only for a single level of the directory hierarchy.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-directories-and-files
+     * @see https://learn.microsoft.com/rest/api/storageservices/list-directories-and-files
      *
      * @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
      * @param options - Options to Directory List Files and Directories Segment operation.
@@ -1353,7 +1353,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Lists handles for a directory.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-handles
+     * @see https://learn.microsoft.com/rest/api/storageservices/list-handles
      *
      * @param marker - Optional. A string value that identifies the portion of the list to be
      *                          returned with the next list handles operation. The operation returns a
@@ -1377,7 +1377,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Force close all handles for a directory.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
+     * @see https://learn.microsoft.com/rest/api/storageservices/force-close-handles
      *
      * @param marker - Optional. A string value that identifies the position of handles that will
      *                          be closed with the next force close handles operation.
@@ -1398,7 +1398,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Force close all handles for a directory.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
+     * @see https://learn.microsoft.com/rest/api/storageservices/force-close-handles
      *
      * @param options -
      */
@@ -1425,7 +1425,7 @@ class ShareDirectoryClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Force close a specific handle for a directory.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
+     * @see https://learn.microsoft.com/rest/api/storageservices/force-close-handles
      *
      * @param aborter - Create a new Aborter instance with Aborter.none or Aborter.timeout(),
      *                          goto documents of Aborter for more examples about request cancellation
@@ -1570,7 +1570,7 @@ class ShareFileClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Creates a new file or replaces a file. Note it only initializes the file with no content.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-file
+     * @see https://learn.microsoft.com/rest/api/storageservices/create-file
      *
      * @param size - Specifies the maximum size in bytes for the file, up to 4 TB.
      * @param options - Options to File Create operation.
@@ -1631,7 +1631,7 @@ class ShareFileClient extends StorageClient_js_1.StorageClient {
      * * In Node.js, data returns in a Readable stream `readableStreamBody`
      * * In browsers, data returns in a promise `contentAsBlob`
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-file
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-file
      *
      * @param offset - From which position of the file 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
@@ -1786,7 +1786,7 @@ class ShareFileClient extends StorageClient_js_1.StorageClient {
     /**
      * Returns all user-defined metadata, standard HTTP properties, and system properties
      * for the file. It does not return the content of the file.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-file-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/get-file-properties
      *
      * @param options - Options to File Get Properties operation.
      * @returns Response data for the File Get Properties operation.
@@ -1805,7 +1805,7 @@ class ShareFileClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Sets properties on the file.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-file-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-file-properties
      *
      * @param properties - File properties. For file HTTP headers(e.g. Content-Type),
      *                                       if no values are provided, existing HTTP headers will be removed.
@@ -1840,7 +1840,7 @@ class ShareFileClient extends StorageClient_js_1.StorageClient {
      * Delete File is not supported on a share snapshot, which is a read-only copy of
      * a share. An attempt to perform this operation on a share snapshot will fail with 400 (InvalidQueryParameterValue)
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2
+     * @see https://learn.microsoft.com/rest/api/storageservices/delete-file2
      *
      * @param options - Options to File Delete operation.
      * @returns Response data for the File Delete operation.
@@ -1862,7 +1862,7 @@ class ShareFileClient extends StorageClient_js_1.StorageClient {
      * Delete File is not supported on a share snapshot, which is a read-only copy of
      * a share. An attempt to perform this operation on a share snapshot will fail with 400 (InvalidQueryParameterValue)
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2
+     * @see https://learn.microsoft.com/rest/api/storageservices/delete-file2
      *
      * @param options -
      */
@@ -1887,7 +1887,7 @@ class ShareFileClient extends StorageClient_js_1.StorageClient {
      *
      * If no option provided, or no value provided for the file HTTP headers in the options,
      * these file HTTP headers without a value will be cleared.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-file-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-file-properties
      *
      * @param FileHttpHeaders - File HTTP headers like Content-Type.
      *                                             Provide undefined will remove existing HTTP headers.
@@ -1913,7 +1913,7 @@ class ShareFileClient extends StorageClient_js_1.StorageClient {
     /**
      * Resize file.
      *
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-file-properties
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-file-properties
      *
      * @param length - Resizes a file to the specified size in bytes.
      *                        If the specified byte value is less than the current size of the file,
@@ -1943,7 +1943,7 @@ class ShareFileClient extends StorageClient_js_1.StorageClient {
      *
      * If no metadata defined in the option parameter, the file
      * metadata will be removed.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-file-metadata
+     * @see https://learn.microsoft.com/rest/api/storageservices/set-file-metadata
      *
      * @param metadata - If no metadata provided, all existing directory metadata will be removed
      * @param options - Options to File Set Metadata operation.
@@ -2096,7 +2096,7 @@ class ShareFileClient extends StorageClient_js_1.StorageClient {
     /**
      * Aborts a pending Copy File operation, and leaves a destination file with zero length and full
      * metadata.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/abort-copy-file
+     * @see https://learn.microsoft.com/rest/api/storageservices/abort-copy-file
      *
      * @param copyId - Id of the Copy File operation to abort.
      * @param options - Options to File Abort Copy From URL operation.
@@ -2429,7 +2429,7 @@ class ShareFileClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Lists handles for a file.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-handles
+     * @see https://learn.microsoft.com/rest/api/storageservices/list-handles
      *
      * @param marker - Optional. A string value that identifies the portion of the list to be
      *                          returned with the next list handles operation. The operation returns a
@@ -2539,7 +2539,7 @@ class ShareFileClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Force close all handles for a file.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
+     * @see https://learn.microsoft.com/rest/api/storageservices/force-close-handles
      *
      * @param marker - Optional. A string value that identifies the position of handles that will
      *                          be closed with the next force close handles operation.
@@ -2560,7 +2560,7 @@ class ShareFileClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Force close all handles for a file.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
+     * @see https://learn.microsoft.com/rest/api/storageservices/force-close-handles
      *
      * @param options - Options to force close handles operation.
      */
@@ -2587,7 +2587,7 @@ class ShareFileClient extends StorageClient_js_1.StorageClient {
     }
     /**
      * Force close a specific handle for a file.
-     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
+     * @see https://learn.microsoft.com/rest/api/storageservices/force-close-handles
      *
      * @param handleId - Specific handle ID, cannot be asterisk "*".
      *                          Use forceCloseAllHandles() to close all handles.
@@ -2665,7 +2665,7 @@ class ShareFileClient extends StorageClient_js_1.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://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.
@@ -2683,7 +2683,7 @@ class ShareFileClient extends StorageClient_js_1.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://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.