@azure/storage-file-share 12.20.0-alpha.20230720.6 → 12.20.0-alpha.20230721.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/dist/index.js +185 -74
  2. package/dist/index.js.map +1 -1
  3. package/dist-esm/storage-file-share/src/Clients.js +58 -51
  4. package/dist-esm/storage-file-share/src/Clients.js.map +1 -1
  5. package/dist-esm/storage-file-share/src/ShareServiceClient.js +7 -4
  6. package/dist-esm/storage-file-share/src/ShareServiceClient.js.map +1 -1
  7. package/dist-esm/storage-file-share/src/StorageClient.js +0 -4
  8. package/dist-esm/storage-file-share/src/StorageClient.js.map +1 -1
  9. package/dist-esm/storage-file-share/src/generated/src/models/index.js +6 -0
  10. package/dist-esm/storage-file-share/src/generated/src/models/index.js.map +1 -1
  11. package/dist-esm/storage-file-share/src/generated/src/models/parameters.js +31 -1
  12. package/dist-esm/storage-file-share/src/generated/src/models/parameters.js.map +1 -1
  13. package/dist-esm/storage-file-share/src/generated/src/operations/directory.js +29 -4
  14. package/dist-esm/storage-file-share/src/generated/src/operations/directory.js.map +1 -1
  15. package/dist-esm/storage-file-share/src/generated/src/operations/file.js +49 -8
  16. package/dist-esm/storage-file-share/src/generated/src/operations/file.js.map +1 -1
  17. package/dist-esm/storage-file-share/src/generated/src/operations/share.js +3 -1
  18. package/dist-esm/storage-file-share/src/generated/src/operations/share.js.map +1 -1
  19. package/dist-esm/storage-file-share/src/generated/src/storageClient.js +1 -1
  20. package/dist-esm/storage-file-share/src/generated/src/storageClient.js.map +1 -1
  21. package/dist-esm/storage-file-share/src/generatedModels.js +5 -1
  22. package/dist-esm/storage-file-share/src/generatedModels.js.map +1 -1
  23. package/dist-esm/storage-file-share/src/models.js.map +1 -1
  24. package/dist-esm/storage-file-share/src/utils/constants.js +1 -1
  25. package/dist-esm/storage-file-share/src/utils/constants.js.map +1 -1
  26. package/package.json +2 -1
  27. package/types/3.1/storage-file-share.d.ts +166 -12
  28. package/types/latest/storage-file-share.d.ts +170 -12
@@ -593,6 +593,10 @@ declare interface DirectoryCreateOptionalParams extends coreClient.OperationOpti
593
593
  metadata?: {
594
594
  [propertyName: string]: string;
595
595
  };
596
+ /** Valid value is backup */
597
+ fileRequestIntent?: ShareTokenIntent;
598
+ /** If true, the trailing dot will not be trimmed from the target URI. */
599
+ allowTrailingDot?: boolean;
596
600
  /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
597
601
  filePermission?: string;
598
602
  /** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
@@ -652,6 +656,10 @@ export declare interface DirectoryDeleteIfExistsResponse extends DirectoryDelete
652
656
  declare interface DirectoryDeleteOptionalParams extends coreClient.OperationOptions {
653
657
  /** 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> */
654
658
  timeoutInSeconds?: number;
659
+ /** Valid value is backup */
660
+ fileRequestIntent?: ShareTokenIntent;
661
+ /** If true, the trailing dot will not be trimmed from the target URI. */
662
+ allowTrailingDot?: boolean;
655
663
  }
656
664
 
657
665
  /**
@@ -708,6 +716,10 @@ declare interface DirectoryForceCloseHandlesOptionalParams extends coreClient.Op
708
716
  marker?: string;
709
717
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
710
718
  shareSnapshot?: string;
719
+ /** Valid value is backup */
720
+ fileRequestIntent?: ShareTokenIntent;
721
+ /** If true, the trailing dot will not be trimmed from the target URI. */
722
+ allowTrailingDot?: boolean;
711
723
  /** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
712
724
  recursive?: boolean;
713
725
  }
@@ -793,6 +805,10 @@ declare interface DirectoryGetPropertiesOptionalParams extends coreClient.Operat
793
805
  timeoutInSeconds?: number;
794
806
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
795
807
  shareSnapshot?: string;
808
+ /** Valid value is backup */
809
+ fileRequestIntent?: ShareTokenIntent;
810
+ /** If true, the trailing dot will not be trimmed from the target URI. */
811
+ allowTrailingDot?: boolean;
796
812
  }
