@azure/storage-file-share 12.15.0-beta.1 → 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 +7060 -7656
  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 -64
  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 -532
  237. package/types/latest/storage-file-share.d.ts +1571 -544
  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
@@ -1,28 +1,26 @@
1
1
  /// <reference types="node" />
2
2
  import { AbortSignalLike } from '@azure/abort-controller';
3
3
  import { AzureLogger } from '@azure/logger';
4
- import { BaseRequestPolicy } from '@azure/core-http';
5
- import * as coreHttp from '@azure/core-http';
6
- import { deserializationPolicy } from '@azure/core-http';
7
- import { HttpHeaders } from '@azure/core-http';
8
- import { HttpOperationResponse } from '@azure/core-http';
9
- import { HttpRequestBody } from '@azure/core-http';
10
- import { HttpResponse } from '@azure/core-http';
11
- import { HttpClient as IHttpClient } from '@azure/core-http';
12
- import { KeepAliveOptions } from '@azure/core-http';
4
+ import { CompatResponse } from '@azure/core-http-compat';
5
+ import * as coreClient from '@azure/core-client';
6
+ import * as coreHttpCompat from '@azure/core-http-compat';
7
+ import * as coreRestPipeline from '@azure/core-rest-pipeline';
8
+ import { HttpHeadersLike } from '@azure/core-http-compat';
9
+ import { HttpPipelineLogLevel } from '@azure/core-http-compat';
10
+ import { KeepAliveOptions } from '@azure/core-http-compat';
13
11
  import { OperationTracingOptions } from '@azure/core-tracing';
14
12
  import { PagedAsyncIterableIterator } from '@azure/core-paging';
15
- import { ProxyOptions } from '@azure/core-http';
13
+ import { ProxySettings } from '@azure/core-rest-pipeline';
16
14
  import { Readable } from 'stream';
17
- import { RequestPolicy } from '@azure/core-http';
18
- import { RequestPolicyFactory } from '@azure/core-http';
19
- import { RequestPolicyOptions } from '@azure/core-http';
20
- import { RestError } from '@azure/core-http';
21
- import { ServiceClientOptions } from '@azure/core-http';
22
- import { TokenCredential } from '@azure/core-http';
23
- import { TransferProgressEvent } from '@azure/core-http';
24
- import { UserAgentOptions } from '@azure/core-http';
25
- import { WebResource } from '@azure/core-http';
15
+ import { RequestBodyType } from '@azure/core-rest-pipeline';
16
+ import { RequestPolicy } from '@azure/core-http-compat';
17
+ import { RequestPolicyFactory } from '@azure/core-http-compat';
18
+ import { RequestPolicyOptionsLike } from '@azure/core-http-compat';
19
+ import { RestError } from '@azure/core-rest-pipeline';
20
+ import { TokenCredential } from '@azure/core-auth';
21
+ import { TransferProgressEvent } from '@azure/core-rest-pipeline';
22
+ import { UserAgentPolicyOptions } from '@azure/core-rest-pipeline';
23
+ import { WebResourceLike } from '@azure/core-http-compat';
26
24
  /** An Access policy. */
27
25
  export declare interface AccessPolicy {
28
26
  /** The date-time the policy is active. */
@@ -222,7 +220,7 @@ export declare interface AccountSASSignatureValues {
222
220
  }
223
221
  /**
224
222
  * AnonymousCredential provides a credentialPolicyCreator member used to create
225
- * {@link AnonymousCredentialPolicy} objects. AnonymousCredentialPolicy is used with
223
+ * AnonymousCredentialPolicy objects. AnonymousCredentialPolicy is used with
226
224
  * HTTP(S) requests that read public resources or for use with Shared Access
227
225
  * Signatures (SAS).
228
226
  */
@@ -233,7 +231,7 @@ export declare class AnonymousCredential extends Credential_2 {
233
231
  * @param nextPolicy -
234
232
  * @param options -
235
233
  */
236
- create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): AnonymousCredentialPolicy;
234
+ create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): AnonymousCredentialPolicy;
237
235
  }
238
236
  /**
239
237
  * AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources
@@ -245,9 +243,51 @@ export declare class AnonymousCredentialPolicy extends CredentialPolicy {
245
243
  * @param nextPolicy -
246
244
  * @param options -
247
245
  */
248
- constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
246
+ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
247
+ }
248
+ /**
249
+ * The base class from which all request policies derive.
250
+ */
251
+ export declare abstract class BaseRequestPolicy implements RequestPolicy {
252
+ /**
253
+ * The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
254
+ */
255
+ readonly _nextPolicy: RequestPolicy;
256
+ /**
257
+ * The options that can be passed to a given request policy.
258
+ */
259
+ readonly _options: RequestPolicyOptionsLike;
260
+ /**
261
+ * The main method to implement that manipulates a request/response.
262
+ */
263
+ protected constructor(
264
+ /**
265
+ * The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
266
+ */
267
+ _nextPolicy: RequestPolicy,
268
+ /**
269
+ * The options that can be passed to a given request policy.
270
+ */
271
+ _options: RequestPolicyOptionsLike);
272
+ /**
273
+ * Sends a network request based on the given web resource.
274
+ * @param webResource - A {@link WebResourceLike} that describes a HTTP request to be made.
275
+ */
276
+ abstract sendRequest(webResource: WebResourceLike): Promise<CompatResponse>;
277
+ /**
278
+ * Get whether or not a log with the provided log level should be logged.
279
+ * @param logLevel - The log level of the log that will be logged.
280
+ * @returns Whether or not a log with the provided log level should be logged.
281
+ */
282
+ shouldLog(logLevel: HttpPipelineLogLevel): boolean;
283
+ /**
284
+ * Attempt to log the provided message to the provided logger. If no logger was provided or if
285
+ * the log level does not meat the logger's threshold, then nothing will be logged.
286
+ * @param logLevel - The log level of this log.
287
+ * @param message - The message of this log.
288
+ */
289
+ log(logLevel: HttpPipelineLogLevel, message: string): void;
249
290
  }
250
- export { BaseRequestPolicy };
251
291
  export declare interface ClearRange {
252
292
  start: number;
253
293
  end: number;
@@ -363,7 +403,7 @@ declare abstract class Credential_2 implements RequestPolicyFactory {
363
403
  * @param _nextPolicy -
364
404
  * @param _options -
365
405
  */
366
- create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
406
+ create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptionsLike): RequestPolicy;
367
407
  }
368
408
  export { Credential_2 as Credential };
369
409
  /**
@@ -376,22 +416,85 @@ export declare abstract class CredentialPolicy extends BaseRequestPolicy {
376
416
  *
377
417
  * @param request -
378
418
  */
379
- sendRequest(request: WebResource): Promise<HttpOperationResponse>;
419
+ sendRequest(request: WebResourceLike): Promise<CompatResponse>;
380
420
  /**
381
421
  * Child classes must implement this method with request signing. This method
382
422
  * will be executed in {@link sendRequest}.
383
423
  *
384
424
  * @param request -
385
425
  */
386
- protected signRequest(request: WebResource): WebResource;
426
+ protected signRequest(request: WebResourceLike): WebResourceLike;
387
427
  }
388
428
  /**
389
429
  * A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
390
430
  */
391
- export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptions) => CredentialPolicy;
431
+ export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike) => CredentialPolicy;
392
432
  /** Defines values for DeleteSnapshotsOptionType. */
393
433
  export declare type DeleteSnapshotsOptionType = "include" | "include-leased";
394
- export { deserializationPolicy };
434
+ /** Parameter group */
435
+ declare interface DestinationLeaseAccessConditions {
436
+ /** 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). */
437
+ destinationLeaseId?: string;
438
+ }
439
+ /** Interface representing a Directory. */
440
+ declare interface Directory {
441
+ /**
442
+ * Creates a new directory under the specified share or parent directory.
443
+ * @param fileAttributes If specified, the provided file attributes shall be set. Default value:
444
+ * ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
445
+ * @param options The options parameters.
446
+ */
447
+ create(fileAttributes: string, options?: DirectoryCreateOptionalParams): Promise<DirectoryCreateResponse_2>;
448
+ /**
449
+ * Returns all system properties for the specified directory, and can also be used to check the
450
+ * existence of a directory. The data returned does not include the files in the directory or any
451
+ * subdirectories.
452
+ * @param options The options parameters.
453
+ */
454
+ getProperties(options?: DirectoryGetPropertiesOptionalParams): Promise<DirectoryGetPropertiesResponse_2>;
455
+ /**
456
+ * Removes the specified empty directory. Note that the directory must be empty before it can be
457
+ * deleted.
458
+ * @param options The options parameters.
459
+ */
460
+ delete(options?: DirectoryDeleteOptionalParams): Promise<DirectoryDeleteResponse_2>;
461
+ /**
462
+ * Sets properties on the directory.
463
+ * @param fileAttributes If specified, the provided file attributes shall be set. Default value:
464
+ * ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
465
+ * @param options The options parameters.
466
+ */
467
+ setProperties(fileAttributes: string, options?: DirectorySetPropertiesOptionalParams): Promise<DirectorySetPropertiesResponse_2>;
468
+ /**
469
+ * Updates user defined metadata for the specified directory.
470
+ * @param options The options parameters.
471
+ */
472
+ setMetadata(options?: DirectorySetMetadataOptionalParams): Promise<DirectorySetMetadataResponse_2>;
473
+ /**
474
+ * Returns a list of files or directories under the specified share or directory. It lists the contents
475
+ * only for a single level of the directory hierarchy.
476
+ * @param options The options parameters.
477
+ */
478
+ listFilesAndDirectoriesSegment(options?: DirectoryListFilesAndDirectoriesSegmentOptionalParams): Promise<DirectoryListFilesAndDirectoriesSegmentResponse_2>;
479
+ /**
480
+ * Lists handles for directory.
481
+ * @param options The options parameters.
482
+ */
483
+ listHandles(options?: DirectoryListHandlesOptionalParams): Promise<DirectoryListHandlesResponse_2>;
484
+ /**
485
+ * Closes all handles open for given directory.
486
+ * @param handleId Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is
487
+ * a wildcard that specifies all handles.
488
+ * @param options The options parameters.
489
+ */
490
+ forceCloseHandles(handleId: string, options?: DirectoryForceCloseHandlesOptionalParams): Promise<DirectoryForceCloseHandlesResponse_2>;
491
+ /**
492
+ * Renames a directory
493
+ * @param renameSource Required. Specifies the URI-style path of the source file, up to 2 KB in length.
494
+ * @param options The options parameters.
495
+ */
496
+ rename(renameSource: string, options?: DirectoryRenameOptionalParams): Promise<DirectoryRenameResponse_2>;
497
+ }
395
498
  /**
396
499
  * Additional response header values for close handles request.
397
500
  */
@@ -456,6 +559,25 @@ export declare interface DirectoryCreateIfNotExistsResponse extends DirectoryCre
456
559
  */
457
560
  succeeded: boolean;
458
561
  }
562
+ /** Optional parameters. */
563
+ declare interface DirectoryCreateOptionalParams extends coreClient.OperationOptions {
564
+ /** 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> */
565
+ timeoutInSeconds?: number;
566
+ /** A name-value pair to associate with a file storage object. */
567
+ metadata?: {
568
+ [propertyName: string]: string;
569
+ };
570
+ /** If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified. */
571
+ filePermission?: string;
572
+ /** 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. */
573
+ filePermissionKey?: string;
574
+ /** Creation time for the file/directory. Default value: Now. */
575
+ fileCreatedOn?: string;
576
+ /** Last write time for the file/directory. Default value: Now. */
577
+ fileLastWriteOn?: string;
578
+ /** Change time for the file/directory. Default value: Now. */
579
+ fileChangeOn?: string;
580
+ }
459
581
  /**
460
582
  * Options to configure {@link ShareDirectoryClient.create} operation.
461
583
  */
@@ -471,13 +593,9 @@ export declare interface DirectoryCreateOptions extends FileAndDirectoryCreateCo
471
593
  metadata?: Metadata;
472
594
  }
473
595
  /** Contains response data for the create operation. */
474
- export declare type DirectoryCreateResponse = DirectoryCreateHeaders & {
475
- /** The underlying HTTP response. */
476
- _response: coreHttp.HttpResponse & {
477
- /** The parsed HTTP response headers. */
478
- parsedHeaders: DirectoryCreateHeaders;
479
- };
480
- };
596
+ export declare type DirectoryCreateResponse = WithResponse<DirectoryCreateHeaders, DirectoryCreateHeaders>;
597
+ /** Contains response data for the create operation. */
598
+ declare type DirectoryCreateResponse_2 = DirectoryCreateHeaders;
481
599
  /** Defines headers for Directory_delete operation. */
482
600
  export declare interface DirectoryDeleteHeaders {
483
601
  /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
@@ -498,6 +616,11 @@ export declare interface DirectoryDeleteIfExistsResponse extends DirectoryDelete
498
616
  */
499
617
  succeeded: boolean;
500
618
  }
619
+ /** Optional parameters. */
620
+ declare interface DirectoryDeleteOptionalParams extends coreClient.OperationOptions {
621
+ /** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a> */
622
+ timeoutInSeconds?: number;
623
+ }
501
624
  /**
502
625
  * Options to configure the {@link ShareDirectoryClient.delete} operation.
503
626
  */
@@ -509,13 +632,9 @@ export declare interface DirectoryDeleteOptions extends CommonOptions {
509
632
  abortSignal?: AbortSignalLike;
510
633
  }
511
634
  /** Contains response data for the delete operation. */
512
- export declare type DirectoryDeleteResponse = DirectoryDeleteHeaders & {
513
- /** The underlying HTTP response. */
514
- _response: coreHttp.HttpResponse & {
515
- /** The parsed HTTP response headers. */
516
- parsedHeaders: DirectoryDeleteHeaders;
517
- };
518
- };
635
+ export declare type DirectoryDeleteResponse = WithResponse<DirectoryDeleteHeaders, DirectoryDeleteHeaders>;
636
+ /** Contains response data for the delete operation. */
637
+ declare type DirectoryDeleteResponse_2 = DirectoryDeleteHeaders;
519
638
  /**
520
639
  * Options to configure the {@link ShareDirectoryClient.exists} operation.
521
640
  */
@@ -543,6 +662,17 @@ export declare interface DirectoryForceCloseHandlesHeaders {
543
662
  /** Error Code */
544
663
  errorCode?: string;
545
664
  }
665
+ /** Optional parameters. */
666
+ declare interface DirectoryForceCloseHandlesOptionalParams extends coreClient.OperationOptions {
667
+ /** 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> */
668
+ timeoutInSeconds?: number;
669
+ /** 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. */
670
+ marker?: string;
671
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
672
+ shareSnapshot?: string;
673
+ /** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
674
+ recursive?: boolean;
675
+ }
546
676
  /**
547
677
  * Options to configure {@link ShareDirectoryClient.forceCloseHandle}.
548
678
  */
@@ -556,17 +686,9 @@ export declare interface DirectoryForceCloseHandlesOptions extends CommonOptions
556
686
  /**
557
687
  * Response type for {@link ShareDirectoryClient.forceCloseHandle}.
558
688
  */
559
- export declare type DirectoryForceCloseHandlesResponse = CloseHandlesInfo & DirectoryCloseHandlesHeaders & {
560
- /**
561
- * The underlying HTTP response.
562
- */
563
- _response: HttpResponse & {
564
- /**
565
- * The parsed HTTP response headers.
566
- */
567
- parsedHeaders: DirectoryForceCloseHandlesHeaders;
568
- };
569
- };
689
+ export declare type DirectoryForceCloseHandlesResponse = WithResponse<CloseHandlesInfo & DirectoryCloseHandlesHeaders, DirectoryForceCloseHandlesHeaders>;
690
+ /** Contains response data for the forceCloseHandles operation. */
691
+ declare type DirectoryForceCloseHandlesResponse_2 = DirectoryForceCloseHandlesHeaders;
570
692
  /**
571
693
  * Options to configure Directory - Force Close Handles Segment operations.
572
694
  *
@@ -621,6 +743,13 @@ export declare interface DirectoryGetPropertiesHeaders {
621
743
  /** Error Code */
622
744
  errorCode?: string;
623
745
  }
746
+ /** Optional parameters. */
747
+ declare interface DirectoryGetPropertiesOptionalParams extends coreClient.OperationOptions {
748
+ /** 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> */
749
+ timeoutInSeconds?: number;
750
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
751
+ shareSnapshot?: string;
752
+ }
624
753
  /**
625
754
  * Options to configure the {@link ShareDirectoryClient.getProperties} operation.
626
755
  */
@@ -632,13 +761,9 @@ export declare interface DirectoryGetPropertiesOptions extends CommonOptions {
632
761
  abortSignal?: AbortSignalLike;
633
762
  }
634
763
  /** Contains response data for the getProperties operation. */
635
- export declare type DirectoryGetPropertiesResponse = DirectoryGetPropertiesHeaders & {
636
- /** The underlying HTTP response. */
637
- _response: coreHttp.HttpResponse & {
638
- /** The parsed HTTP response headers. */
639
- parsedHeaders: DirectoryGetPropertiesHeaders;
640
- };
641
- };
764
+ export declare type DirectoryGetPropertiesResponse = WithResponse<DirectoryGetPropertiesHeaders, DirectoryGetPropertiesHeaders>;
765
+ /** Contains response data for the getProperties operation. */
766
+ declare type DirectoryGetPropertiesResponse_2 = DirectoryGetPropertiesHeaders;
642
767
  /** A listed directory item. */
