@azure/storage-file-share 12.14.0 → 12.20.0-alpha.20230607.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (324) hide show
  1. package/dist/index.js +5739 -6320
  2. package/dist/index.js.map +1 -1
  3. package/dist-esm/storage-blob/src/BatchResponse.js +4 -0
  4. package/dist-esm/storage-blob/src/BatchResponse.js.map +1 -0
  5. package/dist-esm/storage-blob/src/BatchResponseParser.js +137 -0
  6. package/dist-esm/storage-blob/src/BatchResponseParser.js.map +1 -0
  7. package/dist-esm/storage-blob/src/BatchUtils.browser.js +11 -0
  8. package/dist-esm/storage-blob/src/BatchUtils.browser.js.map +1 -0
  9. package/dist-esm/storage-blob/src/BatchUtils.js +15 -0
  10. package/dist-esm/storage-blob/src/BatchUtils.js.map +1 -0
  11. package/dist-esm/storage-blob/src/BlobBatch.js +267 -0
  12. package/dist-esm/storage-blob/src/BlobBatch.js.map +1 -0
  13. package/dist-esm/storage-blob/src/BlobBatchClient.js +140 -0
  14. package/dist-esm/storage-blob/src/BlobBatchClient.js.map +1 -0
  15. package/dist-esm/storage-blob/src/BlobDownloadResponse.browser.js +7 -0
  16. package/dist-esm/storage-blob/src/BlobDownloadResponse.browser.js.map +1 -0
  17. package/dist-esm/storage-blob/src/BlobDownloadResponse.js +455 -0
  18. package/dist-esm/storage-blob/src/BlobDownloadResponse.js.map +1 -0
  19. package/dist-esm/storage-blob/src/BlobLeaseClient.js +192 -0
  20. package/dist-esm/storage-blob/src/BlobLeaseClient.js.map +1 -0
  21. package/dist-esm/storage-blob/src/BlobQueryResponse.browser.js +362 -0
  22. package/dist-esm/storage-blob/src/BlobQueryResponse.browser.js.map +1 -0
  23. package/dist-esm/storage-blob/src/BlobQueryResponse.js +367 -0
  24. package/dist-esm/storage-blob/src/BlobQueryResponse.js.map +1 -0
  25. package/dist-esm/storage-blob/src/BlobServiceClient.js +702 -0
  26. package/dist-esm/storage-blob/src/BlobServiceClient.js.map +1 -0
  27. package/dist-esm/storage-blob/src/Clients.js +2527 -0
  28. package/dist-esm/storage-blob/src/Clients.js.map +1 -0
  29. package/dist-esm/storage-blob/src/ContainerClient.js +1161 -0
  30. package/dist-esm/storage-blob/src/ContainerClient.js.map +1 -0
  31. package/dist-esm/storage-blob/src/PageBlobRangeResponse.js +24 -0
  32. package/dist-esm/storage-blob/src/PageBlobRangeResponse.js.map +1 -0
  33. package/dist-esm/storage-blob/src/Pipeline.js +259 -0
  34. package/dist-esm/storage-blob/src/Pipeline.js.map +1 -0
  35. package/dist-esm/storage-blob/src/Range.js +21 -0
  36. package/dist-esm/storage-blob/src/Range.js.map +1 -0
  37. package/dist-esm/{src → storage-blob/src}/StorageBrowserPolicyFactory.js +1 -1
  38. package/dist-esm/storage-blob/src/StorageBrowserPolicyFactory.js.map +1 -0
  39. package/dist-esm/storage-blob/src/StorageClient.js +29 -0
  40. package/dist-esm/storage-blob/src/StorageClient.js.map +1 -0
  41. package/dist-esm/storage-blob/src/StorageContextClient.js +17 -0
  42. package/dist-esm/storage-blob/src/StorageContextClient.js.map +1 -0
  43. package/dist-esm/{src → storage-blob/src}/StorageRetryPolicyFactory.js +2 -1
  44. package/dist-esm/storage-blob/src/StorageRetryPolicyFactory.js.map +1 -0
  45. package/dist-esm/{src → storage-blob/src}/credentials/AnonymousCredential.js +1 -1
  46. package/dist-esm/storage-blob/src/credentials/AnonymousCredential.js.map +1 -0
  47. package/dist-esm/storage-blob/src/credentials/Credential.js.map +1 -0
  48. package/dist-esm/storage-blob/src/credentials/StorageSharedKeyCredential.browser.js.map +1 -0
  49. package/dist-esm/{src → storage-blob/src}/credentials/StorageSharedKeyCredential.js +1 -1
  50. package/dist-esm/storage-blob/src/credentials/StorageSharedKeyCredential.js.map +1 -0
  51. package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.browser.js +5 -0
  52. package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.browser.js.map +1 -0
  53. package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js +31 -0
  54. package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js.map +1 -0
  55. package/dist-esm/{src → storage-blob/src}/generated/src/index.js +1 -1
  56. package/dist-esm/storage-blob/src/generated/src/index.js.map +1 -0
  57. package/dist-esm/storage-blob/src/generated/src/models/index.js +256 -0
  58. package/dist-esm/storage-blob/src/generated/src/models/index.js.map +1 -0
  59. package/dist-esm/storage-blob/src/generated/src/models/mappers.js +8196 -0
  60. package/dist-esm/storage-blob/src/generated/src/models/mappers.js.map +1 -0
  61. package/dist-esm/storage-blob/src/generated/src/models/parameters.js +1610 -0
  62. package/dist-esm/storage-blob/src/generated/src/models/parameters.js.map +1 -0
  63. package/dist-esm/storage-blob/src/generated/src/operations/appendBlob.js +221 -0
  64. package/dist-esm/storage-blob/src/generated/src/operations/appendBlob.js.map +1 -0
  65. package/dist-esm/storage-blob/src/generated/src/operations/blob.js +997 -0
  66. package/dist-esm/storage-blob/src/generated/src/operations/blob.js.map +1 -0
  67. package/dist-esm/storage-blob/src/generated/src/operations/blockBlob.js +365 -0
  68. package/dist-esm/storage-blob/src/generated/src/operations/blockBlob.js.map +1 -0
  69. package/dist-esm/storage-blob/src/generated/src/operations/container.js +705 -0
  70. package/dist-esm/storage-blob/src/generated/src/operations/container.js.map +1 -0
  71. package/dist-esm/storage-blob/src/generated/src/operations/index.js +14 -0
  72. package/dist-esm/storage-blob/src/generated/src/operations/index.js.map +1 -0
  73. package/dist-esm/storage-blob/src/generated/src/operations/pageBlob.js +456 -0
  74. package/dist-esm/storage-blob/src/generated/src/operations/pageBlob.js.map +1 -0
  75. package/dist-esm/storage-blob/src/generated/src/operations/service.js +315 -0
  76. package/dist-esm/storage-blob/src/generated/src/operations/service.js.map +1 -0
  77. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/appendBlob.js +9 -0
  78. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/appendBlob.js.map +1 -0
  79. package/dist-esm/{src/generated/src/models/index.js → storage-blob/src/generated/src/operationsInterfaces/blob.js} +1 -1
  80. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blob.js.map +1 -0
  81. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blockBlob.js +9 -0
  82. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blockBlob.js.map +1 -0
  83. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/container.js +9 -0
  84. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/container.js.map +1 -0
  85. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/index.js +14 -0
  86. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/index.js.map +1 -0
  87. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/pageBlob.js +9 -0
  88. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/pageBlob.js.map +1 -0
  89. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/service.js +9 -0
  90. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/service.js.map +1 -0
  91. package/dist-esm/storage-blob/src/generated/src/storageClient.js +49 -0
  92. package/dist-esm/storage-blob/src/generated/src/storageClient.js.map +1 -0
  93. package/dist-esm/storage-blob/src/generatedModels.js +4 -0
  94. package/dist-esm/storage-blob/src/generatedModels.js.map +1 -0
  95. package/dist-esm/storage-blob/src/index.browser.js +23 -0
  96. package/dist-esm/storage-blob/src/index.browser.js.map +1 -0
  97. package/dist-esm/storage-blob/src/index.js +33 -0
  98. package/dist-esm/storage-blob/src/index.js.map +1 -0
  99. package/dist-esm/storage-blob/src/log.js +8 -0
  100. package/dist-esm/storage-blob/src/log.js.map +1 -0
  101. package/dist-esm/storage-blob/src/models.js +108 -0
  102. package/dist-esm/storage-blob/src/models.js.map +1 -0
  103. package/dist-esm/storage-blob/src/policies/AnonymousCredentialPolicy.js.map +1 -0
  104. package/dist-esm/{src → storage-blob/src}/policies/CredentialPolicy.js +1 -1
  105. package/dist-esm/storage-blob/src/policies/CredentialPolicy.js.map +1 -0
  106. package/dist-esm/storage-blob/src/policies/RequestPolicy.js +40 -0
  107. package/dist-esm/storage-blob/src/policies/RequestPolicy.js.map +1 -0
  108. package/dist-esm/{src → storage-blob/src}/policies/StorageBrowserPolicy.js +2 -1
  109. package/dist-esm/{src → storage-blob/src}/policies/StorageBrowserPolicy.js.map +1 -1
  110. package/dist-esm/storage-blob/src/policies/StorageBrowserPolicyV2.js +31 -0
  111. package/dist-esm/storage-blob/src/policies/StorageBrowserPolicyV2.js.map +1 -0
  112. package/dist-esm/{src → storage-blob/src}/policies/StorageRetryPolicy.js +15 -6
  113. package/dist-esm/storage-blob/src/policies/StorageRetryPolicy.js.map +1 -0
  114. package/dist-esm/storage-blob/src/policies/StorageRetryPolicyV2.js +165 -0
  115. package/dist-esm/storage-blob/src/policies/StorageRetryPolicyV2.js.map +1 -0
  116. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js.map +1 -0
  117. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.browser.js +18 -0
  118. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.browser.js.map +1 -0
  119. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js +131 -0
  120. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js.map +1 -0
  121. package/dist-esm/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.js +130 -0
  122. package/dist-esm/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.js.map +1 -0
  123. package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js +227 -0
  124. package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js.map +1 -0
  125. package/dist-esm/storage-blob/src/sas/AccountSASResourceTypes.js.map +1 -0
  126. package/dist-esm/storage-blob/src/sas/AccountSASServices.js.map +1 -0
  127. package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js +93 -0
  128. package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js.map +1 -0
  129. package/dist-esm/storage-blob/src/sas/BlobSASPermissions.js +195 -0
  130. package/dist-esm/storage-blob/src/sas/BlobSASPermissions.js.map +1 -0
  131. package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js +555 -0
  132. package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js.map +1 -0
  133. package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js +221 -0
  134. package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js.map +1 -0
  135. package/dist-esm/storage-blob/src/sas/SASQueryParameters.js +234 -0
  136. package/dist-esm/storage-blob/src/sas/SASQueryParameters.js.map +1 -0
  137. package/dist-esm/storage-blob/src/sas/SasIPRange.js +13 -0
  138. package/dist-esm/storage-blob/src/sas/SasIPRange.js.map +1 -0
  139. package/dist-esm/storage-blob/src/utils/Batch.js.map +1 -0
  140. package/dist-esm/storage-blob/src/utils/BlobQuickQueryStream.js +111 -0
  141. package/dist-esm/storage-blob/src/utils/BlobQuickQueryStream.js.map +1 -0
  142. package/dist-esm/storage-blob/src/utils/Mutex.js +66 -0
  143. package/dist-esm/storage-blob/src/utils/Mutex.js.map +1 -0
  144. package/dist-esm/storage-blob/src/utils/RetriableReadableStream.js +119 -0
  145. package/dist-esm/storage-blob/src/utils/RetriableReadableStream.js.map +1 -0
  146. package/dist-esm/storage-blob/src/utils/cache.js +11 -0
  147. package/dist-esm/storage-blob/src/utils/cache.js.map +1 -0
  148. package/dist-esm/storage-blob/src/utils/constants.js +223 -0
  149. package/dist-esm/storage-blob/src/utils/constants.js.map +1 -0
  150. package/dist-esm/storage-blob/src/utils/tracing.js +14 -0
  151. package/dist-esm/storage-blob/src/utils/tracing.js.map +1 -0
  152. package/dist-esm/storage-blob/src/utils/utils.browser.js +48 -0
  153. package/dist-esm/storage-blob/src/utils/utils.browser.js.map +1 -0
  154. package/dist-esm/storage-blob/src/utils/utils.common.js +754 -0
  155. package/dist-esm/storage-blob/src/utils/utils.common.js.map +1 -0
  156. package/dist-esm/storage-blob/src/utils/utils.node.js +132 -0
  157. package/dist-esm/storage-blob/src/utils/utils.node.js.map +1 -0
  158. package/dist-esm/storage-file-share/src/AccountSASPermissions.js.map +1 -0
  159. package/dist-esm/storage-file-share/src/AccountSASResourceTypes.js +72 -0
  160. package/dist-esm/storage-file-share/src/AccountSASResourceTypes.js.map +1 -0
  161. package/dist-esm/storage-file-share/src/AccountSASServices.js +80 -0
  162. package/dist-esm/storage-file-share/src/AccountSASServices.js.map +1 -0
  163. package/dist-esm/storage-file-share/src/AccountSASSignatureValues.js.map +1 -0
  164. package/dist-esm/{src → storage-file-share/src}/Clients.js +476 -1253
  165. package/dist-esm/storage-file-share/src/Clients.js.map +1 -0
  166. package/dist-esm/storage-file-share/src/FileDownloadResponse.browser.js.map +1 -0
  167. package/dist-esm/{src → storage-file-share/src}/FileDownloadResponse.js +15 -14
  168. package/dist-esm/storage-file-share/src/FileDownloadResponse.js.map +1 -0
  169. package/dist-esm/storage-file-share/src/FileSASPermissions.js.map +1 -0
  170. package/dist-esm/storage-file-share/src/FileSASSignatureValues.js.map +1 -0
  171. package/dist-esm/storage-file-share/src/FileSystemAttributes.js.map +1 -0
  172. package/dist-esm/storage-file-share/src/Range.js.map +1 -0
  173. package/dist-esm/{src → storage-file-share/src}/SASQueryParameters.js +14 -14
  174. package/dist-esm/storage-file-share/src/SASQueryParameters.js.map +1 -0
  175. package/dist-esm/storage-file-share/src/SasIPRange.js.map +1 -0
  176. package/dist-esm/{src → storage-file-share/src}/ShareClientInternal.js +1 -2
  177. package/dist-esm/storage-file-share/src/ShareClientInternal.js.map +1 -0
  178. package/dist-esm/storage-file-share/src/ShareSASPermissions.js.map +1 -0
  179. package/dist-esm/{src → storage-file-share/src}/ShareServiceClient.js +58 -121
  180. package/dist-esm/storage-file-share/src/ShareServiceClient.js.map +1 -0
  181. package/dist-esm/{src → storage-file-share/src}/StorageClient.js +20 -14
  182. package/dist-esm/storage-file-share/src/StorageClient.js.map +1 -0
  183. package/dist-esm/storage-file-share/src/StorageContextClient.js +18 -0
  184. package/dist-esm/storage-file-share/src/StorageContextClient.js.map +1 -0
  185. package/dist-esm/storage-file-share/src/generated/src/index.js +11 -0
  186. package/dist-esm/storage-file-share/src/generated/src/index.js.map +1 -0
  187. package/dist-esm/storage-file-share/src/generated/src/models/index.js +144 -0
  188. package/dist-esm/storage-file-share/src/generated/src/models/index.js.map +1 -0
  189. package/dist-esm/{src → storage-file-share/src}/generated/src/models/mappers.js +16 -49
  190. package/dist-esm/storage-file-share/src/generated/src/models/mappers.js.map +1 -0
  191. package/dist-esm/{src → storage-file-share/src}/generated/src/models/parameters.js +17 -37
  192. package/dist-esm/storage-file-share/src/generated/src/models/parameters.js.map +1 -0
  193. package/dist-esm/{src → storage-file-share/src}/generated/src/operations/directory.js +17 -73
  194. package/dist-esm/storage-file-share/src/generated/src/operations/directory.js.map +1 -0
  195. package/dist-esm/{src → storage-file-share/src}/generated/src/operations/file.js +33 -142
  196. package/dist-esm/storage-file-share/src/generated/src/operations/file.js.map +1 -0
  197. package/dist-esm/storage-file-share/src/generated/src/operations/index.js.map +1 -0
  198. package/dist-esm/{src → storage-file-share/src}/generated/src/operations/service.js +7 -17
  199. package/dist-esm/storage-file-share/src/generated/src/operations/service.js.map +1 -0
  200. package/dist-esm/{src → storage-file-share/src}/generated/src/operations/share.js +26 -85
  201. package/dist-esm/storage-file-share/src/generated/src/operations/share.js.map +1 -0
  202. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/directory.js +9 -0
  203. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/directory.js.map +1 -0
  204. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/file.js +9 -0
  205. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/file.js.map +1 -0
  206. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/index.js +12 -0
  207. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/index.js.map +1 -0
  208. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/service.js +9 -0
  209. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/service.js.map +1 -0
  210. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/share.js +9 -0
  211. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/share.js.map +1 -0
  212. package/dist-esm/storage-file-share/src/generated/src/storageClient.js +48 -0
  213. package/dist-esm/storage-file-share/src/generated/src/storageClient.js.map +1 -0
  214. package/dist-esm/storage-file-share/src/generatedModels.js +4 -0
  215. package/dist-esm/storage-file-share/src/generatedModels.js.map +1 -0
  216. package/dist-esm/storage-file-share/src/index.browser.js +18 -0
  217. package/dist-esm/storage-file-share/src/index.browser.js.map +1 -0
  218. package/dist-esm/storage-file-share/src/index.js +28 -0
  219. package/dist-esm/storage-file-share/src/index.js.map +1 -0
  220. package/dist-esm/storage-file-share/src/log.js.map +1 -0
  221. package/dist-esm/storage-file-share/src/models.js.map +1 -0
  222. package/dist-esm/storage-file-share/src/utils/Batch.js +122 -0
  223. package/dist-esm/storage-file-share/src/utils/Batch.js.map +1 -0
  224. package/dist-esm/storage-file-share/src/utils/BufferScheduler.js.map +1 -0
  225. package/dist-esm/{src → storage-file-share/src}/utils/RetriableReadableStream.js +51 -48
  226. package/dist-esm/storage-file-share/src/utils/RetriableReadableStream.js.map +1 -0
  227. package/dist-esm/{src → storage-file-share/src}/utils/constants.js +2 -6
  228. package/dist-esm/storage-file-share/src/utils/constants.js.map +1 -0
  229. package/dist-esm/storage-file-share/src/utils/tracing.js +14 -0
  230. package/dist-esm/storage-file-share/src/utils/tracing.js.map +1 -0
  231. package/dist-esm/storage-file-share/src/utils/utils.browser.js.map +1 -0
  232. package/dist-esm/{src → storage-file-share/src}/utils/utils.common.js +82 -95
  233. package/dist-esm/storage-file-share/src/utils/utils.common.js.map +1 -0
  234. package/dist-esm/storage-file-share/src/utils/utils.node.js.map +1 -0
  235. package/package.json +31 -25
  236. package/types/3.1/storage-file-share.d.ts +1454 -529
  237. package/types/latest/storage-file-share.d.ts +1580 -549
  238. package/dist-esm/src/AccountSASPermissions.js.map +0 -1
  239. package/dist-esm/src/AccountSASResourceTypes.js.map +0 -1
  240. package/dist-esm/src/AccountSASServices.js.map +0 -1
  241. package/dist-esm/src/AccountSASSignatureValues.js.map +0 -1
  242. package/dist-esm/src/Clients.js.map +0 -1
  243. package/dist-esm/src/FileDownloadResponse.browser.js.map +0 -1
  244. package/dist-esm/src/FileDownloadResponse.js.map +0 -1
  245. package/dist-esm/src/FileSASPermissions.js.map +0 -1
  246. package/dist-esm/src/FileSASSignatureValues.js.map +0 -1
  247. package/dist-esm/src/FileSystemAttributes.js.map +0 -1
  248. package/dist-esm/src/Pipeline.js +0 -88
  249. package/dist-esm/src/Pipeline.js.map +0 -1
  250. package/dist-esm/src/Range.js.map +0 -1
  251. package/dist-esm/src/SASQueryParameters.js.map +0 -1
  252. package/dist-esm/src/SasIPRange.js.map +0 -1
  253. package/dist-esm/src/ShareClientInternal.js.map +0 -1
  254. package/dist-esm/src/ShareSASPermissions.js.map +0 -1
  255. package/dist-esm/src/ShareServiceClient.js.map +0 -1
  256. package/dist-esm/src/StorageBrowserPolicyFactory.js.map +0 -1
  257. package/dist-esm/src/StorageClient.js.map +0 -1
  258. package/dist-esm/src/StorageRetryPolicyFactory.js.map +0 -1
  259. package/dist-esm/src/TelemetryPolicyFactory.js +0 -50
  260. package/dist-esm/src/TelemetryPolicyFactory.js.map +0 -1
  261. package/dist-esm/src/credentials/AnonymousCredential.js.map +0 -1
  262. package/dist-esm/src/credentials/Credential.js.map +0 -1
  263. package/dist-esm/src/credentials/StorageSharedKeyCredential.browser.js.map +0 -1
  264. package/dist-esm/src/credentials/StorageSharedKeyCredential.js.map +0 -1
  265. package/dist-esm/src/generated/src/index.js.map +0 -1
  266. package/dist-esm/src/generated/src/models/index.js.map +0 -1
  267. package/dist-esm/src/generated/src/models/mappers.js.map +0 -1
  268. package/dist-esm/src/generated/src/models/parameters.js.map +0 -1
  269. package/dist-esm/src/generated/src/operations/directory.js.map +0 -1
  270. package/dist-esm/src/generated/src/operations/file.js.map +0 -1
  271. package/dist-esm/src/generated/src/operations/index.js.map +0 -1
  272. package/dist-esm/src/generated/src/operations/service.js.map +0 -1
  273. package/dist-esm/src/generated/src/operations/share.js.map +0 -1
  274. package/dist-esm/src/generated/src/storageClient.js +0 -25
  275. package/dist-esm/src/generated/src/storageClient.js.map +0 -1
  276. package/dist-esm/src/generated/src/storageClientContext.js +0 -40
  277. package/dist-esm/src/generated/src/storageClientContext.js.map +0 -1
  278. package/dist-esm/src/generatedModels.js +0 -8
  279. package/dist-esm/src/generatedModels.js.map +0 -1
  280. package/dist-esm/src/index.browser.js +0 -17
  281. package/dist-esm/src/index.browser.js.map +0 -1
  282. package/dist-esm/src/index.js +0 -27
  283. package/dist-esm/src/index.js.map +0 -1
  284. package/dist-esm/src/log.js.map +0 -1
  285. package/dist-esm/src/models.js.map +0 -1
  286. package/dist-esm/src/policies/AnonymousCredentialPolicy.js.map +0 -1
  287. package/dist-esm/src/policies/CredentialPolicy.js.map +0 -1
  288. package/dist-esm/src/policies/StorageRetryPolicy.js.map +0 -1
  289. package/dist-esm/src/policies/StorageSharedKeyCredentialPolicy.js.map +0 -1
  290. package/dist-esm/src/policies/TelemetryPolicy.js +0 -36
  291. package/dist-esm/src/policies/TelemetryPolicy.js.map +0 -1
  292. package/dist-esm/src/utils/Batch.js.map +0 -1
  293. package/dist-esm/src/utils/BufferScheduler.js.map +0 -1
  294. package/dist-esm/src/utils/RetriableReadableStream.js.map +0 -1
  295. package/dist-esm/src/utils/cache.js +0 -8
  296. package/dist-esm/src/utils/cache.js.map +0 -1
  297. package/dist-esm/src/utils/constants.js.map +0 -1
  298. package/dist-esm/src/utils/tracing.js +0 -27
  299. package/dist-esm/src/utils/tracing.js.map +0 -1
  300. package/dist-esm/src/utils/utils.browser.js.map +0 -1
  301. package/dist-esm/src/utils/utils.common.js.map +0 -1
  302. package/dist-esm/src/utils/utils.node.js.map +0 -1
  303. /package/dist-esm/{src → storage-blob/src}/credentials/Credential.js +0 -0
  304. /package/dist-esm/{src → storage-blob/src}/credentials/StorageSharedKeyCredential.browser.js +0 -0
  305. /package/dist-esm/{src → storage-blob/src}/policies/AnonymousCredentialPolicy.js +0 -0
  306. /package/dist-esm/{src → storage-blob/src}/policies/StorageSharedKeyCredentialPolicy.js +0 -0
  307. /package/dist-esm/{src → storage-blob/src/sas}/AccountSASResourceTypes.js +0 -0
  308. /package/dist-esm/{src → storage-blob/src/sas}/AccountSASServices.js +0 -0
  309. /package/dist-esm/{src → storage-blob/src}/utils/Batch.js +0 -0
  310. /package/dist-esm/{src → storage-file-share/src}/AccountSASPermissions.js +0 -0
  311. /package/dist-esm/{src → storage-file-share/src}/AccountSASSignatureValues.js +0 -0
  312. /package/dist-esm/{src → storage-file-share/src}/FileDownloadResponse.browser.js +0 -0
  313. /package/dist-esm/{src → storage-file-share/src}/FileSASPermissions.js +0 -0
  314. /package/dist-esm/{src → storage-file-share/src}/FileSASSignatureValues.js +0 -0
  315. /package/dist-esm/{src → storage-file-share/src}/FileSystemAttributes.js +0 -0
  316. /package/dist-esm/{src → storage-file-share/src}/Range.js +0 -0
  317. /package/dist-esm/{src → storage-file-share/src}/SasIPRange.js +0 -0
  318. /package/dist-esm/{src → storage-file-share/src}/ShareSASPermissions.js +0 -0
  319. /package/dist-esm/{src → storage-file-share/src}/generated/src/operations/index.js +0 -0
  320. /package/dist-esm/{src → storage-file-share/src}/log.js +0 -0
  321. /package/dist-esm/{src → storage-file-share/src}/models.js +0 -0
  322. /package/dist-esm/{src → storage-file-share/src}/utils/BufferScheduler.js +0 -0
  323. /package/dist-esm/{src → storage-file-share/src}/utils/utils.browser.js +0 -0
  324. /package/dist-esm/{src → storage-file-share/src}/utils/utils.node.js +0 -0
