@azure/storage-file-share 12.24.1-alpha.20240807.2 → 12.25.0-beta.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. package/dist/index.js +298 -73
  2. package/dist/index.js.map +1 -1
  3. package/dist-esm/storage-blob/src/BlobServiceClient.js +27 -1
  4. package/dist-esm/storage-blob/src/BlobServiceClient.js.map +1 -1
  5. package/dist-esm/storage-blob/src/Clients.js +19 -1
  6. package/dist-esm/storage-blob/src/Clients.js.map +1 -1
  7. package/dist-esm/storage-blob/src/ContainerClient.js +19 -1
  8. package/dist-esm/storage-blob/src/ContainerClient.js.map +1 -1
  9. package/dist-esm/storage-blob/src/generated/src/models/parameters.js +1 -1
  10. package/dist-esm/storage-blob/src/generated/src/models/parameters.js.map +1 -1
  11. package/dist-esm/storage-blob/src/generated/src/storageClient.js +2 -2
  12. package/dist-esm/storage-blob/src/generated/src/storageClient.js.map +1 -1
  13. package/dist-esm/storage-blob/src/index.js +2 -2
  14. package/dist-esm/storage-blob/src/index.js.map +1 -1
  15. package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js +8 -1
  16. package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js.map +1 -1
  17. package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js +27 -6
  18. package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js.map +1 -1
  19. package/dist-esm/storage-blob/src/utils/constants.js +2 -2
  20. package/dist-esm/storage-blob/src/utils/constants.js.map +1 -1
  21. package/dist-esm/storage-file-share/src/AccountSASSignatureValues.js +8 -1
  22. package/dist-esm/storage-file-share/src/AccountSASSignatureValues.js.map +1 -1
  23. package/dist-esm/storage-file-share/src/Clients.js +65 -20
  24. package/dist-esm/storage-file-share/src/Clients.js.map +1 -1
  25. package/dist-esm/storage-file-share/src/FileSASSignatureValues.js +8 -1
  26. package/dist-esm/storage-file-share/src/FileSASSignatureValues.js.map +1 -1
  27. package/dist-esm/storage-file-share/src/ShareServiceClient.js +31 -5
  28. package/dist-esm/storage-file-share/src/ShareServiceClient.js.map +1 -1
  29. package/dist-esm/storage-file-share/src/generated/src/models/index.js.map +1 -1
  30. package/dist-esm/storage-file-share/src/generated/src/models/mappers.js +50 -0
  31. package/dist-esm/storage-file-share/src/generated/src/models/mappers.js.map +1 -1
  32. package/dist-esm/storage-file-share/src/generated/src/models/parameters.js +52 -11
  33. package/dist-esm/storage-file-share/src/generated/src/models/parameters.js.map +1 -1
  34. package/dist-esm/storage-file-share/src/generated/src/operations/directory.js +12 -9
  35. package/dist-esm/storage-file-share/src/generated/src/operations/directory.js.map +1 -1
  36. package/dist-esm/storage-file-share/src/generated/src/operations/file.js +21 -18
  37. package/dist-esm/storage-file-share/src/generated/src/operations/file.js.map +1 -1
  38. package/dist-esm/storage-file-share/src/generated/src/operations/service.js +12 -3
  39. package/dist-esm/storage-file-share/src/generated/src/operations/service.js.map +1 -1
  40. package/dist-esm/storage-file-share/src/generated/src/operations/share.js +26 -4
  41. package/dist-esm/storage-file-share/src/generated/src/operations/share.js.map +1 -1
  42. package/dist-esm/storage-file-share/src/generated/src/storageClient.js +2 -2
  43. package/dist-esm/storage-file-share/src/generated/src/storageClient.js.map +1 -1
  44. package/dist-esm/storage-file-share/src/generatedModels.js.map +1 -1
  45. package/dist-esm/storage-file-share/src/index.js +2 -2
  46. package/dist-esm/storage-file-share/src/index.js.map +1 -1
  47. package/dist-esm/storage-file-share/src/models.js.map +1 -1
  48. package/dist-esm/storage-file-share/src/utils/constants.js +2 -2
  49. package/dist-esm/storage-file-share/src/utils/constants.js.map +1 -1
  50. package/dist-esm/storage-file-share/src/utils/utils.common.js +12 -0
  51. package/dist-esm/storage-file-share/src/utils/utils.common.js.map +1 -1
  52. package/package.json +3 -3
  53. package/types/latest/storage-file-share.d.ts +225 -41