643
768
  export declare interface DirectoryItem {
644
769
  name: string;
@@ -685,18 +810,27 @@ export declare interface DirectoryListFilesAndDirectoriesSegmentHeaders {
685
810
  /** Error Code */
686
811
  errorCode?: string;
687
812
  }
813
+ /** Optional parameters. */
814
+ declare interface DirectoryListFilesAndDirectoriesSegmentOptionalParams extends coreClient.OperationOptions {
815
+ /** 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> */
816
+ timeoutInSeconds?: number;
817
+ /** Filters the results to return only entries whose name begins with the specified prefix. */
818
+ prefix?: string;
819
+ /** 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. */
820
+ marker?: string;
821
+ /** 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. */
822
+ maxResults?: number;
823
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
824
+ shareSnapshot?: string;
825
+ /** Include this parameter to specify one or more datasets to include in the response. */
826
+ include?: ListFilesIncludeType[];
827
+ /** Include extended information. */
828
+ includeExtendedInfo?: boolean;
829
+ }
688
830
  /** Contains response data for the listFilesAndDirectoriesSegment operation. */
689
- export declare type DirectoryListFilesAndDirectoriesSegmentResponse = DirectoryListFilesAndDirectoriesSegmentHeaders & ListFilesAndDirectoriesSegmentResponse & {
690
- /** The underlying HTTP response. */
691
- _response: coreHttp.HttpResponse & {
692
- /** The response body as text (string format) */
693
- bodyAsText: string;
694
- /** The response body as parsed JSON or XML */
695
- parsedBody: ListFilesAndDirectoriesSegmentResponse;
696
- /** The parsed HTTP response headers. */
697
- parsedHeaders: DirectoryListFilesAndDirectoriesSegmentHeaders;
698
- };
699
- };
831
+ export declare type DirectoryListFilesAndDirectoriesSegmentResponse = WithResponse<DirectoryListFilesAndDirectoriesSegmentHeaders & ListFilesAndDirectoriesSegmentResponse, DirectoryListFilesAndDirectoriesSegmentHeaders, ListFilesAndDirectoriesSegmentResponse>;
832
+ /** Contains response data for the listFilesAndDirectoriesSegment operation. */
833
+ declare type DirectoryListFilesAndDirectoriesSegmentResponse_2 = DirectoryListFilesAndDirectoriesSegmentHeaders & ListFilesAndDirectoriesSegmentResponse;
700
834
  /** Defines headers for Directory_listHandles operation. */
701
835
  export declare interface DirectoryListHandlesHeaders {
702
836
  /** Specifies the format in which the results are returned. Currently this value is 'application/xml'. */
@@ -710,6 +844,19 @@ export declare interface DirectoryListHandlesHeaders {
710
844
  /** Error Code */
711
845
  errorCode?: string;
712
846
  }
847
+ /** Optional parameters. */
848
+ declare interface DirectoryListHandlesOptionalParams extends coreClient.OperationOptions {
849
+ /** 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> */
850
+ timeoutInSeconds?: number;
851
+ /** 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. */
852
+ marker?: string;
853
+ /** 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. */
854
+ maxResults?: number;
855
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
856
+ shareSnapshot?: string;
857
+ /** Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files. */
858
+ recursive?: boolean;
859
+ }
713
860
  /**
714
861
  * Options to configure the {@link ShareDirectoryClient.listHandles} operation.
715
862
  */
@@ -726,17 +873,9 @@ export declare interface DirectoryListHandlesOptions extends CommonOptions {
726
873
  recursive?: boolean;
727
874
  }
728
875
  /** Contains response data for the listHandles operation. */
729
- export declare type DirectoryListHandlesResponse = DirectoryListHandlesHeaders & ListHandlesResponse & {
730
- /** The underlying HTTP response. */
731
- _response: coreHttp.HttpResponse & {
732
- /** The response body as text (string format) */
733
- bodyAsText: string;
734
- /** The response body as parsed JSON or XML */
735
- parsedBody: ListHandlesResponse;
736
- /** The parsed HTTP response headers. */
737
- parsedHeaders: DirectoryListHandlesHeaders;
738
- };
739
- };
876
+ export declare type DirectoryListHandlesResponse = WithResponse<DirectoryListHandlesHeaders & ListHandlesResponse, DirectoryListHandlesHeaders, ListHandlesResponse>;
877
+ /** Contains response data for the listHandles operation. */
878
+ declare type DirectoryListHandlesResponse_2 = DirectoryListHandlesHeaders & ListHandlesResponse;
740
879
  /**
741
880
  * Options to configure Directory - List Handles Segment operations.
742
881
  *
@@ -799,6 +938,29 @@ export declare interface DirectoryRenameHeaders {
799
938
  /** The parent fileId of the directory. */
800
939
  fileParentId?: string;
801
940
  }
941
+ /** Optional parameters. */
942
+ declare interface DirectoryRenameOptionalParams extends coreClient.OperationOptions {
943
+ /** Parameter group */
944
+ sourceLeaseAccessConditions?: SourceLeaseAccessConditions;
945
+ /** Parameter group */
946
+ destinationLeaseAccessConditions?: DestinationLeaseAccessConditions;
947
+ /** Parameter group */
948
+ copyFileSmbInfo?: CopyFileSmbInfo;
949
+ /** 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> */
950
+ timeoutInSeconds?: number;
951
+ /** A name-value pair to associate with a file storage object. */
952
+ metadata?: {
953
+ [propertyName: string]: string;
954
+ };
955
+ /** 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. */
956
+ filePermission?: string;
957
+ /** 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. */
958
+ filePermissionKey?: string;
959
+ /** 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. */
960
+ replaceIfExists?: boolean;
961
+ /** 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. */
962
+ ignoreReadOnly?: boolean;
963
+ }
802
964
  /**
803
965
  * Options to configure the {@link ShareDirectoryClient.rename} operation.
804
966
  */
@@ -853,13 +1015,9 @@ export declare interface DirectoryRenameOptions extends CommonOptions {
853
1015
  ignoreReadOnly?: boolean;
854
1016
  }
855
1017
  /** Contains response data for the rename operation. */
856
- export declare type DirectoryRenameResponse = DirectoryRenameHeaders & {
857
- /** The underlying HTTP response. */
858
- _response: coreHttp.HttpResponse & {
859
- /** The parsed HTTP response headers. */
860
- parsedHeaders: DirectoryRenameHeaders;
861
- };
862
- };
1018
+ export declare type DirectoryRenameResponse = WithResponse<DirectoryRenameHeaders, DirectoryRenameHeaders>;
1019
+ /** Contains response data for the rename operation. */
1020
+ declare type DirectoryRenameResponse_2 = DirectoryRenameHeaders;
863
1021
  /** Defines headers for Directory_setMetadata operation. */
864
1022
  export declare interface DirectorySetMetadataHeaders {
865
1023
  /** The ETag contains a value which represents the version of the directory, in quotes. */
@@ -875,6 +1033,15 @@ export declare interface DirectorySetMetadataHeaders {
875
1033
  /** Error Code */
876
1034
  errorCode?: string;
877
1035
  }
1036
+ /** Optional parameters. */
1037
+ declare interface DirectorySetMetadataOptionalParams extends coreClient.OperationOptions {
1038
+ /** 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> */
1039
+ timeoutInSeconds?: number;
1040
+ /** A name-value pair to associate with a file storage object. */
1041
+ metadata?: {
1042
+ [propertyName: string]: string;
1043
+ };
1044
+ }
878
1045
  /**
879
1046
  * Options to configure the {@link ShareDirectoryClient.setMetadata} operation.
880
1047
  */
@@ -886,13 +1053,9 @@ export declare interface DirectorySetMetadataOptions extends CommonOptions {
886
1053
  abortSignal?: AbortSignalLike;
887
1054
  }
888
1055
  /** Contains response data for the setMetadata operation. */
889
- export declare type DirectorySetMetadataResponse = DirectorySetMetadataHeaders & {
890
- /** The underlying HTTP response. */
891
- _response: coreHttp.HttpResponse & {
892
- /** The parsed HTTP response headers. */
893
- parsedHeaders: DirectorySetMetadataHeaders;
894
- };
895
- };
1056
+ export declare type DirectorySetMetadataResponse = WithResponse<DirectorySetMetadataHeaders, DirectorySetMetadataHeaders>;
1057
+ /** Contains response data for the setMetadata operation. */
1058
+ declare type DirectorySetMetadataResponse_2 = DirectorySetMetadataHeaders;
896
1059
  /** Defines headers for Directory_setProperties operation. */
897
1060
  export declare interface DirectorySetPropertiesHeaders {
898
1061
  /** The ETag contains a value which represents the version of the file, in quotes. */
@@ -924,14 +1087,163 @@ export declare interface DirectorySetPropertiesHeaders {
924
1087
  /** Error Code */
925
1088
  errorCode?: string;
926
1089
  }
1090
+ /** Optional parameters. */
1091
+ declare interface DirectorySetPropertiesOptionalParams extends coreClient.OperationOptions {
1092
+ /** 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> */
1093
+ timeoutInSeconds?: number;
1094
+ /** 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. */
1095
+ filePermission?: string;
1096
+ /** 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. */
1097
+ filePermissionKey?: string;
1098
+ /** Creation time for the file/directory. Default value: Now. */
1099
+ fileCreatedOn?: string;
1100
+ /** Last write time for the file/directory. Default value: Now. */
1101
+ fileLastWriteOn?: string;
1102
+ /** Change time for the file/directory. Default value: Now. */
1103
+ fileChangeOn?: string;
1104
+ }
927
1105
  /** Contains response data for the setProperties operation. */
928
- export declare type DirectorySetPropertiesResponse = DirectorySetPropertiesHeaders & {
929
- /** The underlying HTTP response. */
930
- _response: coreHttp.HttpResponse & {
931
- /** The parsed HTTP response headers. */
932
- parsedHeaders: DirectorySetPropertiesHeaders;
933
- };
934
- };
1106
+ export declare type DirectorySetPropertiesResponse = WithResponse<DirectorySetPropertiesHeaders, DirectorySetPropertiesHeaders>;
1107
+ /** Contains response data for the setProperties operation. */
1108
+ declare type DirectorySetPropertiesResponse_2 = DirectorySetPropertiesHeaders;
1109
+ /** Interface representing a File. */
1110
+ declare interface File_2 {
1111
+ /**
1112
+ * Creates a new file or replaces a file. Note it only initializes the file with no content.
1113
+ * @param fileContentLength Specifies the maximum size for the file, up to 4 TB.
1114
+ * @param fileAttributes If specified, the provided file attributes shall be set. Default value:
1115
+ * ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
1116
+ * @param options The options parameters.
1117
+ */
1118
+ create(fileContentLength: number, fileAttributes: string, options?: FileCreateOptionalParams): Promise<FileCreateResponse_2>;
1119
+ /**
1120
+ * Reads or downloads a file from the system, including its metadata and properties.
1121
+ * @param options The options parameters.
1122
+ */
1123
+ download(options?: FileDownloadOptionalParams): Promise<RawFileDownloadResponse>;
1124
+ /**
1125
+ * Returns all user-defined metadata, standard HTTP properties, and system properties for the file. It
1126
+ * does not return the content of the file.
1127
+ * @param options The options parameters.
1128
+ */
1129
+ getProperties(options?: FileGetPropertiesOptionalParams): Promise<FileGetPropertiesResponse_2>;
1130
+ /**
1131
+ * removes the file from the storage account.
1132
+ * @param options The options parameters.
1133
+ */
1134
+ delete(options?: FileDeleteOptionalParams): Promise<FileDeleteResponse_2>;
1135
+ /**
1136
+ * Sets HTTP headers on the file.
1137
+ * @param fileAttributes If specified, the provided file attributes shall be set. Default value:
1138
+ * ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.
1139
+ * @param options The options parameters.
1140
+ */
1141
+ setHttpHeaders(fileAttributes: string, options?: FileSetHttpHeadersOptionalParams): Promise<FileSetHttpHeadersResponse>;
1142
+ /**
1143
+ * Updates user-defined metadata for the specified file.
1144
+ * @param options The options parameters.
1145
+ */
1146
+ setMetadata(options?: FileSetMetadataOptionalParams): Promise<FileSetMetadataResponse_2>;
1147
+ /**
1148
+ * [Update] The Lease File operation establishes and manages a lock on a file for write and delete
1149
+ * operations
1150
+ * @param options The options parameters.
1151
+ */
1152
+ acquireLease(options?: FileAcquireLeaseOptionalParams): Promise<FileAcquireLeaseResponse>;
1153
+ /**
1154
+ * [Update] The Lease File operation establishes and manages a lock on a file for write and delete
1155
+ * operations
1156
+ * @param leaseId Specifies the current lease ID on the resource.
1157
+ * @param options The options parameters.
1158
+ */
1159
+ releaseLease(leaseId: string, options?: FileReleaseLeaseOptionalParams): Promise<FileReleaseLeaseResponse>;
1160
+ /**
1161
+ * [Update] The Lease File operation establishes and manages a lock on a file for write and delete
1162
+ * operations
1163
+ * @param leaseId Specifies the current lease ID on the resource.
1164
+ * @param options The options parameters.
1165
+ */
1166
+ changeLease(leaseId: string, options?: FileChangeLeaseOptionalParams): Promise<FileChangeLeaseResponse>;
1167
+ /**
1168
+ * [Update] The Lease File operation establishes and manages a lock on a file for write and delete
1169
+ * operations
1170
+ * @param options The options parameters.
1171
+ */
1172
+ breakLease(options?: FileBreakLeaseOptionalParams): Promise<FileBreakLeaseResponse>;
1173
+ /**
1174
+ * Upload a range of bytes to a file.
1175
+ * @param range Specifies the range of bytes to be written. Both the start and end of the range must be
1176
+ * specified. For an update operation, the range can be up to 4 MB in size. For a clear operation, the
1177
+ * range can be up to the value of the file's full size. The File service accepts only a single byte
1178
+ * range for the Range and 'x-ms-range' headers, and the byte range must be specified in the following
1179
+ * format: bytes=startByte-endByte.
1180
+ * @param fileRangeWrite Specify one of the following options: - Update: Writes the bytes specified by
1181
+ * the request body into the specified range. The Range and Content-Length headers must match to
1182
+ * perform the update. - Clear: Clears the specified range and releases the space used in storage for
1183
+ * that range. To clear a range, set the Content-Length header to zero, and set the Range header to a
1184
+ * value that indicates the range to clear, up to maximum file size.
1185
+ * @param contentLength Specifies the number of bytes being transmitted in the request body. When the
1186
+ * x-ms-write header is set to clear, the value of this header must be set to zero.
1187
+ * @param options The options parameters.
1188
+ */
1189
+ uploadRange(range: string, fileRangeWrite: FileRangeWriteType, contentLength: number, options?: FileUploadRangeOptionalParams): Promise<FileUploadRangeResponse_2>;
1190
+ /**
1191
+ * Upload a range of bytes to a file where the contents are read from a URL.
1192
+ * @param range Writes data to the specified byte range in the file.
1193
+ * @param copySource Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file
1194
+ * to another file within the same storage account, you may use Shared Key to authenticate the source
1195
+ * file. If you are copying a file from another storage account, or if you are copying a blob from the
1196
+ * same storage account or another storage account, then you must authenticate the source file or blob
1197
+ * using a shared access signature. If the source is a public blob, no authentication is required to
1198
+ * perform the copy operation. A file in a share snapshot can also be specified as a copy source.
1199
+ * @param contentLength Specifies the number of bytes being transmitted in the request body. When the
1200
+ * x-ms-write header is set to clear, the value of this header must be set to zero.
1201
+ * @param options The options parameters.
1202
+ */
1203
+ uploadRangeFromURL(range: string, copySource: string, contentLength: number, options?: FileUploadRangeFromURLOptionalParams): Promise<FileUploadRangeFromURLResponse_2>;
1204
+ /**
1205
+ * Returns the list of valid ranges for a file.
1206
+ * @param options The options parameters.
1207
+ */
1208
+ getRangeList(options?: FileGetRangeListOptionalParams): Promise<FileGetRangeListResponse_2>;
1209
+ /**
1210
+ * Copies a blob or file to a destination file within the storage account.
1211
+ * @param copySource Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file
1212
+ * to another file within the same storage account, you may use Shared Key to authenticate the source
1213
+ * file. If you are copying a file from another storage account, or if you are copying a blob from the
1214
+ * same storage account or another storage account, then you must authenticate the source file or blob
1215
+ * using a shared access signature. If the source is a public blob, no authentication is required to
1216
+ * perform the copy operation. A file in a share snapshot can also be specified as a copy source.
1217
+ * @param options The options parameters.
1218
+ */
1219
+ startCopy(copySource: string, options?: FileStartCopyOptionalParams): Promise<FileStartCopyResponse_2>;
1220
+ /**
1221
+ * Aborts a pending Copy File operation, and leaves a destination file with zero length and full
1222
+ * metadata.
1223
+ * @param copyId The copy identifier provided in the x-ms-copy-id header of the original Copy File
1224
+ * operation.
1225
+ * @param options The options parameters.
1226
+ */
1227
+ abortCopy(copyId: string, options?: FileAbortCopyOptionalParams): Promise<FileAbortCopyResponse_2>;
1228
+ /**
1229
+ * Lists handles for file
1230
+ * @param options The options parameters.
1231
+ */
1232
+ listHandles(options?: FileListHandlesOptionalParams): Promise<FileListHandlesResponse_2>;
1233
+ /**
1234
+ * Closes all handles open for given file
1235
+ * @param handleId Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is
1236
+ * a wildcard that specifies all handles.
1237
+ * @param options The options parameters.
1238
+ */
1239
+ forceCloseHandles(handleId: string, options?: FileForceCloseHandlesOptionalParams): Promise<FileForceCloseHandlesResponse_2>;
1240
+ /**
1241
+ * Renames a file
1242
+ * @param renameSource Required. Specifies the URI-style path of the source file, up to 2 KB in length.
1243
+ * @param options The options parameters.
1244
+ */
1245
+ rename(renameSource: string, options?: FileRenameOptionalParams): Promise<FileRenameResponse_2>;
1246
+ }
935
1247
  /**
936
1248
  * Options to configure the {@link ShareFileClient.abortCopyFromURL} operation.
937
1249
  */
@@ -957,14 +1269,47 @@ export declare interface FileAbortCopyHeaders {
957
1269
  /** Error Code */
958
1270
  errorCode?: string;
959
1271
  }
1272
+ /** Optional parameters. */
1273
+ declare interface FileAbortCopyOptionalParams extends coreClient.OperationOptions {
1274
+ /** Parameter group */
1275
+ leaseAccessConditions?: LeaseAccessConditions;
1276
+ /** 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> */
1277
+ timeoutInSeconds?: number;
1278
+ }
960
1279
  /** Contains response data for the abortCopy operation. */
961
- export declare type FileAbortCopyResponse = FileAbortCopyHeaders & {
962
- /** The underlying HTTP response. */
963
- _response: coreHttp.HttpResponse & {
964
- /** The parsed HTTP response headers. */
965
- parsedHeaders: FileAbortCopyHeaders;
966
- };
967
- };
1280
+ export declare type FileAbortCopyResponse = WithResponse<FileAbortCopyHeaders, FileAbortCopyHeaders>;
1281
+ /** Contains response data for the abortCopy operation. */
1282
+ declare type FileAbortCopyResponse_2 = FileAbortCopyHeaders;
1283
+ /** Defines headers for File_acquireLease operation. */
1284
+ declare interface FileAcquireLeaseHeaders {
1285
+ /** 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. */
1286
+ etag?: string;
1287
+ /** 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. */
1288
+ lastModified?: Date;
1289
+ /** Uniquely identifies a file's lease */
1290
+ leaseId?: string;
1291
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
1292
+ clientRequestId?: string;
1293
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
1294
+ requestId?: string;
1295
+ /** Indicates the version of the File service used to execute the request. */
1296
+ version?: string;
1297
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
1298
+ date?: Date;
1299
+ }
1300
+ /** Optional parameters. */
1301
+ declare interface FileAcquireLeaseOptionalParams extends coreClient.OperationOptions {
1302
+ /** 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> */
1303
+ timeoutInSeconds?: number;
1304
+ /** 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. */
1305
+ duration?: number;
1306
+ /** 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. */
1307
+ proposedLeaseId?: string;
1308
+ /** 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. */
1309
+ requestId?: string;
1310
+ }
1311
+ /** Contains response data for the acquireLease operation. */
1312
+ declare type FileAcquireLeaseResponse = FileAcquireLeaseHeaders;
968
1313
  export declare interface FileAndDirectoryCreateCommonOptions {
969
1314
  /**
970
1315
  * The permission(security descriptor) to be set for the file or directory in the
@@ -1050,6 +1395,62 @@ export declare interface FileAndDirectorySetPropertiesCommonOptions {
1050
1395
  * Indicates keep existing file attributes unchanged.
1051
1396
  */
1052
1397
  export declare type FileAttributesPreserveType = "preserve";
1398
+ /** Defines headers for File_breakLease operation. */
1399
+ declare interface FileBreakLeaseHeaders {
1400
+ /** 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. */
1401
+ etag?: string;
1402
+ /** 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. */
1403
+ lastModified?: Date;
1404
+ /** Uniquely identifies a file's lease */
1405
+ leaseId?: string;
1406
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
1407
+ clientRequestId?: string;
1408
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
1409
+ requestId?: string;
1410
+ /** Indicates the version of the File service used to execute the request. */
1411
+ version?: string;
1412
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
1413
+ date?: Date;
1414
+ }
1415
+ /** Optional parameters. */
1416
+ declare interface FileBreakLeaseOptionalParams extends coreClient.OperationOptions {
1417
+ /** Parameter group */
1418
+ leaseAccessConditions?: LeaseAccessConditions;
1419
+ /** 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> */
1420
+ timeoutInSeconds?: number;
1421
+ /** 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. */
1422
+ requestId?: string;
1423
+ }
1424
+ /** Contains response data for the breakLease operation. */
1425
+ declare type FileBreakLeaseResponse = FileBreakLeaseHeaders;
1426
+ /** Defines headers for File_changeLease operation. */
1427
+ declare interface FileChangeLeaseHeaders {
1428
+ /** 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. */
1429
+ etag?: string;
1430
+ /** 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. */
1431
+ lastModified?: Date;
1432
+ /** Uniquely identifies a file's lease */
1433
+ leaseId?: string;
1434
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
1435
+ clientRequestId?: string;
1436
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
1437
+ requestId?: string;
1438
+ /** Indicates the version of the File service used to execute the request. */
1439
+ version?: string;
1440
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
1441
+ date?: Date;
1442
+ }
1443
+ /** Optional parameters. */
1444
+ declare interface FileChangeLeaseOptionalParams extends coreClient.OperationOptions {
1445
+ /** 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> */
1446
+ timeoutInSeconds?: number;
1447
+ /** 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. */
1448
+ proposedLeaseId?: string;
1449
+ /** 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. */
1450
+ requestId?: string;
1451
+ }
1452
+ /** Contains response data for the changeLease operation. */
1453
+ declare type FileChangeLeaseResponse = FileChangeLeaseHeaders;
1053
1454
  /**
1054
1455
  * Options to configure the {@link ShareFileClient.clearRange} operation.
1055
1456
  */
@@ -1126,6 +1527,29 @@ export declare interface FileCreateHeaders {
1126
1527
  /** Error Code */
1127
1528
  errorCode?: string;
1128
1529
  }
1530
+ /** Optional parameters. */
1531
+ declare interface FileCreateOptionalParams extends coreClient.OperationOptions {
1532
+ /** Parameter group */
1533
+ leaseAccessConditions?: LeaseAccessConditions;
1534
+ /** Parameter group */
1535
+ fileHttpHeaders?: FileHttpHeaders_2;
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
+ /** A name-value pair to associate with a file storage object. */
1539
+ metadata?: {
1540
+ [propertyName: string]: string;
1541
+ };
1542
+ /** 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. */
1543
+ filePermission?: string;
1544
+ /** 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. */
1545
+ filePermissionKey?: string;
1546
+ /** Creation time for the file/directory. Default value: Now. */
1547
+ fileCreatedOn?: string;
1548
+ /** Last write time for the file/directory. Default value: Now. */
1549
+ fileLastWriteOn?: string;
1550
+ /** Change time for the file/directory. Default value: Now. */
1551
+ fileChangeOn?: string;
1552
+ }
1129
1553
  /**
1130
1554
  * Options to configure the {@link ShareFileClient.create} operation.
1131
1555
  */
@@ -1149,13 +1573,9 @@ export declare interface FileCreateOptions extends FileAndDirectoryCreateCommonO
1149
1573
  leaseAccessConditions?: LeaseAccessConditions;
1150
1574
  }
1151
1575
  /** Contains response data for the create operation. */
1152
- export declare type FileCreateResponse = FileCreateHeaders & {
1153
- /** The underlying HTTP response. */
1154
- _response: coreHttp.HttpResponse & {
1155
- /** The parsed HTTP response headers. */
1156
- parsedHeaders: FileCreateHeaders;
1157
- };
1158
- };
1576
+ export declare type FileCreateResponse = WithResponse<FileCreateHeaders, FileCreateHeaders>;
1577
+ /** Contains response data for the create operation. */
1578
+ declare type FileCreateResponse_2 = FileCreateHeaders;
1159
1579
  /** Defines headers for File_delete operation. */
1160
1580
  export declare interface FileDeleteHeaders {
1161
1581
  /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
@@ -1176,9 +1596,16 @@ export declare interface FileDeleteIfExistsResponse extends FileDeleteResponse {
1176
1596
  */
1177
1597
  succeeded: boolean;
1178
1598
  }
1179
- /**
1180
- * Options to configure the {@link ShareFileClient.delete} operation.
1181
- */
1599
+ /** Optional parameters. */
1600
+ declare interface FileDeleteOptionalParams extends coreClient.OperationOptions {
1601
+ /** Parameter group */
1602
+ leaseAccessConditions?: LeaseAccessConditions;
1603
+ /** 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> */
1604
+ timeoutInSeconds?: number;
1605
+ }
1606
+ /**
1607
+ * Options to configure the {@link ShareFileClient.delete} operation.
1608
+ */
1182
1609
  export declare interface FileDeleteOptions extends CommonOptions {
1183
1610
  /**
1184
1611
  * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
@@ -1191,13 +1618,9 @@ export declare interface FileDeleteOptions extends CommonOptions {
1191
1618
  leaseAccessConditions?: LeaseAccessConditions;
1192
1619
  }
1193
1620
  /** Contains response data for the delete operation. */
1194
- export declare type FileDeleteResponse = FileDeleteHeaders & {
1195
- /** The underlying HTTP response. */
1196
- _response: coreHttp.HttpResponse & {
1197
- /** The parsed HTTP response headers. */
1198
- parsedHeaders: FileDeleteHeaders;
1199
- };
1200
- };
1621
+ export declare type FileDeleteResponse = WithResponse<FileDeleteHeaders, FileDeleteHeaders>;
1622
+ /** Contains response data for the delete operation. */
1623
+ declare type FileDeleteResponse_2 = FileDeleteHeaders;
1201
1624
  /** Defines headers for File_download operation. */
1202
1625
  export declare interface FileDownloadHeaders {
1203
1626
  /** Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time. */
@@ -1272,15 +1695,11 @@ export declare interface FileDownloadHeaders {
1272
1695
  errorCode?: string;
1273
1696
  }
1274
1697
  /** Optional parameters. */
1275
- export declare interface FileDownloadOptionalParams extends coreHttp.OperationOptions {
1698
+ export declare interface FileDownloadOptionalParams extends coreClient.OperationOptions {
1276
1699
  /** Parameter group */
1277
1700
  leaseAccessConditions?: LeaseAccessConditions;
1278
1701
  /** 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> */
1279
1702
  timeoutInSeconds?: number;
1280
- /** Valid value is backup */
1281
- fileRequestIntent?: ShareTokenIntent;
1282
- /** If true, the trailing dot will not be trimmed from the target URI. */
1283
- allowTrailingDot?: boolean;
1284
1703
  /** Return file data only from the specified byte range. */
1285
1704
  range?: string;
1286
1705
  /** 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. */
@@ -1328,27 +1747,7 @@ export declare interface FileDownloadOptions extends CommonOptions {
1328
1747
  leaseAccessConditions?: LeaseAccessConditions;
1329
1748
  }
1330
1749
  /** Contains response data for the download operation. */
1331
- export declare type FileDownloadResponseModel = FileDownloadHeaders & {
1332
- /**
1333
- * BROWSER ONLY
1334
- *
1335
- * The response body as a browser Blob.
1336
- * Always `undefined` in node.js.
1337
- */
1338
- blobBody?: Promise<Blob>;
1339
- /**
1340
- * NODEJS ONLY
1341
- *
1342
- * The response body as a node.js Readable stream.
1343
- * Always `undefined` in the browser.
1344
- */
1345
- readableStreamBody?: NodeJS.ReadableStream;
1346
- /** The underlying HTTP response. */
1347
- _response: coreHttp.HttpResponse & {
1348
- /** The parsed HTTP response headers. */
1349
- parsedHeaders: FileDownloadHeaders;
1350
- };
1351
- };
1750
+ export declare type FileDownloadResponseModel = WithResponse<RawFileDownloadResponse, FileDownloadHeaders>;
1352
1751
  /**
1353
1752
  * Option interface for the {@link ShareFileClient.downloadToBuffer} operation.
1354
1753
  */
@@ -1420,6 +1819,15 @@ export declare interface FileForceCloseHandlesHeaders {
1420
1819
  /** Error Code */
1421
1820
  errorCode?: string;
1422
1821
  }
1822
+ /** Optional parameters. */
1823
+ declare interface FileForceCloseHandlesOptionalParams extends coreClient.OperationOptions {
1824
+ /** 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> */
1825
+ timeoutInSeconds?: number;
1826
+ /** 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. */
1827
+ marker?: string;
1828
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
1829
+ shareSnapshot?: string;
1830
+ }
1423
1831
  /**
1424
1832
  * Options to configure File - Force Close Handles operations.
1425
1833
  *
@@ -1438,17 +1846,9 @@ export declare interface FileForceCloseHandlesOptions extends CommonOptions {
1438
1846
  /**
1439
1847
  * Response type for {@link ShareFileClient.forceCloseHandle}.
1440
1848
  */
1441
- export declare type FileForceCloseHandlesResponse = CloseHandlesInfo & FileCloseHandlesHeaders & {
1442
- /**
1443
- * The underlying HTTP response.
1444
- */
1445
- _response: HttpResponse & {
1446
- /**
1447
- * The parsed HTTP response headers.
1448
- */
1449
- parsedHeaders: FileForceCloseHandlesHeaders;
1450
- };
1451
- };
1849
+ export declare type FileForceCloseHandlesResponse = WithResponse<CloseHandlesInfo & FileCloseHandlesHeaders, FileForceCloseHandlesHeaders>;
1850
+ /** Contains response data for the forceCloseHandles operation. */
1851
+ declare type FileForceCloseHandlesResponse_2 = FileForceCloseHandlesHeaders;
1452
1852
  /**
1453
1853
  * Options to configure {@link ShareFileClient.generateSasUrl} operation.
1454
1854
  */
@@ -1527,6 +1927,15 @@ export declare interface FileGetPropertiesHeaders {
1527
1927
  /** Error Code */
1528
1928
  errorCode?: string;
1529
1929
  }
1930
+ /** Optional parameters. */
1931
+ declare interface FileGetPropertiesOptionalParams extends coreClient.OperationOptions {
1932
+ /** Parameter group */
1933
+ leaseAccessConditions?: LeaseAccessConditions;
1934
+ /** 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> */
1935
+ timeoutInSeconds?: number;
1936
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
1937
+ shareSnapshot?: string;
1938
+ }
1530
1939
  /**
1531
1940
  * Options to configure the {@link ShareFileClient.getProperties} operation.
1532
1941
  */
@@ -1542,25 +1951,11 @@ export declare interface FileGetPropertiesOptions extends CommonOptions {
1542
1951
  leaseAccessConditions?: LeaseAccessConditions;
1543
1952
  }
1544
1953
  /** Contains response data for the getProperties operation. */
1545
- export declare type FileGetPropertiesResponse = FileGetPropertiesHeaders & {
1546
- /** The underlying HTTP response. */
1547
- _response: coreHttp.HttpResponse & {
1548
- /** The parsed HTTP response headers. */
1549
- parsedHeaders: FileGetPropertiesHeaders;
1550
- };
1551
- };
1954
+ export declare type FileGetPropertiesResponse = WithResponse<FileGetPropertiesHeaders, FileGetPropertiesHeaders>;
1955
+ /** Contains response data for the getProperties operation. */
1956
+ declare type FileGetPropertiesResponse_2 = FileGetPropertiesHeaders;
1552
1957
  /** Contains response data for the getRangeList operation. */
1553
- export declare type FileGetRangeListDiffResponse = FileGetRangeListHeaders & ShareFileRangeList & {
1554
- /** The underlying HTTP response. */
1555
- _response: coreHttp.HttpResponse & {
1556
- /** The response body as text (string format) */
1557
- bodyAsText: string;
1558
- /** The response body as parsed JSON or XML */
1559
- parsedBody: ShareFileRangeList;
1560
- /** The parsed HTTP response headers. */
1561
- parsedHeaders: FileGetRangeListHeaders;
1562
- };
1563
- };
1958
+ export declare type FileGetRangeListDiffResponse = WithResponse<FileGetRangeListHeaders & ShareFileRangeList, FileGetRangeListHeaders, ShareFileRangeList>;
1564
1959
  /** Defines headers for File_getRangeList operation. */
1565
1960
  export declare interface FileGetRangeListHeaders {
1566
1961
  /** The date/time that the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the file's last modified time. */
@@ -1578,6 +1973,19 @@ export declare interface FileGetRangeListHeaders {
1578
1973
  /** Error Code */
1579
1974
  errorCode?: string;
1580
1975
  }
1976
+ /** Optional parameters. */
1977
+ declare interface FileGetRangeListOptionalParams extends coreClient.OperationOptions {
1978
+ /** Parameter group */
1979
+ leaseAccessConditions?: LeaseAccessConditions;
1980
+ /** 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> */
1981
+ timeoutInSeconds?: number;
1982
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
1983
+ shareSnapshot?: string;
1984
+ /** Specifies the range of bytes over which to list ranges, inclusively. */
1985
+ range?: string;
1986
+ /** The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot. */
1987
+ prevsharesnapshot?: string;
1988
+ }
1581
1989
  /**
1582
1990
  * The option is defined as parity to REST definition.
1583
1991
  * While it's not ready to be used now, considering Crc64 of source content is
@@ -1604,29 +2012,14 @@ export declare interface FileGetRangeListOptions extends CommonOptions {
1604
2012
  /**
1605
2013
  * Contains response data for the {@link ShareFileClient.getRangeList} operation.
1606
2014
  */
1607
- export declare type FileGetRangeListResponse = FileGetRangeListHeaders & {
2015
+ export declare type FileGetRangeListResponse = WithResponse<FileGetRangeListHeaders & {
1608
2016
  /**
1609
2017
  * Range list for an Azure file.
1610
2018
  */
1611
2019
  rangeList: RangeModel[];
1612
- /**
1613
- * The underlying HTTP response.
1614
- */
1615
- _response: HttpResponse & {
1616
- /**
1617
- * The parsed HTTP response headers.
1618
- */
1619
- parsedHeaders: FileGetRangeListHeaders;
1620
- /**
1621
- * The response body as text (string format)
1622
- */
1623
- bodyAsText: string;
1624
- /**
1625
- * The response body as parsed JSON or XML
1626
- */
1627
- parsedBody: RangeModel[];
1628
- };
1629
- };
2020
+ }, FileGetRangeListHeaders, RangeModel[]>;
2021
+ /** Contains response data for the getRangeList operation. */
2022
+ declare type FileGetRangeListResponse_2 = FileGetRangeListHeaders & ShareFileRangeList;
1630
2023
  export declare interface FileHttpHeaders {
1631
2024
  /**
1632
2025
  * Optional. Sets the file's cache
@@ -1664,6 +2057,21 @@ export declare interface FileHttpHeaders {
1664
2057
  */
1665
2058
  fileContentDisposition?: string;
1666
2059
  }
2060
+ /** Parameter group */
2061
+ declare interface FileHttpHeaders_2 {
2062
+ /** Sets the MIME content type of the file. The default type is 'application/octet-stream'. */
2063
+ fileContentType?: string;
2064
+ /** Specifies which content encodings have been applied to the file. */
2065
+ fileContentEncoding?: string;
2066
+ /** Specifies the natural languages used by this resource. */
2067
+ fileContentLanguage?: string;
2068
+ /** Sets the file's cache control. The File service stores this value but does not use or modify it. */
2069
+ fileCacheControl?: string;
2070
+ /** Sets the file's MD5 hash. */
2071
+ fileContentMD5?: Uint8Array;
2072
+ /** Sets the file's Content-Disposition header. */
2073
+ fileContentDisposition?: string;
2074
+ }
1667
2075
  /** A listed file item. */
1668
2076
  export declare interface FileItem {
1669
2077
  name: string;
@@ -1688,6 +2096,17 @@ export declare interface FileListHandlesHeaders {
1688
2096
  /** Error Code */
1689
2097
  errorCode?: string;
1690
2098
  }
2099
+ /** Optional parameters. */
2100
+ declare interface FileListHandlesOptionalParams extends coreClient.OperationOptions {
2101
+ /** 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> */
2102
+ timeoutInSeconds?: number;
2103
+ /** 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. */
2104
+ marker?: string;
2105
+ /** 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. */
2106
+ maxResults?: number;
2107
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
2108
+ shareSnapshot?: string;
2109
+ }
1691
2110
  export declare interface FileListHandlesOptions extends CommonOptions {
1692
2111
  /**
1693
2112
  * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
@@ -1696,17 +2115,9 @@ export declare interface FileListHandlesOptions extends CommonOptions {
1696
2115
  abortSignal?: AbortSignalLike;
1697
2116
  }
1698
2117
  /** Contains response data for the listHandles operation. */
1699
- export declare type FileListHandlesResponse = FileListHandlesHeaders & ListHandlesResponse & {
1700
- /** The underlying HTTP response. */
1701
- _response: coreHttp.HttpResponse & {
1702
- /** The response body as text (string format) */
1703
- bodyAsText: string;
1704
- /** The response body as parsed JSON or XML */
1705
- parsedBody: ListHandlesResponse;
1706
- /** The parsed HTTP response headers. */
1707
- parsedHeaders: FileListHandlesHeaders;
1708
- };
1709
- };
2118
+ export declare type FileListHandlesResponse = WithResponse<FileListHandlesHeaders & ListHandlesResponse, FileListHandlesHeaders, ListHandlesResponse>;
2119
+ /** Contains response data for the listHandles operation. */
2120
+ declare type FileListHandlesResponse_2 = FileListHandlesHeaders & ListHandlesResponse;
1710
2121
  /**
1711
2122
  * Options to configure File - List Handles Segment operations.
1712
2123
  *
@@ -1801,6 +2212,32 @@ export declare interface FileProperty {
1801
2212
  lastModified?: Date;
1802
2213
  etag?: string;
1803
2214
  }
2215
+ /** Defines values for FileRangeWriteType. */
2216
+ declare type FileRangeWriteType = "update" | "clear";
2217
+ /** Defines headers for File_releaseLease operation. */
2218
+ declare interface FileReleaseLeaseHeaders {
2219
+ /** 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. */
2220
+ etag?: string;
2221
+ /** 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. */
2222
+ lastModified?: Date;
2223
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
2224
+ clientRequestId?: string;
2225
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
2226
+ requestId?: string;
2227
+ /** Indicates the version of the File service used to execute the request. */
2228
+ version?: string;
2229
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
2230
+ date?: Date;
2231
+ }
2232
+ /** Optional parameters. */
2233
+ declare interface FileReleaseLeaseOptionalParams extends coreClient.OperationOptions {
2234
+ /** 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> */
2235
+ timeoutInSeconds?: number;
2236
+ /** 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. */
2237
+ requestId?: string;
2238
+ }
2239
+ /** Contains response data for the releaseLease operation. */
2240
+ declare type FileReleaseLeaseResponse = FileReleaseLeaseHeaders;
1804
2241
  /** Defines headers for File_rename operation. */
1805
2242
  export declare interface FileRenameHeaders {
1806
2243
  /** The ETag contains a value which represents the version of the file, in quotes. */
@@ -1830,6 +2267,31 @@ export declare interface FileRenameHeaders {
1830
2267
  /** The parent fileId of the directory. */
1831
2268
  fileParentId?: string;
1832
2269
  }
2270
+ /** Optional parameters. */
2271
+ declare interface FileRenameOptionalParams extends coreClient.OperationOptions {
2272
+ /** Parameter group */
2273
+ sourceLeaseAccessConditions?: SourceLeaseAccessConditions;
2274
+ /** Parameter group */
2275
+ destinationLeaseAccessConditions?: DestinationLeaseAccessConditions;
2276
+ /** Parameter group */
2277
+ copyFileSmbInfo?: CopyFileSmbInfo;
2278
+ /** Parameter group */
2279
+ fileHttpHeaders?: FileHttpHeaders_2;
2280
+ /** 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> */
2281
+ timeoutInSeconds?: number;
2282
+ /** A name-value pair to associate with a file storage object. */
2283
+ metadata?: {
2284
+ [propertyName: string]: string;
2285
+ };
2286
+ /** 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. */
2287
+ filePermission?: string;
2288
+ /** 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. */
2289
+ filePermissionKey?: string;
2290
+ /** 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. */
2291
+ replaceIfExists?: boolean;
2292
+ /** 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. */
2293
+ ignoreReadOnly?: boolean;
2294
+ }
1833
2295
  /**
1834
2296
  * Options to configure the {@link ShareFileClient.rename} operation.
1835
2297
  */
@@ -1888,13 +2350,9 @@ export declare interface FileRenameOptions extends CommonOptions {
1888
2350
  contentType?: string;
1889
2351
  }
1890
2352
  /** Contains response data for the rename operation. */
1891
- export declare type FileRenameResponse = FileRenameHeaders & {
1892
- /** The underlying HTTP response. */
1893
- _response: coreHttp.HttpResponse & {
1894
- /** The parsed HTTP response headers. */
1895
- parsedHeaders: FileRenameHeaders;
1896
- };
1897
- };
2353
+ export declare type FileRenameResponse = WithResponse<FileRenameHeaders, FileRenameHeaders>;
2354
+ /** Contains response data for the rename operation. */
2355
+ declare type FileRenameResponse_2 = FileRenameHeaders;
1898
2356
  /**
1899
2357
  * Options to configure the {@link ShareFileClient.resize} operation.
1900
2358
  */
@@ -2065,6 +2523,27 @@ export declare interface FileSetHTTPHeadersHeaders {
2065
2523
  /** Error Code */
2066
2524
  errorCode?: string;
2067
2525
  }
2526
+ /** Optional parameters. */
2527
+ declare interface FileSetHttpHeadersOptionalParams extends coreClient.OperationOptions {
2528
+ /** Parameter group */
2529
+ leaseAccessConditions?: LeaseAccessConditions;
2530
+ /** Parameter group */
2531
+ fileHttpHeaders?: FileHttpHeaders_2;
2532
+ /** 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> */
2533
+ timeoutInSeconds?: number;
2534
+ /** 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. */
2535
+ filePermission?: string;
2536
+ /** 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. */
2537
+ filePermissionKey?: string;
2538
+ /** Creation time for the file/directory. Default value: Now. */
2539
+ fileCreatedOn?: string;
2540
+ /** Last write time for the file/directory. Default value: Now. */
2541
+ fileLastWriteOn?: string;
2542
+ /** Change time for the file/directory. Default value: Now. */
2543
+ fileChangeOn?: string;
2544
+ /** 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. */
2545
+ fileContentLength?: number;
2546
+ }
2068
2547
  /**
2069
2548
  * Options to configure the {@link ShareFileClient.setHttpHeaders} operation.
2070
2549
  */
@@ -2080,13 +2559,9 @@ export declare interface FileSetHttpHeadersOptions extends FileAndDirectorySetPr
2080
2559
  leaseAccessConditions?: LeaseAccessConditions;
2081
2560
  }
2082
2561
  /** Contains response data for the setHttpHeaders operation. */
2083
- export declare type FileSetHTTPHeadersResponse = FileSetHTTPHeadersHeaders & {
2084
- /** The underlying HTTP response. */
2085
- _response: coreHttp.HttpResponse & {
2086
- /** The parsed HTTP response headers. */
2087
- parsedHeaders: FileSetHTTPHeadersHeaders;
2088
- };
2089
- };
2562
+ export declare type FileSetHTTPHeadersResponse = WithResponse<FileSetHTTPHeadersHeaders, FileSetHTTPHeadersHeaders>;
2563
+ /** Contains response data for the setHttpHeaders operation. */
2564
+ declare type FileSetHttpHeadersResponse = FileSetHTTPHeadersHeaders;
2090
2565
  /** Defines headers for File_setMetadata operation. */
2091
2566
  export declare interface FileSetMetadataHeaders {
2092
2567
  /** The ETag contains a value which represents the version of the file, in quotes. */
@@ -2102,6 +2577,17 @@ export declare interface FileSetMetadataHeaders {
2102
2577
  /** Error Code */
2103
2578
  errorCode?: string;
2104
2579
  }
2580
+ /** Optional parameters. */
2581
+ declare interface FileSetMetadataOptionalParams extends coreClient.OperationOptions {
2582
+ /** Parameter group */
2583
+ leaseAccessConditions?: LeaseAccessConditions;
2584
+ /** 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> */
2585
+ timeoutInSeconds?: number;
2586
+ /** A name-value pair to associate with a file storage object. */
2587
+ metadata?: {
2588
+ [propertyName: string]: string;
2589
+ };
2590
+ }
2105
2591
  /**
2106
2592
  * Options to configure the {@link ShareFileClient.setMetadata} operation.
2107
2593
  */
@@ -2117,13 +2603,9 @@ export declare interface FileSetMetadataOptions extends CommonOptions {
2117
2603
  leaseAccessConditions?: LeaseAccessConditions;
2118
2604
  }
2119
2605
  /** Contains response data for the setMetadata operation. */
2120
- export declare type FileSetMetadataResponse = FileSetMetadataHeaders & {
2121
- /** The underlying HTTP response. */
2122
- _response: coreHttp.HttpResponse & {
2123
- /** The parsed HTTP response headers. */
2124
- parsedHeaders: FileSetMetadataHeaders;
2125
- };
2126
- };
2606
+ export declare type FileSetMetadataResponse = WithResponse<FileSetMetadataHeaders, FileSetMetadataHeaders>;
2607
+ /** Contains response data for the setMetadata operation. */
2608
+ declare type FileSetMetadataResponse_2 = FileSetMetadataHeaders;
2127
2609
  /** Defines headers for File_startCopy operation. */
2128
2610
  export declare interface FileStartCopyHeaders {
2129
2611
  /** If the copy is completed, contains the ETag of the destination file. If the copy is not complete, contains the ETag of the empty file created at the start of the copy. */
@@ -2143,6 +2625,23 @@ export declare interface FileStartCopyHeaders {
2143
2625
  /** Error Code */
2144
2626
  errorCode?: string;
2145
2627
  }
2628
+ /** Optional parameters. */
2629
+ declare interface FileStartCopyOptionalParams extends coreClient.OperationOptions {
2630
+ /** Parameter group */
2631
+ leaseAccessConditions?: LeaseAccessConditions;
2632
+ /** Parameter group */
2633
+ copyFileSmbInfo?: CopyFileSmbInfo;
2634
+ /** 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> */
2635
+ timeoutInSeconds?: number;
2636
+ /** A name-value pair to associate with a file storage object. */
2637
+ metadata?: {
2638
+ [propertyName: string]: string;
2639
+ };
2640
+ /** 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. */
2641
+ filePermission?: string;
2642
+ /** 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. */
2643
+ filePermissionKey?: string;
2644
+ }
2146
2645
  /**
2147
2646
  * Options to configure the {@link ShareFileClient.startCopyFromURL} operation.
2148
2647
  */
@@ -2179,13 +2678,9 @@ export declare interface FileStartCopyOptions extends CommonOptions {
2179
2678
  copyFileSmbInfo?: CopyFileSmbInfo;
2180
2679
  }
2181
2680
  /** Contains response data for the startCopy operation. */
2182
- export declare type FileStartCopyResponse = FileStartCopyHeaders & {
2183
- /** The underlying HTTP response. */
2184
- _response: coreHttp.HttpResponse & {
2185
- /** The parsed HTTP response headers. */
2186
- parsedHeaders: FileStartCopyHeaders;
2187
- };
2188
- };
2681
+ export declare type FileStartCopyResponse = WithResponse<FileStartCopyHeaders, FileStartCopyHeaders>;
2682
+ /** Contains response data for the startCopy operation. */
2683
+ declare type FileStartCopyResponse_2 = FileStartCopyHeaders;
2189
2684
  /**
2190
2685
  * This is a helper class to construct a string representing the NTFS attributes to a file or directory.
2191
2686
  * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes
@@ -2270,17 +2765,13 @@ export declare interface FileUploadRangeFromURLHeaders {
2270
2765
  errorCode?: string;
2271
2766
  }
2272
2767
  /** Optional parameters. */
2273
- export declare interface FileUploadRangeFromURLOptionalParams extends coreHttp.OperationOptions {
2768
+ export declare interface FileUploadRangeFromURLOptionalParams extends coreClient.OperationOptions {
2274
2769
  /** Parameter group */
2275
2770
  leaseAccessConditions?: LeaseAccessConditions;
2276
2771
  /** Parameter group */
2277
2772
  sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
2278
2773
  /** 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> */
2279
2774
  timeoutInSeconds?: number;
2280
- /** If true, the trailing dot will not be trimmed from the target URI. */
2281
- allowTrailingDot?: boolean;
2282
- /** If true, the trailing dot will not be trimmed from the source URI. */
2283
- allowSourceTrailingDot?: boolean;
2284
2775
  /** If the file last write time should be preserved or overwritten */
2285
2776
  fileLastWrittenMode?: FileLastWrittenMode;
2286
2777
  /** Bytes of source data in the specified range. */
@@ -2330,13 +2821,9 @@ export declare interface FileUploadRangeFromURLOptions extends CommonOptions {
2330
2821
  fileLastWrittenMode?: FileLastWrittenMode;
2331
2822
  }
2332
2823
  /** Contains response data for the uploadRangeFromURL operation. */
2333
- export declare type FileUploadRangeFromURLResponse = FileUploadRangeFromURLHeaders & {
2334
- /** The underlying HTTP response. */
2335
- _response: coreHttp.HttpResponse & {
2336
- /** The parsed HTTP response headers. */
2337
- parsedHeaders: FileUploadRangeFromURLHeaders;
2338
- };
2339
- };
2824
+ export declare type FileUploadRangeFromURLResponse = WithResponse<FileUploadRangeFromURLHeaders, FileUploadRangeFromURLHeaders>;
2825
+ /** Contains response data for the uploadRangeFromURL operation. */
2826
+ declare type FileUploadRangeFromURLResponse_2 = FileUploadRangeFromURLHeaders;
2340
2827
  /** Defines headers for File_uploadRange operation. */
2341
2828
  export declare interface FileUploadRangeHeaders {
2342
2829
  /** The ETag contains a value which represents the version of the file, in quotes. */
@@ -2358,6 +2845,19 @@ export declare interface FileUploadRangeHeaders {
2358
2845
  /** Error Code */
2359
2846
  errorCode?: string;
2360
2847
  }
2848
+ /** Optional parameters. */
2849
+ declare interface FileUploadRangeOptionalParams extends coreClient.OperationOptions {
2850
+ /** Parameter group */
2851
+ leaseAccessConditions?: LeaseAccessConditions;
2852
+ /** 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> */
2853
+ timeoutInSeconds?: number;
2854
+ /** Initial data. */
2855
+ body?: coreRestPipeline.RequestBodyType;
2856
+ /** 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). */
2857
+ contentMD5?: Uint8Array;
2858
+ /** If the file last write time should be preserved or overwritten */
2859
+ fileLastWrittenMode?: FileLastWrittenMode;
2860
+ }
2361
2861
  /**
2362
2862
  * Options to configure the {@link ShareFileClient.uploadRange} operation.
2363
2863
  */
@@ -2393,13 +2893,9 @@ export declare interface FileUploadRangeOptions extends CommonOptions {
2393
2893
  fileLastWrittenMode?: FileLastWrittenMode;
2394
2894
  }
2395
2895
  /** Contains response data for the uploadRange operation. */
2396
- export declare type FileUploadRangeResponse = FileUploadRangeHeaders & {
2397
- /** The underlying HTTP response. */
2398
- _response: coreHttp.HttpResponse & {
2399
- /** The parsed HTTP response headers. */
2400
- parsedHeaders: FileUploadRangeHeaders;
2401
- };
2402
- };
2896
+ export declare type FileUploadRangeResponse = WithResponse<FileUploadRangeHeaders, FileUploadRangeHeaders>;
2897
+ /** Contains response data for the uploadRange operation. */
2898
+ declare type FileUploadRangeResponse_2 = FileUploadRangeHeaders;
2403
2899
  /**
2404
2900
  * Option interface for ShareFileClient.uploadStream().
2405
2901
  */
@@ -2471,7 +2967,6 @@ export declare interface HandleItem {
2471
2967
  openTime: Date;
2472
2968
  /** Time handle was last connected to (UTC) */
2473
2969
  lastReconnectTime?: Date;
2474
- accessRightList?: ShareFileHandleAccessRights[];
2475
2970
  }
2476
2971
  /**
2477
2972
  * Represents authentication information in Authorization, ProxyAuthorization,
@@ -2487,14 +2982,31 @@ export declare interface HttpAuthorization {
2487
2982
  */
2488
2983
  value: string;
2489
2984
  }
2490
- export { HttpHeaders };
2491
- export { HttpOperationResponse };
2492
- export { HttpRequestBody };
2493
- export { IHttpClient };
2494
- /** Known values of {@link ShareTokenIntent} that the service accepts. */
2495
- export declare enum KnownShareTokenIntent {
2496
- Backup = "backup"
2985
+ /**
2986
+ * A representation of an HTTP response that
2987
+ * includes a reference to the request that
2988
+ * originated it.
2989
+ */
2990
+ export declare interface HttpResponse {
2991
+ /**
2992
+ * The headers from the response.
2993
+ */
2994
+ headers: HttpHeadersLike;
2995
+ /**
2996
+ * The original request that resulted in this response.
2997
+ */
2998
+ request: WebResourceLike;
2999
+ /**
3000
+ * The HTTP status code returned from the service.
3001
+ */
3002
+ status: number;
2497
3003
  }
3004
+ /**
3005
+ * A helper to decide if a given argument satisfies the Pipeline contract
3006
+ * @param pipeline - An argument that may be a Pipeline
3007
+ * @returns true when the argument satisfies the Pipeline contract
3008
+ */
3009
+ export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
2498
3010
  /** Parameter group */
2499
3011
  export declare interface LeaseAccessConditions {
2500
3012
  /** If specified, the operation only succeeds if the resource's lease is active and matches this ID. */
@@ -2517,17 +3029,7 @@ export declare interface LeaseOperationOptions extends CommonOptions {
2517
3029
  *
2518
3030
  * See {@link ShareLeaseClient}.
2519
3031
  */
2520
- export declare type LeaseOperationResponse = LeaseOperationResponseHeaders & {
2521
- /**
2522
- * The underlying HTTP response.
2523
- */
2524
- _response: HttpResponse & {
2525
- /**
2526
- * The parsed HTTP response headers.
2527
- */
2528
- parsedHeaders: LeaseOperationResponseHeaders;
2529
- };
2530
- };
3032
+ export declare type LeaseOperationResponse = WithResponse<LeaseOperationResponseHeaders, LeaseOperationResponseHeaders>;
2531
3033
  /**
2532
3034
  * The details of the response for a specific lease operation.
2533
3035
  */
@@ -2586,6 +3088,8 @@ export declare interface ListFilesAndDirectoriesSegmentResponse {
2586
3088
  continuationToken: string;
2587
3089
  directoryId?: string;
2588
3090
  }
3091
+ /** Defines values for ListFilesIncludeType. */
3092
+ declare type ListFilesIncludeType = "Timestamps" | "Etag" | "Attributes" | "PermissionKey";
2589
3093
  /** An enumeration of handles. */
2590
3094
  export declare interface ListHandlesResponse {
2591
3095
  handleList?: HandleItem[];
@@ -2632,13 +3136,13 @@ export declare interface Metrics {
2632
3136
  retentionPolicy?: RetentionPolicy;
2633
3137
  }
2634
3138
  /**
2635
- * Creates a new {@link Pipeline} object with {@link Credential} provided.
3139
+ * Creates a new Pipeline object with Credential provided.
2636
3140
  *
2637
- * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential.
3141
+ * @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.
2638
3142
  * @param pipelineOptions - Optional. Options.
2639
3143
  * @returns A new Pipeline object.
2640
3144
  */
2641
- export declare function newPipeline(credential?: Credential_2 | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline;
3145
+ export declare function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline;
2642
3146
  /** Defines values for PermissionCopyModeType. */
2643
3147
  export declare type PermissionCopyModeType = "source" | "override";
2644
3148
  /**
@@ -2646,10 +3150,10 @@ export declare type PermissionCopyModeType = "source" | "override";
2646
3150
  * You can create a default Pipeline by calling {@link newPipeline}.
2647
3151
  * Or you can create a Pipeline with your own policies by the constructor of Pipeline.
2648
3152
  *
2649
- * Refer to {@link newPipeline} and provided policies as reference before
2650
- * implementing your customized Pipeline.
3153
+ * Refer to {@link newPipeline} and provided policies before implementing your
3154
+ * customized Pipeline.
2651
3155
  */
2652
- export declare class Pipeline {
3156
+ export declare class Pipeline implements PipelineLike {
2653
3157
  /**
2654
3158
  * A list of chained request policy factories.
2655
3159
  */
@@ -2666,7 +3170,32 @@ export declare class Pipeline {
2666
3170
  */
2667
3171
  constructor(factories: RequestPolicyFactory[], options?: PipelineOptions);
2668
3172
  /**
2669
- * Transfer Pipeline object to ServiceClientOptions object which required by
3173
+ * Transfer Pipeline object to ServiceClientOptions object which is required by
3174
+ * ServiceClient constructor.
3175
+ *
3176
+ * @returns The ServiceClientOptions object from this Pipeline.
3177
+ */
3178
+ toServiceClientOptions(): ServiceClientOptions;
3179
+ }
3180
+ /**
3181
+ * An interface for the {@link Pipeline} class containing HTTP request policies.
3182
+ * You can create a default Pipeline by calling {@link newPipeline}.
3183
+ * Or you can create a Pipeline with your own policies by the constructor of Pipeline.
3184
+ *
3185
+ * Refer to {@link newPipeline} and provided policies before implementing your
3186
+ * customized Pipeline.
3187
+ */
3188
+ export declare interface PipelineLike {
3189
+ /**
3190
+ * A list of chained request policy factories.
3191
+ */
3192
+ readonly factories: RequestPolicyFactory[];
3193
+ /**
3194
+ * Configures pipeline logger and HTTP client.
3195
+ */
3196
+ readonly options: PipelineOptions;
3197
+ /**
3198
+ * Transfer Pipeline object to ServiceClientOptions object which is required by
2670
3199
  * ServiceClient constructor.
2671
3200
  *
2672
3201
  * @returns The ServiceClientOptions object from this Pipeline.
@@ -2680,11 +3209,7 @@ export declare interface PipelineOptions {
2680
3209
  /**
2681
3210
  * Optional. Configures the HTTP client to send requests and receive responses.
2682
3211
  */
2683
- httpClient?: IHttpClient;
2684
- /**
2685
- * Intent of using TokenCredential in file requests.
2686
- */
2687
- shareTokenIntent?: ShareTokenIntent;
3212
+ httpClient?: RequestPolicy;
2688
3213
  }
2689
3214
  /**
2690
3215
  * Range for Service Operations.
@@ -2709,9 +3234,70 @@ export declare interface RangeModel {
2709
3234
  /** End of the range. */
2710
3235
  end: number;
2711
3236
  }
2712
- export { RequestPolicy };
2713
- export { RequestPolicyFactory };
2714
- export { RequestPolicyOptions };
3237
+ /** Contains response data for the download operation. */
3238
+ export declare type RawFileDownloadResponse = FileDownloadHeaders & {
3239
+ /**
3240
+ * BROWSER ONLY
3241
+ *
3242
+ * The response body as a browser Blob.
3243
+ * Always `undefined` in node.js.
3244
+ */
3245
+ blobBody?: Promise<Blob>;
3246
+ /**
3247
+ * NODEJS ONLY
3248
+ *
3249
+ * The response body as a node.js Readable stream.
3250
+ * Always `undefined` in the browser.
3251
+ */
3252
+ readableStreamBody?: NodeJS.ReadableStream;
3253
+ };
3254
+ /**
3255
+ * An object with a simple _response property.
3256
+ */
3257
+ export declare interface ResponseLike {
3258
+ /**
3259
+ * The underlying HTTP response.
3260
+ */
3261
+ _response: HttpResponse;
3262
+ }
3263
+ /**
3264
+ * An object with a _response property that has body
3265
+ * and headers already parsed into known types.
3266
+ */
3267
+ export declare interface ResponseWithBody<Headers, Body> {
3268
+ /**
3269
+ * The underlying HTTP response.
3270
+ */
3271
+ _response: HttpResponse & {
3272
+ /**
3273
+ * The parsed HTTP response headers.
3274
+ */
3275
+ parsedHeaders: Headers;
3276
+ /**
3277
+ * The response body as text (string format)
3278
+ */
3279
+ bodyAsText: string;
3280
+ /**
3281
+ * The response body as parsed JSON or XML
3282
+ */
3283
+ parsedBody: Body;
3284
+ };
3285
+ }
3286
+ /**
3287
+ * An object with a _response property that has
3288
+ * headers already parsed into a typed object.
3289
+ */
3290
+ export declare interface ResponseWithHeaders<Headers> {
3291
+ /**
3292
+ * The underlying HTTP response.
3293
+ */
3294
+ _response: HttpResponse & {
3295
+ /**
3296
+ * The parsed HTTP response headers.
3297
+ */
3298
+ parsedHeaders: Headers;
3299
+ };
3300
+ }
2715
3301
  export { RestError };
2716
3302
  /** The retention policy. */
2717
3303
  export declare interface RetentionPolicy {
@@ -2869,6 +3455,41 @@ export declare class SASQueryParameters {
2869
3455
  */
2870
3456
  private tryAppendQueryParameter;
2871
3457
  }
3458
+ /** Interface representing a Service. */
3459
+ declare interface Service {
3460
+ /**
3461
+ * Sets properties for a storage account's File service endpoint, including properties for Storage
3462
+ * Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.
3463
+ * @param properties The StorageService properties.
3464
+ * @param options The options parameters.
3465
+ */
3466
+ setProperties(properties: FileServiceProperties, options?: ServiceSetPropertiesOptionalParams): Promise<ServiceSetPropertiesResponse_2>;
3467
+ /**
3468
+ * Gets the properties of a storage account's File service, including properties for Storage Analytics
3469
+ * metrics and CORS (Cross-Origin Resource Sharing) rules.
3470
+ * @param options The options parameters.
3471
+ */
3472
+ getProperties(options?: ServiceGetPropertiesOptionalParams): Promise<ServiceGetPropertiesResponse_2>;
3473
+ /**
3474
+ * The List Shares Segment operation returns a list of the shares and share snapshots under the
3475
+ * specified account.
3476
+ * @param options The options parameters.
3477
+ */
3478
+ listSharesSegment(options?: ServiceListSharesSegmentOptionalParams): Promise<ServiceListSharesSegmentResponse_2>;
3479
+ }
3480
+ /**
3481
+ * A subset of `@azure/core-http` ServiceClientOptions
3482
+ */
3483
+ export declare interface ServiceClientOptions {
3484
+ /**
3485
+ * Optional. Configures the HTTP client to send requests and receive responses.
3486
+ */
3487
+ httpClient?: RequestPolicy;
3488
+ /**
3489
+ * Optional. Overrides the default policy factories.
3490
+ */
3491
+ requestPolicyFactories?: RequestPolicyFactory[] | ((defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]);
3492
+ }
2872
3493
  /**
2873
3494
  * Options to configure {@link ShareServiceClient.generateAccountSasUrl} operation.
2874
3495
  */
@@ -2900,6 +3521,11 @@ export declare interface ServiceGetPropertiesHeaders {
2900
3521
  /** Error Code */
2901
3522
  errorCode?: string;
2902
3523
  }
3524
+ /** Optional parameters. */
3525
+ declare interface ServiceGetPropertiesOptionalParams extends coreClient.OperationOptions {
3526
+ /** 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> */
3527
+ timeoutInSeconds?: number;
3528
+ }
2903
3529
  /**
2904
3530
  * Options to configure the {@link ShareServiceClient.getProperties} operation.
2905
3531
  */
@@ -2911,17 +3537,9 @@ export declare interface ServiceGetPropertiesOptions extends CommonOptions {
2911
3537
  abortSignal?: AbortSignalLike;
2912
3538
  }
2913
3539
  /** Contains response data for the getProperties operation. */
2914
- export declare type ServiceGetPropertiesResponse = ServiceGetPropertiesHeaders & FileServiceProperties & {
2915
- /** The underlying HTTP response. */
2916
- _response: coreHttp.HttpResponse & {
2917
- /** The response body as text (string format) */
2918
- bodyAsText: string;
2919
- /** The response body as parsed JSON or XML */
2920
- parsedBody: FileServiceProperties;
2921
- /** The parsed HTTP response headers. */
2922
- parsedHeaders: ServiceGetPropertiesHeaders;
2923
- };
2924
- };
3540
+ export declare type ServiceGetPropertiesResponse = WithResponse<ServiceGetPropertiesHeaders & FileServiceProperties, ServiceGetPropertiesHeaders, FileServiceProperties>;
3541
+ /** Contains response data for the getProperties operation. */
3542
+ declare type ServiceGetPropertiesResponse_2 = ServiceGetPropertiesHeaders & FileServiceProperties;
2925
3543
  /**
2926
3544
  * Options to configure the {@link ShareServiceClient.listShares} operation.
2927
3545
  */
@@ -2958,69 +3576,264 @@ export declare interface ServiceListSharesSegmentHeaders {
2958
3576
  /** Error Code */
2959
3577
  errorCode?: string;
2960
3578
  }
3579
+ /** Optional parameters. */
3580
+ declare interface ServiceListSharesSegmentOptionalParams extends coreClient.OperationOptions {
3581
+ /** 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> */
3582
+ timeoutInSeconds?: number;
3583
+ /** Filters the results to return only entries whose name begins with the specified prefix. */
3584
+ prefix?: string;
3585
+ /** 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. */
3586
+ marker?: string;
3587
+ /** 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. */
3588
+ maxResults?: number;
3589
+ /** Include this parameter to specify one or more datasets to include in the response. */
3590
+ include?: ListSharesIncludeType[];
3591
+ }
2961
3592
  /**
2962
3593
  * Contains response data for the {@link ShareServiceClient.listShares} operation.
2963
3594
  */
2964
- export declare type ServiceListSharesSegmentResponse = ListSharesResponse & ServiceListSharesSegmentHeaders & {
2965
- /**
2966
- * The underlying HTTP response.
2967
- */
2968
- _response: HttpResponse & {
2969
- /**
2970
- * The parsed HTTP response headers.
2971
- */
2972
- parsedHeaders: ServiceListSharesSegmentHeaders;
2973
- /**
2974
- * The response body as text (string format)
2975
- */
2976
- bodyAsText: string;
2977
- /**
2978
- * The response body as parsed JSON or XML
2979
- */
2980
- parsedBody: ListSharesResponseModel;
2981
- };
2982
- };
3595
+ export declare type ServiceListSharesSegmentResponse = WithResponse<ListSharesResponse & ServiceListSharesSegmentHeaders, ServiceListSharesSegmentHeaders, ListSharesResponseModel>;
3596
+ /** Contains response data for the listSharesSegment operation. */
3597
+ declare type ServiceListSharesSegmentResponse_2 = ServiceListSharesSegmentHeaders & ListSharesResponseModel;
2983
3598
  /** Defines headers for Service_setProperties operation. */
2984
3599
  export declare interface ServiceSetPropertiesHeaders {
2985
3600
  /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
2986
3601
  requestId?: string;
2987
3602
  /** Indicates the version of the File service used to execute the request. */
2988
3603
  version?: string;
2989
- /** Error Code */
2990
- errorCode?: string;
3604
+ /** Error Code */
3605
+ errorCode?: string;
3606
+ }
3607
+ /** Optional parameters. */
3608
+ declare interface ServiceSetPropertiesOptionalParams extends coreClient.OperationOptions {
3609
+ /** 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> */
3610
+ timeoutInSeconds?: number;
3611
+ }
3612
+ /**
3613
+ * Options to configure the {@link ShareServiceClient.setProperties} operation.
3614
+ */
3615
+ export declare interface ServiceSetPropertiesOptions extends CommonOptions {
3616
+ /**
3617
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
3618
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
3619
+ */
3620
+ abortSignal?: AbortSignalLike;
3621
+ }
3622
+ /** Contains response data for the setProperties operation. */
3623
+ export declare type ServiceSetPropertiesResponse = WithResponse<ServiceSetPropertiesHeaders, ServiceSetPropertiesHeaders>;
3624
+ /** Contains response data for the setProperties operation. */
3625
+ declare type ServiceSetPropertiesResponse_2 = ServiceSetPropertiesHeaders;
3626
+ /**
3627
+ * Options to configure the {@link ShareServiceClient.undelete} operation.
3628
+ */
3629
+ export declare interface ServiceUndeleteShareOptions extends CommonOptions {
3630
+ /**
3631
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
3632
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
3633
+ */
3634
+ abortSignal?: AbortSignalLike;
3635
+ }
3636
+ export declare interface SetPropertiesResponse extends FileSetHTTPHeadersResponse {
3637
+ }
3638
+ /** Interface representing a Share. */
3639
+ declare interface Share {
3640
+ /**
3641
+ * Creates a new share under the specified account. If the share with the same name already exists, the
3642
+ * operation fails.
3643
+ * @param options The options parameters.
3644
+ */
3645
+ create(options?: ShareCreateOptionalParams): Promise<ShareCreateResponse_2>;
3646
+ /**
3647
+ * Returns all user-defined metadata and system properties for the specified share or share snapshot.
3648
+ * The data returned does not include the share's list of files.
3649
+ * @param options The options parameters.
3650
+ */
3651
+ getProperties(options?: ShareGetPropertiesOptionalParams): Promise<ShareGetPropertiesResponse_2>;
3652
+ /**
3653
+ * Operation marks the specified share or share snapshot for deletion. The share or share snapshot and
3654
+ * any files contained within it are later deleted during garbage collection.
3655
+ * @param options The options parameters.
3656
+ */
3657
+ delete(options?: ShareDeleteOptionalParams): Promise<ShareDeleteResponse_2>;
3658
+ /**
3659
+ * The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
3660
+ * set and delete share operations.
3661
+ * @param options The options parameters.
3662
+ */
3663
+ acquireLease(options?: ShareAcquireLeaseOptionalParams): Promise<ShareAcquireLeaseResponse>;
3664
+ /**
3665
+ * The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
3666
+ * set and delete share operations.
3667
+ * @param leaseId Specifies the current lease ID on the resource.
3668
+ * @param options The options parameters.
3669
+ */
3670
+ releaseLease(leaseId: string, options?: ShareReleaseLeaseOptionalParams): Promise<ShareReleaseLeaseResponse>;
3671
+ /**
3672
+ * The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
3673
+ * set and delete share operations.
3674
+ * @param leaseId Specifies the current lease ID on the resource.
3675
+ * @param options The options parameters.
3676
+ */
3677
+ changeLease(leaseId: string, options?: ShareChangeLeaseOptionalParams): Promise<ShareChangeLeaseResponse>;
3678
+ /**
3679
+ * The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
3680
+ * set and delete share operations.
3681
+ * @param leaseId Specifies the current lease ID on the resource.
3682
+ * @param options The options parameters.
3683
+ */
3684
+ renewLease(leaseId: string, options?: ShareRenewLeaseOptionalParams): Promise<ShareRenewLeaseResponse>;
3685
+ /**
3686
+ * The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for
3687
+ * set and delete share operations.
3688
+ * @param options The options parameters.
3689
+ */
3690
+ breakLease(options?: ShareBreakLeaseOptionalParams): Promise<ShareBreakLeaseResponse>;
3691
+ /**
3692
+ * Creates a read-only snapshot of a share.
3693
+ * @param options The options parameters.
3694
+ */
3695
+ createSnapshot(options?: ShareCreateSnapshotOptionalParams): Promise<ShareCreateSnapshotResponse_2>;
3696
+ /**
3697
+ * Create a permission (a security descriptor).
3698
+ * @param sharePermission A permission (a security descriptor) at the share level.
3699
+ * @param options The options parameters.
3700
+ */
3701
+ createPermission(sharePermission: SharePermission, options?: ShareCreatePermissionOptionalParams): Promise<ShareCreatePermissionResponse_2>;
3702
+ /**
3703
+ * Returns the permission (security descriptor) for a given key
3704
+ * @param filePermissionKey Key of the permission to be set for the directory/file.
3705
+ * @param options The options parameters.
3706
+ */
3707
+ getPermission(filePermissionKey: string, options?: ShareGetPermissionOptionalParams): Promise<ShareGetPermissionResponse_2>;
3708
+ /**
3709
+ * Sets properties for the specified share.
3710
+ * @param options The options parameters.
3711
+ */
3712
+ setProperties(options?: ShareSetPropertiesOptionalParams): Promise<ShareSetPropertiesResponse_2>;
3713
+ /**
3714
+ * Sets one or more user-defined name-value pairs for the specified share.
3715
+ * @param options The options parameters.
3716
+ */
3717
+ setMetadata(options?: ShareSetMetadataOptionalParams): Promise<ShareSetMetadataResponse_2>;
3718
+ /**
3719
+ * Returns information about stored access policies specified on the share.
3720
+ * @param options The options parameters.
3721
+ */
3722
+ getAccessPolicy(options?: ShareGetAccessPolicyOptionalParams): Promise<ShareGetAccessPolicyResponse_2>;
3723
+ /**
3724
+ * Sets a stored access policy for use with shared access signatures.
3725
+ * @param options The options parameters.
3726
+ */
3727
+ setAccessPolicy(options?: ShareSetAccessPolicyOptionalParams): Promise<ShareSetAccessPolicyResponse_2>;
3728
+ /**
3729
+ * Retrieves statistics related to the share.
3730
+ * @param options The options parameters.
3731
+ */
3732
+ getStatistics(options?: ShareGetStatisticsOptionalParams): Promise<ShareGetStatisticsResponse_2>;
3733
+ /**
3734
+ * Restores a previously deleted Share.
3735
+ * @param options The options parameters.
3736
+ */
3737
+ restore(options?: ShareRestoreOptionalParams): Promise<ShareRestoreResponse>;
3738
+ }
3739
+ /** Defines values for ShareAccessTier. */
3740
+ export declare type ShareAccessTier = "TransactionOptimized" | "Hot" | "Cool";
3741
+ /** Defines headers for Share_acquireLease operation. */
3742
+ declare interface ShareAcquireLeaseHeaders {
3743
+ /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
3744
+ etag?: string;
3745
+ /** 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. */
3746
+ lastModified?: Date;
3747
+ /** Uniquely identifies a share's lease */
3748
+ leaseId?: string;
3749
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
3750
+ clientRequestId?: string;
3751
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
3752
+ requestId?: string;
3753
+ /** Indicates the version of the File service used to execute the request. */
3754
+ version?: string;
3755
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
3756
+ date?: Date;
3757
+ }
3758
+ /** Optional parameters. */
3759
+ declare interface ShareAcquireLeaseOptionalParams extends coreClient.OperationOptions {
3760
+ /** 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> */
3761
+ timeoutInSeconds?: number;
3762
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
3763
+ shareSnapshot?: string;
3764
+ /** 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. */
3765
+ duration?: number;
3766
+ /** 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. */
3767
+ proposedLeaseId?: string;
3768
+ /** 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. */
3769
+ requestId?: string;
3770
+ }
3771
+ /** Contains response data for the acquireLease operation. */
3772
+ declare type ShareAcquireLeaseResponse = ShareAcquireLeaseHeaders;
3773
+ /** Defines headers for Share_breakLease operation. */
3774
+ declare interface ShareBreakLeaseHeaders {
3775
+ /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
3776
+ etag?: string;
3777
+ /** 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. */
3778
+ lastModified?: Date;
3779
+ /** Approximate time remaining in the lease period, in seconds. */
3780
+ leaseTimeInSeconds?: number;
3781
+ /** Uniquely identifies a share's lease */
3782
+ leaseId?: string;
3783
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
3784
+ clientRequestId?: string;
3785
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
3786
+ requestId?: string;
3787
+ /** Indicates the version of the File service used to execute the request. */
3788
+ version?: string;
3789
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
3790
+ date?: Date;
2991
3791
  }
2992
- /**
2993
- * Options to configure the {@link ShareServiceClient.setProperties} operation.
2994
- */
2995
- export declare interface ServiceSetPropertiesOptions extends CommonOptions {
2996
- /**
2997
- * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
2998
- * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
2999
- */
3000
- abortSignal?: AbortSignalLike;
3792
+ /** Optional parameters. */
3793
+ declare interface ShareBreakLeaseOptionalParams extends coreClient.OperationOptions {
3794
+ /** Parameter group */
3795
+ leaseAccessConditions?: LeaseAccessConditions;
3796
+ /** 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> */
3797
+ timeoutInSeconds?: number;
3798
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
3799
+ shareSnapshot?: string;
3800
+ /** 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. */
3801
+ requestId?: string;
3802
+ /** 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. */
3803
+ breakPeriod?: number;
3001
3804
  }
3002
- /** Contains response data for the setProperties operation. */
3003
- export declare type ServiceSetPropertiesResponse = ServiceSetPropertiesHeaders & {
3004
- /** The underlying HTTP response. */
3005
- _response: coreHttp.HttpResponse & {
3006
- /** The parsed HTTP response headers. */
3007
- parsedHeaders: ServiceSetPropertiesHeaders;
3008
- };
3009
- };
3010
- /**
3011
- * Options to configure the {@link ShareServiceClient.undelete} operation.
3012
- */
3013
- export declare interface ServiceUndeleteShareOptions extends CommonOptions {
3014
- /**
3015
- * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
3016
- * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
3017
- */
3018
- abortSignal?: AbortSignalLike;
3805
+ /** Contains response data for the breakLease operation. */
3806
+ declare type ShareBreakLeaseResponse = ShareBreakLeaseHeaders;
3807
+ /** Defines headers for Share_changeLease operation. */
3808
+ declare interface ShareChangeLeaseHeaders {
3809
+ /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
3810
+ etag?: string;
3811
+ /** 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. */
3812
+ lastModified?: Date;
3813
+ /** Uniquely identifies a share's lease */
3814
+ leaseId?: string;
3815
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
3816
+ clientRequestId?: string;
3817
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
3818
+ requestId?: string;
3819
+ /** Indicates the version of the File service used to execute the request. */
3820
+ version?: string;
3821
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
3822
+ date?: Date;
3019
3823
  }
3020
- export declare interface SetPropertiesResponse extends FileSetHTTPHeadersResponse {
3824
+ /** Optional parameters. */
3825
+ declare interface ShareChangeLeaseOptionalParams extends coreClient.OperationOptions {
3826
+ /** 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> */
3827
+ timeoutInSeconds?: number;
3828
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
3829
+ shareSnapshot?: string;
3830
+ /** 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. */
3831
+ proposedLeaseId?: string;
3832
+ /** 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. */
3833
+ requestId?: string;
3021
3834
  }
3022
- /** Defines values for ShareAccessTier. */
3023
- export declare type ShareAccessTier = "TransactionOptimized" | "Hot" | "Cool";
3835
+ /** Contains response data for the changeLease operation. */
3836
+ declare type ShareChangeLeaseResponse = ShareChangeLeaseHeaders;
3024
3837
  /**
3025
3838
  * A ShareClient represents a URL to the Azure Storage share allowing you to manipulate its directories and files.
3026
3839
  */
@@ -3030,7 +3843,6 @@ export declare class ShareClient extends StorageClient {
3030
3843
  */
3031
3844
  private context;
3032
3845
  private _name;
3033
- private shareClientConfig?;
3034
3846
  /*
3035
3847
  * The name of the share
3036
3848
  */
@@ -3045,7 +3857,7 @@ export declare class ShareClient extends StorageClient {
3045
3857
  * @param name - Share name.
3046
3858
  * @param options - Optional. Options to configure the HTTP pipeline.
3047
3859
  */
3048
- constructor(connectionString: string, name: string, options?: ShareClientOptions);
3860
+ constructor(connectionString: string, name: string, options?: StoragePipelineOptions);
3049
3861
  /**
3050
3862
  * Creates an instance of ShareClient.
3051
3863
  *
@@ -3057,7 +3869,7 @@ export declare class ShareClient extends StorageClient {
3057
3869
  * If not specified, AnonymousCredential is used.
3058
3870
  * @param options - Optional. Options to configure the HTTP pipeline.
3059
3871
  */
3060
- constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
3872
+ constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential, options?: StoragePipelineOptions);
3061
3873
  /**
3062
3874
  * Creates an instance of ShareClient.
3063
3875
  *
@@ -3068,7 +3880,7 @@ export declare class ShareClient extends StorageClient {
3068
3880
  * @param pipeline - Call newPipeline() to create a default
3069
3881
  * pipeline, or provide a customized pipeline.
3070
3882
  */
3071
- constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
3883
+ constructor(url: string, pipeline: Pipeline);
3072
3884
  /**
3073
3885
  * Creates a new ShareClient object identical to the source but with the specified snapshot timestamp.
3074
3886
  * Provide "" will remove the snapshot and return a URL to the base share.
@@ -3310,24 +4122,6 @@ export declare class ShareClient extends StorageClient {
3310
4122
  */
3311
4123
  generateSasUrl(options: ShareGenerateSasUrlOptions): string;
3312
4124
  }
3313
- export declare interface ShareClientConfig {
3314
- /**
3315
- * The Files OAuth over REST feature requires special permissions to be included in the role definition to use
3316
- * These special permissions will give privileged access to file share data -
3317
- * It will allow users to bypass file/directory level ACL/NTFS permissions and get read/write access to file share data
3318
- * Since this additional permission can be unintended and to prevent unintended and over privileged access,
3319
- * additional checks has been implemented that requires users to explicitly indicate their intent to use these additional permissions.
3320
- * This is done using the fileRequestIntent option.
3321
- * Currently, the only value that the header supports is 'backup'
3322
- * 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.
3323
- */
3324
- fileRequestIntent?: ShareTokenIntent;
3325
- /** If true, the trailing dot will not be trimmed from the target URI. */
3326
- allowTrailingDot?: boolean;
3327
- /** If true, the trailing dot will not be trimmed from the source URI. */
3328
- allowSourceTrailingDot?: boolean;
3329
- }
3330
- export declare type ShareClientOptions = StoragePipelineOptions & ShareClientConfig;
3331
4125
  /** Defines headers for Share_create operation. */
3332
4126
  export declare interface ShareCreateHeaders {
3333
4127
  /** The ETag contains a value which represents the version of the share, in quotes. */
@@ -3352,6 +4146,23 @@ export declare interface ShareCreateIfNotExistsResponse extends ShareCreateRespo
3352
4146
  */
3353
4147
  succeeded: boolean;
3354
4148
  }
4149
+ /** Optional parameters. */
4150
+ declare interface ShareCreateOptionalParams extends coreClient.OperationOptions {
4151
+ /** 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> */
4152
+ timeoutInSeconds?: number;
4153
+ /** A name-value pair to associate with a file storage object. */
4154
+ metadata?: {
4155
+ [propertyName: string]: string;
4156
+ };
4157
+ /** Specifies the maximum size of the share, in gigabytes. */
4158
+ quota?: number;
4159
+ /** Specifies the access tier of the share. */
4160
+ accessTier?: ShareAccessTier;
4161
+ /** Protocols to enable on the share. */
4162
+ enabledProtocols?: string;
4163
+ /** Root squash to set on the share. Only valid for NFS shares. */
4164
+ rootSquash?: ShareRootSquash;
4165
+ }
3355
4166
  /**
3356
4167
  * Options to configure the {@link ShareClient.create} operation.
3357
4168
  */
@@ -3400,6 +4211,11 @@ export declare interface ShareCreatePermissionHeaders {
3400
4211
  /** Error Code */
3401
4212
  errorCode?: string;
3402
4213
  }
4214
+ /** Optional parameters. */
4215
+ declare interface ShareCreatePermissionOptionalParams extends coreClient.OperationOptions {
4216
+ /** 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> */
4217
+ timeoutInSeconds?: number;
4218
+ }
3403
4219
  /**
3404
4220
  * Options to configure the {@link ShareClient.createPermission} operation.
3405
4221
  */
@@ -3411,21 +4227,13 @@ export declare interface ShareCreatePermissionOptions extends CommonOptions {
3411
4227
  abortSignal?: AbortSignalLike;
3412
4228
  }
3413
4229
  /** Contains response data for the createPermission operation. */
3414
- export declare type ShareCreatePermissionResponse = ShareCreatePermissionHeaders & {
3415
- /** The underlying HTTP response. */
3416
- _response: coreHttp.HttpResponse & {
3417
- /** The parsed HTTP response headers. */
3418
- parsedHeaders: ShareCreatePermissionHeaders;
3419
- };
3420
- };
4230
+ export declare type ShareCreatePermissionResponse = WithResponse<ShareCreatePermissionHeaders, ShareCreatePermissionHeaders>;
4231
+ /** Contains response data for the createPermission operation. */
4232
+ declare type ShareCreatePermissionResponse_2 = ShareCreatePermissionHeaders;
3421
4233
  /** Contains response data for the create operation. */
3422
- export declare type ShareCreateResponse = ShareCreateHeaders & {
3423
- /** The underlying HTTP response. */
3424
- _response: coreHttp.HttpResponse & {
3425
- /** The parsed HTTP response headers. */
3426
- parsedHeaders: ShareCreateHeaders;
3427
- };
3428
- };
4234
+ export declare type ShareCreateResponse = WithResponse<ShareCreateHeaders, ShareCreateHeaders>;
4235
+ /** Contains response data for the create operation. */
4236
+ declare type ShareCreateResponse_2 = ShareCreateHeaders;
3429
4237
  /** Defines headers for Share_createSnapshot operation. */
3430
4238
  export declare interface ShareCreateSnapshotHeaders {
3431
4239
  /** This header is a DateTime value that uniquely identifies the share snapshot. The value of this header may be used in subsequent requests to access the share snapshot. This value is opaque. */
@@ -3443,6 +4251,15 @@ export declare interface ShareCreateSnapshotHeaders {
3443
4251
  /** Error Code */
3444
4252
  errorCode?: string;
3445
4253
  }
4254
+ /** Optional parameters. */
4255
+ declare interface ShareCreateSnapshotOptionalParams extends coreClient.OperationOptions {
4256
+ /** 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> */
4257
+ timeoutInSeconds?: number;
4258
+ /** A name-value pair to associate with a file storage object. */
4259
+ metadata?: {
4260
+ [propertyName: string]: string;
4261
+ };
4262
+ }
3446
4263
  /**
3447
4264
  * Options to configure the {@link ShareClient.createSnapshot} operation.
3448
4265
  */
@@ -3460,13 +4277,9 @@ export declare interface ShareCreateSnapshotOptions extends CommonOptions {
3460
4277
  };
3461
4278
  }
3462
4279
  /** Contains response data for the createSnapshot operation. */
3463
- export declare type ShareCreateSnapshotResponse = ShareCreateSnapshotHeaders & {
3464
- /** The underlying HTTP response. */
3465
- _response: coreHttp.HttpResponse & {
3466
- /** The parsed HTTP response headers. */
3467
- parsedHeaders: ShareCreateSnapshotHeaders;
3468
- };
3469
- };
4280
+ export declare type ShareCreateSnapshotResponse = WithResponse<ShareCreateSnapshotHeaders, ShareCreateSnapshotHeaders>;
4281
+ /** Contains response data for the createSnapshot operation. */
4282
+ declare type ShareCreateSnapshotResponse_2 = ShareCreateSnapshotHeaders;
3470
4283
  /** Defines headers for Share_delete operation. */
3471
4284
  export declare interface ShareDeleteHeaders {
3472
4285
  /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
@@ -3507,14 +4320,21 @@ export declare interface ShareDeleteMethodOptions extends CommonOptions {
3507
4320
  */
3508
4321
  leaseAccessConditions?: LeaseAccessConditions;
3509
4322
  }
4323
+ /** Optional parameters. */
4324
+ declare interface ShareDeleteOptionalParams extends coreClient.OperationOptions {
4325
+ /** Parameter group */
4326
+ leaseAccessConditions?: LeaseAccessConditions;
4327
+ /** 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> */
4328
+ timeoutInSeconds?: number;
4329
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
4330
+ shareSnapshot?: string;
4331
+ /** Specifies the option include to delete the base share and all of its snapshots. */
4332
+ deleteSnapshots?: DeleteSnapshotsOptionType;
4333
+ }
3510
4334
  /** Contains response data for the delete operation. */
3511
- export declare type ShareDeleteResponse = ShareDeleteHeaders & {
3512
- /** The underlying HTTP response. */
3513
- _response: coreHttp.HttpResponse & {
3514
- /** The parsed HTTP response headers. */
3515
- parsedHeaders: ShareDeleteHeaders;
3516
- };
3517
- };
4335
+ export declare type ShareDeleteResponse = WithResponse<ShareDeleteHeaders, ShareDeleteHeaders>;
4336
+ /** Contains response data for the delete operation. */
4337
+ declare type ShareDeleteResponse_2 = ShareDeleteHeaders;
3518
4338
  /**
3519
4339
  * A ShareDirectoryClient represents a URL to the Azure Storage directory allowing you to manipulate its files and directories.
3520
4340
  */
@@ -3526,7 +4346,6 @@ export declare class ShareDirectoryClient extends StorageClient {
3526
4346
  private _shareName;
3527
4347
  private _path;
3528
4348
  private _name;
3529
- private shareClientConfig?;
3530
4349
  /*
3531
4350
  * The share name corresponding to this directory client
3532
4351
  */
@@ -3554,7 +4373,7 @@ export declare class ShareDirectoryClient extends StorageClient {
3554
4373
  * If not specified, AnonymousCredential is used.
3555
4374
  * @param options - Optional. Options to configure the HTTP pipeline.
3556
4375
  */
3557
- constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
4376
+ constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
3558
4377
  /**
3559
4378
  * Creates an instance of DirectoryClient.
3560
4379
  *
@@ -3569,7 +4388,7 @@ export declare class ShareDirectoryClient extends StorageClient {
3569
4388
  * @param pipeline - Call newPipeline() to create a default
3570
4389
  * pipeline, or provide a customized pipeline.
3571
4390
  */
3572
- constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
4391
+ constructor(url: string, pipeline: Pipeline);
3573
4392
  /**
3574
4393
  * Creates a new directory under the specified share or parent directory.
3575
4394
  * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
@@ -4037,7 +4856,6 @@ export declare class ShareFileClient extends StorageClient {
4037
4856
  private _shareName;
4038
4857
  private _path;
4039
4858
  private _name;
4040
- private shareClientConfig?;
4041
4859
  /*
4042
4860
  * The share name corresponding to this file client
4043
4861
  */
@@ -4061,11 +4879,11 @@ export declare class ShareFileClient extends StorageClient {
4061
4879
  * Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
4062
4880
  * However, if a file or directory name includes %, file or directory name must be encoded in the URL.
4063
4881
  * Such as a file named "myfile%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".
4064
- * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or TokenCredential,
4882
+ * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
4065
4883
  * If not specified, AnonymousCredential is used.
4066
4884
  * @param options - Optional. Options to configure the HTTP pipeline.
4067
4885
  */
4068
- constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
4886
+ constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
4069
4887
  /**
4070
4888
  * Creates an instance of ShareFileClient.
4071
4889
  *
@@ -4080,7 +4898,7 @@ export declare class ShareFileClient extends StorageClient {
4080
4898
  * @param pipeline - Call newPipeline() to create a default
4081
4899
  * pipeline, or provide a customized pipeline.
4082
4900
  */
4083
- constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
4901
+ constructor(url: string, pipeline: Pipeline);
4084
4902
  /**
4085
4903
  * Creates a new ShareFileClient object identical to the source but with the specified share snapshot timestamp.
4086
4904
  * Provide "" will remove the snapshot and return a URL to the base ShareFileClient.
@@ -4302,7 +5120,7 @@ export declare class ShareFileClient extends StorageClient {
4302
5120
  * console.log("Updated file successfully!")
4303
5121
  * ```
4304
5122
  */
4305
- uploadRange(body: HttpRequestBody, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>;
5123
+ uploadRange(body: RequestBodyType, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>;
4306
5124
  /**
4307
5125
  * Upload a range of bytes to a file where the contents are read from a another file's URL.
4308
5126
  * The range can be up to 4 MB in size.
@@ -4587,8 +5405,6 @@ export declare class ShareFileClient extends StorageClient {
4587
5405
  fileRenameResponse: FileRenameResponse;
4588
5406
  }>;
4589
5407
  }
4590
- /** Defines values for AccessRight. */
4591
- export declare type ShareFileHandleAccessRights = "Read" | "Write" | "Delete";
4592
5408
  /** The list of file ranges */
4593
5409
  export declare interface ShareFileRangeList {
4594
5410
  ranges?: RangeModel[];
@@ -4618,6 +5434,13 @@ export declare interface ShareGetAccessPolicyHeaders {
4618
5434
  /** Error Code */
4619
5435
  errorCode?: string;
4620
5436
  }
5437
+ /** Optional parameters. */
5438
+ declare interface ShareGetAccessPolicyOptionalParams extends coreClient.OperationOptions {
5439
+ /** Parameter group */
5440
+ leaseAccessConditions?: LeaseAccessConditions;
5441
+ /** 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> */
5442
+ timeoutInSeconds?: number;
5443
+ }
4621
5444
  /**
4622
5445
  * Options to configure the {@link ShareClient.getAccessPolicy} operation.
4623
5446
  */
@@ -4632,27 +5455,11 @@ export declare interface ShareGetAccessPolicyOptions extends CommonOptions {
4632
5455
  */
4633
5456
  leaseAccessConditions?: LeaseAccessConditions;
4634
5457
  }
4635
- export declare type ShareGetAccessPolicyResponse = {
5458
+ export declare type ShareGetAccessPolicyResponse = WithResponse<{
4636
5459
  signedIdentifiers: SignedIdentifier[];
4637
- } & ShareGetAccessPolicyHeaders & {
4638
- /**
4639
- * The underlying HTTP response.
4640
- */
4641
- _response: HttpResponse & {
4642
- /**
4643
- * The parsed HTTP response headers.
4644
- */
4645
- parsedHeaders: ShareGetAccessPolicyHeaders;
4646
- /**
4647
- * The response body as text (string format)
4648
- */
4649
- bodyAsText: string;
4650
- /**
4651
- * The response body as parsed JSON or XML
4652
- */
4653
- parsedBody: SignedIdentifierModel[];
4654
- };
4655
- };
5460
+ } & ShareGetAccessPolicyHeaders, ShareGetAccessPolicyHeaders, SignedIdentifierModel[]>;
5461
+ /** Contains response data for the getAccessPolicy operation. */
5462
+ declare type ShareGetAccessPolicyResponse_2 = ShareGetAccessPolicyHeaders & SignedIdentifierModel[];
4656
5463
  /** Defines headers for Share_getPermission operation. */
4657
5464
  export declare interface ShareGetPermissionHeaders {
4658
5465
  /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
@@ -4664,6 +5471,11 @@ export declare interface ShareGetPermissionHeaders {
4664
5471
  /** Error Code */
4665
5472
  errorCode?: string;
4666
5473
  }
5474
+ /** Optional parameters. */
5475
+ declare interface ShareGetPermissionOptionalParams extends coreClient.OperationOptions {
5476
+ /** 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> */
5477
+ timeoutInSeconds?: number;
5478
+ }
4667
5479
  /**
4668
5480
  * Options to configure the {@link ShareClient.getPermission} operation.
4669
5481
  */
@@ -4675,17 +5487,9 @@ export declare interface ShareGetPermissionOptions extends CommonOptions {
4675
5487
  abortSignal?: AbortSignalLike;
4676
5488
  }
4677
5489
  /** Contains response data for the getPermission operation. */
4678
- export declare type ShareGetPermissionResponse = ShareGetPermissionHeaders & SharePermission & {
4679
- /** The underlying HTTP response. */
4680
- _response: coreHttp.HttpResponse & {
4681
- /** The response body as text (string format) */
4682
- bodyAsText: string;
4683
- /** The response body as parsed JSON or XML */
4684
- parsedBody: SharePermission;
4685
- /** The parsed HTTP response headers. */
4686
- parsedHeaders: ShareGetPermissionHeaders;
4687
- };
4688
- };
5490
+ export declare type ShareGetPermissionResponse = WithResponse<ShareGetPermissionHeaders & SharePermission, ShareGetPermissionHeaders, SharePermission>;
5491
+ /** Contains response data for the getPermission operation. */
5492
+ declare type ShareGetPermissionResponse_2 = ShareGetPermissionHeaders & SharePermission;
4689
5493
  /** Defines headers for Share_getProperties operation. */
4690
5494
  export declare interface ShareGetPropertiesHeaders {
4691
5495
  /** A set of name-value pairs that contain the user-defined metadata of the share. */
@@ -4733,6 +5537,15 @@ export declare interface ShareGetPropertiesHeaders {
4733
5537
  /** Error Code */
4734
5538
  errorCode?: string;
4735
5539
  }
5540
+ /** Optional parameters. */
5541
+ declare interface ShareGetPropertiesOptionalParams extends coreClient.OperationOptions {
5542
+ /** Parameter group */
5543
+ leaseAccessConditions?: LeaseAccessConditions;
5544
+ /** 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> */
5545
+ timeoutInSeconds?: number;
5546
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
5547
+ shareSnapshot?: string;
5548
+ }
4736
5549
  /**
4737
5550
  * Options to configure the {@link ShareClient.getProperties} operation.
4738
5551
  */
@@ -4757,13 +5570,9 @@ export declare type ShareGetPropertiesResponse = ShareGetPropertiesResponseModel
4757
5570
  protocols?: ShareProtocols;
4758
5571
  };
4759
5572
  /** Contains response data for the getProperties operation. */
4760
- export declare type ShareGetPropertiesResponseModel = ShareGetPropertiesHeaders & {
4761
- /** The underlying HTTP response. */
4762
- _response: coreHttp.HttpResponse & {
4763
- /** The parsed HTTP response headers. */
4764
- parsedHeaders: ShareGetPropertiesHeaders;
4765
- };
4766
- };
5573
+ declare type ShareGetPropertiesResponse_2 = ShareGetPropertiesHeaders;
5574
+ /** Contains response data for the getProperties operation. */
5575
+ export declare type ShareGetPropertiesResponseModel = WithResponse<ShareGetPropertiesHeaders, ShareGetPropertiesHeaders>;
4767
5576
  /** Defines headers for Share_getStatistics operation. */
4768
5577
  export declare interface ShareGetStatisticsHeaders {
4769
5578
  /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
@@ -4779,6 +5588,13 @@ export declare interface ShareGetStatisticsHeaders {
4779
5588
  /** Error Code */
4780
5589
  errorCode?: string;
4781
5590
  }
5591
+ /** Optional parameters. */
5592
+ declare interface ShareGetStatisticsOptionalParams extends coreClient.OperationOptions {
5593
+ /** Parameter group */
5594
+ leaseAccessConditions?: LeaseAccessConditions;
5595
+ /** 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> */
5596
+ timeoutInSeconds?: number;
5597
+ }
4782
5598
  /**
4783
5599
  * Options to configure the {@link ShareClient.getStatistics} operation.
4784
5600
  */
@@ -4806,17 +5622,9 @@ export declare type ShareGetStatisticsResponse = ShareGetStatisticsResponseModel
4806
5622
  shareUsage: number;
4807
5623
  };
4808
5624
  /** Contains response data for the getStatistics operation. */
4809
- export declare type ShareGetStatisticsResponseModel = ShareGetStatisticsHeaders & ShareStats & {
4810
- /** The underlying HTTP response. */
4811
- _response: coreHttp.HttpResponse & {
4812
- /** The response body as text (string format) */
4813
- bodyAsText: string;
4814
- /** The response body as parsed JSON or XML */
4815
- parsedBody: ShareStats;
4816
- /** The parsed HTTP response headers. */
4817
- parsedHeaders: ShareGetStatisticsHeaders;
4818
- };
4819
- };
5625
+ declare type ShareGetStatisticsResponse_2 = ShareGetStatisticsHeaders & ShareStats;
5626
+ /** Contains response data for the getStatistics operation. */
5627
+ export declare type ShareGetStatisticsResponseModel = WithResponse<ShareGetStatisticsHeaders & ShareStats, ShareGetStatisticsHeaders, ShareStats>;
4820
5628
  /**
4821
5629
  * A listed Azure Storage share item.
4822
5630
  */
@@ -4853,7 +5661,6 @@ export declare class ShareLeaseClient {
4853
5661
  private _leaseId;
4854
5662
  private _url;
4855
5663
  private fileOrShare;
4856
- private isShare;
4857
5664
  /*
4858
5665
  * Gets the lease Id.
4859
5666
  *
@@ -4969,6 +5776,88 @@ export declare interface ShareProtocolSettings {
4969
5776
  /** Settings for SMB protocol. */
4970
5777
  smb?: ShareSmbSettings;
4971
5778
  }
5779
+ /** Defines headers for Share_releaseLease operation. */
5780
+ declare interface ShareReleaseLeaseHeaders {
5781
+ /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
5782
+ etag?: string;
5783
+ /** 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. */
5784
+ lastModified?: Date;
5785
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
5786
+ clientRequestId?: string;
5787
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
5788
+ requestId?: string;
5789
+ /** Indicates the version of the File service used to execute the request. */
5790
+ version?: string;
5791
+ /** UTC date/time value generated by the service that indicates the time at which the response was initiated */
5792
+ date?: Date;
5793
+ }
5794
+ /** Optional parameters. */
5795
+ declare interface ShareReleaseLeaseOptionalParams extends coreClient.OperationOptions {
5796
+ /** 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> */
5797
+ timeoutInSeconds?: number;
5798
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
5799
+ shareSnapshot?: string;
5800
+ /** 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. */
5801
+ requestId?: string;
5802
+ }
5803
+ /** Contains response data for the releaseLease operation. */
5804
+ declare type ShareReleaseLeaseResponse = ShareReleaseLeaseHeaders;
5805
+ /** Defines headers for Share_renewLease operation. */
5806
+ declare interface ShareRenewLeaseHeaders {
5807
+ /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
5808
+ etag?: string;
5809
+ /** 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. */
5810
+ lastModified?: Date;
5811
+ /** Uniquely identifies a share's lease */
5812
+ leaseId?: string;
5813
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
5814
+ clientRequestId?: string;
5815
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
5816
+ requestId?: string;
5817
+ /** Indicates the version of the File service used to execute the request. */
5818
+ version?: string;
5819
+ /** Returns the current share next allowed quota downgrade time. */
5820
+ date?: Date;
5821
+ }
5822
+ /** Optional parameters. */
5823
+ declare interface ShareRenewLeaseOptionalParams extends coreClient.OperationOptions {
5824
+ /** 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> */
5825
+ timeoutInSeconds?: number;
5826
+ /** The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query. */
5827
+ shareSnapshot?: string;
5828
+ /** 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. */
5829
+ requestId?: string;
5830
+ }
5831
+ /** Contains response data for the renewLease operation. */
5832
+ declare type ShareRenewLeaseResponse = ShareRenewLeaseHeaders;
5833
+ /** Defines headers for Share_restore operation. */
5834
+ declare interface ShareRestoreHeaders {
5835
+ /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
5836
+ etag?: string;
5837
+ /** 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. */
5838
+ lastModified?: Date;
5839
+ /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
5840
+ requestId?: string;
5841
+ /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
5842
+ clientRequestId?: string;
5843
+ /** Indicates the version of the File service used to execute the request. */
5844
+ version?: string;
5845
+ /** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
5846
+ date?: Date;
5847
+ }
5848
+ /** Optional parameters. */
5849
+ declare interface ShareRestoreOptionalParams extends coreClient.OperationOptions {
5850
+ /** 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> */
5851
+ timeoutInSeconds?: number;
5852
+ /** 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. */
5853
+ requestId?: string;
5854
+ /** Specifies the name of the previously-deleted share. */
5855
+ deletedShareName?: string;
5856
+ /** Specifies the version of the previously-deleted share. */
5857
+ deletedShareVersion?: string;
5858
+ }
5859
+ /** Contains response data for the restore operation. */
5860
+ declare type ShareRestoreResponse = ShareRestoreHeaders;
4972
5861
  /** Defines values for ShareRootSquash. */
4973
5862
  export declare type ShareRootSquash = "NoRootSquash" | "RootSquash" | "AllSquash";
4974
5863
  /**
@@ -5025,7 +5914,6 @@ export declare class ShareServiceClient extends StorageClient {
5025
5914
  * serviceContext provided by protocol layer.
5026
5915
  */
5027
5916
  private serviceContext;
5028
- private shareClientConfig?;
5029
5917
  /**
5030
5918
  *
5031
5919
  * Creates an instance of ShareServiceClient from connection string.
@@ -5039,18 +5927,18 @@ export declare class ShareServiceClient extends StorageClient {
5039
5927
  * @param options - Options to configure the HTTP pipeline.
5040
5928
  * @returns A new ShareServiceClient from the given connection string.
5041
5929
  */
5042
- static fromConnectionString(connectionString: string, options?: ShareClientOptions): ShareServiceClient;
5930
+ static fromConnectionString(connectionString: string, options?: StoragePipelineOptions): ShareServiceClient;
5043
5931
  /**
5044
5932
  * Creates an instance of ShareServiceClient.
5045
5933
  *
5046
5934
  * @param url - A URL string pointing to Azure Storage file service, such as
5047
5935
  * "https://myaccount.file.core.windows.net". You can Append a SAS
5048
5936
  * if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
5049
- * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or TokenCredential.
5937
+ * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
5050
5938
  * If not specified, AnonymousCredential is used.
5051
5939
  * @param options - Optional. Options to configure the HTTP pipeline.
5052
5940
  */
5053
- constructor(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions);
5941
+ constructor(url: string, credential?: AnonymousCredential | StorageSharedKeyCredential, options?: StoragePipelineOptions);
5054
5942
  /**
5055
5943
  * Creates an instance of ShareServiceClient.
5056
5944
  *
@@ -5059,10 +5947,8 @@ export declare class ShareServiceClient extends StorageClient {
5059
5947
  * if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".
5060
5948
  * @param pipeline - Call newPipeline() to create a default
5061
5949
  * pipeline, or provide a customized pipeline.
5062
- * @param options - Optional. Options to configure the HTTP pipeline.
5063
- * @param fileRequestIntent - Optional. File request intent.
5064
5950
  */
5065
- constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
5951
+ constructor(url: string, pipeline: Pipeline);
5066
5952
  /**
5067
5953
  * Creates a ShareClient object.
5068
5954
  *
@@ -5266,6 +6152,15 @@ export declare interface ShareSetAccessPolicyHeaders {
5266
6152
  /** Error Code */
5267
6153
  errorCode?: string;
5268
6154
  }
6155
+ /** Optional parameters. */
6156
+ declare interface ShareSetAccessPolicyOptionalParams extends coreClient.OperationOptions {
6157
+ /** Parameter group */
6158
+ leaseAccessConditions?: LeaseAccessConditions;
6159
+ /** 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> */
6160
+ timeoutInSeconds?: number;
6161
+ /** The ACL for the share. */
6162
+ shareAcl?: SignedIdentifierModel[];
6163
+ }
5269
6164
  /**
5270
6165
  * Options to configure the {@link ShareClient.setAccessPolicy} operation.
5271
6166
  */
@@ -5281,13 +6176,9 @@ export declare interface ShareSetAccessPolicyOptions extends CommonOptions {
5281
6176
  leaseAccessConditions?: LeaseAccessConditions;
5282
6177
  }
5283
6178
  /** Contains response data for the setAccessPolicy operation. */
5284
- export declare type ShareSetAccessPolicyResponse = ShareSetAccessPolicyHeaders & {
5285
- /** The underlying HTTP response. */
5286
- _response: coreHttp.HttpResponse & {
5287
- /** The parsed HTTP response headers. */
5288
- parsedHeaders: ShareSetAccessPolicyHeaders;
5289
- };
5290
- };
6179
+ export declare type ShareSetAccessPolicyResponse = WithResponse<ShareSetAccessPolicyHeaders, ShareGetAccessPolicyHeaders>;
6180
+ /** Contains response data for the setAccessPolicy operation. */
6181
+ declare type ShareSetAccessPolicyResponse_2 = ShareSetAccessPolicyHeaders;
5291
6182
  /** Defines headers for Share_setMetadata operation. */
5292
6183
  export declare interface ShareSetMetadataHeaders {
5293
6184
  /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
@@ -5303,6 +6194,17 @@ export declare interface ShareSetMetadataHeaders {
5303
6194
  /** Error Code */
5304
6195
  errorCode?: string;
5305
6196
  }
6197
+ /** Optional parameters. */
6198
+ declare interface ShareSetMetadataOptionalParams extends coreClient.OperationOptions {
6199
+ /** Parameter group */
6200
+ leaseAccessConditions?: LeaseAccessConditions;
6201
+ /** 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> */
6202
+ timeoutInSeconds?: number;
6203
+ /** A name-value pair to associate with a file storage object. */
6204
+ metadata?: {
6205
+ [propertyName: string]: string;
6206
+ };
6207
+ }
5306
6208
  /**
5307
6209
  * Options to configure the {@link ShareClient.setMetadata} operation.
5308
6210
  */
@@ -5318,13 +6220,9 @@ export declare interface ShareSetMetadataOptions extends CommonOptions {
5318
6220
  leaseAccessConditions?: LeaseAccessConditions;
5319
6221
  }
5320
6222
  /** Contains response data for the setMetadata operation. */
5321
- export declare type ShareSetMetadataResponse = ShareSetMetadataHeaders & {
5322
- /** The underlying HTTP response. */
5323
- _response: coreHttp.HttpResponse & {
5324
- /** The parsed HTTP response headers. */
5325
- parsedHeaders: ShareSetMetadataHeaders;
5326
- };
5327
- };
6223
+ export declare type ShareSetMetadataResponse = WithResponse<ShareSetMetadataHeaders, ShareSetMetadataHeaders>;
6224
+ /** Contains response data for the setMetadata operation. */
6225
+ declare type ShareSetMetadataResponse_2 = ShareSetMetadataHeaders;
5328
6226
  /** Defines headers for Share_setProperties operation. */
5329
6227
  export declare interface ShareSetPropertiesHeaders {
5330
6228
  /** The ETag contains a value that you can use to perform operations conditionally, in quotes. */
@@ -5340,6 +6238,19 @@ export declare interface ShareSetPropertiesHeaders {
5340
6238
  /** Error Code */
5341
6239
  errorCode?: string;
5342
6240
  }
6241
+ /** Optional parameters. */
6242
+ declare interface ShareSetPropertiesOptionalParams extends coreClient.OperationOptions {
6243
+ /** Parameter group */
6244
+ leaseAccessConditions?: LeaseAccessConditions;
6245
+ /** 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> */
6246
+ timeoutInSeconds?: number;
6247
+ /** Specifies the maximum size of the share, in gigabytes. */
6248
+ quota?: number;
6249
+ /** Specifies the access tier of the share. */
6250
+ accessTier?: ShareAccessTier;
6251
+ /** Root squash to set on the share. Only valid for NFS shares. */
6252
+ rootSquash?: ShareRootSquash;
6253
+ }
5343
6254
  /**
5344
6255
  * Options to configure the {@link ShareClient.setProperties} operation.
5345
6256
  */
@@ -5369,13 +6280,9 @@ export declare interface ShareSetPropertiesOptions extends CommonOptions {
5369
6280
  leaseAccessConditions?: LeaseAccessConditions;
5370
6281
  }
5371
6282
  /** Contains response data for the setProperties operation. */
5372
- export declare type ShareSetPropertiesResponse = ShareSetPropertiesHeaders & {
5373
- /** The underlying HTTP response. */
5374
- _response: coreHttp.HttpResponse & {
5375
- /** The parsed HTTP response headers. */
5376
- parsedHeaders: ShareSetPropertiesHeaders;
5377
- };
5378
- };
6283
+ export declare type ShareSetPropertiesResponse = WithResponse<ShareSetPropertiesHeaders, ShareSetPropertiesHeaders>;
6284
+ /** Contains response data for the setProperties operation. */
6285
+ declare type ShareSetPropertiesResponse_2 = ShareSetPropertiesHeaders;
5379
6286
  /**
5380
6287
  * Defines headers for setQuota operation.
5381
6288
  */
@@ -5397,7 +6304,7 @@ export declare interface ShareSetQuotaOptions extends CommonOptions {
5397
6304
  /**
5398
6305
  * Contains response data for the setQuota operation.
5399
6306
  */
5400
- export declare type ShareSetQuotaResponse = ShareSetPropertiesResponse;
6307
+ export declare type ShareSetQuotaResponse = WithResponse<ShareSetQuotaHeaders, ShareSetQuotaHeaders>;
5401
6308
  /** Settings for SMB protocol. */
5402
6309
  export declare interface ShareSmbSettings {
5403
6310
  /** Settings for SMB Multichannel. */
@@ -5408,14 +6315,6 @@ export declare interface ShareStats {
5408
6315
  /** The approximate size of the data stored in bytes. Note that this value may not include all recently created or recently resized files. */
5409
6316
  shareUsageBytes: number;
5410
6317
  }
5411
- /**
5412
- * Defines values for ShareTokenIntent. \
5413
- * {@link KnownShareTokenIntent} can be used interchangeably with ShareTokenIntent,
5414
- * this enum contains the known values that the service supports.
5415
- * ### Know values supported by the service
5416
- * **backup**
5417
- */
5418
- export declare type ShareTokenIntent = string;
5419
6318
  /**
5420
6319
  * Signed Identifier
5421
6320
  */
@@ -5456,6 +6355,11 @@ export declare interface SmbMultichannel {
5456
6355
  enabled?: boolean;
5457
6356
  }
5458
6357
  /** Parameter group */
6358
+ declare interface SourceLeaseAccessConditions {
6359
+ /** Required if the source file has an active infinite lease. */
6360
+ sourceLeaseId?: string;
6361
+ }
6362
+ /** Parameter group */
5459
6363
  export declare interface SourceModifiedAccessConditions {
5460
6364
  /** Specify the crc64 value to operate only on range with a matching crc64 checksum. */
5461
6365
  sourceIfMatchCrc64?: Uint8Array;
@@ -5479,16 +6383,16 @@ export declare class StorageBrowserPolicy extends BaseRequestPolicy {
5479
6383
  * @param nextPolicy -
5480
6384
  * @param options -
5481
6385
  */
5482
- constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
6386
+ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
5483
6387
  /**
5484
6388
  * Sends out request.
5485
6389
  *
5486
6390
  * @param request -
5487
6391
  */
5488
- sendRequest(request: WebResource): Promise<HttpOperationResponse>;
6392
+ sendRequest(request: WebResourceLike): Promise<CompatResponse>;
5489
6393
  }
5490
6394
  /**
5491
- * StorageBrowserPolicyFactory is a factory class helping generating BrowserPolicy objects.
6395
+ * StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.
5492
6396
  */
5493
6397
  export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory {
5494
6398
  /**
@@ -5497,7 +6401,7 @@ export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory
5497
6401
  * @param nextPolicy -
5498
6402
  * @param options -
5499
6403
  */
5500
- create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageBrowserPolicy;
6404
+ create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageBrowserPolicy;
5501
6405
  }
5502
6406
  /**
5503
6407
  * A StorageClient represents a base client class for ServiceClient, ContainerClient and etc.
@@ -5514,7 +6418,7 @@ declare abstract class StorageClient {
5514
6418
  * StorageClient is a reference to protocol layer operations entry, which is
5515
6419
  * generated by AutoRest generator.
5516
6420
  */
5517
- protected readonly storageClientContext: StorageClientContext;
6421
+ protected readonly storageClientContext: StorageClient_2;
5518
6422
  /**
5519
6423
  * Creates an instance of StorageClient.
5520
6424
  * @param url -
@@ -5522,20 +6426,24 @@ declare abstract class StorageClient {
5522
6426
  */
5523
6427
  protected constructor(url: string, pipeline: Pipeline);
5524
6428
  }
5525
- declare class StorageClientContext extends coreHttp.ServiceClient {
6429
+ declare class StorageClient_2 extends coreHttpCompat.ExtendedServiceClient {
5526
6430
  url: string;
5527
6431
  version: string;
5528
6432
  fileRangeWriteFromUrl: string;
5529
6433
  /**
5530
- * Initializes a new instance of the StorageClientContext class.
6434
+ * Initializes a new instance of the StorageClient class.
5531
6435
  * @param url The URL of the service account, share, directory or file that is the target of the
5532
6436
  * desired operation.
5533
6437
  * @param options The parameter options
5534
6438
  */
5535
6439
  constructor(url: string, options?: StorageClientOptionalParams);
6440
+ service: Service;
6441
+ share: Share;
6442
+ directory: Directory;
6443
+ file: File_2;
5536
6444
  }
5537
6445
  /** Optional parameters. */
5538
- declare interface StorageClientOptionalParams extends coreHttp.ServiceClientOptions {
6446
+ declare interface StorageClientOptionalParams extends coreHttpCompat.ExtendedServiceClientOptions {
5539
6447
  /** Specifies the version of the operation to use for this request. */
5540
6448
  version?: string;
5541
6449
  /** Only update is supported: - Update: Writes the bytes downloaded from the source url into the specified range. */
@@ -5544,17 +6452,17 @@ declare interface StorageClientOptionalParams extends coreHttp.ServiceClientOpti
5544
6452
  endpoint?: string;
5545
6453
  }
5546
6454
  /**
5547
- * Option interface for {@link newPipeline} function.
6455
+ * Options interface for the {@link newPipeline} function.
5548
6456
  */
5549
6457
  export declare interface StoragePipelineOptions {
5550
6458
  /**
5551
6459
  * Options to configure a proxy for outgoing requests.
5552
6460
  */
5553
- proxyOptions?: ProxyOptions;
6461
+ proxyOptions?: ProxySettings;
5554
6462
  /**
5555
6463
  * Options for adding user agent details to outgoing requests.
5556
6464
  */
5557
- userAgentOptions?: UserAgentOptions;
6465
+ userAgentOptions?: UserAgentPolicyOptions;
5558
6466
  /**
5559
6467
  * Configures the built-in retry policy behavior.
5560
6468
  */
@@ -5566,10 +6474,14 @@ export declare interface StoragePipelineOptions {
5566
6474
  /**
5567
6475
  * Configures the HTTP client to send requests and receive responses.
5568
6476
  */
5569
- httpClient?: IHttpClient;
6477
+ httpClient?: RequestPolicy;
6478
+ /**
6479
+ * The audience used to retrieve an AAD token.
6480
+ */
6481
+ audience?: string | string[];
5570
6482
  }
5571
6483
  /**
5572
- * Retry options interface.
6484
+ * Storage Blob retry options interface.
5573
6485
  */
5574
6486
  export declare interface StorageRetryOptions {
5575
6487
  /**
@@ -5584,12 +6496,10 @@ export declare interface StorageRetryOptions {
5584
6496
  readonly maxTries?: number;
5585
6497
  /**
5586
6498
  * Optional. Indicates the maximum time in ms allowed for any single try of an HTTP request.
5587
- * A value of zero or undefined means that you accept our default timeout, 60s or 60 * 1000ms.
6499
+ * A value of zero or undefined means no default timeout on SDK client, Azure
6500
+ * Storage server's default timeout policy will be used.
5588
6501
  *
5589
- * NOTE: When transferring large amounts of data, the default TryTimeout will probably
5590
- * not be sufficient. You should override this value based on the bandwidth available to
5591
- * the host machine and proximity to the Storage service. A good starting point may be something
5592
- * like (60 seconds per MB of anticipated-payload-size)
6502
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations
5593
6503
  */
5594
6504
  readonly tryTimeoutInMs?: number;
5595
6505
  /**
@@ -5603,6 +6513,15 @@ export declare interface StorageRetryOptions {
5603
6513
  * If you specify 0, then you must also specify 0 for retryDelayInMs.
5604
6514
  */
5605
6515
  readonly maxRetryDelayInMs?: number;
6516
+ /**
6517
+ * If a secondaryHost is specified, retries will be tried against this host. If secondaryHost is undefined
6518
+ * (the default) then operations are not retried against another host.
6519
+ *
6520
+ * NOTE: Before setting this field, make sure you understand the issues around
6521
+ * reading stale and potentially-inconsistent data at
6522
+ * {@link https://docs.microsoft.com/en-us/azure/storage/common/storage-designing-ha-apps-with-ragrs}
6523
+ */
6524
+ readonly secondaryHost?: string;
5606
6525
  }
5607
6526
  /**
5608
6527
  * Retry policy with exponential retry and linear retry implemented.
@@ -5619,25 +6538,24 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
5619
6538
  * @param options -
5620
6539
  * @param retryOptions -
5621
6540
  */
5622
- constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, retryOptions?: StorageRetryOptions);
6541
+ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, retryOptions?: StorageRetryOptions);
5623
6542
  /**
5624
6543
  * Sends request.
5625
6544
  *
5626
6545
  * @param request -
5627
6546
  */
5628
- sendRequest(request: WebResource): Promise<HttpOperationResponse>;
6547
+ sendRequest(request: WebResourceLike): Promise<CompatResponse>;
5629
6548
  /**
5630
6549
  * Decide and perform next retry. Won't mutate request parameter.
5631
6550
  *
5632
6551
  * @param request -
5633
- * @param response -
5634
6552
  * @param secondaryHas404 - If attempt was against the secondary & it returned a StatusNotFound (404), then
5635
6553
  * the resource was not found. This may be due to replication delay. So, in this
5636
6554
  * case, we'll never try the secondary again for this operation.
5637
6555
  * @param attempt - How many retries has been attempted to performed, starting from 1, which includes
5638
6556
  * the attempt will be performed by this method call.
5639
6557
  */
5640
- protected attemptSendRequest(request: WebResource, secondaryHas404: boolean, attempt: number): Promise<HttpOperationResponse>;
6558
+ protected attemptSendRequest(request: WebResourceLike, secondaryHas404: boolean, attempt: number): Promise<CompatResponse>;
5641
6559
  /**
5642
6560
  * Decide whether to retry according to last HTTP response and retry counters.
5643
6561
  *
@@ -5646,7 +6564,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
5646
6564
  * @param response -
5647
6565
  * @param err -
5648
6566
  */
5649
- protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: HttpOperationResponse, err?: RestError): boolean;
6567
+ protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: CompatResponse, err?: RestError): boolean;
5650
6568
  /**
5651
6569
  * Delay a calculated time between retries.
5652
6570
  *
@@ -5657,7 +6575,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
5657
6575
  private delay;
5658
6576
  }
5659
6577
  /**
5660
- * StorageRetryPolicyFactory is a factory class helping generating StorageRetryPolicy objects.
6578
+ * StorageRetryPolicyFactory is a factory class helping generating {@link StorageRetryPolicy} objects.
5661
6579
  */
5662
6580
  export declare class StorageRetryPolicyFactory implements RequestPolicyFactory {
5663
6581
  private retryOptions?;
@@ -5668,10 +6586,11 @@ export declare class StorageRetryPolicyFactory implements RequestPolicyFactory {
5668
6586
  constructor(retryOptions?: StorageRetryOptions);
5669
6587
  /**
5670
6588
  * Creates a StorageRetryPolicy object.
6589
+ *
5671
6590
  * @param nextPolicy -
5672
6591
  * @param options -
5673
6592
  */
5674
- create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageRetryPolicy;
6593
+ create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageRetryPolicy;
5675
6594
  }
5676
6595
  /**
5677
6596
  * RetryPolicy types.
@@ -5707,12 +6626,12 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
5707
6626
  */
5708
6627
  constructor(accountName: string, accountKey: string);
5709
6628
  /**
5710
- * Creates a {@link StorageSharedKeyCredentialPolicy} object.
6629
+ * Creates a StorageSharedKeyCredentialPolicy object.
5711
6630
  *
5712
6631
  * @param nextPolicy -
5713
6632
  * @param options -
5714
6633
  */
5715
- create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageSharedKeyCredentialPolicy;
6634
+ create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageSharedKeyCredentialPolicy;
5716
6635
  /**
5717
6636
  * Generates a hash signature for an HTTP request or for a SAS.
5718
6637
  *
@@ -5725,7 +6644,7 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
5725
6644
  */
5726
6645
  export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
5727
6646
  /**
5728
- * Reference to {@link StorageSharedKeyCredential} which generates StorageSharedKeyCredentialPolicy
6647
+ * Reference to StorageSharedKeyCredential which generates StorageSharedKeyCredentialPolicy
5729
6648
  */
5730
6649
  private readonly factory;
5731
6650
  /**
@@ -5734,13 +6653,13 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
5734
6653
  * @param options -
5735
6654
  * @param factory -
5736
6655
  */
5737
- constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, factory: StorageSharedKeyCredential);
6656
+ constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, factory: StorageSharedKeyCredential);
5738
6657
  /**
5739
6658
  * Signs request.
5740
6659
  *
5741
6660
  * @param request -
5742
6661
  */
5743
- protected signRequest(request: WebResource): WebResource;
6662
+ protected signRequest(request: WebResourceLike): WebResourceLike;
5744
6663
  /**
5745
6664
  * Retrieve header value according to shared key sign rules.
5746
6665
  * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
@@ -5778,5 +6697,8 @@ export declare type TimeNowType = "now";
5778
6697
  * Indicates keep existing time value unchanged.
5779
6698
  */
5780
6699
  export declare type TimePreserveType = "preserve";
5781
- export { WebResource };
6700
+ /**
6701
+ * A type that represents an operation result with a known _response property.
6702
+ */
6703
+ export declare type WithResponse<T, Headers = undefined, Body = undefined> = T & (Body extends object ? ResponseWithBody<Headers, Body> : Headers extends object ? ResponseWithHeaders<Headers> : ResponseLike);
5782
6704
  export {};