@azure/storage-file-share 12.20.0-alpha.20230720.6 → 12.20.0-alpha.20230724.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 (30) hide show
  1. package/dist/index.js +200 -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/mappers.js +15 -0
  12. package/dist-esm/storage-file-share/src/generated/src/models/mappers.js.map +1 -1
  13. package/dist-esm/storage-file-share/src/generated/src/models/parameters.js +31 -1
  14. package/dist-esm/storage-file-share/src/generated/src/models/parameters.js.map +1 -1
  15. package/dist-esm/storage-file-share/src/generated/src/operations/directory.js +29 -4
  16. package/dist-esm/storage-file-share/src/generated/src/operations/directory.js.map +1 -1
  17. package/dist-esm/storage-file-share/src/generated/src/operations/file.js +49 -8
  18. package/dist-esm/storage-file-share/src/generated/src/operations/file.js.map +1 -1
  19. package/dist-esm/storage-file-share/src/generated/src/operations/share.js +3 -1
  20. package/dist-esm/storage-file-share/src/generated/src/operations/share.js.map +1 -1
  21. package/dist-esm/storage-file-share/src/generated/src/storageClient.js +1 -1
  22. package/dist-esm/storage-file-share/src/generated/src/storageClient.js.map +1 -1
  23. package/dist-esm/storage-file-share/src/generatedModels.js +5 -1
  24. package/dist-esm/storage-file-share/src/generatedModels.js.map +1 -1
  25. package/dist-esm/storage-file-share/src/models.js.map +1 -1
  26. package/dist-esm/storage-file-share/src/utils/constants.js +1 -1
  27. package/dist-esm/storage-file-share/src/utils/constants.js.map +1 -1
  28. package/package.json +2 -1
  29. package/types/3.1/storage-file-share.d.ts +172 -12
  30. package/types/latest/storage-file-share.d.ts +178 -12
@@ -33,6 +33,9 @@ export declare interface AccessPolicy {
33
33
  permissions?: string;
34
34
  }
35
35
 
36
+ /** Defines values for AccessRight. */
37
+ declare type AccessRight = "Read" | "Write" | "Delete";
38
+
36
39
  /**
37
40
  * ONLY AVAILABLE IN NODE.JS RUNTIME.
38
41
  *
@@ -593,6 +596,10 @@ declare interface DirectoryCreateOptionalParams extends coreClient.OperationOpti
593
596
  metadata?: {
594
597
  [propertyName: string]: string;
595
598
  };
599
+ /** Valid value is backup */
600
+ fileRequestIntent?: ShareTokenIntent;
601
+ /** If true, the trailing dot will not be trimmed from the target URI. */
602
+ allowTrailingDot?: boolean;
596
603
  /** 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
604
  filePermission?: string;
598
605
  /** 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 +659,10 @@ export declare interface DirectoryDeleteIfExistsResponse extends DirectoryDelete
652
659
  declare interface DirectoryDeleteOptionalParams extends coreClient.OperationOptions {
653
660
  /** 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
661
  timeoutInSeconds?: number;
662
+ /** Valid value is backup */
663
+ fileRequestIntent?: ShareTokenIntent;
664
+ /** If true, the trailing dot will not be trimmed from the target URI. */
665
+ allowTrailingDot?: boolean;
655
666
  }
656
667
 
657
668
  /**
@@ -708,6 +719,10 @@ declare interface DirectoryForceCloseHandlesOptionalParams extends coreClient.Op
708
719
  marker?: string;
709
720
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
710
721
  shareSnapshot?: string;
722
+ /** Valid value is backup */
723
+ fileRequestIntent?: ShareTokenIntent;
724
+ /** If true, the trailing dot will not be trimmed from the target URI. */
725
+ allowTrailingDot?: boolean;
711
726
  /** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
712
727
  recursive?: boolean;
713
728
  }
@@ -793,6 +808,10 @@ declare interface DirectoryGetPropertiesOptionalParams extends coreClient.Operat
793
808
  timeoutInSeconds?: number;
794
809
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
795
810
  shareSnapshot?: string;
811
+ /** Valid value is backup */
812
+ fileRequestIntent?: ShareTokenIntent;
813
+ /** If true, the trailing dot will not be trimmed from the target URI. */
814
+ allowTrailingDot?: boolean;
796
815
  }