@@ -590,12 +590,14 @@ export declare interface DirectoryCreateIfNotExistsResponse extends DirectoryCre
590
590
  declare interface DirectoryCreateOptionalParams extends coreClient.OperationOptions {
591
591
  /** 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> */
592
592
  timeoutInSeconds?: number;
593
+ /** Valid value is backup */
594
+ fileRequestIntent?: ShareTokenIntent;
593
595
  /** A name-value pair to associate with a file storage object. */
594
596
  metadata?: {
595
597
  [propertyName: string]: string;
596
598
  };
597
- /** Valid value is backup */
598
- fileRequestIntent?: ShareTokenIntent;
599
+ /** Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission */
600
+ filePermissionFormat?: FilePermissionFormat;
599
601
  /** If true, the trailing dot will not be trimmed from the target URI. */
600
602
  allowTrailingDot?: boolean;
601
603
  /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
@@ -713,12 +715,12 @@ export declare interface DirectoryForceCloseHandlesHeaders {
713
715
  declare interface DirectoryForceCloseHandlesOptionalParams extends coreClient.OperationOptions {
714
716
  /** 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> */
715
717
  timeoutInSeconds?: number;
718
+ /** Valid value is backup */
719
+ fileRequestIntent?: ShareTokenIntent;
716
720
  /** A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. */
717
721
  marker?: string;
718
722
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
719
723
  shareSnapshot?: string;
720
- /** Valid value is backup */
721
- fileRequestIntent?: ShareTokenIntent;
722
724
  /** If true, the trailing dot will not be trimmed from the target URI. */
723
725
  allowTrailingDot?: boolean;
724
726
  /** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
@@ -804,10 +806,10 @@ export declare interface DirectoryGetPropertiesHeaders {
804
806
  declare interface DirectoryGetPropertiesOptionalParams extends coreClient.OperationOptions {
805
807
  /** 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> */
806
808
  timeoutInSeconds?: number;
807
- /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
808
- shareSnapshot?: string;
809
809
  /** Valid value is backup */
810
810
  fileRequestIntent?: ShareTokenIntent;
811
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
812
+ shareSnapshot?: string;
811
813
  /** If true, the trailing dot will not be trimmed from the target URI. */
812
814
  allowTrailingDot?: boolean;
813
815
  }
@@ -892,6 +894,8 @@ export declare interface DirectoryListFilesAndDirectoriesSegmentHeaders {
892
894
  declare interface DirectoryListFilesAndDirectoriesSegmentOptionalParams extends coreClient.OperationOptions {
893
895
  /** 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> */
894
896
  timeoutInSeconds?: number;
897
+ /** Valid value is backup */
898
+ fileRequestIntent?: ShareTokenIntent;
895
899
  /** Filters the results to return only entries whose name begins with the specified prefix. */
896
900
  prefix?: string;
897
901
  /** A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. */
@@ -900,8 +904,6 @@ declare interface DirectoryListFilesAndDirectoriesSegmentOptionalParams extends
900
904
  maxResults?: number;
901
905
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
902
906
  shareSnapshot?: string;
903
- /** Valid value is backup */
904
- fileRequestIntent?: ShareTokenIntent;
905
907
  /** If true, the trailing dot will not be trimmed from the target URI. */
906
908
  allowTrailingDot?: boolean;
907
909
  /** Include this parameter to specify one or more datasets to include in the response. */
@@ -934,14 +936,14 @@ export declare interface DirectoryListHandlesHeaders {
934
936
  declare interface DirectoryListHandlesOptionalParams extends coreClient.OperationOptions {
935
937
  /** 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> */
936
938
  timeoutInSeconds?: number;
939
+ /** Valid value is backup */
940
+ fileRequestIntent?: ShareTokenIntent;
937
941
  /** A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. */
938
942
  marker?: string;
939
943
  /** Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items. */
940
944
  maxResults?: number;
941
945
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
942
946
  shareSnapshot?: string;
943
- /** Valid value is backup */
944
- fileRequestIntent?: ShareTokenIntent;
945
947
  /** If true, the trailing dot will not be trimmed from the target URI. */
946
948
  allowTrailingDot?: boolean;
947
949
  /** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
@@ -1045,12 +1047,14 @@ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOpti
1045
1047
  copyFileSmbInfo?: CopyFileSmbInfo;
1046
1048
  /** 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> */
1047
1049
  timeoutInSeconds?: number;
1050
+ /** Valid value is backup */
1051
+ fileRequestIntent?: ShareTokenIntent;
1048
1052
  /** A name-value pair to associate with a file storage object. */
1049
1053
  metadata?: {
1050
1054
  [propertyName: string]: string;
1051
1055
  };
1052
- /** Valid value is backup */
1053
- fileRequestIntent?: ShareTokenIntent;
1056
+ /** Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission */
1057
+ filePermissionFormat?: FilePermissionFormat;
1054
1058
  /** If true, the trailing dot will not be trimmed from the target URI. */
1055
1059
  allowTrailingDot?: boolean;
1056
1060
  /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
@@ -1102,6 +1106,12 @@ export declare interface DirectoryRenameOptions extends CommonOptions {
1102
1106
  * If specified the permission (security descriptor) shall be set for the directory/file.
1103
1107
  */
1104
1108
  filePermission?: string;
1109
+ /**
1110
+ * Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned.
1111
+ * Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format.
1112
+ * If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission
1113
+ */
1114
+ filePermissionFormat?: FilePermissionFormat;
1105
1115
  /**
1106
1116
  * Optional.
1107
1117
  * Key of the permission to be set for the directory/file. Note: Only one of the filePermission or filePermissionKey should be specified.
@@ -1145,12 +1155,12 @@ export declare interface DirectorySetMetadataHeaders {
1145
1155
  declare interface DirectorySetMetadataOptionalParams extends coreClient.OperationOptions {
1146
1156
  /** 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> */
1147
1157
  timeoutInSeconds?: number;
1158
+ /** Valid value is backup */
1159
+ fileRequestIntent?: ShareTokenIntent;
1148
1160
  /** A name-value pair to associate with a file storage object. */
1149
1161
  metadata?: {
1150
1162
  [propertyName: string]: string;
1151
1163
  };
1152
- /** Valid value is backup */
1153
- fileRequestIntent?: ShareTokenIntent;
1154
1164
  /** If true, the trailing dot will not be trimmed from the target URI. */
1155
1165
  allowTrailingDot?: boolean;
1156
1166
  }
@@ -1210,6 +1220,8 @@ declare interface DirectorySetPropertiesOptionalParams extends coreClient.Operat
1210
1220
  timeoutInSeconds?: number;
1211
1221
  /** Valid value is backup */
1212
1222
  fileRequestIntent?: ShareTokenIntent;
1223
+ /** Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission */
1224
+ filePermissionFormat?: FilePermissionFormat;
1213
1225
  /** If true, the trailing dot will not be trimmed from the target URI. */
1214
1226
  allowTrailingDot?: boolean;
1215
1227
  /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
@@ -1436,14 +1448,14 @@ declare interface FileAcquireLeaseHeaders {
1436
1448
  declare interface FileAcquireLeaseOptionalParams extends coreClient.OperationOptions {
1437
1449
  /** 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> */
1438
1450
  timeoutInSeconds?: number;
1451
+ /** Valid value is backup */
1452
+ fileRequestIntent?: ShareTokenIntent;
1439
1453
  /** Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. */
1440
1454
  duration?: number;
1441
1455
  /** Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. */
1442
1456
  proposedLeaseId?: string;
1443
1457
  /** 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. */
1444
1458
  requestId?: string;
1445
- /** Valid value is backup */
1446
- fileRequestIntent?: ShareTokenIntent;
1447
1459
  /** If true, the trailing dot will not be trimmed from the target URI. */
1448
1460
  allowTrailingDot?: boolean;
1449
1461
  }
@@ -1454,13 +1466,21 @@ declare type FileAcquireLeaseResponse = FileAcquireLeaseHeaders;
1454
1466
  export declare interface FileAndDirectoryCreateCommonOptions {
1455
1467
  /**
1456
1468
  * The permission(security descriptor) to be set for the file or directory in the
1457
- * Security Descriptor Definition Language (SDDL). If specified, it must have an owner, group, and discretionary access control list (DACL).
1469
+ * Security Descriptor Definition Language (SDDL) or binary.
1470
+ * If specified, it must have an owner, group, and discretionary access control list (DACL).
1458
1471
  * A value of inherit may be passed to inherit from the parent directory.
1459
1472
  *
1460
1473
  * Note that only one of filePermission or filePermissionKey can be specified.
1461
1474
  * And if both are not specified, inherit will be set to filePermission as default value by client library.
1462
1475
  */
1463
1476
  filePermission?: string | FilePermissionInheritType;
1477
+ /**
1478
+ * Optional. Available for version 2023-06-01 and later.
1479
+ * Specifies the format in which the permission is returned. Acceptable values are SDDL or binary.
1480
+ * If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format.
1481
+ * If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission
1482
+ */
1483
+ filePermissionFormat?: FilePermissionFormat;
1464
1484
  /**
1465
1485
  * The key of the permission to be set for the file or directory. This can be created using the Create-Permission API.
1466
1486
  *
@@ -1502,6 +1522,13 @@ export declare interface FileAndDirectorySetPropertiesCommonOptions {
1502
1522
  * And if both are not specified, preserve will be set to filePermission as default value by client library.
1503
1523
  */
1504
1524
  filePermission?: string | FilePermissionInheritType | FilePermissionPreserveType;
1525
+ /**
1526
+ * Optional. Available for version 2023-06-01 and later.
1527
+ * Specifies the format in which the permission is returned. Acceptable values are SDDL or binary.
1528
+ * If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format.
1529
+ * If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission
1530
+ */
1531
+ filePermissionFormat?: FilePermissionFormat;
1505
1532
  /**
1506
1533
  * The key of the permission to be set for the file or directory. This can be created using the Create-Permission API.
1507
1534
  *
@@ -1563,10 +1590,10 @@ declare interface FileBreakLeaseOptionalParams extends coreClient.OperationOptio
1563
1590
  leaseAccessConditions?: LeaseAccessConditions;
1564
1591
  /** 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> */
1565
1592
  timeoutInSeconds?: number;
1566
- /** 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. */
1567
- requestId?: string;
1568
1593
  /** Valid value is backup */
1569
1594
  fileRequestIntent?: ShareTokenIntent;
1595
+ /** 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. */
1596
+ requestId?: string;
1570
1597
  /** If true, the trailing dot will not be trimmed from the target URI. */
1571
1598
  allowTrailingDot?: boolean;
1572
1599
  }
@@ -1596,12 +1623,12 @@ declare interface FileChangeLeaseHeaders {
1596
1623
  declare interface FileChangeLeaseOptionalParams extends coreClient.OperationOptions {
1597
1624
  /** 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> */
1598
1625
  timeoutInSeconds?: number;
1626
+ /** Valid value is backup */
1627
+ fileRequestIntent?: ShareTokenIntent;
1599
1628
  /** Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. */
1600
1629
  proposedLeaseId?: string;
1601
1630
  /** 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. */
1602
1631
  requestId?: string;
1603
- /** Valid value is backup */
1604
- fileRequestIntent?: ShareTokenIntent;
1605
1632
  /** If true, the trailing dot will not be trimmed from the target URI. */
1606
1633
  allowTrailingDot?: boolean;
1607
1634
  }
@@ -1696,12 +1723,14 @@ declare interface FileCreateOptionalParams extends coreClient.OperationOptions {
1696
1723
  fileHttpHeaders?: FileHttpHeaders_2;
1697
1724
  /** 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> */
1698
1725
  timeoutInSeconds?: number;
1726
+ /** Valid value is backup */
1727
+ fileRequestIntent?: ShareTokenIntent;
1699
1728
  /** A name-value pair to associate with a file storage object. */
1700
1729
  metadata?: {
1701
1730
  [propertyName: string]: string;
1702
1731
  };
1703
- /** Valid value is backup */
1704
- fileRequestIntent?: ShareTokenIntent;
1732
+ /** Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission */
1733
+ filePermissionFormat?: FilePermissionFormat;
1705
1734
  /** If true, the trailing dot will not be trimmed from the target URI. */
1706
1735
  allowTrailingDot?: boolean;
1707
1736
  /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
@@ -2013,12 +2042,12 @@ export declare interface FileForceCloseHandlesHeaders {
2013
2042
  declare interface FileForceCloseHandlesOptionalParams extends coreClient.OperationOptions {
2014
2043
  /** 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> */
2015
2044
  timeoutInSeconds?: number;
2045
+ /** Valid value is backup */
2046
+ fileRequestIntent?: ShareTokenIntent;
2016
2047
  /** A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. */
2017
2048
  marker?: string;
2018
2049
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2019
2050
  shareSnapshot?: string;
2020
- /** Valid value is backup */
2021
- fileRequestIntent?: ShareTokenIntent;
2022
2051
  /** If true, the trailing dot will not be trimmed from the target URI. */
2023
2052
  allowTrailingDot?: boolean;
2024
2053
  }
@@ -2133,10 +2162,10 @@ declare interface FileGetPropertiesOptionalParams extends coreClient.OperationOp
2133
2162
  leaseAccessConditions?: LeaseAccessConditions;
2134
2163
  /** 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> */
2135
2164
  timeoutInSeconds?: number;
2136
- /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2137
- shareSnapshot?: string;
2138
2165
  /** Valid value is backup */
2139
2166
  fileRequestIntent?: ShareTokenIntent;
2167
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2168
+ shareSnapshot?: string;
2140
2169
  /** If true, the trailing dot will not be trimmed from the target URI. */
2141
2170
  allowTrailingDot?: boolean;
2142
2171
  }
@@ -2189,10 +2218,10 @@ declare interface FileGetRangeListOptionalParams extends coreClient.OperationOpt
2189
2218
  leaseAccessConditions?: LeaseAccessConditions;
2190
2219
  /** 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> */
2191
2220
  timeoutInSeconds?: number;
2192
- /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2193
- shareSnapshot?: string;
2194
2221
  /** Valid value is backup */
2195
2222
  fileRequestIntent?: ShareTokenIntent;
2223
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2224
+ shareSnapshot?: string;
2196
2225
  /** If true, the trailing dot will not be trimmed from the target URI. */
2197
2226
  allowTrailingDot?: boolean;
2198
2227
  /** Specifies the range of bytes over which to list ranges, inclusively. */
@@ -2342,14 +2371,14 @@ export declare interface FileListHandlesHeaders {
2342
2371
  declare interface FileListHandlesOptionalParams extends coreClient.OperationOptions {
2343
2372
  /** 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> */
2344
2373
  timeoutInSeconds?: number;
2374
+ /** Valid value is backup */
2375
+ fileRequestIntent?: ShareTokenIntent;
2345
2376
  /** A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. */
2346
2377
  marker?: string;
2347
2378
  /** Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items. */
2348
2379
  maxResults?: number;
2349
2380
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2350
2381
  shareSnapshot?: string;
2351
- /** Valid value is backup */
2352
- fileRequestIntent?: ShareTokenIntent;
2353
2382
  /** If true, the trailing dot will not be trimmed from the target URI. */
2354
2383
  allowTrailingDot?: boolean;
2355
2384
  }
@@ -2430,6 +2459,9 @@ export declare interface FileParallelUploadOptions extends CommonOptions {
2430
2459
  leaseAccessConditions?: LeaseAccessConditions;
2431
2460
  }
2432
2461
 
2462
+ /** Defines values for FilePermissionFormat. */
2463
+ export declare type FilePermissionFormat = "Sddl" | "Binary";
2464
+
2433
2465
  /**
2434
2466
  * Indicates inherit file permission from the parent directory.
2435
2467
  */
@@ -2491,10 +2523,10 @@ declare interface FileReleaseLeaseHeaders {
2491
2523
  declare interface FileReleaseLeaseOptionalParams extends coreClient.OperationOptions {
2492
2524
  /** 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> */
2493
2525
  timeoutInSeconds?: number;
2494
- /** 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. */
2495
- requestId?: string;
2496
2526
  /** Valid value is backup */
2497
2527
  fileRequestIntent?: ShareTokenIntent;
2528
+ /** 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. */
2529
+ requestId?: string;
2498
2530
  /** If true, the trailing dot will not be trimmed from the target URI. */
2499
2531
  allowTrailingDot?: boolean;
2500
2532
  }
@@ -2544,12 +2576,14 @@ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
2544
2576
  fileHttpHeaders?: FileHttpHeaders_2;
2545
2577
  /** 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> */
2546
2578
  timeoutInSeconds?: number;
2579
+ /** Valid value is backup */
2580
+ fileRequestIntent?: ShareTokenIntent;
2547
2581
  /** A name-value pair to associate with a file storage object. */
2548
2582
  metadata?: {
2549
2583
  [propertyName: string]: string;
2550
2584
  };
2551
- /** Valid value is backup */
2552
- fileRequestIntent?: ShareTokenIntent;
2585
+ /** Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission */
2586
+ filePermissionFormat?: FilePermissionFormat;
2553
2587
  /** If true, the trailing dot will not be trimmed from the target URI. */
2554
2588
  allowTrailingDot?: boolean;
2555
2589
  /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
@@ -2600,6 +2634,12 @@ export declare interface FileRenameOptions extends CommonOptions {
2600
2634
  * If specified the permission (security descriptor) shall be set for the directory/file.
2601
2635
  */
2602
2636
  filePermission?: string;
2637
+ /**
2638
+ * Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned.
2639
+ * Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format.
2640
+ * If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission
2641
+ */
2642
+ filePermissionFormat?: FilePermissionFormat;
2603
2643
  /**
2604
2644
  * Optional.
2605
2645
  * Key of the permission to be set for the directory/file. Note: Only one of the filePermission or filePermissionKey should be specified.
@@ -2820,6 +2860,8 @@ declare interface FileSetHttpHeadersOptionalParams extends coreClient.OperationO
2820
2860
  timeoutInSeconds?: number;
2821
2861
  /** Valid value is backup */
2822
2862
  fileRequestIntent?: ShareTokenIntent;
2863
+ /** Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission */
2864
+ filePermissionFormat?: FilePermissionFormat;
2823
2865
  /** If true, the trailing dot will not be trimmed from the target URI. */
2824
2866
  allowTrailingDot?: boolean;
2825
2867
  /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
@@ -2879,12 +2921,12 @@ declare interface FileSetMetadataOptionalParams extends coreClient.OperationOpti
2879
2921
  leaseAccessConditions?: LeaseAccessConditions;
2880
2922
  /** 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> */
2881
2923
  timeoutInSeconds?: number;
2924
+ /** Valid value is backup */
2925
+ fileRequestIntent?: ShareTokenIntent;
2882
2926
  /** A name-value pair to associate with a file storage object. */
2883
2927
  metadata?: {
2884
2928
  [propertyName: string]: string;
2885
2929
  };
2886
- /** Valid value is backup */
2887
- fileRequestIntent?: ShareTokenIntent;
2888
2930
  /** If true, the trailing dot will not be trimmed from the target URI. */
2889
2931
  allowTrailingDot?: boolean;
2890
2932
  }
@@ -2938,12 +2980,12 @@ declare interface FileStartCopyOptionalParams extends coreClient.OperationOption
2938
2980
  copyFileSmbInfo?: CopyFileSmbInfo;
2939
2981
  /** 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> */
2940
2982
  timeoutInSeconds?: number;
2983
+ /** Valid value is backup */
2984
+ fileRequestIntent?: ShareTokenIntent;
2941
2985
  /** A name-value pair to associate with a file storage object. */
2942
2986
  metadata?: {
2943
2987
  [propertyName: string]: string;
2944
2988
  };
2945
- /** Valid value is backup */
2946
- fileRequestIntent?: ShareTokenIntent;
2947
2989
  /** If true, the trailing dot will not be trimmed from the target URI. */
2948
2990
  allowTrailingDot?: boolean;
2949
2991
  /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
@@ -3978,6 +4020,8 @@ export declare interface ServiceGetPropertiesHeaders {
3978
4020
  declare interface ServiceGetPropertiesOptionalParams extends coreClient.OperationOptions {
3979
4021
  /** 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> */
3980
4022
  timeoutInSeconds?: number;
4023
+ /** Valid value is backup */
4024
+ fileRequestIntent?: ShareTokenIntent;
3981
4025
  }
3982
4026
 
3983
4027
  /**
@@ -4039,6 +4083,8 @@ export declare interface ServiceListSharesSegmentHeaders {
4039
4083
  declare interface ServiceListSharesSegmentOptionalParams extends coreClient.OperationOptions {
4040
4084
  /** 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> */
4041
4085
  timeoutInSeconds?: number;
4086
+ /** Valid value is backup */
4087
+ fileRequestIntent?: ShareTokenIntent;
4042
4088
  /** Filters the results to return only entries whose name begins with the specified prefix. */
4043
4089
  prefix?: string;
4044
4090
  /** A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client. */
@@ -4071,6 +4117,8 @@ export declare interface ServiceSetPropertiesHeaders {
4071
4117
  declare interface ServiceSetPropertiesOptionalParams extends coreClient.OperationOptions {
4072
4118
  /** 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> */
4073
4119
  timeoutInSeconds?: number;
4120
+ /** Valid value is backup */
4121
+ fileRequestIntent?: ShareTokenIntent;
4074
4122
  }
4075
4123
 
4076
4124
  /**
@@ -4231,6 +4279,8 @@ declare interface ShareAcquireLeaseHeaders {
4231
4279
  declare interface ShareAcquireLeaseOptionalParams extends coreClient.OperationOptions {
4232
4280
  /** 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> */
4233
4281
  timeoutInSeconds?: number;
4282
+ /** Valid value is backup */
4283
+ fileRequestIntent?: ShareTokenIntent;
4234
4284
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
4235
4285
  shareSnapshot?: string;
4236
4286
  /** Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. */
@@ -4270,6 +4320,8 @@ declare interface ShareBreakLeaseOptionalParams extends coreClient.OperationOpti
4270
4320
  leaseAccessConditions?: LeaseAccessConditions;
4271
4321
  /** 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> */
4272
4322
  timeoutInSeconds?: number;
4323
+ /** Valid value is backup */
4324
+ fileRequestIntent?: ShareTokenIntent;
4273
4325
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
4274
4326
  shareSnapshot?: string;
4275
4327
  /** 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. */
@@ -4303,6 +4355,8 @@ declare interface ShareChangeLeaseHeaders {
4303
4355
  declare interface ShareChangeLeaseOptionalParams extends coreClient.OperationOptions {
4304
4356
  /** 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> */
4305
4357
  timeoutInSeconds?: number;
4358
+ /** Valid value is backup */
4359
+ fileRequestIntent?: ShareTokenIntent;
4306
4360
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
4307
4361
  shareSnapshot?: string;
4308
4362
  /** Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. */
@@ -4580,7 +4634,7 @@ export declare class ShareClient extends StorageClient {
4580
4634
  * @param options - Options to Share Create Permission operation.
4581
4635
  * @param filePermission - File permission described in the SDDL
4582
4636
  */
4583
- createPermission(filePermission: string, options?: ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>;
4637
+ createPermission(filePermission: string | SharePermission, options?: ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>;
4584
4638
  /**
4585
4639
  * Gets the Security Descriptor Definition Language (SDDL) for a given file permission key
4586
4640
  * which indicates a security descriptor.
@@ -4590,6 +4644,13 @@ export declare class ShareClient extends StorageClient {
4590
4644
  * @param filePermissionKey - File permission key which indicates the security descriptor of the permission.
4591
4645
  */
4592
4646
  getPermission(filePermissionKey: string, options?: ShareGetPermissionOptions): Promise<ShareGetPermissionResponse>;
4647
+ /**
4648
+ * Get a {@link ShareLeaseClient} that manages leases on the file.
4649
+ *
4650
+ * @param proposeLeaseId - Initial proposed lease Id.
4651
+ * @returns A new ShareLeaseClient object for managing leases on the file.
4652
+ */
4653
+ getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient;
4593
4654
  /**
4594
4655
  * Only available for ShareClient constructed with a shared key credential.
4595
4656
  *
@@ -4602,6 +4663,18 @@ export declare class ShareClient extends StorageClient {
4602
4663
  * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
4603
4664
  */
4604
4665
  generateSasUrl(options: ShareGenerateSasUrlOptions): string;
4666
+ /**
4667
+ * Only available for ShareClient constructed with a shared key credential.
4668
+ *
4669
+ * Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
4670
+ * and parameters passed in. The SAS is signed by the shared key credential of the client.
4671
+ *
4672
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
4673
+ *
4674
+ * @param options - Optional parameters.
4675
+ * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
4676
+ */
4677
+ generateSasStringToSign(options: ShareGenerateSasUrlOptions): string;
4605
4678
  }
4606
4679
 
4607
4680
  export declare interface ShareClientConfig {
@@ -4654,6 +4727,8 @@ export declare interface ShareCreateIfNotExistsResponse extends ShareCreateRespo
4654
4727
  declare interface ShareCreateOptionalParams extends coreClient.OperationOptions {
4655
4728
  /** 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> */
4656
4729
  timeoutInSeconds?: number;
4730
+ /** Valid value is backup */
4731
+ fileRequestIntent?: ShareTokenIntent;
4657
4732
  /** A name-value pair to associate with a file storage object. */
4658
4733
  metadata?: {
4659
4734
  [propertyName: string]: string;
@@ -4667,6 +4742,12 @@ declare interface ShareCreateOptionalParams extends coreClient.OperationOptions
4667
4742
  /** Root squash to set on the share. Only valid for NFS shares. */
4668
4743
  rootSquash?: ShareRootSquash;
4669
4744
  enableSnapshotVirtualDirectoryAccess?: boolean;
4745
+ /** Optional. Boolean. Default if not specified is false. This property enables paid bursting. */
4746
+ paidBurstingEnabled?: boolean;
4747
+ /** Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec. */
4748
+ paidBurstingMaxBandwidthMibps?: number;
4749
+ /** Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS. */
4750
+ paidBurstingMaxIops?: number;
4670
4751
  }
4671
4752
 
4672
4753
  /**
@@ -4708,6 +4789,18 @@ export declare interface ShareCreateOptions extends CommonOptions {
4708
4789
  * If not specified, the default is true.
4709
4790
  */
4710
4791
  enableSnapshotVirtualDirectoryAccess?: boolean;
4792
+ /**
4793
+ * Optional. Boolean. Default if not specified is false. This property enables paid bursting.
4794
+ */
4795
+ paidBurstingEnabled?: boolean;
4796
+ /**
4797
+ * Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec.
4798
+ */
4799
+ paidBurstingMaxBandwidthMibps?: number;
4800
+ /**
4801
+ * Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS.
4802
+ */
4803
+ paidBurstingMaxIops?: number;
4711
4804
  }
4712
4805
 
4713
4806
  /** Defines headers for Share_createPermission operation. */
@@ -4777,6 +4870,8 @@ export declare interface ShareCreateSnapshotHeaders {
4777
4870
  declare interface ShareCreateSnapshotOptionalParams extends coreClient.OperationOptions {
4778
4871
  /** 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> */
4779
4872
  timeoutInSeconds?: number;
4873
+ /** Valid value is backup */
4874
+ fileRequestIntent?: ShareTokenIntent;
4780
4875
  /** A name-value pair to associate with a file storage object. */
4781
4876
  metadata?: {
4782
4877
  [propertyName: string]: string;
@@ -4855,6 +4950,8 @@ declare interface ShareDeleteOptionalParams extends coreClient.OperationOptions
4855
4950
  leaseAccessConditions?: LeaseAccessConditions;
4856
4951
  /** 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> */
4857
4952
  timeoutInSeconds?: number;
4953
+ /** Valid value is backup */
4954
+ fileRequestIntent?: ShareTokenIntent;
4858
4955
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
4859
4956
  shareSnapshot?: string;
4860
4957
  /** Specifies the option include to delete the base share and all of its snapshots. */
@@ -5919,6 +6016,18 @@ export declare class ShareFileClient extends StorageClient {
5919
6016
  * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
5920
6017
  */
5921
6018
  generateSasUrl(options: FileGenerateSasUrlOptions): string;
6019
+ /**
6020
+ * Only available for clients constructed with a shared key credential.
6021
+ *
6022
+ * Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
6023
+ * and parameters passed in. The SAS is signed by the shared key credential of the client.
6024
+ *
6025
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
6026
+ *
6027
+ * @param options - Optional parameters.
6028
+ * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
6029
+ */
6030
+ generateSasStringToSign(options: FileGenerateSasUrlOptions): string;
5922
6031
  /**
5923
6032
  * Renames a file.
5924
6033
  * This API only supports renaming a file in the same share.
@@ -5983,6 +6092,8 @@ declare interface ShareGetAccessPolicyOptionalParams extends coreClient.Operatio
5983
6092
  leaseAccessConditions?: LeaseAccessConditions;
5984
6093
  /** 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> */
5985
6094
  timeoutInSeconds?: number;
6095
+ /** Valid value is backup */
6096
+ fileRequestIntent?: ShareTokenIntent;
5986
6097
  }
5987
6098
 
5988
6099
  /**
@@ -6025,12 +6136,20 @@ declare interface ShareGetPermissionOptionalParams extends coreClient.OperationO
6025
6136
  timeoutInSeconds?: number;
6026
6137
  /** Valid value is backup */
6027
6138
  fileRequestIntent?: ShareTokenIntent;
6139
+ /** Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned. Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format. If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission */
6140
+ filePermissionFormat?: FilePermissionFormat;
6028
6141
  }
6029
6142
 
6030
6143
  /**
6031
6144
  * Options to configure the {@link ShareClient.getPermission} operation.
6032
6145
  */
6033
6146
  export declare interface ShareGetPermissionOptions extends CommonOptions {
6147
+ /**
6148
+ * Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned.
6149
+ * Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format.
6150
+ * If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission
6151
+ */
6152
+ filePermissionFormat?: FilePermissionFormat;
6034
6153
  /**
6035
6154
  * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
6036
6155
  * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
@@ -6090,6 +6209,12 @@ export declare interface ShareGetPropertiesHeaders {
6090
6209
  rootSquash?: ShareRootSquash;
6091
6210
  /** Version 2023-08-03 and newer. Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled. This header is only returned for shares, not for snapshots. */
6092
6211
  enableSnapshotVirtualDirectoryAccess?: boolean;
6212
+ /** Optional. Boolean. Default if not specified is false. This property enables paid bursting. */
6213
+ paidBurstingEnabled?: boolean;
6214
+ /** Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS. */
6215
+ paidBurstingMaxIops?: number;
6216
+ /** Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec. */
6217
+ paidBurstingMaxBandwidthMibps?: number;
6093
6218
  /** Error Code */
6094
6219
  errorCode?: string;
6095
6220
  }
@@ -6100,6 +6225,8 @@ declare interface ShareGetPropertiesOptionalParams extends coreClient.OperationO
6100
6225
  leaseAccessConditions?: LeaseAccessConditions;
6101
6226
  /** 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> */
6102
6227
  timeoutInSeconds?: number;
6228
+ /** Valid value is backup */
6229
+ fileRequestIntent?: ShareTokenIntent;
6103
6230
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
6104
6231
  shareSnapshot?: string;
6105
6232
  }
@@ -6157,6 +6284,8 @@ declare interface ShareGetStatisticsOptionalParams extends coreClient.OperationO
6157
6284
  leaseAccessConditions?: LeaseAccessConditions;
6158
6285
  /** 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> */
6159
6286
  timeoutInSeconds?: number;
6287
+ /** Valid value is backup */
6288
+ fileRequestIntent?: ShareTokenIntent;
6160
6289
  }
6161
6290
 
6162
6291
  /**
@@ -6231,6 +6360,7 @@ export declare class ShareLeaseClient {
6231
6360
  private _leaseId;
6232
6361
  private _url;
6233
6362
  private fileOrShare;
6363
+ private shareClientConfig?;
6234
6364
  /**
6235
6365
  * Gets the lease Id.
6236
6366
  *
@@ -6248,7 +6378,7 @@ export declare class ShareLeaseClient {
6248
6378
  * @param client - The client to make the lease operation requests.
6249
6379
  * @param leaseId - Initial proposed lease id.
6250
6380
  */
6251
- constructor(client: ShareFileClient, leaseId?: string);
6381
+ constructor(client: ShareFileClient | ShareClient, leaseId?: string);
6252
6382
  /**
6253
6383
  * Establishes and manages a lock on a file, share or share snapshot for write and delete operations.
6254
6384
  *
@@ -6295,6 +6425,7 @@ export declare class ShareLeaseClient {
6295
6425
  export declare interface SharePermission {
6296
6426
  /** The permission in the Security Descriptor Definition Language (SDDL). */
6297
6427
  permission: string;
6428
+ format?: FilePermissionFormat;
6298
6429
  }
6299
6430
 
6300
6431
  /**
@@ -6331,6 +6462,9 @@ export declare interface SharePropertiesInternal {
6331
6462
  enabledProtocols?: string;
6332
6463
  rootSquash?: ShareRootSquash;
6333
6464
  enableSnapshotVirtualDirectoryAccess?: boolean;
6465
+ paidBurstingEnabled?: boolean;
6466
+ paidBurstingMaxIops?: number;
6467
+ paidBurstingMaxBandwidthMibps?: number;
6334
6468
  }
6335
6469
 
6336
6470
  /**
@@ -6373,6 +6507,8 @@ declare interface ShareReleaseLeaseHeaders {
6373
6507
  declare interface ShareReleaseLeaseOptionalParams extends coreClient.OperationOptions {
6374
6508
  /** 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> */
6375
6509
  timeoutInSeconds?: number;
6510
+ /** Valid value is backup */
6511
+ fileRequestIntent?: ShareTokenIntent;
6376
6512
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
6377
6513
  shareSnapshot?: string;
6378
6514
  /** 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. */
@@ -6404,6 +6540,8 @@ declare interface ShareRenewLeaseHeaders {
6404
6540
  declare interface ShareRenewLeaseOptionalParams extends coreClient.OperationOptions {
6405
6541
  /** 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> */
6406
6542
  timeoutInSeconds?: number;
6543
+ /** Valid value is backup */
6544
+ fileRequestIntent?: ShareTokenIntent;
6407
6545
  /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
6408
6546
  shareSnapshot?: string;
6409
6547
  /** 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. */
@@ -6433,6 +6571,8 @@ declare interface ShareRestoreHeaders {
6433
6571
  declare interface ShareRestoreOptionalParams extends coreClient.OperationOptions {
6434
6572
  /** 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> */
6435
6573
  timeoutInSeconds?: number;
6574
+ /** Valid value is backup */
6575
+ fileRequestIntent?: ShareTokenIntent;
6436
6576
  /** 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. */
6437
6577
  requestId?: string;
6438
6578
  /** Specifies the name of the previously-deleted share. */
@@ -6726,6 +6866,21 @@ export declare class ShareServiceClient extends StorageClient {
6726
6866
  * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
6727
6867
  */
6728
6868
  generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string;
6869
+ /**
6870
+ * Only available for ShareServiceClient constructed with a shared key credential.
6871
+ *
6872
+ * Generates string to sign for an account Shared Access Signature (SAS) URI based on the client properties
6873
+ * and parameters passed in. The SAS is signed by the shared key credential of the client.
6874
+ *
6875
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-account-sas
6876
+ *
6877
+ * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.
6878
+ * @param permissions - Specifies the list of permissions to be associated with the SAS.
6879
+ * @param resourceTypes - Specifies the resource types associated with the shared access signature.
6880
+ * @param options - Optional parameters.
6881
+ * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
6882
+ */
6883
+ generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string;
6729
6884
  }
6730
6885
 
6731
6886
  /** Defines headers for Share_setAccessPolicy operation. */
@@ -6750,6 +6905,8 @@ declare interface ShareSetAccessPolicyOptionalParams extends coreClient.Operatio
6750
6905
  leaseAccessConditions?: LeaseAccessConditions;
6751
6906
  /** 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> */
6752
6907
  timeoutInSeconds?: number;
6908
+ /** Valid value is backup */
6909
+ fileRequestIntent?: ShareTokenIntent;
6753
6910
  /** The ACL for the share. */
6754
6911
  shareAcl?: SignedIdentifierModel[];
6755
6912
  }
@@ -6797,6 +6954,8 @@ declare interface ShareSetMetadataOptionalParams extends coreClient.OperationOpt
6797
6954
  leaseAccessConditions?: LeaseAccessConditions;
6798
6955
  /** 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> */
6799
6956
  timeoutInSeconds?: number;
6957
+ /** Valid value is backup */
6958
+ fileRequestIntent?: ShareTokenIntent;
6800
6959
  /** A name-value pair to associate with a file storage object. */
6801
6960
  metadata?: {
6802
6961
  [propertyName: string]: string;
@@ -6846,6 +7005,8 @@ declare interface ShareSetPropertiesOptionalParams extends coreClient.OperationO
6846
7005
  leaseAccessConditions?: LeaseAccessConditions;
6847
7006
  /** 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> */
6848
7007
  timeoutInSeconds?: number;
7008
+ /** Valid value is backup */
7009
+ fileRequestIntent?: ShareTokenIntent;
6849
7010
  /** Specifies the maximum size of the share, in gigabytes. */
6850
7011
  quota?: number;
6851
7012
  /** Specifies the access tier of the share. */
@@ -6853,6 +7014,12 @@ declare interface ShareSetPropertiesOptionalParams extends coreClient.OperationO
6853
7014
  /** Root squash to set on the share. Only valid for NFS shares. */
6854
7015
  rootSquash?: ShareRootSquash;
6855
7016
  enableSnapshotVirtualDirectoryAccess?: boolean;
7017
+ /** Optional. Boolean. Default if not specified is false. This property enables paid bursting. */
7018
+ paidBurstingEnabled?: boolean;
7019
+ /** Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec. */
7020
+ paidBurstingMaxBandwidthMibps?: number;
7021
+ /** Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS. */
7022
+ paidBurstingMaxIops?: number;
6856
7023
  }
6857
7024
 
6858
7025
  /**
@@ -6882,6 +7049,23 @@ export declare interface ShareSetPropertiesOptions extends CommonOptions {
6882
7049
  * If specified, the operation only succeeds if the resource's lease is active and matches this ID.
6883
7050
  */
6884
7051
  leaseAccessConditions?: LeaseAccessConditions;
7052
+ /**
7053
+ * Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled.
7054
+ * If not specified, the default is true.
7055
+ */
7056
+ enableSnapshotVirtualDirectoryAccess?: boolean;
7057
+ /**
7058
+ * Optional. Boolean. Default if not specified is false. This property enables paid bursting.
7059
+ */
7060
+ paidBurstingEnabled?: boolean;
7061
+ /**
7062
+ * Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec.
7063
+ */
7064
+ paidBurstingMaxBandwidthMibps?: number;
7065
+ /**
7066
+ * Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS.
7067
+ */
7068
+ paidBurstingMaxIops?: number;
6885
7069
  }
6886
7070
 
6887
7071
  /** Contains response data for the setProperties operation. */