@azure/storage-file-share 12.13.0-beta.1 → 12.14.0-beta.1

package/types/3.1/storage-file-share.d.ts

@@ -19,6 +19,7 @@ import { RequestPolicyFactory } from '@azure/core-http';
 import { RequestPolicyOptions } from '@azure/core-http';
 import { RestError } from '@azure/core-http';
 import { ServiceClientOptions } from '@azure/core-http';
+import { TokenCredential } from '@azure/core-http';
 import { TransferProgressEvent } from '@azure/core-http';
 import { UserAgentOptions } from '@azure/core-http';
 import { WebResource } from '@azure/core-http';
@@ -1276,6 +1277,10 @@ export declare interface FileDownloadOptionalParams extends coreHttp.OperationOp
     leaseAccessConditions?: LeaseAccessConditions;
     /** 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;
+    /** Valid value is backup */
+    fileRequestIntent?: ShareTokenIntent;
+    /** If true, the trailing dot will not be trimmed from the target URI. */
+    allowTrailingDot?: boolean;
     /** Return file data only from the specified byte range. */
     range?: string;
     /** When this header is set to true and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. */
@@ -2272,6 +2277,10 @@ export declare interface FileUploadRangeFromURLOptionalParams extends coreHttp.O
     sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
     /** 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;
+    /** If true, the trailing dot will not be trimmed from the target URI. */
+    allowTrailingDot?: boolean;
+    /** If true, the trailing dot will not be trimmed from the source URI. */
+    allowSourceTrailingDot?: boolean;
     /** If the file last write time should be preserved or overwritten */
     fileLastWrittenMode?: FileLastWrittenMode;
     /** Bytes of source data in the specified range. */
@@ -2481,6 +2490,10 @@ export { HttpHeaders };
 export { HttpOperationResponse };
 export { HttpRequestBody };
 export { IHttpClient };
