@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.
- package/dist/index.js +185 -74
- package/dist/index.js.map +1 -1
- package/dist-esm/storage-file-share/src/Clients.js +58 -51
- package/dist-esm/storage-file-share/src/Clients.js.map +1 -1
- package/dist-esm/storage-file-share/src/ShareServiceClient.js +7 -4
- package/dist-esm/storage-file-share/src/ShareServiceClient.js.map +1 -1
- package/dist-esm/storage-file-share/src/StorageClient.js +0 -4
- package/dist-esm/storage-file-share/src/StorageClient.js.map +1 -1
- package/dist-esm/storage-file-share/src/generated/src/models/index.js +6 -0
- package/dist-esm/storage-file-share/src/generated/src/models/index.js.map +1 -1
- package/dist-esm/storage-file-share/src/generated/src/models/parameters.js +31 -1
- package/dist-esm/storage-file-share/src/generated/src/models/parameters.js.map +1 -1
- package/dist-esm/storage-file-share/src/generated/src/operations/directory.js +29 -4
- package/dist-esm/storage-file-share/src/generated/src/operations/directory.js.map +1 -1
- package/dist-esm/storage-file-share/src/generated/src/operations/file.js +49 -8
- package/dist-esm/storage-file-share/src/generated/src/operations/file.js.map +1 -1
- package/dist-esm/storage-file-share/src/generated/src/operations/share.js +3 -1
- package/dist-esm/storage-file-share/src/generated/src/operations/share.js.map +1 -1
- package/dist-esm/storage-file-share/src/generated/src/storageClient.js +1 -1
- package/dist-esm/storage-file-share/src/generated/src/storageClient.js.map +1 -1
- package/dist-esm/storage-file-share/src/generatedModels.js +5 -1
- package/dist-esm/storage-file-share/src/generatedModels.js.map +1 -1
- package/dist-esm/storage-file-share/src/models.js.map +1 -1
- package/dist-esm/storage-file-share/src/utils/constants.js +1 -1
- package/dist-esm/storage-file-share/src/utils/constants.js.map +1 -1
- package/package.json +2 -1
- package/types/3.1/storage-file-share.d.ts +166 -12
- package/types/latest/storage-file-share.d.ts +170 -12
@@ -567,6 +567,10 @@ declare interface DirectoryCreateOptionalParams extends coreClient.OperationOpti
|
|
567
567
|
metadata?: {
|
568
568
|
[propertyName: string]: string;
|
569
569
|
};
|
570
|
+
/** Valid value is backup */
|
571
|
+
fileRequestIntent?: ShareTokenIntent;
|
572
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
573
|
+
allowTrailingDot?: boolean;
|
570
574
|
/** 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. */
|
571
575
|
filePermission?: string;
|
572
576
|
/** 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. */
|
@@ -620,6 +624,10 @@ export declare interface DirectoryDeleteIfExistsResponse extends DirectoryDelete
|
|
620
624
|
declare interface DirectoryDeleteOptionalParams extends coreClient.OperationOptions {
|
621
625
|
/** 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> */
|
622
626
|
timeoutInSeconds?: number;
|
627
|
+
/** Valid value is backup */
|
628
|
+
fileRequestIntent?: ShareTokenIntent;
|
629
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
630
|
+
allowTrailingDot?: boolean;
|
623
631
|
}
|
624
632
|
/**
|
625
633
|
* Options to configure the {@link ShareDirectoryClient.delete} operation.
|
@@ -670,6 +678,10 @@ declare interface DirectoryForceCloseHandlesOptionalParams extends coreClient.Op
|
|
670
678
|
marker?: string;
|
671
679
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
672
680
|
shareSnapshot?: string;
|
681
|
+
/** Valid value is backup */
|
682
|
+
fileRequestIntent?: ShareTokenIntent;
|
683
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
684
|
+
allowTrailingDot?: boolean;
|
673
685
|
/** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
|
674
686
|
recursive?: boolean;
|
675
687
|
}
|
@@ -749,6 +761,10 @@ declare interface DirectoryGetPropertiesOptionalParams extends coreClient.Operat
|
|
749
761
|
timeoutInSeconds?: number;
|
750
762
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
751
763
|
shareSnapshot?: string;
|
764
|
+
/** Valid value is backup */
|
765
|
+
fileRequestIntent?: ShareTokenIntent;
|
766
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
767
|
+
allowTrailingDot?: boolean;
|
752
768
|
}
|
753
769
|
/**
|
754
770
|
* Options to configure the {@link ShareDirectoryClient.getProperties} operation.
|
@@ -831,6 +847,10 @@ declare interface DirectoryListFilesAndDirectoriesSegmentOptionalParams extends
|
|
831
847
|
maxResults?: number;
|
832
848
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
833
849
|
shareSnapshot?: string;
|
850
|
+
/** Valid value is backup */
|
851
|
+
fileRequestIntent?: ShareTokenIntent;
|
852
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
853
|
+
allowTrailingDot?: boolean;
|
834
854
|
/** Include this parameter to specify one or more datasets to include in the response. */
|
835
855
|
include?: ListFilesIncludeType[];
|
836
856
|
/** Include extended information. */
|
@@ -863,6 +883,10 @@ declare interface DirectoryListHandlesOptionalParams extends coreClient.Operatio
|
|
863
883
|
maxResults?: number;
|
864
884
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
865
885
|
shareSnapshot?: string;
|
886
|
+
/** Valid value is backup */
|
887
|
+
fileRequestIntent?: ShareTokenIntent;
|
888
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
889
|
+
allowTrailingDot?: boolean;
|
866
890
|
/** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
|
867
891
|
recursive?: boolean;
|
868
892
|
}
|
@@ -961,6 +985,10 @@ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOpti
|
|
961
985
|
metadata?: {
|
962
986
|
[propertyName: string]: string;
|
963
987
|
};
|
988
|
+
/** Valid value is backup */
|
989
|
+
fileRequestIntent?: ShareTokenIntent;
|
990
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
991
|
+
allowTrailingDot?: boolean;
|
964
992
|
/** 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. */
|
965
993
|
filePermission?: string;
|
966
994
|
/** 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. */
|
@@ -969,6 +997,8 @@ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOpti
|
|
969
997
|
replaceIfExists?: boolean;
|
970
998
|
/** 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. */
|
971
999
|
ignoreReadOnly?: boolean;
|
1000
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
1001
|
+
allowSourceTrailingDot?: boolean;
|
972
1002
|
}
|
973
1003
|
/**
|
974
1004
|
* Options to configure the {@link ShareDirectoryClient.rename} operation.
|
@@ -1050,6 +1080,10 @@ declare interface DirectorySetMetadataOptionalParams extends coreClient.Operatio
|
|
1050
1080
|
metadata?: {
|
1051
1081
|
[propertyName: string]: string;
|
1052
1082
|
};
|
1083
|
+
/** Valid value is backup */
|
1084
|
+
fileRequestIntent?: ShareTokenIntent;
|
1085
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1086
|
+
allowTrailingDot?: boolean;
|
1053
1087
|
}
|
1054
1088
|
/**
|
1055
1089
|
* Options to configure the {@link ShareDirectoryClient.setMetadata} operation.
|
@@ -1100,6 +1134,10 @@ export declare interface DirectorySetPropertiesHeaders {
|
|
1100
1134
|
declare interface DirectorySetPropertiesOptionalParams extends coreClient.OperationOptions {
|
1101
1135
|
/** 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> */
|
1102
1136
|
timeoutInSeconds?: number;
|
1137
|
+
/** Valid value is backup */
|
1138
|
+
fileRequestIntent?: ShareTokenIntent;
|
1139
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1140
|
+
allowTrailingDot?: boolean;
|
1103
1141
|
/** 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. */
|
1104
1142
|
filePermission?: string;
|
1105
1143
|
/** 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. */
|
@@ -1284,6 +1322,10 @@ declare interface FileAbortCopyOptionalParams extends coreClient.OperationOption
|
|
1284
1322
|
leaseAccessConditions?: LeaseAccessConditions;
|
1285
1323
|
/** 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> */
|
1286
1324
|
timeoutInSeconds?: number;
|
1325
|
+
/** Valid value is backup */
|
1326
|
+
fileRequestIntent?: ShareTokenIntent;
|
1327
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1328
|
+
allowTrailingDot?: boolean;
|
1287
1329
|
}
|
1288
1330
|
/** Contains response data for the abortCopy operation. */
|
1289
1331
|
export declare type FileAbortCopyResponse = WithResponse<FileAbortCopyHeaders, FileAbortCopyHeaders>;
|
@@ -1316,6 +1358,10 @@ declare interface FileAcquireLeaseOptionalParams extends coreClient.OperationOpt
|
|
1316
1358
|
proposedLeaseId?: string;
|
1317
1359
|
/** 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. */
|
1318
1360
|
requestId?: string;
|
1361
|
+
/** Valid value is backup */
|
1362
|
+
fileRequestIntent?: ShareTokenIntent;
|
1363
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1364
|
+
allowTrailingDot?: boolean;
|
1319
1365
|
}
|
1320
1366
|
/** Contains response data for the acquireLease operation. */
|
1321
1367
|
declare type FileAcquireLeaseResponse = FileAcquireLeaseHeaders;
|
@@ -1429,6 +1475,10 @@ declare interface FileBreakLeaseOptionalParams extends coreClient.OperationOptio
|
|
1429
1475
|
timeoutInSeconds?: number;
|
1430
1476
|
/** 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. */
|
1431
1477
|
requestId?: string;
|
1478
|
+
/** Valid value is backup */
|
1479
|
+
fileRequestIntent?: ShareTokenIntent;
|
1480
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1481
|
+
allowTrailingDot?: boolean;
|
1432
1482
|
}
|
1433
1483
|
/** Contains response data for the breakLease operation. */
|
1434
1484
|
declare type FileBreakLeaseResponse = FileBreakLeaseHeaders;
|
@@ -1457,6 +1507,10 @@ declare interface FileChangeLeaseOptionalParams extends coreClient.OperationOpti
|
|
1457
1507
|
proposedLeaseId?: string;
|
1458
1508
|
/** 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. */
|
1459
1509
|
requestId?: string;
|
1510
|
+
/** Valid value is backup */
|
1511
|
+
fileRequestIntent?: ShareTokenIntent;
|
1512
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1513
|
+
allowTrailingDot?: boolean;
|
1460
1514
|
}
|
1461
1515
|
/** Contains response data for the changeLease operation. */
|
1462
1516
|
declare type FileChangeLeaseResponse = FileChangeLeaseHeaders;
|
@@ -1548,6 +1602,10 @@ declare interface FileCreateOptionalParams extends coreClient.OperationOptions {
|
|
1548
1602
|
metadata?: {
|
1549
1603
|
[propertyName: string]: string;
|
1550
1604
|
};
|
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;
|
1551
1609
|
/** 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. */
|
1552
1610
|
filePermission?: string;
|
1553
1611
|
/** 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. */
|
@@ -1611,6 +1669,10 @@ declare interface FileDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1611
1669
|
leaseAccessConditions?: LeaseAccessConditions;
|
1612
1670
|
/** 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> */
|
1613
1671
|
timeoutInSeconds?: number;
|
1672
|
+
/** Valid value is backup */
|
1673
|
+
fileRequestIntent?: ShareTokenIntent;
|
1674
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1675
|
+
allowTrailingDot?: boolean;
|
1614
1676
|
}
|
1615
1677
|
/**
|
1616
1678
|
* Options to configure the {@link ShareFileClient.delete} operation.
|
@@ -1709,6 +1771,10 @@ export declare interface FileDownloadOptionalParams extends coreClient.Operation
|
|
1709
1771
|
leaseAccessConditions?: LeaseAccessConditions;
|
1710
1772
|
/** 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> */
|
1711
1773
|
timeoutInSeconds?: number;
|
1774
|
+
/** Valid value is backup */
|
1775
|
+
fileRequestIntent?: ShareTokenIntent;
|
1776
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1777
|
+
allowTrailingDot?: boolean;
|
1712
1778
|
/** Return file data only from the specified byte range. */
|
1713
1779
|
range?: string;
|
1714
1780
|
/** 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. */
|
@@ -1836,6 +1902,10 @@ declare interface FileForceCloseHandlesOptionalParams extends coreClient.Operati
|
|
1836
1902
|
marker?: string;
|
1837
1903
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
1838
1904
|
shareSnapshot?: string;
|
1905
|
+
/** Valid value is backup */
|
1906
|
+
fileRequestIntent?: ShareTokenIntent;
|
1907
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1908
|
+
allowTrailingDot?: boolean;
|
1839
1909
|
}
|
1840
1910
|
/**
|
1841
1911
|
* Options to configure File - Force Close Handles operations.
|
@@ -1944,6 +2014,10 @@ declare interface FileGetPropertiesOptionalParams extends coreClient.OperationOp
|
|
1944
2014
|
timeoutInSeconds?: number;
|
1945
2015
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
1946
2016
|
shareSnapshot?: string;
|
2017
|
+
/** Valid value is backup */
|
2018
|
+
fileRequestIntent?: ShareTokenIntent;
|
2019
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2020
|
+
allowTrailingDot?: boolean;
|
1947
2021
|
}
|
1948
2022
|
/**
|
1949
2023
|
* Options to configure the {@link ShareFileClient.getProperties} operation.
|
@@ -1990,6 +2064,10 @@ declare interface FileGetRangeListOptionalParams extends coreClient.OperationOpt
|
|
1990
2064
|
timeoutInSeconds?: number;
|
1991
2065
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
1992
2066
|
shareSnapshot?: string;
|
2067
|
+
/** Valid value is backup */
|
2068
|
+
fileRequestIntent?: ShareTokenIntent;
|
2069
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2070
|
+
allowTrailingDot?: boolean;
|
1993
2071
|
/** Specifies the range of bytes over which to list ranges, inclusively. */
|
1994
2072
|
range?: string;
|
1995
2073
|
/** The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot. */
|
@@ -2124,6 +2202,10 @@ declare interface FileListHandlesOptionalParams extends coreClient.OperationOpti
|
|
2124
2202
|
maxResults?: number;
|
2125
2203
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
2126
2204
|
shareSnapshot?: string;
|
2205
|
+
/** Valid value is backup */
|
2206
|
+
fileRequestIntent?: ShareTokenIntent;
|
2207
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2208
|
+
allowTrailingDot?: boolean;
|
2127
2209
|
}
|
2128
2210
|
export declare interface FileListHandlesOptions extends CommonOptions {
|
2129
2211
|
/**
|
@@ -2253,6 +2335,10 @@ declare interface FileReleaseLeaseOptionalParams extends coreClient.OperationOpt
|
|
2253
2335
|
timeoutInSeconds?: number;
|
2254
2336
|
/** 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. */
|
2255
2337
|
requestId?: string;
|
2338
|
+
/** Valid value is backup */
|
2339
|
+
fileRequestIntent?: ShareTokenIntent;
|
2340
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2341
|
+
allowTrailingDot?: boolean;
|
2256
2342
|
}
|
2257
2343
|
/** Contains response data for the releaseLease operation. */
|
2258
2344
|
declare type FileReleaseLeaseResponse = FileReleaseLeaseHeaders;
|
@@ -2301,6 +2387,10 @@ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
|
|
2301
2387
|
metadata?: {
|
2302
2388
|
[propertyName: string]: string;
|
2303
2389
|
};
|
2390
|
+
/** Valid value is backup */
|
2391
|
+
fileRequestIntent?: ShareTokenIntent;
|
2392
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2393
|
+
allowTrailingDot?: boolean;
|
2304
2394
|
/** 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. */
|
2305
2395
|
filePermission?: string;
|
2306
2396
|
/** 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. */
|
@@ -2309,6 +2399,8 @@ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
|
|
2309
2399
|
replaceIfExists?: boolean;
|
2310
2400
|
/** 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. */
|
2311
2401
|
ignoreReadOnly?: boolean;
|
2402
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
2403
|
+
allowSourceTrailingDot?: boolean;
|
2312
2404
|
}
|
2313
2405
|
/**
|
2314
2406
|
* Options to configure the {@link ShareFileClient.rename} operation.
|
@@ -2554,6 +2646,10 @@ declare interface FileSetHttpHeadersOptionalParams extends coreClient.OperationO
|
|
2554
2646
|
fileHttpHeaders?: FileHttpHeaders_2;
|
2555
2647
|
/** 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> */
|
2556
2648
|
timeoutInSeconds?: number;
|
2649
|
+
/** Valid value is backup */
|
2650
|
+
fileRequestIntent?: ShareTokenIntent;
|
2651
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2652
|
+
allowTrailingDot?: boolean;
|
2557
2653
|
/** 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. */
|
2558
2654
|
filePermission?: string;
|
2559
2655
|
/** 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. */
|
@@ -2610,6 +2706,10 @@ declare interface FileSetMetadataOptionalParams extends coreClient.OperationOpti
|
|
2610
2706
|
metadata?: {
|
2611
2707
|
[propertyName: string]: string;
|
2612
2708
|
};
|
2709
|
+
/** Valid value is backup */
|
2710
|
+
fileRequestIntent?: ShareTokenIntent;
|
2711
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2712
|
+
allowTrailingDot?: boolean;
|
2613
2713
|
}
|
2614
2714
|
/**
|
2615
2715
|
* Options to configure the {@link ShareFileClient.setMetadata} operation.
|
@@ -2660,10 +2760,16 @@ declare interface FileStartCopyOptionalParams extends coreClient.OperationOption
|
|
2660
2760
|
metadata?: {
|
2661
2761
|
[propertyName: string]: string;
|
2662
2762
|
};
|
2763
|
+
/** Valid value is backup */
|
2764
|
+
fileRequestIntent?: ShareTokenIntent;
|
2765
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2766
|
+
allowTrailingDot?: boolean;
|
2663
2767
|
/** 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. */
|
2664
2768
|
filePermission?: string;
|
2665
2769
|
/** 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. */
|
2666
2770
|
filePermissionKey?: string;
|
2771
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
2772
|
+
allowSourceTrailingDot?: boolean;
|
2667
2773
|
}
|
2668
2774
|
/**
|
2669
2775
|
* Options to configure the {@link ShareFileClient.startCopyFromURL} operation.
|
@@ -2795,6 +2901,10 @@ export declare interface FileUploadRangeFromURLOptionalParams extends coreClient
|
|
2795
2901
|
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
2796
2902
|
/** 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> */
|
2797
2903
|
timeoutInSeconds?: number;
|
2904
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2905
|
+
allowTrailingDot?: boolean;
|
2906
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
2907
|
+
allowSourceTrailingDot?: boolean;
|
2798
2908
|
/** If the file last write time should be preserved or overwritten */
|
2799
2909
|
fileLastWrittenMode?: FileLastWrittenMode;
|
2800
2910
|
/** Bytes of source data in the specified range. */
|
@@ -2874,6 +2984,10 @@ declare interface FileUploadRangeOptionalParams extends coreClient.OperationOpti
|
|
2874
2984
|
leaseAccessConditions?: LeaseAccessConditions;
|
2875
2985
|
/** 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> */
|
2876
2986
|
timeoutInSeconds?: number;
|
2987
|
+
/** Valid value is backup */
|
2988
|
+
fileRequestIntent?: ShareTokenIntent;
|
2989
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2990
|
+
allowTrailingDot?: boolean;
|
2877
2991
|
/** Initial data. */
|
2878
2992
|
body?: coreRestPipeline.RequestBodyType;
|
2879
2993
|
/** 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). */
|
@@ -3051,6 +3165,10 @@ export declare interface HttpResponse {
|
|
3051
3165
|
* @returns true when the argument satisfies the Pipeline contract
|
3052
3166
|
*/
|
3053
3167
|
export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
|
3168
|
+
/** Known values of {@link ShareTokenIntent} that the service accepts. */
|
3169
|
+
export declare enum KnownShareTokenIntent {
|
3170
|
+
Backup = "backup"
|
3171
|
+
}
|
3054
3172
|
/** Parameter group */
|
3055
3173
|
export declare interface LeaseAccessConditions {
|
3056
3174
|
/** If specified, the operation only succeeds if the resource's lease is active and matches this ID. */
|
@@ -3911,6 +4029,7 @@ export declare class ShareClient extends StorageClient {
|
|
3911
4029
|
*/
|
3912
4030
|
private context;
|
3913
4031
|
private _name;
|
4032
|
+
private shareClientConfig?;
|
3914
4033
|
/*
|
3915
4034
|
* The name of the share
|
3916
4035
|
*/
|
@@ -3925,7 +4044,7 @@ export declare class ShareClient extends StorageClient {
|
|
3925
4044
|
* @param name - Share name.
|
3926
4045
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
3927
4046
|
*/
|
3928
|
-
constructor(connectionString: string, name: string, options?:
|
4047
|
+
constructor(connectionString: string, name: string, options?: ShareClientOptions);
|
3929
4048
|
/**
|
3930
4049
|
* Creates an instance of ShareClient.
|
3931
4050
|
*
|
@@ -3937,7 +4056,8 @@ export declare class ShareClient extends StorageClient {
|
|
3937
4056
|
* If not specified, AnonymousCredential is used.
|
3938
4057
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
3939
4058
|
*/
|
3940
|
-
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?:
|
4059
|
+
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: ShareClientOptions);
|
4060
|
+
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?: ShareClientOptions);
|
3941
4061
|
/**
|
3942
4062
|
* Creates an instance of ShareClient.
|
3943
4063
|
*
|
@@ -3948,7 +4068,7 @@ export declare class ShareClient extends StorageClient {
|
|
3948
4068
|
* @param pipeline - Call newPipeline() to create a default
|
3949
4069
|
* pipeline, or provide a customized pipeline.
|
3950
4070
|
*/
|
3951
|
-
constructor(url: string, pipeline: Pipeline);
|
4071
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
|
3952
4072
|
/**
|
3953
4073
|
* Creates a new ShareClient object identical to the source but with the specified snapshot timestamp.
|
3954
4074
|
* Provide "" will remove the snapshot and return a URL to the base share.
|
@@ -4190,6 +4310,24 @@ export declare class ShareClient extends StorageClient {
|
|
4190
4310
|
*/
|
4191
4311
|
generateSasUrl(options: ShareGenerateSasUrlOptions): string;
|
4192
4312
|
}
|
4313
|
+
export declare interface ShareClientConfig {
|
4314
|
+
/**
|
4315
|
+
* The Files OAuth over REST feature requires special permissions to be included in the role definition to use
|
4316
|
+
* These special permissions will give privileged access to file share data -
|
4317
|
+
* It will allow users to bypass file/directory level ACL/NTFS permissions and get read/write access to file share data
|
4318
|
+
* Since this additional permission can be unintended and to prevent unintended and over privileged access,
|
4319
|
+
* additional checks has been implemented that requires users to explicitly indicate their intent to use these additional permissions.
|
4320
|
+
* This is done using the fileRequestIntent option.
|
4321
|
+
* Currently, the only value that the header supports is 'backup'
|
4322
|
+
* 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.
|
4323
|
+
*/
|
4324
|
+
fileRequestIntent?: ShareTokenIntent;
|
4325
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
4326
|
+
allowTrailingDot?: boolean;
|
4327
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
4328
|
+
allowSourceTrailingDot?: boolean;
|
4329
|
+
}
|
4330
|
+
export declare type ShareClientOptions = StoragePipelineOptions & ShareClientConfig;
|
4193
4331
|
/** Defines headers for Share_create operation. */
|
4194
4332
|
export declare interface ShareCreateHeaders {
|
4195
4333
|
/** The ETag contains a value which represents the version of the share, in quotes. */
|
@@ -4283,6 +4421,8 @@ export declare interface ShareCreatePermissionHeaders {
|
|
4283
4421
|
declare interface ShareCreatePermissionOptionalParams extends coreClient.OperationOptions {
|
4284
4422
|
/** 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> */
|
4285
4423
|
timeoutInSeconds?: number;
|
4424
|
+
/** Valid value is backup */
|
4425
|
+
fileRequestIntent?: ShareTokenIntent;
|
4286
4426
|
}
|
4287
4427
|
/**
|
4288
4428
|
* Options to configure the {@link ShareClient.createPermission} operation.
|
@@ -4414,6 +4554,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
4414
4554
|
private _shareName;
|
4415
4555
|
private _path;
|
4416
4556
|
private _name;
|
4557
|
+
private shareClientConfig?;
|
4417
4558
|
/*
|
4418
4559
|
* The share name corresponding to this directory client
|
4419
4560
|
*/
|
@@ -4441,7 +4582,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
4441
4582
|
* If not specified, AnonymousCredential is used.
|
4442
4583
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
4443
4584
|
*/
|
4444
|
-
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?:
|
4585
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
|
4445
4586
|
/**
|
4446
4587
|
* Creates an instance of DirectoryClient.
|
4447
4588
|
*
|
@@ -4456,7 +4597,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
4456
4597
|
* @param pipeline - Call newPipeline() to create a default
|
4457
4598
|
* pipeline, or provide a customized pipeline.
|
4458
4599
|
*/
|
4459
|
-
constructor(url: string, pipeline: Pipeline);
|
4600
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
|
4460
4601
|
/**
|
4461
4602
|
* Creates a new directory under the specified share or parent directory.
|
4462
4603
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
|
@@ -4924,6 +5065,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
4924
5065
|
private _shareName;
|
4925
5066
|
private _path;
|
4926
5067
|
private _name;
|
5068
|
+
private shareClientConfig?;
|
4927
5069
|
/*
|
4928
5070
|
* The share name corresponding to this file client
|
4929
5071
|
*/
|
@@ -4947,11 +5089,11 @@ export declare class ShareFileClient extends StorageClient {
|
|
4947
5089
|
* Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
|
4948
5090
|
* However, if a file or directory name includes %, file or directory name must be encoded in the URL.
|
4949
5091
|
* Such as a file named "myfile%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".
|
4950
|
-
* @param credential - Such as
|
5092
|
+
* @param credential - Such as , StorageSharedKeyCredential or TokenCredential,
|
4951
5093
|
* If not specified, AnonymousCredential is used.
|
4952
5094
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
4953
5095
|
*/
|
4954
|
-
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?:
|
5096
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
|
4955
5097
|
/**
|
4956
5098
|
* Creates an instance of ShareFileClient.
|
4957
5099
|
*
|
@@ -4966,7 +5108,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
4966
5108
|
* @param pipeline - Call newPipeline() to create a default
|
4967
5109
|
* pipeline, or provide a customized pipeline.
|
4968
5110
|
*/
|
4969
|
-
constructor(url: string, pipeline: Pipeline);
|
5111
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
|
4970
5112
|
/**
|
4971
5113
|
* Creates a new ShareFileClient object identical to the source but with the specified share snapshot timestamp.
|
4972
5114
|
* Provide "" will remove the snapshot and return a URL to the base ShareFileClient.
|
@@ -5543,6 +5685,8 @@ export declare interface ShareGetPermissionHeaders {
|
|
5543
5685
|
declare interface ShareGetPermissionOptionalParams extends coreClient.OperationOptions {
|
5544
5686
|
/** 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> */
|
5545
5687
|
timeoutInSeconds?: number;
|
5688
|
+
/** Valid value is backup */
|
5689
|
+
fileRequestIntent?: ShareTokenIntent;
|
5546
5690
|
}
|
5547
5691
|
/**
|
5548
5692
|
* Options to configure the {@link ShareClient.getPermission} operation.
|
@@ -5982,6 +6126,7 @@ export declare class ShareServiceClient extends StorageClient {
|
|
5982
6126
|
* serviceContext provided by protocol layer.
|
5983
6127
|
*/
|
5984
6128
|
private serviceContext;
|
6129
|
+
private shareClientConfig?;
|
5985
6130
|
/**
|
5986
6131
|
*
|
5987
6132
|
* Creates an instance of ShareServiceClient from connection string.
|
@@ -5995,18 +6140,18 @@ export declare class ShareServiceClient extends StorageClient {
|
|
5995
6140
|
* @param options - Options to configure the HTTP pipeline.
|
5996
6141
|
* @returns A new ShareServiceClient from the given connection string.
|
5997
6142
|
*/
|
5998
|
-
static fromConnectionString(connectionString: string, options?:
|
6143
|
+
static fromConnectionString(connectionString: string, options?: ShareClientOptions): ShareServiceClient;
|
5999
6144
|
/**
|
6000
6145
|
* Creates an instance of ShareServiceClient.
|
6001
6146
|
*
|
6002
6147
|
* @param url - A URL string pointing to Azure Storage file service, such as
|
6003
6148
|
* "https://myaccount.file.core.windows.net". You can Append a SAS
|
6004
6149
|
* if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
|
6005
|
-
* @param credential - Such as AnonymousCredential or
|
6150
|
+
* @param credential - Such as AnonymousCredential, StorageSharedKeyCredential, or TokenCredential,
|
6006
6151
|
* If not specified, AnonymousCredential is used.
|
6007
6152
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
6008
6153
|
*/
|
6009
|
-
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?:
|
6154
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
|
6010
6155
|
/**
|
6011
6156
|
* Creates an instance of ShareServiceClient.
|
6012
6157
|
*
|
@@ -6015,8 +6160,9 @@ export declare class ShareServiceClient extends StorageClient {
|
|
6015
6160
|
* if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
|
6016
6161
|
* @param pipeline - Call newPipeline() to create a default
|
6017
6162
|
* pipeline, or provide a customized pipeline.
|
6163
|
+
* @param options - Optional. Options to configure the HTTP pipeline.
|
6018
6164
|
*/
|
6019
|
-
constructor(url: string, pipeline: Pipeline);
|
6165
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientOptions);
|
6020
6166
|
/**
|
6021
6167
|
* Creates a ShareClient object.
|
6022
6168
|
*
|
@@ -6383,6 +6529,14 @@ export declare interface ShareStats {
|
|
6383
6529
|
/** The approximate size of the data stored in bytes. Note that this value may not include all recently created or recently resized files. */
|
6384
6530
|
shareUsageBytes: number;
|
6385
6531
|
}
|
6532
|
+
/**
|
6533
|
+
* Defines values for ShareTokenIntent. \
|
6534
|
+
* {@link KnownShareTokenIntent} can be used interchangeably with ShareTokenIntent,
|
6535
|
+
* this enum contains the known values that the service supports.
|
6536
|
+
* ### Known values supported by the service
|
6537
|
+
* **backup**
|
6538
|
+
*/
|
6539
|
+
export declare type ShareTokenIntent = string;
|
6386
6540
|
/**
|
6387
6541
|
* Signed Identifier
|
6388
6542
|
*/
|