797
816
 
798
817
  /**
@@ -883,6 +902,10 @@ declare interface DirectoryListFilesAndDirectoriesSegmentOptionalParams extends
883
902
  maxResults?: number;
884
903
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
885
904
  shareSnapshot?: string;
905
+ /** Valid value is backup */
906
+ fileRequestIntent?: ShareTokenIntent;
907
+ /** If true, the trailing dot will not be trimmed from the target URI. */
908
+ allowTrailingDot?: boolean;
886
909
  /** Include this parameter to specify one or more datasets to include in the response. */
887
910
  include?: ListFilesIncludeType[];
888
911
  /** Include extended information. */
@@ -919,6 +942,10 @@ declare interface DirectoryListHandlesOptionalParams extends coreClient.Operatio
919
942
  maxResults?: number;
920
943
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
921
944
  shareSnapshot?: string;
945
+ /** Valid value is backup */
946
+ fileRequestIntent?: ShareTokenIntent;
947
+ /** If true, the trailing dot will not be trimmed from the target URI. */
948
+ allowTrailingDot?: boolean;
922
949
  /** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
923
950
  recursive?: boolean;
924
951
  }
@@ -1024,6 +1051,10 @@ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOpti
1024
1051
  metadata?: {
1025
1052
  [propertyName: string]: string;
1026
1053
  };
1054
+ /** Valid value is backup */
1055
+ fileRequestIntent?: ShareTokenIntent;
1056
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1057
+ allowTrailingDot?: boolean;
1027
1058
  /** 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
1059
  filePermission?: string;
1029
1060
  /** 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 +1063,8 @@ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOpti
1032
1063
  replaceIfExists?: boolean;
1033
1064
  /** 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
1065
  ignoreReadOnly?: boolean;
1066
+ /** If true, the trailing dot will not be trimmed from the source URI. */
1067
+ allowSourceTrailingDot?: boolean;
1035
1068
  }
1036
1069
 
1037
1070
  /**
@@ -1118,6 +1151,10 @@ declare interface DirectorySetMetadataOptionalParams extends coreClient.Operatio
1118
1151
  metadata?: {
1119
1152
  [propertyName: string]: string;
1120
1153
  };
1154
+ /** Valid value is backup */
1155
+ fileRequestIntent?: ShareTokenIntent;
1156
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1157
+ allowTrailingDot?: boolean;
1121
1158
  }
1122
1159
 
1123
1160
  /**
@@ -1173,6 +1210,10 @@ export declare interface DirectorySetPropertiesHeaders {
1173
1210
  declare interface DirectorySetPropertiesOptionalParams extends coreClient.OperationOptions {
1174
1211
  /** 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
1212
  timeoutInSeconds?: number;
1213
+ /** Valid value is backup */
1214
+ fileRequestIntent?: ShareTokenIntent;
1215
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1216
+ allowTrailingDot?: boolean;
1176
1217
  /** 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
1218
  filePermission?: string;
1178
1219
  /** 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 +1404,10 @@ declare interface FileAbortCopyOptionalParams extends coreClient.OperationOption
1363
1404
  leaseAccessConditions?: LeaseAccessConditions;
1364
1405
  /** 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
1406
  timeoutInSeconds?: number;
1407
+ /** Valid value is backup */
1408
+ fileRequestIntent?: ShareTokenIntent;
1409
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1410
+ allowTrailingDot?: boolean;
1366
1411
  }
1367
1412
 
1368
1413
  /** Contains response data for the abortCopy operation. */
@@ -1399,6 +1444,10 @@ declare interface FileAcquireLeaseOptionalParams extends coreClient.OperationOpt
1399
1444
  proposedLeaseId?: string;
1400
1445
  /** 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
1446
  requestId?: string;
1447
+ /** Valid value is backup */
1448
+ fileRequestIntent?: ShareTokenIntent;
1449
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1450
+ allowTrailingDot?: boolean;
1402
1451
  }
1403
1452
 
1404
1453
  /** Contains response data for the acquireLease operation. */
