@azure/storage-file-share 12.26.0 → 12.27.0-alpha.20250217.1
Sign up to get free protection for your applications and to get access to all the features.
- package/LICENSE +3 -3
- package/README.md +16 -18
- package/dist/index.js +1430 -431
- package/dist/index.js.map +1 -1
- package/dist-esm/storage-blob/src/BatchResponseParser.js +1 -1
- package/dist-esm/storage-blob/src/BatchResponseParser.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobBatch.js +1 -1
- package/dist-esm/storage-blob/src/BlobBatch.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobBatchClient.js +2 -2
- package/dist-esm/storage-blob/src/BlobBatchClient.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobLeaseClient.js +10 -10
- package/dist-esm/storage-blob/src/BlobLeaseClient.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobServiceClient.js +11 -11
- package/dist-esm/storage-blob/src/BlobServiceClient.js.map +1 -1
- package/dist-esm/storage-blob/src/Clients.js +43 -43
- package/dist-esm/storage-blob/src/Clients.js.map +1 -1
- package/dist-esm/storage-blob/src/ContainerClient.js +18 -18
- package/dist-esm/storage-blob/src/ContainerClient.js.map +1 -1
- package/dist-esm/storage-blob/src/Range.js.map +1 -1
- package/dist-esm/storage-blob/src/StorageRetryPolicyFactory.js.map +1 -1
- package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js +1 -1
- package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js.map +1 -1
- package/dist-esm/storage-blob/src/models.js +2 -2
- package/dist-esm/storage-blob/src/models.js.map +1 -1
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js +2 -2
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js.map +1 -1
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js +2 -2
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js.map +1 -1
- package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js +2 -2
- package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js.map +1 -1
- package/dist-esm/storage-blob/src/sas/AccountSASResourceTypes.js +1 -1
- package/dist-esm/storage-blob/src/sas/AccountSASResourceTypes.js.map +1 -1
- package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js +1 -1
- package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js.map +1 -1
- package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js +1 -1
- package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js.map +1 -1
- package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js +1 -1
- package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js.map +1 -1
- package/dist-esm/storage-blob/src/sas/SASQueryParameters.js.map +1 -1
- package/dist-esm/storage-blob/src/utils/utils.common.js +3 -3
- package/dist-esm/storage-blob/src/utils/utils.common.js.map +1 -1
- package/dist-esm/storage-blob/src/utils/utils.node.js +1 -1
- package/dist-esm/storage-blob/src/utils/utils.node.js.map +1 -1
- package/dist-esm/storage-file-share/src/AccountSASPermissions.js +2 -2
- package/dist-esm/storage-file-share/src/AccountSASPermissions.js.map +1 -1
- package/dist-esm/storage-file-share/src/AccountSASResourceTypes.js +1 -1
- package/dist-esm/storage-file-share/src/AccountSASResourceTypes.js.map +1 -1
- package/dist-esm/storage-file-share/src/AccountSASSignatureValues.js +1 -1
- package/dist-esm/storage-file-share/src/AccountSASSignatureValues.js.map +1 -1
- package/dist-esm/storage-file-share/src/Clients.js +103 -78
- package/dist-esm/storage-file-share/src/Clients.js.map +1 -1
- package/dist-esm/storage-file-share/src/FileDownloadResponse.js +24 -0
- package/dist-esm/storage-file-share/src/FileDownloadResponse.js.map +1 -1
- package/dist-esm/storage-file-share/src/FileSASSignatureValues.js.map +1 -1
- package/dist-esm/storage-file-share/src/FileSystemAttributes.js +1 -1
- package/dist-esm/storage-file-share/src/FileSystemAttributes.js.map +1 -1
- package/dist-esm/storage-file-share/src/Range.js.map +1 -1
- package/dist-esm/storage-file-share/src/SASQueryParameters.js.map +1 -1
- package/dist-esm/storage-file-share/src/ShareSASPermissions.js +1 -1
- package/dist-esm/storage-file-share/src/ShareSASPermissions.js.map +1 -1
- package/dist-esm/storage-file-share/src/ShareServiceClient.js +13 -7
- package/dist-esm/storage-file-share/src/ShareServiceClient.js.map +1 -1
- package/dist-esm/storage-file-share/src/StorageRetryPolicyFactory.js.map +1 -1
- package/dist-esm/storage-file-share/src/generated/src/models/index.js +10 -0
- package/dist-esm/storage-file-share/src/generated/src/models/index.js.map +1 -1
- package/dist-esm/storage-file-share/src/generated/src/models/mappers.js +544 -0
- package/dist-esm/storage-file-share/src/generated/src/models/mappers.js.map +1 -1
- package/dist-esm/storage-file-share/src/generated/src/models/parameters.js +108 -3
- 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 +12 -10
- 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 +125 -10
- package/dist-esm/storage-file-share/src/generated/src/operations/file.js.map +1 -1
- package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/directory.js.map +1 -1
- package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/file.js.map +1 -1
- package/dist-esm/storage-file-share/src/generated/src/storageClient.js +2 -2
- package/dist-esm/storage-file-share/src/generated/src/storageClient.js.map +1 -1
- package/dist-esm/storage-file-share/src/generatedModels.js.map +1 -1
- package/dist-esm/storage-file-share/src/index.browser.js +1 -0
- package/dist-esm/storage-file-share/src/index.browser.js.map +1 -1
- package/dist-esm/storage-file-share/src/index.js +1 -0
- package/dist-esm/storage-file-share/src/index.js.map +1 -1
- package/dist-esm/storage-file-share/src/models.js +0 -21
- package/dist-esm/storage-file-share/src/models.js.map +1 -1
- package/dist-esm/storage-file-share/src/utils/constants.js +2 -2
- package/dist-esm/storage-file-share/src/utils/constants.js.map +1 -1
- package/dist-esm/storage-file-share/src/utils/utils.common.js +214 -2
- package/dist-esm/storage-file-share/src/utils/utils.common.js.map +1 -1
- package/package.json +9 -9
- package/types/latest/storage-file-share.d.ts +968 -134
@@ -89,7 +89,7 @@ export declare class AccountSASPermissions {
|
|
89
89
|
* Using this method will guarantee the resource types are in
|
90
90
|
* an order accepted by the service.
|
91
91
|
*
|
92
|
-
* @see https://
|
92
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
93
93
|
*
|
94
94
|
*/
|
95
95
|
toString(): string;
|
@@ -127,7 +127,7 @@ export declare class AccountSASResourceTypes {
|
|
127
127
|
/**
|
128
128
|
* Converts the given resource types to a string.
|
129
129
|
*
|
130
|
-
* @see https://
|
130
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
131
131
|
*
|
132
132
|
*/
|
133
133
|
toString(): string;
|
@@ -182,10 +182,10 @@ export declare class AccountSASServices {
|
|
182
182
|
* the former is mutable and a logical representation while the latter is immutable and used to generate actual REST
|
183
183
|
* requests.
|
184
184
|
*
|
185
|
-
* @see https://
|
185
|
+
* @see https://learn.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1
|
186
186
|
* for more conceptual information on SAS
|
187
187
|
*
|
188
|
-
* @see https://
|
188
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
189
189
|
* for descriptions of the parameters, including which are required
|
190
190
|
*/
|
191
191
|
export declare interface AccountSASSignatureValues {
|
@@ -343,7 +343,7 @@ export declare interface CommonGenerateSasUrlOptions {
|
|
343
343
|
/**
|
344
344
|
* Optional. The name of the access policy on the share this SAS references if any.
|
345
345
|
*
|
346
|
-
* @see https://
|
346
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
|
347
347
|
*/
|
348
348
|
identifier?: string;
|
349
349
|
/**
|
@@ -463,11 +463,9 @@ declare interface DestinationLeaseAccessConditions {
|
|
463
463
|
declare interface Directory {
|
464
464
|
/**
|
465
465
|
* Creates a new directory under the specified share or parent directory.
|
466
|
-
* @param fileAttributes If specified, the provided file attributes shall be set. Default value:
|
467
|
-
* ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
|
468
466
|
* @param options The options parameters.
|
469
467
|
*/
|
470
|
-
create(
|
468
|
+
create(options?: DirectoryCreateOptionalParams): Promise<DirectoryCreateResponse_2>;
|
471
469
|
/**
|
472
470
|
* Returns all system properties for the specified directory, and can also be used to check the
|
473
471
|
* existence of a directory. The data returned does not include the files in the directory or any
|
@@ -483,11 +481,9 @@ declare interface Directory {
|
|
483
481
|
delete(options?: DirectoryDeleteOptionalParams): Promise<DirectoryDeleteResponse_2>;
|
484
482
|
/**
|
485
483
|
* Sets properties on the directory.
|
486
|
-
* @param fileAttributes If specified, the provided file attributes shall be set. Default value:
|
487
|
-
* ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
|
488
484
|
* @param options The options parameters.
|
489
485
|
*/
|
490
|
-
setProperties(
|
486
|
+
setProperties(options?: DirectorySetPropertiesOptionalParams): Promise<DirectorySetPropertiesResponse_2>;
|
491
487
|
/**
|
492
488
|
* Updates user defined metadata for the specified directory.
|
493
489
|
* @param options The options parameters.
|
@@ -572,6 +568,54 @@ export declare interface DirectoryCreateHeaders {
|
|
572
568
|
fileId?: string;
|
573
569
|
/** The parent fileId of the directory. */
|
574
570
|
fileParentId?: string;
|
571
|
+
/** NFS only. The mode of the file or directory. */
|
572
|
+
fileMode?: NfsFileMode;
|
573
|
+
/** NFS only. The owner of the file or directory. */
|
574
|
+
owner?: string;
|
575
|
+
/** NFS only. The owning group of the file or directory. */
|
576
|
+
group?: string;
|
577
|
+
/** NFS only. Type of the file or directory. */
|
578
|
+
nfsFileType?: NfsFileType;
|
579
|
+
/** Error Code */
|
580
|
+
errorCode?: string;
|
581
|
+
}
|
582
|
+
|
583
|
+
/** Defines headers for Directory_create operation. */
|
584
|
+
declare interface DirectoryCreateHeaders_2 {
|
585
|
+
/** The ETag contains a value which represents the version of the directory, in quotes. */
|
586
|
+
etag?: string;
|
587
|
+
/** Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */
|
588
|
+
lastModified?: Date;
|
589
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
590
|
+
requestId?: string;
|
591
|
+
/** Indicates the version of the File service used to execute the request. */
|
592
|
+
version?: string;
|
593
|
+
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
594
|
+
date?: Date;
|
595
|
+
/** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */
|
596
|
+
isServerEncrypted?: boolean;
|
597
|
+
/** Key of the permission set for the directory. */
|
598
|
+
filePermissionKey?: string;
|
599
|
+
/** Attributes set for the directory. */
|
600
|
+
fileAttributes?: string;
|
601
|
+
/** Creation time for the directory. */
|
602
|
+
fileCreatedOn?: Date;
|
603
|
+
/** Last write time for the directory. */
|
604
|
+
fileLastWriteOn?: Date;
|
605
|
+
/** Change time for the directory. */
|
606
|
+
fileChangeOn?: Date;
|
607
|
+
/** The fileId of the directory. */
|
608
|
+
fileId?: string;
|
609
|
+
/** The parent fileId of the directory. */
|
610
|
+
fileParentId?: string;
|
611
|
+
/** NFS only. The mode of the file or directory. */
|
612
|
+
fileMode?: string;
|
613
|
+
/** NFS only. The owner of the file or directory. */
|
614
|
+
owner?: string;
|
615
|
+
/** NFS only. The owning group of the file or directory. */
|
616
|
+
group?: string;
|
617
|
+
/** NFS only. Type of the file or directory. */
|
618
|
+
nfsFileType?: NfsFileType;
|
575
619
|
/** Error Code */
|
576
620
|
errorCode?: string;
|
577
621
|
}
|
@@ -604,12 +648,20 @@ declare interface DirectoryCreateOptionalParams extends coreClient.OperationOpti
|
|
604
648
|
filePermission?: string;
|
605
649
|
/** 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. */
|
606
650
|
filePermissionKey?: string;
|
651
|
+
/** If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default. */
|
652
|
+
fileAttributes?: string;
|
607
653
|
/** Creation time for the file/directory. Default value: Now. */
|
608
654
|
fileCreatedOn?: string;
|
609
655
|
/** Last write time for the file/directory. Default value: Now. */
|
610
656
|
fileLastWriteOn?: string;
|
611
657
|
/** Change time for the file/directory. Default value: Now. */
|
612
658
|
fileChangeOn?: string;
|
659
|
+
/** Optional, NFS only. The owner of the file or directory. */
|
660
|
+
owner?: string;
|
661
|
+
/** Optional, NFS only. The owning group of the file or directory. */
|
662
|
+
group?: string;
|
663
|
+
/** Optional, NFS only. The file mode of the file or directory */
|
664
|
+
fileMode?: string;
|
613
665
|
}
|
614
666
|
|
615
667
|
/**
|
@@ -631,7 +683,7 @@ export declare interface DirectoryCreateOptions extends FileAndDirectoryCreateCo
|
|
631
683
|
export declare type DirectoryCreateResponse = WithResponse<DirectoryCreateHeaders, DirectoryCreateHeaders>;
|
632
684
|
|
633
685
|
/** Contains response data for the create operation. */
|
634
|
-
declare type DirectoryCreateResponse_2 =
|
686
|
+
declare type DirectoryCreateResponse_2 = DirectoryCreateHeaders_2;
|
635
687
|
|
636
688
|
/** Defines headers for Directory_delete operation. */
|
637
689
|
export declare interface DirectoryDeleteHeaders {
|
@@ -798,6 +850,58 @@ export declare interface DirectoryGetPropertiesHeaders {
|
|
798
850
|
fileId?: string;
|
799
851
|
/** The parent fileId of the directory. */
|
800
852
|
fileParentId?: string;
|
853
|
+
/** NFS only. The mode of the file or directory. */
|
854
|
+
fileMode?: NfsFileMode;
|
855
|
+
/** NFS only. The owner of the file or directory. */
|
856
|
+
owner?: string;
|
857
|
+
/** NFS only. The owning group of the file or directory. */
|
858
|
+
group?: string;
|
859
|
+
/** NFS only. Type of the file or directory. */
|
860
|
+
nfsFileType?: NfsFileType;
|
861
|
+
/** Error Code */
|
862
|
+
errorCode?: string;
|
863
|
+
}
|
864
|
+
|
865
|
+
/** Defines headers for Directory_getProperties operation. */
|
866
|
+
declare interface DirectoryGetPropertiesHeaders_2 {
|
867
|
+
/** A set of name-value pairs that contain metadata for the directory. */
|
868
|
+
metadata?: {
|
869
|
+
[propertyName: string]: string;
|
870
|
+
};
|
871
|
+
/** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
|
872
|
+
etag?: string;
|
873
|
+
/** Returns the date and time the Directory was last modified. Operations on files within the directory do not affect the last modified time of the directory. */
|
874
|
+
lastModified?: Date;
|
875
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
876
|
+
requestId?: string;
|
877
|
+
/** Indicates the version of the File service used to execute the request. */
|
878
|
+
version?: string;
|
879
|
+
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
880
|
+
date?: Date;
|
881
|
+
/** The value of this header is set to true if the directory metadata is completely encrypted using the specified algorithm. Otherwise, the value is set to false. */
|
882
|
+
isServerEncrypted?: boolean;
|
883
|
+
/** Attributes set for the directory. */
|
884
|
+
fileAttributes?: string;
|
885
|
+
/** Creation time for the directory. */
|
886
|
+
fileCreatedOn?: Date;
|
887
|
+
/** Last write time for the directory. */
|
888
|
+
fileLastWriteOn?: Date;
|
889
|
+
/** Change time for the directory. */
|
890
|
+
fileChangeOn?: Date;
|
891
|
+
/** Key of the permission set for the directory. */
|
892
|
+
filePermissionKey?: string;
|
893
|
+
/** The fileId of the directory. */
|
894
|
+
fileId?: string;
|
895
|
+
/** The parent fileId of the directory. */
|
896
|
+
fileParentId?: string;
|
897
|
+
/** NFS only. The mode of the file or directory. */
|
898
|
+
fileMode?: string;
|
899
|
+
/** NFS only. The owner of the file or directory. */
|
900
|
+
owner?: string;
|
901
|
+
/** NFS only. The owning group of the file or directory. */
|
902
|
+
group?: string;
|
903
|
+
/** NFS only. Type of the file or directory. */
|
904
|
+
nfsFileType?: NfsFileType;
|
801
905
|
/** Error Code */
|
802
906
|
errorCode?: string;
|
803
907
|
}
|
@@ -829,7 +933,7 @@ export declare interface DirectoryGetPropertiesOptions extends CommonOptions {
|
|
829
933
|
export declare type DirectoryGetPropertiesResponse = WithResponse<DirectoryGetPropertiesHeaders, DirectoryGetPropertiesHeaders>;
|
830
934
|
|
831
935
|
/** Contains response data for the getProperties operation. */
|
832
|
-
declare type DirectoryGetPropertiesResponse_2 =
|
936
|
+
declare type DirectoryGetPropertiesResponse_2 = DirectoryGetPropertiesHeaders_2;
|
833
937
|
|
834
938
|
/** A listed directory item. */
|
835
939
|
export declare interface DirectoryItem {
|
@@ -1093,7 +1197,7 @@ export declare interface DirectoryRenameOptions extends CommonOptions {
|
|
1093
1197
|
copyFileSmbInfo?: CopyFileSmbInfo;
|
1094
1198
|
/**
|
1095
1199
|
* Optional.
|
1096
|
-
* The timeout parameter is expressed in seconds. For more information, see <a href="https://
|
1200
|
+
* The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a>
|
1097
1201
|
*/
|
1098
1202
|
timeoutInSeconds?: number;
|
1099
1203
|
/**
|
@@ -1210,6 +1314,50 @@ export declare interface DirectorySetPropertiesHeaders {
|
|
1210
1314
|
fileId?: string;
|
1211
1315
|
/** The parent fileId of the directory. */
|
1212
1316
|
fileParentId?: string;
|
1317
|
+
/** NFS only. The mode of the file or directory. */
|
1318
|
+
fileMode?: NfsFileMode;
|
1319
|
+
/** NFS only. The owner of the file or directory. */
|
1320
|
+
owner?: string;
|
1321
|
+
/** NFS only. The owning group of the file or directory. */
|
1322
|
+
group?: string;
|
1323
|
+
/** Error Code */
|
1324
|
+
errorCode?: string;
|
1325
|
+
}
|
1326
|
+
|
1327
|
+
/** Defines headers for Directory_setProperties operation. */
|
1328
|
+
declare interface DirectorySetPropertiesHeaders_2 {
|
1329
|
+
/** The ETag contains a value which represents the version of the file, in quotes. */
|
1330
|
+
etag?: string;
|
1331
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
1332
|
+
requestId?: string;
|
1333
|
+
/** Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */
|
1334
|
+
lastModified?: Date;
|
1335
|
+
/** Indicates the version of the File service used to execute the request. */
|
1336
|
+
version?: string;
|
1337
|
+
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
1338
|
+
date?: Date;
|
1339
|
+
/** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */
|
1340
|
+
isServerEncrypted?: boolean;
|
1341
|
+
/** Key of the permission set for the directory. */
|
1342
|
+
filePermissionKey?: string;
|
1343
|
+
/** Attributes set for the directory. */
|
1344
|
+
fileAttributes?: string;
|
1345
|
+
/** Creation time for the directory. */
|
1346
|
+
fileCreatedOn?: Date;
|
1347
|
+
/** Last write time for the directory. */
|
1348
|
+
fileLastWriteOn?: Date;
|
1349
|
+
/** Change time for the directory. */
|
1350
|
+
fileChangeOn?: Date;
|
1351
|
+
/** The fileId of the directory. */
|
1352
|
+
fileId?: string;
|
1353
|
+
/** The parent fileId of the directory. */
|
1354
|
+
fileParentId?: string;
|
1355
|
+
/** NFS only. The mode of the file or directory. */
|
1356
|
+
fileMode?: string;
|
1357
|
+
/** NFS only. The owner of the file or directory. */
|
1358
|
+
owner?: string;
|
1359
|
+
/** NFS only. The owning group of the file or directory. */
|
1360
|
+
group?: string;
|
1213
1361
|
/** Error Code */
|
1214
1362
|
errorCode?: string;
|
1215
1363
|
}
|
@@ -1228,35 +1376,41 @@ declare interface DirectorySetPropertiesOptionalParams extends coreClient.Operat
|
|
1228
1376
|
filePermission?: string;
|
1229
1377
|
/** 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. */
|
1230
1378
|
filePermissionKey?: string;
|
1379
|
+
/** If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default. */
|
1380
|
+
fileAttributes?: string;
|
1231
1381
|
/** Creation time for the file/directory. Default value: Now. */
|
1232
1382
|
fileCreatedOn?: string;
|
1233
1383
|
/** Last write time for the file/directory. Default value: Now. */
|
1234
1384
|
fileLastWriteOn?: string;
|
1235
1385
|
/** Change time for the file/directory. Default value: Now. */
|
1236
1386
|
fileChangeOn?: string;
|
1387
|
+
/** Optional, NFS only. The owner of the file or directory. */
|
1388
|
+
owner?: string;
|
1389
|
+
/** Optional, NFS only. The owning group of the file or directory. */
|
1390
|
+
group?: string;
|
1391
|
+
/** Optional, NFS only. The file mode of the file or directory */
|
1392
|
+
fileMode?: string;
|
1237
1393
|
}
|
1238
1394
|
|
1239
1395
|
/** Contains response data for the setProperties operation. */
|
1240
1396
|
export declare type DirectorySetPropertiesResponse = WithResponse<DirectorySetPropertiesHeaders, DirectorySetPropertiesHeaders>;
|
1241
1397
|
|
1242
1398
|
/** Contains response data for the setProperties operation. */
|
1243
|
-
declare type DirectorySetPropertiesResponse_2 =
|
1399
|
+
declare type DirectorySetPropertiesResponse_2 = DirectorySetPropertiesHeaders_2;
|
1244
1400
|
|
1245
1401
|
/** Interface representing a File. */
|
1246
1402
|
declare interface File_2 {
|
1247
1403
|
/**
|
1248
1404
|
* Creates a new file or replaces a file. Note it only initializes the file with no content.
|
1249
1405
|
* @param fileContentLength Specifies the maximum size for the file, up to 4 TB.
|
1250
|
-
* @param fileAttributes If specified, the provided file attributes shall be set. Default value:
|
1251
|
-
* ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
|
1252
1406
|
* @param options The options parameters.
|
1253
1407
|
*/
|
1254
|
-
create(fileContentLength: number,
|
1408
|
+
create(fileContentLength: number, options?: FileCreateOptionalParams): Promise<FileCreateResponse_2>;
|
1255
1409
|
/**
|
1256
1410
|
* Reads or downloads a file from the system, including its metadata and properties.
|
1257
1411
|
* @param options The options parameters.
|
1258
1412
|
*/
|
1259
|
-
download(options?: FileDownloadOptionalParams): Promise<
|
1413
|
+
download(options?: FileDownloadOptionalParams): Promise<FileDownloadResponse>;
|
1260
1414
|
/**
|
1261
1415
|
* Returns all user-defined metadata, standard HTTP properties, and system properties for the file. It
|
1262
1416
|
* does not return the content of the file.
|
@@ -1270,11 +1424,9 @@ declare interface File_2 {
|
|
1270
1424
|
delete(options?: FileDeleteOptionalParams): Promise<FileDeleteResponse_2>;
|
1271
1425
|
/**
|
1272
1426
|
* Sets HTTP headers on the file.
|
1273
|
-
* @param fileAttributes If specified, the provided file attributes shall be set. Default value:
|
1274
|
-
* ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
|
1275
1427
|
* @param options The options parameters.
|
1276
1428
|
*/
|
1277
|
-
setHttpHeaders(
|
1429
|
+
setHttpHeaders(options?: FileSetHttpHeadersOptionalParams): Promise<FileSetHttpHeadersResponse>;
|
1278
1430
|
/**
|
1279
1431
|
* Updates user-defined metadata for the specified file.
|
1280
1432
|
* @param options The options parameters.
|
@@ -1379,6 +1531,24 @@ declare interface File_2 {
|
|
1379
1531
|
* @param options The options parameters.
|
1380
1532
|
*/
|
1381
1533
|
rename(renameSource: string, options?: FileRenameOptionalParams): Promise<FileRenameResponse_2>;
|
1534
|
+
/**
|
1535
|
+
* Creates a symbolic link.
|
1536
|
+
* @param linkText NFS only. Required. The path to the original file, the symbolic link is pointing to.
|
1537
|
+
* The path is of type string which is not resolved and is stored as is. The path can be absolute path
|
1538
|
+
* or the relative path depending on the content stored in the symbolic link file.
|
1539
|
+
* @param options The options parameters.
|
1540
|
+
*/
|
1541
|
+
createSymbolicLink(linkText: string, options?: FileCreateSymbolicLinkOptionalParams): Promise<FileCreateSymbolicLinkResponse>;
|
1542
|
+
/** @param options The options parameters. */
|
1543
|
+
getSymbolicLink(options?: FileGetSymbolicLinkOptionalParams): Promise<FileGetSymbolicLinkResponse>;
|
1544
|
+
/**
|
1545
|
+
* Creates a hard link.
|
1546
|
+
* @param targetFile NFS only. Required. Specifies the path of the target file to which the link will
|
1547
|
+
* be created, up to 2 KiB in length. It should be full path of the target from the root.The target
|
1548
|
+
* file must be in the same share and hence the same storage account.
|
1549
|
+
* @param options The options parameters.
|
1550
|
+
*/
|
1551
|
+
createHardLink(targetFile: string, options?: FileCreateHardLinkOptionalParams): Promise<FileCreateHardLinkResponse_2>;
|
1382
1552
|
}
|
1383
1553
|
|
1384
1554
|
/**
|
@@ -1509,6 +1679,11 @@ export declare interface FileAndDirectoryCreateCommonOptions {
|
|
1509
1679
|
* By default, the value will be set to the time of the request.
|
1510
1680
|
*/
|
1511
1681
|
changeTime?: Date | TimeNowType;
|
1682
|
+
/**
|
1683
|
+
* Optional properties to set on NFS files.
|
1684
|
+
Note that this property is only applicable to files created in NFS shares.
|
1685
|
+
*/
|
1686
|
+
posixProperties?: FilePosixProperties;
|
1512
1687
|
}
|
1513
1688
|
|
1514
1689
|
export declare interface FileAndDirectorySetPropertiesCommonOptions {
|
@@ -1559,6 +1734,11 @@ export declare interface FileAndDirectorySetPropertiesCommonOptions {
|
|
1559
1734
|
* By default, the value will be set to the time of the request.
|
1560
1735
|
*/
|
1561
1736
|
changeTime?: Date | TimeNowType;
|
1737
|
+
/**
|
1738
|
+
* Optional properties to set on NFS files.
|
1739
|
+
Note that this property is only applicable to files created in NFS shares.
|
1740
|
+
*/
|
1741
|
+
posixProperties?: FilePosixProperties;
|
1562
1742
|
}
|
1563
1743
|
|
1564
1744
|
/**
|
@@ -1683,6 +1863,114 @@ export declare interface FileCloseHandlesHeaders {
|
|
1683
1863
|
marker?: string;
|
1684
1864
|
}
|
1685
1865
|
|
1866
|
+
/** Defines headers for File_createHardLink operation. */
|
1867
|
+
export declare interface FileCreateHardLinkHeaders {
|
1868
|
+
/** The ETag contains a value which represents the version of the file, in quotes. */
|
1869
|
+
etag?: string;
|
1870
|
+
/** Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */
|
1871
|
+
lastModified?: Date;
|
1872
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
1873
|
+
requestId?: string;
|
1874
|
+
/** Indicates the version of the File service used to execute the request. */
|
1875
|
+
version?: string;
|
1876
|
+
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
1877
|
+
date?: Date;
|
1878
|
+
/** Creation time for the file. */
|
1879
|
+
fileCreationTime?: Date;
|
1880
|
+
/** Last write time for the file. */
|
1881
|
+
fileLastWriteTime?: Date;
|
1882
|
+
/** Change time for the file. */
|
1883
|
+
fileChangeTime?: Date;
|
1884
|
+
/** The fileId of the file. */
|
1885
|
+
fileId?: string;
|
1886
|
+
/** The parent fileId of the directory. */
|
1887
|
+
fileParentId?: string;
|
1888
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
1889
|
+
clientRequestId?: string;
|
1890
|
+
/** NFS only. The link count of the file or directory. */
|
1891
|
+
linkCount?: number;
|
1892
|
+
/** NFS only. The mode of the file or directory. */
|
1893
|
+
fileMode?: NfsFileMode;
|
1894
|
+
/** NFS only. The owner of the file or directory. */
|
1895
|
+
owner?: string;
|
1896
|
+
/** NFS only. The owning group of the file or directory. */
|
1897
|
+
group?: string;
|
1898
|
+
/** NFS only. Type of the file or directory. */
|
1899
|
+
nfsFileType?: NfsFileType;
|
1900
|
+
}
|
1901
|
+
|
1902
|
+
/** Defines headers for File_createHardLink operation. */
|
1903
|
+
declare interface FileCreateHardLinkHeaders_2 {
|
1904
|
+
/** The ETag contains a value which represents the version of the file, in quotes. */
|
1905
|
+
etag?: string;
|
1906
|
+
/** Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */
|
1907
|
+
lastModified?: Date;
|
1908
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
1909
|
+
requestId?: string;
|
1910
|
+
/** Indicates the version of the File service used to execute the request. */
|
1911
|
+
version?: string;
|
1912
|
+
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
1913
|
+
date?: Date;
|
1914
|
+
/** Creation time for the file. */
|
1915
|
+
fileCreationTime?: Date;
|
1916
|
+
/** Last write time for the file. */
|
1917
|
+
fileLastWriteTime?: Date;
|
1918
|
+
/** Change time for the file. */
|
1919
|
+
fileChangeTime?: Date;
|
1920
|
+
/** The fileId of the file. */
|
1921
|
+
fileId?: string;
|
1922
|
+
/** The parent fileId of the directory. */
|
1923
|
+
fileParentId?: string;
|
1924
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
1925
|
+
clientRequestId?: string;
|
1926
|
+
/** NFS only. The link count of the file or directory. */
|
1927
|
+
linkCount?: number;
|
1928
|
+
/** NFS only. The mode of the file or directory. */
|
1929
|
+
fileMode?: string;
|
1930
|
+
/** NFS only. The owner of the file or directory. */
|
1931
|
+
owner?: string;
|
1932
|
+
/** NFS only. The owning group of the file or directory. */
|
1933
|
+
group?: string;
|
1934
|
+
/** NFS only. Type of the file or directory. */
|
1935
|
+
nfsFileType?: NfsFileType;
|
1936
|
+
}
|
1937
|
+
|
1938
|
+
/** Optional parameters. */
|
1939
|
+
declare interface FileCreateHardLinkOptionalParams extends coreClient.OperationOptions {
|
1940
|
+
/** Parameter group */
|
1941
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
1942
|
+
/** 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> */
|
1943
|
+
timeoutInSeconds?: number;
|
1944
|
+
/** Valid value is backup */
|
1945
|
+
fileRequestIntent?: ShareTokenIntent;
|
1946
|
+
/** 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. */
|
1947
|
+
requestId?: string;
|
1948
|
+
}
|
1949
|
+
|
1950
|
+
/**
|
1951
|
+
* Options to configure File - Create Hard Link operations.
|
1952
|
+
*
|
1953
|
+
* See:
|
1954
|
+
* - {@link ShareFileClient.createHardLink}
|
1955
|
+
*/
|
1956
|
+
export declare interface FileCreateHardLinkOptions extends CommonOptions {
|
1957
|
+
/**
|
1958
|
+
* Lease access conditions.
|
1959
|
+
*/
|
1960
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
1961
|
+
/**
|
1962
|
+
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
1963
|
+
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
1964
|
+
*/
|
1965
|
+
abortSignal?: AbortSignalLike;
|
1966
|
+
}
|
1967
|
+
|
1968
|
+
/** Contains response data for the create hard link operation. */
|
1969
|
+
export declare type FileCreateHardLinkResponse = WithResponse<FileCreateHardLinkHeaders, FileCreateHardLinkHeaders>;
|
1970
|
+
|
1971
|
+
/** Contains response data for the createHardLink operation. */
|
1972
|
+
declare type FileCreateHardLinkResponse_2 = FileCreateHardLinkHeaders_2;
|
1973
|
+
|
1686
1974
|
/** Defines headers for File_create operation. */
|
1687
1975
|
export declare interface FileCreateHeaders {
|
1688
1976
|
/** The ETag contains a value which represents the version of the file, in quotes. */
|
@@ -1711,6 +1999,54 @@ export declare interface FileCreateHeaders {
|
|
1711
1999
|
fileId?: string;
|
1712
2000
|
/** The parent fileId of the file. */
|
1713
2001
|
fileParentId?: string;
|
2002
|
+
/** NFS only. The mode of the file or directory. */
|
2003
|
+
fileMode?: NfsFileMode;
|
2004
|
+
/** NFS only. The owner of the file or directory. */
|
2005
|
+
owner?: string;
|
2006
|
+
/** NFS only. The owning group of the file or directory. */
|
2007
|
+
group?: string;
|
2008
|
+
/** NFS only. Type of the file or directory. */
|
2009
|
+
nfsFileType?: NfsFileType;
|
2010
|
+
/** Error Code */
|
2011
|
+
errorCode?: string;
|
2012
|
+
}
|
2013
|
+
|
2014
|
+
/** Defines headers for File_create operation. */
|
2015
|
+
declare interface FileCreateHeaders_2 {
|
2016
|
+
/** The ETag contains a value which represents the version of the file, in quotes. */
|
2017
|
+
etag?: string;
|
2018
|
+
/** Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */
|
2019
|
+
lastModified?: Date;
|
2020
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
2021
|
+
requestId?: string;
|
2022
|
+
/** Indicates the version of the File service used to execute the request. */
|
2023
|
+
version?: string;
|
2024
|
+
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
2025
|
+
date?: Date;
|
2026
|
+
/** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */
|
2027
|
+
isServerEncrypted?: boolean;
|
2028
|
+
/** Key of the permission set for the file. */
|
2029
|
+
filePermissionKey?: string;
|
2030
|
+
/** Attributes set for the file. */
|
2031
|
+
fileAttributes?: string;
|
2032
|
+
/** Creation time for the file. */
|
2033
|
+
fileCreatedOn?: Date;
|
2034
|
+
/** Last write time for the file. */
|
2035
|
+
fileLastWriteOn?: Date;
|
2036
|
+
/** Change time for the file. */
|
2037
|
+
fileChangeOn?: Date;
|
2038
|
+
/** The fileId of the file. */
|
2039
|
+
fileId?: string;
|
2040
|
+
/** The parent fileId of the file. */
|
2041
|
+
fileParentId?: string;
|
2042
|
+
/** NFS only. The mode of the file or directory. */
|
2043
|
+
fileMode?: string;
|
2044
|
+
/** NFS only. The owner of the file or directory. */
|
2045
|
+
owner?: string;
|
2046
|
+
/** NFS only. The owning group of the file or directory. */
|
2047
|
+
group?: string;
|
2048
|
+
/** NFS only. Type of the file or directory. */
|
2049
|
+
nfsFileType?: NfsFileType;
|
1714
2050
|
/** Error Code */
|
1715
2051
|
errorCode?: string;
|
1716
2052
|
}
|
@@ -1737,12 +2073,22 @@ declare interface FileCreateOptionalParams extends coreClient.OperationOptions {
|
|
1737
2073
|
filePermission?: string;
|
1738
2074
|
/** 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. */
|
1739
2075
|
filePermissionKey?: string;
|
2076
|
+
/** If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default. */
|
2077
|
+
fileAttributes?: string;
|
1740
2078
|
/** Creation time for the file/directory. Default value: Now. */
|
1741
2079
|
fileCreatedOn?: string;
|
1742
2080
|
/** Last write time for the file/directory. Default value: Now. */
|
1743
2081
|
fileLastWriteOn?: string;
|
1744
2082
|
/** Change time for the file/directory. Default value: Now. */
|
1745
2083
|
fileChangeOn?: string;
|
2084
|
+
/** Optional, NFS only. The owner of the file or directory. */
|
2085
|
+
owner?: string;
|
2086
|
+
/** Optional, NFS only. The owning group of the file or directory. */
|
2087
|
+
group?: string;
|
2088
|
+
/** Optional, NFS only. The file mode of the file or directory */
|
2089
|
+
fileMode?: string;
|
2090
|
+
/** Optional, NFS only. Type of the file or directory. */
|
2091
|
+
nfsFileType?: NfsFileType;
|
1746
2092
|
}
|
1747
2093
|
|
1748
2094
|
/**
|
@@ -1772,7 +2118,68 @@ export declare interface FileCreateOptions extends FileAndDirectoryCreateCommonO
|
|
1772
2118
|
export declare type FileCreateResponse = WithResponse<FileCreateHeaders, FileCreateHeaders>;
|
1773
2119
|
|
1774
2120
|
/** Contains response data for the create operation. */
|
1775
|
-
declare type FileCreateResponse_2 =
|
2121
|
+
declare type FileCreateResponse_2 = FileCreateHeaders_2;
|
2122
|
+
|
2123
|
+
/** Defines headers for File_createSymbolicLink operation. */
|
2124
|
+
declare interface FileCreateSymbolicLinkHeaders {
|
2125
|
+
/** The ETag contains a value which represents the version of the file, in quotes. */
|
2126
|
+
etag?: string;
|
2127
|
+
/** Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */
|
2128
|
+
lastModified?: Date;
|
2129
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
2130
|
+
requestId?: string;
|
2131
|
+
/** Indicates the version of the File service used to execute the request. */
|
2132
|
+
version?: string;
|
2133
|
+
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
2134
|
+
date?: Date;
|
2135
|
+
/** Creation time for the file. */
|
2136
|
+
fileCreationTime?: Date;
|
2137
|
+
/** Last write time for the file. */
|
2138
|
+
fileLastWriteTime?: Date;
|
2139
|
+
/** Change time for the file. */
|
2140
|
+
fileChangeTime?: Date;
|
2141
|
+
/** The fileId of the file. */
|
2142
|
+
fileId?: string;
|
2143
|
+
/** The parent fileId of the directory. */
|
2144
|
+
fileParentId?: string;
|
2145
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
2146
|
+
clientRequestId?: string;
|
2147
|
+
/** NFS only. The mode of the file or directory. */
|
2148
|
+
fileMode?: string;
|
2149
|
+
/** NFS only. The owner of the file or directory. */
|
2150
|
+
owner?: string;
|
2151
|
+
/** NFS only. The owning group of the file or directory. */
|
2152
|
+
group?: string;
|
2153
|
+
/** NFS only. Type of the file or directory. */
|
2154
|
+
nfsFileType?: NfsFileType;
|
2155
|
+
}
|
2156
|
+
|
2157
|
+
/** Optional parameters. */
|
2158
|
+
declare interface FileCreateSymbolicLinkOptionalParams extends coreClient.OperationOptions {
|
2159
|
+
/** Parameter group */
|
2160
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
2161
|
+
/** 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> */
|
2162
|
+
timeoutInSeconds?: number;
|
2163
|
+
/** Valid value is backup */
|
2164
|
+
fileRequestIntent?: ShareTokenIntent;
|
2165
|
+
/** A name-value pair to associate with a file storage object. */
|
2166
|
+
metadata?: {
|
2167
|
+
[propertyName: string]: string;
|
2168
|
+
};
|
2169
|
+
/** 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. */
|
2170
|
+
requestId?: string;
|
2171
|
+
/** Creation time for the file/directory. Default value: Now. */
|
2172
|
+
fileCreatedOn?: string;
|
2173
|
+
/** Last write time for the file/directory. Default value: Now. */
|
2174
|
+
fileLastWriteOn?: string;
|
2175
|
+
/** Optional, NFS only. The owner of the file or directory. */
|
2176
|
+
owner?: string;
|
2177
|
+
/** Optional, NFS only. The owning group of the file or directory. */
|
2178
|
+
group?: string;
|
2179
|
+
}
|
2180
|
+
|
2181
|
+
/** Contains response data for the createSymbolicLink operation. */
|
2182
|
+
declare type FileCreateSymbolicLinkResponse = FileCreateSymbolicLinkHeaders;
|
1776
2183
|
|
1777
2184
|
/** Defines headers for File_delete operation. */
|
1778
2185
|
export declare interface FileDeleteHeaders {
|
@@ -1782,55 +2189,139 @@ export declare interface FileDeleteHeaders {
|
|
1782
2189
|
version?: string;
|
1783
2190
|
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
1784
2191
|
date?: Date;
|
2192
|
+
/** NFS only. The link count of the file or directory. */
|
2193
|
+
linkCount?: number;
|
2194
|
+
/** Error Code */
|
2195
|
+
errorCode?: string;
|
2196
|
+
}
|
2197
|
+
|
2198
|
+
/**
|
2199
|
+
* Contains response data for the {@link ShareFileClient.deleteIfExists} operation.
|
2200
|
+
*/
|
2201
|
+
export declare interface FileDeleteIfExistsResponse extends FileDeleteResponse {
|
2202
|
+
/**
|
2203
|
+
* Indicate whether the file is successfully deleted. Is false if the file does not exist in the first place.
|
2204
|
+
*/
|
2205
|
+
succeeded: boolean;
|
2206
|
+
}
|
2207
|
+
|
2208
|
+
/** Optional parameters. */
|
2209
|
+
declare interface FileDeleteOptionalParams extends coreClient.OperationOptions {
|
2210
|
+
/** Parameter group */
|
2211
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
2212
|
+
/** 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> */
|
2213
|
+
timeoutInSeconds?: number;
|
2214
|
+
/** Valid value is backup */
|
2215
|
+
fileRequestIntent?: ShareTokenIntent;
|
2216
|
+
/** If true, the trailing dot will not be trimmed from the target URI. */
|
2217
|
+
allowTrailingDot?: boolean;
|
2218
|
+
}
|
2219
|
+
|
2220
|
+
/**
|
2221
|
+
* Options to configure the {@link ShareFileClient.delete} operation.
|
2222
|
+
*/
|
2223
|
+
export declare interface FileDeleteOptions extends CommonOptions {
|
2224
|
+
/**
|
2225
|
+
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
2226
|
+
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
2227
|
+
*/
|
2228
|
+
abortSignal?: AbortSignalLike;
|
2229
|
+
/**
|
2230
|
+
* Lease access conditions.
|
2231
|
+
*/
|
2232
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
2233
|
+
}
|
2234
|
+
|
2235
|
+
/** Contains response data for the delete operation. */
|
2236
|
+
export declare type FileDeleteResponse = WithResponse<FileDeleteHeaders, FileDeleteHeaders>;
|
2237
|
+
|
2238
|
+
/** Contains response data for the delete operation. */
|
2239
|
+
declare type FileDeleteResponse_2 = FileDeleteHeaders;
|
2240
|
+
|
2241
|
+
/** Defines headers for File_download operation. */
|
2242
|
+
export declare interface FileDownloadHeaders {
|
2243
|
+
/** Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time. */
|
2244
|
+
lastModified?: Date;
|
2245
|
+
/** A set of name-value pairs associated with this file as user-defined metadata. */
|
2246
|
+
metadata?: {
|
2247
|
+
[propertyName: string]: string;
|
2248
|
+
};
|
2249
|
+
/** The number of bytes present in the response body. */
|
2250
|
+
contentLength?: number;
|
2251
|
+
/** The content type specified for the file. The default content type is 'application/octet-stream' */
|
2252
|
+
contentType?: string;
|
2253
|
+
/** Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header. */
|
2254
|
+
contentRange?: string;
|
2255
|
+
/** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
|
2256
|
+
etag?: string;
|
2257
|
+
/** If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header. */
|
2258
|
+
contentMD5?: Uint8Array;
|
2259
|
+
/** Returns the value that was specified for the Content-Encoding request header. */
|
2260
|
+
contentEncoding?: string;
|
2261
|
+
/** Returned if it was previously specified for the file. */
|
2262
|
+
cacheControl?: string;
|
2263
|
+
/** Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response. */
|
2264
|
+
contentDisposition?: string;
|
2265
|
+
/** Returns the value that was specified for the Content-Language request header. */
|
2266
|
+
contentLanguage?: string;
|
2267
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
2268
|
+
requestId?: string;
|
2269
|
+
/** Indicates the version of the File service used to execute the request. */
|
2270
|
+
version?: string;
|
2271
|
+
/** Indicates that the service supports requests for partial file content. */
|
2272
|
+
acceptRanges?: string;
|
2273
|
+
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
2274
|
+
date?: Date;
|
2275
|
+
/** Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt. */
|
2276
|
+
copyCompletedOn?: Date;
|
2277
|
+
/** Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure. */
|
2278
|
+
copyStatusDescription?: string;
|
2279
|
+
/** String identifier for the last attempted Copy File operation where this file was the destination file. */
|
2280
|
+
copyId?: string;
|
2281
|
+
/** Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied. */
|
2282
|
+
copyProgress?: string;
|
2283
|
+
/** URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file. */
|
2284
|
+
copySource?: string;
|
2285
|
+
/** State of the copy operation identified by 'x-ms-copy-id'. */
|
2286
|
+
copyStatus?: CopyStatusType;
|
2287
|
+
/** If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range. */
|
2288
|
+
fileContentMD5?: Uint8Array;
|
2289
|
+
/** The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted). */
|
2290
|
+
isServerEncrypted?: boolean;
|
2291
|
+
/** Attributes set for the file. */
|
2292
|
+
fileAttributes?: string;
|
2293
|
+
/** Creation time for the file. */
|
2294
|
+
fileCreatedOn?: Date;
|
2295
|
+
/** Last write time for the file. */
|
2296
|
+
fileLastWriteOn?: Date;
|
2297
|
+
/** Change time for the file. */
|
2298
|
+
fileChangeOn?: Date;
|
2299
|
+
/** Key of the permission set for the file. */
|
2300
|
+
filePermissionKey?: string;
|
2301
|
+
/** The fileId of the file. */
|
2302
|
+
fileId?: string;
|
2303
|
+
/** The parent fileId of the file. */
|
2304
|
+
fileParentId?: string;
|
2305
|
+
/** When a file is leased, specifies whether the lease is of infinite or fixed duration. */
|
2306
|
+
leaseDuration?: LeaseDurationType;
|
2307
|
+
/** Lease state of the file. */
|
2308
|
+
leaseState?: LeaseStateType;
|
2309
|
+
/** The current lease status of the file. */
|
2310
|
+
leaseStatus?: LeaseStatusType;
|
2311
|
+
/** NFS only. The mode of the file or directory. */
|
2312
|
+
fileMode?: NfsFileMode;
|
2313
|
+
/** NFS only. The owner of the file or directory. */
|
2314
|
+
owner?: string;
|
2315
|
+
/** NFS only. The owning group of the file or directory. */
|
2316
|
+
group?: string;
|
2317
|
+
/** NFS only. The link count of the file or directory. */
|
2318
|
+
linkCount?: number;
|
1785
2319
|
/** Error Code */
|
1786
2320
|
errorCode?: string;
|
1787
2321
|
}
|
1788
2322
|
|
1789
|
-
/**
|
1790
|
-
* Contains response data for the {@link ShareFileClient.deleteIfExists} operation.
|
1791
|
-
*/
|
1792
|
-
export declare interface FileDeleteIfExistsResponse extends FileDeleteResponse {
|
1793
|
-
/**
|
1794
|
-
* Indicate whether the file is successfully deleted. Is false if the file does not exist in the first place.
|
1795
|
-
*/
|
1796
|
-
succeeded: boolean;
|
1797
|
-
}
|
1798
|
-
|
1799
|
-
/** Optional parameters. */
|
1800
|
-
declare interface FileDeleteOptionalParams extends coreClient.OperationOptions {
|
1801
|
-
/** Parameter group */
|
1802
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
1803
|
-
/** 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> */
|
1804
|
-
timeoutInSeconds?: number;
|
1805
|
-
/** Valid value is backup */
|
1806
|
-
fileRequestIntent?: ShareTokenIntent;
|
1807
|
-
/** If true, the trailing dot will not be trimmed from the target URI. */
|
1808
|
-
allowTrailingDot?: boolean;
|
1809
|
-
}
|
1810
|
-
|
1811
|
-
/**
|
1812
|
-
* Options to configure the {@link ShareFileClient.delete} operation.
|
1813
|
-
*/
|
1814
|
-
export declare interface FileDeleteOptions extends CommonOptions {
|
1815
|
-
/**
|
1816
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
1817
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
1818
|
-
*/
|
1819
|
-
abortSignal?: AbortSignalLike;
|
1820
|
-
/**
|
1821
|
-
* Lease access conditions.
|
1822
|
-
*/
|
1823
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
1824
|
-
}
|
1825
|
-
|
1826
|
-
/** Contains response data for the delete operation. */
|
1827
|
-
export declare type FileDeleteResponse = WithResponse<FileDeleteHeaders, FileDeleteHeaders>;
|
1828
|
-
|
1829
|
-
/** Contains response data for the delete operation. */
|
1830
|
-
declare type FileDeleteResponse_2 = FileDeleteHeaders;
|
1831
|
-
|
1832
2323
|
/** Defines headers for File_download operation. */
|
1833
|
-
|
2324
|
+
declare interface FileDownloadHeaders_2 {
|
1834
2325
|
/** Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time. */
|
1835
2326
|
lastModified?: Date;
|
1836
2327
|
/** A set of name-value pairs associated with this file as user-defined metadata. */
|
@@ -1899,6 +2390,14 @@ export declare interface FileDownloadHeaders {
|
|
1899
2390
|
leaseState?: LeaseStateType;
|
1900
2391
|
/** The current lease status of the file. */
|
1901
2392
|
leaseStatus?: LeaseStatusType;
|
2393
|
+
/** NFS only. The mode of the file or directory. */
|
2394
|
+
fileMode?: string;
|
2395
|
+
/** NFS only. The owner of the file or directory. */
|
2396
|
+
owner?: string;
|
2397
|
+
/** NFS only. The owning group of the file or directory. */
|
2398
|
+
group?: string;
|
2399
|
+
/** NFS only. The link count of the file or directory. */
|
2400
|
+
linkCount?: number;
|
1902
2401
|
/** Error Code */
|
1903
2402
|
errorCode?: string;
|
1904
2403
|
}
|
@@ -1961,6 +2460,24 @@ export declare interface FileDownloadOptions extends CommonOptions {
|
|
1961
2460
|
leaseAccessConditions?: LeaseAccessConditions;
|
1962
2461
|
}
|
1963
2462
|
|
2463
|
+
/** Contains response data for the download operation. */
|
2464
|
+
declare type FileDownloadResponse = FileDownloadHeaders_2 & {
|
2465
|
+
/**
|
2466
|
+
* BROWSER ONLY
|
2467
|
+
*
|
2468
|
+
* The response body as a browser Blob.
|
2469
|
+
* Always `undefined` in node.js.
|
2470
|
+
*/
|
2471
|
+
blobBody?: Promise<Blob>;
|
2472
|
+
/**
|
2473
|
+
* NODEJS ONLY
|
2474
|
+
*
|
2475
|
+
* The response body as a node.js Readable stream.
|
2476
|
+
* Always `undefined` in the browser.
|
2477
|
+
*/
|
2478
|
+
readableStreamBody?: NodeJS.ReadableStream;
|
2479
|
+
};
|
2480
|
+
|
1964
2481
|
/** Contains response data for the download operation. */
|
1965
2482
|
export declare type FileDownloadResponseModel = WithResponse<RawFileDownloadResponse, FileDownloadHeaders>;
|
1966
2483
|
|
@@ -2152,6 +2669,96 @@ export declare interface FileGetPropertiesHeaders {
|
|
2152
2669
|
leaseState?: LeaseStateType;
|
2153
2670
|
/** The current lease status of the file. */
|
2154
2671
|
leaseStatus?: LeaseStatusType;
|
2672
|
+
/** NFS only. The mode of the file or directory. */
|
2673
|
+
fileMode?: NfsFileMode;
|
2674
|
+
/** NFS only. The owner of the file or directory. */
|
2675
|
+
owner?: string;
|
2676
|
+
/** NFS only. The owning group of the file or directory. */
|
2677
|
+
group?: string;
|
2678
|
+
/** NFS only. The link count of the file or directory. */
|
2679
|
+
linkCount?: number;
|
2680
|
+
/** NFS only. Type of the file or directory. */
|
2681
|
+
nfsFileType?: NfsFileType;
|
2682
|
+
/** Error Code */
|
2683
|
+
errorCode?: string;
|
2684
|
+
}
|
2685
|
+
|
2686
|
+
/** Defines headers for File_getProperties operation. */
|
2687
|
+
declare interface FileGetPropertiesHeaders_2 {
|
2688
|
+
/** Returns the date and time the file was last modified. The date format follows RFC 1123. Any operation that modifies the file or its properties updates the last modified time. */
|
2689
|
+
lastModified?: Date;
|
2690
|
+
/** A set of name-value pairs associated with this file as user-defined metadata. */
|
2691
|
+
metadata?: {
|
2692
|
+
[propertyName: string]: string;
|
2693
|
+
};
|
2694
|
+
/** Returns the type File. Reserved for future use. */
|
2695
|
+
fileType?: string;
|
2696
|
+
/** The size of the file in bytes. This header returns the value of the 'x-ms-content-length' header that is stored with the file. */
|
2697
|
+
contentLength?: number;
|
2698
|
+
/** The content type specified for the file. The default content type is 'application/octet-stream' */
|
2699
|
+
contentType?: string;
|
2700
|
+
/** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
|
2701
|
+
etag?: string;
|
2702
|
+
/** If the Content-MD5 header has been set for the file, the Content-MD5 response header is returned so that the client can check for message content integrity. */
|
2703
|
+
contentMD5?: Uint8Array;
|
2704
|
+
/** If the Content-Encoding request header has previously been set for the file, the Content-Encoding value is returned in this header. */
|
2705
|
+
contentEncoding?: string;
|
2706
|
+
/** If the Cache-Control request header has previously been set for the file, the Cache-Control value is returned in this header. */
|
2707
|
+
cacheControl?: string;
|
2708
|
+
/** Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response. */
|
2709
|
+
contentDisposition?: string;
|
2710
|
+
/** Returns the value that was specified for the Content-Language request header. */
|
2711
|
+
contentLanguage?: string;
|
2712
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
2713
|
+
requestId?: string;
|
2714
|
+
/** Indicates the version of the File service used to execute the request. */
|
2715
|
+
version?: string;
|
2716
|
+
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
2717
|
+
date?: Date;
|
2718
|
+
/** Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt. */
|
2719
|
+
copyCompletedOn?: Date;
|
2720
|
+
/** Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure. */
|
2721
|
+
copyStatusDescription?: string;
|
2722
|
+
/** String identifier for the last attempted Copy File operation where this file was the destination file. */
|
2723
|
+
copyId?: string;
|
2724
|
+
/** Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied. */
|
2725
|
+
copyProgress?: string;
|
2726
|
+
/** URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file. */
|
2727
|
+
copySource?: string;
|
2728
|
+
/** State of the copy operation identified by 'x-ms-copy-id'. */
|
2729
|
+
copyStatus?: CopyStatusType;
|
2730
|
+
/** The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted). */
|
2731
|
+
isServerEncrypted?: boolean;
|
2732
|
+
/** Attributes set for the file. */
|
2733
|
+
fileAttributes?: string;
|
2734
|
+
/** Creation time for the file. */
|
2735
|
+
fileCreatedOn?: Date;
|
2736
|
+
/** Last write time for the file. */
|
2737
|
+
fileLastWriteOn?: Date;
|
2738
|
+
/** Change time for the file. */
|
2739
|
+
fileChangeOn?: Date;
|
2740
|
+
/** Key of the permission set for the file. */
|
2741
|
+
filePermissionKey?: string;
|
2742
|
+
/** The fileId of the file. */
|
2743
|
+
fileId?: string;
|
2744
|
+
/** The parent fileId of the file. */
|
2745
|
+
fileParentId?: string;
|
2746
|
+
/** When a file is leased, specifies whether the lease is of infinite or fixed duration. */
|
2747
|
+
leaseDuration?: LeaseDurationType;
|
2748
|
+
/** Lease state of the file. */
|
2749
|
+
leaseState?: LeaseStateType;
|
2750
|
+
/** The current lease status of the file. */
|
2751
|
+
leaseStatus?: LeaseStatusType;
|
2752
|
+
/** NFS only. The mode of the file or directory. */
|
2753
|
+
fileMode?: string;
|
2754
|
+
/** NFS only. The owner of the file or directory. */
|
2755
|
+
owner?: string;
|
2756
|
+
/** NFS only. The owning group of the file or directory. */
|
2757
|
+
group?: string;
|
2758
|
+
/** NFS only. The link count of the file or directory. */
|
2759
|
+
linkCount?: number;
|
2760
|
+
/** NFS only. Type of the file or directory. */
|
2761
|
+
nfsFileType?: NfsFileType;
|
2155
2762
|
/** Error Code */
|
2156
2763
|
errorCode?: string;
|
2157
2764
|
}
|
@@ -2189,7 +2796,7 @@ export declare interface FileGetPropertiesOptions extends CommonOptions {
|
|
2189
2796
|
export declare type FileGetPropertiesResponse = WithResponse<FileGetPropertiesHeaders, FileGetPropertiesHeaders>;
|
2190
2797
|
|
2191
2798
|
/** Contains response data for the getProperties operation. */
|
2192
|
-
declare type FileGetPropertiesResponse_2 =
|
2799
|
+
declare type FileGetPropertiesResponse_2 = FileGetPropertiesHeaders_2;
|
2193
2800
|
|
2194
2801
|
/** Contains response data for the getRangeList operation. */
|
2195
2802
|
export declare type FileGetRangeListDiffResponse = WithResponse<FileGetRangeListHeaders & ShareFileRangeList, FileGetRangeListHeaders, ShareFileRangeList>;
|
@@ -2276,6 +2883,39 @@ export declare type FileGetRangeListResponse = WithResponse<FileGetRangeListHead
|
|
2276
2883
|
/** Contains response data for the getRangeList operation. */
|
2277
2884
|
declare type FileGetRangeListResponse_2 = FileGetRangeListHeaders & ShareFileRangeList;
|
2278
2885
|
|
2886
|
+
/** Defines headers for File_getSymbolicLink operation. */
|
2887
|
+
declare interface FileGetSymbolicLinkHeaders {
|
2888
|
+
/** The ETag contains a value which represents the version of the file, in quotes. */
|
2889
|
+
etag?: string;
|
2890
|
+
/** Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */
|
2891
|
+
lastModified?: Date;
|
2892
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
2893
|
+
requestId?: string;
|
2894
|
+
/** Indicates the version of the File service used to execute the request. */
|
2895
|
+
version?: string;
|
2896
|
+
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
2897
|
+
date?: Date;
|
2898
|
+
/** The path to the original file, the symbolic link is pointing to. The path is of type string which is not resolved and is stored as is. The path can be absolute path or the relative path depending on the content stored in the symbolic link file. */
|
2899
|
+
linkText?: string;
|
2900
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
2901
|
+
clientRequestId?: string;
|
2902
|
+
}
|
2903
|
+
|
2904
|
+
/** Optional parameters. */
|
2905
|
+
declare interface FileGetSymbolicLinkOptionalParams extends coreClient.OperationOptions {
|
2906
|
+
/** 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> */
|
2907
|
+
timeoutInSeconds?: number;
|
2908
|
+
/** Valid value is backup */
|
2909
|
+
fileRequestIntent?: ShareTokenIntent;
|
2910
|
+
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
|
2911
|
+
shareSnapshot?: string;
|
2912
|
+
/** 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. */
|
2913
|
+
requestId?: string;
|
2914
|
+
}
|
2915
|
+
|
2916
|
+
/** Contains response data for the getSymbolicLink operation. */
|
2917
|
+
declare type FileGetSymbolicLinkResponse = FileGetSymbolicLinkHeaders;
|
2918
|
+
|
2279
2919
|
export declare interface FileHttpHeaders {
|
2280
2920
|
/**
|
2281
2921
|
* Optional. Sets the file's cache
|
@@ -2472,6 +3112,23 @@ export declare type FilePermissionInheritType = "inherit";
|
|
2472
3112
|
*/
|
2473
3113
|
export declare type FilePermissionPreserveType = "preserve";
|
2474
3114
|
|
3115
|
+
/**
|
3116
|
+
*
|
3117
|
+
NFS properties.
|
3118
|
+
Note that these properties only apply to files or directories in
|
3119
|
+
premium NFS file accounts.
|
3120
|
+
*/
|
3121
|
+
export declare interface FilePosixProperties {
|
3122
|
+
/** Optional, NFS only. The owner of the file or directory. */
|
3123
|
+
owner?: string;
|
3124
|
+
/** Optional, NFS only. The owning group of the file or directory. */
|
3125
|
+
group?: string;
|
3126
|
+
/** Optional, NFS only. The file mode of the file or directory */
|
3127
|
+
fileMode?: NfsFileMode;
|
3128
|
+
/** Optional, NFS only. Type of the file or directory. */
|
3129
|
+
fileType?: NfsFileType;
|
3130
|
+
}
|
3131
|
+
|
2475
3132
|
export declare interface FileProperties extends FileAndDirectorySetPropertiesCommonOptions, CommonOptions {
|
2476
3133
|
/**
|
2477
3134
|
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
@@ -2626,7 +3283,7 @@ export declare interface FileRenameOptions extends CommonOptions {
|
|
2626
3283
|
metadata?: Metadata;
|
2627
3284
|
/**
|
2628
3285
|
* Optional.
|
2629
|
-
* The timeout parameter is expressed in seconds. For more information, see <a href="https://
|
3286
|
+
* The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a>
|
2630
3287
|
*/
|
2631
3288
|
timeoutInSeconds?: number;
|
2632
3289
|
/**
|
@@ -2781,7 +3438,7 @@ export declare interface FileSASSignatureValues {
|
|
2781
3438
|
/**
|
2782
3439
|
* Optional. The name of the access policy on the share this SAS references if any.
|
2783
3440
|
*
|
2784
|
-
* @see https://
|
3441
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
|
2785
3442
|
*/
|
2786
3443
|
identifier?: string;
|
2787
3444
|
/**
|
@@ -2846,6 +3503,54 @@ export declare interface FileSetHTTPHeadersHeaders {
|
|
2846
3503
|
fileId?: string;
|
2847
3504
|
/** The parent fileId of the directory. */
|
2848
3505
|
fileParentId?: string;
|
3506
|
+
/** NFS only. The mode of the file or directory. */
|
3507
|
+
fileMode?: NfsFileMode;
|
3508
|
+
/** NFS only. The owner of the file or directory. */
|
3509
|
+
owner?: string;
|
3510
|
+
/** NFS only. The owning group of the file or directory. */
|
3511
|
+
group?: string;
|
3512
|
+
/** NFS only. The link count of the file or directory. */
|
3513
|
+
linkCount?: number;
|
3514
|
+
/** Error Code */
|
3515
|
+
errorCode?: string;
|
3516
|
+
}
|
3517
|
+
|
3518
|
+
/** Defines headers for File_setHttpHeaders operation. */
|
3519
|
+
declare interface FileSetHttpHeadersHeaders {
|
3520
|
+
/** The ETag contains a value which represents the version of the file, in quotes. */
|
3521
|
+
etag?: string;
|
3522
|
+
/** Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */
|
3523
|
+
lastModified?: Date;
|
3524
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
3525
|
+
requestId?: string;
|
3526
|
+
/** Indicates the version of the File service used to execute the request. */
|
3527
|
+
version?: string;
|
3528
|
+
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
3529
|
+
date?: Date;
|
3530
|
+
/** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */
|
3531
|
+
isServerEncrypted?: boolean;
|
3532
|
+
/** Key of the permission set for the file. */
|
3533
|
+
filePermissionKey?: string;
|
3534
|
+
/** Attributes set for the file. */
|
3535
|
+
fileAttributes?: string;
|
3536
|
+
/** Creation time for the file. */
|
3537
|
+
fileCreatedOn?: Date;
|
3538
|
+
/** Last write time for the file. */
|
3539
|
+
fileLastWriteOn?: Date;
|
3540
|
+
/** Change time for the file. */
|
3541
|
+
fileChangeOn?: Date;
|
3542
|
+
/** The fileId of the directory. */
|
3543
|
+
fileId?: string;
|
3544
|
+
/** The parent fileId of the directory. */
|
3545
|
+
fileParentId?: string;
|
3546
|
+
/** NFS only. The mode of the file or directory. */
|
3547
|
+
fileMode?: string;
|
3548
|
+
/** NFS only. The owner of the file or directory. */
|
3549
|
+
owner?: string;
|
3550
|
+
/** NFS only. The owning group of the file or directory. */
|
3551
|
+
group?: string;
|
3552
|
+
/** NFS only. The link count of the file or directory. */
|
3553
|
+
linkCount?: number;
|
2849
3554
|
/** Error Code */
|
2850
3555
|
errorCode?: string;
|
2851
3556
|
}
|
@@ -2868,12 +3573,20 @@ declare interface FileSetHttpHeadersOptionalParams extends coreClient.OperationO
|
|
2868
3573
|
filePermission?: string;
|
2869
3574
|
/** 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. */
|
2870
3575
|
filePermissionKey?: string;
|
3576
|
+
/** If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default. */
|
3577
|
+
fileAttributes?: string;
|
2871
3578
|
/** Creation time for the file/directory. Default value: Now. */
|
2872
3579
|
fileCreatedOn?: string;
|
2873
3580
|
/** Last write time for the file/directory. Default value: Now. */
|
2874
3581
|
fileLastWriteOn?: string;
|
2875
3582
|
/** Change time for the file/directory. Default value: Now. */
|
2876
3583
|
fileChangeOn?: string;
|
3584
|
+
/** Optional, NFS only. The owner of the file or directory. */
|
3585
|
+
owner?: string;
|
3586
|
+
/** Optional, NFS only. The owning group of the file or directory. */
|
3587
|
+
group?: string;
|
3588
|
+
/** Optional, NFS only. The file mode of the file or directory */
|
3589
|
+
fileMode?: string;
|
2877
3590
|
/** Resizes a file to the specified size. If the specified byte value is less than the current size of the file, then all ranges above the specified byte value are cleared. */
|
2878
3591
|
fileContentLength?: number;
|
2879
3592
|
}
|
@@ -2897,7 +3610,7 @@ export declare interface FileSetHttpHeadersOptions extends FileAndDirectorySetPr
|
|
2897
3610
|
export declare type FileSetHTTPHeadersResponse = WithResponse<FileSetHTTPHeadersHeaders, FileSetHTTPHeadersHeaders>;
|
2898
3611
|
|
2899
3612
|
/** Contains response data for the setHttpHeaders operation. */
|
2900
|
-
declare type FileSetHttpHeadersResponse =
|
3613
|
+
declare type FileSetHttpHeadersResponse = FileSetHttpHeadersHeaders;
|
2901
3614
|
|
2902
3615
|
/** Defines headers for File_setMetadata operation. */
|
2903
3616
|
export declare interface FileSetMetadataHeaders {
|
@@ -2994,8 +3707,18 @@ declare interface FileStartCopyOptionalParams extends coreClient.OperationOption
|
|
2994
3707
|
filePermission?: string;
|
2995
3708
|
/** 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. */
|
2996
3709
|
filePermissionKey?: string;
|
3710
|
+
/** Optional, NFS only. The owner of the file or directory. */
|
3711
|
+
owner?: string;
|
3712
|
+
/** Optional, NFS only. The owning group of the file or directory. */
|
3713
|
+
group?: string;
|
3714
|
+
/** Optional, NFS only. The file mode of the file or directory */
|
3715
|
+
fileMode?: string;
|
2997
3716
|
/** If true, the trailing dot will not be trimmed from the source URI. */
|
2998
3717
|
allowSourceTrailingDot?: boolean;
|
3718
|
+
/** NFS only. Applicable only when the copy source is a File. Determines the copy behavior of the mode bits of the file. source: The mode on the destination file is copied from the source file. override: The mode on the destination file is determined via the x-ms-mode header. */
|
3719
|
+
fileModeCopyMode?: ModeCopyMode;
|
3720
|
+
/** NFS only. Determines the copy behavior of the owner user identifier (UID) and group identifier (GID) of the file. source: The owner user identifier (UID) and group identifier (GID) on the destination file is copied from the source file. override: The owner user identifier (UID) and group identifier (GID) on the destination file is determined via the x-ms-owner and x-ms-group headers. */
|
3721
|
+
fileOwnerCopyMode?: OwnerCopyMode;
|
2999
3722
|
}
|
3000
3723
|
|
3001
3724
|
/**
|
@@ -3038,6 +3761,24 @@ export declare interface FileStartCopyOptions extends CommonOptions {
|
|
3038
3761
|
* SMB info.
|
3039
3762
|
*/
|
3040
3763
|
copyFileSmbInfo?: CopyFileSmbInfo;
|
3764
|
+
/**
|
3765
|
+
* Optional properties to set on NFS files.
|
3766
|
+
Note that this property is only applicable to files created in NFS shares.
|
3767
|
+
*/
|
3768
|
+
posixProperties?: FilePosixProperties;
|
3769
|
+
/**
|
3770
|
+
* Optional, only applicable to NFS Files.
|
3771
|
+
* Applicable only when the copy source is a File. Determines the copy behavior of the mode bits of the file.
|
3772
|
+
* source: The mode on the destination file is copied from the source file.
|
3773
|
+
* override: The mode on the destination file is determined via the x-ms-mode header.
|
3774
|
+
*/
|
3775
|
+
fileModeCopyMode?: ModeCopyMode;
|
3776
|
+
/**
|
3777
|
+
* Optional, only applicable to NFS Files. Determines the copy behavior of the owner user identifier (UID) and group identifier (GID) of the file.
|
3778
|
+
* source: The owner user identifier (UID) and group identifier (GID) on the destination file is copied from the source file.
|
3779
|
+
* override: The owner user identifier (UID) and group identifier (GID) on the destination file is determined via the x-ms-owner and x-ms-group headers.
|
3780
|
+
*/
|
3781
|
+
fileOwnerCopyMode?: OwnerCopyMode;
|
3041
3782
|
}
|
3042
3783
|
|
3043
3784
|
/** Contains response data for the startCopy operation. */
|
@@ -3048,7 +3789,7 @@ declare type FileStartCopyResponse_2 = FileStartCopyHeaders;
|
|
3048
3789
|
|
3049
3790
|
/**
|
3050
3791
|
* This is a helper class to construct a string representing the NTFS attributes to a file or directory.
|
3051
|
-
* @see https://
|
3792
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes
|
3052
3793
|
*/
|
3053
3794
|
export declare class FileSystemAttributes {
|
3054
3795
|
/**
|
@@ -3166,7 +3907,7 @@ export declare interface FileUploadRangeFromURLOptions extends CommonOptions {
|
|
3166
3907
|
abortSignal?: AbortSignalLike;
|
3167
3908
|
/**
|
3168
3909
|
* The timeout parameter is expressed in seconds. For more information, see <a
|
3169
|
-
* href="https://
|
3910
|
+
* href="https://learn.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting
|
3170
3911
|
* Timeouts for File Service Operations.</a>
|
3171
3912
|
*/
|
3172
3913
|
timeoutInSeconds?: number;
|
@@ -3315,7 +4056,7 @@ export declare interface FileUploadStreamOptions extends CommonOptions {
|
|
3315
4056
|
* Generates a {@link SASQueryParameters} object which contains all SAS query parameters needed to make an actual
|
3316
4057
|
* REST request.
|
3317
4058
|
*
|
3318
|
-
* @see https://
|
4059
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
|
3319
4060
|
*
|
3320
4061
|
* @param sharedKeyCredential -
|
3321
4062
|
*/
|
@@ -3607,6 +4348,9 @@ export declare interface Metrics {
|
|
3607
4348
|
retentionPolicy?: RetentionPolicy;
|
3608
4349
|
}
|
3609
4350
|
|
4351
|
+
/** Defines values for ModeCopyMode. */
|
4352
|
+
export declare type ModeCopyMode = "source" | "override";
|
4353
|
+
|
3610
4354
|
/**
|
3611
4355
|
* Creates a new Pipeline object with Credential provided.
|
3612
4356
|
*
|
@@ -3616,6 +4360,61 @@ export declare interface Metrics {
|
|
3616
4360
|
*/
|
3617
4361
|
export declare function newPipeline(credential?: Credential_2 | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline;
|
3618
4362
|
|
4363
|
+
/**
|
4364
|
+
* The mode permissions of the file or directory.
|
4365
|
+
*/
|
4366
|
+
export declare interface NfsFileMode {
|
4367
|
+
/**
|
4368
|
+
* Permissions the owner has over the file or directory.
|
4369
|
+
*/
|
4370
|
+
owner: PosixRolePermissions;
|
4371
|
+
/**
|
4372
|
+
* Permissions the group has over the file or directory.
|
4373
|
+
*/
|
4374
|
+
group: PosixRolePermissions;
|
4375
|
+
/**
|
4376
|
+
* Permissions other have over the file or directory.
|
4377
|
+
*/
|
4378
|
+
other: PosixRolePermissions;
|
4379
|
+
/**
|
4380
|
+
* Set effective user ID (setuid) on the file or directory.
|
4381
|
+
*/
|
4382
|
+
effectiveUserIdentity: boolean;
|
4383
|
+
/**
|
4384
|
+
* Set effective group ID (setgid) on the file or directory.
|
4385
|
+
*/
|
4386
|
+
effectiveGroupIdentity: boolean;
|
4387
|
+
/**
|
4388
|
+
* The sticky bit may be set on directories. The files in that
|
4389
|
+
* directory may only be renamed or deleted by the file's owner, the directory's owner, or the root user.
|
4390
|
+
*/
|
4391
|
+
stickyBit: boolean;
|
4392
|
+
}
|
4393
|
+
|
4394
|
+
/**
|
4395
|
+
* Defines values for NfsFileType. \
|
4396
|
+
* {@link KnownNfsFileType} can be used interchangeably with NfsFileType,
|
4397
|
+
* this enum contains the known values that the service supports.
|
4398
|
+
* ### Known values supported by the service
|
4399
|
+
* **Regular** \
|
4400
|
+
* **Directory** \
|
4401
|
+
* **SymLink**
|
4402
|
+
*/
|
4403
|
+
export declare type NfsFileType = string;
|
4404
|
+
|
4405
|
+
/** Defines values for OwnerCopyMode. */
|
4406
|
+
export declare type OwnerCopyMode = "source" | "override";
|
4407
|
+
|
4408
|
+
/**
|
4409
|
+
* Parse 4-digit octal string representation of a File Mode to a {@link NfsFileMode} structure.
|
4410
|
+
*/
|
4411
|
+
export declare function parseOctalFileMode(input?: string): NfsFileMode | undefined;
|
4412
|
+
|
4413
|
+
/**
|
4414
|
+
* Parse a 9-character symbolic string representation of a File Mode to a {@link NfsFileMode} structure.
|
4415
|
+
*/
|
4416
|
+
export declare function parseSymbolicFileMode(input?: string): NfsFileMode | undefined;
|
4417
|
+
|
3619
4418
|
/** Defines values for PermissionCopyModeType. */
|
3620
4419
|
export declare type PermissionCopyModeType = "source" | "override";
|
3621
4420
|
|
@@ -3692,9 +4491,27 @@ export declare interface PipelineOptions {
|
|
3692
4491
|
shareTokenIntent?: ShareTokenIntent;
|
3693
4492
|
}
|
3694
4493
|
|
4494
|
+
/**
|
4495
|
+
* Represents file permissions for a specific role.
|
4496
|
+
*/
|
4497
|
+
export declare interface PosixRolePermissions {
|
4498
|
+
/**
|
4499
|
+
* The execute permission.
|
4500
|
+
*/
|
4501
|
+
execute: boolean;
|
4502
|
+
/**
|
4503
|
+
* The write permission.
|
4504
|
+
*/
|
4505
|
+
write: boolean;
|
4506
|
+
/**
|
4507
|
+
* The read permission.
|
4508
|
+
*/
|
4509
|
+
read: boolean;
|
4510
|
+
}
|
4511
|
+
|
3695
4512
|
/**
|
3696
4513
|
* Range for Service Operations.
|
3697
|
-
* @see https://
|
4514
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations
|
3698
4515
|
*/
|
3699
4516
|
declare interface Range_2 {
|
3700
4517
|
/**
|
@@ -3877,7 +4694,7 @@ export declare class SASQueryParameters {
|
|
3877
4694
|
/**
|
3878
4695
|
* Optional. The signed identifier (only for {@link FileSASSignatureValues}).
|
3879
4696
|
*
|
3880
|
-
* @see https://
|
4697
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
|
3881
4698
|
*/
|
3882
4699
|
readonly identifier?: string;
|
3883
4700
|
/**
|
@@ -4435,7 +5252,7 @@ export declare class ShareClient extends StorageClient {
|
|
4435
5252
|
/**
|
4436
5253
|
* Creates a new share under the specified account. If the share with
|
4437
5254
|
* the same name already exists, the operation fails.
|
4438
|
-
* @see https://
|
5255
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-share
|
4439
5256
|
*
|
4440
5257
|
* @param options - Options to Share Create operation.
|
4441
5258
|
* @returns Response data for the Share Create operation.
|
@@ -4444,7 +5261,7 @@ export declare class ShareClient extends StorageClient {
|
|
4444
5261
|
/**
|
4445
5262
|
* Creates a new share under the specified account. If the share with
|
4446
5263
|
* the same name already exists, it is not changed.
|
4447
|
-
* @see https://
|
5264
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-share
|
4448
5265
|
*
|
4449
5266
|
* @param options -
|
4450
5267
|
*/
|
@@ -4465,7 +5282,7 @@ export declare class ShareClient extends StorageClient {
|
|
4465
5282
|
get rootDirectoryClient(): ShareDirectoryClient;
|
4466
5283
|
/**
|
4467
5284
|
* Creates a new subdirectory under this share.
|
4468
|
-
* @see https://
|
5285
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
|
4469
5286
|
*
|
4470
5287
|
* @param directoryName -
|
4471
5288
|
* @param options - Options to Directory Create operation.
|
@@ -4478,7 +5295,7 @@ export declare class ShareClient extends StorageClient {
|
|
4478
5295
|
/**
|
4479
5296
|
* Removes the specified empty sub directory under this share.
|
4480
5297
|
* Note that the directory must be empty before it can be deleted.
|
4481
|
-
* @see https://
|
5298
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
|
4482
5299
|
*
|
4483
5300
|
* @param directoryName -
|
4484
5301
|
* @param options - Options to Directory Delete operation.
|
@@ -4488,7 +5305,7 @@ export declare class ShareClient extends StorageClient {
|
|
4488
5305
|
/**
|
4489
5306
|
* Creates a new file or replaces a file under the root directory of this share.
|
4490
5307
|
* Note it only initializes the file with no content.
|
4491
|
-
* @see https://
|
5308
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-file
|
4492
5309
|
*
|
4493
5310
|
* @param fileName -
|
4494
5311
|
* @param size - Specifies the maximum size in bytes for the file, up to 4 TB.
|
@@ -4512,7 +5329,7 @@ export declare class ShareClient extends StorageClient {
|
|
4512
5329
|
* a share. An attempt to perform this operation on a share snapshot will fail with 400
|
4513
5330
|
* (`InvalidQueryParameterValue`)
|
4514
5331
|
*
|
4515
|
-
* @see https://
|
5332
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2
|
4516
5333
|
*
|
4517
5334
|
* @param directoryName -
|
4518
5335
|
* @param fileName -
|
@@ -4533,7 +5350,7 @@ export declare class ShareClient extends StorageClient {
|
|
4533
5350
|
/**
|
4534
5351
|
* Returns all user-defined metadata and system properties for the specified
|
4535
5352
|
* share.
|
4536
|
-
* @see https://
|
5353
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-share-properties
|
4537
5354
|
*
|
4538
5355
|
* WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
|
4539
5356
|
* they originally contained uppercase characters. This differs from the metadata keys returned by
|
@@ -4546,7 +5363,7 @@ export declare class ShareClient extends StorageClient {
|
|
4546
5363
|
/**
|
4547
5364
|
* Marks the specified share for deletion. The share and any directories or files
|
4548
5365
|
* contained within it are later deleted during garbage collection.
|
4549
|
-
* @see https://
|
5366
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-share
|
4550
5367
|
*
|
4551
5368
|
* @param options - Options to Share Delete operation.
|
4552
5369
|
* @returns Response data for the Share Delete operation.
|
@@ -4555,7 +5372,7 @@ export declare class ShareClient extends StorageClient {
|
|
4555
5372
|
/**
|
4556
5373
|
* Marks the specified share for deletion if it exists. The share and any directories or files
|
4557
5374
|
* contained within it are later deleted during garbage collection.
|
4558
|
-
* @see https://
|
5375
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-share
|
4559
5376
|
*
|
4560
5377
|
* @param options -
|
4561
5378
|
*/
|
@@ -4565,7 +5382,7 @@ export declare class ShareClient extends StorageClient {
|
|
4565
5382
|
*
|
4566
5383
|
* If no option provided, or no metadata defined in the option parameter, the share
|
4567
5384
|
* metadata will be removed.
|
4568
|
-
* @see https://
|
5385
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-share-metadata
|
4569
5386
|
*
|
4570
5387
|
* @param metadata - If no metadata provided, all existing directory metadata will be removed.
|
4571
5388
|
* @param option - Options to Share Set Metadata operation.
|
@@ -4579,7 +5396,7 @@ export declare class ShareClient extends StorageClient {
|
|
4579
5396
|
* WARNING: JavaScript Date will potential lost precision when parsing start and expiry string.
|
4580
5397
|
* For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
|
4581
5398
|
*
|
4582
|
-
* @see https://
|
5399
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-share-acl
|
4583
5400
|
*
|
4584
5401
|
* @param option - Options to Share Get Access Policy operation.
|
4585
5402
|
* @returns Response data for the Share Get Access Policy operation.
|
@@ -4596,7 +5413,7 @@ export declare class ShareClient extends StorageClient {
|
|
4596
5413
|
* When you establish a stored access policy on a share, it may take up to 30 seconds to take effect.
|
4597
5414
|
* During this interval, a shared access signature that is associated with the stored access policy will
|
4598
5415
|
* fail with status code 403 (Forbidden), until the access policy becomes active.
|
4599
|
-
* @see https://
|
5416
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-share-acl
|
4600
5417
|
*
|
4601
5418
|
* @param shareAcl - Array of signed identifiers, each having a unique Id and details of access policy.
|
4602
5419
|
* @param option - Options to Share Set Access Policy operation.
|
@@ -4637,7 +5454,7 @@ export declare class ShareClient extends StorageClient {
|
|
4637
5454
|
/**
|
4638
5455
|
* Creates a file permission (a security descriptor) at the share level.
|
4639
5456
|
* The created security descriptor can be used for the files/directories in the share.
|
4640
|
-
* @see https://
|
5457
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-permission
|
4641
5458
|
*
|
4642
5459
|
* @param options - Options to Share Create Permission operation.
|
4643
5460
|
* @param filePermission - File permission described in the SDDL
|
@@ -4646,7 +5463,7 @@ export declare class ShareClient extends StorageClient {
|
|
4646
5463
|
/**
|
4647
5464
|
* Gets the Security Descriptor Definition Language (SDDL) for a given file permission key
|
4648
5465
|
* which indicates a security descriptor.
|
4649
|
-
* @see https://
|
5466
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-permission
|
4650
5467
|
*
|
4651
5468
|
* @param options - Options to Share Create Permission operation.
|
4652
5469
|
* @param filePermissionKey - File permission key which indicates the security descriptor of the permission.
|
@@ -4665,7 +5482,7 @@ export declare class ShareClient extends StorageClient {
|
|
4665
5482
|
* Generates a Service Shared Access Signature (SAS) URI based on the client properties
|
4666
5483
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
4667
5484
|
*
|
4668
|
-
* @see https://
|
5485
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
4669
5486
|
*
|
4670
5487
|
* @param options - Optional parameters.
|
4671
5488
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
@@ -4677,7 +5494,7 @@ export declare class ShareClient extends StorageClient {
|
|
4677
5494
|
* Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
|
4678
5495
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
4679
5496
|
*
|
4680
|
-
* @see https://
|
5497
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
4681
5498
|
*
|
4682
5499
|
* @param options - Optional parameters.
|
4683
5500
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
@@ -5054,7 +5871,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
5054
5871
|
constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
|
5055
5872
|
/**
|
5056
5873
|
* Creates a new directory under the specified share or parent directory.
|
5057
|
-
* @see https://
|
5874
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
|
5058
5875
|
*
|
5059
5876
|
* @param options - Options to Directory Create operation.
|
5060
5877
|
* @returns Response data for the Directory operation.
|
@@ -5063,14 +5880,14 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
5063
5880
|
/**
|
5064
5881
|
* Creates a new directory under the specified share or parent directory if it does not already exists.
|
5065
5882
|
* If the directory already exists, it is not modified.
|
5066
|
-
* @see https://
|
5883
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
|
5067
5884
|
*
|
5068
5885
|
* @param options -
|
5069
5886
|
*/
|
5070
5887
|
createIfNotExists(options?: DirectoryCreateOptions): Promise<DirectoryCreateIfNotExistsResponse>;
|
5071
5888
|
/**
|
5072
5889
|
* Sets properties on the directory.
|
5073
|
-
* @see https://
|
5890
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-directory-properties
|
5074
5891
|
*
|
5075
5892
|
* @param DirectoryProperties - Directory properties. If no values are provided,
|
5076
5893
|
* existing values will be preserved.
|
@@ -5093,7 +5910,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
5093
5910
|
getDirectoryClient(subDirectoryName: string): ShareDirectoryClient;
|
5094
5911
|
/**
|
5095
5912
|
* Creates a new subdirectory under this directory.
|
5096
|
-
* @see https://
|
5913
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
|
5097
5914
|
*
|
5098
5915
|
* @param directoryName -
|
5099
5916
|
* @param options - Options to Directory Create operation.
|
@@ -5106,7 +5923,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
5106
5923
|
/**
|
5107
5924
|
* Removes the specified empty sub directory under this directory.
|
5108
5925
|
* Note that the directory must be empty before it can be deleted.
|
5109
|
-
* @see https://
|
5926
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
|
5110
5927
|
*
|
5111
5928
|
* @param directoryName -
|
5112
5929
|
* @param options - Options to Directory Delete operation.
|
@@ -5115,7 +5932,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
5115
5932
|
deleteSubdirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>;
|
5116
5933
|
/**
|
5117
5934
|
* Creates a new file or replaces a file under this directory. Note it only initializes the file with no content.
|
5118
|
-
* @see https://
|
5935
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-file
|
5119
5936
|
*
|
5120
5937
|
* @param fileName -
|
5121
5938
|
* @param size - Specifies the maximum size in bytes for the file, up to 4 TB.
|
@@ -5138,7 +5955,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
5138
5955
|
* Delete File is not supported on a share snapshot, which is a read-only copy of
|
5139
5956
|
* a share. An attempt to perform this operation on a share snapshot will fail with 400 (InvalidQueryParameterValue)
|
5140
5957
|
*
|
5141
|
-
* @see https://
|
5958
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2
|
5142
5959
|
*
|
5143
5960
|
* @param fileName - Name of the file to delete
|
5144
5961
|
* @param options - Options to File Delete operation.
|
@@ -5180,7 +5997,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
5180
5997
|
* Returns all system properties for the specified directory, and can also be used to check the
|
5181
5998
|
* existence of a directory. The data returned does not include the files in the directory or any
|
5182
5999
|
* subdirectories.
|
5183
|
-
* @see https://
|
6000
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-directory-properties
|
5184
6001
|
*
|
5185
6002
|
* @param options - Options to Directory Get Properties operation.
|
5186
6003
|
* @returns Response data for the Directory Get Properties operation.
|
@@ -5189,7 +6006,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
5189
6006
|
/**
|
5190
6007
|
* Removes the specified empty directory. Note that the directory must be empty before it can be
|
5191
6008
|
* deleted.
|
5192
|
-
* @see https://
|
6009
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
|
5193
6010
|
*
|
5194
6011
|
* @param options - Options to Directory Delete operation.
|
5195
6012
|
* @returns Response data for the Directory Delete operation.
|
@@ -5198,14 +6015,14 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
5198
6015
|
/**
|
5199
6016
|
* Removes the specified empty directory if it exists. Note that the directory must be empty before it can be
|
5200
6017
|
* deleted.
|
5201
|
-
* @see https://
|
6018
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
|
5202
6019
|
*
|
5203
6020
|
* @param options -
|
5204
6021
|
*/
|
5205
6022
|
deleteIfExists(options?: DirectoryDeleteOptions): Promise<DirectoryDeleteIfExistsResponse>;
|
5206
6023
|
/**
|
5207
6024
|
* Updates user defined metadata for the specified directory.
|
5208
|
-
* @see https://
|
6025
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-directory-metadata
|
5209
6026
|
*
|
5210
6027
|
* @param metadata - If no metadata provided, all existing directory metadata will be removed
|
5211
6028
|
* @param options - Options to Directory Set Metadata operation.
|
@@ -5329,7 +6146,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
5329
6146
|
/**
|
5330
6147
|
* Returns a list of files or directories under the specified share or directory. It lists the
|
5331
6148
|
* contents only for a single level of the directory hierarchy.
|
5332
|
-
* @see https://
|
6149
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-directories-and-files
|
5333
6150
|
*
|
5334
6151
|
* @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
|
5335
6152
|
* @param options - Options to Directory List Files and Directories Segment operation.
|
@@ -5432,7 +6249,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
5432
6249
|
listHandles(options?: DirectoryListHandlesOptions): PagedAsyncIterableIterator<HandleItem, DirectoryListHandlesResponse>;
|
5433
6250
|
/**
|
5434
6251
|
* Lists handles for a directory.
|
5435
|
-
* @see https://
|
6252
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-handles
|
5436
6253
|
*
|
5437
6254
|
* @param marker - Optional. A string value that identifies the portion of the list to be
|
5438
6255
|
* returned with the next list handles operation. The operation returns a
|
@@ -5444,7 +6261,7 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
5444
6261
|
private listHandlesSegment;
|
5445
6262
|
/**
|
5446
6263
|
* Force close all handles for a directory.
|
5447
|
-
* @see https://
|
6264
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
|
5448
6265
|
*
|
5449
6266
|
* @param marker - Optional. A string value that identifies the position of handles that will
|
5450
6267
|
* be closed with the next force close handles operation.
|
@@ -5456,14 +6273,14 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
5456
6273
|
private forceCloseHandlesSegment;
|
5457
6274
|
/**
|
5458
6275
|
* Force close all handles for a directory.
|
5459
|
-
* @see https://
|
6276
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
|
5460
6277
|
*
|
5461
6278
|
* @param options -
|
5462
6279
|
*/
|
5463
6280
|
forceCloseAllHandles(options?: DirectoryForceCloseHandlesSegmentOptions): Promise<CloseHandlesInfo>;
|
5464
6281
|
/**
|
5465
6282
|
* Force close a specific handle for a directory.
|
5466
|
-
* @see https://
|
6283
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
|
5467
6284
|
*
|
5468
6285
|
* @param aborter - Create a new Aborter instance with Aborter.none or Aborter.timeout(),
|
5469
6286
|
* goto documents of Aborter for more examples about request cancellation
|
@@ -5575,7 +6392,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5575
6392
|
withShareSnapshot(shareSnapshot: string): ShareFileClient;
|
5576
6393
|
/**
|
5577
6394
|
* Creates a new file or replaces a file. Note it only initializes the file with no content.
|
5578
|
-
* @see https://
|
6395
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-file
|
5579
6396
|
*
|
5580
6397
|
* @param size - Specifies the maximum size in bytes for the file, up to 4 TB.
|
5581
6398
|
* @param options - Options to File Create operation.
|
@@ -5602,7 +6419,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5602
6419
|
* * In Node.js, data returns in a Readable stream `readableStreamBody`
|
5603
6420
|
* * In browsers, data returns in a promise `contentAsBlob`
|
5604
6421
|
*
|
5605
|
-
* @see https://
|
6422
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-file
|
5606
6423
|
*
|
5607
6424
|
* @param offset - From which position of the file to download, greater than or equal to 0
|
5608
6425
|
* @param count - How much data to be downloaded, greater than 0. Will download to the end when undefined
|
@@ -5671,7 +6488,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5671
6488
|
/**
|
5672
6489
|
* Returns all user-defined metadata, standard HTTP properties, and system properties
|
5673
6490
|
* for the file. It does not return the content of the file.
|
5674
|
-
* @see https://
|
6491
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-file-properties
|
5675
6492
|
*
|
5676
6493
|
* @param options - Options to File Get Properties operation.
|
5677
6494
|
* @returns Response data for the File Get Properties operation.
|
@@ -5679,7 +6496,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5679
6496
|
getProperties(options?: FileGetPropertiesOptions): Promise<FileGetPropertiesResponse>;
|
5680
6497
|
/**
|
5681
6498
|
* Sets properties on the file.
|
5682
|
-
* @see https://
|
6499
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-file-properties
|
5683
6500
|
*
|
5684
6501
|
* @param properties - File properties. For file HTTP headers(e.g. Content-Type),
|
5685
6502
|
* if no values are provided, existing HTTP headers will be removed.
|
@@ -5699,7 +6516,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5699
6516
|
* Delete File is not supported on a share snapshot, which is a read-only copy of
|
5700
6517
|
* a share. An attempt to perform this operation on a share snapshot will fail with 400 (InvalidQueryParameterValue)
|
5701
6518
|
*
|
5702
|
-
* @see https://
|
6519
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2
|
5703
6520
|
*
|
5704
6521
|
* @param options - Options to File Delete operation.
|
5705
6522
|
* @returns Response data for the File Delete operation.
|
@@ -5717,7 +6534,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5717
6534
|
* Delete File is not supported on a share snapshot, which is a read-only copy of
|
5718
6535
|
* a share. An attempt to perform this operation on a share snapshot will fail with 400 (InvalidQueryParameterValue)
|
5719
6536
|
*
|
5720
|
-
* @see https://
|
6537
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2
|
5721
6538
|
*
|
5722
6539
|
* @param options -
|
5723
6540
|
*/
|
@@ -5727,7 +6544,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5727
6544
|
*
|
5728
6545
|
* If no option provided, or no value provided for the file HTTP headers in the options,
|
5729
6546
|
* these file HTTP headers without a value will be cleared.
|
5730
|
-
* @see https://
|
6547
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-file-properties
|
5731
6548
|
*
|
5732
6549
|
* @param FileHttpHeaders - File HTTP headers like Content-Type.
|
5733
6550
|
* Provide undefined will remove existing HTTP headers.
|
@@ -5738,7 +6555,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5738
6555
|
/**
|
5739
6556
|
* Resize file.
|
5740
6557
|
*
|
5741
|
-
* @see https://
|
6558
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-file-properties
|
5742
6559
|
*
|
5743
6560
|
* @param length - Resizes a file to the specified size in bytes.
|
5744
6561
|
* If the specified byte value is less than the current size of the file,
|
@@ -5752,7 +6569,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5752
6569
|
*
|
5753
6570
|
* If no metadata defined in the option parameter, the file
|
5754
6571
|
* metadata will be removed.
|
5755
|
-
* @see https://
|
6572
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-file-metadata
|
5756
6573
|
*
|
5757
6574
|
* @param metadata - If no metadata provided, all existing directory metadata will be removed
|
5758
6575
|
* @param options - Options to File Set Metadata operation.
|
@@ -5836,7 +6653,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5836
6653
|
/**
|
5837
6654
|
* Aborts a pending Copy File operation, and leaves a destination file with zero length and full
|
5838
6655
|
* metadata.
|
5839
|
-
* @see https://
|
6656
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/abort-copy-file
|
5840
6657
|
*
|
5841
6658
|
* @param copyId - Id of the Copy File operation to abort.
|
5842
6659
|
* @param options - Options to File Abort Copy From URL operation.
|
@@ -5964,7 +6781,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
5964
6781
|
downloadToFile(filePath: string, offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>;
|
5965
6782
|
/**
|
5966
6783
|
* Lists handles for a file.
|
5967
|
-
* @see https://
|
6784
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-handles
|
5968
6785
|
*
|
5969
6786
|
* @param marker - Optional. A string value that identifies the portion of the list to be
|
5970
6787
|
* returned with the next list handles operation. The operation returns a
|
@@ -6004,7 +6821,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
6004
6821
|
listHandles(options?: FileListHandlesOptions): PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse>;
|
6005
6822
|
/**
|
6006
6823
|
* Force close all handles for a file.
|
6007
|
-
* @see https://
|
6824
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
|
6008
6825
|
*
|
6009
6826
|
* @param marker - Optional. A string value that identifies the position of handles that will
|
6010
6827
|
* be closed with the next force close handles operation.
|
@@ -6016,20 +6833,27 @@ export declare class ShareFileClient extends StorageClient {
|
|
6016
6833
|
private forceCloseHandlesSegment;
|
6017
6834
|
/**
|
6018
6835
|
* Force close all handles for a file.
|
6019
|
-
* @see https://
|
6836
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
|
6020
6837
|
*
|
6021
6838
|
* @param options - Options to force close handles operation.
|
6022
6839
|
*/
|
6023
6840
|
forceCloseAllHandles(options?: FileForceCloseHandlesOptions): Promise<CloseHandlesInfo>;
|
6024
6841
|
/**
|
6025
6842
|
* Force close a specific handle for a file.
|
6026
|
-
* @see https://
|
6843
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
|
6027
6844
|
*
|
6028
6845
|
* @param handleId - Specific handle ID, cannot be asterisk "*".
|
6029
6846
|
* Use forceCloseAllHandles() to close all handles.
|
6030
6847
|
* @param FileForceCloseHandlesOptions - Options to force close handles operation.
|
6031
6848
|
*/
|
6032
6849
|
forceCloseHandle(handleId: string, options?: FileForceCloseHandlesOptions): Promise<FileForceCloseHandlesResponse>;
|
6850
|
+
/**
|
6851
|
+
* NFS only. Creates a hard link to the file file specified by path.
|
6852
|
+
* @param targetFile - Path of the file to create the hard link to, not including the share.
|
6853
|
+
* For example: "targetDirectory/targetSubDirectory/.../targetFile"
|
6854
|
+
* @param options - Options to create hard link operation.
|
6855
|
+
*/
|
6856
|
+
createHardLink(targetFile: string, options?: FileCreateHardLinkOptions): Promise<FileCreateHardLinkResponse>;
|
6033
6857
|
/**
|
6034
6858
|
* Get a {@link ShareLeaseClient} that manages leases on the file.
|
6035
6859
|
*
|
@@ -6043,7 +6867,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
6043
6867
|
* Generates a Service Shared Access Signature (SAS) URI based on the client properties
|
6044
6868
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
6045
6869
|
*
|
6046
|
-
* @see https://
|
6870
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
6047
6871
|
*
|
6048
6872
|
* @param options - Optional parameters.
|
6049
6873
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
@@ -6055,7 +6879,7 @@ export declare class ShareFileClient extends StorageClient {
|
|
6055
6879
|
* Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
|
6056
6880
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
6057
6881
|
*
|
6058
|
-
* @see https://
|
6882
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
6059
6883
|
*
|
6060
6884
|
* @param options - Optional parameters.
|
6061
6885
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
@@ -6393,9 +7217,9 @@ export declare interface ShareItemInternal {
|
|
6393
7217
|
|
6394
7218
|
/**
|
6395
7219
|
* A client that manages leases for a {@link ShareFileClient} or {@link ShareClient}.
|
6396
|
-
* @see https://
|
7220
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/lease-file
|
6397
7221
|
* and
|
6398
|
-
* @see https://
|
7222
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/lease-share
|
6399
7223
|
*/
|
6400
7224
|
export declare class ShareLeaseClient {
|
6401
7225
|
private _leaseId;
|
@@ -6682,7 +7506,7 @@ export declare class ShareSASPermissions {
|
|
6682
7506
|
* order accepted by the service.
|
6683
7507
|
*
|
6684
7508
|
* The order of the characters should be as specified here to ensure correctness.
|
6685
|
-
* @see https://
|
7509
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
|
6686
7510
|
*
|
6687
7511
|
*/
|
6688
7512
|
toString(): string;
|
@@ -6771,7 +7595,7 @@ export declare class ShareServiceClient extends StorageClient {
|
|
6771
7595
|
/**
|
6772
7596
|
* Gets the properties of a storage account’s file service, including properties
|
6773
7597
|
* for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
|
6774
|
-
* @see https://
|
7598
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-file-service-properties
|
6775
7599
|
*
|
6776
7600
|
* @param options - Options to Get Properties operation.
|
6777
7601
|
* @returns Response data for the Get Properties operation.
|
@@ -6780,7 +7604,7 @@ export declare class ShareServiceClient extends StorageClient {
|
|
6780
7604
|
/**
|
6781
7605
|
* Sets properties for a storage account’s file service endpoint, including properties
|
6782
7606
|
* for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.
|
6783
|
-
* @see https://
|
7607
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-file-service-properties
|
6784
7608
|
*
|
6785
7609
|
* @param properties -
|
6786
7610
|
* @param options - Options to Set Properties operation.
|
@@ -6912,7 +7736,7 @@ export declare class ShareServiceClient extends StorageClient {
|
|
6912
7736
|
* Generates an account Shared Access Signature (SAS) URI based on the client properties
|
6913
7737
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
6914
7738
|
*
|
6915
|
-
* @see https://
|
7739
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
|
6916
7740
|
*
|
6917
7741
|
* @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.
|
6918
7742
|
* @param permissions - Specifies the list of permissions to be associated with the SAS.
|
@@ -6927,7 +7751,7 @@ export declare class ShareServiceClient extends StorageClient {
|
|
6927
7751
|
* Generates string to sign for an account Shared Access Signature (SAS) URI based on the client properties
|
6928
7752
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
6929
7753
|
*
|
6930
|
-
* @see https://
|
7754
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
|
6931
7755
|
*
|
6932
7756
|
* @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.
|
6933
7757
|
* @param permissions - Specifies the list of permissions to be associated with the SAS.
|
@@ -7224,7 +8048,7 @@ export declare interface SignedIdentifier {
|
|
7224
8048
|
expiresOn: Date;
|
7225
8049
|
/**
|
7226
8050
|
* the permissions for the acl policy
|
7227
|
-
* @see https://
|
8051
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-share-acl
|
7228
8052
|
*/
|
7229
8053
|
permissions: string;
|
7230
8054
|
};
|
@@ -7413,7 +8237,7 @@ export declare interface StorageRetryOptions {
|
|
7413
8237
|
* A value of zero or undefined means no default timeout on SDK client, Azure
|
7414
8238
|
* Storage server's default timeout policy will be used.
|
7415
8239
|
*
|
7416
|
-
* @see https://
|
8240
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations
|
7417
8241
|
*/
|
7418
8242
|
readonly tryTimeoutInMs?: number;
|
7419
8243
|
/**
|
@@ -7572,7 +8396,7 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
7572
8396
|
protected signRequest(request: WebResource): WebResource;
|
7573
8397
|
/**
|
7574
8398
|
* Retrieve header value according to shared key sign rules.
|
7575
|
-
* @see https://
|
8399
|
+
* @see https://learn.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
|
7576
8400
|
*
|
7577
8401
|
* @param request -
|
7578
8402
|
* @param headerName -
|
@@ -7615,6 +8439,16 @@ export declare type TimeNowType = "now";
|
|
7615
8439
|
*/
|
7616
8440
|
export declare type TimePreserveType = "preserve";
|
7617
8441
|
|
8442
|
+
/**
|
8443
|
+
* Convert {@link NfsFileMode} structure to a 4-digit octal string represenation.
|
8444
|
+
*/
|
8445
|
+
export declare function toOctalFileMode(input?: NfsFileMode): string | undefined;
|
8446
|
+
|
8447
|
+
/**
|
8448
|
+
* Convert a {@link NfsFileMode} to a string in symbolic notation.
|
8449
|
+
*/
|
8450
|
+
export declare function toSymbolicFileMode(input?: NfsFileMode): string | undefined;
|
8451
|
+
|
7618
8452
|
export { WebResource }
|
7619
8453
|
|
7620
8454
|
/**
|