797
813
 
798
814
  /**
@@ -883,6 +899,10 @@ declare interface DirectoryListFilesAndDirectoriesSegmentOptionalParams extends
883
899
  maxResults?: number;
884
900
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
885
901
  shareSnapshot?: string;
902
+ /** Valid value is backup */
903
+ fileRequestIntent?: ShareTokenIntent;
904
+ /** If true, the trailing dot will not be trimmed from the target URI. */
905
+ allowTrailingDot?: boolean;
886
906
  /** Include this parameter to specify one or more datasets to include in the response. */
887
907
  include?: ListFilesIncludeType[];
888
908
  /** Include extended information. */
@@ -919,6 +939,10 @@ declare interface DirectoryListHandlesOptionalParams extends coreClient.Operatio
919
939
  maxResults?: number;
920
940
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
921
941
  shareSnapshot?: string;
942
+ /** Valid value is backup */
943
+ fileRequestIntent?: ShareTokenIntent;
944
+ /** If true, the trailing dot will not be trimmed from the target URI. */
945
+ allowTrailingDot?: boolean;
922
946
  /** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
923
947
  recursive?: boolean;
924
948
  }
@@ -1024,6 +1048,10 @@ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOpti
1024
1048
  metadata?: {
1025
1049
  [propertyName: string]: string;
1026
1050
  };
1051
+ /** Valid value is backup */
1052
+ fileRequestIntent?: ShareTokenIntent;
1053
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1054
+ allowTrailingDot?: boolean;
1027
1055
  /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
1028
1056
  filePermission?: string;
1029
1057
  /** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
@@ -1032,6 +1060,8 @@ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOpti
1032
1060
  replaceIfExists?: boolean;
1033
1061
  /** 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. */
1034
1062
  ignoreReadOnly?: boolean;
1063
+ /** If true, the trailing dot will not be trimmed from the source URI. */
1064
+ allowSourceTrailingDot?: boolean;
1035
1065
  }
1036
1066
 
1037
1067
  /**
@@ -1118,6 +1148,10 @@ declare interface DirectorySetMetadataOptionalParams extends coreClient.Operatio
1118
1148
  metadata?: {
1119
1149
  [propertyName: string]: string;
1120
1150
  };
1151
+ /** Valid value is backup */
1152
+ fileRequestIntent?: ShareTokenIntent;
1153
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1154
+ allowTrailingDot?: boolean;
1121
1155
  }
1122
1156
 
1123
1157
  /**
@@ -1173,6 +1207,10 @@ export declare interface DirectorySetPropertiesHeaders {
1173
1207
  declare interface DirectorySetPropertiesOptionalParams extends coreClient.OperationOptions {
1174
1208
  /** 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> */
1175
1209
  timeoutInSeconds?: number;
1210
+ /** Valid value is backup */
1211
+ fileRequestIntent?: ShareTokenIntent;
1212
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1213
+ allowTrailingDot?: boolean;
1176
1214
  /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
1177
1215
  filePermission?: string;
1178
1216
  /** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
@@ -1363,6 +1401,10 @@ declare interface FileAbortCopyOptionalParams extends coreClient.OperationOption
1363
1401
  leaseAccessConditions?: LeaseAccessConditions;
1364
1402
  /** 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> */
1365
1403
  timeoutInSeconds?: number;
1404
+ /** Valid value is backup */
1405
+ fileRequestIntent?: ShareTokenIntent;
1406
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1407
+ allowTrailingDot?: boolean;
1366
1408
  }
1367
1409
 
1368
1410
  /** Contains response data for the abortCopy operation. */