@@ -1518,6 +1567,10 @@ declare interface FileBreakLeaseOptionalParams extends coreClient.OperationOptio
1518
1567
  timeoutInSeconds?: number;
1519
1568
  /** 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
1569
  requestId?: string;
1570
+ /** Valid value is backup */
1571
+ fileRequestIntent?: ShareTokenIntent;
1572
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1573
+ allowTrailingDot?: boolean;
1521
1574
  }
1522
1575
 
1523
1576
  /** Contains response data for the breakLease operation. */
@@ -1549,6 +1602,10 @@ declare interface FileChangeLeaseOptionalParams extends coreClient.OperationOpti
1549
1602
  proposedLeaseId?: string;
1550
1603
  /** 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
1604
  requestId?: string;
1605
+ /** Valid value is backup */
1606
+ fileRequestIntent?: ShareTokenIntent;
1607
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1608
+ allowTrailingDot?: boolean;
1552
1609
  }
1553
1610
 
1554
1611
  /** Contains response data for the changeLease operation. */
@@ -1645,6 +1702,10 @@ declare interface FileCreateOptionalParams extends coreClient.OperationOptions {
1645
1702
  metadata?: {
1646
1703
  [propertyName: string]: string;
1647
1704
  };
1705
+ /** Valid value is backup */
1706
+ fileRequestIntent?: ShareTokenIntent;
1707
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1708
+ allowTrailingDot?: boolean;
1648
1709
  /** 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
1710
  filePermission?: string;
1650
1711
  /** 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 +1775,10 @@ declare interface FileDeleteOptionalParams extends coreClient.OperationOptions {
1714
1775
  leaseAccessConditions?: LeaseAccessConditions;
1715
1776
  /** 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
1777
  timeoutInSeconds?: number;
1778
+ /** Valid value is backup */
1779
+ fileRequestIntent?: ShareTokenIntent;
1780
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1781
+ allowTrailingDot?: boolean;
1717
1782
  }
1718
1783
 
1719
1784
  /**
@@ -1817,6 +1882,10 @@ export declare interface FileDownloadOptionalParams extends coreClient.Operation
1817
1882
  leaseAccessConditions?: LeaseAccessConditions;
1818
1883
  /** 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
1884
  timeoutInSeconds?: number;
1885
+ /** Valid value is backup */
1886
+ fileRequestIntent?: ShareTokenIntent;
1887
+ /** If true, the trailing dot will not be trimmed from the target URI. */
1888
+ allowTrailingDot?: boolean;
1820
1889
  /** Return file data only from the specified byte range. */
1821
1890
  range?: string;
1822
1891
  /** 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 +2019,10 @@ declare interface FileForceCloseHandlesOptionalParams extends coreClient.Operati
1950
2019
  marker?: string;
1951
2020
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
1952
2021
  shareSnapshot?: string;
2022
+ /** Valid value is backup */
2023
+ fileRequestIntent?: ShareTokenIntent;
2024
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2025
+ allowTrailingDot?: boolean;
1953
2026
  }
1954
2027
 
1955
2028
  /**
@@ -2064,6 +2137,10 @@ declare interface FileGetPropertiesOptionalParams extends coreClient.OperationOp
2064
2137
  timeoutInSeconds?: number;
2065
2138
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2066
2139
  shareSnapshot?: string;
2140
+ /** Valid value is backup */
2141
+ fileRequestIntent?: ShareTokenIntent;
2142
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2143
+ allowTrailingDot?: boolean;
2067
2144
  }
2068
2145
 
2069
2146
  /**
@@ -2116,6 +2193,10 @@ declare interface FileGetRangeListOptionalParams extends coreClient.OperationOpt
2116
2193
  timeoutInSeconds?: number;
2117
2194
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2118
2195
  shareSnapshot?: string;
2196
+ /** Valid value is backup */
2197
+ fileRequestIntent?: ShareTokenIntent;
2198
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2199
+ allowTrailingDot?: boolean;
2119
2200
  /** Specifies the range of bytes over which to list ranges, inclusively. */
2120
2201
  range?: string;
2121
2202
  /** The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot. */