@@ -2,28 +2,26 @@
2
2
 
3
3
  import { AbortSignalLike } from '@azure/abort-controller';
4
4
  import { AzureLogger } from '@azure/logger';
5
- import { BaseRequestPolicy } from '@azure/core-http';
6
- import * as coreHttp from '@azure/core-http';
7
- import { deserializationPolicy } from '@azure/core-http';
8
- import { HttpHeaders } from '@azure/core-http';
9
- import { HttpOperationResponse } from '@azure/core-http';
10
- import { HttpRequestBody } from '@azure/core-http';
11
- import { HttpResponse } from '@azure/core-http';
12
- import { HttpClient as IHttpClient } from '@azure/core-http';
13
- import { KeepAliveOptions } from '@azure/core-http';
5
+ import { CompatResponse } from '@azure/core-http-compat';
6
+ import * as coreClient from '@azure/core-client';
7
+ import * as coreHttpCompat from '@azure/core-http-compat';
8
+ import * as coreRestPipeline from '@azure/core-rest-pipeline';
9
+ import { HttpHeadersLike } from '@azure/core-http-compat';
10
+ import { HttpPipelineLogLevel } from '@azure/core-http-compat';
11
+ import { KeepAliveOptions } from '@azure/core-http-compat';
14
12
  import { OperationTracingOptions } from '@azure/core-tracing';
15
13
  import { PagedAsyncIterableIterator } from '@azure/core-paging';
16
- import { ProxyOptions } from '@azure/core-http';
14
+ import { ProxySettings } from '@azure/core-rest-pipeline';
17
15
  import { Readable } from 'stream';
18
- import { RequestPolicy } from '@azure/core-http';
19
- import { RequestPolicyFactory } from '@azure/core-http';
20
- import { RequestPolicyOptions } from '@azure/core-http';
21
- import { RestError } from '@azure/core-http';
22
- import { ServiceClientOptions } from '@azure/core-http';
23
- import { TokenCredential } from '@azure/core-http';
24
- import { TransferProgressEvent } from '@azure/core-http';
25
- import { UserAgentOptions } from '@azure/core-http';
26
- import { WebResource } from '@azure/core-http';
16
+ import { RequestBodyType } from '@azure/core-rest-pipeline';
17
+ import { RequestPolicy } from '@azure/core-http-compat';
18
+ import { RequestPolicyFactory } from '@azure/core-http-compat';
19
+ import { RequestPolicyOptionsLike } from '@azure/core-http-compat';
20
+ import { RestError } from '@azure/core-rest-pipeline';
21
+ import { TokenCredential } from '@azure/core-auth';
22
+ import { TransferProgressEvent } from '@azure/core-rest-pipeline';
23
+ import { UserAgentPolicyOptions } from '@azure/core-rest-pipeline';
24
+ import { WebResourceLike } from '@azure/core-http-compat';
27
25
 
28
26
  /** An Access policy. */
29
27
  export declare interface AccessPolicy {
@@ -229,7 +227,7 @@ export declare interface AccountSASSignatureValues {
229
227
 
230
228
  /**
231
229
  * AnonymousCredential provides a credentialPolicyCreator member used to create
232
- * {@link AnonymousCredentialPolicy} objects. AnonymousCredentialPolicy is used with
230
+ * AnonymousCredentialPolicy objects. AnonymousCredentialPolicy is used with
233
231
  * HTTP(S) requests that read public resources or for use with Shared Access
234
232
  * Signatures (SAS).
235
233
  */
@@ -240,7 +238,7 @@ export declare class AnonymousCredential extends Credential_2 {
240
238
  * @param nextPolicy -
241
239
  * @param options -
242
240
  */
243
- create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): AnonymousCredentialPolicy;
241
+ create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): AnonymousCredentialPolicy;
244
242
  }
245
243
 
246
244
  /**
@@ -253,10 +251,52 @@ export declare class AnonymousCredentialPolicy extends CredentialPolicy {
253
251
  * @param nextPolicy -
254
252
  * @param options -
255
253
  */
256
- constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
254
+ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
257
255
  }
258
256
 
259
- export { BaseRequestPolicy }
257
+ /**
258
+ * The base class from which all request policies derive.
259
+ */
260
+ export declare abstract class BaseRequestPolicy implements RequestPolicy {
261
+ /**
262
+ * The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
263
+ */
264
+ readonly _nextPolicy: RequestPolicy;
265
+ /**
266
+ * The options that can be passed to a given request policy.
267
+ */
268
+ readonly _options: RequestPolicyOptionsLike;
269
+ /**
270
+ * The main method to implement that manipulates a request/response.
271
+ */
272
+ protected constructor(
273
+ /**
274
+ * The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
275
+ */
276
+ _nextPolicy: RequestPolicy,
277
+ /**
278
+ * The options that can be passed to a given request policy.
279
+ */
280
+ _options: RequestPolicyOptionsLike);
281
+ /**
282
+ * Sends a network request based on the given web resource.
283
+ * @param webResource - A {@link WebResourceLike} that describes a HTTP request to be made.
284
+ */
285
+ abstract sendRequest(webResource: WebResourceLike): Promise<CompatResponse>;
286
+ /**
287
+ * Get whether or not a log with the provided log level should be logged.
288
+ * @param logLevel - The log level of the log that will be logged.
289
+ * @returns Whether or not a log with the provided log level should be logged.
290
+ */
291
+ shouldLog(logLevel: HttpPipelineLogLevel): boolean;
292
+ /**
293
+ * Attempt to log the provided message to the provided logger. If no logger was provided or if
294
+ * the log level does not meat the logger's threshold, then nothing will be logged.
295
+ * @param logLevel - The log level of this log.
296
+ * @param message - The message of this log.
297
+ */
298
+ log(logLevel: HttpPipelineLogLevel, message: string): void;
299
+ }
260
300
 
261
301
  export declare interface ClearRange {
262
302
  start: number;
@@ -380,7 +420,7 @@ declare abstract class Credential_2 implements RequestPolicyFactory {
380
420
  * @param _nextPolicy -
381
421
  * @param _options -
382
422
  */
383
- create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
423
+ create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptionsLike): RequestPolicy;
384
424
  }
385
425
  export { Credential_2 as Credential }
386
426
 
@@ -394,25 +434,89 @@ export declare abstract class CredentialPolicy extends BaseRequestPolicy {
394
434
  *
395
435
  * @param request -
396
436
  */
397
- sendRequest(request: WebResource): Promise<HttpOperationResponse>;
437
+ sendRequest(request: WebResourceLike): Promise<CompatResponse>;
398
438
  /**
399
439
  * Child classes must implement this method with request signing. This method
400
440
  * will be executed in {@link sendRequest}.
401
441
  *
402
442
  * @param request -
403
443
  */
404
- protected signRequest(request: WebResource): WebResource;
444
+ protected signRequest(request: WebResourceLike): WebResourceLike;
405
445
  }
406
446
 
407
447
  /**
408
448
  * A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
409
449
  */
410
- export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptions) => CredentialPolicy;
450
+ export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike) => CredentialPolicy;
411
451
 
412
452
  /** Defines values for DeleteSnapshotsOptionType. */
413
453
  export declare type DeleteSnapshotsOptionType = "include" | "include-leased";
414
454
 
415
- export { deserializationPolicy }
455
+ /** Parameter group */
456
+ declare interface DestinationLeaseAccessConditions {
457
+ /** Required if the destination file has an active infinite lease. The lease ID specified for this header must match the lease ID of the destination file. If the request does not include the lease ID or it is not valid, the operation fails with status code 412 (Precondition Failed). If this header is specified and the destination file does not currently have an active lease, the operation will also fail with status code 412 (Precondition Failed). */
458
+ destinationLeaseId?: string;
459
+ }
460
+
461
+ /** Interface representing a Directory. */
462
+ declare interface Directory {
463
+ /**
464
+ * Creates a new directory under the specified share or parent directory.
465
+ * @param fileAttributes If specified, the provided file attributes shall be set. Default value:
466
+ * ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
467
+ * @param options The options parameters.
468
+ */
469
+ create(fileAttributes: string, options?: DirectoryCreateOptionalParams): Promise<DirectoryCreateResponse_2>;
470
+ /**
471
+ * Returns all system properties for the specified directory, and can also be used to check the
472
+ * existence of a directory. The data returned does not include the files in the directory or any
473
+ * subdirectories.
474
+ * @param options The options parameters.
475
+ */
476
+ getProperties(options?: DirectoryGetPropertiesOptionalParams): Promise<DirectoryGetPropertiesResponse_2>;
477
+ /**
478
+ * Removes the specified empty directory. Note that the directory must be empty before it can be
479
+ * deleted.
480
+ * @param options The options parameters.
481
+ */
482
+ delete(options?: DirectoryDeleteOptionalParams): Promise<DirectoryDeleteResponse_2>;
483
+ /**
484
+ * Sets properties on the directory.
485
+ * @param fileAttributes If specified, the provided file attributes shall be set. Default value:
486
+ * ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
487
+ * @param options The options parameters.
488
+ */
489
+ setProperties(fileAttributes: string, options?: DirectorySetPropertiesOptionalParams): Promise<DirectorySetPropertiesResponse_2>;
490
+ /**
491
+ * Updates user defined metadata for the specified directory.
492
+ * @param options The options parameters.
493
+ */
494
+ setMetadata(options?: DirectorySetMetadataOptionalParams): Promise<DirectorySetMetadataResponse_2>;
495
+ /**
496
+ * Returns a list of files or directories under the specified share or directory. It lists the contents
497
+ * only for a single level of the directory hierarchy.
498
+ * @param options The options parameters.
499
+ */
500
+ listFilesAndDirectoriesSegment(options?: DirectoryListFilesAndDirectoriesSegmentOptionalParams): Promise<DirectoryListFilesAndDirectoriesSegmentResponse_2>;
501
+ /**
502
+ * Lists handles for directory.
503
+ * @param options The options parameters.
504
+ */
505
+ listHandles(options?: DirectoryListHandlesOptionalParams): Promise<DirectoryListHandlesResponse_2>;
506
+ /**
507
+ * Closes all handles open for given directory.
508
+ * @param handleId Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is
509
+ * a wildcard that specifies all handles.
510
+ * @param options The options parameters.
511
+ */
512
+ forceCloseHandles(handleId: string, options?: DirectoryForceCloseHandlesOptionalParams): Promise<DirectoryForceCloseHandlesResponse_2>;
513
+ /**
514
+ * Renames a directory
515
+ * @param renameSource Required. Specifies the URI-style path of the source file, up to 2 KB in length.
516
+ * @param options The options parameters.
517
+ */
518
+ rename(renameSource: string, options?: DirectoryRenameOptionalParams): Promise<DirectoryRenameResponse_2>;
519
+ }
416
520
 
417
521
  /**
418
522
  * Additional response header values for close handles request.
@@ -481,6 +585,26 @@ export declare interface DirectoryCreateIfNotExistsResponse extends DirectoryCre
481
585
  succeeded: boolean;
482
586
  }
483
587
 
588
+ /** Optional parameters. */
589
+ declare interface DirectoryCreateOptionalParams extends coreClient.OperationOptions {
590
+ /** 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> */
591
+ timeoutInSeconds?: number;
592
+ /** A name-value pair to associate with a file storage object. */
593
+ metadata?: {
594
+ [propertyName: string]: string;
595
+ };
596
+ /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
597
+ filePermission?: string;
598
+ /** 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. */
599
+ filePermissionKey?: string;
600
+ /** Creation time for the file/directory. Default value: Now. */
601
+ fileCreatedOn?: string;
602
+ /** Last write time for the file/directory. Default value: Now. */
603
+ fileLastWriteOn?: string;
604
+ /** Change time for the file/directory. Default value: Now. */
605
+ fileChangeOn?: string;
606
+ }
607
+
484
608
  /**
485
609
  * Options to configure {@link ShareDirectoryClient.create} operation.
486
610
  */
@@ -497,13 +621,10 @@ export declare interface DirectoryCreateOptions extends FileAndDirectoryCreateCo
497
621
  }
498
622
 
499
623
  /** Contains response data for the create operation. */
500
- export declare type DirectoryCreateResponse = DirectoryCreateHeaders & {
501
- /** The underlying HTTP response. */
502
- _response: coreHttp.HttpResponse & {
503
- /** The parsed HTTP response headers. */
504
- parsedHeaders: DirectoryCreateHeaders;
505
- };
506
- };
624
+ export declare type DirectoryCreateResponse = WithResponse<DirectoryCreateHeaders, DirectoryCreateHeaders>;
625
+
626
+ /** Contains response data for the create operation. */
627
+ declare type DirectoryCreateResponse_2 = DirectoryCreateHeaders;
507
628
 
508
629
  /** Defines headers for Directory_delete operation. */
509
630
  export declare interface DirectoryDeleteHeaders {
@@ -527,6 +648,12 @@ export declare interface DirectoryDeleteIfExistsResponse extends DirectoryDelete
527
648
  succeeded: boolean;
528
649
  }
529
650
 