@@ -1399,6 +1441,10 @@ declare interface FileAcquireLeaseOptionalParams extends coreClient.OperationOpt
1399
1441
  proposedLeaseId?: string;
1400
1442
  /** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
1401
1443
  requestId?: string;
1444
+ /** Valid value is backup */
1445
+ fileRequestIntent?: ShareTokenIntent;
1446
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1447
+ allowTrailingDot?: boolean;
1402
1448
  }
1403
1449
 
1404
1450
  /** Contains response data for the acquireLease operation. */
@@ -1518,6 +1564,10 @@ declare interface FileBreakLeaseOptionalParams extends coreClient.OperationOptio
1518
1564
  timeoutInSeconds?: number;
1519
1565
  /** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
1520
1566
  requestId?: string;
1567
+ /** Valid value is backup */
1568
+ fileRequestIntent?: ShareTokenIntent;
1569
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1570
+ allowTrailingDot?: boolean;
1521
1571
  }
1522
1572
 
1523
1573
  /** Contains response data for the breakLease operation. */
@@ -1549,6 +1599,10 @@ declare interface FileChangeLeaseOptionalParams extends coreClient.OperationOpti
1549
1599
  proposedLeaseId?: string;
1550
1600
  /** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
1551
1601
  requestId?: string;
1602
+ /** Valid value is backup */
1603
+ fileRequestIntent?: ShareTokenIntent;
1604
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1605
+ allowTrailingDot?: boolean;
1552
1606
  }
1553
1607
 
1554
1608
  /** Contains response data for the changeLease operation. */
@@ -1645,6 +1699,10 @@ declare interface FileCreateOptionalParams extends coreClient.OperationOptions {
1645
1699
  metadata?: {
1646
1700
  [propertyName: string]: string;
1647
1701
  };
1702
+ /** Valid value is backup */
1703
+ fileRequestIntent?: ShareTokenIntent;
1704
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1705
+ allowTrailingDot?: boolean;
1648
1706
  /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
1649
1707
  filePermission?: string;
1650
1708
  /** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
@@ -1714,6 +1772,10 @@ declare interface FileDeleteOptionalParams extends coreClient.OperationOptions {
1714
1772
  leaseAccessConditions?: LeaseAccessConditions;
1715
1773
  /** 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> */
1716
1774
  timeoutInSeconds?: number;
1775
+ /** Valid value is backup */
1776
+ fileRequestIntent?: ShareTokenIntent;
1777
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1778
+ allowTrailingDot?: boolean;
1717
1779
  }
1718
1780
 
1719
1781
  /**
@@ -1817,6 +1879,10 @@ export declare interface FileDownloadOptionalParams extends coreClient.Operation
1817
1879
  leaseAccessConditions?: LeaseAccessConditions;
1818
1880
  /** 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> */
1819
1881
  timeoutInSeconds?: number;
1882
+ /** Valid value is backup */
1883
+ fileRequestIntent?: ShareTokenIntent;
1884
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1885
+ allowTrailingDot?: boolean;
1820
1886
  /** Return file data only from the specified byte range. */
1821
1887
  range?: string;
1822
1888
  /** 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. */
@@ -1950,6 +2016,10 @@ declare interface FileForceCloseHandlesOptionalParams extends coreClient.Operati
1950
2016
  marker?: string;
1951
2017
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
1952
2018
  shareSnapshot?: string;
2019
+ /** Valid value is backup */
2020
+ fileRequestIntent?: ShareTokenIntent;
2021
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2022
+ allowTrailingDot?: boolean;
1953
2023
  }
1954
2024
 
1955
2025
  /**
@@ -2064,6 +2134,10 @@ declare interface FileGetPropertiesOptionalParams extends coreClient.OperationOp
2064
2134
  timeoutInSeconds?: number;
2065
2135
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2066
2136
  shareSnapshot?: string;
2137
+ /** Valid value is backup */
2138
+ fileRequestIntent?: ShareTokenIntent;
2139
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2140
+ allowTrailingDot?: boolean;
2067
2141
  }