+/** Known values of {@link ShareTokenIntent} that the service accepts. */
+export declare enum KnownShareTokenIntent {
+    Backup = "backup"
+}
 /** Parameter group */
 export declare interface LeaseAccessConditions {
     /** If specified, the operation only succeeds if the resource's lease is active and matches this ID. */
@@ -2624,7 +2637,7 @@ export declare interface Metrics {
  * @param pipelineOptions - Optional. Options.
  * @returns A new Pipeline object.
  */
-export declare function newPipeline(credential?: Credential_2, pipelineOptions?: StoragePipelineOptions): Pipeline;
+export declare function newPipeline(credential?: Credential_2 | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline;
 /** Defines values for PermissionCopyModeType. */
 export declare type PermissionCopyModeType = "source" | "override";
 /**
@@ -2667,6 +2680,10 @@ export declare interface PipelineOptions {
      * Optional. Configures the HTTP client to send requests and receive responses.
      */
     httpClient?: IHttpClient;
+    /**
+     * Intent of using TokenCredential in file requests.
+     */
+    shareTokenIntent?: ShareTokenIntent;
 }
 /**
  * Range for Service Operations.
@@ -3012,6 +3029,7 @@ export declare class ShareClient extends StorageClient {
      */
     private context;
     private _name;
+    private shareClientConfig?;
     /*
     * The name of the share
     */
@@ -3038,7 +3056,7 @@ export declare class ShareClient extends StorageClient {
      *                                  If not specified, AnonymousCredential is used.
      * @param options - Optional. Options to configure the HTTP pipeline.
      */
-    constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
+    constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
     /**
      * Creates an instance of ShareClient.
      *
@@ -3049,7 +3067,7 @@ export declare class ShareClient extends StorageClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
     /**
      * Creates a new ShareClient object identical to the source but with the specified snapshot timestamp.
      * Provide "" will remove the snapshot and return a URL to the base share.
@@ -3291,6 +3309,24 @@ export declare class ShareClient extends StorageClient {
      */
     generateSasUrl(options: ShareGenerateSasUrlOptions): string;
 }
+export declare interface ShareClientConfig {
+    /**
+     * The Files OAuth over REST feature requires special permissions to be included in the role definition to use
+     * These special permissions will give privileged access to file share data -
+     * It will allow users to bypass file/directory level ACL/NTFS permissions and get read/write access to file share data
+     * Since this additional permission can be unintended and to prevent unintended and over privileged access,
+     * additional checks has been implemented that requires users to explicitly indicate their intent to use these additional permissions.
+     * This is done using the fileRequestIntent option.
+     * Currently, the only value that the header supports is 'backup'
+     * Any user who wishes to use Files OAuth over REST feature has to call the API with the intent header. If the API is not called with the intent header, any subsequent data operation requests will be denied.
+     */
+    fileRequestIntent?: ShareTokenIntent;
+    /** If true, the trailing dot will not be trimmed from the target URI. */
+    allowTrailingDot?: boolean;
+    /** If true, the trailing dot will not be trimmed from the source URI. */
+    allowSourceTrailingDot?: boolean;
+}
+export declare type ShareClientOptions = StoragePipelineOptions & ShareClientConfig;
 /** Defines headers for Share_create operation. */
 export declare interface ShareCreateHeaders {
     /** The ETag contains a value which represents the version of the share, in quotes. */
@@ -3489,6 +3525,7 @@ export declare class ShareDirectoryClient extends StorageClient {
     private _shareName;
     private _path;
     private _name;
+    private shareClientConfig?;
     /*
     * The share name corresponding to this directory client
     */
@@ -3516,7 +3553,7 @@ export declare class ShareDirectoryClient extends StorageClient {
      *                                  If not specified, AnonymousCredential is used.
      * @param options - Optional. Options to configure the HTTP pipeline.
      */
-    constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
+    constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
     /**
      * Creates an instance of DirectoryClient.
      *
@@ -3531,7 +3568,7 @@ export declare class ShareDirectoryClient extends StorageClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
     /**
      * Creates a new directory under the specified share or parent directory.
      * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
@@ -3999,6 +4036,7 @@ export declare class ShareFileClient extends StorageClient {
     private _shareName;
     private _path;
     private _name;
+    private shareClientConfig?;
     /*
     * The share name corresponding to this file client
     */
@@ -4022,11 +4060,11 @@ export declare class ShareFileClient extends StorageClient {
      *                     Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
      *                     However, if a file or directory name includes %, file or directory name must be encoded in the URL.
      *                     Such as a file named "myfile%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".
-     * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
+     * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or TokenCredential,
      *                                  If not specified, AnonymousCredential is used.
      * @param options - Optional. Options to configure the HTTP pipeline.
      */
-    constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
+    constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
     /**
      * Creates an instance of ShareFileClient.
      *
@@ -4041,7 +4079,7 @@ export declare class ShareFileClient extends StorageClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
     /**
      * Creates a new ShareFileClient object identical to the source but with the specified share snapshot timestamp.
      * Provide "" will remove the snapshot and return a URL to the base ShareFileClient.
@@ -4984,6 +5022,7 @@ export declare class ShareServiceClient extends StorageClient {
      * serviceContext provided by protocol layer.
      */
     private serviceContext;
+    private shareClientConfig?;
     /**
      *
      * Creates an instance of ShareServiceClient from connection string.
@@ -4997,18 +5036,18 @@ export declare class ShareServiceClient extends StorageClient {
      * @param options - Options to configure the HTTP pipeline.
      * @returns A new ShareServiceClient from the given connection string.
      */
-    static fromConnectionString(connectionString: string, options?: StoragePipelineOptions): ShareServiceClient;
+    static fromConnectionString(connectionString: string, options?: ShareClientOptions): ShareServiceClient;
     /**
      * Creates an instance of ShareServiceClient.
      *
      * @param url - A URL string pointing to Azure Storage file service, such as
      *                     "https://myaccount.file.core.windows.net". You can Append a SAS
      *                     if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
-     * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
+     * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or TokenCredential.
      *                                  If not specified, AnonymousCredential is used.
      * @param options - Optional. Options to configure the HTTP pipeline.
      */
-    constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
+    constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
     /**
      * Creates an instance of ShareServiceClient.
      *
@@ -5017,8 +5056,10 @@ export declare class ShareServiceClient extends StorageClient {
      *                     if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
+     * @param options - Optional. Options to configure the HTTP pipeline.
+     * @param fileRequestIntent - Optional. File request intent.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
     /**
      * Creates a ShareClient object.
      *
@@ -5364,6 +5405,14 @@ export declare interface ShareStats {
     /** The approximate size of the data stored in bytes. Note that this value may not include all recently created or recently resized files. */
     shareUsageBytes: number;
 }
+/**
+ * Defines values for ShareTokenIntent. \
+ * {@link KnownShareTokenIntent} can be used interchangeably with ShareTokenIntent,
+ *  this enum contains the known values that the service supports.
+ * ### Know values supported by the service
+ * **backup**
+ */
+export declare type ShareTokenIntent = string;
 /**
  * Signed Identifier
  */

package/types/latest/storage-file-share.d.ts

@@ -20,6 +20,7 @@ import { RequestPolicyFactory } from '@azure/core-http';
 import { RequestPolicyOptions } from '@azure/core-http';
 import { RestError } from '@azure/core-http';
 import { ServiceClientOptions } from '@azure/core-http';
+import { TokenCredential } from '@azure/core-http';
 import { TransferProgressEvent } from '@azure/core-http';
 import { UserAgentOptions } from '@azure/core-http';
 import { WebResource } from '@azure/core-http';
@@ -1348,6 +1349,10 @@ export declare interface FileDownloadOptionalParams extends coreHttp.OperationOp
     leaseAccessConditions?: LeaseAccessConditions;
     /** 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;
+    /** Valid value is backup */
+    fileRequestIntent?: ShareTokenIntent;
+    /** If true, the trailing dot will not be trimmed from the target URI. */
+    allowTrailingDot?: boolean;
     /** Return file data only from the specified byte range. */
     range?: string;
     /** When this header is set to true and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. */
@@ -2391,6 +2396,10 @@ export declare interface FileUploadRangeFromURLOptionalParams extends coreHttp.O
     sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
     /** 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;
+    /** If true, the trailing dot will not be trimmed from the target URI. */
+    allowTrailingDot?: boolean;
+    /** If true, the trailing dot will not be trimmed from the source URI. */
+    allowSourceTrailingDot?: boolean;
     /** If the file last write time should be preserved or overwritten */
     fileLastWrittenMode?: FileLastWrittenMode;
     /** Bytes of source data in the specified range. */
@@ -2615,6 +2624,11 @@ export { HttpRequestBody }
 
 export { IHttpClient }
 
+/** Known values of {@link ShareTokenIntent} that the service accepts. */
+export declare enum KnownShareTokenIntent {
+    Backup = "backup"
+}
+
 /** Parameter group */
 export declare interface LeaseAccessConditions {
     /** If specified, the operation only succeeds if the resource's lease is active and matches this ID. */
@@ -2773,7 +2787,7 @@ export declare interface Metrics {
  * @param pipelineOptions - Optional. Options.
  * @returns A new Pipeline object.
  */
-export declare function newPipeline(credential?: Credential_2, pipelineOptions?: StoragePipelineOptions): Pipeline;
+export declare function newPipeline(credential?: Credential_2 | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline;
 
 /** Defines values for PermissionCopyModeType. */
 export declare type PermissionCopyModeType = "source" | "override";
@@ -2819,6 +2833,10 @@ export declare interface PipelineOptions {
      * Optional. Configures the HTTP client to send requests and receive responses.
      */
     httpClient?: IHttpClient;
+    /**
+     * Intent of using TokenCredential in file requests.
+     */
+    shareTokenIntent?: ShareTokenIntent;
 }
 
 /**
@@ -3188,6 +3206,7 @@ export declare class ShareClient extends StorageClient {
      */
     private context;
     private _name;
+    private shareClientConfig?;
     /**
      * The name of the share
      */
@@ -3214,7 +3233,7 @@ export declare class ShareClient extends StorageClient {
      *                                  If not specified, AnonymousCredential is used.
      * @param options - Optional. Options to configure the HTTP pipeline.
      */
-    constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
+    constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
     /**
      * Creates an instance of ShareClient.
      *
@@ -3225,7 +3244,7 @@ export declare class ShareClient extends StorageClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
     /**
      * Creates a new ShareClient object identical to the source but with the specified snapshot timestamp.
      * Provide "" will remove the snapshot and return a URL to the base share.
@@ -3468,6 +3487,26 @@ export declare class ShareClient extends StorageClient {
     generateSasUrl(options: ShareGenerateSasUrlOptions): string;
 }
 
+export declare interface ShareClientConfig {
+    /**
+     * The Files OAuth over REST feature requires special permissions to be included in the role definition to use
+     * These special permissions will give privileged access to file share data -
+     * It will allow users to bypass file/directory level ACL/NTFS permissions and get read/write access to file share data
+     * Since this additional permission can be unintended and to prevent unintended and over privileged access,
+     * additional checks has been implemented that requires users to explicitly indicate their intent to use these additional permissions.
+     * This is done using the fileRequestIntent option.
+     * Currently, the only value that the header supports is 'backup'
+     * Any user who wishes to use Files OAuth over REST feature has to call the API with the intent header. If the API is not called with the intent header, any subsequent data operation requests will be denied.
+     */
+    fileRequestIntent?: ShareTokenIntent;
+    /** If true, the trailing dot will not be trimmed from the target URI. */
+    allowTrailingDot?: boolean;
+    /** If true, the trailing dot will not be trimmed from the source URI. */
+    allowSourceTrailingDot?: boolean;
+}
+
+export declare type ShareClientOptions = StoragePipelineOptions & ShareClientConfig;
+
 /** Defines headers for Share_create operation. */
 export declare interface ShareCreateHeaders {
     /** The ETag contains a value which represents the version of the share, in quotes. */
@@ -3680,6 +3719,7 @@ export declare class ShareDirectoryClient extends StorageClient {
     private _shareName;
     private _path;
     private _name;
+    private shareClientConfig?;
     /**
      * The share name corresponding to this directory client
      */
@@ -3707,7 +3747,7 @@ export declare class ShareDirectoryClient extends StorageClient {
      *                                  If not specified, AnonymousCredential is used.
      * @param options - Optional. Options to configure the HTTP pipeline.
      */
-    constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
+    constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
     /**
      * Creates an instance of DirectoryClient.
      *
@@ -3722,7 +3762,7 @@ export declare class ShareDirectoryClient extends StorageClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
     /**
      * Creates a new directory under the specified share or parent directory.
      * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
@@ -4192,6 +4232,7 @@ export declare class ShareFileClient extends StorageClient {
     private _shareName;
     private _path;
     private _name;
+    private shareClientConfig?;
     /**
      * The share name corresponding to this file client
      */
@@ -4215,11 +4256,11 @@ export declare class ShareFileClient extends StorageClient {
      *                     Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
      *                     However, if a file or directory name includes %, file or directory name must be encoded in the URL.
      *                     Such as a file named "myfile%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".
-     * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
+     * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or TokenCredential,
      *                                  If not specified, AnonymousCredential is used.
      * @param options - Optional. Options to configure the HTTP pipeline.
      */
-    constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
+    constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
     /**
      * Creates an instance of ShareFileClient.
      *
@@ -4234,7 +4275,7 @@ export declare class ShareFileClient extends StorageClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
     /**
      * Creates a new ShareFileClient object identical to the source but with the specified share snapshot timestamp.
      * Provide "" will remove the snapshot and return a URL to the base ShareFileClient.
@@ -5204,6 +5245,7 @@ export declare class ShareServiceClient extends StorageClient {
      * serviceContext provided by protocol layer.
      */
     private serviceContext;
+    private shareClientConfig?;
     /**
      *
      * Creates an instance of ShareServiceClient from connection string.
@@ -5217,18 +5259,18 @@ export declare class ShareServiceClient extends StorageClient {
      * @param options - Options to configure the HTTP pipeline.
      * @returns A new ShareServiceClient from the given connection string.
      */
-    static fromConnectionString(connectionString: string, options?: StoragePipelineOptions): ShareServiceClient;
+    static fromConnectionString(connectionString: string, options?: ShareClientOptions): ShareServiceClient;
     /**
      * Creates an instance of ShareServiceClient.
      *
      * @param url - A URL string pointing to Azure Storage file service, such as
      *                     "https://myaccount.file.core.windows.net". You can Append a SAS
      *                     if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
-     * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
+     * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or TokenCredential.
      *                                  If not specified, AnonymousCredential is used.
      * @param options - Optional. Options to configure the HTTP pipeline.
      */
-    constructor(url: string, credential?: Credential_2, options?: StoragePipelineOptions);
+    constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
     /**
      * Creates an instance of ShareServiceClient.
      *
@@ -5237,8 +5279,10 @@ export declare class ShareServiceClient extends StorageClient {
      *                     if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
+     * @param options - Optional. Options to configure the HTTP pipeline.
+     * @param fileRequestIntent - Optional. File request intent.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
     /**
      * Creates a ShareClient object.
      *
@@ -5599,6 +5643,15 @@ export declare interface ShareStats {
     shareUsageBytes: number;
 }
 
+/**
+ * Defines values for ShareTokenIntent. \
+ * {@link KnownShareTokenIntent} can be used interchangeably with ShareTokenIntent,
+ *  this enum contains the known values that the service supports.
+ * ### Know values supported by the service
+ * **backup**
+ */
+export declare type ShareTokenIntent = string;
+
 /**
  * Signed Identifier
  */