@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
@@ -1,26 +1,26 @@
|
|
1
1
|
/// <reference types="node" />
|
2
2
|
import { AbortSignalLike } from '@azure/abort-controller';
|
3
3
|
import { AzureLogger } from '@azure/logger';
|
4
|
-
import { CompatResponse } from '@azure/core-http-compat';
|
5
4
|
import * as coreClient from '@azure/core-client';
|
6
5
|
import * as coreHttpCompat from '@azure/core-http-compat';
|
7
6
|
import * as coreRestPipeline from '@azure/core-rest-pipeline';
|
8
|
-
import { HttpHeadersLike } from '@azure/core-http-compat';
|
7
|
+
import { HttpHeadersLike as HttpHeaders } from '@azure/core-http-compat';
|
8
|
+
import { CompatResponse as HttpOperationResponse } from '@azure/core-http-compat';
|
9
9
|
import { HttpPipelineLogLevel } from '@azure/core-http-compat';
|
10
|
+
import { RequestBodyType as HttpRequestBody } from '@azure/core-rest-pipeline';
|
10
11
|
import { KeepAliveOptions } from '@azure/core-http-compat';
|
11
12
|
import { OperationTracingOptions } from '@azure/core-tracing';
|
12
13
|
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
13
14
|
import { ProxySettings } from '@azure/core-rest-pipeline';
|
14
15
|
import { Readable } from 'stream';
|
15
|
-
import { RequestBodyType } from '@azure/core-rest-pipeline';
|
16
16
|
import { RequestPolicy } from '@azure/core-http-compat';
|
17
17
|
import { RequestPolicyFactory } from '@azure/core-http-compat';
|
18
|
-
import { RequestPolicyOptionsLike } from '@azure/core-http-compat';
|
18
|
+
import { RequestPolicyOptionsLike as RequestPolicyOptions } from '@azure/core-http-compat';
|
19
19
|
import { RestError } from '@azure/core-rest-pipeline';
|
20
20
|
import { TokenCredential } from '@azure/core-auth';
|
21
21
|
import { TransferProgressEvent } from '@azure/core-rest-pipeline';
|
22
22
|
import { UserAgentPolicyOptions } from '@azure/core-rest-pipeline';
|
23
|
-
import { WebResourceLike } from '@azure/core-http-compat';
|
23
|
+
import { WebResourceLike as WebResource } from '@azure/core-http-compat';
|
24
24
|
/** An Access policy. */
|
25
25
|
export declare interface AccessPolicy {
|
26
26
|
/** The date-time the policy is active. */
|
@@ -231,7 +231,7 @@ export declare class AnonymousCredential extends Credential_2 {
|
|
231
231
|
* @param nextPolicy -
|
232
232
|
* @param options -
|
233
233
|
*/
|
234
|
-
create(nextPolicy: RequestPolicy, options:
|
234
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): AnonymousCredentialPolicy;
|
235
235
|
}
|
236
236
|
/**
|
237
237
|
* AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources
|
@@ -243,7 +243,7 @@ export declare class AnonymousCredentialPolicy extends CredentialPolicy {
|
|
243
243
|
* @param nextPolicy -
|
244
244
|
* @param options -
|
245
245
|
*/
|
246
|
-
constructor(nextPolicy: RequestPolicy, options:
|
246
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
|
247
247
|
}
|
248
248
|
/**
|
249
249
|
* The base class from which all request policies derive.
|
@@ -256,7 +256,7 @@ export declare abstract class BaseRequestPolicy implements RequestPolicy {
|
|
256
256
|
/**
|
257
257
|
* The options that can be passed to a given request policy.
|
258
258
|
*/
|
259
|
-
readonly _options:
|
259
|
+
readonly _options: RequestPolicyOptions;
|
260
260
|
/**
|
261
261
|
* The main method to implement that manipulates a request/response.
|
262
262
|
*/
|
@@ -268,12 +268,12 @@ export declare abstract class BaseRequestPolicy implements RequestPolicy {
|
|
268
268
|
/**
|
269
269
|
* The options that can be passed to a given request policy.
|
270
270
|
*/
|
271
|
-
_options:
|
271
|
+
_options: RequestPolicyOptions);
|
272
272
|
/**
|
273
273
|
* Sends a network request based on the given web resource.
|
274
274
|
* @param webResource - A {@link WebResourceLike} that describes a HTTP request to be made.
|
275
275
|
*/
|
276
|
-
abstract sendRequest(webResource:
|
276
|
+
abstract sendRequest(webResource: WebResource): Promise<HttpOperationResponse>;
|
277
277
|
/**
|
278
278
|
* Get whether or not a log with the provided log level should be logged.
|
279
279
|
* @param logLevel - The log level of the log that will be logged.
|
@@ -403,7 +403,7 @@ declare abstract class Credential_2 implements RequestPolicyFactory {
|
|
403
403
|
* @param _nextPolicy -
|
404
404
|
* @param _options -
|
405
405
|
*/
|
406
|
-
create(_nextPolicy: RequestPolicy, _options:
|
406
|
+
create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
|
407
407
|
}
|
408
408
|
export { Credential_2 as Credential };
|
409
409
|
/**
|
@@ -416,19 +416,19 @@ export declare abstract class CredentialPolicy extends BaseRequestPolicy {
|
|
416
416
|
*
|
417
417
|
* @param request -
|
418
418
|
*/
|
419
|
-
sendRequest(request:
|
419
|
+
sendRequest(request: WebResource): Promise<HttpOperationResponse>;
|
420
420
|
/**
|
421
421
|
* Child classes must implement this method with request signing. This method
|
422
422
|
* will be executed in {@link sendRequest}.
|
423
423
|
*
|
424
424
|
* @param request -
|
425
425
|
*/
|
426
|
-
protected signRequest(request:
|
426
|
+
protected signRequest(request: WebResource): WebResource;
|
427
427
|
}
|
428
428
|
/**
|
429
429
|
* A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
|
430
430
|
*/
|
431
|
-
export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options:
|
431
|
+
export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptions) => CredentialPolicy;
|
432
432
|
/** Defines values for DeleteSnapshotsOptionType. */
|
433
433
|
export declare type DeleteSnapshotsOptionType = "include" | "include-leased";
|
434
434
|
/** Parameter group */
|
@@ -567,6 +567,10 @@ declare interface DirectoryCreateOptionalParams extends coreClient.OperationOpti
|
|
567
567
|
metadata?: {
|
568
568
|
[propertyName: string]: string;
|
569
569
|
};
|
570
|
+
/** Valid value is backup */
|
571
|
+
fileRequestIntent?: ShareTokenIntent;
|
572
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
573
|
+
allowTrailingDot?: boolean;
|
570
574
|
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
571
575
|
filePermission?: string;
|
572
576
|
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
@@ -620,6 +624,10 @@ export declare interface DirectoryDeleteIfExistsResponse extends DirectoryDelete
|
|
620
624
|
declare interface DirectoryDeleteOptionalParams extends coreClient.OperationOptions {
|
621
625
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
622
626
|
timeoutInSeconds?: number;
|
627
|
+
/** Valid value is backup */
|
628
|
+
fileRequestIntent?: ShareTokenIntent;
|
629
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
630
|
+
allowTrailingDot?: boolean;
|
623
631
|
}
|
624
632
|
/**
|
625
633
|
* Options to configure the {@link ShareDirectoryClient.delete} operation.
|
@@ -670,6 +678,10 @@ declare interface DirectoryForceCloseHandlesOptionalParams extends coreClient.Op
|
|
670
678
|
marker?: string;
|
671
679
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
672
680
|
shareSnapshot?: string;
|
681
|
+
/** Valid value is backup */
|
682
|
+
fileRequestIntent?: ShareTokenIntent;
|
683
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
684
|
+
allowTrailingDot?: boolean;
|
673
685
|
/** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
|
674
686
|
recursive?: boolean;
|
675
687
|
}
|
@@ -749,6 +761,10 @@ declare interface DirectoryGetPropertiesOptionalParams extends coreClient.Operat
|
|
749
761
|
timeoutInSeconds?: number;
|
750
762
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
751
763
|
shareSnapshot?: string;
|
764
|
+
/** Valid value is backup */
|
765
|
+
fileRequestIntent?: ShareTokenIntent;
|
766
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
767
|
+
allowTrailingDot?: boolean;
|
752
768
|
}
|
753
769
|
/**
|
754
770
|
* Options to configure the {@link ShareDirectoryClient.getProperties} operation.
|
@@ -831,6 +847,10 @@ declare interface DirectoryListFilesAndDirectoriesSegmentOptionalParams extends
|
|
831
847
|
maxResults?: number;
|
832
848
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
833
849
|
shareSnapshot?: string;
|
850
|
+
/** Valid value is backup */
|
851
|
+
fileRequestIntent?: ShareTokenIntent;
|
852
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
853
|
+
allowTrailingDot?: boolean;
|
834
854
|
/** Include this parameter to specify one or more datasets to include in the response. */
|
835
855
|
include?: ListFilesIncludeType[];
|
836
856
|
/** Include extended information. */
|
@@ -863,6 +883,10 @@ declare interface DirectoryListHandlesOptionalParams extends coreClient.Operatio
|
|
863
883
|
maxResults?: number;
|
864
884
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
865
885
|
shareSnapshot?: string;
|
886
|
+
/** Valid value is backup */
|
887
|
+
fileRequestIntent?: ShareTokenIntent;
|
888
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
889
|
+
allowTrailingDot?: boolean;
|
866
890
|
/** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
|
867
891
|
recursive?: boolean;
|
868
892
|
}
|
@@ -961,6 +985,10 @@ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOpti
|
|
961
985
|
metadata?: {
|
962
986
|
[propertyName: string]: string;
|
963
987
|
};
|
988
|
+
/** Valid value is backup */
|
989
|
+
fileRequestIntent?: ShareTokenIntent;
|
990
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
991
|
+
allowTrailingDot?: boolean;
|
964
992
|
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
965
993
|
filePermission?: string;
|
966
994
|
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
@@ -969,6 +997,8 @@ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOpti
|
|
969
997
|
replaceIfExists?: boolean;
|
970
998
|
/** Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail. */
|
971
999
|
ignoreReadOnly?: boolean;
|
1000
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
1001
|
+
allowSourceTrailingDot?: boolean;
|
972
1002
|
}
|
973
1003
|
/**
|
974
1004
|
* Options to configure the {@link ShareDirectoryClient.rename} operation.
|
@@ -1050,6 +1080,10 @@ declare interface DirectorySetMetadataOptionalParams extends coreClient.Operatio
|
|
1050
1080
|
metadata?: {
|
1051
1081
|
[propertyName: string]: string;
|
1052
1082
|
};
|
1083
|
+
/** Valid value is backup */
|
1084
|
+
fileRequestIntent?: ShareTokenIntent;
|
1085
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1086
|
+
allowTrailingDot?: boolean;
|
1053
1087
|
}
|
1054
1088
|
/**
|
1055
1089
|
* Options to configure the {@link ShareDirectoryClient.setMetadata} operation.
|
@@ -1100,6 +1134,10 @@ export declare interface DirectorySetPropertiesHeaders {
|
|
1100
1134
|
declare interface DirectorySetPropertiesOptionalParams extends coreClient.OperationOptions {
|
1101
1135
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1102
1136
|
timeoutInSeconds?: number;
|
1137
|
+
/** Valid value is backup */
|
1138
|
+
fileRequestIntent?: ShareTokenIntent;
|
1139
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1140
|
+
allowTrailingDot?: boolean;
|
1103
1141
|
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
1104
1142
|
filePermission?: string;
|
1105
1143
|
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
@@ -1284,6 +1322,10 @@ declare interface FileAbortCopyOptionalParams extends coreClient.OperationOption
|
|
1284
1322
|
leaseAccessConditions?: LeaseAccessConditions;
|
1285
1323
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1286
1324
|
timeoutInSeconds?: number;
|
1325
|
+
/** Valid value is backup */
|
1326
|
+
fileRequestIntent?: ShareTokenIntent;
|
1327
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1328
|
+
allowTrailingDot?: boolean;
|
1287
1329
|
}
|
1288
1330
|
/** Contains response data for the abortCopy operation. */
|
1289
1331
|
export declare type FileAbortCopyResponse = WithResponse<FileAbortCopyHeaders, FileAbortCopyHeaders>;
|
@@ -1316,6 +1358,10 @@ declare interface FileAcquireLeaseOptionalParams extends coreClient.OperationOpt
|
|
1316
1358
|
proposedLeaseId?: string;
|
1317
1359
|
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
1318
1360
|
requestId?: string;
|
1361
|
+
/** Valid value is backup */
|
1362
|
+
fileRequestIntent?: ShareTokenIntent;
|
1363
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1364
|
+
allowTrailingDot?: boolean;
|
1319
1365
|
}
|
1320
1366
|
/** Contains response data for the acquireLease operation. */
|
1321
1367
|
declare type FileAcquireLeaseResponse = FileAcquireLeaseHeaders;
|
@@ -1429,6 +1475,10 @@ declare interface FileBreakLeaseOptionalParams extends coreClient.OperationOptio
|
|
1429
1475
|
timeoutInSeconds?: number;
|
1430
1476
|
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
1431
1477
|
requestId?: string;
|
1478
|
+
/** Valid value is backup */
|
1479
|
+
fileRequestIntent?: ShareTokenIntent;
|
1480
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1481
|
+
allowTrailingDot?: boolean;
|
1432
1482
|
}
|
1433
1483
|
/** Contains response data for the breakLease operation. */
|
1434
1484
|
declare type FileBreakLeaseResponse = FileBreakLeaseHeaders;
|
@@ -1457,6 +1507,10 @@ declare interface FileChangeLeaseOptionalParams extends coreClient.OperationOpti
|
|
1457
1507
|
proposedLeaseId?: string;
|
1458
1508
|
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
1459
1509
|
requestId?: string;
|
1510
|
+
/** Valid value is backup */
|
1511
|
+
fileRequestIntent?: ShareTokenIntent;
|
1512
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1513
|
+
allowTrailingDot?: boolean;
|
1460
1514
|
}
|
1461
1515
|
/** Contains response data for the changeLease operation. */
|
1462
1516
|
declare type FileChangeLeaseResponse = FileChangeLeaseHeaders;
|
@@ -1548,6 +1602,10 @@ declare interface FileCreateOptionalParams extends coreClient.OperationOptions {
|
|
1548
1602
|
metadata?: {
|
1549
1603
|
[propertyName: string]: string;
|
1550
1604
|
};
|
1605
|
+
/** Valid value is backup */
|
1606
|
+
fileRequestIntent?: ShareTokenIntent;
|
1607
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1608
|
+
allowTrailingDot?: boolean;
|
1551
1609
|
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
1552
1610
|
filePermission?: string;
|
1553
1611
|
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
@@ -1611,6 +1669,10 @@ declare interface FileDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1611
1669
|
leaseAccessConditions?: LeaseAccessConditions;
|
1612
1670
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1613
1671
|
timeoutInSeconds?: number;
|
1672
|
+
/** Valid value is backup */
|
1673
|
+
fileRequestIntent?: ShareTokenIntent;
|
1674
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1675
|
+
allowTrailingDot?: boolean;
|
1614
1676
|
}
|
1615
1677
|
/**
|
1616
1678
|
* Options to configure the {@link ShareFileClient.delete} operation.
|
@@ -1709,6 +1771,10 @@ export declare interface FileDownloadOptionalParams extends coreClient.Operation
|
|
1709
1771
|
leaseAccessConditions?: LeaseAccessConditions;
|
1710
1772
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
1711
1773
|
timeoutInSeconds?: number;
|
1774
|
+
/** Valid value is backup */
|
1775
|
+
fileRequestIntent?: ShareTokenIntent;
|
1776
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1777
|
+
allowTrailingDot?: boolean;
|
1712
1778
|
/** Return file data only from the specified byte range. */
|
1713
1779
|
range?: string;
|
1714
1780
|
/** When this header is set to true and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. */
|
@@ -1836,6 +1902,10 @@ declare interface FileForceCloseHandlesOptionalParams extends coreClient.Operati
|
|
1836
1902
|
marker?: string;
|
1837
1903
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
1838
1904
|
shareSnapshot?: string;
|
1905
|
+
/** Valid value is backup */
|
1906
|
+
fileRequestIntent?: ShareTokenIntent;
|
1907
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1908
|
+
allowTrailingDot?: boolean;
|
1839
1909
|
}
|
1840
1910
|
/**
|
1841
1911
|
* Options to configure File - Force Close Handles operations.
|
@@ -1944,6 +2014,10 @@ declare interface FileGetPropertiesOptionalParams extends coreClient.OperationOp
|
|
1944
2014
|
timeoutInSeconds?: number;
|
1945
2015
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
1946
2016
|
shareSnapshot?: string;
|
2017
|
+
/** Valid value is backup */
|
2018
|
+
fileRequestIntent?: ShareTokenIntent;
|
2019
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2020
|
+
allowTrailingDot?: boolean;
|
1947
2021
|
}
|
1948
2022
|
/**
|
1949
2023
|
* Options to configure the {@link ShareFileClient.getProperties} operation.
|
@@ -1990,6 +2064,10 @@ declare interface FileGetRangeListOptionalParams extends coreClient.OperationOpt
|
|
1990
2064
|
timeoutInSeconds?: number;
|
1991
2065
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
1992
2066
|
shareSnapshot?: string;
|
2067
|
+
/** Valid value is backup */
|
2068
|
+
fileRequestIntent?: ShareTokenIntent;
|
2069
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2070
|
+
allowTrailingDot?: boolean;
|
1993
2071
|
/** Specifies the range of bytes over which to list ranges, inclusively. */
|
1994
2072
|
range?: string;
|
1995
2073
|
/** The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot. */
|
@@ -2124,6 +2202,10 @@ declare interface FileListHandlesOptionalParams extends coreClient.OperationOpti
|
|
2124
2202
|
maxResults?: number;
|
2125
2203
|
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
2126
2204
|
shareSnapshot?: string;
|
2205
|
+
/** Valid value is backup */
|
2206
|
+
fileRequestIntent?: ShareTokenIntent;
|
2207
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2208
|
+
allowTrailingDot?: boolean;
|
2127
2209
|
}
|
2128
2210
|
export declare interface FileListHandlesOptions extends CommonOptions {
|
2129
2211
|
/**
|
@@ -2253,6 +2335,10 @@ declare interface FileReleaseLeaseOptionalParams extends coreClient.OperationOpt
|
|
2253
2335
|
timeoutInSeconds?: number;
|
2254
2336
|
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
2255
2337
|
requestId?: string;
|
2338
|
+
/** Valid value is backup */
|
2339
|
+
fileRequestIntent?: ShareTokenIntent;
|
2340
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2341
|
+
allowTrailingDot?: boolean;
|
2256
2342
|
}
|
2257
2343
|
/** Contains response data for the releaseLease operation. */
|
2258
2344
|
declare type FileReleaseLeaseResponse = FileReleaseLeaseHeaders;
|
@@ -2301,6 +2387,10 @@ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
|
|
2301
2387
|
metadata?: {
|
2302
2388
|
[propertyName: string]: string;
|
2303
2389
|
};
|
2390
|
+
/** Valid value is backup */
|
2391
|
+
fileRequestIntent?: ShareTokenIntent;
|
2392
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2393
|
+
allowTrailingDot?: boolean;
|
2304
2394
|
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
2305
2395
|
filePermission?: string;
|
2306
2396
|
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
@@ -2309,6 +2399,8 @@ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
|
|
2309
2399
|
replaceIfExists?: boolean;
|
2310
2400
|
/** Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail. */
|
2311
2401
|
ignoreReadOnly?: boolean;
|
2402
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
2403
|
+
allowSourceTrailingDot?: boolean;
|
2312
2404
|
}
|
2313
2405
|
/**
|
2314
2406
|
* Options to configure the {@link ShareFileClient.rename} operation.
|
@@ -2554,6 +2646,10 @@ declare interface FileSetHttpHeadersOptionalParams extends coreClient.OperationO
|
|
2554
2646
|
fileHttpHeaders?: FileHttpHeaders_2;
|
2555
2647
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
2556
2648
|
timeoutInSeconds?: number;
|
2649
|
+
/** Valid value is backup */
|
2650
|
+
fileRequestIntent?: ShareTokenIntent;
|
2651
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2652
|
+
allowTrailingDot?: boolean;
|
2557
2653
|
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
2558
2654
|
filePermission?: string;
|
2559
2655
|
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
@@ -2610,6 +2706,10 @@ declare interface FileSetMetadataOptionalParams extends coreClient.OperationOpti
|
|
2610
2706
|
metadata?: {
|
2611
2707
|
[propertyName: string]: string;
|
2612
2708
|
};
|
2709
|
+
/** Valid value is backup */
|
2710
|
+
fileRequestIntent?: ShareTokenIntent;
|
2711
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2712
|
+
allowTrailingDot?: boolean;
|
2613
2713
|
}
|
2614
2714
|
/**
|
2615
2715
|
* Options to configure the {@link ShareFileClient.setMetadata} operation.
|
@@ -2660,10 +2760,16 @@ declare interface FileStartCopyOptionalParams extends coreClient.OperationOption
|
|
2660
2760
|
metadata?: {
|
2661
2761
|
[propertyName: string]: string;
|
2662
2762
|
};
|
2763
|
+
/** Valid value is backup */
|
2764
|
+
fileRequestIntent?: ShareTokenIntent;
|
2765
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2766
|
+
allowTrailingDot?: boolean;
|
2663
2767
|
/** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
2664
2768
|
filePermission?: string;
|
2665
2769
|
/** Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
|
2666
2770
|
filePermissionKey?: string;
|
2771
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
2772
|
+
allowSourceTrailingDot?: boolean;
|
2667
2773
|
}
|
2668
2774
|
/**
|
2669
2775
|
* Options to configure the {@link ShareFileClient.startCopyFromURL} operation.
|
@@ -2795,6 +2901,10 @@ export declare interface FileUploadRangeFromURLOptionalParams extends coreClient
|
|
2795
2901
|
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
2796
2902
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
2797
2903
|
timeoutInSeconds?: number;
|
2904
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2905
|
+
allowTrailingDot?: boolean;
|
2906
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
2907
|
+
allowSourceTrailingDot?: boolean;
|
2798
2908
|
/** If the file last write time should be preserved or overwritten */
|
2799
2909
|
fileLastWrittenMode?: FileLastWrittenMode;
|
2800
2910
|
/** Bytes of source data in the specified range. */
|
@@ -2874,6 +2984,10 @@ declare interface FileUploadRangeOptionalParams extends coreClient.OperationOpti
|
|
2874
2984
|
leaseAccessConditions?: LeaseAccessConditions;
|
2875
2985
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
2876
2986
|
timeoutInSeconds?: number;
|
2987
|
+
/** Valid value is backup */
|
2988
|
+
fileRequestIntent?: ShareTokenIntent;
|
2989
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2990
|
+
allowTrailingDot?: boolean;
|
2877
2991
|
/** Initial data. */
|
2878
2992
|
body?: coreRestPipeline.RequestBodyType;
|
2879
2993
|
/** An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5 header is specified, the File service compares the hash of the content that has arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). */
|
@@ -3023,6 +3137,9 @@ export declare interface HttpAuthorization {
|
|
3023
3137
|
*/
|
3024
3138
|
value: string;
|
3025
3139
|
}
|
3140
|
+
export { HttpHeaders };
|
3141
|
+
export { HttpOperationResponse };
|
3142
|
+
export { HttpRequestBody };
|
3026
3143
|
/**
|
3027
3144
|
* A representation of an HTTP response that
|
3028
3145
|
* includes a reference to the request that
|
@@ -3032,11 +3149,11 @@ export declare interface HttpResponse {
|
|
3032
3149
|
/**
|
3033
3150
|
* The headers from the response.
|
3034
3151
|
*/
|
3035
|
-
headers:
|
3152
|
+
headers: HttpHeaders;
|
3036
3153
|
/**
|
3037
3154
|
* The original request that resulted in this response.
|
3038
3155
|
*/
|
3039
|
-
request:
|
3156
|
+
request: WebResource;
|
3040
3157
|
/**
|
3041
3158
|
* The HTTP status code returned from the service.
|
3042
3159
|
*/
|
@@ -3048,6 +3165,10 @@ export declare interface HttpResponse {
|
|
3048
3165
|
* @returns true when the argument satisfies the Pipeline contract
|
3049
3166
|
*/
|
3050
3167
|
export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
|
3168
|
+
/** Known values of {@link ShareTokenIntent} that the service accepts. */
|
3169
|
+
export declare enum KnownShareTokenIntent {
|
3170
|
+
Backup = "backup"
|
3171
|
+
}
|
3051
3172
|
/** Parameter group */
|
3052
3173
|
export declare interface LeaseAccessConditions {
|
3053
3174
|
/** If specified, the operation only succeeds if the resource's lease is active and matches this ID. */
|
@@ -3312,6 +3433,10 @@ export declare type RawFileDownloadResponse = FileDownloadHeaders & {
|
|
3312
3433
|
*/
|
3313
3434
|
readableStreamBody?: NodeJS.ReadableStream;
|
3314
3435
|
};
|
3436
|
+
export { RequestPolicy as IHttpClient };
|
3437
|
+
export { RequestPolicy };
|
3438
|
+
export { RequestPolicyFactory };
|
3439
|
+
export { RequestPolicyOptions };
|
3315
3440
|
/**
|
3316
3441
|
* An object with a simple _response property.
|
3317
3442
|
*/
|
@@ -3904,6 +4029,7 @@ export declare class ShareClient extends StorageClient {
|
|
3904
4029
|
*/
|
3905
4030
|
private context;
|
3906
4031
|
private _name;
|
4032
|
+
private shareClientConfig?;
|
3907
4033
|
/*
|
3908
4034
|
* The name of the share
|
3909
4035
|
*/
|
@@ -3918,7 +4044,7 @@ export declare class ShareClient extends StorageClient {
|
|
3918
4044
|
* @param name - Share name.
|
3919
4045
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
3920
4046
|
*/
|
3921
|
-
constructor(connectionString: string, name: string, options?:
|
4047
|
+
constructor(connectionString: string, name: string, options?: ShareClientOptions);
|
3922
4048
|
/**
|
3923
4049
|
* Creates an instance of ShareClient.
|
3924
4050
|
*
|
@@ -3930,7 +4056,8 @@ export declare class ShareClient extends StorageClient {
|
|
3930
4056
|
* If not specified, AnonymousCredential is used.
|
3931
4057
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
3932
4058
|
*/
|
3933
|
-
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?:
|
4059
|
+
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: ShareClientOptions);
|
4060
|
+
constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?: ShareClientOptions);
|
3934
4061
|
/**
|
3935
4062
|
* Creates an instance of ShareClient.
|
3936
4063
|
*
|
@@ -3941,7 +4068,7 @@ export declare class ShareClient extends StorageClient {
|
|
3941
4068
|
* @param pipeline - Call newPipeline() to create a default
|
3942
4069
|
* pipeline, or provide a customized pipeline.
|
3943
4070
|
*/
|
3944
|
-
constructor(url: string, pipeline: Pipeline);
|
4071
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
|
3945
4072
|
/**
|
3946
4073
|
* Creates a new ShareClient object identical to the source but with the specified snapshot timestamp.
|
3947
4074
|
* Provide "" will remove the snapshot and return a URL to the base share.
|
@@ -4183,6 +4310,24 @@ export declare class ShareClient extends StorageClient {
|
|
4183
4310
|
*/
|
4184
4311
|
generateSasUrl(options: ShareGenerateSasUrlOptions): string;
|
4185
4312
|
}
|
4313
|
+
export declare interface ShareClientConfig {
|
4314
|
+
/**
|
4315
|
+
* The Files OAuth over REST feature requires special permissions to be included in the role definition to use
|
4316
|
+
* These special permissions will give privileged access to file share data -
|
4317
|
+
* It will allow users to bypass file/directory level ACL/NTFS permissions and get read/write access to file share data
|
4318
|
+
* Since this additional permission can be unintended and to prevent unintended and over privileged access,
|
4319
|
+
* additional checks has been implemented that requires users to explicitly indicate their intent to use these additional permissions.
|
4320
|
+
* This is done using the fileRequestIntent option.
|
4321
|
+
* Currently, the only value that the header supports is 'backup'
|
4322
|
+
* Any user who wishes to use Files OAuth over REST feature has to call the API with the intent header. If the API is not called with the intent header, any subsequent data operation requests will be denied.
|
4323
|
+
*/
|
4324
|
+
fileRequestIntent?: ShareTokenIntent;
|
4325
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
4326
|
+
allowTrailingDot?: boolean;
|
4327
|
+
/** If true, the trailing dot will not be trimmed from the source URI. */
|
4328
|
+
allowSourceTrailingDot?: boolean;
|
4329
|
+
}
|
4330
|
+
export declare type ShareClientOptions = StoragePipelineOptions & ShareClientConfig;
|
4186
4331
|
/** Defines headers for Share_create operation. */
|
4187
4332
|
export declare interface ShareCreateHeaders {
|
4188
4333
|
/** The ETag contains a value which represents the version of the share, in quotes. */
|
@@ -4276,6 +4421,8 @@ export declare interface ShareCreatePermissionHeaders {
|
|
4276
4421
|
declare interface ShareCreatePermissionOptionalParams extends coreClient.OperationOptions {
|
4277
4422
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
4278
4423
|
timeoutInSeconds?: number;
|
4424
|
+
/** Valid value is backup */
|
4425
|
+
fileRequestIntent?: ShareTokenIntent;
|
4279
4426
|
}
|
4280
4427
|
/**
|
4281
4428
|
* Options to configure the {@link ShareClient.createPermission} operation.
|
@@ -4407,6 +4554,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
4407
4554
|
private _shareName;
|
4408
4555
|
private _path;
|
4409
4556
|
private _name;
|
4557
|
+
private shareClientConfig?;
|
4410
4558
|
/*
|
4411
4559
|
* The share name corresponding to this directory client
|
4412
4560
|
*/
|
@@ -4434,7 +4582,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
4434
4582
|
* If not specified, AnonymousCredential is used.
|
4435
4583
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
4436
4584
|
*/
|
4437
|
-
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?:
|
4585
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
|
4438
4586
|
/**
|
4439
4587
|
* Creates an instance of DirectoryClient.
|
4440
4588
|
*
|
@@ -4449,7 +4597,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
4449
4597
|
* @param pipeline - Call newPipeline() to create a default
|
4450
4598
|
* pipeline, or provide a customized pipeline.
|
4451
4599
|
*/
|
4452
|
-
constructor(url: string, pipeline: Pipeline);
|
4600
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
|
4453
4601
|
/**
|
4454
4602
|
* Creates a new directory under the specified share or parent directory.
|
4455
4603
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
|
@@ -4917,6 +5065,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
4917
5065
|
private _shareName;
|
4918
5066
|
private _path;
|
4919
5067
|
private _name;
|
5068
|
+
private shareClientConfig?;
|
4920
5069
|
/*
|
4921
5070
|
* The share name corresponding to this file client
|
4922
5071
|
*/
|
@@ -4940,11 +5089,11 @@ export declare class ShareFileClient extends StorageClient {
|
|
4940
5089
|
* Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
|
4941
5090
|
* However, if a file or directory name includes %, file or directory name must be encoded in the URL.
|
4942
5091
|
* Such as a file named "myfile%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".
|
4943
|
-
* @param credential - Such as
|
5092
|
+
* @param credential - Such as , StorageSharedKeyCredential or TokenCredential,
|
4944
5093
|
* If not specified, AnonymousCredential is used.
|
4945
5094
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
4946
5095
|
*/
|
4947
|
-
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?:
|
5096
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
|
4948
5097
|
/**
|
4949
5098
|
* Creates an instance of ShareFileClient.
|
4950
5099
|
*
|
@@ -4959,7 +5108,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
4959
5108
|
* @param pipeline - Call newPipeline() to create a default
|
4960
5109
|
* pipeline, or provide a customized pipeline.
|
4961
5110
|
*/
|
4962
|
-
constructor(url: string, pipeline: Pipeline);
|
5111
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
|
4963
5112
|
/**
|
4964
5113
|
* Creates a new ShareFileClient object identical to the source but with the specified share snapshot timestamp.
|
4965
5114
|
* Provide "" will remove the snapshot and return a URL to the base ShareFileClient.
|
@@ -5181,7 +5330,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5181
5330
|
* console.log("Updated file successfully!")
|
5182
5331
|
* ```
|
5183
5332
|
*/
|
5184
|
-
uploadRange(body:
|
5333
|
+
uploadRange(body: HttpRequestBody, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>;
|
5185
5334
|
/**
|
5186
5335
|
* Upload a range of bytes to a file where the contents are read from a another file's URL.
|
5187
5336
|
* The range can be up to 4 MB in size.
|
@@ -5536,6 +5685,8 @@ export declare interface ShareGetPermissionHeaders {
|
|
5536
5685
|
declare interface ShareGetPermissionOptionalParams extends coreClient.OperationOptions {
|
5537
5686
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
|
5538
5687
|
timeoutInSeconds?: number;
|
5688
|
+
/** Valid value is backup */
|
5689
|
+
fileRequestIntent?: ShareTokenIntent;
|
5539
5690
|
}
|
5540
5691
|
/**
|
5541
5692
|
* Options to configure the {@link ShareClient.getPermission} operation.
|
@@ -5975,6 +6126,7 @@ export declare class ShareServiceClient extends StorageClient {
|
|
5975
6126
|
* serviceContext provided by protocol layer.
|
5976
6127
|
*/
|
5977
6128
|
private serviceContext;
|
6129
|
+
private shareClientConfig?;
|
5978
6130
|
/**
|
5979
6131
|
*
|
5980
6132
|
* Creates an instance of ShareServiceClient from connection string.
|
@@ -5988,18 +6140,18 @@ export declare class ShareServiceClient extends StorageClient {
|
|
5988
6140
|
* @param options - Options to configure the HTTP pipeline.
|
5989
6141
|
* @returns A new ShareServiceClient from the given connection string.
|
5990
6142
|
*/
|
5991
|
-
static fromConnectionString(connectionString: string, options?:
|
6143
|
+
static fromConnectionString(connectionString: string, options?: ShareClientOptions): ShareServiceClient;
|
5992
6144
|
/**
|
5993
6145
|
* Creates an instance of ShareServiceClient.
|
5994
6146
|
*
|
5995
6147
|
* @param url - A URL string pointing to Azure Storage file service, such as
|
5996
6148
|
* "https://myaccount.file.core.windows.net". You can Append a SAS
|
5997
6149
|
* if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
|
5998
|
-
* @param credential - Such as AnonymousCredential or
|
6150
|
+
* @param credential - Such as AnonymousCredential, StorageSharedKeyCredential, or TokenCredential,
|
5999
6151
|
* If not specified, AnonymousCredential is used.
|
6000
6152
|
* @param options - Optional. Options to configure the HTTP pipeline.
|
6001
6153
|
*/
|
6002
|
-
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?:
|
6154
|
+
constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential | TokenCredential, options?: ShareClientOptions);
|
6003
6155
|
/**
|
6004
6156
|
* Creates an instance of ShareServiceClient.
|
6005
6157
|
*
|
@@ -6008,8 +6160,9 @@ export declare class ShareServiceClient extends StorageClient {
|
|
6008
6160
|
* if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
|
6009
6161
|
* @param pipeline - Call newPipeline() to create a default
|
6010
6162
|
* pipeline, or provide a customized pipeline.
|
6163
|
+
* @param options - Optional. Options to configure the HTTP pipeline.
|
6011
6164
|
*/
|
6012
|
-
constructor(url: string, pipeline: Pipeline);
|
6165
|
+
constructor(url: string, pipeline: Pipeline, options?: ShareClientOptions);
|
6013
6166
|
/**
|
6014
6167
|
* Creates a ShareClient object.
|
6015
6168
|
*
|
@@ -6376,6 +6529,14 @@ export declare interface ShareStats {
|
|
6376
6529
|
/** The approximate size of the data stored in bytes. Note that this value may not include all recently created or recently resized files. */
|
6377
6530
|
shareUsageBytes: number;
|
6378
6531
|
}
|
6532
|
+
/**
|
6533
|
+
* Defines values for ShareTokenIntent. \
|
6534
|
+
* {@link KnownShareTokenIntent} can be used interchangeably with ShareTokenIntent,
|
6535
|
+
* this enum contains the known values that the service supports.
|
6536
|
+
* ### Known values supported by the service
|
6537
|
+
* **backup**
|
6538
|
+
*/
|
6539
|
+
export declare type ShareTokenIntent = string;
|
6379
6540
|
/**
|
6380
6541
|
* Signed Identifier
|
6381
6542
|
*/
|
@@ -6444,13 +6605,13 @@ export declare class StorageBrowserPolicy extends BaseRequestPolicy {
|
|
6444
6605
|
* @param nextPolicy -
|
6445
6606
|
* @param options -
|
6446
6607
|
*/
|
6447
|
-
constructor(nextPolicy: RequestPolicy, options:
|
6608
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
|
6448
6609
|
/**
|
6449
6610
|
* Sends out request.
|
6450
6611
|
*
|
6451
6612
|
* @param request -
|
6452
6613
|
*/
|
6453
|
-
sendRequest(request:
|
6614
|
+
sendRequest(request: WebResource): Promise<HttpOperationResponse>;
|
6454
6615
|
}
|
6455
6616
|
/**
|
6456
6617
|
* StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.
|
@@ -6462,7 +6623,7 @@ export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory
|
|
6462
6623
|
* @param nextPolicy -
|
6463
6624
|
* @param options -
|
6464
6625
|
*/
|
6465
|
-
create(nextPolicy: RequestPolicy, options:
|
6626
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageBrowserPolicy;
|
6466
6627
|
}
|
6467
6628
|
/**
|
6468
6629
|
* A StorageClient represents a base client class for ServiceClient, ContainerClient and etc.
|
@@ -6512,6 +6673,10 @@ declare interface StorageClientOptionalParams extends coreHttpCompat.ExtendedSer
|
|
6512
6673
|
/** Overrides client endpoint. */
|
6513
6674
|
endpoint?: string;
|
6514
6675
|
}
|
6676
|
+
/**
|
6677
|
+
* The OAuth scope to use with Azure Storage.
|
6678
|
+
*/
|
6679
|
+
export declare const StorageOAuthScopes: string | string[];
|
6515
6680
|
/**
|
6516
6681
|
* Options interface for the {@link newPipeline} function.
|
6517
6682
|
*/
|
@@ -6599,13 +6764,13 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
|
|
6599
6764
|
* @param options -
|
6600
6765
|
* @param retryOptions -
|
6601
6766
|
*/
|
6602
|
-
constructor(nextPolicy: RequestPolicy, options:
|
6767
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, retryOptions?: StorageRetryOptions);
|
6603
6768
|
/**
|
6604
6769
|
* Sends request.
|
6605
6770
|
*
|
6606
6771
|
* @param request -
|
6607
6772
|
*/
|
6608
|
-
sendRequest(request:
|
6773
|
+
sendRequest(request: WebResource): Promise<HttpOperationResponse>;
|
6609
6774
|
/**
|
6610
6775
|
* Decide and perform next retry. Won't mutate request parameter.
|
6611
6776
|
*
|
@@ -6616,7 +6781,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
|
|
6616
6781
|
* @param attempt - How many retries has been attempted to performed, starting from 1, which includes
|
6617
6782
|
* the attempt will be performed by this method call.
|
6618
6783
|
*/
|
6619
|
-
protected attemptSendRequest(request:
|
6784
|
+
protected attemptSendRequest(request: WebResource, secondaryHas404: boolean, attempt: number): Promise<HttpOperationResponse>;
|
6620
6785
|
/**
|
6621
6786
|
* Decide whether to retry according to last HTTP response and retry counters.
|
6622
6787
|
*
|
@@ -6625,7 +6790,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
|
|
6625
6790
|
* @param response -
|
6626
6791
|
* @param err -
|
6627
6792
|
*/
|
6628
|
-
protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?:
|
6793
|
+
protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: HttpOperationResponse, err?: RestError): boolean;
|
6629
6794
|
/**
|
6630
6795
|
* Delay a calculated time between retries.
|
6631
6796
|
*
|
@@ -6651,7 +6816,7 @@ export declare class StorageRetryPolicyFactory implements RequestPolicyFactory {
|
|
6651
6816
|
* @param nextPolicy -
|
6652
6817
|
* @param options -
|
6653
6818
|
*/
|
6654
|
-
create(nextPolicy: RequestPolicy, options:
|
6819
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageRetryPolicy;
|
6655
6820
|
}
|
6656
6821
|
/**
|
6657
6822
|
* RetryPolicy types.
|
@@ -6692,7 +6857,7 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
|
|
6692
6857
|
* @param nextPolicy -
|
6693
6858
|
* @param options -
|
6694
6859
|
*/
|
6695
|
-
create(nextPolicy: RequestPolicy, options:
|
6860
|
+
create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageSharedKeyCredentialPolicy;
|
6696
6861
|
/**
|
6697
6862
|
* Generates a hash signature for an HTTP request or for a SAS.
|
6698
6863
|
*
|
@@ -6714,13 +6879,13 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
6714
6879
|
* @param options -
|
6715
6880
|
* @param factory -
|
6716
6881
|
*/
|
6717
|
-
constructor(nextPolicy: RequestPolicy, options:
|
6882
|
+
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, factory: StorageSharedKeyCredential);
|
6718
6883
|
/**
|
6719
6884
|
* Signs request.
|
6720
6885
|
*
|
6721
6886
|
* @param request -
|
6722
6887
|
*/
|
6723
|
-
protected signRequest(request:
|
6888
|
+
protected signRequest(request: WebResource): WebResource;
|
6724
6889
|
/**
|
6725
6890
|
* Retrieve header value according to shared key sign rules.
|
6726
6891
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
|
@@ -6762,6 +6927,7 @@ export declare type TimeNowType = "now";
|
|
6762
6927
|
* Indicates keep existing time value unchanged.
|
6763
6928
|
*/
|
6764
6929
|
export declare type TimePreserveType = "preserve";
|
6930
|
+
export { WebResource };
|
6765
6931
|
/**
|
6766
6932
|
* A type that represents an operation result with a known _response property.
|
6767
6933
|
*/
|