2068
2142
 
2069
2143
  /**
@@ -2116,6 +2190,10 @@ declare interface FileGetRangeListOptionalParams extends coreClient.OperationOpt
2116
2190
  timeoutInSeconds?: number;
2117
2191
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2118
2192
  shareSnapshot?: string;
2193
+ /** Valid value is backup */
2194
+ fileRequestIntent?: ShareTokenIntent;
2195
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2196
+ allowTrailingDot?: boolean;
2119
2197
  /** Specifies the range of bytes over which to list ranges, inclusively. */
2120
2198
  range?: string;
2121
2199
  /** The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot. */
@@ -2260,6 +2338,10 @@ declare interface FileListHandlesOptionalParams extends coreClient.OperationOpti
2260
2338
  maxResults?: number;
2261
2339
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2262
2340
  shareSnapshot?: string;
2341
+ /** Valid value is backup */
2342
+ fileRequestIntent?: ShareTokenIntent;
2343
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2344
+ allowTrailingDot?: boolean;
2263
2345
  }
2264
2346
 
2265
2347
  export declare interface FileListHandlesOptions extends CommonOptions {
@@ -2401,6 +2483,10 @@ declare interface FileReleaseLeaseOptionalParams extends coreClient.OperationOpt
2401
2483
  timeoutInSeconds?: number;
2402
2484
  /** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
2403
2485
  requestId?: string;
2486
+ /** Valid value is backup */
2487
+ fileRequestIntent?: ShareTokenIntent;
2488
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2489
+ allowTrailingDot?: boolean;
2404
2490
  }
2405
2491
 
2406
2492
  /** Contains response data for the releaseLease operation. */
@@ -2452,6 +2538,10 @@ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
2452
2538
  metadata?: {
2453
2539
  [propertyName: string]: string;
2454
2540
  };
2541
+ /** Valid value is backup */
2542
+ fileRequestIntent?: ShareTokenIntent;
2543
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2544
+ allowTrailingDot?: boolean;
2455
2545
  /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
2456
2546
  filePermission?: string;
2457
2547
  /** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
@@ -2460,6 +2550,8 @@ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
2460
2550
  replaceIfExists?: boolean;
2461
2551
  /** 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. */
2462
2552
  ignoreReadOnly?: boolean;
2553
+ /** If true, the trailing dot will not be trimmed from the source URI. */
2554
+ allowSourceTrailingDot?: boolean;
2463
2555
  }
2464
2556
 
2465
2557
  /**
@@ -2716,6 +2808,10 @@ declare interface FileSetHttpHeadersOptionalParams extends coreClient.OperationO
2716
2808
  fileHttpHeaders?: FileHttpHeaders_2;
2717
2809
  /** 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> */
2718
2810
  timeoutInSeconds?: number;
2811
+ /** Valid value is backup */
2812
+ fileRequestIntent?: ShareTokenIntent;
2813
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2814
+ allowTrailingDot?: boolean;
2719
2815
  /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
2720
2816
  filePermission?: string;
2721
2817
  /** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
@@ -2777,6 +2873,10 @@ declare interface FileSetMetadataOptionalParams extends coreClient.OperationOpti
2777
2873
  metadata?: {
2778
2874
  [propertyName: string]: string;
2779
2875
  };
2876
+ /** Valid value is backup */
2877
+ fileRequestIntent?: ShareTokenIntent;
2878
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2879
+ allowTrailingDot?: boolean;
2780
2880
  }
2781
2881
 
2782
2882
  /**
@@ -2832,10 +2932,16 @@ declare interface FileStartCopyOptionalParams extends coreClient.OperationOption
2832
2932
  metadata?: {
2833
2933
  [propertyName: string]: string;
2834
2934
  };
2935
+ /** Valid value is backup */
2936
+ fileRequestIntent?: ShareTokenIntent;
2937
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2938
+ allowTrailingDot?: boolean;
2835
2939
  /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
2836
2940
  filePermission?: string;