651
+ /** Optional parameters. */
652
+ declare interface DirectoryDeleteOptionalParams extends coreClient.OperationOptions {
653
+ /** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
654
+ timeoutInSeconds?: number;
655
+ }
656
+
530
657
  /**
531
658
  * Options to configure the {@link ShareDirectoryClient.delete} operation.
532
659
  */
@@ -539,13 +666,10 @@ export declare interface DirectoryDeleteOptions extends CommonOptions {
539
666
  }
540
667
 
541
668
  /** Contains response data for the delete operation. */
542
- export declare type DirectoryDeleteResponse = DirectoryDeleteHeaders & {
543
- /** The underlying HTTP response. */
544
- _response: coreHttp.HttpResponse & {
545
- /** The parsed HTTP response headers. */
546
- parsedHeaders: DirectoryDeleteHeaders;
547
- };
548
- };
669
+ export declare type DirectoryDeleteResponse = WithResponse<DirectoryDeleteHeaders, DirectoryDeleteHeaders>;
670
+
671
+ /** Contains response data for the delete operation. */
672
+ declare type DirectoryDeleteResponse_2 = DirectoryDeleteHeaders;
549
673
 
550
674
  /**
551
675
  * Options to configure the {@link ShareDirectoryClient.exists} operation.
@@ -576,6 +700,18 @@ export declare interface DirectoryForceCloseHandlesHeaders {
576
700
  errorCode?: string;
577
701
  }
578
702
 
703
+ /** Optional parameters. */
704
+ declare interface DirectoryForceCloseHandlesOptionalParams extends coreClient.OperationOptions {
705
+ /** 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> */
706
+ timeoutInSeconds?: number;
707
+ /** 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. */
708
+ marker?: string;
709
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
710
+ shareSnapshot?: string;
711
+ /** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
712
+ recursive?: boolean;
713
+ }
714
+
579
715
  /**
580
716
  * Options to configure {@link ShareDirectoryClient.forceCloseHandle}.
581
717
  */
@@ -590,17 +726,10 @@ export declare interface DirectoryForceCloseHandlesOptions extends CommonOptions
590
726
  /**
591
727
  * Response type for {@link ShareDirectoryClient.forceCloseHandle}.
592
728
  */
593
- export declare type DirectoryForceCloseHandlesResponse = CloseHandlesInfo & DirectoryCloseHandlesHeaders & {
594
- /**
595
- * The underlying HTTP response.
596
- */
597
- _response: HttpResponse & {
598
- /**
599
- * The parsed HTTP response headers.
600
- */
601
- parsedHeaders: DirectoryForceCloseHandlesHeaders;
602
- };
603
- };
729
+ export declare type DirectoryForceCloseHandlesResponse = WithResponse<CloseHandlesInfo & DirectoryCloseHandlesHeaders, DirectoryForceCloseHandlesHeaders>;
730
+
731
+ /** Contains response data for the forceCloseHandles operation. */
732
+ declare type DirectoryForceCloseHandlesResponse_2 = DirectoryForceCloseHandlesHeaders;
604
733
 
605
734
  /**
606
735
  * Options to configure Directory - Force Close Handles Segment operations.
@@ -658,6 +787,14 @@ export declare interface DirectoryGetPropertiesHeaders {
658
787
  errorCode?: string;
659
788
  }
660
789
 
790
+ /** Optional parameters. */
791
+ declare interface DirectoryGetPropertiesOptionalParams extends coreClient.OperationOptions {
792
+ /** 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> */
793
+ timeoutInSeconds?: number;
794
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
795
+ shareSnapshot?: string;
796
+ }
797
+
661
798
  /**
662
799
  * Options to configure the {@link ShareDirectoryClient.getProperties} operation.
663
800
  */
@@ -670,13 +807,10 @@ export declare interface DirectoryGetPropertiesOptions extends CommonOptions {
670
807
  }
671
808
 
672
809
  /** Contains response data for the getProperties operation. */
673
- export declare type DirectoryGetPropertiesResponse = DirectoryGetPropertiesHeaders & {
674
- /** The underlying HTTP response. */
675
- _response: coreHttp.HttpResponse & {
676
- /** The parsed HTTP response headers. */
677
- parsedHeaders: DirectoryGetPropertiesHeaders;
678
- };
679
- };
810
+ export declare type DirectoryGetPropertiesResponse = WithResponse<DirectoryGetPropertiesHeaders, DirectoryGetPropertiesHeaders>;
811
+
812
+ /** Contains response data for the getProperties operation. */
813
+ declare type DirectoryGetPropertiesResponse_2 = DirectoryGetPropertiesHeaders;
680
814
 
681
815
  /** A listed directory item. */
682
816
  export declare interface DirectoryItem {
@@ -727,18 +861,29 @@ export declare interface DirectoryListFilesAndDirectoriesSegmentHeaders {
727
861
  errorCode?: string;
728
862
  }
729
863
 
864
+ /** Optional parameters. */
865
+ declare interface DirectoryListFilesAndDirectoriesSegmentOptionalParams extends coreClient.OperationOptions {
866
+ /** 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> */
867
+ timeoutInSeconds?: number;
868
+ /** Filters the results to return only entries whose name begins with the specified prefix. */
869
+ prefix?: string;
870
+ /** 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. */
871
+ marker?: string;
872
+ /** 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. */
873
+ maxResults?: number;
874
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
875
+ shareSnapshot?: string;
876
+ /** Include this parameter to specify one or more datasets to include in the response. */
877
+ include?: ListFilesIncludeType[];
878
+ /** Include extended information. */
879
+ includeExtendedInfo?: boolean;
880
+ }
881
+
730
882
  /** Contains response data for the listFilesAndDirectoriesSegment operation. */
731
- export declare type DirectoryListFilesAndDirectoriesSegmentResponse = DirectoryListFilesAndDirectoriesSegmentHeaders & ListFilesAndDirectoriesSegmentResponse & {
732
- /** The underlying HTTP response. */
733
- _response: coreHttp.HttpResponse & {
734
- /** The response body as text (string format) */
735
- bodyAsText: string;
736
- /** The response body as parsed JSON or XML */
737
- parsedBody: ListFilesAndDirectoriesSegmentResponse;
738
- /** The parsed HTTP response headers. */
739
- parsedHeaders: DirectoryListFilesAndDirectoriesSegmentHeaders;
740
- };
741
- };
883
+ export declare type DirectoryListFilesAndDirectoriesSegmentResponse = WithResponse<DirectoryListFilesAndDirectoriesSegmentHeaders & ListFilesAndDirectoriesSegmentResponse, DirectoryListFilesAndDirectoriesSegmentHeaders, ListFilesAndDirectoriesSegmentResponse>;
884
+
885
+ /** Contains response data for the listFilesAndDirectoriesSegment operation. */
886
+ declare type DirectoryListFilesAndDirectoriesSegmentResponse_2 = DirectoryListFilesAndDirectoriesSegmentHeaders & ListFilesAndDirectoriesSegmentResponse;
742
887
 
743
888
  /** Defines headers for Directory_listHandles operation. */
744
889
  export declare interface DirectoryListHandlesHeaders {
@@ -754,6 +899,20 @@ export declare interface DirectoryListHandlesHeaders {
754
899
  errorCode?: string;
755
900
  }
756
901
 
902
+ /** Optional parameters. */
903
+ declare interface DirectoryListHandlesOptionalParams extends coreClient.OperationOptions {
904
+ /** 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> */
905
+ timeoutInSeconds?: number;
906
+ /** 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. */
907
+ marker?: string;
908
+ /** 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. */
909
+ maxResults?: number;
910
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
911
+ shareSnapshot?: string;
912
+ /** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
913
+ recursive?: boolean;
914
+ }
915
+
757
916
  /**
758
917
  * Options to configure the {@link ShareDirectoryClient.listHandles} operation.
759
918
  */
@@ -771,17 +930,10 @@ export declare interface DirectoryListHandlesOptions extends CommonOptions {
771
930
  }
772
931
 
773
932
  /** Contains response data for the listHandles operation. */
774
- export declare type DirectoryListHandlesResponse = DirectoryListHandlesHeaders & ListHandlesResponse & {
775
- /** The underlying HTTP response. */
776
- _response: coreHttp.HttpResponse & {
777
- /** The response body as text (string format) */
778
- bodyAsText: string;
779
- /** The response body as parsed JSON or XML */
780
- parsedBody: ListHandlesResponse;
781
- /** The parsed HTTP response headers. */
782
- parsedHeaders: DirectoryListHandlesHeaders;
783
- };
784
- };
933
+ export declare type DirectoryListHandlesResponse = WithResponse<DirectoryListHandlesHeaders & ListHandlesResponse, DirectoryListHandlesHeaders, ListHandlesResponse>;
934
+
935
+ /** Contains response data for the listHandles operation. */
936
+ declare type DirectoryListHandlesResponse_2 = DirectoryListHandlesHeaders & ListHandlesResponse;
785
937
 
786
938
  /**
787
939
  * Options to configure Directory - List Handles Segment operations.
@@ -848,6 +1000,30 @@ export declare interface DirectoryRenameHeaders {
848
1000
  fileParentId?: string;
849
1001
  }
850
1002
 
1003
+ /** Optional parameters. */
1004
+ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOptions {
1005
+ /** Parameter group */
1006
+ sourceLeaseAccessConditions?: SourceLeaseAccessConditions;
1007
+ /** Parameter group */
1008
+ destinationLeaseAccessConditions?: DestinationLeaseAccessConditions;
1009
+ /** Parameter group */
1010
+ copyFileSmbInfo?: CopyFileSmbInfo;
1011
+ /** 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> */
1012
+ timeoutInSeconds?: number;
1013
+ /** A name-value pair to associate with a file storage object. */
1014
+ metadata?: {
1015
+ [propertyName: string]: string;
1016
+ };
1017
+ /** 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. */
1018
+ filePermission?: string;
1019
+ /** 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. */
1020
+ filePermissionKey?: string;
1021
+ /** Optional. A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value. */
1022
+ replaceIfExists?: boolean;
1023
+ /** Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail. */
1024
+ ignoreReadOnly?: boolean;
1025
+ }
1026
+
851
1027
  /**
852
1028
  * Options to configure the {@link ShareDirectoryClient.rename} operation.
853
1029
  */
@@ -903,13 +1079,10 @@ export declare interface DirectoryRenameOptions extends CommonOptions {
903
1079
  }
904
1080
 
905
1081
  /** Contains response data for the rename operation. */
906
- export declare type DirectoryRenameResponse = DirectoryRenameHeaders & {
907
- /** The underlying HTTP response. */
908
- _response: coreHttp.HttpResponse & {
909
- /** The parsed HTTP response headers. */
910
- parsedHeaders: DirectoryRenameHeaders;
911
- };
912
- };
1082
+ export declare type DirectoryRenameResponse = WithResponse<DirectoryRenameHeaders, DirectoryRenameHeaders>;
1083
+
1084
+ /** Contains response data for the rename operation. */
1085
+ declare type DirectoryRenameResponse_2 = DirectoryRenameHeaders;
913
1086
 
914
1087
  /** Defines headers for Directory_setMetadata operation. */
915
1088
  export declare interface DirectorySetMetadataHeaders {
@@ -927,6 +1100,16 @@ export declare interface DirectorySetMetadataHeaders {
927
1100
  errorCode?: string;
928
1101
  }
929
1102
 
1103
+ /** Optional parameters. */
1104
+ declare interface DirectorySetMetadataOptionalParams extends coreClient.OperationOptions {
1105
+ /** 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> */
1106
+ timeoutInSeconds?: number;
1107
+ /** A name-value pair to associate with a file storage object. */
1108
+ metadata?: {
1109
+ [propertyName: string]: string;
1110
+ };
1111
+ }
1112
+
930
1113
  /**
931
1114
  * Options to configure the {@link ShareDirectoryClient.setMetadata} operation.
932
1115
  */
@@ -939,13 +1122,10 @@ export declare interface DirectorySetMetadataOptions extends CommonOptions {
939
1122
  }
940
1123
 
941
1124
  /** Contains response data for the setMetadata operation. */
942
- export declare type DirectorySetMetadataResponse = DirectorySetMetadataHeaders & {
943
- /** The underlying HTTP response. */
944
- _response: coreHttp.HttpResponse & {
945
- /** The parsed HTTP response headers. */
946
- parsedHeaders: DirectorySetMetadataHeaders;
947
- };
948
- };
1125
+ export declare type DirectorySetMetadataResponse = WithResponse<DirectorySetMetadataHeaders, DirectorySetMetadataHeaders>;
1126
+
1127
+ /** Contains response data for the setMetadata operation. */
1128
+ declare type DirectorySetMetadataResponse_2 = DirectorySetMetadataHeaders;
949
1129
 
950
1130
  /** Defines headers for Directory_setProperties operation. */
951
1131
  export declare interface DirectorySetPropertiesHeaders {
@@ -979,14 +1159,166 @@ export declare interface DirectorySetPropertiesHeaders {
979
1159
  errorCode?: string;
980
1160
  }
981
1161
 
1162
+ /** Optional parameters. */
1163
+ declare interface DirectorySetPropertiesOptionalParams extends coreClient.OperationOptions {
1164
+ /** 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> */
1165
+ timeoutInSeconds?: number;
1166
+ /** 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. */
1167
+ filePermission?: string;
1168
+ /** 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. */
1169
+ filePermissionKey?: string;
1170
+ /** Creation time for the file/directory. Default value: Now. */
1171
+ fileCreatedOn?: string;
1172
+ /** Last write time for the file/directory. Default value: Now. */
1173
+ fileLastWriteOn?: string;
1174
+ /** Change time for the file/directory. Default value: Now. */
1175
+ fileChangeOn?: string;
1176
+ }
1177
+
982
1178
  /** Contains response data for the setProperties operation. */
983
- export declare type DirectorySetPropertiesResponse = DirectorySetPropertiesHeaders & {
984
- /** The underlying HTTP response. */
985
- _response: coreHttp.HttpResponse & {
986
- /** The parsed HTTP response headers. */
987
- parsedHeaders: DirectorySetPropertiesHeaders;
988
- };
989
- };
1179
+ export declare type DirectorySetPropertiesResponse = WithResponse<DirectorySetPropertiesHeaders, DirectorySetPropertiesHeaders>;
1180
+
1181
+ /** Contains response data for the setProperties operation. */
1182
+ declare type DirectorySetPropertiesResponse_2 = DirectorySetPropertiesHeaders;
1183
+
1184
+ /** Interface representing a File. */
1185
+ declare interface File_2 {
1186
+ /**
1187
+ * Creates a new file or replaces a file. Note it only initializes the file with no content.
1188
+ * @param fileContentLength Specifies the maximum size for the file, up to 4 TB.
1189
+ * @param fileAttributes If specified, the provided file attributes shall be set. Default value:
1190
+ * ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
1191
+ * @param options The options parameters.
1192
+ */
1193
+ create(fileContentLength: number, fileAttributes: string, options?: FileCreateOptionalParams): Promise<FileCreateResponse_2>;
1194
+ /**
1195
+ * Reads or downloads a file from the system, including its metadata and properties.
1196
+ * @param options The options parameters.
1197
+ */
1198
+ download(options?: FileDownloadOptionalParams): Promise<RawFileDownloadResponse>;
1199
+ /**
1200
+ * Returns all user-defined metadata, standard HTTP properties, and system properties for the file. It
1201
+ * does not return the content of the file.
1202
+ * @param options The options parameters.
1203
+ */
1204
+ getProperties(options?: FileGetPropertiesOptionalParams): Promise<FileGetPropertiesResponse_2>;
1205
+ /**
1206
+ * removes the file from the storage account.
1207
+ * @param options The options parameters.
1208
+ */
1209
+ delete(options?: FileDeleteOptionalParams): Promise<FileDeleteResponse_2>;
1210
+ /**
1211
+ * Sets HTTP headers on the file.
1212
+ * @param fileAttributes If specified, the provided file attributes shall be set. Default value:
1213
+ * ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
1214
+ * @param options The options parameters.
1215
+ */
1216
+ setHttpHeaders(fileAttributes: string, options?: FileSetHttpHeadersOptionalParams): Promise<FileSetHttpHeadersResponse>;
1217
+ /**
1218
+ * Updates user-defined metadata for the specified file.
1219
+ * @param options The options parameters.
1220
+ */
1221
+ setMetadata(options?: FileSetMetadataOptionalParams): Promise<FileSetMetadataResponse_2>;
1222
+ /**
1223
+ * [Update] The Lease File operation establishes and manages a lock on a file for write and delete
1224
+ * operations
1225
+ * @param options The options parameters.
1226
+ */
1227
+ acquireLease(options?: FileAcquireLeaseOptionalParams): Promise<FileAcquireLeaseResponse>;
1228
+ /**
1229
+ * [Update] The Lease File operation establishes and manages a lock on a file for write and delete
1230
+ * operations
1231
+ * @param leaseId Specifies the current lease ID on the resource.
1232
+ * @param options The options parameters.
1233
+ */
1234
+ releaseLease(leaseId: string, options?: FileReleaseLeaseOptionalParams): Promise<FileReleaseLeaseResponse>;
1235
+ /**
1236
+ * [Update] The Lease File operation establishes and manages a lock on a file for write and delete
1237
+ * operations
1238
+ * @param leaseId Specifies the current lease ID on the resource.
1239
+ * @param options The options parameters.
1240
+ */
1241
+ changeLease(leaseId: string, options?: FileChangeLeaseOptionalParams): Promise<FileChangeLeaseResponse>;
1242
+ /**
1243
+ * [Update] The Lease File operation establishes and manages a lock on a file for write and delete
1244
+ * operations
1245
+ * @param options The options parameters.
1246
+ */
1247
+ breakLease(options?: FileBreakLeaseOptionalParams): Promise<FileBreakLeaseResponse>;
1248
+ /**
1249
+ * Upload a range of bytes to a file.
1250
+ * @param range Specifies the range of bytes to be written. Both the start and end of the range must be
1251
+ * specified. For an update operation, the range can be up to 4 MB in size. For a clear operation, the
1252
+ * range can be up to the value of the file's full size. The File service accepts only a single byte
1253
+ * range for the Range and 'x-ms-range' headers, and the byte range must be specified in the following
1254
+ * format: bytes=startByte-endByte.
1255
+ * @param fileRangeWrite Specify one of the following options: - Update: Writes the bytes specified by
1256
+ * the request body into the specified range. The Range and Content-Length headers must match to
1257
+ * perform the update. - Clear: Clears the specified range and releases the space used in storage for
1258
+ * that range. To clear a range, set the Content-Length header to zero, and set the Range header to a
1259
+ * value that indicates the range to clear, up to maximum file size.
1260
+ * @param contentLength Specifies the number of bytes being transmitted in the request body. When the
1261
+ * x-ms-write header is set to clear, the value of this header must be set to zero.
1262
+ * @param options The options parameters.
1263
+ */
1264
+ uploadRange(range: string, fileRangeWrite: FileRangeWriteType, contentLength: number, options?: FileUploadRangeOptionalParams): Promise<FileUploadRangeResponse_2>;
1265
+ /**
1266
+ * Upload a range of bytes to a file where the contents are read from a URL.
1267
+ * @param range Writes data to the specified byte range in the file.
1268
+ * @param copySource Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file
1269
+ * to another file within the same storage account, you may use Shared Key to authenticate the source
1270
+ * file. If you are copying a file from another storage account, or if you are copying a blob from the
1271
+ * same storage account or another storage account, then you must authenticate the source file or blob
1272
+ * using a shared access signature. If the source is a public blob, no authentication is required to
1273
+ * perform the copy operation. A file in a share snapshot can also be specified as a copy source.
1274
+ * @param contentLength Specifies the number of bytes being transmitted in the request body. When the
1275
+ * x-ms-write header is set to clear, the value of this header must be set to zero.
1276
+ * @param options The options parameters.
1277
+ */
1278
+ uploadRangeFromURL(range: string, copySource: string, contentLength: number, options?: FileUploadRangeFromURLOptionalParams): Promise<FileUploadRangeFromURLResponse_2>;
1279
+ /**
1280
+ * Returns the list of valid ranges for a file.
1281
+ * @param options The options parameters.
1282
+ */
1283
+ getRangeList(options?: FileGetRangeListOptionalParams): Promise<FileGetRangeListResponse_2>;
1284
+ /**
1285
+ * Copies a blob or file to a destination file within the storage account.
1286
+ * @param copySource Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file
1287
+ * to another file within the same storage account, you may use Shared Key to authenticate the source
1288
+ * file. If you are copying a file from another storage account, or if you are copying a blob from the
1289
+ * same storage account or another storage account, then you must authenticate the source file or blob
1290
+ * using a shared access signature. If the source is a public blob, no authentication is required to
1291
+ * perform the copy operation. A file in a share snapshot can also be specified as a copy source.
1292
+ * @param options The options parameters.
1293
+ */
1294
+ startCopy(copySource: string, options?: FileStartCopyOptionalParams): Promise<FileStartCopyResponse_2>;
1295
+ /**
1296
+ * Aborts a pending Copy File operation, and leaves a destination file with zero length and full
1297
+ * metadata.
1298
+ * @param copyId The copy identifier provided in the x-ms-copy-id header of the original Copy File
1299
+ * operation.
1300
+ * @param options The options parameters.
1301
+ */
1302
+ abortCopy(copyId: string, options?: FileAbortCopyOptionalParams): Promise<FileAbortCopyResponse_2>;
1303
+ /**
1304
+ * Lists handles for file
1305
+ * @param options The options parameters.
1306
+ */
1307
+ listHandles(options?: FileListHandlesOptionalParams): Promise<FileListHandlesResponse_2>;
1308
+ /**
1309
+ * Closes all handles open for given file
1310
+ * @param handleId Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is
1311
+ * a wildcard that specifies all handles.
1312
+ * @param options The options parameters.
1313
+ */
1314
+ forceCloseHandles(handleId: string, options?: FileForceCloseHandlesOptionalParams): Promise<FileForceCloseHandlesResponse_2>;
1315
+ /**
1316
+ * Renames a file
1317
+ * @param renameSource Required. Specifies the URI-style path of the source file, up to 2 KB in length.
1318
+ * @param options The options parameters.
1319
+ */
1320
+ rename(renameSource: string, options?: FileRenameOptionalParams): Promise<FileRenameResponse_2>;
1321
+ }
990
1322
 
991
1323
  /**
992
1324
  * Options to configure the {@link ShareFileClient.abortCopyFromURL} operation.
@@ -1015,14 +1347,52 @@ export declare interface FileAbortCopyHeaders {
1015
1347
  errorCode?: string;
1016
1348
  }
1017
1349
 
1350
+ /** Optional parameters. */
1351
+ declare interface FileAbortCopyOptionalParams extends coreClient.OperationOptions {
1352
+ /** Parameter group */
1353
+ leaseAccessConditions?: LeaseAccessConditions;
1354
+ /** 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> */
1355
+ timeoutInSeconds?: number;
1356
+ }
1357
+
1018
1358
  /** Contains response data for the abortCopy operation. */
1019
- export declare type FileAbortCopyResponse = FileAbortCopyHeaders & {
1020
- /** The underlying HTTP response. */
1021
- _response: coreHttp.HttpResponse & {
1022
- /** The parsed HTTP response headers. */
1023
- parsedHeaders: FileAbortCopyHeaders;
1024
- };
1025
- };
1359
+ export declare type FileAbortCopyResponse = WithResponse<FileAbortCopyHeaders, FileAbortCopyHeaders>;
1360
+
1361
+ /** Contains response data for the abortCopy operation. */
1362
+ declare type FileAbortCopyResponse_2 = FileAbortCopyHeaders;
1363
+
1364
+ /** Defines headers for File_acquireLease operation. */
1365
+ declare interface FileAcquireLeaseHeaders {
1366
+ /** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
1367
+ etag?: string;
1368
+ /** Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file. */
1369
+ lastModified?: Date;
1370
+ /** Uniquely identifies a file's lease */
1371
+ leaseId?: string;
1372
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
1373
+ clientRequestId?: string;
1374
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
1375
+ requestId?: string;
1376
+ /** Indicates the version of the File service used to execute the request. */
1377
+ version?: string;
1378
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
1379
+ date?: Date;
1380
+ }
1381
+
1382
+ /** Optional parameters. */
1383
+ declare interface FileAcquireLeaseOptionalParams extends coreClient.OperationOptions {
1384
+ /** 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> */
1385
+ timeoutInSeconds?: number;
1386
+ /** 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. */
1387
+ duration?: number;
1388
+ /** 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. */
1389
+ proposedLeaseId?: string;
1390
+ /** 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. */
1391
+ requestId?: string;
1392
+ }
1393
+
1394
+ /** Contains response data for the acquireLease operation. */
1395
+ declare type FileAcquireLeaseResponse = FileAcquireLeaseHeaders;
1026
1396
 
1027
1397
  export declare interface FileAndDirectoryCreateCommonOptions {
1028
1398
  /**
@@ -1112,29 +1482,91 @@ export declare interface FileAndDirectorySetPropertiesCommonOptions {
1112
1482
  */
1113
1483
  export declare type FileAttributesPreserveType = "preserve";
1114
1484
 
1115
- /**
1116
- * Options to configure the {@link ShareFileClient.clearRange} operation.
1117
- */
1118
- export declare interface FileClearRangeOptions extends CommonOptions {
1119
- /**
1120
- * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1121
- * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1122
- */
1123
- abortSignal?: AbortSignalLike;
1124
- /**
1125
- * Lease access conditions.
1126
- */
1127
- leaseAccessConditions?: LeaseAccessConditions;
1128
- /**
1129
- * The last write time for the file.
1130
- * A value of preserve may be passed to keep an existing value unchanged.
1131
- * A value of now may be used to indicate the time of the request.
1132
- * By default, the value will be set as now.
1133
- */
1134
- fileLastWrittenMode?: FileLastWrittenMode;
1135
- }
1136
-
1137
- /**
1485
+ /** Defines headers for File_breakLease operation. */
1486
+ declare interface FileBreakLeaseHeaders {
1487
+ /** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
1488
+ etag?: string;
1489
+ /** Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file. */
1490
+ lastModified?: Date;
1491
+ /** Uniquely identifies a file's lease */
1492
+ leaseId?: string;
1493
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
1494
+ clientRequestId?: string;
1495
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
1496
+ requestId?: string;
1497
+ /** Indicates the version of the File service used to execute the request. */
1498
+ version?: string;
1499
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
1500
+ date?: Date;
1501
+ }
1502
+
1503
+ /** Optional parameters. */
1504
+ declare interface FileBreakLeaseOptionalParams extends coreClient.OperationOptions {
1505
+ /** Parameter group */
1506
+ leaseAccessConditions?: LeaseAccessConditions;
1507
+ /** 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> */
1508
+ timeoutInSeconds?: number;
1509
+ /** 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. */
1510
+ requestId?: string;
1511
+ }
1512
+
1513
+ /** Contains response data for the breakLease operation. */
1514
+ declare type FileBreakLeaseResponse = FileBreakLeaseHeaders;
1515
+
1516
+ /** Defines headers for File_changeLease operation. */
1517
+ declare interface FileChangeLeaseHeaders {
1518
+ /** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
1519
+ etag?: string;
1520
+ /** Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file. */
1521
+ lastModified?: Date;
1522
+ /** Uniquely identifies a file's lease */
1523
+ leaseId?: string;
1524
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
1525
+ clientRequestId?: string;
1526
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
1527
+ requestId?: string;
1528
+ /** Indicates the version of the File service used to execute the request. */
1529
+ version?: string;
1530
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
1531
+ date?: Date;
1532
+ }
1533
+
1534
+ /** Optional parameters. */
1535
+ declare interface FileChangeLeaseOptionalParams extends coreClient.OperationOptions {
1536
+ /** 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> */
1537
+ timeoutInSeconds?: number;
1538
+ /** 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. */
1539
+ proposedLeaseId?: string;
1540
+ /** 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. */
1541
+ requestId?: string;
1542
+ }
1543
+
1544
+ /** Contains response data for the changeLease operation. */
1545
+ declare type FileChangeLeaseResponse = FileChangeLeaseHeaders;
1546
+
1547
+ /**
1548
+ * Options to configure the {@link ShareFileClient.clearRange} operation.
1549
+ */
1550
+ export declare interface FileClearRangeOptions extends CommonOptions {
1551
+ /**
1552
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1553
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1554
+ */
1555
+ abortSignal?: AbortSignalLike;
1556
+ /**
1557
+ * Lease access conditions.
1558
+ */
1559
+ leaseAccessConditions?: LeaseAccessConditions;
1560
+ /**
1561
+ * The last write time for the file.
1562
+ * A value of preserve may be passed to keep an existing value unchanged.
1563
+ * A value of now may be used to indicate the time of the request.
1564
+ * By default, the value will be set as now.
1565
+ */
1566
+ fileLastWrittenMode?: FileLastWrittenMode;
1567
+ }
1568
+
1569
+ /**
1138
1570
  * Additional response header values for close handles request.
1139
1571
  */
1140
1572
  export declare interface FileCloseHandlesHeaders {
@@ -1191,6 +1623,30 @@ export declare interface FileCreateHeaders {
1191
1623
  errorCode?: string;
1192
1624
  }
1193
1625
 
1626
+ /** Optional parameters. */
1627
+ declare interface FileCreateOptionalParams extends coreClient.OperationOptions {
1628
+ /** Parameter group */
1629
+ leaseAccessConditions?: LeaseAccessConditions;
1630
+ /** Parameter group */
1631
+ fileHttpHeaders?: FileHttpHeaders_2;
1632
+ /** 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> */
1633
+ timeoutInSeconds?: number;
1634
+ /** A name-value pair to associate with a file storage object. */
1635
+ metadata?: {
1636
+ [propertyName: string]: string;
1637
+ };
1638
+ /** 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. */
1639
+ filePermission?: string;
1640
+ /** 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. */
1641
+ filePermissionKey?: string;
1642
+ /** Creation time for the file/directory. Default value: Now. */
1643
+ fileCreatedOn?: string;
1644
+ /** Last write time for the file/directory. Default value: Now. */
1645
+ fileLastWriteOn?: string;
1646
+ /** Change time for the file/directory. Default value: Now. */
1647
+ fileChangeOn?: string;
1648
+ }
1649
+
1194
1650
  /**
1195
1651
  * Options to configure the {@link ShareFileClient.create} operation.
1196
1652
  */
@@ -1215,13 +1671,10 @@ export declare interface FileCreateOptions extends FileAndDirectoryCreateCommonO
1215
1671
  }
1216
1672
 
1217
1673
  /** Contains response data for the create operation. */
1218
- export declare type FileCreateResponse = FileCreateHeaders & {
1219
- /** The underlying HTTP response. */
1220
- _response: coreHttp.HttpResponse & {
1221
- /** The parsed HTTP response headers. */
1222
- parsedHeaders: FileCreateHeaders;
1223
- };
1224
- };
1674
+ export declare type FileCreateResponse = WithResponse<FileCreateHeaders, FileCreateHeaders>;
1675
+
1676
+ /** Contains response data for the create operation. */
1677
+ declare type FileCreateResponse_2 = FileCreateHeaders;
1225
1678
 
1226
1679
  /** Defines headers for File_delete operation. */
1227
1680
  export declare interface FileDeleteHeaders {
@@ -1245,6 +1698,14 @@ export declare interface FileDeleteIfExistsResponse extends FileDeleteResponse {
1245
1698
  succeeded: boolean;
1246
1699
  }
1247
1700
 
1701
+ /** Optional parameters. */
1702
+ declare interface FileDeleteOptionalParams extends coreClient.OperationOptions {
1703
+ /** Parameter group */
1704
+ leaseAccessConditions?: LeaseAccessConditions;
1705
+ /** 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> */
1706
+ timeoutInSeconds?: number;
1707
+ }
1708
+
1248
1709
  /**
1249
1710
  * Options to configure the {@link ShareFileClient.delete} operation.
1250
1711
  */
@@ -1261,13 +1722,10 @@ export declare interface FileDeleteOptions extends CommonOptions {
1261
1722
  }
1262
1723
 
1263
1724
  /** Contains response data for the delete operation. */
1264
- export declare type FileDeleteResponse = FileDeleteHeaders & {
1265
- /** The underlying HTTP response. */
1266
- _response: coreHttp.HttpResponse & {
1267
- /** The parsed HTTP response headers. */
1268
- parsedHeaders: FileDeleteHeaders;
1269
- };
1270
- };
1725
+ export declare type FileDeleteResponse = WithResponse<FileDeleteHeaders, FileDeleteHeaders>;
1726
+
1727
+ /** Contains response data for the delete operation. */
1728
+ declare type FileDeleteResponse_2 = FileDeleteHeaders;
1271
1729
 
1272
1730
  /** Defines headers for File_download operation. */
1273
1731
  export declare interface FileDownloadHeaders {
@@ -1344,15 +1802,11 @@ export declare interface FileDownloadHeaders {
1344
1802
  }
1345
1803
 
1346
1804
  /** Optional parameters. */
1347
- export declare interface FileDownloadOptionalParams extends coreHttp.OperationOptions {
1805
+ export declare interface FileDownloadOptionalParams extends coreClient.OperationOptions {
1348
1806
  /** Parameter group */
1349
1807
  leaseAccessConditions?: LeaseAccessConditions;
1350
1808
  /** 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> */
1351
1809
  timeoutInSeconds?: number;
1352
- /** Valid value is backup */
1353
- fileRequestIntent?: ShareTokenIntent;
1354
- /** If true, the trailing dot will not be trimmed from the target URI. */
1355
- allowTrailingDot?: boolean;
1356
1810
  /** Return file data only from the specified byte range. */
1357
1811
  range?: string;
1358
1812
  /** When this header is set to true and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size. */
@@ -1402,27 +1856,7 @@ export declare interface FileDownloadOptions extends CommonOptions {
1402
1856
  }
1403
1857
 
1404
1858
  /** Contains response data for the download operation. */
1405
- export declare type FileDownloadResponseModel = FileDownloadHeaders & {
1406
- /**
1407
- * BROWSER ONLY
1408
- *
1409
- * The response body as a browser Blob.
1410
- * Always `undefined` in node.js.
1411
- */
1412
- blobBody?: Promise<Blob>;
1413
- /**
1414
- * NODEJS ONLY
1415
- *
1416
- * The response body as a node.js Readable stream.
1417
- * Always `undefined` in the browser.
1418
- */
1419
- readableStreamBody?: NodeJS.ReadableStream;
1420
- /** The underlying HTTP response. */
1421
- _response: coreHttp.HttpResponse & {
1422
- /** The parsed HTTP response headers. */
1423
- parsedHeaders: FileDownloadHeaders;
1424
- };
1425
- };
1859
+ export declare type FileDownloadResponseModel = WithResponse<RawFileDownloadResponse, FileDownloadHeaders>;
1426
1860
 
1427
1861
  /**
1428
1862
  * Option interface for the {@link ShareFileClient.downloadToBuffer} operation.
@@ -1498,6 +1932,16 @@ export declare interface FileForceCloseHandlesHeaders {
1498
1932
  errorCode?: string;
1499
1933
  }
1500
1934
 
1935
+ /** Optional parameters. */
1936
+ declare interface FileForceCloseHandlesOptionalParams extends coreClient.OperationOptions {
1937
+ /** 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> */
1938
+ timeoutInSeconds?: number;
1939
+ /** 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. */
1940
+ marker?: string;
1941
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
1942
+ shareSnapshot?: string;
1943
+ }
1944
+
1501
1945
  /**
1502
1946
  * Options to configure File - Force Close Handles operations.
1503
1947
  *
@@ -1517,17 +1961,10 @@ export declare interface FileForceCloseHandlesOptions extends CommonOptions {
1517
1961
  /**
1518
1962
  * Response type for {@link ShareFileClient.forceCloseHandle}.
1519
1963
  */
1520
- export declare type FileForceCloseHandlesResponse = CloseHandlesInfo & FileCloseHandlesHeaders & {
1521
- /**
1522
- * The underlying HTTP response.
1523
- */
1524
- _response: HttpResponse & {
1525
- /**
1526
- * The parsed HTTP response headers.
1527
- */
1528
- parsedHeaders: FileForceCloseHandlesHeaders;
1529
- };
1530
- };
1964
+ export declare type FileForceCloseHandlesResponse = WithResponse<CloseHandlesInfo & FileCloseHandlesHeaders, FileForceCloseHandlesHeaders>;
1965
+
1966
+ /** Contains response data for the forceCloseHandles operation. */
1967
+ declare type FileForceCloseHandlesResponse_2 = FileForceCloseHandlesHeaders;
1531
1968
 
1532
1969
  /**
1533
1970
  * Options to configure {@link ShareFileClient.generateSasUrl} operation.
@@ -1609,6 +2046,16 @@ export declare interface FileGetPropertiesHeaders {
1609
2046
  errorCode?: string;
1610
2047
  }
1611
2048
 
2049
+ /** Optional parameters. */
2050
+ declare interface FileGetPropertiesOptionalParams extends coreClient.OperationOptions {
2051
+ /** Parameter group */
2052
+ leaseAccessConditions?: LeaseAccessConditions;
2053
+ /** 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> */
2054
+ timeoutInSeconds?: number;
2055
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2056
+ shareSnapshot?: string;
2057
+ }
2058
+
1612
2059
  /**
1613
2060
  * Options to configure the {@link ShareFileClient.getProperties} operation.
1614
2061
  */
@@ -1625,26 +2072,13 @@ export declare interface FileGetPropertiesOptions extends CommonOptions {
1625
2072
  }
1626
2073
 
1627
2074
  /** Contains response data for the getProperties operation. */
1628
- export declare type FileGetPropertiesResponse = FileGetPropertiesHeaders & {
1629
- /** The underlying HTTP response. */
1630
- _response: coreHttp.HttpResponse & {
1631
- /** The parsed HTTP response headers. */
1632
- parsedHeaders: FileGetPropertiesHeaders;
1633
- };
1634
- };
2075
+ export declare type FileGetPropertiesResponse = WithResponse<FileGetPropertiesHeaders, FileGetPropertiesHeaders>;
2076
+
2077
+ /** Contains response data for the getProperties operation. */
2078
+ declare type FileGetPropertiesResponse_2 = FileGetPropertiesHeaders;
1635
2079
 
1636
2080
  /** Contains response data for the getRangeList operation. */
1637
- export declare type FileGetRangeListDiffResponse = FileGetRangeListHeaders & ShareFileRangeList & {
1638
- /** The underlying HTTP response. */
1639
- _response: coreHttp.HttpResponse & {
1640
- /** The response body as text (string format) */
1641
- bodyAsText: string;
1642
- /** The response body as parsed JSON or XML */
1643
- parsedBody: ShareFileRangeList;
1644
- /** The parsed HTTP response headers. */
1645
- parsedHeaders: FileGetRangeListHeaders;
1646
- };
1647
- };
2081
+ export declare type FileGetRangeListDiffResponse = WithResponse<FileGetRangeListHeaders & ShareFileRangeList, FileGetRangeListHeaders, ShareFileRangeList>;
1648
2082
 
1649
2083
  /** Defines headers for File_getRangeList operation. */
1650
2084
  export declare interface FileGetRangeListHeaders {
@@ -1664,6 +2098,20 @@ export declare interface FileGetRangeListHeaders {
1664
2098
  errorCode?: string;
1665
2099
  }
1666
2100
 
2101
+ /** Optional parameters. */
2102
+ declare interface FileGetRangeListOptionalParams extends coreClient.OperationOptions {
2103
+ /** Parameter group */
2104
+ leaseAccessConditions?: LeaseAccessConditions;
2105
+ /** 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> */
2106
+ timeoutInSeconds?: number;
2107
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2108
+ shareSnapshot?: string;
2109
+ /** Specifies the range of bytes over which to list ranges, inclusively. */
2110
+ range?: string;
2111
+ /** The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot. */
2112
+ prevsharesnapshot?: string;
2113
+ }
2114
+
1667
2115
  /**
1668
2116
  * The option is defined as parity to REST definition.
1669
2117
  * While it's not ready to be used now, considering Crc64 of source content is
@@ -1691,29 +2139,15 @@ export declare interface FileGetRangeListOptions extends CommonOptions {
1691
2139
  /**
1692
2140
  * Contains response data for the {@link ShareFileClient.getRangeList} operation.
1693
2141
  */
1694
- export declare type FileGetRangeListResponse = FileGetRangeListHeaders & {
2142
+ export declare type FileGetRangeListResponse = WithResponse<FileGetRangeListHeaders & {
1695
2143
  /**
1696
2144
  * Range list for an Azure file.
1697
2145
  */
1698
2146
  rangeList: RangeModel[];
1699
- /**
1700
- * The underlying HTTP response.
1701
- */
1702
- _response: HttpResponse & {
1703
- /**
1704
- * The parsed HTTP response headers.
1705
- */
1706
- parsedHeaders: FileGetRangeListHeaders;
1707
- /**
1708
- * The response body as text (string format)
1709
- */
1710
- bodyAsText: string;
1711
- /**
1712
- * The response body as parsed JSON or XML
1713
- */
1714
- parsedBody: RangeModel[];
1715
- };
1716
- };
2147
+ }, FileGetRangeListHeaders, RangeModel[]>;
2148
+
2149
+ /** Contains response data for the getRangeList operation. */
2150
+ declare type FileGetRangeListResponse_2 = FileGetRangeListHeaders & ShareFileRangeList;
1717
2151
 
1718
2152
  export declare interface FileHttpHeaders {
1719
2153
  /**
@@ -1753,6 +2187,22 @@ export declare interface FileHttpHeaders {
1753
2187
  fileContentDisposition?: string;
1754
2188
  }
1755
2189
 
2190
+ /** Parameter group */
2191
+ declare interface FileHttpHeaders_2 {
2192
+ /** Sets the MIME content type of the file. The default type is 'application/octet-stream'. */
2193
+ fileContentType?: string;
2194
+ /** Specifies which content encodings have been applied to the file. */
2195
+ fileContentEncoding?: string;
2196
+ /** Specifies the natural languages used by this resource. */
2197
+ fileContentLanguage?: string;
2198
+ /** Sets the file's cache control. The File service stores this value but does not use or modify it. */
2199
+ fileCacheControl?: string;
2200
+ /** Sets the file's MD5 hash. */
2201
+ fileContentMD5?: Uint8Array;
2202
+ /** Sets the file's Content-Disposition header. */
2203
+ fileContentDisposition?: string;
2204
+ }
2205
+
1756
2206
  /** A listed file item. */
1757
2207
  export declare interface FileItem {
1758
2208
  name: string;
@@ -1780,6 +2230,18 @@ export declare interface FileListHandlesHeaders {
1780
2230
  errorCode?: string;
1781
2231
  }
1782
2232
 
2233
+ /** Optional parameters. */
2234
+ declare interface FileListHandlesOptionalParams extends coreClient.OperationOptions {
2235
+ /** 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> */
2236
+ timeoutInSeconds?: number;
2237
+ /** 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. */
2238
+ marker?: string;
2239
+ /** 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. */
2240
+ maxResults?: number;
2241
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2242
+ shareSnapshot?: string;
2243
+ }
2244
+
1783
2245
  export declare interface FileListHandlesOptions extends CommonOptions {
1784
2246
  /**
1785
2247
  * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
@@ -1789,17 +2251,10 @@ export declare interface FileListHandlesOptions extends CommonOptions {
1789
2251
  }
1790
2252
 
1791
2253
  /** Contains response data for the listHandles operation. */
1792
- export declare type FileListHandlesResponse = FileListHandlesHeaders & ListHandlesResponse & {
1793
- /** The underlying HTTP response. */
1794
- _response: coreHttp.HttpResponse & {
1795
- /** The response body as text (string format) */
1796
- bodyAsText: string;
1797
- /** The response body as parsed JSON or XML */
1798
- parsedBody: ListHandlesResponse;
1799
- /** The parsed HTTP response headers. */
1800
- parsedHeaders: FileListHandlesHeaders;
1801
- };
1802
- };
2254
+ export declare type FileListHandlesResponse = WithResponse<FileListHandlesHeaders & ListHandlesResponse, FileListHandlesHeaders, ListHandlesResponse>;
2255
+
2256
+ /** Contains response data for the listHandles operation. */
2257
+ declare type FileListHandlesResponse_2 = FileListHandlesHeaders & ListHandlesResponse;
1803
2258
 
1804
2259
  /**
1805
2260
  * Options to configure File - List Handles Segment operations.
@@ -1901,6 +2356,36 @@ export declare interface FileProperty {
1901
2356
  etag?: string;
1902
2357
  }
1903
2358
 
2359
+ /** Defines values for FileRangeWriteType. */
2360
+ declare type FileRangeWriteType = "update" | "clear";
2361
+
2362
+ /** Defines headers for File_releaseLease operation. */
2363
+ declare interface FileReleaseLeaseHeaders {
2364
+ /** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
2365
+ etag?: string;
2366
+ /** Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file. */
2367
+ lastModified?: Date;
2368
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
2369
+ clientRequestId?: string;
2370
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
2371
+ requestId?: string;
2372
+ /** Indicates the version of the File service used to execute the request. */
2373
+ version?: string;
2374
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
2375
+ date?: Date;
2376
+ }
2377
+
2378
+ /** Optional parameters. */
2379
+ declare interface FileReleaseLeaseOptionalParams extends coreClient.OperationOptions {
2380
+ /** 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> */
2381
+ timeoutInSeconds?: number;
2382
+ /** 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. */
2383
+ requestId?: string;
2384
+ }
2385
+
2386
+ /** Contains response data for the releaseLease operation. */
2387
+ declare type FileReleaseLeaseResponse = FileReleaseLeaseHeaders;
2388
+
1904
2389
  /** Defines headers for File_rename operation. */
1905
2390
  export declare interface FileRenameHeaders {
1906
2391
  /** The ETag contains a value which represents the version of the file, in quotes. */
@@ -1931,6 +2416,32 @@ export declare interface FileRenameHeaders {
1931
2416
  fileParentId?: string;
1932
2417
  }
1933
2418
 
2419
+ /** Optional parameters. */
2420
+ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
2421
+ /** Parameter group */
2422
+ sourceLeaseAccessConditions?: SourceLeaseAccessConditions;
2423
+ /** Parameter group */
2424
+ destinationLeaseAccessConditions?: DestinationLeaseAccessConditions;
2425
+ /** Parameter group */
2426
+ copyFileSmbInfo?: CopyFileSmbInfo;
2427
+ /** Parameter group */
2428
+ fileHttpHeaders?: FileHttpHeaders_2;
2429
+ /** 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> */
2430
+ timeoutInSeconds?: number;
2431
+ /** A name-value pair to associate with a file storage object. */
2432
+ metadata?: {
2433
+ [propertyName: string]: string;
2434
+ };
2435
+ /** 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. */
2436
+ filePermission?: string;
2437
+ /** 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. */
2438
+ filePermissionKey?: string;
2439
+ /** Optional. A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value. */
2440
+ replaceIfExists?: boolean;
2441
+ /** Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail. */
2442
+ ignoreReadOnly?: boolean;
2443
+ }
2444
+
1934
2445
  /**
1935
2446
  * Options to configure the {@link ShareFileClient.rename} operation.
1936
2447
  */
@@ -1990,13 +2501,10 @@ export declare interface FileRenameOptions extends CommonOptions {
1990
2501
  }
1991
2502
 
1992
2503
  /** Contains response data for the rename operation. */
1993
- export declare type FileRenameResponse = FileRenameHeaders & {
1994
- /** The underlying HTTP response. */
1995
- _response: coreHttp.HttpResponse & {
1996
- /** The parsed HTTP response headers. */
1997
- parsedHeaders: FileRenameHeaders;
1998
- };
1999
- };
2504
+ export declare type FileRenameResponse = WithResponse<FileRenameHeaders, FileRenameHeaders>;
2505
+
2506
+ /** Contains response data for the rename operation. */
2507
+ declare type FileRenameResponse_2 = FileRenameHeaders;
2000
2508
 
2001
2509
  /**
2002
2510
  * Options to configure the {@link ShareFileClient.resize} operation.
@@ -2174,6 +2682,28 @@ export declare interface FileSetHTTPHeadersHeaders {
2174
2682
  errorCode?: string;
2175
2683
  }
2176
2684
 
2685
+ /** Optional parameters. */
2686
+ declare interface FileSetHttpHeadersOptionalParams extends coreClient.OperationOptions {
2687
+ /** Parameter group */
2688
+ leaseAccessConditions?: LeaseAccessConditions;
2689
+ /** Parameter group */
2690
+ fileHttpHeaders?: FileHttpHeaders_2;
2691
+ /** 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> */
2692
+ timeoutInSeconds?: number;
2693
+ /** 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. */
2694
+ filePermission?: string;
2695
+ /** 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. */
2696
+ filePermissionKey?: string;
2697
+ /** Creation time for the file/directory. Default value: Now. */
2698
+ fileCreatedOn?: string;
2699
+ /** Last write time for the file/directory. Default value: Now. */
2700
+ fileLastWriteOn?: string;
2701
+ /** Change time for the file/directory. Default value: Now. */
2702
+ fileChangeOn?: string;
2703
+ /** 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. */
2704
+ fileContentLength?: number;
2705
+ }
2706
+
2177
2707
  /**
2178
2708
  * Options to configure the {@link ShareFileClient.setHttpHeaders} operation.
2179
2709
  */
@@ -2190,13 +2720,10 @@ export declare interface FileSetHttpHeadersOptions extends FileAndDirectorySetPr
2190
2720
  }
2191
2721
 
2192
2722
  /** Contains response data for the setHttpHeaders operation. */
2193
- export declare type FileSetHTTPHeadersResponse = FileSetHTTPHeadersHeaders & {
2194
- /** The underlying HTTP response. */
2195
- _response: coreHttp.HttpResponse & {
2196
- /** The parsed HTTP response headers. */
2197
- parsedHeaders: FileSetHTTPHeadersHeaders;
2198
- };
2199
- };
2723
+ export declare type FileSetHTTPHeadersResponse = WithResponse<FileSetHTTPHeadersHeaders, FileSetHTTPHeadersHeaders>;
2724
+
2725
+ /** Contains response data for the setHttpHeaders operation. */
2726
+ declare type FileSetHttpHeadersResponse = FileSetHTTPHeadersHeaders;
2200
2727
 
2201
2728
  /** Defines headers for File_setMetadata operation. */
2202
2729
  export declare interface FileSetMetadataHeaders {
@@ -2214,6 +2741,18 @@ export declare interface FileSetMetadataHeaders {
2214
2741
  errorCode?: string;
2215
2742
  }
2216
2743
 
2744
+ /** Optional parameters. */
2745
+ declare interface FileSetMetadataOptionalParams extends coreClient.OperationOptions {
2746
+ /** Parameter group */
2747
+ leaseAccessConditions?: LeaseAccessConditions;
2748
+ /** 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> */
2749
+ timeoutInSeconds?: number;
2750
+ /** A name-value pair to associate with a file storage object. */
2751
+ metadata?: {
2752
+ [propertyName: string]: string;
2753
+ };
2754
+ }
2755
+
2217
2756
  /**
2218
2757
  * Options to configure the {@link ShareFileClient.setMetadata} operation.
2219
2758
  */
@@ -2230,13 +2769,10 @@ export declare interface FileSetMetadataOptions extends CommonOptions {
2230
2769
  }
2231
2770
 
2232
2771
  /** Contains response data for the setMetadata operation. */
2233
- export declare type FileSetMetadataResponse = FileSetMetadataHeaders & {
2234
- /** The underlying HTTP response. */
2235
- _response: coreHttp.HttpResponse & {
2236
- /** The parsed HTTP response headers. */
2237
- parsedHeaders: FileSetMetadataHeaders;
2238
- };
2239
- };
2772
+ export declare type FileSetMetadataResponse = WithResponse<FileSetMetadataHeaders, FileSetMetadataHeaders>;
2773
+
2774
+ /** Contains response data for the setMetadata operation. */
2775
+ declare type FileSetMetadataResponse_2 = FileSetMetadataHeaders;
2240
2776
 
2241
2777
  /** Defines headers for File_startCopy operation. */
2242
2778
  export declare interface FileStartCopyHeaders {
@@ -2258,11 +2794,29 @@ export declare interface FileStartCopyHeaders {
2258
2794
  errorCode?: string;
2259
2795
  }
2260
2796
 
2261
- /**
2262
- * Options to configure the {@link ShareFileClient.startCopyFromURL} operation.
2263
- */
2264
- export declare interface FileStartCopyOptions extends CommonOptions {
2265
- /**
2797
+ /** Optional parameters. */
2798
+ declare interface FileStartCopyOptionalParams extends coreClient.OperationOptions {
2799
+ /** Parameter group */
2800
+ leaseAccessConditions?: LeaseAccessConditions;
2801
+ /** Parameter group */
2802
+ copyFileSmbInfo?: CopyFileSmbInfo;
2803
+ /** 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> */
2804
+ timeoutInSeconds?: number;
2805
+ /** A name-value pair to associate with a file storage object. */
2806
+ metadata?: {
2807
+ [propertyName: string]: string;
2808
+ };
2809
+ /** 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. */
2810
+ filePermission?: string;
2811
+ /** 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. */
2812
+ filePermissionKey?: string;
2813
+ }
2814
+
2815
+ /**
2816
+ * Options to configure the {@link ShareFileClient.startCopyFromURL} operation.
2817
+ */
2818
+ export declare interface FileStartCopyOptions extends CommonOptions {
2819
+ /**
2266
2820
  * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
2267
2821
  * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
2268
2822
  */
@@ -2295,13 +2849,10 @@ export declare interface FileStartCopyOptions extends CommonOptions {
2295
2849
  }
2296
2850
 
2297
2851
  /** Contains response data for the startCopy operation. */
2298
- export declare type FileStartCopyResponse = FileStartCopyHeaders & {
2299
- /** The underlying HTTP response. */
2300
- _response: coreHttp.HttpResponse & {
2301
- /** The parsed HTTP response headers. */
2302
- parsedHeaders: FileStartCopyHeaders;
2303
- };
2304
- };
2852
+ export declare type FileStartCopyResponse = WithResponse<FileStartCopyHeaders, FileStartCopyHeaders>;
2853
+
2854
+ /** Contains response data for the startCopy operation. */
2855
+ declare type FileStartCopyResponse_2 = FileStartCopyHeaders;
2305
2856
 
2306
2857
  /**
2307
2858
  * This is a helper class to construct a string representing the NTFS attributes to a file or directory.
@@ -2389,17 +2940,13 @@ export declare interface FileUploadRangeFromURLHeaders {
2389
2940
  }
2390
2941
 
2391
2942
  /** Optional parameters. */
2392
- export declare interface FileUploadRangeFromURLOptionalParams extends coreHttp.OperationOptions {
2943
+ export declare interface FileUploadRangeFromURLOptionalParams extends coreClient.OperationOptions {
2393
2944
  /** Parameter group */
2394
2945
  leaseAccessConditions?: LeaseAccessConditions;
2395
2946
  /** Parameter group */
2396
2947
  sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
2397
2948
  /** 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> */
2398
2949
  timeoutInSeconds?: number;
2399
- /** If true, the trailing dot will not be trimmed from the target URI. */
2400
- allowTrailingDot?: boolean;
2401
- /** If true, the trailing dot will not be trimmed from the source URI. */
2402
- allowSourceTrailingDot?: boolean;
2403
2950
  /** If the file last write time should be preserved or overwritten */
2404
2951
  fileLastWrittenMode?: FileLastWrittenMode;
2405
2952
  /** Bytes of source data in the specified range. */
@@ -2451,13 +2998,10 @@ export declare interface FileUploadRangeFromURLOptions extends CommonOptions {
2451
2998
  }
2452
2999
 
2453
3000
  /** Contains response data for the uploadRangeFromURL operation. */
2454
- export declare type FileUploadRangeFromURLResponse = FileUploadRangeFromURLHeaders & {
2455
- /** The underlying HTTP response. */
2456
- _response: coreHttp.HttpResponse & {
2457
- /** The parsed HTTP response headers. */
2458
- parsedHeaders: FileUploadRangeFromURLHeaders;
2459
- };
2460
- };
3001
+ export declare type FileUploadRangeFromURLResponse = WithResponse<FileUploadRangeFromURLHeaders, FileUploadRangeFromURLHeaders>;
3002
+
3003
+ /** Contains response data for the uploadRangeFromURL operation. */
3004
+ declare type FileUploadRangeFromURLResponse_2 = FileUploadRangeFromURLHeaders;
2461
3005
 
2462
3006
  /** Defines headers for File_uploadRange operation. */
2463
3007
  export declare interface FileUploadRangeHeaders {
@@ -2481,6 +3025,20 @@ export declare interface FileUploadRangeHeaders {
2481
3025
  errorCode?: string;
2482
3026
  }
2483
3027
 
3028
+ /** Optional parameters. */
3029
+ declare interface FileUploadRangeOptionalParams extends coreClient.OperationOptions {
3030
+ /** Parameter group */
3031
+ leaseAccessConditions?: LeaseAccessConditions;
3032
+ /** 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> */
3033
+ timeoutInSeconds?: number;
3034
+ /** Initial data. */
3035
+ body?: coreRestPipeline.RequestBodyType;
3036
+ /** An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5 header is specified, the File service compares the hash of the content that has arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). */
3037
+ contentMD5?: Uint8Array;
3038
+ /** If the file last write time should be preserved or overwritten */
3039
+ fileLastWrittenMode?: FileLastWrittenMode;
3040
+ }
3041
+
2484
3042
  /**
2485
3043
  * Options to configure the {@link ShareFileClient.uploadRange} operation.
2486
3044
  */
@@ -2517,13 +3075,10 @@ export declare interface FileUploadRangeOptions extends CommonOptions {
2517
3075
  }
2518
3076
 
2519
3077
  /** Contains response data for the uploadRange operation. */
2520
- export declare type FileUploadRangeResponse = FileUploadRangeHeaders & {
2521
- /** The underlying HTTP response. */
2522
- _response: coreHttp.HttpResponse & {
2523
- /** The parsed HTTP response headers. */
2524
- parsedHeaders: FileUploadRangeHeaders;
2525
- };
2526
- };
3078
+ export declare type FileUploadRangeResponse = WithResponse<FileUploadRangeHeaders, FileUploadRangeHeaders>;
3079
+
3080
+ /** Contains response data for the uploadRange operation. */
3081
+ declare type FileUploadRangeResponse_2 = FileUploadRangeHeaders;
2527
3082
 
2528
3083
  /**
2529
3084
  * Option interface for ShareFileClient.uploadStream().
@@ -2616,19 +3171,33 @@ export declare interface HttpAuthorization {
2616
3171
  value: string;
2617
3172
  }
2618
3173
 
2619
- export { HttpHeaders }
2620
-
2621
- export { HttpOperationResponse }
2622
-
2623
- export { HttpRequestBody }
2624
-
2625
- export { IHttpClient }
2626
-
2627
- /** Known values of {@link ShareTokenIntent} that the service accepts. */
2628
- export declare enum KnownShareTokenIntent {
2629
- Backup = "backup"
3174
+ /**
3175
+ * A representation of an HTTP response that
3176
+ * includes a reference to the request that
3177
+ * originated it.
3178
+ */
3179
+ export declare interface HttpResponse {
3180
+ /**
3181
+ * The headers from the response.
3182
+ */
3183
+ headers: HttpHeadersLike;
3184
+ /**
3185
+ * The original request that resulted in this response.
3186
+ */
3187
+ request: WebResourceLike;
3188
+ /**
3189
+ * The HTTP status code returned from the service.
3190
+ */
3191
+ status: number;
2630
3192
  }
2631
3193
 
3194
+ /**
3195
+ * A helper to decide if a given argument satisfies the Pipeline contract
3196
+ * @param pipeline - An argument that may be a Pipeline
3197
+ * @returns true when the argument satisfies the Pipeline contract
3198
+ */
3199
+ export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
3200
+
2632
3201
  /** Parameter group */
2633
3202
  export declare interface LeaseAccessConditions {
2634
3203
  /** If specified, the operation only succeeds if the resource's lease is active and matches this ID. */
@@ -2654,17 +3223,7 @@ export declare interface LeaseOperationOptions extends CommonOptions {
2654
3223
  *
2655
3224
  * See {@link ShareLeaseClient}.
2656
3225
  */
2657
- export declare type LeaseOperationResponse = LeaseOperationResponseHeaders & {
2658
- /**
2659
- * The underlying HTTP response.
2660
- */
2661
- _response: HttpResponse & {
2662
- /**
2663
- * The parsed HTTP response headers.
2664
- */
2665
- parsedHeaders: LeaseOperationResponseHeaders;
2666
- };
2667
- };
3226
+ export declare type LeaseOperationResponse = WithResponse<LeaseOperationResponseHeaders, LeaseOperationResponseHeaders>;
2668
3227
 
2669
3228
  /**
2670
3229
  * The details of the response for a specific lease operation.
@@ -2728,6 +3287,9 @@ export declare interface ListFilesAndDirectoriesSegmentResponse {
2728
3287
  directoryId?: string;
2729
3288
  }
2730
3289
 
3290
+ /** Defines values for ListFilesIncludeType. */
3291
+ declare type ListFilesIncludeType = "Timestamps" | "Etag" | "Attributes" | "PermissionKey";
3292
+
2731
3293
  /** An enumeration of handles. */
2732
3294
  export declare interface ListHandlesResponse {
2733
3295
  handleList?: HandleItem[];
@@ -2781,13 +3343,13 @@ export declare interface Metrics {
2781
3343
  }
2782
3344
 
2783
3345
  /**
2784
- * Creates a new {@link Pipeline} object with {@link Credential} provided.
3346
+ * Creates a new Pipeline object with Credential provided.
2785
3347
  *
2786
- * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential.
3348
+ * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
2787
3349
  * @param pipelineOptions - Optional. Options.
2788
3350
  * @returns A new Pipeline object.
2789
3351
  */
2790
- export declare function newPipeline(credential?: Credential_2 | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline;
3352
+ export declare function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline;
2791
3353
 
2792
3354
  /** Defines values for PermissionCopyModeType. */
2793
3355
  export declare type PermissionCopyModeType = "source" | "override";
@@ -2797,10 +3359,10 @@ export declare type PermissionCopyModeType = "source" | "override";
2797
3359
  * You can create a default Pipeline by calling {@link newPipeline}.
2798
3360
  * Or you can create a Pipeline with your own policies by the constructor of Pipeline.
2799
3361
  *
2800
- * Refer to {@link newPipeline} and provided policies as reference before
2801
- * implementing your customized Pipeline.
3362
+ * Refer to {@link newPipeline} and provided policies before implementing your
3363
+ * customized Pipeline.
2802
3364
  */
2803
- export declare class Pipeline {
3365
+ export declare class Pipeline implements PipelineLike {
2804
3366
  /**
2805
3367
  * A list of chained request policy factories.
2806
3368
  */
@@ -2817,7 +3379,33 @@ export declare class Pipeline {
2817
3379
  */
2818
3380
  constructor(factories: RequestPolicyFactory[], options?: PipelineOptions);
2819
3381
  /**
2820
- * Transfer Pipeline object to ServiceClientOptions object which required by
3382
+ * Transfer Pipeline object to ServiceClientOptions object which is required by
3383
+ * ServiceClient constructor.
3384
+ *
3385
+ * @returns The ServiceClientOptions object from this Pipeline.
3386
+ */
3387
+ toServiceClientOptions(): ServiceClientOptions;
3388
+ }
3389
+
3390
+ /**
3391
+ * An interface for the {@link Pipeline} class containing HTTP request policies.
3392
+ * You can create a default Pipeline by calling {@link newPipeline}.
3393
+ * Or you can create a Pipeline with your own policies by the constructor of Pipeline.
3394
+ *
3395
+ * Refer to {@link newPipeline} and provided policies before implementing your
3396
+ * customized Pipeline.
3397
+ */
3398
+ export declare interface PipelineLike {
3399
+ /**
3400
+ * A list of chained request policy factories.
3401
+ */
3402
+ readonly factories: RequestPolicyFactory[];
3403
+ /**
3404
+ * Configures pipeline logger and HTTP client.
3405
+ */
3406
+ readonly options: PipelineOptions;
3407
+ /**
3408
+ * Transfer Pipeline object to ServiceClientOptions object which is required by
2821
3409
  * ServiceClient constructor.
2822
3410
  *
2823
3411
  * @returns The ServiceClientOptions object from this Pipeline.
@@ -2832,11 +3420,7 @@ export declare interface PipelineOptions {
2832
3420
  /**
2833
3421
  * Optional. Configures the HTTP client to send requests and receive responses.
2834
3422
  */
2835
- httpClient?: IHttpClient;
2836
- /**
2837
- * Intent of using TokenCredential in file requests.
2838
- */
2839
- shareTokenIntent?: ShareTokenIntent;
3423
+ httpClient?: RequestPolicy;
2840
3424
  }
2841
3425
 
2842
3426
  /**
@@ -2864,11 +3448,73 @@ export declare interface RangeModel {
2864
3448
  end: number;
2865
3449
  }
2866
3450
 
2867
- export { RequestPolicy }
3451
+ /** Contains response data for the download operation. */
3452
+ export declare type RawFileDownloadResponse = FileDownloadHeaders & {
3453
+ /**
3454
+ * BROWSER ONLY
3455
+ *
3456
+ * The response body as a browser Blob.
3457
+ * Always `undefined` in node.js.
3458
+ */
3459
+ blobBody?: Promise<Blob>;
3460
+ /**
3461
+ * NODEJS ONLY
3462
+ *
3463
+ * The response body as a node.js Readable stream.
3464
+ * Always `undefined` in the browser.
3465
+ */
3466
+ readableStreamBody?: NodeJS.ReadableStream;
3467
+ };
2868
3468
 
2869
- export { RequestPolicyFactory }
3469
+ /**
3470
+ * An object with a simple _response property.
3471
+ */
3472
+ export declare interface ResponseLike {
3473
+ /**
3474
+ * The underlying HTTP response.
3475
+ */
3476
+ _response: HttpResponse;
3477
+ }
2870
3478
 
2871
- export { RequestPolicyOptions }
3479
+ /**
3480
+ * An object with a _response property that has body
3481
+ * and headers already parsed into known types.
3482
+ */
3483
+ export declare interface ResponseWithBody<Headers, Body> {
3484
+ /**
3485
+ * The underlying HTTP response.
3486
+ */
3487
+ _response: HttpResponse & {
3488
+ /**
3489
+ * The parsed HTTP response headers.
3490
+ */
3491
+ parsedHeaders: Headers;
3492
+ /**
3493
+ * The response body as text (string format)
3494
+ */
3495
+ bodyAsText: string;
3496
+ /**
3497
+ * The response body as parsed JSON or XML
3498
+ */
3499
+ parsedBody: Body;
3500
+ };
3501
+ }
3502
+
3503
+ /**
3504
+ * An object with a _response property that has
3505
+ * headers already parsed into a typed object.
3506
+ */
3507
+ export declare interface ResponseWithHeaders<Headers> {
3508
+ /**
3509
+ * The underlying HTTP response.
3510
+ */
3511
+ _response: HttpResponse & {
3512
+ /**
3513
+ * The parsed HTTP response headers.
3514
+ */
3515
+ parsedHeaders: Headers;
3516
+ };
3517
+ }
2872
3518
 
2873
3519
  export { RestError }
2874
3520
 
@@ -3032,6 +3678,43 @@ export declare class SASQueryParameters {
3032
3678
  private tryAppendQueryParameter;
3033
3679
  }
3034
3680
 
3681
+ /** Interface representing a Service. */
3682
+ declare interface Service {
3683
+ /**
3684
+ * Sets properties for a storage account's File service endpoint, including properties for Storage
3685
+ * Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.
3686
+ * @param properties The StorageService properties.
3687
+ * @param options The options parameters.
3688
+ */
3689
+ setProperties(properties: FileServiceProperties, options?: ServiceSetPropertiesOptionalParams): Promise<ServiceSetPropertiesResponse_2>;
3690
+ /**
3691
+ * Gets the properties of a storage account's File service, including properties for Storage Analytics
3692
+ * metrics and CORS (Cross-Origin Resource Sharing) rules.
3693
+ * @param options The options parameters.
3694
+ */
3695
+ getProperties(options?: ServiceGetPropertiesOptionalParams): Promise<ServiceGetPropertiesResponse_2>;
3696
+ /**
3697
+ * The List Shares Segment operation returns a list of the shares and share snapshots under the
3698
+ * specified account.
3699
+ * @param options The options parameters.
3700
+ */
3701
+ listSharesSegment(options?: ServiceListSharesSegmentOptionalParams): Promise<ServiceListSharesSegmentResponse_2>;
3702
+ }
3703
+
3704
+ /**
3705
+ * A subset of `@azure/core-http` ServiceClientOptions
3706
+ */
3707
+ export declare interface ServiceClientOptions {
3708
+ /**
3709
+ * Optional. Configures the HTTP client to send requests and receive responses.
3710
+ */
3711
+ httpClient?: RequestPolicy;
3712
+ /**
3713
+ * Optional. Overrides the default policy factories.
3714
+ */
3715
+ requestPolicyFactories?: RequestPolicyFactory[] | ((defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]);
3716
+ }
3717
+
3035
3718
  /**
3036
3719
  * Options to configure {@link ShareServiceClient.generateAccountSasUrl} operation.
3037
3720
  */
@@ -3065,6 +3748,12 @@ export declare interface ServiceGetPropertiesHeaders {
3065
3748
  errorCode?: string;
3066
3749
  }
3067
3750
 
3751
+ /** Optional parameters. */
3752
+ declare interface ServiceGetPropertiesOptionalParams extends coreClient.OperationOptions {
3753
+ /** 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> */
3754
+ timeoutInSeconds?: number;
3755
+ }
3756
+
3068
3757
  /**
3069
3758
  * Options to configure the {@link ShareServiceClient.getProperties} operation.
3070
3759
  */
@@ -3077,17 +3766,10 @@ export declare interface ServiceGetPropertiesOptions extends CommonOptions {
3077
3766
  }
3078
3767
 
3079
3768
  /** Contains response data for the getProperties operation. */
3080
- export declare type ServiceGetPropertiesResponse = ServiceGetPropertiesHeaders & FileServiceProperties & {
3081
- /** The underlying HTTP response. */
3082
- _response: coreHttp.HttpResponse & {
3083
- /** The response body as text (string format) */
3084
- bodyAsText: string;
3085
- /** The response body as parsed JSON or XML */
3086
- parsedBody: FileServiceProperties;
3087
- /** The parsed HTTP response headers. */
3088
- parsedHeaders: ServiceGetPropertiesHeaders;
3089
- };
3090
- };
3769
+ export declare type ServiceGetPropertiesResponse = WithResponse<ServiceGetPropertiesHeaders & FileServiceProperties, ServiceGetPropertiesHeaders, FileServiceProperties>;
3770
+
3771
+ /** Contains response data for the getProperties operation. */
3772
+ declare type ServiceGetPropertiesResponse_2 = ServiceGetPropertiesHeaders & FileServiceProperties;
3091
3773
 
3092
3774
  /**
3093
3775
  * Options to configure the {@link ShareServiceClient.listShares} operation.
@@ -3127,28 +3809,27 @@ export declare interface ServiceListSharesSegmentHeaders {
3127
3809
  errorCode?: string;
3128
3810
  }
3129
3811
 
3812
+ /** Optional parameters. */
3813
+ declare interface ServiceListSharesSegmentOptionalParams extends coreClient.OperationOptions {
3814
+ /** 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> */
3815
+ timeoutInSeconds?: number;
3816
+ /** Filters the results to return only entries whose name begins with the specified prefix. */
3817
+ prefix?: string;
3818
+ /** 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. */
3819
+ marker?: string;
3820
+ /** 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. */
3821
+ maxResults?: number;
3822
+ /** Include this parameter to specify one or more datasets to include in the response. */
3823
+ include?: ListSharesIncludeType[];
3824
+ }
3825
+
3130
3826
  /**
3131
3827
  * Contains response data for the {@link ShareServiceClient.listShares} operation.
3132
3828
  */
3133
- export declare type ServiceListSharesSegmentResponse = ListSharesResponse & ServiceListSharesSegmentHeaders & {
3134
- /**
3135
- * The underlying HTTP response.
3136
- */
3137
- _response: HttpResponse & {
3138
- /**
3139
- * The parsed HTTP response headers.
3140
- */
3141
- parsedHeaders: ServiceListSharesSegmentHeaders;
3142
- /**
3143
- * The response body as text (string format)
3144
- */
3145
- bodyAsText: string;
3146
- /**
3147
- * The response body as parsed JSON or XML
3148
- */
3149
- parsedBody: ListSharesResponseModel;
3150
- };
3151
- };
3829
+ export declare type ServiceListSharesSegmentResponse = WithResponse<ListSharesResponse & ServiceListSharesSegmentHeaders, ServiceListSharesSegmentHeaders, ListSharesResponseModel>;
3830
+
3831
+ /** Contains response data for the listSharesSegment operation. */
3832
+ declare type ServiceListSharesSegmentResponse_2 = ServiceListSharesSegmentHeaders & ListSharesResponseModel;
3152
3833
 
3153
3834
  /** Defines headers for Service_setProperties operation. */
3154
3835
  export declare interface ServiceSetPropertiesHeaders {
@@ -3160,6 +3841,12 @@ export declare interface ServiceSetPropertiesHeaders {
3160
3841
  errorCode?: string;
3161
3842
  }
3162
3843
 
3844
+ /** Optional parameters. */
3845
+ declare interface ServiceSetPropertiesOptionalParams extends coreClient.OperationOptions {
3846
+ /** 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> */
3847
+ timeoutInSeconds?: number;
3848
+ }
3849
+
3163
3850
  /**
3164
3851
  * Options to configure the {@link ShareServiceClient.setProperties} operation.
3165
3852
  */
@@ -3172,30 +3859,234 @@ export declare interface ServiceSetPropertiesOptions extends CommonOptions {
3172
3859
  }
3173
3860
 
3174
3861
  /** Contains response data for the setProperties operation. */
3175
- export declare type ServiceSetPropertiesResponse = ServiceSetPropertiesHeaders & {
3176
- /** The underlying HTTP response. */
3177
- _response: coreHttp.HttpResponse & {
3178
- /** The parsed HTTP response headers. */
3179
- parsedHeaders: ServiceSetPropertiesHeaders;
3180
- };
3181
- };
3862
+ export declare type ServiceSetPropertiesResponse = WithResponse<ServiceSetPropertiesHeaders, ServiceSetPropertiesHeaders>;
3863
+
3864
+ /** Contains response data for the setProperties operation. */
3865
+ declare type ServiceSetPropertiesResponse_2 = ServiceSetPropertiesHeaders;
3866
+
3867
+ /**
3868
+ * Options to configure the {@link ShareServiceClient.undelete} operation.
3869
+ */
3870
+ export declare interface ServiceUndeleteShareOptions extends CommonOptions {
3871
+ /**
3872
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
3873
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
3874
+ */
3875
+ abortSignal?: AbortSignalLike;
3876
+ }
3877
+
3878
+ export declare interface SetPropertiesResponse extends FileSetHTTPHeadersResponse {
3879
+ }
3880
+
3881
+ /** Interface representing a Share. */
3882
+ declare interface Share {
3883
+ /**
3884
+ * Creates a new share under the specified account. If the share with the same name already exists, the
3885
+ * operation fails.
3886
+ * @param options The options parameters.
3887
+ */
3888
+ create(options?: ShareCreateOptionalParams): Promise<ShareCreateResponse_2>;
3889
+ /**
3890
+ * Returns all user-defined metadata and system properties for the specified share or share snapshot.
3891
+ * The data returned does not include the share's list of files.
3892
+ * @param options The options parameters.
3893
+ */
3894
+ getProperties(options?: ShareGetPropertiesOptionalParams): Promise<ShareGetPropertiesResponse_2>;
3895
+ /**
3896
+ * Operation marks the specified share or share snapshot for deletion. The share or share snapshot and
3897
+ * any files contained within it are later deleted during garbage collection.
3898
+ * @param options The options parameters.
3899
+ */
3900
+ delete(options?: ShareDeleteOptionalParams): Promise<ShareDeleteResponse_2>;
3901
+ /**
3902
+ * The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
3903
+ * set and delete share operations.
3904
+ * @param options The options parameters.
3905
+ */
3906
+ acquireLease(options?: ShareAcquireLeaseOptionalParams): Promise<ShareAcquireLeaseResponse>;
3907
+ /**
3908
+ * The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
3909
+ * set and delete share operations.
3910
+ * @param leaseId Specifies the current lease ID on the resource.
3911
+ * @param options The options parameters.
3912
+ */
3913
+ releaseLease(leaseId: string, options?: ShareReleaseLeaseOptionalParams): Promise<ShareReleaseLeaseResponse>;
3914
+ /**
3915
+ * The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
3916
+ * set and delete share operations.
3917
+ * @param leaseId Specifies the current lease ID on the resource.
3918
+ * @param options The options parameters.
3919
+ */
3920
+ changeLease(leaseId: string, options?: ShareChangeLeaseOptionalParams): Promise<ShareChangeLeaseResponse>;
3921
+ /**
3922
+ * The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
3923
+ * set and delete share operations.
3924
+ * @param leaseId Specifies the current lease ID on the resource.
3925
+ * @param options The options parameters.
3926
+ */
3927
+ renewLease(leaseId: string, options?: ShareRenewLeaseOptionalParams): Promise<ShareRenewLeaseResponse>;
3928
+ /**
3929
+ * The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
3930
+ * set and delete share operations.
3931
+ * @param options The options parameters.
3932
+ */
3933
+ breakLease(options?: ShareBreakLeaseOptionalParams): Promise<ShareBreakLeaseResponse>;
3934
+ /**
3935
+ * Creates a read-only snapshot of a share.
3936
+ * @param options The options parameters.
3937
+ */
3938
+ createSnapshot(options?: ShareCreateSnapshotOptionalParams): Promise<ShareCreateSnapshotResponse_2>;
3939
+ /**
3940
+ * Create a permission (a security descriptor).
3941
+ * @param sharePermission A permission (a security descriptor) at the share level.
3942
+ * @param options The options parameters.
3943
+ */
3944
+ createPermission(sharePermission: SharePermission, options?: ShareCreatePermissionOptionalParams): Promise<ShareCreatePermissionResponse_2>;
3945
+ /**
3946
+ * Returns the permission (security descriptor) for a given key
3947
+ * @param filePermissionKey Key of the permission to be set for the directory/file.
3948
+ * @param options The options parameters.
3949
+ */
3950
+ getPermission(filePermissionKey: string, options?: ShareGetPermissionOptionalParams): Promise<ShareGetPermissionResponse_2>;
3951
+ /**
3952
+ * Sets properties for the specified share.
3953
+ * @param options The options parameters.
3954
+ */
3955
+ setProperties(options?: ShareSetPropertiesOptionalParams): Promise<ShareSetPropertiesResponse_2>;
3956
+ /**
3957
+ * Sets one or more user-defined name-value pairs for the specified share.
3958
+ * @param options The options parameters.
3959
+ */
3960
+ setMetadata(options?: ShareSetMetadataOptionalParams): Promise<ShareSetMetadataResponse_2>;
3961
+ /**
3962
+ * Returns information about stored access policies specified on the share.
3963
+ * @param options The options parameters.
3964
+ */
3965
+ getAccessPolicy(options?: ShareGetAccessPolicyOptionalParams): Promise<ShareGetAccessPolicyResponse_2>;
3966
+ /**
3967
+ * Sets a stored access policy for use with shared access signatures.
3968
+ * @param options The options parameters.
3969
+ */
3970
+ setAccessPolicy(options?: ShareSetAccessPolicyOptionalParams): Promise<ShareSetAccessPolicyResponse_2>;
3971
+ /**
3972
+ * Retrieves statistics related to the share.
3973
+ * @param options The options parameters.
3974
+ */
3975
+ getStatistics(options?: ShareGetStatisticsOptionalParams): Promise<ShareGetStatisticsResponse_2>;
3976
+ /**
3977
+ * Restores a previously deleted Share.
3978
+ * @param options The options parameters.
3979
+ */
3980
+ restore(options?: ShareRestoreOptionalParams): Promise<ShareRestoreResponse>;
3981
+ }
3982
+
3983
+ /** Defines values for ShareAccessTier. */
3984
+ export declare type ShareAccessTier = "TransactionOptimized" | "Hot" | "Cool";
3985
+
3986
+ /** Defines headers for Share_acquireLease operation. */
3987
+ declare interface ShareAcquireLeaseHeaders {
3988
+ /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
3989
+ etag?: string;
3990
+ /** Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. */
3991
+ lastModified?: Date;
3992
+ /** Uniquely identifies a share's lease */
3993
+ leaseId?: string;
3994
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
3995
+ clientRequestId?: string;
3996
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
3997
+ requestId?: string;
3998
+ /** Indicates the version of the File service used to execute the request. */
3999
+ version?: string;
4000
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
4001
+ date?: Date;
4002
+ }
4003
+
4004
+ /** Optional parameters. */
4005
+ declare interface ShareAcquireLeaseOptionalParams extends coreClient.OperationOptions {
4006
+ /** 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> */
4007
+ timeoutInSeconds?: number;
4008
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
4009
+ shareSnapshot?: string;
4010
+ /** 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. */
4011
+ duration?: number;
4012
+ /** 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. */
4013
+ proposedLeaseId?: string;
4014
+ /** 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. */
4015
+ requestId?: string;
4016
+ }
4017
+
4018
+ /** Contains response data for the acquireLease operation. */
4019
+ declare type ShareAcquireLeaseResponse = ShareAcquireLeaseHeaders;
4020
+
4021
+ /** Defines headers for Share_breakLease operation. */
4022
+ declare interface ShareBreakLeaseHeaders {
4023
+ /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
4024
+ etag?: string;
4025
+ /** Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. */
4026
+ lastModified?: Date;
4027
+ /** Approximate time remaining in the lease period, in seconds. */
4028
+ leaseTimeInSeconds?: number;
4029
+ /** Uniquely identifies a share's lease */
4030
+ leaseId?: string;
4031
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
4032
+ clientRequestId?: string;
4033
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
4034
+ requestId?: string;
4035
+ /** Indicates the version of the File service used to execute the request. */
4036
+ version?: string;
4037
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
4038
+ date?: Date;
4039
+ }
4040
+
4041
+ /** Optional parameters. */
4042
+ declare interface ShareBreakLeaseOptionalParams extends coreClient.OperationOptions {
4043
+ /** Parameter group */
4044
+ leaseAccessConditions?: LeaseAccessConditions;
4045
+ /** 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> */
4046
+ timeoutInSeconds?: number;
4047
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
4048
+ shareSnapshot?: string;
4049
+ /** 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. */
4050
+ requestId?: string;
4051
+ /** For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately. */
4052
+ breakPeriod?: number;
4053
+ }
4054
+
4055
+ /** Contains response data for the breakLease operation. */
4056
+ declare type ShareBreakLeaseResponse = ShareBreakLeaseHeaders;
3182
4057
 
3183
- /**
3184
- * Options to configure the {@link ShareServiceClient.undelete} operation.
3185
- */
3186
- export declare interface ServiceUndeleteShareOptions extends CommonOptions {
3187
- /**
3188
- * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
3189
- * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
3190
- */
3191
- abortSignal?: AbortSignalLike;
4058
+ /** Defines headers for Share_changeLease operation. */
4059
+ declare interface ShareChangeLeaseHeaders {
4060
+ /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
4061
+ etag?: string;
4062
+ /** Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. */
4063
+ lastModified?: Date;
4064
+ /** Uniquely identifies a share's lease */
4065
+ leaseId?: string;
4066
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
4067
+ clientRequestId?: string;
4068
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
4069
+ requestId?: string;
4070
+ /** Indicates the version of the File service used to execute the request. */
4071
+ version?: string;
4072
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
4073
+ date?: Date;
3192
4074
  }
3193
4075
 
3194
- export declare interface SetPropertiesResponse extends FileSetHTTPHeadersResponse {
4076
+ /** Optional parameters. */
4077
+ declare interface ShareChangeLeaseOptionalParams extends coreClient.OperationOptions {
4078
+ /** 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> */
4079
+ timeoutInSeconds?: number;
4080
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
4081
+ shareSnapshot?: string;
4082
+ /** 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. */
4083
+ proposedLeaseId?: string;
4084
+ /** 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. */
4085
+ requestId?: string;
3195
4086
  }
3196
4087
 
3197
- /** Defines values for ShareAccessTier. */
3198
- export declare type ShareAccessTier = "TransactionOptimized" | "Hot" | "Cool";
4088
+ /** Contains response data for the changeLease operation. */
4089
+ declare type ShareChangeLeaseResponse = ShareChangeLeaseHeaders;
3199
4090
 
3200
4091
  /**
3201
4092
  * A ShareClient represents a URL to the Azure Storage share allowing you to manipulate its directories and files.
@@ -3206,7 +4097,6 @@ export declare class ShareClient extends StorageClient {
3206
4097
  */
3207
4098
  private context;
3208
4099
  private _name;
3209
- private shareClientConfig?;
3210
4100
  /**
3211
4101
  * The name of the share
3212
4102
  */
@@ -3221,7 +4111,7 @@ export declare class ShareClient extends StorageClient {
3221
4111
  * @param name - Share name.
3222
4112
  * @param options - Optional. Options to configure the HTTP pipeline.
3223
4113
  */
3224
- constructor(connectionString: string, name: string, options?: ShareClientOptions);
4114
+ constructor(connectionString: string, name: string, options?: StoragePipelineOptions);
3225
4115
  /**
3226
4116
  * Creates an instance of ShareClient.
3227
4117
  *
@@ -3233,7 +4123,7 @@ export declare class ShareClient extends StorageClient {
3233
4123
  * If not specified, AnonymousCredential is used.
3234
4124
  * @param options - Optional. Options to configure the HTTP pipeline.
3235
4125
  */
3236
- constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
4126
+ constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?: StoragePipelineOptions);
3237
4127
  /**
3238
4128
  * Creates an instance of ShareClient.
3239
4129
  *
@@ -3244,7 +4134,7 @@ export declare class ShareClient extends StorageClient {
3244
4134
  * @param pipeline - Call newPipeline() to create a default
3245
4135
  * pipeline, or provide a customized pipeline.
3246
4136
  */
3247
- constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
4137
+ constructor(url: string, pipeline: Pipeline);
3248
4138
  /**
3249
4139
  * Creates a new ShareClient object identical to the source but with the specified snapshot timestamp.
3250
4140
  * Provide "" will remove the snapshot and return a URL to the base share.
@@ -3487,26 +4377,6 @@ export declare class ShareClient extends StorageClient {
3487
4377
  generateSasUrl(options: ShareGenerateSasUrlOptions): string;
3488
4378
  }
3489
4379
 
3490
- export declare interface ShareClientConfig {
3491
- /**
3492
- * The Files OAuth over REST feature requires special permissions to be included in the role definition to use
3493
- * These special permissions will give privileged access to file share data -
3494
- * It will allow users to bypass file/directory level ACL/NTFS permissions and get read/write access to file share data
3495
- * Since this additional permission can be unintended and to prevent unintended and over privileged access,
3496
- * additional checks has been implemented that requires users to explicitly indicate their intent to use these additional permissions.
3497
- * This is done using the fileRequestIntent option.
3498
- * Currently, the only value that the header supports is 'backup'
3499
- * Any user who wishes to use Files OAuth over REST feature has to call the API with the intent header. If the API is not called with the intent header, any subsequent data operation requests will be denied.
3500
- */
3501
- fileRequestIntent?: ShareTokenIntent;
3502
- /** If true, the trailing dot will not be trimmed from the target URI. */
3503
- allowTrailingDot?: boolean;
3504
- /** If true, the trailing dot will not be trimmed from the source URI. */
3505
- allowSourceTrailingDot?: boolean;
3506
- }
3507
-
3508
- export declare type ShareClientOptions = StoragePipelineOptions & ShareClientConfig;
3509
-
3510
4380
  /** Defines headers for Share_create operation. */
3511
4381
  export declare interface ShareCreateHeaders {
3512
4382
  /** The ETag contains a value which represents the version of the share, in quotes. */
@@ -3533,6 +4403,24 @@ export declare interface ShareCreateIfNotExistsResponse extends ShareCreateRespo
3533
4403
  succeeded: boolean;
3534
4404
  }
3535
4405
 
4406
+ /** Optional parameters. */
4407
+ declare interface ShareCreateOptionalParams extends coreClient.OperationOptions {
4408
+ /** 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> */
4409
+ timeoutInSeconds?: number;
4410
+ /** A name-value pair to associate with a file storage object. */
4411
+ metadata?: {
4412
+ [propertyName: string]: string;
4413
+ };
4414
+ /** Specifies the maximum size of the share, in gigabytes. */
4415
+ quota?: number;
4416
+ /** Specifies the access tier of the share. */
4417
+ accessTier?: ShareAccessTier;
4418
+ /** Protocols to enable on the share. */
4419
+ enabledProtocols?: string;
4420
+ /** Root squash to set on the share. Only valid for NFS shares. */
4421
+ rootSquash?: ShareRootSquash;
4422
+ }
4423
+
3536
4424
  /**
3537
4425
  * Options to configure the {@link ShareClient.create} operation.
3538
4426
  */
@@ -3583,6 +4471,12 @@ export declare interface ShareCreatePermissionHeaders {
3583
4471
  errorCode?: string;
3584
4472
  }
3585
4473
 
4474
+ /** Optional parameters. */
4475
+ declare interface ShareCreatePermissionOptionalParams extends coreClient.OperationOptions {
4476
+ /** 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> */
4477
+ timeoutInSeconds?: number;
4478
+ }
4479
+
3586
4480
  /**
3587
4481
  * Options to configure the {@link ShareClient.createPermission} operation.
3588
4482
  */
@@ -3595,22 +4489,16 @@ export declare interface ShareCreatePermissionOptions extends CommonOptions {
3595
4489
  }
3596
4490
 
3597
4491
  /** Contains response data for the createPermission operation. */
3598
- export declare type ShareCreatePermissionResponse = ShareCreatePermissionHeaders & {
3599
- /** The underlying HTTP response. */
3600
- _response: coreHttp.HttpResponse & {
3601
- /** The parsed HTTP response headers. */
3602
- parsedHeaders: ShareCreatePermissionHeaders;
3603
- };
3604
- };
4492
+ export declare type ShareCreatePermissionResponse = WithResponse<ShareCreatePermissionHeaders, ShareCreatePermissionHeaders>;
4493
+
4494
+ /** Contains response data for the createPermission operation. */
4495
+ declare type ShareCreatePermissionResponse_2 = ShareCreatePermissionHeaders;
3605
4496
 
3606
4497
  /** Contains response data for the create operation. */
3607
- export declare type ShareCreateResponse = ShareCreateHeaders & {
3608
- /** The underlying HTTP response. */
3609
- _response: coreHttp.HttpResponse & {
3610
- /** The parsed HTTP response headers. */
3611
- parsedHeaders: ShareCreateHeaders;
3612
- };
3613
- };
4498
+ export declare type ShareCreateResponse = WithResponse<ShareCreateHeaders, ShareCreateHeaders>;
4499
+
4500
+ /** Contains response data for the create operation. */
4501
+ declare type ShareCreateResponse_2 = ShareCreateHeaders;
3614
4502
 
3615
4503
  /** Defines headers for Share_createSnapshot operation. */
3616
4504
  export declare interface ShareCreateSnapshotHeaders {
@@ -3630,6 +4518,16 @@ export declare interface ShareCreateSnapshotHeaders {
3630
4518
  errorCode?: string;
3631
4519
  }
3632
4520
 
4521
+ /** Optional parameters. */
4522
+ declare interface ShareCreateSnapshotOptionalParams extends coreClient.OperationOptions {
4523
+ /** 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> */
4524
+ timeoutInSeconds?: number;
4525
+ /** A name-value pair to associate with a file storage object. */
4526
+ metadata?: {
4527
+ [propertyName: string]: string;
4528
+ };
4529
+ }
4530
+
3633
4531
  /**
3634
4532
  * Options to configure the {@link ShareClient.createSnapshot} operation.
3635
4533
  */
@@ -3648,13 +4546,10 @@ export declare interface ShareCreateSnapshotOptions extends CommonOptions {
3648
4546
  }
3649
4547
 
3650
4548
  /** Contains response data for the createSnapshot operation. */
3651
- export declare type ShareCreateSnapshotResponse = ShareCreateSnapshotHeaders & {
3652
- /** The underlying HTTP response. */
3653
- _response: coreHttp.HttpResponse & {
3654
- /** The parsed HTTP response headers. */
3655
- parsedHeaders: ShareCreateSnapshotHeaders;
3656
- };
3657
- };
4549
+ export declare type ShareCreateSnapshotResponse = WithResponse<ShareCreateSnapshotHeaders, ShareCreateSnapshotHeaders>;
4550
+
4551
+ /** Contains response data for the createSnapshot operation. */
4552
+ declare type ShareCreateSnapshotResponse_2 = ShareCreateSnapshotHeaders;
3658
4553
 
3659
4554
  /** Defines headers for Share_delete operation. */
3660
4555
  export declare interface ShareDeleteHeaders {
@@ -3699,14 +4594,23 @@ export declare interface ShareDeleteMethodOptions extends CommonOptions {
3699
4594
  leaseAccessConditions?: LeaseAccessConditions;
3700
4595
  }
3701
4596
 
4597
+ /** Optional parameters. */
4598
+ declare interface ShareDeleteOptionalParams extends coreClient.OperationOptions {
4599
+ /** Parameter group */
4600
+ leaseAccessConditions?: LeaseAccessConditions;
4601
+ /** 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> */
4602
+ timeoutInSeconds?: number;
4603
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
4604
+ shareSnapshot?: string;
4605
+ /** Specifies the option include to delete the base share and all of its snapshots. */
4606
+ deleteSnapshots?: DeleteSnapshotsOptionType;
4607
+ }
4608
+
3702
4609
  /** Contains response data for the delete operation. */
3703
- export declare type ShareDeleteResponse = ShareDeleteHeaders & {
3704
- /** The underlying HTTP response. */
3705
- _response: coreHttp.HttpResponse & {
3706
- /** The parsed HTTP response headers. */
3707
- parsedHeaders: ShareDeleteHeaders;
3708
- };
3709
- };
4610
+ export declare type ShareDeleteResponse = WithResponse<ShareDeleteHeaders, ShareDeleteHeaders>;
4611
+
4612
+ /** Contains response data for the delete operation. */
4613
+ declare type ShareDeleteResponse_2 = ShareDeleteHeaders;
3710
4614
 
3711
4615
  /**
3712
4616
  * A ShareDirectoryClient represents a URL to the Azure Storage directory allowing you to manipulate its files and directories.
@@ -3719,7 +4623,6 @@ export declare class ShareDirectoryClient extends StorageClient {
3719
4623
  private _shareName;
3720
4624
  private _path;
3721
4625
  private _name;
3722
- private shareClientConfig?;
3723
4626
  /**
3724
4627
  * The share name corresponding to this directory client
3725
4628
  */
@@ -3747,7 +4650,7 @@ export declare class ShareDirectoryClient extends StorageClient {
3747
4650
  * If not specified, AnonymousCredential is used.
3748
4651
  * @param options - Optional. Options to configure the HTTP pipeline.
3749
4652
  */
3750
- constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
4653
+ constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
3751
4654
  /**
3752
4655
  * Creates an instance of DirectoryClient.
3753
4656
  *
@@ -3762,7 +4665,7 @@ export declare class ShareDirectoryClient extends StorageClient {
3762
4665
  * @param pipeline - Call newPipeline() to create a default
3763
4666
  * pipeline, or provide a customized pipeline.
3764
4667
  */
3765
- constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
4668
+ constructor(url: string, pipeline: Pipeline);
3766
4669
  /**
3767
4670
  * Creates a new directory under the specified share or parent directory.
3768
4671
  * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
@@ -4232,7 +5135,6 @@ export declare class ShareFileClient extends StorageClient {
4232
5135
  private _shareName;
4233
5136
  private _path;
4234
5137
  private _name;
4235
- private shareClientConfig?;
4236
5138
  /**
4237
5139
  * The share name corresponding to this file client
4238
5140
  */
@@ -4256,11 +5158,11 @@ export declare class ShareFileClient extends StorageClient {
4256
5158
  * Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
4257
5159
  * However, if a file or directory name includes %, file or directory name must be encoded in the URL.
4258
5160
  * Such as a file named "myfile%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".
4259
- * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or TokenCredential,
5161
+ * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
4260
5162
  * If not specified, AnonymousCredential is used.
4261
5163
  * @param options - Optional. Options to configure the HTTP pipeline.
4262
5164
  */
4263
- constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
5165
+ constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
4264
5166
  /**
4265
5167
  * Creates an instance of ShareFileClient.
4266
5168
  *
@@ -4275,7 +5177,7 @@ export declare class ShareFileClient extends StorageClient {
4275
5177
  * @param pipeline - Call newPipeline() to create a default
4276
5178
  * pipeline, or provide a customized pipeline.
4277
5179
  */
4278
- constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
5180
+ constructor(url: string, pipeline: Pipeline);
4279
5181
  /**
4280
5182
  * Creates a new ShareFileClient object identical to the source but with the specified share snapshot timestamp.
4281
5183
  * Provide "" will remove the snapshot and return a URL to the base ShareFileClient.
@@ -4497,7 +5399,7 @@ export declare class ShareFileClient extends StorageClient {
4497
5399
  * console.log("Updated file successfully!")
4498
5400
  * ```
4499
5401
  */
4500
- uploadRange(body: HttpRequestBody, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>;
5402
+ uploadRange(body: RequestBodyType, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>;
4501
5403
  /**
4502
5404
  * Upload a range of bytes to a file where the contents are read from a another file's URL.
4503
5405
  * The range can be up to 4 MB in size.
@@ -4815,6 +5717,14 @@ export declare interface ShareGetAccessPolicyHeaders {
4815
5717
  errorCode?: string;
4816
5718
  }
4817
5719
 
5720
+ /** Optional parameters. */
5721
+ declare interface ShareGetAccessPolicyOptionalParams extends coreClient.OperationOptions {
5722
+ /** Parameter group */
5723
+ leaseAccessConditions?: LeaseAccessConditions;
5724
+ /** 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> */
5725
+ timeoutInSeconds?: number;
5726
+ }
5727
+
4818
5728
  /**
4819
5729
  * Options to configure the {@link ShareClient.getAccessPolicy} operation.
4820
5730
  */
@@ -4830,27 +5740,12 @@ export declare interface ShareGetAccessPolicyOptions extends CommonOptions {
4830
5740
  leaseAccessConditions?: LeaseAccessConditions;
4831
5741
  }
4832
5742
 
4833
- export declare type ShareGetAccessPolicyResponse = {
5743
+ export declare type ShareGetAccessPolicyResponse = WithResponse<{
4834
5744
  signedIdentifiers: SignedIdentifier[];
4835
- } & ShareGetAccessPolicyHeaders & {
4836
- /**
4837
- * The underlying HTTP response.
4838
- */
4839
- _response: HttpResponse & {
4840
- /**
4841
- * The parsed HTTP response headers.
4842
- */
4843
- parsedHeaders: ShareGetAccessPolicyHeaders;
4844
- /**
4845
- * The response body as text (string format)
4846
- */
4847
- bodyAsText: string;
4848
- /**
4849
- * The response body as parsed JSON or XML
4850
- */
4851
- parsedBody: SignedIdentifierModel[];
4852
- };
4853
- };
5745
+ } & ShareGetAccessPolicyHeaders, ShareGetAccessPolicyHeaders, SignedIdentifierModel[]>;
5746
+
5747
+ /** Contains response data for the getAccessPolicy operation. */
5748
+ declare type ShareGetAccessPolicyResponse_2 = ShareGetAccessPolicyHeaders & SignedIdentifierModel[];
4854
5749
 
4855
5750
  /** Defines headers for Share_getPermission operation. */
4856
5751
  export declare interface ShareGetPermissionHeaders {
@@ -4864,6 +5759,12 @@ export declare interface ShareGetPermissionHeaders {
4864
5759
  errorCode?: string;
4865
5760
  }
4866
5761
 
5762
+ /** Optional parameters. */
5763
+ declare interface ShareGetPermissionOptionalParams extends coreClient.OperationOptions {
5764
+ /** 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> */
5765
+ timeoutInSeconds?: number;
5766
+ }
5767
+
4867
5768
  /**
4868
5769
  * Options to configure the {@link ShareClient.getPermission} operation.
4869
5770
  */
@@ -4876,17 +5777,10 @@ export declare interface ShareGetPermissionOptions extends CommonOptions {
4876
5777
  }
4877
5778
 
4878
5779
  /** Contains response data for the getPermission operation. */
4879
- export declare type ShareGetPermissionResponse = ShareGetPermissionHeaders & SharePermission & {
4880
- /** The underlying HTTP response. */
4881
- _response: coreHttp.HttpResponse & {
4882
- /** The response body as text (string format) */
4883
- bodyAsText: string;
4884
- /** The response body as parsed JSON or XML */
4885
- parsedBody: SharePermission;
4886
- /** The parsed HTTP response headers. */
4887
- parsedHeaders: ShareGetPermissionHeaders;
4888
- };
4889
- };
5780
+ export declare type ShareGetPermissionResponse = WithResponse<ShareGetPermissionHeaders & SharePermission, ShareGetPermissionHeaders, SharePermission>;
5781
+
5782
+ /** Contains response data for the getPermission operation. */
5783
+ declare type ShareGetPermissionResponse_2 = ShareGetPermissionHeaders & SharePermission;
4890
5784
 
4891
5785
  /** Defines headers for Share_getProperties operation. */
4892
5786
  export declare interface ShareGetPropertiesHeaders {
@@ -4936,6 +5830,16 @@ export declare interface ShareGetPropertiesHeaders {
4936
5830
  errorCode?: string;
4937
5831
  }
4938
5832
 
5833
+ /** Optional parameters. */
5834
+ declare interface ShareGetPropertiesOptionalParams extends coreClient.OperationOptions {
5835
+ /** Parameter group */
5836
+ leaseAccessConditions?: LeaseAccessConditions;
5837
+ /** 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> */
5838
+ timeoutInSeconds?: number;
5839
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
5840
+ shareSnapshot?: string;
5841
+ }
5842
+
4939
5843
  /**
4940
5844
  * Options to configure the {@link ShareClient.getProperties} operation.
4941
5845
  */
@@ -4962,13 +5866,10 @@ export declare type ShareGetPropertiesResponse = ShareGetPropertiesResponseModel
4962
5866
  };
4963
5867
 
4964
5868
  /** Contains response data for the getProperties operation. */
4965
- export declare type ShareGetPropertiesResponseModel = ShareGetPropertiesHeaders & {
4966
- /** The underlying HTTP response. */
4967
- _response: coreHttp.HttpResponse & {
4968
- /** The parsed HTTP response headers. */
4969
- parsedHeaders: ShareGetPropertiesHeaders;
4970
- };
4971
- };
5869
+ declare type ShareGetPropertiesResponse_2 = ShareGetPropertiesHeaders;
5870
+
5871
+ /** Contains response data for the getProperties operation. */
5872
+ export declare type ShareGetPropertiesResponseModel = WithResponse<ShareGetPropertiesHeaders, ShareGetPropertiesHeaders>;
4972
5873
 
4973
5874
  /** Defines headers for Share_getStatistics operation. */
4974
5875
  export declare interface ShareGetStatisticsHeaders {
@@ -4986,6 +5887,14 @@ export declare interface ShareGetStatisticsHeaders {
4986
5887
  errorCode?: string;
4987
5888
  }
4988
5889
 
5890
+ /** Optional parameters. */
5891
+ declare interface ShareGetStatisticsOptionalParams extends coreClient.OperationOptions {
5892
+ /** Parameter group */
5893
+ leaseAccessConditions?: LeaseAccessConditions;
5894
+ /** 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> */
5895
+ timeoutInSeconds?: number;
5896
+ }
5897
+
4989
5898
  /**
4990
5899
  * Options to configure the {@link ShareClient.getStatistics} operation.
4991
5900
  */
@@ -5015,17 +5924,10 @@ export declare type ShareGetStatisticsResponse = ShareGetStatisticsResponseModel
5015
5924
  };
5016
5925
 
5017
5926
  /** Contains response data for the getStatistics operation. */
5018
- export declare type ShareGetStatisticsResponseModel = ShareGetStatisticsHeaders & ShareStats & {
5019
- /** The underlying HTTP response. */
5020
- _response: coreHttp.HttpResponse & {
5021
- /** The response body as text (string format) */
5022
- bodyAsText: string;
5023
- /** The response body as parsed JSON or XML */
5024
- parsedBody: ShareStats;
5025
- /** The parsed HTTP response headers. */
5026
- parsedHeaders: ShareGetStatisticsHeaders;
5027
- };
5028
- };
5927
+ declare type ShareGetStatisticsResponse_2 = ShareGetStatisticsHeaders & ShareStats;
5928
+
5929
+ /** Contains response data for the getStatistics operation. */
5930
+ export declare type ShareGetStatisticsResponseModel = WithResponse<ShareGetStatisticsHeaders & ShareStats, ShareGetStatisticsHeaders, ShareStats>;
5029
5931
 
5030
5932
  /**
5031
5933
  * A listed Azure Storage share item.
@@ -5065,7 +5967,6 @@ export declare class ShareLeaseClient {
5065
5967
  private _leaseId;
5066
5968
  private _url;
5067
5969
  private fileOrShare;
5068
- private isShare;
5069
5970
  /**
5070
5971
  * Gets the lease Id.
5071
5972
  *
@@ -5187,6 +6088,97 @@ export declare interface ShareProtocolSettings {
5187
6088
  smb?: ShareSmbSettings;
5188
6089
  }
5189
6090
 
6091
+ /** Defines headers for Share_releaseLease operation. */
6092
+ declare interface ShareReleaseLeaseHeaders {
6093
+ /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
6094
+ etag?: string;
6095
+ /** Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. */
6096
+ lastModified?: Date;
6097
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
6098
+ clientRequestId?: string;
6099
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
6100
+ requestId?: string;
6101
+ /** Indicates the version of the File service used to execute the request. */
6102
+ version?: string;
6103
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
6104
+ date?: Date;
6105
+ }
6106
+
6107
+ /** Optional parameters. */
6108
+ declare interface ShareReleaseLeaseOptionalParams extends coreClient.OperationOptions {
6109
+ /** 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> */
6110
+ timeoutInSeconds?: number;
6111
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
6112
+ shareSnapshot?: string;
6113
+ /** 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. */
6114
+ requestId?: string;
6115
+ }
6116
+
6117
+ /** Contains response data for the releaseLease operation. */
6118
+ declare type ShareReleaseLeaseResponse = ShareReleaseLeaseHeaders;
6119
+
6120
+ /** Defines headers for Share_renewLease operation. */
6121
+ declare interface ShareRenewLeaseHeaders {
6122
+ /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
6123
+ etag?: string;
6124
+ /** Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. */
6125
+ lastModified?: Date;
6126
+ /** Uniquely identifies a share's lease */
6127
+ leaseId?: string;
6128
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
6129
+ clientRequestId?: string;
6130
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
6131
+ requestId?: string;
6132
+ /** Indicates the version of the File service used to execute the request. */
6133
+ version?: string;
6134
+ /** Returns the current share next allowed quota downgrade time. */
6135
+ date?: Date;
6136
+ }
6137
+
6138
+ /** Optional parameters. */
6139
+ declare interface ShareRenewLeaseOptionalParams extends coreClient.OperationOptions {
6140
+ /** 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> */
6141
+ timeoutInSeconds?: number;
6142
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
6143
+ shareSnapshot?: string;
6144
+ /** 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. */
6145
+ requestId?: string;
6146
+ }
6147
+
6148
+ /** Contains response data for the renewLease operation. */
6149
+ declare type ShareRenewLeaseResponse = ShareRenewLeaseHeaders;
6150
+
6151
+ /** Defines headers for Share_restore operation. */
6152
+ declare interface ShareRestoreHeaders {
6153
+ /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
6154
+ etag?: string;
6155
+ /** Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. */
6156
+ lastModified?: Date;
6157
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
6158
+ requestId?: string;
6159
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
6160
+ clientRequestId?: string;
6161
+ /** Indicates the version of the File service used to execute the request. */
6162
+ version?: string;
6163
+ /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
6164
+ date?: Date;
6165
+ }
6166
+
6167
+ /** Optional parameters. */
6168
+ declare interface ShareRestoreOptionalParams extends coreClient.OperationOptions {
6169
+ /** 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> */
6170
+ timeoutInSeconds?: number;
6171
+ /** 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. */
6172
+ requestId?: string;
6173
+ /** Specifies the name of the previously-deleted share. */
6174
+ deletedShareName?: string;
6175
+ /** Specifies the version of the previously-deleted share. */
6176
+ deletedShareVersion?: string;
6177
+ }
6178
+
6179
+ /** Contains response data for the restore operation. */
6180
+ declare type ShareRestoreResponse = ShareRestoreHeaders;
6181
+
5190
6182
  /** Defines values for ShareRootSquash. */
5191
6183
  export declare type ShareRootSquash = "NoRootSquash" | "RootSquash" | "AllSquash";
5192
6184
 
@@ -5245,7 +6237,6 @@ export declare class ShareServiceClient extends StorageClient {
5245
6237
  * serviceContext provided by protocol layer.
5246
6238
  */
5247
6239
  private serviceContext;
5248
- private shareClientConfig?;
5249
6240
  /**
5250
6241
  *
5251
6242
  * Creates an instance of ShareServiceClient from connection string.
@@ -5259,18 +6250,18 @@ export declare class ShareServiceClient extends StorageClient {
5259
6250
  * @param options - Options to configure the HTTP pipeline.
5260
6251
  * @returns A new ShareServiceClient from the given connection string.
5261
6252
  */
5262
- static fromConnectionString(connectionString: string, options?: ShareClientOptions): ShareServiceClient;
6253
+ static fromConnectionString(connectionString: string, options?: StoragePipelineOptions): ShareServiceClient;
5263
6254
  /**
5264
6255
  * Creates an instance of ShareServiceClient.
5265
6256
  *
5266
6257
  * @param url - A URL string pointing to Azure Storage file service, such as
5267
6258
  * "https://myaccount.file.core.windows.net". You can Append a SAS
5268
6259
  * if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
5269
- * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or TokenCredential.
6260
+ * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
5270
6261
  * If not specified, AnonymousCredential is used.
5271
6262
  * @param options - Optional. Options to configure the HTTP pipeline.
5272
6263
  */
5273
- constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
6264
+ constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
5274
6265
  /**
5275
6266
  * Creates an instance of ShareServiceClient.
5276
6267
  *
@@ -5279,10 +6270,8 @@ export declare class ShareServiceClient extends StorageClient {
5279
6270
  * if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
5280
6271
  * @param pipeline - Call newPipeline() to create a default
5281
6272
  * pipeline, or provide a customized pipeline.
5282
- * @param options - Optional. Options to configure the HTTP pipeline.
5283
- * @param fileRequestIntent - Optional. File request intent.
5284
6273
  */
5285
- constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
6274
+ constructor(url: string, pipeline: Pipeline);
5286
6275
  /**
5287
6276
  * Creates a ShareClient object.
5288
6277
  *
@@ -5488,6 +6477,16 @@ export declare interface ShareSetAccessPolicyHeaders {
5488
6477
  errorCode?: string;
5489
6478
  }
5490
6479
 
6480
+ /** Optional parameters. */
6481
+ declare interface ShareSetAccessPolicyOptionalParams extends coreClient.OperationOptions {
6482
+ /** Parameter group */
6483
+ leaseAccessConditions?: LeaseAccessConditions;
6484
+ /** 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> */
6485
+ timeoutInSeconds?: number;
6486
+ /** The ACL for the share. */
6487
+ shareAcl?: SignedIdentifierModel[];
6488
+ }
6489
+
5491
6490
  /**
5492
6491
  * Options to configure the {@link ShareClient.setAccessPolicy} operation.
5493
6492
  */
@@ -5504,13 +6503,10 @@ export declare interface ShareSetAccessPolicyOptions extends CommonOptions {
5504
6503
  }
5505
6504
 
5506
6505
  /** Contains response data for the setAccessPolicy operation. */
5507
- export declare type ShareSetAccessPolicyResponse = ShareSetAccessPolicyHeaders & {
5508
- /** The underlying HTTP response. */
5509
- _response: coreHttp.HttpResponse & {
5510
- /** The parsed HTTP response headers. */
5511
- parsedHeaders: ShareSetAccessPolicyHeaders;
5512
- };
5513
- };
6506
+ export declare type ShareSetAccessPolicyResponse = WithResponse<ShareSetAccessPolicyHeaders, ShareGetAccessPolicyHeaders>;
6507
+
6508
+ /** Contains response data for the setAccessPolicy operation. */
6509
+ declare type ShareSetAccessPolicyResponse_2 = ShareSetAccessPolicyHeaders;
5514
6510
 
5515
6511
  /** Defines headers for Share_setMetadata operation. */
5516
6512
  export declare interface ShareSetMetadataHeaders {
@@ -5528,6 +6524,18 @@ export declare interface ShareSetMetadataHeaders {
5528
6524
  errorCode?: string;
5529
6525
  }
5530
6526
 
6527
+ /** Optional parameters. */
6528
+ declare interface ShareSetMetadataOptionalParams extends coreClient.OperationOptions {
6529
+ /** Parameter group */
6530
+ leaseAccessConditions?: LeaseAccessConditions;
6531
+ /** 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> */
6532
+ timeoutInSeconds?: number;
6533
+ /** A name-value pair to associate with a file storage object. */
6534
+ metadata?: {
6535
+ [propertyName: string]: string;
6536
+ };
6537
+ }
6538
+
5531
6539
  /**
5532
6540
  * Options to configure the {@link ShareClient.setMetadata} operation.
5533
6541
  */
@@ -5544,13 +6552,10 @@ export declare interface ShareSetMetadataOptions extends CommonOptions {
5544
6552
  }
5545
6553
 
5546
6554
  /** Contains response data for the setMetadata operation. */
5547
- export declare type ShareSetMetadataResponse = ShareSetMetadataHeaders & {
5548
- /** The underlying HTTP response. */
5549
- _response: coreHttp.HttpResponse & {
5550
- /** The parsed HTTP response headers. */
5551
- parsedHeaders: ShareSetMetadataHeaders;
5552
- };
5553
- };
6555
+ export declare type ShareSetMetadataResponse = WithResponse<ShareSetMetadataHeaders, ShareSetMetadataHeaders>;
6556
+
6557
+ /** Contains response data for the setMetadata operation. */
6558
+ declare type ShareSetMetadataResponse_2 = ShareSetMetadataHeaders;
5554
6559
 
5555
6560
  /** Defines headers for Share_setProperties operation. */
5556
6561
  export declare interface ShareSetPropertiesHeaders {
@@ -5568,6 +6573,20 @@ export declare interface ShareSetPropertiesHeaders {
5568
6573
  errorCode?: string;
5569
6574
  }
5570
6575
 
6576
+ /** Optional parameters. */
6577
+ declare interface ShareSetPropertiesOptionalParams extends coreClient.OperationOptions {
6578
+ /** Parameter group */
6579
+ leaseAccessConditions?: LeaseAccessConditions;
6580
+ /** 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> */
6581
+ timeoutInSeconds?: number;
6582
+ /** Specifies the maximum size of the share, in gigabytes. */
6583
+ quota?: number;
6584
+ /** Specifies the access tier of the share. */
6585
+ accessTier?: ShareAccessTier;
6586
+ /** Root squash to set on the share. Only valid for NFS shares. */
6587
+ rootSquash?: ShareRootSquash;
6588
+ }
6589
+
5571
6590
  /**
5572
6591
  * Options to configure the {@link ShareClient.setProperties} operation.
5573
6592
  */
@@ -5598,13 +6617,10 @@ export declare interface ShareSetPropertiesOptions extends CommonOptions {
5598
6617
  }
5599
6618
 
5600
6619
  /** Contains response data for the setProperties operation. */
5601
- export declare type ShareSetPropertiesResponse = ShareSetPropertiesHeaders & {
5602
- /** The underlying HTTP response. */
5603
- _response: coreHttp.HttpResponse & {
5604
- /** The parsed HTTP response headers. */
5605
- parsedHeaders: ShareSetPropertiesHeaders;
5606
- };
5607
- };
6620
+ export declare type ShareSetPropertiesResponse = WithResponse<ShareSetPropertiesHeaders, ShareSetPropertiesHeaders>;
6621
+
6622
+ /** Contains response data for the setProperties operation. */
6623
+ declare type ShareSetPropertiesResponse_2 = ShareSetPropertiesHeaders;
5608
6624
 
5609
6625
  /**
5610
6626
  * Defines headers for setQuota operation.
@@ -5629,7 +6645,7 @@ export declare interface ShareSetQuotaOptions extends CommonOptions {
5629
6645
  /**
5630
6646
  * Contains response data for the setQuota operation.
5631
6647
  */
5632
- export declare type ShareSetQuotaResponse = ShareSetPropertiesResponse;
6648
+ export declare type ShareSetQuotaResponse = WithResponse<ShareSetQuotaHeaders, ShareSetQuotaHeaders>;
5633
6649
 
5634
6650
  /** Settings for SMB protocol. */
5635
6651
  export declare interface ShareSmbSettings {
@@ -5643,15 +6659,6 @@ export declare interface ShareStats {
5643
6659
  shareUsageBytes: number;
5644
6660
  }
5645
6661
 
5646
- /**
5647
- * Defines values for ShareTokenIntent. \
5648
- * {@link KnownShareTokenIntent} can be used interchangeably with ShareTokenIntent,
5649
- * this enum contains the known values that the service supports.
5650
- * ### Know values supported by the service
5651
- * **backup**
5652
- */
5653
- export declare type ShareTokenIntent = string;
5654
-
5655
6662
  /**
5656
6663
  * Signed Identifier
5657
6664
  */
@@ -5694,6 +6701,12 @@ export declare interface SmbMultichannel {
5694
6701
  enabled?: boolean;
5695
6702
  }
5696
6703
 
6704
+ /** Parameter group */
6705
+ declare interface SourceLeaseAccessConditions {
6706
+ /** Required if the source file has an active infinite lease. */
6707
+ sourceLeaseId?: string;
6708
+ }
6709
+
5697
6710
  /** Parameter group */
5698
6711
  export declare interface SourceModifiedAccessConditions {
5699
6712
  /** Specify the crc64 value to operate only on range with a matching crc64 checksum. */
@@ -5719,17 +6732,17 @@ export declare class StorageBrowserPolicy extends BaseRequestPolicy {
5719
6732
  * @param nextPolicy -
5720
6733
  * @param options -
5721
6734
  */
5722
- constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
6735
+ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
5723
6736
  /**
5724
6737
  * Sends out request.
5725
6738
  *
5726
6739
  * @param request -
5727
6740
  */
5728
- sendRequest(request: WebResource): Promise<HttpOperationResponse>;
6741
+ sendRequest(request: WebResourceLike): Promise<CompatResponse>;
5729
6742
  }
5730
6743
 
5731
6744
  /**
5732
- * StorageBrowserPolicyFactory is a factory class helping generating BrowserPolicy objects.
6745
+ * StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.
5733
6746
  */
5734
6747
  export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory {
5735
6748
  /**
@@ -5738,7 +6751,7 @@ export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory
5738
6751
  * @param nextPolicy -
5739
6752
  * @param options -
5740
6753
  */
5741
- create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageBrowserPolicy;
6754
+ create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageBrowserPolicy;
5742
6755
  }
5743
6756
 
5744
6757
  /**
@@ -5756,7 +6769,7 @@ declare abstract class StorageClient {
5756
6769
  * StorageClient is a reference to protocol layer operations entry, which is
5757
6770
  * generated by AutoRest generator.
5758
6771
  */
5759
- protected readonly storageClientContext: StorageClientContext;
6772
+ protected readonly storageClientContext: StorageClient_2;
5760
6773
  /**
5761
6774
  * Creates an instance of StorageClient.
5762
6775
  * @param url -
@@ -5765,21 +6778,25 @@ declare abstract class StorageClient {
5765
6778
  protected constructor(url: string, pipeline: Pipeline);
5766
6779
  }
5767
6780
 
5768
- declare class StorageClientContext extends coreHttp.ServiceClient {
6781
+ declare class StorageClient_2 extends coreHttpCompat.ExtendedServiceClient {
5769
6782
  url: string;
5770
6783
  version: string;
5771
6784
  fileRangeWriteFromUrl: string;
5772
6785
  /**
5773
- * Initializes a new instance of the StorageClientContext class.
6786
+ * Initializes a new instance of the StorageClient class.
5774
6787
  * @param url The URL of the service account, share, directory or file that is the target of the
5775
6788
  * desired operation.
5776
6789
  * @param options The parameter options
5777
6790
  */
5778
6791
  constructor(url: string, options?: StorageClientOptionalParams);
6792
+ service: Service;
6793
+ share: Share;
6794
+ directory: Directory;
6795
+ file: File_2;
5779
6796
  }
5780
6797
 
5781
6798
  /** Optional parameters. */
5782
- declare interface StorageClientOptionalParams extends coreHttp.ServiceClientOptions {
6799
+ declare interface StorageClientOptionalParams extends coreHttpCompat.ExtendedServiceClientOptions {
5783
6800
  /** Specifies the version of the operation to use for this request. */
5784
6801
  version?: string;
5785
6802
  /** Only update is supported: - Update: Writes the bytes downloaded from the source url into the specified range. */
@@ -5789,17 +6806,17 @@ declare interface StorageClientOptionalParams extends coreHttp.ServiceClientOpti
5789
6806
  }
5790
6807
 
5791
6808
  /**
5792
- * Option interface for {@link newPipeline} function.
6809
+ * Options interface for the {@link newPipeline} function.
5793
6810
  */
5794
6811
  export declare interface StoragePipelineOptions {
5795
6812
  /**
5796
6813
  * Options to configure a proxy for outgoing requests.
5797
6814
  */
5798
- proxyOptions?: ProxyOptions;
6815
+ proxyOptions?: ProxySettings;
5799
6816
  /**
5800
6817
  * Options for adding user agent details to outgoing requests.
5801
6818
  */
5802
- userAgentOptions?: UserAgentOptions;
6819
+ userAgentOptions?: UserAgentPolicyOptions;
5803
6820
  /**
5804
6821
  * Configures the built-in retry policy behavior.
5805
6822
  */
@@ -5811,11 +6828,15 @@ export declare interface StoragePipelineOptions {
5811
6828
  /**
5812
6829
  * Configures the HTTP client to send requests and receive responses.
5813
6830
  */
5814
- httpClient?: IHttpClient;
6831
+ httpClient?: RequestPolicy;
6832
+ /**
6833
+ * The audience used to retrieve an AAD token.
6834
+ */
6835
+ audience?: string | string[];
5815
6836
  }
5816
6837
 
5817
6838
  /**
5818
- * Retry options interface.
6839
+ * Storage Blob retry options interface.
5819
6840
  */
5820
6841
  export declare interface StorageRetryOptions {
5821
6842
  /**
@@ -5830,12 +6851,10 @@ export declare interface StorageRetryOptions {
5830
6851
  readonly maxTries?: number;
5831
6852
  /**
5832
6853
  * Optional. Indicates the maximum time in ms allowed for any single try of an HTTP request.
5833
- * A value of zero or undefined means that you accept our default timeout, 60s or 60 * 1000ms.
6854
+ * A value of zero or undefined means no default timeout on SDK client, Azure
6855
+ * Storage server's default timeout policy will be used.
5834
6856
  *
5835
- * NOTE: When transferring large amounts of data, the default TryTimeout will probably
5836
- * not be sufficient. You should override this value based on the bandwidth available to
5837
- * the host machine and proximity to the Storage service. A good starting point may be something
5838
- * like (60 seconds per MB of anticipated-payload-size)
6857
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations
5839
6858
  */
5840
6859
  readonly tryTimeoutInMs?: number;
5841
6860
  /**
@@ -5849,6 +6868,15 @@ export declare interface StorageRetryOptions {
5849
6868
  * If you specify 0, then you must also specify 0 for retryDelayInMs.
5850
6869
  */
5851
6870
  readonly maxRetryDelayInMs?: number;
6871
+ /**
6872
+ * If a secondaryHost is specified, retries will be tried against this host. If secondaryHost is undefined
6873
+ * (the default) then operations are not retried against another host.
6874
+ *
6875
+ * NOTE: Before setting this field, make sure you understand the issues around
6876
+ * reading stale and potentially-inconsistent data at
6877
+ * {@link https://docs.microsoft.com/en-us/azure/storage/common/storage-designing-ha-apps-with-ragrs}
6878
+ */
6879
+ readonly secondaryHost?: string;
5852
6880
  }
5853
6881
 
5854
6882
  /**
@@ -5866,25 +6894,24 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
5866
6894
  * @param options -
5867
6895
  * @param retryOptions -
5868
6896
  */
5869
- constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, retryOptions?: StorageRetryOptions);
6897
+ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, retryOptions?: StorageRetryOptions);
5870
6898
  /**
5871
6899
  * Sends request.
5872
6900
  *
5873
6901
  * @param request -
5874
6902
  */
5875
- sendRequest(request: WebResource): Promise<HttpOperationResponse>;
6903
+ sendRequest(request: WebResourceLike): Promise<CompatResponse>;
5876
6904
  /**
5877
6905
  * Decide and perform next retry. Won't mutate request parameter.
5878
6906
  *
5879
6907
  * @param request -
5880
- * @param response -
5881
6908
  * @param secondaryHas404 - If attempt was against the secondary & it returned a StatusNotFound (404), then
5882
6909
  * the resource was not found. This may be due to replication delay. So, in this
5883
6910
  * case, we'll never try the secondary again for this operation.
5884
6911
  * @param attempt - How many retries has been attempted to performed, starting from 1, which includes
5885
6912
  * the attempt will be performed by this method call.
5886
6913
  */
5887
- protected attemptSendRequest(request: WebResource, secondaryHas404: boolean, attempt: number): Promise<HttpOperationResponse>;
6914
+ protected attemptSendRequest(request: WebResourceLike, secondaryHas404: boolean, attempt: number): Promise<CompatResponse>;
5888
6915
  /**
5889
6916
  * Decide whether to retry according to last HTTP response and retry counters.
5890
6917
  *
@@ -5893,7 +6920,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
5893
6920
  * @param response -
5894
6921
  * @param err -
5895
6922
  */
5896
- protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: HttpOperationResponse, err?: RestError): boolean;
6923
+ protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: CompatResponse, err?: RestError): boolean;
5897
6924
  /**
5898
6925
  * Delay a calculated time between retries.
5899
6926
  *
@@ -5905,7 +6932,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
5905
6932
  }
5906
6933
 
5907
6934
  /**
5908
- * StorageRetryPolicyFactory is a factory class helping generating StorageRetryPolicy objects.
6935
+ * StorageRetryPolicyFactory is a factory class helping generating {@link StorageRetryPolicy} objects.
5909
6936
  */
5910
6937
  export declare class StorageRetryPolicyFactory implements RequestPolicyFactory {
5911
6938
  private retryOptions?;
@@ -5916,10 +6943,11 @@ export declare class StorageRetryPolicyFactory implements RequestPolicyFactory {
5916
6943
  constructor(retryOptions?: StorageRetryOptions);
5917
6944
  /**
5918
6945
  * Creates a StorageRetryPolicy object.
6946
+ *
5919
6947
  * @param nextPolicy -
5920
6948
  * @param options -
5921
6949
  */
5922
- create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageRetryPolicy;
6950
+ create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageRetryPolicy;
5923
6951
  }
5924
6952
 
5925
6953
  /**
@@ -5957,12 +6985,12 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
5957
6985
  */
5958
6986
  constructor(accountName: string, accountKey: string);
5959
6987
  /**
5960
- * Creates a {@link StorageSharedKeyCredentialPolicy} object.
6988
+ * Creates a StorageSharedKeyCredentialPolicy object.
5961
6989
  *
5962
6990
  * @param nextPolicy -
5963
6991
  * @param options -
5964
6992
  */
5965
- create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageSharedKeyCredentialPolicy;
6993
+ create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageSharedKeyCredentialPolicy;
5966
6994
  /**
5967
6995
  * Generates a hash signature for an HTTP request or for a SAS.
5968
6996
  *
@@ -5976,7 +7004,7 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
5976
7004
  */
5977
7005
  export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
5978
7006
  /**
5979
- * Reference to {@link StorageSharedKeyCredential} which generates StorageSharedKeyCredentialPolicy
7007
+ * Reference to StorageSharedKeyCredential which generates StorageSharedKeyCredentialPolicy
5980
7008
  */
5981
7009
  private readonly factory;
5982
7010
  /**
@@ -5985,13 +7013,13 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
5985
7013
  * @param options -
5986
7014
  * @param factory -
5987
7015
  */
5988
- constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, factory: StorageSharedKeyCredential);
7016
+ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, factory: StorageSharedKeyCredential);
5989
7017
  /**
5990
7018
  * Signs request.
5991
7019
  *
5992
7020
  * @param request -
5993
7021
  */
5994
- protected signRequest(request: WebResource): WebResource;
7022
+ protected signRequest(request: WebResourceLike): WebResourceLike;
5995
7023
  /**
5996
7024
  * Retrieve header value according to shared key sign rules.
5997
7025
  * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
@@ -6032,6 +7060,9 @@ export declare type TimeNowType = "now";
6032
7060
  */
6033
7061
  export declare type TimePreserveType = "preserve";
6034
7062
 
6035
- export { WebResource }
7063
+ /**
7064
+ * A type that represents an operation result with a known _response property.
7065
+ */
7066
+ export declare type WithResponse<T, Headers = undefined, Body = undefined> = T & (Body extends object ? ResponseWithBody<Headers, Body> : Headers extends object ? ResponseWithHeaders<Headers> : ResponseLike);
6036
7067
 
6037
7068
  export { }