@@ -2260,6 +2341,10 @@ declare interface FileListHandlesOptionalParams extends coreClient.OperationOpti
2260
2341
  maxResults?: number;
2261
2342
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2262
2343
  shareSnapshot?: string;
2344
+ /** Valid value is backup */
2345
+ fileRequestIntent?: ShareTokenIntent;
2346
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2347
+ allowTrailingDot?: boolean;
2263
2348
  }
2264
2349
 
2265
2350
  export declare interface FileListHandlesOptions extends CommonOptions {
@@ -2401,6 +2486,10 @@ declare interface FileReleaseLeaseOptionalParams extends coreClient.OperationOpt
2401
2486
  timeoutInSeconds?: number;
2402
2487
  /** 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
2488
  requestId?: string;
2489
+ /** Valid value is backup */
2490
+ fileRequestIntent?: ShareTokenIntent;
2491
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2492
+ allowTrailingDot?: boolean;
2404
2493
  }
2405
2494
 
2406
2495
  /** Contains response data for the releaseLease operation. */
@@ -2452,6 +2541,10 @@ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
2452
2541
  metadata?: {
2453
2542
  [propertyName: string]: string;
2454
2543
  };
2544
+ /** Valid value is backup */
2545
+ fileRequestIntent?: ShareTokenIntent;
2546
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2547
+ allowTrailingDot?: boolean;
2455
2548
  /** 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
2549
  filePermission?: string;
2457
2550
  /** 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 +2553,8 @@ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
2460
2553
  replaceIfExists?: boolean;
2461
2554
  /** 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
2555
  ignoreReadOnly?: boolean;
2556
+ /** If true, the trailing dot will not be trimmed from the source URI. */
2557
+ allowSourceTrailingDot?: boolean;
2463
2558
  }
2464
2559
 
2465
2560
  /**
@@ -2716,6 +2811,10 @@ declare interface FileSetHttpHeadersOptionalParams extends coreClient.OperationO
2716
2811
  fileHttpHeaders?: FileHttpHeaders_2;
2717
2812
  /** 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
2813
  timeoutInSeconds?: number;
2814
+ /** Valid value is backup */
2815
+ fileRequestIntent?: ShareTokenIntent;
2816
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2817
+ allowTrailingDot?: boolean;
2719
2818
  /** 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
2819
  filePermission?: string;
2721
2820
  /** 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 +2876,10 @@ declare interface FileSetMetadataOptionalParams extends coreClient.OperationOpti
2777
2876
  metadata?: {
2778
2877
  [propertyName: string]: string;
2779
2878
  };
2879
+ /** Valid value is backup */
2880
+ fileRequestIntent?: ShareTokenIntent;
2881
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2882
+ allowTrailingDot?: boolean;
2780
2883
  }
2781
2884
 
2782
2885
  /**
@@ -2832,10 +2935,16 @@ declare interface FileStartCopyOptionalParams extends coreClient.OperationOption
2832
2935
  metadata?: {
2833
2936
  [propertyName: string]: string;
2834
2937
  };
2938
+ /** Valid value is backup */
2939
+ fileRequestIntent?: ShareTokenIntent;
2940
+ /** If true, the trailing dot will not be trimmed from the target URI. */
2941
+ allowTrailingDot?: boolean;
2835
2942
  /** 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
2943
  filePermission?: string;
2837
2944
  /** 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
2945
  filePermissionKey?: string;
2946
+ /** If true, the trailing dot will not be trimmed from the source URI. */
2947
+ allowSourceTrailingDot?: boolean;
2839
2948
  }
2840
2949
 
2841
2950
  /**
@@ -2973,6 +3082,10 @@ export declare interface FileUploadRangeFromURLOptionalParams extends coreClient
2973
3082
  sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
2974
3083
  /** 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
3084
  timeoutInSeconds?: number;
3085
+ /** If true, the trailing dot will not be trimmed from the target URI. */
3086
+ allowTrailingDot?: boolean;
3087
+ /** If true, the trailing dot will not be trimmed from the source URI. */
3088
+ allowSourceTrailingDot?: boolean;
2976
3089
  /** If the file last write time should be preserved or overwritten */
