@azure/storage-file-share 12.9.0-beta.1 → 12.9.0-beta.4

package/{typings → types}/latest/storage-file-share.d.ts

@@ -335,16 +335,16 @@ export declare interface CommonOptions {
 
 /** Parameter group */
 export declare interface CopyFileSmbInfo {
-    /** Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key. */
-    filePermissionCopyMode?: PermissionCopyModeType;
-    /** Specifies the option to overwrite the target file if it already exists and has read-only attribute set. */
-    ignoreReadOnly?: boolean;
     /** Specifies either the option to copy file attributes from a source file(source) to a target file or a list of attributes to set on a target file. */
     fileAttributes?: string;
     /** Specifies either the option to copy file creation time from a source file(source) to a target file or a time value in ISO 8601 format to set as creation time on a target file. */
     fileCreationTime?: string;
     /** Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file. */
     fileLastWriteTime?: string;
+    /** Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key. */
+    filePermissionCopyMode?: PermissionCopyModeType;
+    /** Specifies the option to overwrite the target file if it already exists and has read-only attribute set. */
+    ignoreReadOnly?: boolean;
     /** Specifies the option to set archive attribute on a target file. True means archive attribute will be set on a target file despite attribute overrides or a source file state. */
     setArchiveAttribute?: boolean;
 }
@@ -815,6 +815,99 @@ export declare interface DirectoryProperties extends FileAndDirectorySetProperti
     abortSignal?: AbortSignalLike;
 }
 
+/** Defines headers for Directory_rename operation. */
+export declare interface DirectoryRenameHeaders {
+    /** The ETag contains a value which represents the version of the file, in quotes. */
+    etag?: string;
+    /** Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */
+    lastModified?: Date;
+    /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
+    requestId?: string;
+    /** Indicates the version of the File service used to execute the request. */
+    version?: string;
+    /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
+    date?: Date;
+    /** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */
+    isServerEncrypted?: boolean;
+    /** Key of the permission set for the file. */
+    filePermissionKey?: string;
+    /** Attributes set for the file. */
+    fileAttributes?: string;
+    /** Creation time for the file. */
+    fileCreationTime?: Date;
+    /** Last write time for the file. */
+    fileLastWriteTime?: Date;
+    /** Change time for the file. */
+    fileChangeTime?: Date;
+    /** The fileId of the file. */
+    fileId?: string;
+    /** The parent fileId of the directory. */
+    fileParentId?: string;
+}
+
+/**
+ * Options to configure the {@link ShareDirectoryClient.rename} operation.
+ */
+export declare interface DirectoryRenameOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the @azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+    /**
+     * Lease access condition for source file. Required if the source file has an active infinite lease.
+     */
+    sourceLeaseAccessConditions?: LeaseAccessConditions;
+    /**
+     * Lease access condition for destination file. Required if the destination file has an active infinite lease.
+     */
+    destinationLeaseAccessConditions?: LeaseAccessConditions;
+    /**
+     * Optional.
+     * Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key.
+     */
+    copyFileSmbInfo?: CopyFileSmbInfo;
+    /**
+     * Optional.
+     * The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a>
+     */
+    timeoutInSeconds?: number;
+    /**
+     * Optional.
+     * A name-value pair to associate with a file storage object.
+     */
+    metadata?: Metadata;
+    /**
+     * Optional.
+     * If specified the permission (security descriptor) shall be set for the directory/file.
+     */
+    filePermission?: string;
+    /**
+     * Optional.
+     * Key of the permission to be set for the directory/file. Note: Only one of the filePermission or filePermissionKey should be specified.
+     */
+    filePermissionKey?: string;
+    /**
+     * Optional.
+     * A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value.
+     */
+    replaceIfExists?: boolean;
+    /**
+     * Optional.
+     * A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail.
+     */
+    ignoreReadOnly?: boolean;
+}
+
+/** Contains response data for the rename operation. */
+export declare type DirectoryRenameResponse = DirectoryRenameHeaders & {
+    /** The underlying HTTP response. */
+    _response: coreHttp.HttpResponse & {
+        /** The parsed HTTP response headers. */
+        parsedHeaders: DirectoryRenameHeaders;
+    };
+};
+
 /** Defines headers for Directory_setMetadata operation. */
 export declare interface DirectorySetMetadataHeaders {
     /** The ETag contains a value which represents the version of the directory, in quotes. */
@@ -1429,7 +1522,7 @@ export declare interface FileGetPropertiesHeaders {
         [propertyName: string]: string;
     };
     /** Returns the type File. Reserved for future use. */
-    fileType?: FileType;
+    fileType?: string;
     /** The size of the file in bytes. This header returns the value of the 'x-ms-content-length' header that is stored with the file. */
     contentLength?: number;
     /** The content type specified for the file. The default content type is 'application/octet-stream' */
@@ -1779,6 +1872,98 @@ export declare interface FileProperty {
     etag?: string;
 }
 
+/** Defines headers for File_rename operation. */
+export declare interface FileRenameHeaders {
+    /** The ETag contains a value which represents the version of the file, in quotes. */
+    etag?: string;
+    /** Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */
+    lastModified?: Date;
+    /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
+    requestId?: string;
+    /** Indicates the version of the File service used to execute the request. */
+    version?: string;
+    /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
+    date?: Date;
+    /** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */
+    isServerEncrypted?: boolean;
+    /** Key of the permission set for the file. */
+    filePermissionKey?: string;
+    /** Attributes set for the file. */
+    fileAttributes?: string;
+    /** Creation time for the file. */
+    fileCreationTime?: Date;
+    /** Last write time for the file. */
+    fileLastWriteTime?: Date;
+    /** Change time for the file. */
+    fileChangeTime?: Date;
+    /** The fileId of the file. */
+    fileId?: string;
+    /** The parent fileId of the directory. */
+    fileParentId?: string;
+}
+
+/**
+ * Options to configure the {@link ShareFileClient.rename} operation.
+ */
+export declare interface FileRenameOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+    /**
+     * Lease access condition for source file. Required if the source file has an active infinite lease.
+     */
+    sourceLeaseAccessConditions?: LeaseAccessConditions;
+    /**
+     * Lease access condition for destination file. Required if the destination file has an active infinite lease.
+     */
+    destinationLeaseAccessConditions?: LeaseAccessConditions;
+    /**
+     * Optional.
+     * Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key.
+     */
+    copyFileSmbInfo?: CopyFileSmbInfo;
+    /**
+     * A name-value pair to associate with a file storage object.
+     */
+    metadata?: Metadata;
+    /**
+     * Optional.
+     * The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a>
+     */
+    timeoutInSeconds?: number;
+    /**
+     * Optional.
+     * If specified the permission (security descriptor) shall be set for the directory/file.
+     */
+    filePermission?: string;
+    /**
+     * Optional.
+     * Key of the permission to be set for the directory/file. Note: Only one of the filePermission or filePermissionKey should be specified.
+     */
+    filePermissionKey?: string;
+    /**
+     * Optional.
+     * A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value.
+     */
+    replaceIfExists?: boolean;
+    /**
+     * Optional.
+     * A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail.
+     */
+    ignoreReadOnly?: boolean;
+}
+
+/** Contains response data for the rename operation. */
+export declare type FileRenameResponse = FileRenameHeaders & {
+    /** The underlying HTTP response. */
+    _response: coreHttp.HttpResponse & {
+        /** The parsed HTTP response headers. */
+        parsedHeaders: FileRenameHeaders;
+    };
+};
+
 /**
  * Options to configure the {@link ShareFileClient.resize} operation.
  */