2837
2941
  /** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
2838
2942
  filePermissionKey?: string;
2943
+ /** If true, the trailing dot will not be trimmed from the source URI. */
2944
+ allowSourceTrailingDot?: boolean;
2839
2945
  }
2840
2946
 
2841
2947
  /**
@@ -2973,6 +3079,10 @@ export declare interface FileUploadRangeFromURLOptionalParams extends coreClient
2973
3079
  sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
2974
3080
  /** 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> */
2975
3081
  timeoutInSeconds?: number;
3082
+ /** If true, the trailing dot will not be trimmed from the target URI. */
3083
+ allowTrailingDot?: boolean;
3084
+ /** If true, the trailing dot will not be trimmed from the source URI. */
3085
+ allowSourceTrailingDot?: boolean;
2976
3086
  /** If the file last write time should be preserved or overwritten */
2977
3087
  fileLastWrittenMode?: FileLastWrittenMode;
2978
3088
  /** Bytes of source data in the specified range. */
@@ -3057,6 +3167,10 @@ declare interface FileUploadRangeOptionalParams extends coreClient.OperationOpti
3057
3167
  leaseAccessConditions?: LeaseAccessConditions;
3058
3168
  /** 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> */
3059
3169
  timeoutInSeconds?: number;
3170
+ /** Valid value is backup */
3171
+ fileRequestIntent?: ShareTokenIntent;
3172
+ /** If true, the trailing dot will not be trimmed from the target URI. */
3173
+ allowTrailingDot?: boolean;
3060
3174
  /** Initial data. */
3061
3175
  body?: coreRestPipeline.RequestBodyType;
3062
3176
  /** An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5 header is specified, the File service compares the hash of the content that has arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). */
@@ -3249,6 +3363,11 @@ export declare interface HttpResponse {
3249
3363
  */
3250
3364
  export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
3251
3365
 
3366
+ /** Known values of {@link ShareTokenIntent} that the service accepts. */
3367
+ export declare enum KnownShareTokenIntent {
3368
+ Backup = "backup"
3369
+ }
3370
+
3252
3371
  /** Parameter group */
3253
3372
  export declare interface LeaseAccessConditions {
3254
3373
  /** If specified, the operation only succeeds if the resource's lease is active and matches this ID. */
@@ -4177,6 +4296,7 @@ export declare class ShareClient extends StorageClient {
4177
4296
  */
4178
4297
  private context;
4179
4298
  private _name;
4299
+ private shareClientConfig?;
4180
4300
  /**
4181
4301
  * The name of the share
4182
4302
  */
@@ -4191,7 +4311,7 @@ export declare class ShareClient extends StorageClient {
4191
4311
  * @param name - Share name.
4192
4312
  * @param options - Optional. Options to configure the HTTP pipeline.
4193
4313
  */
4194
- constructor(connectionString: string, name: string, options?: StoragePipelineOptions);
4314
+ constructor(connectionString: string, name: string, options?: ShareClientOptions);
4195
4315
  /**
4196
4316
  * Creates an instance of ShareClient.
4197
4317
  *
@@ -4203,7 +4323,8 @@ export declare class ShareClient extends StorageClient {
4203
4323
  * If not specified, AnonymousCredential is used.
4204
4324
  * @param options - Optional. Options to configure the HTTP pipeline.
4205
4325
  */
4206
- constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?: StoragePipelineOptions);
4326
+ constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: ShareClientOptions);
4327
+ constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?: ShareClientOptions);
4207
4328
  /**
4208
4329
  * Creates an instance of ShareClient.
4209
4330
  *
@@ -4214,7 +4335,7 @@ export declare class ShareClient extends StorageClient {
4214
4335
  * @param pipeline - Call newPipeline() to create a default
4215
4336
  * pipeline, or provide a customized pipeline.
4216
4337
  */
4217
- constructor(url: string, pipeline: Pipeline);
4338
+ constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
4218
4339
  /**
4219
4340
  * Creates a new ShareClient object identical to the source but with the specified snapshot timestamp.
4220
4341
  * Provide "" will remove the snapshot and return a URL to the base share.
@@ -4457,6 +4578,26 @@ export declare class ShareClient extends StorageClient {
4457
4578
  generateSasUrl(options: ShareGenerateSasUrlOptions): string;
4458
4579
  }
4459
4580
 
4581
+ export declare interface ShareClientConfig {
4582
+ /**
4583
+ * The Files OAuth over REST feature requires special permissions to be included in the role definition to use
4584
+ * These special permissions will give privileged access to file share data -
4585
+ * It will allow users to bypass file/directory level ACL/NTFS permissions and get read/write access to file share data
4586
+ * Since this additional permission can be unintended and to prevent unintended and over privileged access,
4587
+ * additional checks has been implemented that requires users to explicitly indicate their intent to use these additional permissions.
4588
+ * This is done using the fileRequestIntent option.
4589
+ * Currently, the only value that the header supports is 'backup'
4590
+ * 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.
4591
+ */
4592
+ fileRequestIntent?: ShareTokenIntent;
4593
+ /** If true, the trailing dot will not be trimmed from the target URI. */
4594
+ allowTrailingDot?: boolean;
4595
+ /** If true, the trailing dot will not be trimmed from the source URI. */
4596
+ allowSourceTrailingDot?: boolean;
4597
+ }
4598
+
4599
+ export declare type ShareClientOptions = StoragePipelineOptions & ShareClientConfig;
4600
+
4460
4601
  /** Defines headers for Share_create operation. */