2977
3090
  fileLastWrittenMode?: FileLastWrittenMode;
2978
3091
  /** Bytes of source data in the specified range. */
@@ -3057,6 +3170,10 @@ declare interface FileUploadRangeOptionalParams extends coreClient.OperationOpti
3057
3170
  leaseAccessConditions?: LeaseAccessConditions;
3058
3171
  /** 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
3172
  timeoutInSeconds?: number;
3173
+ /** Valid value is backup */
3174
+ fileRequestIntent?: ShareTokenIntent;
3175
+ /** If true, the trailing dot will not be trimmed from the target URI. */
3176
+ allowTrailingDot?: boolean;
3060
3177
  /** Initial data. */
3061
3178
  body?: coreRestPipeline.RequestBodyType;
3062
3179
  /** 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). */
@@ -3180,6 +3297,7 @@ export declare interface HandleItem {
3180
3297
  openTime: Date;
3181
3298
  /** Time handle was last connected to (UTC) */
3182
3299
  lastReconnectTime?: Date;
3300
+ accessRightList?: ShareFileHandleAccessRights[];
3183
3301
  }
3184
3302
 
3185
3303
  /** A listed Azure Storage handle item. */
@@ -3199,6 +3317,7 @@ declare interface HandleItem_2 {
3199
3317
  openTime: Date;
3200
3318
  /** Time handle was last connected to (UTC) */
3201
3319
  lastReconnectTime?: Date;
3320
+ accessRightList?: AccessRight[];
3202
3321
  }
3203
3322
 
3204
3323
  /**
@@ -3249,6 +3368,11 @@ export declare interface HttpResponse {
3249
3368
  */
3250
3369
  export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
3251
3370
 
3371
+ /** Known values of {@link ShareTokenIntent} that the service accepts. */
3372
+ export declare enum KnownShareTokenIntent {
3373
+ Backup = "backup"
3374
+ }
3375
+
3252
3376
  /** Parameter group */
3253
3377
  export declare interface LeaseAccessConditions {
3254
3378
  /** If specified, the operation only succeeds if the resource's lease is active and matches this ID. */
@@ -4177,6 +4301,7 @@ export declare class ShareClient extends StorageClient {
4177
4301
  */
4178
4302
  private context;
4179
4303
  private _name;
4304
+ private shareClientConfig?;
4180
4305
  /**
4181
4306
  * The name of the share
4182
4307
  */
@@ -4191,7 +4316,7 @@ export declare class ShareClient extends StorageClient {
4191
4316
  * @param name - Share name.
4192
4317
  * @param options - Optional. Options to configure the HTTP pipeline.
4193
4318
  */
4194
- constructor(connectionString: string, name: string, options?: StoragePipelineOptions);
4319
+ constructor(connectionString: string, name: string, options?: ShareClientOptions);
4195
4320
  /**
4196
4321
  * Creates an instance of ShareClient.
4197
4322
  *
@@ -4203,7 +4328,8 @@ export declare class ShareClient extends StorageClient {
4203
4328
  * If not specified, AnonymousCredential is used.
4204
4329
  * @param options - Optional. Options to configure the HTTP pipeline.
4205
4330
  */
4206
- constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?: StoragePipelineOptions);
4331
+ constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: ShareClientOptions);
4332
+ constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?: ShareClientOptions);
4207
4333
  /**
4208
4334
  * Creates an instance of ShareClient.
4209
4335
  *
@@ -4214,7 +4340,7 @@ export declare class ShareClient extends StorageClient {
4214
4340
  * @param pipeline - Call newPipeline() to create a default
4215
4341
  * pipeline, or provide a customized pipeline.
4216
4342
  */
