@azure/storage-file-share 12.20.0-alpha.20230622.3 → 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 +186 -74
- package/dist/index.js.map +1 -1
- package/dist-esm/storage-blob/src/Clients.js +6 -0
- package/dist-esm/storage-blob/src/Clients.js.map +1 -1
- package/dist-esm/storage-blob/src/ContainerClient.js +1 -3
- package/dist-esm/storage-blob/src/ContainerClient.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/models/parameters.js +1 -1
- package/dist-esm/storage-blob/src/generated/src/models/parameters.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/storageClient.js +1 -1
- package/dist-esm/storage-blob/src/generated/src/storageClient.js.map +1 -1
- package/dist-esm/storage-blob/src/utils/constants.js +1 -1
- package/dist-esm/storage-blob/src/utils/constants.js.map +1 -1
- package/dist-esm/storage-blob/src/utils/utils.common.js +1 -3
- package/dist-esm/storage-blob/src/utils/utils.common.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/index.js +1 -1
- package/dist-esm/storage-file-share/src/index.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 +206 -40
- package/types/latest/storage-file-share.d.ts +218 -40
@@ -2,26 +2,26 @@
|
|
2
2
|
|
3
3
|
import { AbortSignalLike } from '@azure/abort-controller';
|
4
4
|
import { AzureLogger } from '@azure/logger';
|
5
|
-
import { CompatResponse } from '@azure/core-http-compat';
|
6
5
|
import * as coreClient from '@azure/core-client';
|
7
6
|
import * as coreHttpCompat from '@azure/core-http-compat';
|
8
7
|
import * as coreRestPipeline from '@azure/core-rest-pipeline';
|
9
|
-
import { HttpHeadersLike } from '@azure/core-http-compat';
|
8
|
+
import { HttpHeadersLike as HttpHeaders } from '@azure/core-http-compat';
|
9
|
+
import { CompatResponse as HttpOperationResponse } from '@azure/core-http-compat';
|
10
10
|
import { HttpPipelineLogLevel } from '@azure/core-http-compat';
|
11
|
+
import { RequestBodyType as HttpRequestBody } from '@azure/core-rest-pipeline';
|
11
12
|
import { KeepAliveOptions } from '@azure/core-http-compat';
|
12
13
|
import { OperationTracingOptions } from '@azure/core-tracing';
|
13
14
|
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
14
15
|
import { ProxySettings } from '@azure/core-rest-pipeline';
|
15
16
|
import { Readable } from 'stream';
|
16
|
-
import { RequestBodyType } from '@azure/core-rest-pipeline';
|
17
17
|
import { RequestPolicy } from '@azure/core-http-compat';
|
18
18
|
import { RequestPolicyFactory } from '@azure/core-http-compat';
|
19
|
-
import { RequestPolicyOptionsLike } from '@azure/core-http-compat';
|
19
|
+
import { RequestPolicyOptionsLike as RequestPolicyOptions } from '@azure/core-http-compat';
|
20
20
|
import { RestError } from '@azure/core-rest-pipeline';
|
21
21
|
import { TokenCredential } from '@azure/core-auth';
|
22
22
|
import { TransferProgressEvent } from '@azure/core-rest-pipeline';
|
23
23
|
import { UserAgentPolicyOptions } from '@azure/core-rest-pipeline';
|
24
|
-
import { WebResourceLike } from '@azure/core-http-compat';
|
24
|
+
import { WebResourceLike as WebResource } from '@azure/core-http-compat';
|
25
25
|
|
26
26
|
/** An Access policy. */
|
27
27
|
export declare interface AccessPolicy {
|
@@ -238,7 +238,7 @@ export declare class AnonymousCredential extends Credential_2 {
|
|
238
238
|
* @param nextPolicy -
|
239
239
|
* @param options -
|
240
240
|
*/
|
241
|
-
create(nextPolicy: RequestPolicy, options:
|
241
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): AnonymousCredentialPolicy;
|
242
242
|
}
|
243
243
|
|
244
244
|
/**
|
@@ -251,7 +251,7 @@ export declare class AnonymousCredentialPolicy extends CredentialPolicy {
|
|
251
251
|
* @param nextPolicy -
|
252
252
|
* @param options -
|
253
253
|
*/
|
254
|
-
constructor(nextPolicy: RequestPolicy, options:
|
254
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
|
255
255
|
}
|
256
256
|
|
257
257
|
/**
|
@@ -265,7 +265,7 @@ export declare abstract class BaseRequestPolicy implements RequestPolicy {
|
|
265
265
|
/**
|
266
266
|
* The options that can be passed to a given request policy.
|
267
267
|
*/
|
268
|
-
readonly _options:
|
268
|
+
readonly _options: RequestPolicyOptions;
|
269
269
|
/**
|
270
270
|
* The main method to implement that manipulates a request/response.
|
271
271
|
*/
|
@@ -277,12 +277,12 @@ export declare abstract class BaseRequestPolicy implements RequestPolicy {
|
|
277
277
|
/**
|
278
278
|
* The options that can be passed to a given request policy.
|
279
279
|
*/
|
280
|
-
_options:
|
280
|
+
_options: RequestPolicyOptions);
|
281
281
|
/**
|
282
282
|
* Sends a network request based on the given web resource.
|
283
283
|
* @param webResource - A {@link WebResourceLike} that describes a HTTP request to be made.
|
284
284
|
*/
|
285
|
-
abstract sendRequest(webResource:
|
285
|
+
abstract sendRequest(webResource: WebResource): Promise<HttpOperationResponse>;
|
286
286
|
/**
|
287
287
|
* Get whether or not a log with the provided log level should be logged.
|
288
288
|
* @param logLevel - The log level of the log that will be logged.
|
@@ -420,7 +420,7 @@ declare abstract class Credential_2 implements RequestPolicyFactory {
|
|
420
420
|
* @param _nextPolicy -
|
421
421
|
* @param _options -
|
422
422
|
*/
|
423
|
-
create(_nextPolicy: RequestPolicy, _options:
|
423
|
+
create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
|
424
424
|
}
|
425
425
|
export { Credential_2 as Credential }
|
426
426
|
|
@@ -434,20 +434,20 @@ export declare abstract class CredentialPolicy extends BaseRequestPolicy {
|
|
434
434
|
*
|
435
435
|
* @param request -
|
436
436
|
*/
|
437
|
-
sendRequest(request:
|
437
|
+
sendRequest(request: WebResource): Promise<HttpOperationResponse>;
|
438
438
|
/**
|
439
439
|
* Child classes must implement this method with request signing. This method
|
440
440
|
* will be executed in {@link sendRequest}.
|
441
441
|
*
|
442
442
|
* @param request -
|
443
443
|
*/
|
444
|
-
protected signRequest(request:
|
444
|
+
protected signRequest(request: WebResource): WebResource;
|
445
445
|
}
|
446
446
|
|
447
447
|
/**
|
448
448
|
* A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
|
449
449
|
*/
|
450
|
-
export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options:
|
450
|
+
export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptions) => CredentialPolicy;
|
451
451
|
|
452
452
|
/** Defines values for DeleteSnapshotsOptionType. */
|
453
453
|
export declare type DeleteSnapshotsOptionType = "include" | "include-leased";
|
@@ -593,6 +593,10 @@ declare interface DirectoryCreateOptionalParams extends coreClient.OperationOpti
|
|
593
593
|
metadata?: {
|
594
594
|
[propertyName: string]: string;
|
595
595
|
};
|
596
|
+
/** Valid value is backup */
|
597
|
+
fileRequestIntent?: ShareTokenIntent;
|
598
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
599
|
+
allowTrailingDot?: boolean;
|
596
600
|
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
597
601
|
filePermission?: string;
|
598
602
|
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
@@ -652,6 +656,10 @@ export declare interface DirectoryDeleteIfExistsResponse extends DirectoryDelete
|
|
652
656
|
declare interface DirectoryDeleteOptionalParams extends coreClient.OperationOptions {
|
653
657
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
654
658
|
timeoutInSeconds?: number;
|
659
|
+
/** Valid value is backup */
|
660
|
+
fileRequestIntent?: ShareTokenIntent;
|
661
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
662
|
+
allowTrailingDot?: boolean;
|
655
663
|
}
|
656
664
|
|
657
665
|
/**
|
@@ -708,6 +716,10 @@ declare interface DirectoryForceCloseHandlesOptionalParams extends coreClient.Op
|
|
708
716
|
marker?: string;
|
709
717
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
710
718
|
shareSnapshot?: string;
|
719
|
+
/** Valid value is backup */
|
720
|
+
fileRequestIntent?: ShareTokenIntent;
|
721
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
722
|
+
allowTrailingDot?: boolean;
|
711
723
|
/** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
|
712
724
|
recursive?: boolean;
|
713
725
|
}
|
@@ -793,6 +805,10 @@ declare interface DirectoryGetPropertiesOptionalParams extends coreClient.Operat
|
|
793
805
|
timeoutInSeconds?: number;
|
794
806
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
795
807
|
shareSnapshot?: string;
|
808
|
+
/** Valid value is backup */
|
809
|
+
fileRequestIntent?: ShareTokenIntent;
|
810
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
811
|
+
allowTrailingDot?: boolean;
|
796
812
|
}
|
797
813
|
|
798
814
|
/**
|
@@ -883,6 +899,10 @@ declare interface DirectoryListFilesAndDirectoriesSegmentOptionalParams extends
|
|
883
899
|
maxResults?: number;
|
884
900
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
885
901
|
shareSnapshot?: string;
|
902
|
+
/** Valid value is backup */
|
903
|
+
fileRequestIntent?: ShareTokenIntent;
|
904
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
905
|
+
allowTrailingDot?: boolean;
|
886
906
|
/** Include this parameter to specify one or more datasets to include in the response. */
|
887
907
|
include?: ListFilesIncludeType[];
|
888
908
|
/** Include extended information. */
|
@@ -919,6 +939,10 @@ declare interface DirectoryListHandlesOptionalParams extends coreClient.Operatio
|
|
919
939
|
maxResults?: number;
|
920
940
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
921
941
|
shareSnapshot?: string;
|
942
|
+
/** Valid value is backup */
|
943
|
+
fileRequestIntent?: ShareTokenIntent;
|
944
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
945
|
+
allowTrailingDot?: boolean;
|
922
946
|
/** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
|
923
947
|
recursive?: boolean;
|
924
948
|
}
|
@@ -1024,6 +1048,10 @@ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOpti
|
|
1024
1048
|
metadata?: {
|
1025
1049
|
[propertyName: string]: string;
|
1026
1050
|
};
|
1051
|
+
/** Valid value is backup */
|
1052
|
+
fileRequestIntent?: ShareTokenIntent;
|
1053
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1054
|
+
allowTrailingDot?: boolean;
|
1027
1055
|
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
1028
1056
|
filePermission?: string;
|
1029
1057
|
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
@@ -1032,6 +1060,8 @@ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOpti
|
|
1032
1060
|
replaceIfExists?: boolean;
|
1033
1061
|
/** Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail. */
|
1034
1062
|
ignoreReadOnly?: boolean;
|
1063
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
1064
|
+
allowSourceTrailingDot?: boolean;
|
1035
1065
|
}
|
1036
1066
|
|
1037
1067
|
/**
|
@@ -1118,6 +1148,10 @@ declare interface DirectorySetMetadataOptionalParams extends coreClient.Operatio
|
|
1118
1148
|
metadata?: {
|
1119
1149
|
[propertyName: string]: string;
|
1120
1150
|
};
|
1151
|
+
/** Valid value is backup */
|
1152
|
+
fileRequestIntent?: ShareTokenIntent;
|
1153
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1154
|
+
allowTrailingDot?: boolean;
|
1121
1155
|
}
|
1122
1156
|
|
1123
1157
|
/**
|
@@ -1173,6 +1207,10 @@ export declare interface DirectorySetPropertiesHeaders {
|
|
1173
1207
|
declare interface DirectorySetPropertiesOptionalParams extends coreClient.OperationOptions {
|
1174
1208
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1175
1209
|
timeoutInSeconds?: number;
|
1210
|
+
/** Valid value is backup */
|
1211
|
+
fileRequestIntent?: ShareTokenIntent;
|
1212
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1213
|
+
allowTrailingDot?: boolean;
|
1176
1214
|
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
1177
1215
|
filePermission?: string;
|
1178
1216
|
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
@@ -1363,6 +1401,10 @@ declare interface FileAbortCopyOptionalParams extends coreClient.OperationOption
|
|
1363
1401
|
leaseAccessConditions?: LeaseAccessConditions;
|
1364
1402
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1365
1403
|
timeoutInSeconds?: number;
|
1404
|
+
/** Valid value is backup */
|
1405
|
+
fileRequestIntent?: ShareTokenIntent;
|
1406
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1407
|
+
allowTrailingDot?: boolean;
|
1366
1408
|
}
|
1367
1409
|
|
1368
1410
|
/** Contains response data for the abortCopy operation. */
|
@@ -1399,6 +1441,10 @@ declare interface FileAcquireLeaseOptionalParams extends coreClient.OperationOpt
|
|
1399
1441
|
proposedLeaseId?: string;
|
1400
1442
|
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
1401
1443
|
requestId?: string;
|
1444
|
+
/** Valid value is backup */
|
1445
|
+
fileRequestIntent?: ShareTokenIntent;
|
1446
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1447
|
+
allowTrailingDot?: boolean;
|
1402
1448
|
}
|
1403
1449
|
|
1404
1450
|
/** Contains response data for the acquireLease operation. */
|
@@ -1518,6 +1564,10 @@ declare interface FileBreakLeaseOptionalParams extends coreClient.OperationOptio
|
|
1518
1564
|
timeoutInSeconds?: number;
|
1519
1565
|
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
1520
1566
|
requestId?: string;
|
1567
|
+
/** Valid value is backup */
|
1568
|
+
fileRequestIntent?: ShareTokenIntent;
|
1569
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1570
|
+
allowTrailingDot?: boolean;
|
1521
1571
|
}
|
1522
1572
|
|
1523
1573
|
/** Contains response data for the breakLease operation. */
|
@@ -1549,6 +1599,10 @@ declare interface FileChangeLeaseOptionalParams extends coreClient.OperationOpti
|
|
1549
1599
|
proposedLeaseId?: string;
|
1550
1600
|
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
1551
1601
|
requestId?: string;
|
1602
|
+
/** Valid value is backup */
|
1603
|
+
fileRequestIntent?: ShareTokenIntent;
|
1604
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1605
|
+
allowTrailingDot?: boolean;
|
1552
1606
|
}
|
1553
1607
|
|
1554
1608
|
/** Contains response data for the changeLease operation. */
|
@@ -1645,6 +1699,10 @@ declare interface FileCreateOptionalParams extends coreClient.OperationOptions {
|
|
1645
1699
|
metadata?: {
|
1646
1700
|
[propertyName: string]: string;
|
1647
1701
|
};
|
1702
|
+
/** Valid value is backup */
|
1703
|
+
fileRequestIntent?: ShareTokenIntent;
|
1704
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1705
|
+
allowTrailingDot?: boolean;
|
1648
1706
|
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
1649
1707
|
filePermission?: string;
|
1650
1708
|
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
@@ -1714,6 +1772,10 @@ declare interface FileDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1714
1772
|
leaseAccessConditions?: LeaseAccessConditions;
|
1715
1773
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1716
1774
|
timeoutInSeconds?: number;
|
1775
|
+
/** Valid value is backup */
|
1776
|
+
fileRequestIntent?: ShareTokenIntent;
|
1777
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1778
|
+
allowTrailingDot?: boolean;
|
1717
1779
|
}
|
1718
1780
|
|
1719
1781
|
/**
|
@@ -1817,6 +1879,10 @@ export declare interface FileDownloadOptionalParams extends coreClient.Operation
|
|
1817
1879
|
leaseAccessConditions?: LeaseAccessConditions;
|
1818
1880
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1819
1881
|
timeoutInSeconds?: number;
|
1882
|
+
/** Valid value is backup */
|
1883
|
+
fileRequestIntent?: ShareTokenIntent;
|
1884
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1885
|
+
allowTrailingDot?: boolean;
|
1820
1886
|
/** Return file data only from the specified byte range. */
|
1821
1887
|
range?: string;
|
1822
1888
|
/** When this header is set to true and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. */
|
@@ -1950,6 +2016,10 @@ declare interface FileForceCloseHandlesOptionalParams extends coreClient.Operati
|
|
1950
2016
|
marker?: string;
|
1951
2017
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
1952
2018
|
shareSnapshot?: string;
|
2019
|
+
/** Valid value is backup */
|
2020
|
+
fileRequestIntent?: ShareTokenIntent;
|
2021
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2022
|
+
allowTrailingDot?: boolean;
|
1953
2023
|
}
|
1954
2024
|
|
1955
2025
|
/**
|
@@ -2064,6 +2134,10 @@ declare interface FileGetPropertiesOptionalParams extends coreClient.OperationOp
|
|
2064
2134
|
timeoutInSeconds?: number;
|
2065
2135
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
2066
2136
|
shareSnapshot?: string;
|
2137
|
+
/** Valid value is backup */
|
2138
|
+
fileRequestIntent?: ShareTokenIntent;
|
2139
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2140
|
+
allowTrailingDot?: boolean;
|
2067
2141
|
}
|
2068
2142
|
|
2069
2143
|
/**
|
@@ -2116,6 +2190,10 @@ declare interface FileGetRangeListOptionalParams extends coreClient.OperationOpt
|
|
2116
2190
|
timeoutInSeconds?: number;
|
2117
2191
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
2118
2192
|
shareSnapshot?: string;
|
2193
|
+
/** Valid value is backup */
|
2194
|
+
fileRequestIntent?: ShareTokenIntent;
|
2195
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2196
|
+
allowTrailingDot?: boolean;
|
2119
2197
|
/** Specifies the range of bytes over which to list ranges, inclusively. */
|
2120
2198
|
range?: string;
|
2121
2199
|
/** The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot. */
|
@@ -2260,6 +2338,10 @@ declare interface FileListHandlesOptionalParams extends coreClient.OperationOpti
|
|
2260
2338
|
maxResults?: number;
|
2261
2339
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
2262
2340
|
shareSnapshot?: string;
|
2341
|
+
/** Valid value is backup */
|
2342
|
+
fileRequestIntent?: ShareTokenIntent;
|
2343
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2344
|
+
allowTrailingDot?: boolean;
|
2263
2345
|
}
|
2264
2346
|
|
2265
2347
|
export declare interface FileListHandlesOptions extends CommonOptions {
|
@@ -2401,6 +2483,10 @@ declare interface FileReleaseLeaseOptionalParams extends coreClient.OperationOpt
|
|
2401
2483
|
timeoutInSeconds?: number;
|
2402
2484
|
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
2403
2485
|
requestId?: string;
|
2486
|
+
/** Valid value is backup */
|
2487
|
+
fileRequestIntent?: ShareTokenIntent;
|
2488
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2489
|
+
allowTrailingDot?: boolean;
|
2404
2490
|
}
|
2405
2491
|
|
2406
2492
|
/** Contains response data for the releaseLease operation. */
|
@@ -2452,6 +2538,10 @@ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
|
|
2452
2538
|
metadata?: {
|
2453
2539
|
[propertyName: string]: string;
|
2454
2540
|
};
|
2541
|
+
/** Valid value is backup */
|
2542
|
+
fileRequestIntent?: ShareTokenIntent;
|
2543
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2544
|
+
allowTrailingDot?: boolean;
|
2455
2545
|
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
2456
2546
|
filePermission?: string;
|
2457
2547
|
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
@@ -2460,6 +2550,8 @@ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
|
|
2460
2550
|
replaceIfExists?: boolean;
|
2461
2551
|
/** Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail. */
|
2462
2552
|
ignoreReadOnly?: boolean;
|
2553
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
2554
|
+
allowSourceTrailingDot?: boolean;
|
2463
2555
|
}
|
2464
2556
|
|
2465
2557
|
/**
|
@@ -2716,6 +2808,10 @@ declare interface FileSetHttpHeadersOptionalParams extends coreClient.OperationO
|
|
2716
2808
|
fileHttpHeaders?: FileHttpHeaders_2;
|
2717
2809
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
2718
2810
|
timeoutInSeconds?: number;
|
2811
|
+
/** Valid value is backup */
|
2812
|
+
fileRequestIntent?: ShareTokenIntent;
|
2813
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2814
|
+
allowTrailingDot?: boolean;
|
2719
2815
|
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
2720
2816
|
filePermission?: string;
|
2721
2817
|
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
@@ -2777,6 +2873,10 @@ declare interface FileSetMetadataOptionalParams extends coreClient.OperationOpti
|
|
2777
2873
|
metadata?: {
|
2778
2874
|
[propertyName: string]: string;
|
2779
2875
|
};
|
2876
|
+
/** Valid value is backup */
|
2877
|
+
fileRequestIntent?: ShareTokenIntent;
|
2878
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2879
|
+
allowTrailingDot?: boolean;
|
2780
2880
|
}
|
2781
2881
|
|
2782
2882
|
/**
|
@@ -2832,10 +2932,16 @@ declare interface FileStartCopyOptionalParams extends coreClient.OperationOption
|
|
2832
2932
|
metadata?: {
|
2833
2933
|
[propertyName: string]: string;
|
2834
2934
|
};
|
2935
|
+
/** Valid value is backup */
|
2936
|
+
fileRequestIntent?: ShareTokenIntent;
|
2937
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2938
|
+
allowTrailingDot?: boolean;
|
2835
2939
|
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
2836
2940
|
filePermission?: string;
|
2837
2941
|
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
2838
2942
|
filePermissionKey?: string;
|
2943
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
2944
|
+
allowSourceTrailingDot?: boolean;
|
2839
2945
|
}
|
2840
2946
|
|
2841
2947
|
/**
|
@@ -2973,6 +3079,10 @@ export declare interface FileUploadRangeFromURLOptionalParams extends coreClient
|
|
2973
3079
|
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
2974
3080
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
2975
3081
|
timeoutInSeconds?: number;
|
3082
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
3083
|
+
allowTrailingDot?: boolean;
|
3084
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
3085
|
+
allowSourceTrailingDot?: boolean;
|
2976
3086
|
/** If the file last write time should be preserved or overwritten */
|
2977
3087
|
fileLastWrittenMode?: FileLastWrittenMode;
|
2978
3088
|
/** Bytes of source data in the specified range. */
|
@@ -3057,6 +3167,10 @@ declare interface FileUploadRangeOptionalParams extends coreClient.OperationOpti
|
|
3057
3167
|
leaseAccessConditions?: LeaseAccessConditions;
|
3058
3168
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
3059
3169
|
timeoutInSeconds?: number;
|
3170
|
+
/** Valid value is backup */
|
3171
|
+
fileRequestIntent?: ShareTokenIntent;
|
3172
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
3173
|
+
allowTrailingDot?: boolean;
|
3060
3174
|
/** Initial data. */
|
3061
3175
|
body?: coreRestPipeline.RequestBodyType;
|
3062
3176
|
/** An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5 header is specified, the File service compares the hash of the content that has arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). */
|
@@ -3216,6 +3330,12 @@ export declare interface HttpAuthorization {
|
|
3216
3330
|
value: string;
|
3217
3331
|
}
|
3218
3332
|
|
3333
|
+
export { HttpHeaders }
|
3334
|
+
|
3335
|
+
export { HttpOperationResponse }
|
3336
|
+
|
3337
|
+
export { HttpRequestBody }
|
3338
|
+
|
3219
3339
|
/**
|
3220
3340
|
* A representation of an HTTP response that
|
3221
3341
|
* includes a reference to the request that
|
@@ -3225,11 +3345,11 @@ export declare interface HttpResponse {
|
|
3225
3345
|
/**
|
3226
3346
|
* The headers from the response.
|
3227
3347
|
*/
|
3228
|
-
headers:
|
3348
|
+
headers: HttpHeaders;
|
3229
3349
|
/**
|
3230
3350
|
* The original request that resulted in this response.
|
3231
3351
|
*/
|
3232
|
-
request:
|
3352
|
+
request: WebResource;
|
3233
3353
|
/**
|
3234
3354
|
* The HTTP status code returned from the service.
|
3235
3355
|
*/
|
@@ -3243,6 +3363,11 @@ export declare interface HttpResponse {
|
|
3243
3363
|
*/
|
3244
3364
|
export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
|
3245
3365
|
|
3366
|
+
/** Known values of {@link ShareTokenIntent} that the service accepts. */
|
3367
|
+
export declare enum KnownShareTokenIntent {
|
3368
|
+
Backup = "backup"
|
3369
|
+
}
|
3370
|
+
|
3246
3371
|
/** Parameter group */
|
3247
3372
|
export declare interface LeaseAccessConditions {
|
3248
3373
|
/** If specified, the operation only succeeds if the resource's lease is active and matches this ID. */
|
@@ -3533,6 +3658,13 @@ export declare type RawFileDownloadResponse = FileDownloadHeaders & {
|
|
3533
3658
|
readableStreamBody?: NodeJS.ReadableStream;
|
3534
3659
|
};
|
3535
3660
|
|
3661
|
+
export { RequestPolicy as IHttpClient }
|
3662
|
+
export { RequestPolicy }
|
3663
|
+
|
3664
|
+
export { RequestPolicyFactory }
|
3665
|
+
|
3666
|
+
export { RequestPolicyOptions }
|
3667
|
+
|
3536
3668
|
/**
|
3537
3669
|
* An object with a simple _response property.
|
3538
3670
|
*/
|
@@ -4164,6 +4296,7 @@ export declare class ShareClient extends StorageClient {
|
|
4164
4296
|
*/
|
4165
4297
|
private context;
|
4166
4298
|
private _name;
|
4299
|
+
private shareClientConfig?;
|
4167
4300
|
/**
|
4168
4301
|
* The name of the share
|
4169
4302
|
*/
|
@@ -4178,7 +4311,7 @@ export declare class ShareClient extends StorageClient {
|
|
4178
4311
|
* @param name - Share name.
|
4179
4312
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
4180
4313
|
*/
|
4181
|
-
constructor(connectionString: string, name: string, options?:
|
4314
|
+
constructor(connectionString: string, name: string, options?: ShareClientOptions);
|
4182
4315
|
/**
|
4183
4316
|
* Creates an instance of ShareClient.
|
4184
4317
|
*
|
@@ -4190,7 +4323,8 @@ export declare class ShareClient extends StorageClient {
|
|
4190
4323
|
* If not specified, AnonymousCredential is used.
|
4191
4324
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
4192
4325
|
*/
|
4193
|
-
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?:
|
4326
|
+
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: ShareClientOptions);
|
4327
|
+
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?: ShareClientOptions);
|
4194
4328
|
/**
|
4195
4329
|
* Creates an instance of ShareClient.
|
4196
4330
|
*
|
@@ -4201,7 +4335,7 @@ export declare class ShareClient extends StorageClient {
|
|
4201
4335
|
* @param pipeline - Call newPipeline() to create a default
|
4202
4336
|
* pipeline, or provide a customized pipeline.
|
4203
4337
|
*/
|
4204
|
-
constructor(url: string, pipeline: Pipeline);
|
4338
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
|
4205
4339
|
/**
|
4206
4340
|
* Creates a new ShareClient object identical to the source but with the specified snapshot timestamp.
|
4207
4341
|
* Provide "" will remove the snapshot and return a URL to the base share.
|
@@ -4444,6 +4578,26 @@ export declare class ShareClient extends StorageClient {
|
|
4444
4578
|
generateSasUrl(options: ShareGenerateSasUrlOptions): string;
|
4445
4579
|
}
|
4446
4580
|
|
4581
|
+
export declare interface ShareClientConfig {
|
4582
|
+
/**
|
4583
|
+
* The Files OAuth over REST feature requires special permissions to be included in the role definition to use
|
4584
|
+
* These special permissions will give privileged access to file share data -
|
4585
|
+
* It will allow users to bypass file/directory level ACL/NTFS permissions and get read/write access to file share data
|
4586
|
+
* Since this additional permission can be unintended and to prevent unintended and over privileged access,
|
4587
|
+
* additional checks has been implemented that requires users to explicitly indicate their intent to use these additional permissions.
|
4588
|
+
* This is done using the fileRequestIntent option.
|
4589
|
+
* Currently, the only value that the header supports is 'backup'
|
4590
|
+
* Any user who wishes to use Files OAuth over REST feature has to call the API with the intent header. If the API is not called with the intent header, any subsequent data operation requests will be denied.
|
4591
|
+
*/
|
4592
|
+
fileRequestIntent?: ShareTokenIntent;
|
4593
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
4594
|
+
allowTrailingDot?: boolean;
|
4595
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
4596
|
+
allowSourceTrailingDot?: boolean;
|
4597
|
+
}
|
4598
|
+
|
4599
|
+
export declare type ShareClientOptions = StoragePipelineOptions & ShareClientConfig;
|
4600
|
+
|
4447
4601
|
/** Defines headers for Share_create operation. */
|
4448
4602
|
export declare interface ShareCreateHeaders {
|
4449
4603
|
/** The ETag contains a value which represents the version of the share, in quotes. */
|
@@ -4542,6 +4696,8 @@ export declare interface ShareCreatePermissionHeaders {
|
|
4542
4696
|
declare interface ShareCreatePermissionOptionalParams extends coreClient.OperationOptions {
|
4543
4697
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
4544
4698
|
timeoutInSeconds?: number;
|
4699
|
+
/** Valid value is backup */
|
4700
|
+
fileRequestIntent?: ShareTokenIntent;
|
4545
4701
|
}
|
4546
4702
|
|
4547
4703
|
/**
|
@@ -4690,6 +4846,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
4690
4846
|
private _shareName;
|
4691
4847
|
private _path;
|
4692
4848
|
private _name;
|
4849
|
+
private shareClientConfig?;
|
4693
4850
|
/**
|
4694
4851
|
* The share name corresponding to this directory client
|
4695
4852
|
*/
|
@@ -4717,7 +4874,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
4717
4874
|
* If not specified, AnonymousCredential is used.
|
4718
4875
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
4719
4876
|
*/
|
4720
|
-
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?:
|
4877
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
|
4721
4878
|
/**
|
4722
4879
|
* Creates an instance of DirectoryClient.
|
4723
4880
|
*
|
@@ -4732,7 +4889,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
4732
4889
|
* @param pipeline - Call newPipeline() to create a default
|
4733
4890
|
* pipeline, or provide a customized pipeline.
|
4734
4891
|
*/
|
4735
|
-
constructor(url: string, pipeline: Pipeline);
|
4892
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
|
4736
4893
|
/**
|
4737
4894
|
* Creates a new directory under the specified share or parent directory.
|
4738
4895
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
|
@@ -5202,6 +5359,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5202
5359
|
private _shareName;
|
5203
5360
|
private _path;
|
5204
5361
|
private _name;
|
5362
|
+
private shareClientConfig?;
|
5205
5363
|
/**
|
5206
5364
|
* The share name corresponding to this file client
|
5207
5365
|
*/
|
@@ -5225,11 +5383,11 @@ export declare class ShareFileClient extends StorageClient {
|
|
5225
5383
|
* Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
|
5226
5384
|
* However, if a file or directory name includes %, file or directory name must be encoded in the URL.
|
5227
5385
|
* Such as a file named "myfile%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".
|
5228
|
-
* @param credential - Such as
|
5386
|
+
* @param credential - Such as , StorageSharedKeyCredential or TokenCredential,
|
5229
5387
|
* If not specified, AnonymousCredential is used.
|
5230
5388
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
5231
5389
|
*/
|
5232
|
-
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?:
|
5390
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
|
5233
5391
|
/**
|
5234
5392
|
* Creates an instance of ShareFileClient.
|
5235
5393
|
*
|
@@ -5244,7 +5402,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5244
5402
|
* @param pipeline - Call newPipeline() to create a default
|
5245
5403
|
* pipeline, or provide a customized pipeline.
|
5246
5404
|
*/
|
5247
|
-
constructor(url: string, pipeline: Pipeline);
|
5405
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
|
5248
5406
|
/**
|
5249
5407
|
* Creates a new ShareFileClient object identical to the source but with the specified share snapshot timestamp.
|
5250
5408
|
* Provide "" will remove the snapshot and return a URL to the base ShareFileClient.
|
@@ -5466,7 +5624,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5466
5624
|
* console.log("Updated file successfully!")
|
5467
5625
|
* ```
|
5468
5626
|
*/
|
5469
|
-
uploadRange(body:
|
5627
|
+
uploadRange(body: HttpRequestBody, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>;
|
5470
5628
|
/**
|
5471
5629
|
* Upload a range of bytes to a file where the contents are read from a another file's URL.
|
5472
5630
|
* The range can be up to 4 MB in size.
|
@@ -5830,6 +5988,8 @@ export declare interface ShareGetPermissionHeaders {
|
|
5830
5988
|
declare interface ShareGetPermissionOptionalParams extends coreClient.OperationOptions {
|
5831
5989
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
5832
5990
|
timeoutInSeconds?: number;
|
5991
|
+
/** Valid value is backup */
|
5992
|
+
fileRequestIntent?: ShareTokenIntent;
|
5833
5993
|
}
|
5834
5994
|
|
5835
5995
|
/**
|
@@ -6304,6 +6464,7 @@ export declare class ShareServiceClient extends StorageClient {
|
|
6304
6464
|
* serviceContext provided by protocol layer.
|
6305
6465
|
*/
|
6306
6466
|
private serviceContext;
|
6467
|
+
private shareClientConfig?;
|
6307
6468
|
/**
|
6308
6469
|
*
|
6309
6470
|
* Creates an instance of ShareServiceClient from connection string.
|
@@ -6317,18 +6478,18 @@ export declare class ShareServiceClient extends StorageClient {
|
|
6317
6478
|
* @param options - Options to configure the HTTP pipeline.
|
6318
6479
|
* @returns A new ShareServiceClient from the given connection string.
|
6319
6480
|
*/
|
6320
|
-
static fromConnectionString(connectionString: string, options?:
|
6481
|
+
static fromConnectionString(connectionString: string, options?: ShareClientOptions): ShareServiceClient;
|
6321
6482
|
/**
|
6322
6483
|
* Creates an instance of ShareServiceClient.
|
6323
6484
|
*
|
6324
6485
|
* @param url - A URL string pointing to Azure Storage file service, such as
|
6325
6486
|
* "https://myaccount.file.core.windows.net". You can Append a SAS
|
6326
6487
|
* if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
|
6327
|
-
* @param credential - Such as AnonymousCredential or
|
6488
|
+
* @param credential - Such as AnonymousCredential, StorageSharedKeyCredential, or TokenCredential,
|
6328
6489
|
* If not specified, AnonymousCredential is used.
|
6329
6490
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
6330
6491
|
*/
|
6331
|
-
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?:
|
6492
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
|
6332
6493
|
/**
|
6333
6494
|
* Creates an instance of ShareServiceClient.
|
6334
6495
|
*
|
@@ -6337,8 +6498,9 @@ export declare class ShareServiceClient extends StorageClient {
|
|
6337
6498
|
* if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
|
6338
6499
|
* @param pipeline - Call newPipeline() to create a default
|
6339
6500
|
* pipeline, or provide a customized pipeline.
|
6501
|
+
* @param options - Optional. Options to configure the HTTP pipeline.
|
6340
6502
|
*/
|
6341
|
-
constructor(url: string, pipeline: Pipeline);
|
6503
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientOptions);
|
6342
6504
|
/**
|
6343
6505
|
* Creates a ShareClient object.
|
6344
6506
|
*
|
@@ -6726,6 +6888,15 @@ export declare interface ShareStats {
|
|
6726
6888
|
shareUsageBytes: number;
|
6727
6889
|
}
|
6728
6890
|
|
6891
|
+
/**
|
6892
|
+
* Defines values for ShareTokenIntent. \
|
6893
|
+
* {@link KnownShareTokenIntent} can be used interchangeably with ShareTokenIntent,
|
6894
|
+
* this enum contains the known values that the service supports.
|
6895
|
+
* ### Known values supported by the service
|
6896
|
+
* **backup**
|
6897
|
+
*/
|
6898
|
+
export declare type ShareTokenIntent = string;
|
6899
|
+
|
6729
6900
|
/**
|
6730
6901
|
* Signed Identifier
|
6731
6902
|
*/
|
@@ -6799,13 +6970,13 @@ export declare class StorageBrowserPolicy extends BaseRequestPolicy {
|
|
6799
6970
|
* @param nextPolicy -
|
6800
6971
|
* @param options -
|
6801
6972
|
*/
|
6802
|
-
constructor(nextPolicy: RequestPolicy, options:
|
6973
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
|
6803
6974
|
/**
|
6804
6975
|
* Sends out request.
|
6805
6976
|
*
|
6806
6977
|
* @param request -
|
6807
6978
|
*/
|
6808
|
-
sendRequest(request:
|
6979
|
+
sendRequest(request: WebResource): Promise<HttpOperationResponse>;
|
6809
6980
|
}
|
6810
6981
|
|
6811
6982
|
/**
|
@@ -6818,7 +6989,7 @@ export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory
|
|
6818
6989
|
* @param nextPolicy -
|
6819
6990
|
* @param options -
|
6820
6991
|
*/
|
6821
|
-
create(nextPolicy: RequestPolicy, options:
|
6992
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageBrowserPolicy;
|
6822
6993
|
}
|
6823
6994
|
|
6824
6995
|
/**
|
@@ -6872,6 +7043,11 @@ declare interface StorageClientOptionalParams extends coreHttpCompat.ExtendedSer
|
|
6872
7043
|
endpoint?: string;
|
6873
7044
|
}
|
6874
7045
|
|
7046
|
+
/**
|
7047
|
+
* The OAuth scope to use with Azure Storage.
|
7048
|
+
*/
|
7049
|
+
export declare const StorageOAuthScopes: string | string[];
|
7050
|
+
|
6875
7051
|
/**
|
6876
7052
|
* Options interface for the {@link newPipeline} function.
|
6877
7053
|
*/
|
@@ -6961,13 +7137,13 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
|
|
6961
7137
|
* @param options -
|
6962
7138
|
* @param retryOptions -
|
6963
7139
|
*/
|
6964
|
-
constructor(nextPolicy: RequestPolicy, options:
|
7140
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, retryOptions?: StorageRetryOptions);
|
6965
7141
|
/**
|
6966
7142
|
* Sends request.
|
6967
7143
|
*
|
6968
7144
|
* @param request -
|
6969
7145
|
*/
|
6970
|
-
sendRequest(request:
|
7146
|
+
sendRequest(request: WebResource): Promise<HttpOperationResponse>;
|
6971
7147
|
/**
|
6972
7148
|
* Decide and perform next retry. Won't mutate request parameter.
|
6973
7149
|
*
|
@@ -6978,7 +7154,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
|
|
6978
7154
|
* @param attempt - How many retries has been attempted to performed, starting from 1, which includes
|
6979
7155
|
* the attempt will be performed by this method call.
|
6980
7156
|
*/
|
6981
|
-
protected attemptSendRequest(request:
|
7157
|
+
protected attemptSendRequest(request: WebResource, secondaryHas404: boolean, attempt: number): Promise<HttpOperationResponse>;
|
6982
7158
|
/**
|
6983
7159
|
* Decide whether to retry according to last HTTP response and retry counters.
|
6984
7160
|
*
|
@@ -6987,7 +7163,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
|
|
6987
7163
|
* @param response -
|
6988
7164
|
* @param err -
|
6989
7165
|
*/
|
6990
|
-
protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?:
|
7166
|
+
protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: HttpOperationResponse, err?: RestError): boolean;
|
6991
7167
|
/**
|
6992
7168
|
* Delay a calculated time between retries.
|
6993
7169
|
*
|
@@ -7014,7 +7190,7 @@ export declare class StorageRetryPolicyFactory implements RequestPolicyFactory {
|
|
7014
7190
|
* @param nextPolicy -
|
7015
7191
|
* @param options -
|
7016
7192
|
*/
|
7017
|
-
create(nextPolicy: RequestPolicy, options:
|
7193
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageRetryPolicy;
|
7018
7194
|
}
|
7019
7195
|
|
7020
7196
|
/**
|
@@ -7057,7 +7233,7 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
|
|
7057
7233
|
* @param nextPolicy -
|
7058
7234
|
* @param options -
|
7059
7235
|
*/
|
7060
|
-
create(nextPolicy: RequestPolicy, options:
|
7236
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageSharedKeyCredentialPolicy;
|
7061
7237
|
/**
|
7062
7238
|
* Generates a hash signature for an HTTP request or for a SAS.
|
7063
7239
|
*
|
@@ -7080,13 +7256,13 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
7080
7256
|
* @param options -
|
7081
7257
|
* @param factory -
|
7082
7258
|
*/
|
7083
|
-
constructor(nextPolicy: RequestPolicy, options:
|
7259
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, factory: StorageSharedKeyCredential);
|
7084
7260
|
/**
|
7085
7261
|
* Signs request.
|
7086
7262
|
*
|
7087
7263
|
* @param request -
|
7088
7264
|
*/
|
7089
|
-
protected signRequest(request:
|
7265
|
+
protected signRequest(request: WebResource): WebResource;
|
7090
7266
|
/**
|
7091
7267
|
* Retrieve header value according to shared key sign rules.
|
7092
7268
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
|
@@ -7132,6 +7308,8 @@ export declare type TimeNowType = "now";
|
|
7132
7308
|
*/
|
7133
7309
|
export declare type TimePreserveType = "preserve";
|
7134
7310
|
|
7311
|
+
export { WebResource }
|
7312
|
+
|
7135
7313
|
/**
|
7136
7314
|
* A type that represents an operation result with a known _response property.
|
7137
7315
|
*/
|