4461
4602
  export declare interface ShareCreateHeaders {
4462
4603
  /** The ETag contains a value which represents the version of the share, in quotes. */
@@ -4555,6 +4696,8 @@ export declare interface ShareCreatePermissionHeaders {
4555
4696
  declare interface ShareCreatePermissionOptionalParams extends coreClient.OperationOptions {
4556
4697
  /** 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> */
4557
4698
  timeoutInSeconds?: number;
4699
+ /** Valid value is backup */
4700
+ fileRequestIntent?: ShareTokenIntent;
4558
4701
  }
4559
4702
 
4560
4703
  /**
@@ -4703,6 +4846,7 @@ export declare class ShareDirectoryClient extends StorageClient {
4703
4846
  private _shareName;
4704
4847
  private _path;
4705
4848
  private _name;
4849
+ private shareClientConfig?;
4706
4850
  /**
4707
4851
  * The share name corresponding to this directory client
4708
4852
  */
@@ -4730,7 +4874,7 @@ export declare class ShareDirectoryClient extends StorageClient {
4730
4874
  * If not specified, AnonymousCredential is used.
4731
4875
  * @param options - Optional. Options to configure the HTTP pipeline.
4732
4876
  */
4733
- constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
4877
+ constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
4734
4878
  /**
4735
4879
  * Creates an instance of DirectoryClient.
4736
4880
  *
@@ -4745,7 +4889,7 @@ export declare class ShareDirectoryClient extends StorageClient {
4745
4889
  * @param pipeline - Call newPipeline() to create a default
4746
4890
  * pipeline, or provide a customized pipeline.
4747
4891
  */
4748
- constructor(url: string, pipeline: Pipeline);
4892
+ constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
4749
4893
  /**
4750
4894
  * Creates a new directory under the specified share or parent directory.
4751
4895
  * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
@@ -5215,6 +5359,7 @@ export declare class ShareFileClient extends StorageClient {
5215
5359
  private _shareName;
5216
5360
  private _path;
5217
5361
  private _name;
5362
+ private shareClientConfig?;
5218
5363
  /**
5219
5364
  * The share name corresponding to this file client
5220
5365
  */
@@ -5238,11 +5383,11 @@ export declare class ShareFileClient extends StorageClient {
5238
5383
  * Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
5239
5384
  * However, if a file or directory name includes %, file or directory name must be encoded in the URL.
5240
5385
  * Such as a file named "myfile%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".
5241
- * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
5386
+ * @param credential - Such as , StorageSharedKeyCredential or TokenCredential,
5242
5387
  * If not specified, AnonymousCredential is used.
5243
5388
  * @param options - Optional. Options to configure the HTTP pipeline.
5244
5389
  */
5245
- constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
5390
+ constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
5246
5391
  /**
5247
5392
  * Creates an instance of ShareFileClient.
5248
5393
  *
@@ -5257,7 +5402,7 @@ export declare class ShareFileClient extends StorageClient {
5257
5402
  * @param pipeline - Call newPipeline() to create a default
5258
5403
  * pipeline, or provide a customized pipeline.
5259
5404
  */
5260
- constructor(url: string, pipeline: Pipeline);
5405
+ constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
5261
5406
  /**
5262
5407
  * Creates a new ShareFileClient object identical to the source but with the specified share snapshot timestamp.
5263
5408
  * Provide "" will remove the snapshot and return a URL to the base ShareFileClient.
@@ -5843,6 +5988,8 @@ export declare interface ShareGetPermissionHeaders {
5843
5988
  declare interface ShareGetPermissionOptionalParams extends coreClient.OperationOptions {
5844
5989
  /** 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> */
5845
5990
  timeoutInSeconds?: number;
5991
+ /** Valid value is backup */
5992
+ fileRequestIntent?: ShareTokenIntent;
5846
5993
  }
5847
5994
 
5848
5995
  /**
@@ -6317,6 +6464,7 @@ export declare class ShareServiceClient extends StorageClient {
6317
6464
  * serviceContext provided by protocol layer.
6318
6465
  */
6319
6466
  private serviceContext;
6467
+ private shareClientConfig?;
6320
6468
  /**
6321
6469
  *
6322
6470
  * Creates an instance of ShareServiceClient from connection string.
@@ -6330,18 +6478,18 @@ export declare class ShareServiceClient extends StorageClient {
6330
6478
  * @param options - Options to configure the HTTP pipeline.
6331
6479
  * @returns A new ShareServiceClient from the given connection string.
6332
6480
  */
6333
- static fromConnectionString(connectionString: string, options?: StoragePipelineOptions): ShareServiceClient;
6481
+ static fromConnectionString(connectionString: string, options?: ShareClientOptions): ShareServiceClient;
6334
6482
  /**
6335
6483
  * Creates an instance of ShareServiceClient.
6336
6484
  *
6337
6485
  * @param url - A URL string pointing to Azure Storage file service, such as
6338
6486
  * "https://myaccount.file.core.windows.net". You can Append a SAS
6339
6487
  * if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
6340
- * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
6488
+ * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential, or TokenCredential,
6341
6489
  * If not specified, AnonymousCredential is used.
6342
6490
  * @param options - Optional. Options to configure the HTTP pipeline.
6343
6491
  */
6344
- constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
6492
+ constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
6345
6493
  /**
6346
6494
  * Creates an instance of ShareServiceClient.
6347
6495
  *
@@ -6350,8 +6498,9 @@ export declare class ShareServiceClient extends StorageClient {
6350
6498
  * if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
6351
6499
  * @param pipeline - Call newPipeline() to create a default
6352
6500
  * pipeline, or provide a customized pipeline.
6501
+ * @param options - Optional. Options to configure the HTTP pipeline.
6353
6502
  */
6354
- constructor(url: string, pipeline: Pipeline);
6503
+ constructor(url: string, pipeline: Pipeline, options?: ShareClientOptions);
6355
6504
  /**
6356
6505
  * Creates a ShareClient object.
6357
6506
  *
@@ -6739,6 +6888,15 @@ export declare interface ShareStats {
6739
6888
  shareUsageBytes: number;
6740
6889
  }
6741
6890
 
6891
+ /**
6892
+ * Defines values for ShareTokenIntent. \
6893
+ * {@link KnownShareTokenIntent} can be used interchangeably with ShareTokenIntent,
6894
+ * this enum contains the known values that the service supports.
6895
+ * ### Known values supported by the service
6896
+ * **backup**
6897
+ */
6898
+ export declare type ShareTokenIntent = string;
6899
+
6742
6900
  /**
6743
6901
  * Signed Identifier
6744
6902
  */