4217
- constructor(url: string, pipeline: Pipeline);
4343
+ constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
4218
4344
  /**
4219
4345
  * Creates a new ShareClient object identical to the source but with the specified snapshot timestamp.
4220
4346
  * Provide "" will remove the snapshot and return a URL to the base share.
@@ -4457,6 +4583,26 @@ export declare class ShareClient extends StorageClient {
4457
4583
  generateSasUrl(options: ShareGenerateSasUrlOptions): string;
4458
4584
  }
4459
4585
 
4586
+ export declare interface ShareClientConfig {
4587
+ /**
4588
+ * The Files OAuth over REST feature requires special permissions to be included in the role definition to use
4589
+ * These special permissions will give privileged access to file share data -
4590
+ * It will allow users to bypass file/directory level ACL/NTFS permissions and get read/write access to file share data
4591
+ * Since this additional permission can be unintended and to prevent unintended and over privileged access,
4592
+ * additional checks has been implemented that requires users to explicitly indicate their intent to use these additional permissions.
4593
+ * This is done using the fileRequestIntent option.
4594
+ * Currently, the only value that the header supports is 'backup'
4595
+ * 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.
4596
+ */
4597
+ fileRequestIntent?: ShareTokenIntent;
4598
+ /** If true, the trailing dot will not be trimmed from the target URI. */
4599
+ allowTrailingDot?: boolean;
4600
+ /** If true, the trailing dot will not be trimmed from the source URI. */
4601
+ allowSourceTrailingDot?: boolean;
4602
+ }
4603
+
4604
+ export declare type ShareClientOptions = StoragePipelineOptions & ShareClientConfig;
4605
+
4460
4606
  /** Defines headers for Share_create operation. */
