@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.
- package/dist/index.js +200 -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/mappers.js +15 -0
- package/dist-esm/storage-file-share/src/generated/src/models/mappers.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 +172 -12
- package/types/latest/storage-file-share.d.ts +178 -12
@@ -30,6 +30,8 @@ export declare interface AccessPolicy {
|
|
30
30
|
/** The permissions for the ACL policy. */
|
31
31
|
permissions?: string;
|
32
32
|
}
|
33
|
+
/** Defines values for AccessRight. */
|
34
|
+
declare type AccessRight = "Read" | "Write" | "Delete";
|
33
35
|
/**
|
34
36
|
* ONLY AVAILABLE IN NODE.JS RUNTIME.
|
35
37
|
*
|
@@ -567,6 +569,10 @@ declare interface DirectoryCreateOptionalParams extends coreClient.OperationOpti
|
|
567
569
|
metadata?: {
|
568
570
|
[propertyName: string]: string;
|
569
571
|
};
|
572
|
+
/** Valid value is backup */
|
573
|
+
fileRequestIntent?: ShareTokenIntent;
|
574
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
575
|
+
allowTrailingDot?: boolean;
|
570
576
|
/** 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
577
|
filePermission?: string;
|
572
578
|
/** 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 +626,10 @@ export declare interface DirectoryDeleteIfExistsResponse extends DirectoryDelete
|
|
620
626
|
declare interface DirectoryDeleteOptionalParams extends coreClient.OperationOptions {
|
621
627
|
/** 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
628
|
timeoutInSeconds?: number;
|
629
|
+
/** Valid value is backup */
|
630
|
+
fileRequestIntent?: ShareTokenIntent;
|
631
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
632
|
+
allowTrailingDot?: boolean;
|
623
633
|
}
|
624
634
|
/**
|
625
635
|
* Options to configure the {@link ShareDirectoryClient.delete} operation.
|
@@ -670,6 +680,10 @@ declare interface DirectoryForceCloseHandlesOptionalParams extends coreClient.Op
|
|
670
680
|
marker?: string;
|
671
681
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
672
682
|
shareSnapshot?: string;
|
683
|
+
/** Valid value is backup */
|
684
|
+
fileRequestIntent?: ShareTokenIntent;
|
685
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
686
|
+
allowTrailingDot?: boolean;
|
673
687
|
/** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
|
674
688
|
recursive?: boolean;
|
675
689
|
}
|
@@ -749,6 +763,10 @@ declare interface DirectoryGetPropertiesOptionalParams extends coreClient.Operat
|
|
749
763
|
timeoutInSeconds?: number;
|
750
764
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
751
765
|
shareSnapshot?: string;
|
766
|
+
/** Valid value is backup */
|
767
|
+
fileRequestIntent?: ShareTokenIntent;
|
768
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
769
|
+
allowTrailingDot?: boolean;
|
752
770
|
}
|
753
771
|
/**
|
754
772
|
* Options to configure the {@link ShareDirectoryClient.getProperties} operation.
|
@@ -831,6 +849,10 @@ declare interface DirectoryListFilesAndDirectoriesSegmentOptionalParams extends
|
|
831
849
|
maxResults?: number;
|
832
850
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
833
851
|
shareSnapshot?: string;
|
852
|
+
/** Valid value is backup */
|
853
|
+
fileRequestIntent?: ShareTokenIntent;
|
854
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
855
|
+
allowTrailingDot?: boolean;
|
834
856
|
/** Include this parameter to specify one or more datasets to include in the response. */
|
835
857
|
include?: ListFilesIncludeType[];
|
836
858
|
/** Include extended information. */
|
@@ -863,6 +885,10 @@ declare interface DirectoryListHandlesOptionalParams extends coreClient.Operatio
|
|
863
885
|
maxResults?: number;
|
864
886
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
865
887
|
shareSnapshot?: string;
|
888
|
+
/** Valid value is backup */
|
889
|
+
fileRequestIntent?: ShareTokenIntent;
|
890
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
891
|
+
allowTrailingDot?: boolean;
|
866
892
|
/** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
|
867
893
|
recursive?: boolean;
|
868
894
|
}
|
@@ -961,6 +987,10 @@ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOpti
|
|
961
987
|
metadata?: {
|
962
988
|
[propertyName: string]: string;
|
963
989
|
};
|
990
|
+
/** Valid value is backup */
|
991
|
+
fileRequestIntent?: ShareTokenIntent;
|
992
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
993
|
+
allowTrailingDot?: boolean;
|
964
994
|
/** 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
995
|
filePermission?: string;
|
966
996
|
/** 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 +999,8 @@ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOpti
|
|
969
999
|
replaceIfExists?: boolean;
|
970
1000
|
/** 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
1001
|
ignoreReadOnly?: boolean;
|
1002
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
1003
|
+
allowSourceTrailingDot?: boolean;
|
972
1004
|
}
|
973
1005
|
/**
|
974
1006
|
* Options to configure the {@link ShareDirectoryClient.rename} operation.
|
@@ -1050,6 +1082,10 @@ declare interface DirectorySetMetadataOptionalParams extends coreClient.Operatio
|
|
1050
1082
|
metadata?: {
|
1051
1083
|
[propertyName: string]: string;
|
1052
1084
|
};
|
1085
|
+
/** Valid value is backup */
|
1086
|
+
fileRequestIntent?: ShareTokenIntent;
|
1087
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1088
|
+
allowTrailingDot?: boolean;
|
1053
1089
|
}
|
1054
1090
|
/**
|
1055
1091
|
* Options to configure the {@link ShareDirectoryClient.setMetadata} operation.
|
@@ -1100,6 +1136,10 @@ export declare interface DirectorySetPropertiesHeaders {
|
|
1100
1136
|
declare interface DirectorySetPropertiesOptionalParams extends coreClient.OperationOptions {
|
1101
1137
|
/** 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
1138
|
timeoutInSeconds?: number;
|
1139
|
+
/** Valid value is backup */
|
1140
|
+
fileRequestIntent?: ShareTokenIntent;
|
1141
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1142
|
+
allowTrailingDot?: boolean;
|
1103
1143
|
/** 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
1144
|
filePermission?: string;
|
1105
1145
|
/** 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 +1324,10 @@ declare interface FileAbortCopyOptionalParams extends coreClient.OperationOption
|
|
1284
1324
|
leaseAccessConditions?: LeaseAccessConditions;
|
1285
1325
|
/** 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
1326
|
timeoutInSeconds?: number;
|
1327
|
+
/** Valid value is backup */
|
1328
|
+
fileRequestIntent?: ShareTokenIntent;
|
1329
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1330
|
+
allowTrailingDot?: boolean;
|
1287
1331
|
}
|
1288
1332
|
/** Contains response data for the abortCopy operation. */
|
1289
1333
|
export declare type FileAbortCopyResponse = WithResponse<FileAbortCopyHeaders, FileAbortCopyHeaders>;
|
@@ -1316,6 +1360,10 @@ declare interface FileAcquireLeaseOptionalParams extends coreClient.OperationOpt
|
|
1316
1360
|
proposedLeaseId?: string;
|
1317
1361
|
/** 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
1362
|
requestId?: string;
|
1363
|
+
/** Valid value is backup */
|
1364
|
+
fileRequestIntent?: ShareTokenIntent;
|
1365
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1366
|
+
allowTrailingDot?: boolean;
|
1319
1367
|
}
|
1320
1368
|
/** Contains response data for the acquireLease operation. */
|
1321
1369
|
declare type FileAcquireLeaseResponse = FileAcquireLeaseHeaders;
|
@@ -1429,6 +1477,10 @@ declare interface FileBreakLeaseOptionalParams extends coreClient.OperationOptio
|
|
1429
1477
|
timeoutInSeconds?: number;
|
1430
1478
|
/** 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
1479
|
requestId?: string;
|
1480
|
+
/** Valid value is backup */
|
1481
|
+
fileRequestIntent?: ShareTokenIntent;
|
1482
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1483
|
+
allowTrailingDot?: boolean;
|
1432
1484
|
}
|
1433
1485
|
/** Contains response data for the breakLease operation. */
|
1434
1486
|
declare type FileBreakLeaseResponse = FileBreakLeaseHeaders;
|
@@ -1457,6 +1509,10 @@ declare interface FileChangeLeaseOptionalParams extends coreClient.OperationOpti
|
|
1457
1509
|
proposedLeaseId?: string;
|
1458
1510
|
/** 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
1511
|
requestId?: string;
|
1512
|
+
/** Valid value is backup */
|
1513
|
+
fileRequestIntent?: ShareTokenIntent;
|
1514
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1515
|
+
allowTrailingDot?: boolean;
|
1460
1516
|
}
|
1461
1517
|
/** Contains response data for the changeLease operation. */
|
1462
1518
|
declare type FileChangeLeaseResponse = FileChangeLeaseHeaders;
|
@@ -1548,6 +1604,10 @@ declare interface FileCreateOptionalParams extends coreClient.OperationOptions {
|
|
1548
1604
|
metadata?: {
|
1549
1605
|
[propertyName: string]: string;
|
1550
1606
|
};
|
1607
|
+
/** Valid value is backup */
|
1608
|
+
fileRequestIntent?: ShareTokenIntent;
|
1609
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1610
|
+
allowTrailingDot?: boolean;
|
1551
1611
|
/** 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
1612
|
filePermission?: string;
|
1553
1613
|
/** 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 +1671,10 @@ declare interface FileDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1611
1671
|
leaseAccessConditions?: LeaseAccessConditions;
|
1612
1672
|
/** 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
1673
|
timeoutInSeconds?: number;
|
1674
|
+
/** Valid value is backup */
|
1675
|
+
fileRequestIntent?: ShareTokenIntent;
|
1676
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1677
|
+
allowTrailingDot?: boolean;
|
1614
1678
|
}
|
1615
1679
|
/**
|
1616
1680
|
* Options to configure the {@link ShareFileClient.delete} operation.
|
@@ -1709,6 +1773,10 @@ export declare interface FileDownloadOptionalParams extends coreClient.Operation
|
|
1709
1773
|
leaseAccessConditions?: LeaseAccessConditions;
|
1710
1774
|
/** 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
1775
|
timeoutInSeconds?: number;
|
1776
|
+
/** Valid value is backup */
|
1777
|
+
fileRequestIntent?: ShareTokenIntent;
|
1778
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1779
|
+
allowTrailingDot?: boolean;
|
1712
1780
|
/** Return file data only from the specified byte range. */
|
1713
1781
|
range?: string;
|
1714
1782
|
/** 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 +1904,10 @@ declare interface FileForceCloseHandlesOptionalParams extends coreClient.Operati
|
|
1836
1904
|
marker?: string;
|
1837
1905
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
1838
1906
|
shareSnapshot?: string;
|
1907
|
+
/** Valid value is backup */
|
1908
|
+
fileRequestIntent?: ShareTokenIntent;
|
1909
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1910
|
+
allowTrailingDot?: boolean;
|
1839
1911
|
}
|
1840
1912
|
/**
|
1841
1913
|
* Options to configure File - Force Close Handles operations.
|
@@ -1944,6 +2016,10 @@ declare interface FileGetPropertiesOptionalParams extends coreClient.OperationOp
|
|
1944
2016
|
timeoutInSeconds?: number;
|
1945
2017
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
1946
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;
|
1947
2023
|
}
|
1948
2024
|
/**
|
1949
2025
|
* Options to configure the {@link ShareFileClient.getProperties} operation.
|
@@ -1990,6 +2066,10 @@ declare interface FileGetRangeListOptionalParams extends coreClient.OperationOpt
|
|
1990
2066
|
timeoutInSeconds?: number;
|
1991
2067
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
1992
2068
|
shareSnapshot?: string;
|
2069
|
+
/** Valid value is backup */
|
2070
|
+
fileRequestIntent?: ShareTokenIntent;
|
2071
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2072
|
+
allowTrailingDot?: boolean;
|
1993
2073
|
/** Specifies the range of bytes over which to list ranges, inclusively. */
|
1994
2074
|
range?: string;
|
1995
2075
|
/** The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot. */
|
@@ -2124,6 +2204,10 @@ declare interface FileListHandlesOptionalParams extends coreClient.OperationOpti
|
|
2124
2204
|
maxResults?: number;
|
2125
2205
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
2126
2206
|
shareSnapshot?: string;
|
2207
|
+
/** Valid value is backup */
|
2208
|
+
fileRequestIntent?: ShareTokenIntent;
|
2209
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2210
|
+
allowTrailingDot?: boolean;
|
2127
2211
|
}
|
2128
2212
|
export declare interface FileListHandlesOptions extends CommonOptions {
|
2129
2213
|
/**
|
@@ -2253,6 +2337,10 @@ declare interface FileReleaseLeaseOptionalParams extends coreClient.OperationOpt
|
|
2253
2337
|
timeoutInSeconds?: number;
|
2254
2338
|
/** 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
2339
|
requestId?: string;
|
2340
|
+
/** Valid value is backup */
|
2341
|
+
fileRequestIntent?: ShareTokenIntent;
|
2342
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2343
|
+
allowTrailingDot?: boolean;
|
2256
2344
|
}
|
2257
2345
|
/** Contains response data for the releaseLease operation. */
|
2258
2346
|
declare type FileReleaseLeaseResponse = FileReleaseLeaseHeaders;
|
@@ -2301,6 +2389,10 @@ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
|
|
2301
2389
|
metadata?: {
|
2302
2390
|
[propertyName: string]: string;
|
2303
2391
|
};
|
2392
|
+
/** Valid value is backup */
|
2393
|
+
fileRequestIntent?: ShareTokenIntent;
|
2394
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2395
|
+
allowTrailingDot?: boolean;
|
2304
2396
|
/** 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
2397
|
filePermission?: string;
|
2306
2398
|
/** 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 +2401,8 @@ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
|
|
2309
2401
|
replaceIfExists?: boolean;
|
2310
2402
|
/** 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
2403
|
ignoreReadOnly?: boolean;
|
2404
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
2405
|
+
allowSourceTrailingDot?: boolean;
|
2312
2406
|
}
|
2313
2407
|
/**
|
2314
2408
|
* Options to configure the {@link ShareFileClient.rename} operation.
|
@@ -2554,6 +2648,10 @@ declare interface FileSetHttpHeadersOptionalParams extends coreClient.OperationO
|
|
2554
2648
|
fileHttpHeaders?: FileHttpHeaders_2;
|
2555
2649
|
/** 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
2650
|
timeoutInSeconds?: number;
|
2651
|
+
/** Valid value is backup */
|
2652
|
+
fileRequestIntent?: ShareTokenIntent;
|
2653
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2654
|
+
allowTrailingDot?: boolean;
|
2557
2655
|
/** 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
2656
|
filePermission?: string;
|
2559
2657
|
/** 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 +2708,10 @@ declare interface FileSetMetadataOptionalParams extends coreClient.OperationOpti
|
|
2610
2708
|
metadata?: {
|
2611
2709
|
[propertyName: string]: string;
|
2612
2710
|
};
|
2711
|
+
/** Valid value is backup */
|
2712
|
+
fileRequestIntent?: ShareTokenIntent;
|
2713
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2714
|
+
allowTrailingDot?: boolean;
|
2613
2715
|
}
|
2614
2716
|
/**
|
2615
2717
|
* Options to configure the {@link ShareFileClient.setMetadata} operation.
|
@@ -2660,10 +2762,16 @@ declare interface FileStartCopyOptionalParams extends coreClient.OperationOption
|
|
2660
2762
|
metadata?: {
|
2661
2763
|
[propertyName: string]: string;
|
2662
2764
|
};
|
2765
|
+
/** Valid value is backup */
|
2766
|
+
fileRequestIntent?: ShareTokenIntent;
|
2767
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2768
|
+
allowTrailingDot?: boolean;
|
2663
2769
|
/** 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
2770
|
filePermission?: string;
|
2665
2771
|
/** 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
2772
|
filePermissionKey?: string;
|
2773
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
2774
|
+
allowSourceTrailingDot?: boolean;
|
2667
2775
|
}
|
2668
2776
|
/**
|
2669
2777
|
* Options to configure the {@link ShareFileClient.startCopyFromURL} operation.
|
@@ -2795,6 +2903,10 @@ export declare interface FileUploadRangeFromURLOptionalParams extends coreClient
|
|
2795
2903
|
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
2796
2904
|
/** 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
2905
|
timeoutInSeconds?: number;
|
2906
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2907
|
+
allowTrailingDot?: boolean;
|
2908
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
2909
|
+
allowSourceTrailingDot?: boolean;
|
2798
2910
|
/** If the file last write time should be preserved or overwritten */
|
2799
2911
|
fileLastWrittenMode?: FileLastWrittenMode;
|
2800
2912
|
/** Bytes of source data in the specified range. */
|
@@ -2874,6 +2986,10 @@ declare interface FileUploadRangeOptionalParams extends coreClient.OperationOpti
|
|
2874
2986
|
leaseAccessConditions?: LeaseAccessConditions;
|
2875
2987
|
/** 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
2988
|
timeoutInSeconds?: number;
|
2989
|
+
/** Valid value is backup */
|
2990
|
+
fileRequestIntent?: ShareTokenIntent;
|
2991
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2992
|
+
allowTrailingDot?: boolean;
|
2877
2993
|
/** Initial data. */
|
2878
2994
|
body?: coreRestPipeline.RequestBodyType;
|
2879
2995
|
/** 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). */
|
@@ -2990,6 +3106,7 @@ export declare interface HandleItem {
|
|
2990
3106
|
openTime: Date;
|
2991
3107
|
/** Time handle was last connected to (UTC) */
|
2992
3108
|
lastReconnectTime?: Date;
|
3109
|
+
accessRightList?: ShareFileHandleAccessRights[];
|
2993
3110
|
}
|
2994
3111
|
/** A listed Azure Storage handle item. */
|
2995
3112
|
declare interface HandleItem_2 {
|
@@ -3008,6 +3125,7 @@ declare interface HandleItem_2 {
|
|
3008
3125
|
openTime: Date;
|
3009
3126
|
/** Time handle was last connected to (UTC) */
|
3010
3127
|
lastReconnectTime?: Date;
|
3128
|
+
accessRightList?: AccessRight[];
|
3011
3129
|
}
|
3012
3130
|
/**
|
3013
3131
|
* Represents authentication information in Authorization, ProxyAuthorization,
|
@@ -3051,6 +3169,10 @@ export declare interface HttpResponse {
|
|
3051
3169
|
* @returns true when the argument satisfies the Pipeline contract
|
3052
3170
|
*/
|
3053
3171
|
export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
|
3172
|
+
/** Known values of {@link ShareTokenIntent} that the service accepts. */
|
3173
|
+
export declare enum KnownShareTokenIntent {
|
3174
|
+
Backup = "backup"
|
3175
|
+
}
|
3054
3176
|
/** Parameter group */
|
3055
3177
|
export declare interface LeaseAccessConditions {
|
3056
3178
|
/** If specified, the operation only succeeds if the resource's lease is active and matches this ID. */
|
@@ -3911,6 +4033,7 @@ export declare class ShareClient extends StorageClient {
|
|
3911
4033
|
*/
|
3912
4034
|
private context;
|
3913
4035
|
private _name;
|
4036
|
+
private shareClientConfig?;
|
3914
4037
|
/*
|
3915
4038
|
* The name of the share
|
3916
4039
|
*/
|
@@ -3925,7 +4048,7 @@ export declare class ShareClient extends StorageClient {
|
|
3925
4048
|
* @param name - Share name.
|
3926
4049
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
3927
4050
|
*/
|
3928
|
-
constructor(connectionString: string, name: string, options?:
|
4051
|
+
constructor(connectionString: string, name: string, options?: ShareClientOptions);
|
3929
4052
|
/**
|
3930
4053
|
* Creates an instance of ShareClient.
|
3931
4054
|
*
|
@@ -3937,7 +4060,8 @@ export declare class ShareClient extends StorageClient {
|
|
3937
4060
|
* If not specified, AnonymousCredential is used.
|
3938
4061
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
3939
4062
|
*/
|
3940
|
-
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?:
|
4063
|
+
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: ShareClientOptions);
|
4064
|
+
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?: ShareClientOptions);
|
3941
4065
|
/**
|
3942
4066
|
* Creates an instance of ShareClient.
|
3943
4067
|
*
|
@@ -3948,7 +4072,7 @@ export declare class ShareClient extends StorageClient {
|
|
3948
4072
|
* @param pipeline - Call newPipeline() to create a default
|
3949
4073
|
* pipeline, or provide a customized pipeline.
|
3950
4074
|
*/
|
3951
|
-
constructor(url: string, pipeline: Pipeline);
|
4075
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
|
3952
4076
|
/**
|
3953
4077
|
* Creates a new ShareClient object identical to the source but with the specified snapshot timestamp.
|
3954
4078
|
* Provide "" will remove the snapshot and return a URL to the base share.
|
@@ -4190,6 +4314,24 @@ export declare class ShareClient extends StorageClient {
|
|
4190
4314
|
*/
|
4191
4315
|
generateSasUrl(options: ShareGenerateSasUrlOptions): string;
|
4192
4316
|
}
|
4317
|
+
export declare interface ShareClientConfig {
|
4318
|
+
/**
|
4319
|
+
* The Files OAuth over REST feature requires special permissions to be included in the role definition to use
|
4320
|
+
* These special permissions will give privileged access to file share data -
|
4321
|
+
* It will allow users to bypass file/directory level ACL/NTFS permissions and get read/write access to file share data
|
4322
|
+
* Since this additional permission can be unintended and to prevent unintended and over privileged access,
|
4323
|
+
* additional checks has been implemented that requires users to explicitly indicate their intent to use these additional permissions.
|
4324
|
+
* This is done using the fileRequestIntent option.
|
4325
|
+
* Currently, the only value that the header supports is 'backup'
|
4326
|
+
* 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.
|
4327
|
+
*/
|
4328
|
+
fileRequestIntent?: ShareTokenIntent;
|
4329
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
4330
|
+
allowTrailingDot?: boolean;
|
4331
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
4332
|
+
allowSourceTrailingDot?: boolean;
|
4333
|
+
}
|
4334
|
+
export declare type ShareClientOptions = StoragePipelineOptions & ShareClientConfig;
|
4193
4335
|
/** Defines headers for Share_create operation. */
|
4194
4336
|
export declare interface ShareCreateHeaders {
|
4195
4337
|
/** The ETag contains a value which represents the version of the share, in quotes. */
|
@@ -4283,6 +4425,8 @@ export declare interface ShareCreatePermissionHeaders {
|
|
4283
4425
|
declare interface ShareCreatePermissionOptionalParams extends coreClient.OperationOptions {
|
4284
4426
|
/** 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
4427
|
timeoutInSeconds?: number;
|
4428
|
+
/** Valid value is backup */
|
4429
|
+
fileRequestIntent?: ShareTokenIntent;
|
4286
4430
|
}
|
4287
4431
|
/**
|
4288
4432
|
* Options to configure the {@link ShareClient.createPermission} operation.
|
@@ -4414,6 +4558,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
4414
4558
|
private _shareName;
|
4415
4559
|
private _path;
|
4416
4560
|
private _name;
|
4561
|
+
private shareClientConfig?;
|
4417
4562
|
/*
|
4418
4563
|
* The share name corresponding to this directory client
|
4419
4564
|
*/
|
@@ -4441,7 +4586,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
4441
4586
|
* If not specified, AnonymousCredential is used.
|
4442
4587
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
4443
4588
|
*/
|
4444
|
-
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?:
|
4589
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
|
4445
4590
|
/**
|
4446
4591
|
* Creates an instance of DirectoryClient.
|
4447
4592
|
*
|
@@ -4456,7 +4601,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
4456
4601
|
* @param pipeline - Call newPipeline() to create a default
|
4457
4602
|
* pipeline, or provide a customized pipeline.
|
4458
4603
|
*/
|
4459
|
-
constructor(url: string, pipeline: Pipeline);
|
4604
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
|
4460
4605
|
/**
|
4461
4606
|
* Creates a new directory under the specified share or parent directory.
|
4462
4607
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
|
@@ -4924,6 +5069,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
4924
5069
|
private _shareName;
|
4925
5070
|
private _path;
|
4926
5071
|
private _name;
|
5072
|
+
private shareClientConfig?;
|
4927
5073
|
/*
|
4928
5074
|
* The share name corresponding to this file client
|
4929
5075
|
*/
|
@@ -4947,11 +5093,11 @@ export declare class ShareFileClient extends StorageClient {
|
|
4947
5093
|
* Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
|
4948
5094
|
* However, if a file or directory name includes %, file or directory name must be encoded in the URL.
|
4949
5095
|
* 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
|
5096
|
+
* @param credential - Such as , StorageSharedKeyCredential or TokenCredential,
|
4951
5097
|
* If not specified, AnonymousCredential is used.
|
4952
5098
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
4953
5099
|
*/
|
4954
|
-
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?:
|
5100
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
|
4955
5101
|
/**
|
4956
5102
|
* Creates an instance of ShareFileClient.
|
4957
5103
|
*
|
@@ -4966,7 +5112,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
4966
5112
|
* @param pipeline - Call newPipeline() to create a default
|
4967
5113
|
* pipeline, or provide a customized pipeline.
|
4968
5114
|
*/
|
4969
|
-
constructor(url: string, pipeline: Pipeline);
|
5115
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
|
4970
5116
|
/**
|
4971
5117
|
* Creates a new ShareFileClient object identical to the source but with the specified share snapshot timestamp.
|
4972
5118
|
* Provide "" will remove the snapshot and return a URL to the base ShareFileClient.
|
@@ -5473,6 +5619,8 @@ export declare class ShareFileClient extends StorageClient {
|
|
5473
5619
|
fileRenameResponse: FileRenameResponse;
|
5474
5620
|
}>;
|
5475
5621
|
}
|
5622
|
+
/** Defines values for AccessRight. */
|
5623
|
+
export declare type ShareFileHandleAccessRights = "Read" | "Write" | "Delete";
|
5476
5624
|
/** The list of file ranges */
|
5477
5625
|
export declare interface ShareFileRangeList {
|
5478
5626
|
ranges?: RangeModel[];
|
@@ -5543,6 +5691,8 @@ export declare interface ShareGetPermissionHeaders {
|
|
5543
5691
|
declare interface ShareGetPermissionOptionalParams extends coreClient.OperationOptions {
|
5544
5692
|
/** 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
5693
|
timeoutInSeconds?: number;
|
5694
|
+
/** Valid value is backup */
|
5695
|
+
fileRequestIntent?: ShareTokenIntent;
|
5546
5696
|
}
|
5547
5697
|
/**
|
5548
5698
|
* Options to configure the {@link ShareClient.getPermission} operation.
|
@@ -5982,6 +6132,7 @@ export declare class ShareServiceClient extends StorageClient {
|
|
5982
6132
|
* serviceContext provided by protocol layer.
|
5983
6133
|
*/
|
5984
6134
|
private serviceContext;
|
6135
|
+
private shareClientConfig?;
|
5985
6136
|
/**
|
5986
6137
|
*
|
5987
6138
|
* Creates an instance of ShareServiceClient from connection string.
|
@@ -5995,18 +6146,18 @@ export declare class ShareServiceClient extends StorageClient {
|
|
5995
6146
|
* @param options - Options to configure the HTTP pipeline.
|
5996
6147
|
* @returns A new ShareServiceClient from the given connection string.
|
5997
6148
|
*/
|
5998
|
-
static fromConnectionString(connectionString: string, options?:
|
6149
|
+
static fromConnectionString(connectionString: string, options?: ShareClientOptions): ShareServiceClient;
|
5999
6150
|
/**
|
6000
6151
|
* Creates an instance of ShareServiceClient.
|
6001
6152
|
*
|
6002
6153
|
* @param url - A URL string pointing to Azure Storage file service, such as
|
6003
6154
|
* "https://myaccount.file.core.windows.net". You can Append a SAS
|
6004
6155
|
* if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
|
6005
|
-
* @param credential - Such as AnonymousCredential or
|
6156
|
+
* @param credential - Such as AnonymousCredential, StorageSharedKeyCredential, or TokenCredential,
|
6006
6157
|
* If not specified, AnonymousCredential is used.
|
6007
6158
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
6008
6159
|
*/
|
6009
|
-
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?:
|
6160
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
|
6010
6161
|
/**
|
6011
6162
|
* Creates an instance of ShareServiceClient.
|
6012
6163
|
*
|
@@ -6015,8 +6166,9 @@ export declare class ShareServiceClient extends StorageClient {
|
|
6015
6166
|
* if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
|
6016
6167
|
* @param pipeline - Call newPipeline() to create a default
|
6017
6168
|
* pipeline, or provide a customized pipeline.
|
6169
|
+
* @param options - Optional. Options to configure the HTTP pipeline.
|
6018
6170
|
*/
|
6019
|
-
constructor(url: string, pipeline: Pipeline);
|
6171
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientOptions);
|
6020
6172
|
/**
|
6021
6173
|
* Creates a ShareClient object.
|
6022
6174
|
*
|
@@ -6383,6 +6535,14 @@ export declare interface ShareStats {
|
|
6383
6535
|
/** The approximate size of the data stored in bytes. Note that this value may not include all recently created or recently resized files. */
|
6384
6536
|
shareUsageBytes: number;
|
6385
6537
|
}
|
6538
|
+
/**
|
6539
|
+
* Defines values for ShareTokenIntent. \
|
6540
|
+
* {@link KnownShareTokenIntent} can be used interchangeably with ShareTokenIntent,
|
6541
|
+
* this enum contains the known values that the service supports.
|
6542
|
+
* ### Known values supported by the service
|
6543
|
+
* **backup**
|
6544
|
+
*/
|
6545
|
+
export declare type ShareTokenIntent = string;
|
6386
6546
|
/**
|
6387
6547
|
* Signed Identifier
|
6388
6548
|
*/
|