@@ -2147,14 +2332,6 @@ export declare class FileSystemAttributes {
     toString(): string;
 }
 
-/**
- * Defines values for FileType.
- * Possible values include: 'File'
- * @readonly
- * @enum {string}
- */
-export declare type FileType = "File";
-
 /** Defines headers for File_uploadRangeFromURL operation. */
 export declare interface FileUploadRangeFromURLHeaders {
     /** The ETag contains a value which represents the version of the file, in quotes. */
@@ -3917,6 +4094,27 @@ export declare class ShareDirectoryClient extends StorageClient {
      * @param options -
      */
     forceCloseHandle(handleId: string, options?: DirectoryForceCloseHandlesOptions): Promise<DirectoryForceCloseHandlesResponse>;
+    /**
+     * Renames a directory.
+     * This API only supports renaming a directory in the same share.
+     *
+     * @param destinationPath - Specifies the destination path to rename to. The path will be encoded to put into a URL to specify the destination.
+     * @param options - Options for the renaming operation.
+     * @returns Response data for the file renaming operation.
+     *
+     * Example usage:
+     *
+     * ```js
+     *
+     * // Rename the directory
+     * await diretoryClient.rename(destinationPath);
+     * console.log("Renamed directory successfully!");
+     * ```
+     */
+    rename(destinationPath: string, options?: DirectoryRenameOptions): Promise<{
+        destinationDirectoryClient: ShareDirectoryClient;
+        directoryRenameResponse: DirectoryRenameResponse;
+    }>;
 }
 
 /**
@@ -4472,6 +4670,27 @@ export declare class ShareFileClient extends StorageClient {
      * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
      */
     generateSasUrl(options: FileGenerateSasUrlOptions): string;
+    /**
+     * Renames a file.
+     * This API only supports renaming a file in the same share.
+     *
+     * @param destinationPath - Specifies the destination path to rename to. The path will be encoded to put into a URL to specify the destination.
+     * @param options - Options for the renaming operation.
+     * @returns Response data for the file renaming operation.
+     *
+     * Example usage:
+     *
+     * ```js
+     *
+     * // Rename the file
+     * await fileClient.rename(destinationPath);
+     * console.log("Renamed file successfully!");
+     * ```
+     */
+    rename(destinationPath: string, options?: FileRenameOptions): Promise<{
+        destinationFileClient: ShareFileClient;
+        fileRenameResponse: FileRenameResponse;
+    }>;
 }
 
 /** The list of file ranges */
@@ -4605,6 +4824,8 @@ export declare interface ShareGetPropertiesHeaders {
     provisionedEgressMBps?: number;
     /** Returns the current share next allowed quota downgrade time. */
     nextAllowedQuotaDowngradeTime?: Date;
+    /** Returns the current share provisioned bandwidth in megabits per second. */
+    provisionedBandwidthMibps?: number;
     /** When a share is leased, specifies whether the lease is of infinite or fixed duration. */
     leaseDuration?: LeaseDurationType;
     /** Lease state of the share. */
@@ -4839,6 +5060,7 @@ export declare interface SharePropertiesInternal {
     provisionedIops?: number;
     provisionedIngressMBps?: number;
     provisionedEgressMBps?: number;
+    provisionedBandwidthMiBps?: number;
     nextAllowedQuotaDowngradeTime?: Date;
     deletedTime?: Date;
     remainingRetentionDays?: number;