4461
4607
  export declare interface ShareCreateHeaders {
4462
4608
  /** The ETag contains a value which represents the version of the share, in quotes. */
@@ -4555,6 +4701,8 @@ export declare interface ShareCreatePermissionHeaders {
4555
4701
  declare interface ShareCreatePermissionOptionalParams extends coreClient.OperationOptions {
4556
4702
  /** 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
4703
  timeoutInSeconds?: number;
4704
+ /** Valid value is backup */
4705
+ fileRequestIntent?: ShareTokenIntent;
4558
4706
  }
4559
4707
 
4560
4708
  /**
@@ -4703,6 +4851,7 @@ export declare class ShareDirectoryClient extends StorageClient {
4703
4851
  private _shareName;
4704
4852
  private _path;
4705
4853
  private _name;
4854
+ private shareClientConfig?;
4706
4855
  /**
4707
4856
  * The share name corresponding to this directory client
4708
4857
  */
@@ -4730,7 +4879,7 @@ export declare class ShareDirectoryClient extends StorageClient {
4730
4879
  * If not specified, AnonymousCredential is used.
4731
4880
  * @param options - Optional. Options to configure the HTTP pipeline.
4732
4881
  */
4733
- constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
4882
+ constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
4734
4883
  /**
4735
4884
  * Creates an instance of DirectoryClient.
4736
4885
  *
@@ -4745,7 +4894,7 @@ export declare class ShareDirectoryClient extends StorageClient {
4745
4894
  * @param pipeline - Call newPipeline() to create a default
4746
4895
  * pipeline, or provide a customized pipeline.
4747
4896
  */
4748
- constructor(url: string, pipeline: Pipeline);
4897
+ constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
4749
4898
  /**
4750
4899
  * Creates a new directory under the specified share or parent directory.
4751
4900
  * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
@@ -5215,6 +5364,7 @@ export declare class ShareFileClient extends StorageClient {
5215
5364
  private _shareName;
5216
5365
  private _path;
5217
5366
  private _name;
5367
+ private shareClientConfig?;
5218
5368
  /**
5219
5369
  * The share name corresponding to this file client
5220
5370
  */
@@ -5238,11 +5388,11 @@ export declare class ShareFileClient extends StorageClient {
5238
5388
  * Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
5239
5389
  * However, if a file or directory name includes %, file or directory name must be encoded in the URL.
5240
5390
  * 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.
5391
+ * @param credential - Such as , StorageSharedKeyCredential or TokenCredential,
5242
5392
  * If not specified, AnonymousCredential is used.
5243
5393
  * @param options - Optional. Options to configure the HTTP pipeline.
5244
5394
  */
5245
- constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
5395
+ constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
5246
5396
  /**
5247
5397
  * Creates an instance of ShareFileClient.
5248
5398
  *
@@ -5257,7 +5407,7 @@ export declare class ShareFileClient extends StorageClient {
5257
5407
  * @param pipeline - Call newPipeline() to create a default
5258
5408
  * pipeline, or provide a customized pipeline.
5259
5409
  */
5260
- constructor(url: string, pipeline: Pipeline);
5410
+ constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
5261
5411
  /**
5262
5412
  * Creates a new ShareFileClient object identical to the source but with the specified share snapshot timestamp.
5263
5413
  * Provide "" will remove the snapshot and return a URL to the base ShareFileClient.
@@ -5765,6 +5915,9 @@ export declare class ShareFileClient extends StorageClient {
5765
5915
  }>;
5766
5916
  }
5767
5917
 
5918
+ /** Defines values for AccessRight. */
5919
+ export declare type ShareFileHandleAccessRights = "Read" | "Write" | "Delete";
5920
+
5768
5921
  /** The list of file ranges */
5769
5922
  export declare interface ShareFileRangeList {
5770
5923
  ranges?: RangeModel[];
@@ -5843,6 +5996,8 @@ export declare interface ShareGetPermissionHeaders {
5843
5996
  declare interface ShareGetPermissionOptionalParams extends coreClient.OperationOptions {
5844
5997
  /** 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
5998
  timeoutInSeconds?: number;
5999
+ /** Valid value is backup */
6000
+ fileRequestIntent?: ShareTokenIntent;
5846
6001
  }
5847
6002
 
5848
6003
  /**
@@ -6317,6 +6472,7 @@ export declare class ShareServiceClient extends StorageClient {
6317
6472
  * serviceContext provided by protocol layer.
6318
6473
  */
6319
6474
  private serviceContext;
6475
+ private shareClientConfig?;
6320
6476
  /**
6321
6477
  *
6322
6478
  * Creates an instance of ShareServiceClient from connection string.
@@ -6330,18 +6486,18 @@ export declare class ShareServiceClient extends StorageClient {
6330
6486
  * @param options - Options to configure the HTTP pipeline.
6331
6487
  * @returns A new ShareServiceClient from the given connection string.
6332
6488
  */
6333
- static fromConnectionString(connectionString: string, options?: StoragePipelineOptions): ShareServiceClient;
6489
+ static fromConnectionString(connectionString: string, options?: ShareClientOptions): ShareServiceClient;
6334
6490
  /**
6335
6491
  * Creates an instance of ShareServiceClient.
6336
6492
  *
6337
6493
  * @param url - A URL string pointing to Azure Storage file service, such as
6338
6494
  * "https://myaccount.file.core.windows.net". You can Append a SAS
6339
6495
  * if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
6340
- * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
6496
+ * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential, or TokenCredential,
6341
6497
  * If not specified, AnonymousCredential is used.
6342
6498
  * @param options - Optional. Options to configure the HTTP pipeline.
6343
6499
  */
6344
- constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
6500
+ constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
6345
6501
  /**
6346
6502
  * Creates an instance of ShareServiceClient.
6347
6503
  *
@@ -6350,8 +6506,9 @@ export declare class ShareServiceClient extends StorageClient {
6350
6506
  * if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
6351
6507
  * @param pipeline - Call newPipeline() to create a default
6352
6508
  * pipeline, or provide a customized pipeline.
6509
+ * @param options - Optional. Options to configure the HTTP pipeline.
6353
6510
  */
6354
- constructor(url: string, pipeline: Pipeline);
6511
+ constructor(url: string, pipeline: Pipeline, options?: ShareClientOptions);
6355
6512
  /**
6356
6513
  * Creates a ShareClient object.
6357
6514
  *
@@ -6739,6 +6896,15 @@ export declare interface ShareStats {
6739
6896
  shareUsageBytes: number;
6740
6897
  }
6741
6898
 
6899
+ /**
6900
+ * Defines values for ShareTokenIntent. \
6901
+ * {@link KnownShareTokenIntent} can be used interchangeably with ShareTokenIntent,
6902
+ * this enum contains the known values that the service supports.
6903
+ * ### Known values supported by the service
6904
+ * **backup**
6905
+ */
6906
+ export declare type ShareTokenIntent = string;
6907
+
6742
6908
  /**
6743
6909
  * Signed Identifier
6744
6910
  */