@azure/storage-file-share 12.27.0 → 12.28.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (998) hide show
  1. package/README.md +105 -155
  2. package/dist/browser/AccountSASPermissions.d.ts +61 -0
  3. package/dist/browser/AccountSASPermissions.d.ts.map +1 -0
  4. package/dist/browser/AccountSASPermissions.js.map +1 -0
  5. package/dist/browser/AccountSASResourceTypes.d.ts +38 -0
  6. package/dist/browser/AccountSASResourceTypes.d.ts.map +1 -0
  7. package/dist/browser/AccountSASResourceTypes.js.map +1 -0
  8. package/dist/browser/AccountSASServices.d.ts +40 -0
  9. package/dist/browser/AccountSASServices.d.ts.map +1 -0
  10. package/dist/browser/AccountSASServices.js.map +1 -0
  11. package/dist/browser/AccountSASSignatureValues.d.ts +73 -0
  12. package/dist/browser/AccountSASSignatureValues.d.ts.map +1 -0
  13. package/dist/browser/AccountSASSignatureValues.js +71 -0
  14. package/dist/browser/AccountSASSignatureValues.js.map +1 -0
  15. package/dist/browser/Clients.d.ts +3114 -0
  16. package/dist/browser/Clients.d.ts.map +1 -0
  17. package/dist/browser/Clients.js +2882 -0
  18. package/dist/browser/Clients.js.map +1 -0
  19. package/dist/browser/FileDownloadResponse-browser.d.mts.map +1 -0
  20. package/dist/browser/FileDownloadResponse-browser.mjs.map +1 -0
  21. package/dist/browser/FileDownloadResponse.d.ts +2 -0
  22. package/dist/browser/FileDownloadResponse.js +7 -0
  23. package/dist/browser/FileSASPermissions.d.ts +42 -0
  24. package/dist/browser/FileSASPermissions.d.ts.map +1 -0
  25. package/dist/browser/FileSASPermissions.js.map +1 -0
  26. package/dist/browser/FileSASSignatureValues.d.ts +95 -0
  27. package/dist/browser/FileSASSignatureValues.d.ts.map +1 -0
  28. package/dist/browser/FileSASSignatureValues.js +84 -0
  29. package/dist/browser/FileSASSignatureValues.js.map +1 -0
  30. package/dist/browser/FileSystemAttributes.d.ts +63 -0
  31. package/dist/browser/FileSystemAttributes.d.ts.map +1 -0
  32. package/dist/browser/FileSystemAttributes.js.map +1 -0
  33. package/dist/browser/Pipeline.d.ts +142 -0
  34. package/dist/browser/Pipeline.d.ts.map +1 -0
  35. package/dist/browser/Pipeline.js +261 -0
  36. package/dist/browser/Pipeline.js.map +1 -0
  37. package/dist/browser/Range.d.ts +25 -0
  38. package/dist/browser/Range.d.ts.map +1 -0
  39. package/dist/browser/Range.js.map +1 -0
  40. package/dist/browser/SASQueryParameters.d.ts +136 -0
  41. package/dist/browser/SASQueryParameters.d.ts.map +1 -0
  42. package/dist/browser/SASQueryParameters.js +177 -0
  43. package/dist/browser/SASQueryParameters.js.map +1 -0
  44. package/dist/browser/SasIPRange.d.ts +25 -0
  45. package/dist/browser/SasIPRange.d.ts.map +1 -0
  46. package/dist/browser/SasIPRange.js.map +1 -0
  47. package/dist/browser/ShareClientInternal.d.ts +12 -0
  48. package/dist/browser/ShareClientInternal.d.ts.map +1 -0
  49. package/dist/browser/ShareClientInternal.js +16 -0
  50. package/dist/browser/ShareClientInternal.js.map +1 -0
  51. package/dist/browser/ShareSASPermissions.d.ts +46 -0
  52. package/dist/browser/ShareSASPermissions.d.ts.map +1 -0
  53. package/dist/browser/ShareSASPermissions.js.map +1 -0
  54. package/dist/browser/ShareServiceClient.d.ts +427 -0
  55. package/dist/browser/ShareServiceClient.d.ts.map +1 -0
  56. package/dist/browser/ShareServiceClient.js +475 -0
  57. package/dist/browser/ShareServiceClient.js.map +1 -0
  58. package/dist/browser/StorageClient.d.ts +47 -0
  59. package/dist/browser/StorageClient.d.ts.map +1 -0
  60. package/dist/browser/StorageClient.js +30 -0
  61. package/dist/browser/StorageClient.js.map +1 -0
  62. package/dist/browser/StorageContextClient.d.ts +9 -0
  63. package/dist/browser/StorageContextClient.d.ts.map +1 -0
  64. package/dist/browser/StorageContextClient.js +18 -0
  65. package/dist/browser/StorageContextClient.js.map +1 -0
  66. package/dist/browser/StorageRetryPolicyFactory.d.ts +56 -0
  67. package/dist/browser/StorageRetryPolicyFactory.d.ts.map +1 -0
  68. package/dist/browser/StorageRetryPolicyFactory.js +26 -0
  69. package/dist/browser/StorageRetryPolicyFactory.js.map +1 -0
  70. package/dist/browser/generated/src/index.d.ts +4 -0
  71. package/dist/browser/generated/src/index.d.ts.map +1 -0
  72. package/dist/browser/generated/src/index.js +11 -0
  73. package/dist/browser/generated/src/index.js.map +1 -0
  74. package/dist/browser/generated/src/models/index.d.ts +2881 -0
  75. package/dist/browser/generated/src/models/index.d.ts.map +1 -0
  76. package/dist/browser/generated/src/models/index.js.map +1 -0
  77. package/dist/browser/generated/src/models/mappers.d.ts +128 -0
  78. package/dist/browser/generated/src/models/mappers.d.ts.map +1 -0
  79. package/dist/browser/generated/src/models/mappers.js.map +1 -0
  80. package/dist/browser/generated/src/models/parameters.d.ts +128 -0
  81. package/dist/browser/generated/src/models/parameters.d.ts.map +1 -0
  82. package/dist/browser/generated/src/models/parameters.js +1364 -0
  83. package/dist/browser/generated/src/models/parameters.js.map +1 -0
  84. package/dist/browser/generated/src/operations/directory.d.ts +65 -0
  85. package/dist/browser/generated/src/operations/directory.d.ts.map +1 -0
  86. package/dist/browser/generated/src/operations/directory.js +378 -0
  87. package/dist/browser/generated/src/operations/directory.js.map +1 -0
  88. package/dist/browser/generated/src/operations/file.d.ts +162 -0
  89. package/dist/browser/generated/src/operations/file.d.ts.map +1 -0
  90. package/dist/browser/generated/src/operations/file.js +866 -0
  91. package/dist/browser/generated/src/operations/file.js.map +1 -0
  92. package/dist/browser/generated/src/operations/index.d.ts +5 -0
  93. package/dist/browser/generated/src/operations/index.d.ts.map +1 -0
  94. package/dist/browser/generated/src/operations/index.js +12 -0
  95. package/dist/browser/generated/src/operations/index.js.map +1 -0
  96. package/dist/browser/generated/src/operations/service.d.ts +32 -0
  97. package/dist/browser/generated/src/operations/service.d.ts.map +1 -0
  98. package/dist/browser/generated/src/operations/service.js +135 -0
  99. package/dist/browser/generated/src/operations/service.js.map +1 -0
  100. package/dist/browser/generated/src/operations/share.d.ts +111 -0
  101. package/dist/browser/generated/src/operations/share.d.ts.map +1 -0
  102. package/dist/browser/generated/src/operations/share.js +671 -0
  103. package/dist/browser/generated/src/operations/share.js.map +1 -0
  104. package/dist/browser/generated/src/operationsInterfaces/directory.d.ts +57 -0
  105. package/dist/browser/generated/src/operationsInterfaces/directory.d.ts.map +1 -0
  106. package/dist/browser/generated/src/operationsInterfaces/directory.js.map +1 -0
  107. package/dist/browser/generated/src/operationsInterfaces/file.d.ts +154 -0
  108. package/dist/browser/generated/src/operationsInterfaces/file.d.ts.map +1 -0
  109. package/dist/browser/generated/src/operationsInterfaces/file.js.map +1 -0
  110. package/dist/browser/generated/src/operationsInterfaces/index.d.ts +5 -0
  111. package/dist/browser/generated/src/operationsInterfaces/index.d.ts.map +1 -0
  112. package/dist/browser/generated/src/operationsInterfaces/index.js +12 -0
  113. package/dist/browser/generated/src/operationsInterfaces/index.js.map +1 -0
  114. package/dist/browser/generated/src/operationsInterfaces/service.d.ts +24 -0
  115. package/dist/browser/generated/src/operationsInterfaces/service.d.ts.map +1 -0
  116. package/dist/browser/generated/src/operationsInterfaces/service.js.map +1 -0
  117. package/dist/browser/generated/src/operationsInterfaces/share.d.ts +103 -0
  118. package/dist/browser/generated/src/operationsInterfaces/share.d.ts.map +1 -0
  119. package/dist/browser/generated/src/operationsInterfaces/share.js.map +1 -0
  120. package/dist/browser/generated/src/storageClient.d.ts +20 -0
  121. package/dist/browser/generated/src/storageClient.d.ts.map +1 -0
  122. package/dist/browser/generated/src/storageClient.js +48 -0
  123. package/dist/browser/generated/src/storageClient.js.map +1 -0
  124. package/dist/browser/generatedModels.d.ts +492 -0
  125. package/dist/browser/generatedModels.d.ts.map +1 -0
  126. package/dist/browser/generatedModels.js.map +1 -0
  127. package/dist/browser/index-browser.d.mts.map +1 -0
  128. package/dist/browser/index-browser.mjs.map +1 -0
  129. package/dist/browser/index.d.ts +22 -0
  130. package/dist/browser/index.js +19 -0
  131. package/dist/browser/log.d.ts +5 -0
  132. package/dist/browser/log.d.ts.map +1 -0
  133. package/dist/browser/log.js.map +1 -0
  134. package/dist/browser/models.d.ts +373 -0
  135. package/dist/browser/models.d.ts.map +1 -0
  136. package/dist/browser/models.js +94 -0
  137. package/dist/browser/models.js.map +1 -0
  138. package/dist/browser/package.json +3 -0
  139. package/dist/browser/policies/StorageRetryPolicy.d.ts +75 -0
  140. package/dist/browser/policies/StorageRetryPolicy.d.ts.map +1 -0
  141. package/dist/browser/policies/StorageRetryPolicy.js +220 -0
  142. package/dist/browser/policies/StorageRetryPolicy.js.map +1 -0
  143. package/dist/browser/policies/StorageRetryPolicyV2.d.ts +24 -0
  144. package/dist/browser/policies/StorageRetryPolicyV2.d.ts.map +1 -0
  145. package/dist/browser/policies/StorageRetryPolicyV2.js +176 -0
  146. package/dist/browser/policies/StorageRetryPolicyV2.js.map +1 -0
  147. package/dist/browser/utils/Batch.d.ts +68 -0
  148. package/dist/browser/utils/Batch.d.ts.map +1 -0
  149. package/dist/browser/utils/Batch.js.map +1 -0
  150. package/dist/browser/utils/BufferScheduler.d.ts +157 -0
  151. package/dist/browser/utils/BufferScheduler.d.ts.map +1 -0
  152. package/dist/browser/utils/BufferScheduler.js.map +1 -0
  153. package/dist/browser/utils/RetriableReadableStream.d.ts +58 -0
  154. package/dist/browser/utils/RetriableReadableStream.d.ts.map +1 -0
  155. package/dist/browser/utils/RetriableReadableStream.js +119 -0
  156. package/dist/browser/utils/RetriableReadableStream.js.map +1 -0
  157. package/dist/browser/utils/constants.d.ts +55 -0
  158. package/dist/browser/utils/constants.d.ts.map +1 -0
  159. package/dist/browser/utils/constants.js +162 -0
  160. package/dist/browser/utils/constants.js.map +1 -0
  161. package/dist/browser/utils/tracing.d.ts +6 -0
  162. package/dist/browser/utils/tracing.d.ts.map +1 -0
  163. package/dist/browser/utils/tracing.js +14 -0
  164. package/dist/browser/utils/tracing.js.map +1 -0
  165. package/dist/browser/utils/utils-browser.d.mts.map +1 -0
  166. package/dist/browser/utils/utils-browser.mjs.map +1 -0
  167. package/dist/browser/utils/utils.common.d.ts +304 -0
  168. package/dist/browser/utils/utils.common.d.ts.map +1 -0
  169. package/dist/browser/utils/utils.common.js +778 -0
  170. package/dist/browser/utils/utils.common.js.map +1 -0
  171. package/dist/browser/utils/utils.d.ts +5 -0
  172. package/dist/browser/utils/utils.js +15 -0
  173. package/dist/commonjs/AccountSASPermissions.d.ts +61 -0
  174. package/dist/commonjs/AccountSASPermissions.d.ts.map +1 -0
  175. package/dist/commonjs/AccountSASPermissions.js +132 -0
  176. package/dist/commonjs/AccountSASPermissions.js.map +1 -0
  177. package/dist/commonjs/AccountSASResourceTypes.d.ts +38 -0
  178. package/dist/commonjs/AccountSASResourceTypes.d.ts.map +1 -0
  179. package/dist/commonjs/AccountSASResourceTypes.js +76 -0
  180. package/dist/commonjs/AccountSASResourceTypes.js.map +1 -0
  181. package/dist/commonjs/AccountSASServices.d.ts +40 -0
  182. package/dist/commonjs/AccountSASServices.d.ts.map +1 -0
  183. package/dist/commonjs/AccountSASServices.js +84 -0
  184. package/dist/commonjs/AccountSASServices.js.map +1 -0
  185. package/dist/commonjs/AccountSASSignatureValues.d.ts +73 -0
  186. package/dist/commonjs/AccountSASSignatureValues.d.ts.map +1 -0
  187. package/dist/commonjs/AccountSASSignatureValues.js +75 -0
  188. package/dist/commonjs/AccountSASSignatureValues.js.map +1 -0
  189. package/dist/commonjs/Clients.d.ts +3114 -0
  190. package/dist/commonjs/Clients.d.ts.map +1 -0
  191. package/dist/commonjs/Clients.js +2889 -0
  192. package/dist/commonjs/Clients.js.map +1 -0
  193. package/dist/commonjs/FileDownloadResponse.d.ts +291 -0
  194. package/dist/commonjs/FileDownloadResponse.d.ts.map +1 -0
  195. package/dist/commonjs/FileDownloadResponse.js +371 -0
  196. package/dist/commonjs/FileDownloadResponse.js.map +1 -0
  197. package/dist/commonjs/FileSASPermissions.d.ts +42 -0
  198. package/dist/commonjs/FileSASPermissions.d.ts.map +1 -0
  199. package/dist/commonjs/FileSASPermissions.js +86 -0
  200. package/dist/commonjs/FileSASPermissions.js.map +1 -0
  201. package/dist/commonjs/FileSASSignatureValues.d.ts +95 -0
  202. package/dist/commonjs/FileSASSignatureValues.d.ts.map +1 -0
  203. package/dist/commonjs/FileSASSignatureValues.js +88 -0
  204. package/dist/commonjs/FileSASSignatureValues.js.map +1 -0
  205. package/dist/commonjs/FileSystemAttributes.d.ts +63 -0
  206. package/dist/commonjs/FileSystemAttributes.d.ts.map +1 -0
  207. package/dist/commonjs/FileSystemAttributes.js +148 -0
  208. package/dist/commonjs/FileSystemAttributes.js.map +1 -0
  209. package/dist/commonjs/Pipeline.d.ts +142 -0
  210. package/dist/commonjs/Pipeline.d.ts.map +1 -0
  211. package/dist/commonjs/Pipeline.js +267 -0
  212. package/dist/commonjs/Pipeline.js.map +1 -0
  213. package/dist/commonjs/Range.d.ts +25 -0
  214. package/dist/commonjs/Range.d.ts.map +1 -0
  215. package/dist/commonjs/Range.js +25 -0
  216. package/dist/commonjs/Range.js.map +1 -0
  217. package/dist/commonjs/SASQueryParameters.d.ts +136 -0
  218. package/dist/commonjs/SASQueryParameters.d.ts.map +1 -0
  219. package/dist/commonjs/SASQueryParameters.js +181 -0
  220. package/dist/commonjs/SASQueryParameters.js.map +1 -0
  221. package/dist/commonjs/SasIPRange.d.ts +25 -0
  222. package/dist/commonjs/SasIPRange.d.ts.map +1 -0
  223. package/dist/commonjs/SasIPRange.js +17 -0
  224. package/dist/commonjs/SasIPRange.js.map +1 -0
  225. package/dist/commonjs/ShareClientInternal.d.ts +12 -0
  226. package/dist/commonjs/ShareClientInternal.d.ts.map +1 -0
  227. package/dist/commonjs/ShareClientInternal.js +20 -0
  228. package/dist/commonjs/ShareClientInternal.js.map +1 -0
  229. package/dist/commonjs/ShareSASPermissions.d.ts +46 -0
  230. package/dist/commonjs/ShareSASPermissions.d.ts.map +1 -0
  231. package/dist/commonjs/ShareSASPermissions.js +96 -0
  232. package/dist/commonjs/ShareSASPermissions.js.map +1 -0
  233. package/dist/commonjs/ShareServiceClient.d.ts +427 -0
  234. package/dist/commonjs/ShareServiceClient.d.ts.map +1 -0
  235. package/dist/commonjs/ShareServiceClient.js +479 -0
  236. package/dist/commonjs/ShareServiceClient.js.map +1 -0
  237. package/dist/commonjs/StorageClient.d.ts +47 -0
  238. package/dist/commonjs/StorageClient.d.ts.map +1 -0
  239. package/dist/commonjs/StorageClient.js +34 -0
  240. package/dist/commonjs/StorageClient.js.map +1 -0
  241. package/dist/commonjs/StorageContextClient.d.ts +9 -0
  242. package/dist/commonjs/StorageContextClient.d.ts.map +1 -0
  243. package/dist/commonjs/StorageContextClient.js +22 -0
  244. package/dist/commonjs/StorageContextClient.js.map +1 -0
  245. package/dist/commonjs/StorageRetryPolicyFactory.d.ts +56 -0
  246. package/dist/commonjs/StorageRetryPolicyFactory.d.ts.map +1 -0
  247. package/dist/commonjs/StorageRetryPolicyFactory.js +31 -0
  248. package/dist/commonjs/StorageRetryPolicyFactory.js.map +1 -0
  249. package/dist/commonjs/generated/src/index.d.ts +4 -0
  250. package/dist/commonjs/generated/src/index.d.ts.map +1 -0
  251. package/dist/commonjs/generated/src/index.js +16 -0
  252. package/dist/commonjs/generated/src/index.js.map +1 -0
  253. package/dist/commonjs/generated/src/models/index.d.ts +2881 -0
  254. package/dist/commonjs/generated/src/models/index.d.ts.map +1 -0
  255. package/dist/commonjs/generated/src/models/index.js +169 -0
  256. package/dist/commonjs/generated/src/models/index.js.map +1 -0
  257. package/dist/commonjs/generated/src/models/mappers.d.ts +128 -0
  258. package/dist/commonjs/generated/src/models/mappers.d.ts.map +1 -0
  259. package/dist/commonjs/generated/src/models/mappers.js +5992 -0
  260. package/dist/commonjs/generated/src/models/mappers.js.map +1 -0
  261. package/dist/commonjs/generated/src/models/parameters.d.ts +128 -0
  262. package/dist/commonjs/generated/src/models/parameters.d.ts.map +1 -0
  263. package/dist/commonjs/generated/src/models/parameters.js +1369 -0
  264. package/dist/commonjs/generated/src/models/parameters.js.map +1 -0
  265. package/dist/commonjs/generated/src/operations/directory.d.ts +65 -0
  266. package/dist/commonjs/generated/src/operations/directory.d.ts.map +1 -0
  267. package/dist/commonjs/generated/src/operations/directory.js +383 -0
  268. package/dist/commonjs/generated/src/operations/directory.js.map +1 -0
  269. package/dist/commonjs/generated/src/operations/file.d.ts +162 -0
  270. package/dist/commonjs/generated/src/operations/file.d.ts.map +1 -0
  271. package/dist/commonjs/generated/src/operations/file.js +871 -0
  272. package/dist/commonjs/generated/src/operations/file.js.map +1 -0
  273. package/dist/commonjs/generated/src/operations/index.d.ts +5 -0
  274. package/dist/commonjs/generated/src/operations/index.d.ts.map +1 -0
  275. package/dist/commonjs/generated/src/operations/index.js +15 -0
  276. package/dist/commonjs/generated/src/operations/index.js.map +1 -0
  277. package/dist/commonjs/generated/src/operations/service.d.ts +32 -0
  278. package/dist/commonjs/generated/src/operations/service.d.ts.map +1 -0
  279. package/dist/commonjs/generated/src/operations/service.js +140 -0
  280. package/dist/commonjs/generated/src/operations/service.js.map +1 -0
  281. package/dist/commonjs/generated/src/operations/share.d.ts +111 -0
  282. package/dist/commonjs/generated/src/operations/share.d.ts.map +1 -0
  283. package/dist/commonjs/generated/src/operations/share.js +676 -0
  284. package/dist/commonjs/generated/src/operations/share.js.map +1 -0
  285. package/dist/commonjs/generated/src/operationsInterfaces/directory.d.ts +57 -0
  286. package/dist/commonjs/generated/src/operationsInterfaces/directory.d.ts.map +1 -0
  287. package/dist/commonjs/generated/src/operationsInterfaces/directory.js +10 -0
  288. package/dist/commonjs/generated/src/operationsInterfaces/directory.js.map +1 -0
  289. package/dist/commonjs/generated/src/operationsInterfaces/file.d.ts +154 -0
  290. package/dist/commonjs/generated/src/operationsInterfaces/file.d.ts.map +1 -0
  291. package/dist/commonjs/generated/src/operationsInterfaces/file.js +10 -0
  292. package/dist/commonjs/generated/src/operationsInterfaces/file.js.map +1 -0
  293. package/dist/commonjs/generated/src/operationsInterfaces/index.d.ts +5 -0
  294. package/dist/commonjs/generated/src/operationsInterfaces/index.d.ts.map +1 -0
  295. package/dist/commonjs/generated/src/operationsInterfaces/index.js +15 -0
  296. package/dist/commonjs/generated/src/operationsInterfaces/index.js.map +1 -0
  297. package/dist/commonjs/generated/src/operationsInterfaces/service.d.ts +24 -0
  298. package/dist/commonjs/generated/src/operationsInterfaces/service.d.ts.map +1 -0
  299. package/dist/commonjs/generated/src/operationsInterfaces/service.js +10 -0
  300. package/dist/commonjs/generated/src/operationsInterfaces/service.js.map +1 -0
  301. package/dist/commonjs/generated/src/operationsInterfaces/share.d.ts +103 -0
  302. package/dist/commonjs/generated/src/operationsInterfaces/share.d.ts.map +1 -0
  303. package/dist/commonjs/generated/src/operationsInterfaces/share.js +10 -0
  304. package/dist/commonjs/generated/src/operationsInterfaces/share.js.map +1 -0
  305. package/dist/commonjs/generated/src/storageClient.d.ts +20 -0
  306. package/dist/commonjs/generated/src/storageClient.d.ts.map +1 -0
  307. package/dist/commonjs/generated/src/storageClient.js +53 -0
  308. package/dist/commonjs/generated/src/storageClient.js.map +1 -0
  309. package/dist/commonjs/generatedModels.d.ts +492 -0
  310. package/dist/commonjs/generatedModels.d.ts.map +1 -0
  311. package/dist/commonjs/generatedModels.js +11 -0
  312. package/dist/commonjs/generatedModels.js.map +1 -0
  313. package/dist/commonjs/index.d.ts +32 -0
  314. package/dist/commonjs/index.d.ts.map +1 -0
  315. package/dist/commonjs/index.js +55 -0
  316. package/dist/commonjs/index.js.map +1 -0
  317. package/dist/commonjs/log.d.ts +5 -0
  318. package/dist/commonjs/log.d.ts.map +1 -0
  319. package/dist/commonjs/log.js +11 -0
  320. package/dist/commonjs/log.js.map +1 -0
  321. package/dist/commonjs/models.d.ts +373 -0
  322. package/dist/commonjs/models.d.ts.map +1 -0
  323. package/dist/commonjs/models.js +107 -0
  324. package/dist/commonjs/models.js.map +1 -0
  325. package/dist/commonjs/package.json +3 -0
  326. package/dist/commonjs/policies/StorageRetryPolicy.d.ts +75 -0
  327. package/dist/commonjs/policies/StorageRetryPolicy.d.ts.map +1 -0
  328. package/dist/commonjs/policies/StorageRetryPolicy.js +225 -0
  329. package/dist/commonjs/policies/StorageRetryPolicy.js.map +1 -0
  330. package/dist/commonjs/policies/StorageRetryPolicyV2.d.ts +24 -0
  331. package/dist/commonjs/policies/StorageRetryPolicyV2.d.ts.map +1 -0
  332. package/dist/commonjs/policies/StorageRetryPolicyV2.js +180 -0
  333. package/dist/commonjs/policies/StorageRetryPolicyV2.js.map +1 -0
  334. package/dist/commonjs/tsdoc-metadata.json +11 -0
  335. package/dist/commonjs/utils/Batch.d.ts +68 -0
  336. package/dist/commonjs/utils/Batch.d.ts.map +1 -0
  337. package/dist/commonjs/utils/Batch.js +126 -0
  338. package/dist/commonjs/utils/Batch.js.map +1 -0
  339. package/dist/commonjs/utils/BufferScheduler.d.ts +157 -0
  340. package/dist/commonjs/utils/BufferScheduler.d.ts.map +1 -0
  341. package/dist/commonjs/utils/BufferScheduler.js +268 -0
  342. package/dist/commonjs/utils/BufferScheduler.js.map +1 -0
  343. package/dist/commonjs/utils/RetriableReadableStream.d.ts +58 -0
  344. package/dist/commonjs/utils/RetriableReadableStream.d.ts.map +1 -0
  345. package/dist/commonjs/utils/RetriableReadableStream.js +123 -0
  346. package/dist/commonjs/utils/RetriableReadableStream.js.map +1 -0
  347. package/dist/commonjs/utils/constants.d.ts +55 -0
  348. package/dist/commonjs/utils/constants.d.ts.map +1 -0
  349. package/dist/commonjs/utils/constants.js +165 -0
  350. package/dist/commonjs/utils/constants.js.map +1 -0
  351. package/dist/commonjs/utils/tracing.d.ts +6 -0
  352. package/dist/commonjs/utils/tracing.d.ts.map +1 -0
  353. package/dist/commonjs/utils/tracing.js +17 -0
  354. package/dist/commonjs/utils/tracing.js.map +1 -0
  355. package/dist/commonjs/utils/utils.common.d.ts +304 -0
  356. package/dist/commonjs/utils/utils.common.d.ts.map +1 -0
  357. package/dist/commonjs/utils/utils.common.js +816 -0
  358. package/dist/commonjs/utils/utils.common.js.map +1 -0
  359. package/dist/commonjs/utils/utils.d.ts +28 -0
  360. package/dist/commonjs/utils/utils.d.ts.map +1 -0
  361. package/dist/commonjs/utils/utils.js +85 -0
  362. package/dist/commonjs/utils/utils.js.map +1 -0
  363. package/dist/esm/AccountSASPermissions.d.ts +61 -0
  364. package/dist/esm/AccountSASPermissions.d.ts.map +1 -0
  365. package/dist/esm/AccountSASPermissions.js +128 -0
  366. package/dist/esm/AccountSASPermissions.js.map +1 -0
  367. package/dist/esm/AccountSASResourceTypes.d.ts +38 -0
  368. package/dist/esm/AccountSASResourceTypes.d.ts.map +1 -0
  369. package/dist/esm/AccountSASResourceTypes.js.map +1 -0
  370. package/dist/esm/AccountSASServices.d.ts +40 -0
  371. package/dist/esm/AccountSASServices.d.ts.map +1 -0
  372. package/dist/esm/AccountSASServices.js.map +1 -0
  373. package/dist/esm/AccountSASSignatureValues.d.ts +73 -0
  374. package/dist/esm/AccountSASSignatureValues.d.ts.map +1 -0
  375. package/dist/esm/AccountSASSignatureValues.js +71 -0
  376. package/dist/esm/AccountSASSignatureValues.js.map +1 -0
  377. package/dist/esm/Clients.d.ts +3114 -0
  378. package/dist/esm/Clients.d.ts.map +1 -0
  379. package/dist/esm/Clients.js +2882 -0
  380. package/dist/esm/Clients.js.map +1 -0
  381. package/dist/esm/FileDownloadResponse.d.ts +291 -0
  382. package/dist/esm/FileDownloadResponse.d.ts.map +1 -0
  383. package/dist/esm/FileDownloadResponse.js +367 -0
  384. package/dist/esm/FileDownloadResponse.js.map +1 -0
  385. package/dist/esm/FileSASPermissions.d.ts +42 -0
  386. package/dist/esm/FileSASPermissions.d.ts.map +1 -0
  387. package/dist/esm/FileSASPermissions.js +82 -0
  388. package/dist/esm/FileSASPermissions.js.map +1 -0
  389. package/dist/esm/FileSASSignatureValues.d.ts +95 -0
  390. package/dist/esm/FileSASSignatureValues.d.ts.map +1 -0
  391. package/dist/esm/FileSASSignatureValues.js +84 -0
  392. package/dist/esm/FileSASSignatureValues.js.map +1 -0
  393. package/dist/esm/FileSystemAttributes.d.ts +63 -0
  394. package/dist/esm/FileSystemAttributes.d.ts.map +1 -0
  395. package/dist/esm/FileSystemAttributes.js +144 -0
  396. package/dist/esm/FileSystemAttributes.js.map +1 -0
  397. package/dist/esm/Pipeline.d.ts +142 -0
  398. package/dist/esm/Pipeline.d.ts.map +1 -0
  399. package/dist/esm/Pipeline.js +261 -0
  400. package/dist/esm/Pipeline.js.map +1 -0
  401. package/dist/esm/Range.d.ts +25 -0
  402. package/dist/esm/Range.d.ts.map +1 -0
  403. package/dist/esm/Range.js +22 -0
  404. package/dist/esm/Range.js.map +1 -0
  405. package/dist/esm/SASQueryParameters.d.ts +136 -0
  406. package/dist/esm/SASQueryParameters.d.ts.map +1 -0
  407. package/dist/esm/SASQueryParameters.js +177 -0
  408. package/dist/esm/SASQueryParameters.js.map +1 -0
  409. package/dist/esm/SasIPRange.d.ts +25 -0
  410. package/dist/esm/SasIPRange.d.ts.map +1 -0
  411. package/dist/esm/SasIPRange.js +14 -0
  412. package/dist/esm/SasIPRange.js.map +1 -0
  413. package/dist/esm/ShareClientInternal.d.ts +12 -0
  414. package/dist/esm/ShareClientInternal.d.ts.map +1 -0
  415. package/dist/esm/ShareClientInternal.js +16 -0
  416. package/dist/esm/ShareClientInternal.js.map +1 -0
  417. package/dist/esm/ShareSASPermissions.d.ts +46 -0
  418. package/dist/esm/ShareSASPermissions.d.ts.map +1 -0
  419. package/dist/esm/ShareSASPermissions.js +92 -0
  420. package/dist/esm/ShareSASPermissions.js.map +1 -0
  421. package/dist/esm/ShareServiceClient.d.ts +427 -0
  422. package/dist/esm/ShareServiceClient.d.ts.map +1 -0
  423. package/dist/esm/ShareServiceClient.js +475 -0
  424. package/dist/esm/ShareServiceClient.js.map +1 -0
  425. package/dist/esm/StorageClient.d.ts +47 -0
  426. package/dist/esm/StorageClient.d.ts.map +1 -0
  427. package/dist/esm/StorageClient.js +30 -0
  428. package/dist/esm/StorageClient.js.map +1 -0
  429. package/dist/esm/StorageContextClient.d.ts +9 -0
  430. package/dist/esm/StorageContextClient.d.ts.map +1 -0
  431. package/dist/esm/StorageContextClient.js +18 -0
  432. package/dist/esm/StorageContextClient.js.map +1 -0
  433. package/dist/esm/StorageRetryPolicyFactory.d.ts +56 -0
  434. package/dist/esm/StorageRetryPolicyFactory.d.ts.map +1 -0
  435. package/dist/esm/StorageRetryPolicyFactory.js +26 -0
  436. package/dist/esm/StorageRetryPolicyFactory.js.map +1 -0
  437. package/dist/esm/generated/src/index.d.ts +4 -0
  438. package/dist/esm/generated/src/index.d.ts.map +1 -0
  439. package/dist/esm/generated/src/index.js +11 -0
  440. package/dist/esm/generated/src/index.js.map +1 -0
  441. package/dist/esm/generated/src/models/index.d.ts +2881 -0
  442. package/dist/esm/generated/src/models/index.d.ts.map +1 -0
  443. package/dist/esm/generated/src/models/index.js +166 -0
  444. package/dist/esm/generated/src/models/index.js.map +1 -0
  445. package/dist/esm/generated/src/models/mappers.d.ts +128 -0
  446. package/dist/esm/generated/src/models/mappers.d.ts.map +1 -0
  447. package/dist/esm/generated/src/models/mappers.js +5987 -0
  448. package/dist/esm/generated/src/models/mappers.js.map +1 -0
  449. package/dist/esm/generated/src/models/parameters.d.ts +128 -0
  450. package/dist/esm/generated/src/models/parameters.d.ts.map +1 -0
  451. package/dist/esm/generated/src/models/parameters.js +1364 -0
  452. package/dist/esm/generated/src/models/parameters.js.map +1 -0
  453. package/dist/esm/generated/src/operations/directory.d.ts +65 -0
  454. package/dist/esm/generated/src/operations/directory.d.ts.map +1 -0
  455. package/dist/esm/generated/src/operations/directory.js +378 -0
  456. package/dist/esm/generated/src/operations/directory.js.map +1 -0
  457. package/dist/esm/generated/src/operations/file.d.ts +162 -0
  458. package/dist/esm/generated/src/operations/file.d.ts.map +1 -0
  459. package/dist/esm/generated/src/operations/file.js +866 -0
  460. package/dist/esm/generated/src/operations/file.js.map +1 -0
  461. package/dist/esm/generated/src/operations/index.d.ts +5 -0
  462. package/dist/esm/generated/src/operations/index.d.ts.map +1 -0
  463. package/dist/esm/generated/src/operations/index.js +12 -0
  464. package/dist/esm/generated/src/operations/index.js.map +1 -0
  465. package/dist/esm/generated/src/operations/service.d.ts +32 -0
  466. package/dist/esm/generated/src/operations/service.d.ts.map +1 -0
  467. package/dist/esm/generated/src/operations/service.js +135 -0
  468. package/dist/esm/generated/src/operations/service.js.map +1 -0
  469. package/dist/esm/generated/src/operations/share.d.ts +111 -0
  470. package/dist/esm/generated/src/operations/share.d.ts.map +1 -0
  471. package/dist/esm/generated/src/operations/share.js +671 -0
  472. package/dist/esm/generated/src/operations/share.js.map +1 -0
  473. package/dist/esm/generated/src/operationsInterfaces/directory.d.ts +57 -0
  474. package/dist/esm/generated/src/operationsInterfaces/directory.d.ts.map +1 -0
  475. package/dist/esm/generated/src/operationsInterfaces/directory.js +9 -0
  476. package/dist/esm/generated/src/operationsInterfaces/directory.js.map +1 -0
  477. package/dist/esm/generated/src/operationsInterfaces/file.d.ts +154 -0
  478. package/dist/esm/generated/src/operationsInterfaces/file.d.ts.map +1 -0
  479. package/dist/esm/generated/src/operationsInterfaces/file.js +9 -0
  480. package/dist/esm/generated/src/operationsInterfaces/file.js.map +1 -0
  481. package/dist/esm/generated/src/operationsInterfaces/index.d.ts +5 -0
  482. package/dist/esm/generated/src/operationsInterfaces/index.d.ts.map +1 -0
  483. package/dist/esm/generated/src/operationsInterfaces/index.js +12 -0
  484. package/dist/esm/generated/src/operationsInterfaces/index.js.map +1 -0
  485. package/dist/esm/generated/src/operationsInterfaces/service.d.ts +24 -0
  486. package/dist/esm/generated/src/operationsInterfaces/service.d.ts.map +1 -0
  487. package/dist/esm/generated/src/operationsInterfaces/service.js.map +1 -0
  488. package/dist/esm/generated/src/operationsInterfaces/share.d.ts +103 -0
  489. package/dist/esm/generated/src/operationsInterfaces/share.d.ts.map +1 -0
  490. package/dist/esm/generated/src/operationsInterfaces/share.js +9 -0
  491. package/dist/esm/generated/src/operationsInterfaces/share.js.map +1 -0
  492. package/dist/esm/generated/src/storageClient.d.ts +20 -0
  493. package/dist/esm/generated/src/storageClient.d.ts.map +1 -0
  494. package/dist/esm/generated/src/storageClient.js +48 -0
  495. package/dist/esm/generated/src/storageClient.js.map +1 -0
  496. package/dist/esm/generatedModels.d.ts +492 -0
  497. package/dist/esm/generatedModels.d.ts.map +1 -0
  498. package/dist/esm/generatedModels.js +8 -0
  499. package/dist/esm/generatedModels.js.map +1 -0
  500. package/dist/esm/index.d.ts +32 -0
  501. package/dist/esm/index.d.ts.map +1 -0
  502. package/dist/esm/index.js +30 -0
  503. package/dist/esm/index.js.map +1 -0
  504. package/dist/esm/log.d.ts +5 -0
  505. package/dist/esm/log.d.ts.map +1 -0
  506. package/dist/esm/log.js +8 -0
  507. package/dist/esm/log.js.map +1 -0
  508. package/dist/esm/models.d.ts +373 -0
  509. package/dist/esm/models.d.ts.map +1 -0
  510. package/dist/esm/models.js +94 -0
  511. package/dist/esm/models.js.map +1 -0
  512. package/dist/esm/package.json +3 -0
  513. package/dist/esm/policies/StorageRetryPolicy.d.ts +75 -0
  514. package/dist/esm/policies/StorageRetryPolicy.d.ts.map +1 -0
  515. package/dist/esm/policies/StorageRetryPolicy.js +220 -0
  516. package/dist/esm/policies/StorageRetryPolicy.js.map +1 -0
  517. package/dist/esm/policies/StorageRetryPolicyV2.d.ts +24 -0
  518. package/dist/esm/policies/StorageRetryPolicyV2.d.ts.map +1 -0
  519. package/dist/esm/policies/StorageRetryPolicyV2.js +176 -0
  520. package/dist/esm/policies/StorageRetryPolicyV2.js.map +1 -0
  521. package/dist/esm/utils/Batch.d.ts +68 -0
  522. package/dist/esm/utils/Batch.d.ts.map +1 -0
  523. package/dist/esm/utils/Batch.js.map +1 -0
  524. package/dist/esm/utils/BufferScheduler.d.ts +157 -0
  525. package/dist/esm/utils/BufferScheduler.d.ts.map +1 -0
  526. package/dist/esm/utils/BufferScheduler.js +264 -0
  527. package/dist/esm/utils/BufferScheduler.js.map +1 -0
  528. package/dist/esm/utils/RetriableReadableStream.d.ts +58 -0
  529. package/dist/esm/utils/RetriableReadableStream.d.ts.map +1 -0
  530. package/dist/esm/utils/RetriableReadableStream.js +119 -0
  531. package/dist/esm/utils/RetriableReadableStream.js.map +1 -0
  532. package/dist/esm/utils/constants.d.ts +55 -0
  533. package/dist/esm/utils/constants.d.ts.map +1 -0
  534. package/dist/esm/utils/constants.js +162 -0
  535. package/dist/esm/utils/constants.js.map +1 -0
  536. package/dist/esm/utils/tracing.d.ts +6 -0
  537. package/dist/esm/utils/tracing.d.ts.map +1 -0
  538. package/dist/esm/utils/tracing.js +14 -0
  539. package/dist/esm/utils/tracing.js.map +1 -0
  540. package/dist/esm/utils/utils.common.d.ts +304 -0
  541. package/dist/esm/utils/utils.common.d.ts.map +1 -0
  542. package/dist/esm/utils/utils.common.js +778 -0
  543. package/dist/esm/utils/utils.common.js.map +1 -0
  544. package/dist/esm/utils/utils.d.ts +28 -0
  545. package/dist/esm/utils/utils.d.ts.map +1 -0
  546. package/dist/esm/utils/utils.js +79 -0
  547. package/dist/esm/utils/utils.js.map +1 -0
  548. package/dist/react-native/AccountSASPermissions.d.ts +61 -0
  549. package/dist/react-native/AccountSASPermissions.d.ts.map +1 -0
  550. package/dist/react-native/AccountSASPermissions.js +128 -0
  551. package/dist/react-native/AccountSASPermissions.js.map +1 -0
  552. package/dist/react-native/AccountSASResourceTypes.d.ts +38 -0
  553. package/dist/react-native/AccountSASResourceTypes.d.ts.map +1 -0
  554. package/dist/react-native/AccountSASResourceTypes.js +72 -0
  555. package/dist/react-native/AccountSASResourceTypes.js.map +1 -0
  556. package/dist/react-native/AccountSASServices.d.ts +40 -0
  557. package/dist/react-native/AccountSASServices.d.ts.map +1 -0
  558. package/dist/react-native/AccountSASServices.js +80 -0
  559. package/dist/react-native/AccountSASServices.js.map +1 -0
  560. package/dist/react-native/AccountSASSignatureValues.d.ts +73 -0
  561. package/dist/react-native/AccountSASSignatureValues.d.ts.map +1 -0
  562. package/dist/react-native/AccountSASSignatureValues.js +71 -0
  563. package/dist/react-native/AccountSASSignatureValues.js.map +1 -0
  564. package/dist/react-native/Clients.d.ts +3114 -0
  565. package/dist/react-native/Clients.d.ts.map +1 -0
  566. package/dist/react-native/Clients.js +2882 -0
  567. package/dist/react-native/Clients.js.map +1 -0
  568. package/dist/react-native/FileDownloadResponse.d.ts +291 -0
  569. package/dist/react-native/FileDownloadResponse.d.ts.map +1 -0
  570. package/dist/react-native/FileDownloadResponse.js +367 -0
  571. package/dist/react-native/FileDownloadResponse.js.map +1 -0
  572. package/dist/react-native/FileSASPermissions.d.ts +42 -0
  573. package/dist/react-native/FileSASPermissions.d.ts.map +1 -0
  574. package/dist/react-native/FileSASPermissions.js +82 -0
  575. package/dist/react-native/FileSASPermissions.js.map +1 -0
  576. package/dist/react-native/FileSASSignatureValues.d.ts +95 -0
  577. package/dist/react-native/FileSASSignatureValues.d.ts.map +1 -0
  578. package/dist/react-native/FileSASSignatureValues.js +84 -0
  579. package/dist/react-native/FileSASSignatureValues.js.map +1 -0
  580. package/dist/react-native/FileSystemAttributes.d.ts +63 -0
  581. package/dist/react-native/FileSystemAttributes.d.ts.map +1 -0
  582. package/dist/react-native/FileSystemAttributes.js +144 -0
  583. package/dist/react-native/FileSystemAttributes.js.map +1 -0
  584. package/dist/react-native/Pipeline.d.ts +142 -0
  585. package/dist/react-native/Pipeline.d.ts.map +1 -0
  586. package/dist/react-native/Pipeline.js +261 -0
  587. package/dist/react-native/Pipeline.js.map +1 -0
  588. package/dist/react-native/Range.d.ts +25 -0
  589. package/dist/react-native/Range.d.ts.map +1 -0
  590. package/dist/react-native/Range.js +22 -0
  591. package/dist/react-native/Range.js.map +1 -0
  592. package/dist/react-native/SASQueryParameters.d.ts +136 -0
  593. package/dist/react-native/SASQueryParameters.d.ts.map +1 -0
  594. package/dist/react-native/SASQueryParameters.js +177 -0
  595. package/dist/react-native/SASQueryParameters.js.map +1 -0
  596. package/dist/react-native/SasIPRange.d.ts +25 -0
  597. package/dist/react-native/SasIPRange.d.ts.map +1 -0
  598. package/dist/react-native/SasIPRange.js +14 -0
  599. package/dist/react-native/SasIPRange.js.map +1 -0
  600. package/dist/react-native/ShareClientInternal.d.ts +12 -0
  601. package/dist/react-native/ShareClientInternal.d.ts.map +1 -0
  602. package/dist/react-native/ShareClientInternal.js +16 -0
  603. package/dist/react-native/ShareClientInternal.js.map +1 -0
  604. package/dist/react-native/ShareSASPermissions.d.ts +46 -0
  605. package/dist/react-native/ShareSASPermissions.d.ts.map +1 -0
  606. package/dist/react-native/ShareSASPermissions.js +92 -0
  607. package/dist/react-native/ShareSASPermissions.js.map +1 -0
  608. package/dist/react-native/ShareServiceClient.d.ts +427 -0
  609. package/dist/react-native/ShareServiceClient.d.ts.map +1 -0
  610. package/dist/react-native/ShareServiceClient.js +475 -0
  611. package/dist/react-native/ShareServiceClient.js.map +1 -0
  612. package/dist/react-native/StorageClient.d.ts +47 -0
  613. package/dist/react-native/StorageClient.d.ts.map +1 -0
  614. package/dist/react-native/StorageClient.js +30 -0
  615. package/dist/react-native/StorageClient.js.map +1 -0
  616. package/dist/react-native/StorageContextClient.d.ts +9 -0
  617. package/dist/react-native/StorageContextClient.d.ts.map +1 -0
  618. package/dist/react-native/StorageContextClient.js +18 -0
  619. package/dist/react-native/StorageContextClient.js.map +1 -0
  620. package/dist/react-native/StorageRetryPolicyFactory.d.ts +56 -0
  621. package/dist/react-native/StorageRetryPolicyFactory.d.ts.map +1 -0
  622. package/dist/react-native/StorageRetryPolicyFactory.js +26 -0
  623. package/dist/react-native/StorageRetryPolicyFactory.js.map +1 -0
  624. package/dist/react-native/generated/src/index.d.ts +4 -0
  625. package/dist/react-native/generated/src/index.d.ts.map +1 -0
  626. package/dist/react-native/generated/src/index.js +11 -0
  627. package/dist/react-native/generated/src/index.js.map +1 -0
  628. package/dist/react-native/generated/src/models/index.d.ts +2881 -0
  629. package/dist/react-native/generated/src/models/index.d.ts.map +1 -0
  630. package/dist/react-native/generated/src/models/index.js +166 -0
  631. package/dist/react-native/generated/src/models/index.js.map +1 -0
  632. package/dist/react-native/generated/src/models/mappers.d.ts +128 -0
  633. package/dist/react-native/generated/src/models/mappers.d.ts.map +1 -0
  634. package/dist/react-native/generated/src/models/mappers.js +5987 -0
  635. package/dist/react-native/generated/src/models/mappers.js.map +1 -0
  636. package/dist/react-native/generated/src/models/parameters.d.ts +128 -0
  637. package/dist/react-native/generated/src/models/parameters.d.ts.map +1 -0
  638. package/dist/react-native/generated/src/models/parameters.js +1364 -0
  639. package/dist/react-native/generated/src/models/parameters.js.map +1 -0
  640. package/dist/react-native/generated/src/operations/directory.d.ts +65 -0
  641. package/dist/react-native/generated/src/operations/directory.d.ts.map +1 -0
  642. package/dist/react-native/generated/src/operations/directory.js +378 -0
  643. package/dist/react-native/generated/src/operations/directory.js.map +1 -0
  644. package/dist/react-native/generated/src/operations/file.d.ts +162 -0
  645. package/dist/react-native/generated/src/operations/file.d.ts.map +1 -0
  646. package/dist/react-native/generated/src/operations/file.js +866 -0
  647. package/dist/react-native/generated/src/operations/file.js.map +1 -0
  648. package/dist/react-native/generated/src/operations/index.d.ts +5 -0
  649. package/dist/react-native/generated/src/operations/index.d.ts.map +1 -0
  650. package/dist/react-native/generated/src/operations/index.js +12 -0
  651. package/dist/react-native/generated/src/operations/index.js.map +1 -0
  652. package/dist/react-native/generated/src/operations/service.d.ts +32 -0
  653. package/dist/react-native/generated/src/operations/service.d.ts.map +1 -0
  654. package/dist/react-native/generated/src/operations/service.js +135 -0
  655. package/dist/react-native/generated/src/operations/service.js.map +1 -0
  656. package/dist/react-native/generated/src/operations/share.d.ts +111 -0
  657. package/dist/react-native/generated/src/operations/share.d.ts.map +1 -0
  658. package/dist/react-native/generated/src/operations/share.js +671 -0
  659. package/dist/react-native/generated/src/operations/share.js.map +1 -0
  660. package/dist/react-native/generated/src/operationsInterfaces/directory.d.ts +57 -0
  661. package/dist/react-native/generated/src/operationsInterfaces/directory.d.ts.map +1 -0
  662. package/dist/react-native/generated/src/operationsInterfaces/directory.js +9 -0
  663. package/dist/react-native/generated/src/operationsInterfaces/directory.js.map +1 -0
  664. package/dist/react-native/generated/src/operationsInterfaces/file.d.ts +154 -0
  665. package/dist/react-native/generated/src/operationsInterfaces/file.d.ts.map +1 -0
  666. package/dist/react-native/generated/src/operationsInterfaces/file.js +9 -0
  667. package/dist/react-native/generated/src/operationsInterfaces/file.js.map +1 -0
  668. package/dist/react-native/generated/src/operationsInterfaces/index.d.ts +5 -0
  669. package/dist/react-native/generated/src/operationsInterfaces/index.d.ts.map +1 -0
  670. package/dist/react-native/generated/src/operationsInterfaces/index.js +12 -0
  671. package/dist/react-native/generated/src/operationsInterfaces/index.js.map +1 -0
  672. package/dist/react-native/generated/src/operationsInterfaces/service.d.ts +24 -0
  673. package/dist/react-native/generated/src/operationsInterfaces/service.d.ts.map +1 -0
  674. package/dist/react-native/generated/src/operationsInterfaces/service.js +9 -0
  675. package/dist/react-native/generated/src/operationsInterfaces/service.js.map +1 -0
  676. package/dist/react-native/generated/src/operationsInterfaces/share.d.ts +103 -0
  677. package/dist/react-native/generated/src/operationsInterfaces/share.d.ts.map +1 -0
  678. package/dist/react-native/generated/src/operationsInterfaces/share.js +9 -0
  679. package/dist/react-native/generated/src/operationsInterfaces/share.js.map +1 -0
  680. package/dist/react-native/generated/src/storageClient.d.ts +20 -0
  681. package/dist/react-native/generated/src/storageClient.d.ts.map +1 -0
  682. package/dist/react-native/generated/src/storageClient.js +48 -0
  683. package/dist/react-native/generated/src/storageClient.js.map +1 -0
  684. package/dist/react-native/generatedModels.d.ts +492 -0
  685. package/dist/react-native/generatedModels.d.ts.map +1 -0
  686. package/dist/react-native/generatedModels.js +8 -0
  687. package/dist/react-native/generatedModels.js.map +1 -0
  688. package/dist/react-native/index.d.ts +32 -0
  689. package/dist/react-native/index.d.ts.map +1 -0
  690. package/dist/react-native/index.js +30 -0
  691. package/dist/react-native/index.js.map +1 -0
  692. package/dist/react-native/log.d.ts +5 -0
  693. package/dist/react-native/log.d.ts.map +1 -0
  694. package/dist/react-native/log.js +8 -0
  695. package/dist/react-native/log.js.map +1 -0
  696. package/dist/react-native/models.d.ts +373 -0
  697. package/dist/react-native/models.d.ts.map +1 -0
  698. package/dist/react-native/models.js +94 -0
  699. package/dist/react-native/models.js.map +1 -0
  700. package/dist/react-native/package.json +3 -0
  701. package/dist/react-native/policies/StorageRetryPolicy.d.ts +75 -0
  702. package/dist/react-native/policies/StorageRetryPolicy.d.ts.map +1 -0
  703. package/dist/react-native/policies/StorageRetryPolicy.js +220 -0
  704. package/dist/react-native/policies/StorageRetryPolicy.js.map +1 -0
  705. package/dist/react-native/policies/StorageRetryPolicyV2.d.ts +24 -0
  706. package/dist/react-native/policies/StorageRetryPolicyV2.d.ts.map +1 -0
  707. package/dist/react-native/policies/StorageRetryPolicyV2.js +176 -0
  708. package/dist/react-native/policies/StorageRetryPolicyV2.js.map +1 -0
  709. package/dist/react-native/utils/Batch.d.ts +68 -0
  710. package/dist/react-native/utils/Batch.d.ts.map +1 -0
  711. package/dist/react-native/utils/Batch.js +122 -0
  712. package/dist/react-native/utils/Batch.js.map +1 -0
  713. package/dist/react-native/utils/BufferScheduler.d.ts +157 -0
  714. package/dist/react-native/utils/BufferScheduler.d.ts.map +1 -0
  715. package/dist/react-native/utils/BufferScheduler.js +264 -0
  716. package/dist/react-native/utils/BufferScheduler.js.map +1 -0
  717. package/dist/react-native/utils/RetriableReadableStream.d.ts +58 -0
  718. package/dist/react-native/utils/RetriableReadableStream.d.ts.map +1 -0
  719. package/dist/react-native/utils/RetriableReadableStream.js +119 -0
  720. package/dist/react-native/utils/RetriableReadableStream.js.map +1 -0
  721. package/dist/react-native/utils/constants.d.ts +55 -0
  722. package/dist/react-native/utils/constants.d.ts.map +1 -0
  723. package/dist/react-native/utils/constants.js +162 -0
  724. package/dist/react-native/utils/constants.js.map +1 -0
  725. package/dist/react-native/utils/tracing.d.ts +6 -0
  726. package/dist/react-native/utils/tracing.d.ts.map +1 -0
  727. package/dist/react-native/utils/tracing.js +14 -0
  728. package/dist/react-native/utils/tracing.js.map +1 -0
  729. package/dist/react-native/utils/utils.common.d.ts +304 -0
  730. package/dist/react-native/utils/utils.common.d.ts.map +1 -0
  731. package/dist/react-native/utils/utils.common.js +778 -0
  732. package/dist/react-native/utils/utils.common.js.map +1 -0
  733. package/dist/react-native/utils/utils.d.ts +28 -0
  734. package/dist/react-native/utils/utils.d.ts.map +1 -0
  735. package/dist/react-native/utils/utils.js +79 -0
  736. package/dist/react-native/utils/utils.js.map +1 -0
  737. package/package.json +69 -74
  738. package/dist/index.js +0 -16901
  739. package/dist/index.js.map +0 -1
  740. package/dist-esm/storage-blob/src/BatchResponse.js +0 -4
  741. package/dist-esm/storage-blob/src/BatchResponse.js.map +0 -1
  742. package/dist-esm/storage-blob/src/BatchResponseParser.js +0 -137
  743. package/dist-esm/storage-blob/src/BatchResponseParser.js.map +0 -1
  744. package/dist-esm/storage-blob/src/BatchUtils.js +0 -15
  745. package/dist-esm/storage-blob/src/BatchUtils.js.map +0 -1
  746. package/dist-esm/storage-blob/src/BlobBatch.js +0 -267
  747. package/dist-esm/storage-blob/src/BlobBatch.js.map +0 -1
  748. package/dist-esm/storage-blob/src/BlobBatchClient.js +0 -140
  749. package/dist-esm/storage-blob/src/BlobBatchClient.js.map +0 -1
  750. package/dist-esm/storage-blob/src/BlobDownloadResponse.js +0 -463
  751. package/dist-esm/storage-blob/src/BlobDownloadResponse.js.map +0 -1
  752. package/dist-esm/storage-blob/src/BlobLeaseClient.js +0 -192
  753. package/dist-esm/storage-blob/src/BlobLeaseClient.js.map +0 -1
  754. package/dist-esm/storage-blob/src/BlobQueryResponse.js +0 -367
  755. package/dist-esm/storage-blob/src/BlobQueryResponse.js.map +0 -1
  756. package/dist-esm/storage-blob/src/BlobServiceClient.js +0 -716
  757. package/dist-esm/storage-blob/src/BlobServiceClient.js.map +0 -1
  758. package/dist-esm/storage-blob/src/Clients.js +0 -2594
  759. package/dist-esm/storage-blob/src/Clients.js.map +0 -1
  760. package/dist-esm/storage-blob/src/ContainerClient.js +0 -1209
  761. package/dist-esm/storage-blob/src/ContainerClient.js.map +0 -1
  762. package/dist-esm/storage-blob/src/PageBlobRangeResponse.js +0 -24
  763. package/dist-esm/storage-blob/src/PageBlobRangeResponse.js.map +0 -1
  764. package/dist-esm/storage-blob/src/Pipeline.js +0 -261
  765. package/dist-esm/storage-blob/src/Pipeline.js.map +0 -1
  766. package/dist-esm/storage-blob/src/Range.js +0 -21
  767. package/dist-esm/storage-blob/src/Range.js.map +0 -1
  768. package/dist-esm/storage-blob/src/StorageBrowserPolicyFactory.js +0 -19
  769. package/dist-esm/storage-blob/src/StorageBrowserPolicyFactory.js.map +0 -1
  770. package/dist-esm/storage-blob/src/StorageClient.js +0 -29
  771. package/dist-esm/storage-blob/src/StorageClient.js.map +0 -1
  772. package/dist-esm/storage-blob/src/StorageContextClient.js +0 -17
  773. package/dist-esm/storage-blob/src/StorageContextClient.js.map +0 -1
  774. package/dist-esm/storage-blob/src/StorageRetryPolicyFactory.js +0 -26
  775. package/dist-esm/storage-blob/src/StorageRetryPolicyFactory.js.map +0 -1
  776. package/dist-esm/storage-blob/src/credentials/AnonymousCredential.js +0 -22
  777. package/dist-esm/storage-blob/src/credentials/AnonymousCredential.js.map +0 -1
  778. package/dist-esm/storage-blob/src/credentials/Credential.js +0 -18
  779. package/dist-esm/storage-blob/src/credentials/Credential.js.map +0 -1
  780. package/dist-esm/storage-blob/src/credentials/StorageSharedKeyCredential.browser.js +0 -5
  781. package/dist-esm/storage-blob/src/credentials/StorageSharedKeyCredential.browser.js.map +0 -1
  782. package/dist-esm/storage-blob/src/credentials/StorageSharedKeyCredential.js +0 -40
  783. package/dist-esm/storage-blob/src/credentials/StorageSharedKeyCredential.js.map +0 -1
  784. package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.browser.js +0 -5
  785. package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.browser.js.map +0 -1
  786. package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js +0 -31
  787. package/dist-esm/storage-blob/src/credentials/UserDelegationKeyCredential.js.map +0 -1
  788. package/dist-esm/storage-blob/src/generated/src/index.js +0 -11
  789. package/dist-esm/storage-blob/src/generated/src/index.js.map +0 -1
  790. package/dist-esm/storage-blob/src/generated/src/models/index.js +0 -258
  791. package/dist-esm/storage-blob/src/generated/src/models/index.js.map +0 -1
  792. package/dist-esm/storage-blob/src/generated/src/models/mappers.js +0 -8225
  793. package/dist-esm/storage-blob/src/generated/src/models/mappers.js.map +0 -1
  794. package/dist-esm/storage-blob/src/generated/src/models/parameters.js +0 -1610
  795. package/dist-esm/storage-blob/src/generated/src/models/parameters.js.map +0 -1
  796. package/dist-esm/storage-blob/src/generated/src/operations/appendBlob.js +0 -221
  797. package/dist-esm/storage-blob/src/generated/src/operations/appendBlob.js.map +0 -1
  798. package/dist-esm/storage-blob/src/generated/src/operations/blob.js +0 -1020
  799. package/dist-esm/storage-blob/src/generated/src/operations/blob.js.map +0 -1
  800. package/dist-esm/storage-blob/src/generated/src/operations/blockBlob.js +0 -365
  801. package/dist-esm/storage-blob/src/generated/src/operations/blockBlob.js.map +0 -1
  802. package/dist-esm/storage-blob/src/generated/src/operations/container.js +0 -713
  803. package/dist-esm/storage-blob/src/generated/src/operations/container.js.map +0 -1
  804. package/dist-esm/storage-blob/src/generated/src/operations/index.js +0 -14
  805. package/dist-esm/storage-blob/src/generated/src/operations/index.js.map +0 -1
  806. package/dist-esm/storage-blob/src/generated/src/operations/pageBlob.js +0 -456
  807. package/dist-esm/storage-blob/src/generated/src/operations/pageBlob.js.map +0 -1
  808. package/dist-esm/storage-blob/src/generated/src/operations/service.js +0 -323
  809. package/dist-esm/storage-blob/src/generated/src/operations/service.js.map +0 -1
  810. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/appendBlob.js +0 -9
  811. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/appendBlob.js.map +0 -1
  812. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blob.js +0 -9
  813. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blob.js.map +0 -1
  814. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blockBlob.js +0 -9
  815. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blockBlob.js.map +0 -1
  816. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/container.js +0 -9
  817. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/container.js.map +0 -1
  818. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/index.js +0 -14
  819. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/index.js.map +0 -1
  820. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/pageBlob.js +0 -9
  821. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/pageBlob.js.map +0 -1
  822. package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/service.js.map +0 -1
  823. package/dist-esm/storage-blob/src/generated/src/storageClient.js +0 -49
  824. package/dist-esm/storage-blob/src/generated/src/storageClient.js.map +0 -1
  825. package/dist-esm/storage-blob/src/generatedModels.js +0 -8
  826. package/dist-esm/storage-blob/src/generatedModels.js.map +0 -1
  827. package/dist-esm/storage-blob/src/index.js +0 -33
  828. package/dist-esm/storage-blob/src/index.js.map +0 -1
  829. package/dist-esm/storage-blob/src/log.js +0 -8
  830. package/dist-esm/storage-blob/src/log.js.map +0 -1
  831. package/dist-esm/storage-blob/src/models.js +0 -115
  832. package/dist-esm/storage-blob/src/models.js.map +0 -1
  833. package/dist-esm/storage-blob/src/policies/AnonymousCredentialPolicy.js +0 -20
  834. package/dist-esm/storage-blob/src/policies/AnonymousCredentialPolicy.js.map +0 -1
  835. package/dist-esm/storage-blob/src/policies/CredentialPolicy.js +0 -29
  836. package/dist-esm/storage-blob/src/policies/CredentialPolicy.js.map +0 -1
  837. package/dist-esm/storage-blob/src/policies/RequestPolicy.js +0 -40
  838. package/dist-esm/storage-blob/src/policies/RequestPolicy.js.map +0 -1
  839. package/dist-esm/storage-blob/src/policies/StorageBrowserPolicy.js +0 -47
  840. package/dist-esm/storage-blob/src/policies/StorageBrowserPolicy.js.map +0 -1
  841. package/dist-esm/storage-blob/src/policies/StorageBrowserPolicyV2.js +0 -31
  842. package/dist-esm/storage-blob/src/policies/StorageBrowserPolicyV2.js.map +0 -1
  843. package/dist-esm/storage-blob/src/policies/StorageCorrectContentLengthPolicy.browser.js +0 -18
  844. package/dist-esm/storage-blob/src/policies/StorageCorrectContentLengthPolicy.browser.js.map +0 -1
  845. package/dist-esm/storage-blob/src/policies/StorageCorrectContentLengthPolicy.js +0 -27
  846. package/dist-esm/storage-blob/src/policies/StorageCorrectContentLengthPolicy.js.map +0 -1
  847. package/dist-esm/storage-blob/src/policies/StorageRetryPolicy.js +0 -229
  848. package/dist-esm/storage-blob/src/policies/StorageRetryPolicy.js.map +0 -1
  849. package/dist-esm/storage-blob/src/policies/StorageRetryPolicyV2.js +0 -180
  850. package/dist-esm/storage-blob/src/policies/StorageRetryPolicyV2.js.map +0 -1
  851. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js +0 -141
  852. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js.map +0 -1
  853. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.browser.js +0 -18
  854. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.browser.js.map +0 -1
  855. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js +0 -132
  856. package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js.map +0 -1
  857. package/dist-esm/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.js +0 -130
  858. package/dist-esm/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.js.map +0 -1
  859. package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js +0 -227
  860. package/dist-esm/storage-blob/src/sas/AccountSASPermissions.js.map +0 -1
  861. package/dist-esm/storage-blob/src/sas/AccountSASResourceTypes.js.map +0 -1
  862. package/dist-esm/storage-blob/src/sas/AccountSASServices.js.map +0 -1
  863. package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js +0 -100
  864. package/dist-esm/storage-blob/src/sas/AccountSASSignatureValues.js.map +0 -1
  865. package/dist-esm/storage-blob/src/sas/BlobSASPermissions.js +0 -195
  866. package/dist-esm/storage-blob/src/sas/BlobSASPermissions.js.map +0 -1
  867. package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js +0 -576
  868. package/dist-esm/storage-blob/src/sas/BlobSASSignatureValues.js.map +0 -1
  869. package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js +0 -221
  870. package/dist-esm/storage-blob/src/sas/ContainerSASPermissions.js.map +0 -1
  871. package/dist-esm/storage-blob/src/sas/SASQueryParameters.js +0 -234
  872. package/dist-esm/storage-blob/src/sas/SASQueryParameters.js.map +0 -1
  873. package/dist-esm/storage-blob/src/sas/SasIPRange.js +0 -13
  874. package/dist-esm/storage-blob/src/sas/SasIPRange.js.map +0 -1
  875. package/dist-esm/storage-blob/src/utils/Batch.js.map +0 -1
  876. package/dist-esm/storage-blob/src/utils/BlobQuickQueryStream.js +0 -111
  877. package/dist-esm/storage-blob/src/utils/BlobQuickQueryStream.js.map +0 -1
  878. package/dist-esm/storage-blob/src/utils/Mutex.js +0 -65
  879. package/dist-esm/storage-blob/src/utils/Mutex.js.map +0 -1
  880. package/dist-esm/storage-blob/src/utils/RetriableReadableStream.js +0 -119
  881. package/dist-esm/storage-blob/src/utils/RetriableReadableStream.js.map +0 -1
  882. package/dist-esm/storage-blob/src/utils/SharedKeyComparator.js +0 -73
  883. package/dist-esm/storage-blob/src/utils/SharedKeyComparator.js.map +0 -1
  884. package/dist-esm/storage-blob/src/utils/cache.js +0 -11
  885. package/dist-esm/storage-blob/src/utils/cache.js.map +0 -1
  886. package/dist-esm/storage-blob/src/utils/constants.js +0 -226
  887. package/dist-esm/storage-blob/src/utils/constants.js.map +0 -1
  888. package/dist-esm/storage-blob/src/utils/tracing.js +0 -14
  889. package/dist-esm/storage-blob/src/utils/tracing.js.map +0 -1
  890. package/dist-esm/storage-blob/src/utils/utils.common.js +0 -756
  891. package/dist-esm/storage-blob/src/utils/utils.common.js.map +0 -1
  892. package/dist-esm/storage-blob/src/utils/utils.node.js +0 -132
  893. package/dist-esm/storage-blob/src/utils/utils.node.js.map +0 -1
  894. package/dist-esm/storage-file-share/src/AccountSASPermissions.js.map +0 -1
  895. package/dist-esm/storage-file-share/src/AccountSASResourceTypes.js.map +0 -1
  896. package/dist-esm/storage-file-share/src/AccountSASServices.js.map +0 -1
  897. package/dist-esm/storage-file-share/src/AccountSASSignatureValues.js +0 -71
  898. package/dist-esm/storage-file-share/src/AccountSASSignatureValues.js.map +0 -1
  899. package/dist-esm/storage-file-share/src/Clients.js +0 -2642
  900. package/dist-esm/storage-file-share/src/Clients.js.map +0 -1
  901. package/dist-esm/storage-file-share/src/FileDownloadResponse.browser.js +0 -7
  902. package/dist-esm/storage-file-share/src/FileDownloadResponse.browser.js.map +0 -1
  903. package/dist-esm/storage-file-share/src/FileDownloadResponse.js +0 -367
  904. package/dist-esm/storage-file-share/src/FileDownloadResponse.js.map +0 -1
  905. package/dist-esm/storage-file-share/src/FileSASPermissions.js.map +0 -1
  906. package/dist-esm/storage-file-share/src/FileSASSignatureValues.js +0 -84
  907. package/dist-esm/storage-file-share/src/FileSASSignatureValues.js.map +0 -1
  908. package/dist-esm/storage-file-share/src/FileSystemAttributes.js.map +0 -1
  909. package/dist-esm/storage-file-share/src/Pipeline.js +0 -261
  910. package/dist-esm/storage-file-share/src/Pipeline.js.map +0 -1
  911. package/dist-esm/storage-file-share/src/Range.js.map +0 -1
  912. package/dist-esm/storage-file-share/src/SASQueryParameters.js +0 -177
  913. package/dist-esm/storage-file-share/src/SASQueryParameters.js.map +0 -1
  914. package/dist-esm/storage-file-share/src/SasIPRange.js.map +0 -1
  915. package/dist-esm/storage-file-share/src/ShareClientInternal.js +0 -16
  916. package/dist-esm/storage-file-share/src/ShareClientInternal.js.map +0 -1
  917. package/dist-esm/storage-file-share/src/ShareSASPermissions.js.map +0 -1
  918. package/dist-esm/storage-file-share/src/ShareServiceClient.js +0 -429
  919. package/dist-esm/storage-file-share/src/ShareServiceClient.js.map +0 -1
  920. package/dist-esm/storage-file-share/src/StorageClient.js +0 -30
  921. package/dist-esm/storage-file-share/src/StorageClient.js.map +0 -1
  922. package/dist-esm/storage-file-share/src/StorageContextClient.js +0 -18
  923. package/dist-esm/storage-file-share/src/StorageContextClient.js.map +0 -1
  924. package/dist-esm/storage-file-share/src/StorageRetryPolicyFactory.js +0 -26
  925. package/dist-esm/storage-file-share/src/StorageRetryPolicyFactory.js.map +0 -1
  926. package/dist-esm/storage-file-share/src/generated/src/index.js +0 -11
  927. package/dist-esm/storage-file-share/src/generated/src/index.js.map +0 -1
  928. package/dist-esm/storage-file-share/src/generated/src/models/index.js.map +0 -1
  929. package/dist-esm/storage-file-share/src/generated/src/models/mappers.js.map +0 -1
  930. package/dist-esm/storage-file-share/src/generated/src/models/parameters.js +0 -1364
  931. package/dist-esm/storage-file-share/src/generated/src/models/parameters.js.map +0 -1
  932. package/dist-esm/storage-file-share/src/generated/src/operations/directory.js +0 -378
  933. package/dist-esm/storage-file-share/src/generated/src/operations/directory.js.map +0 -1
  934. package/dist-esm/storage-file-share/src/generated/src/operations/file.js +0 -866
  935. package/dist-esm/storage-file-share/src/generated/src/operations/file.js.map +0 -1
  936. package/dist-esm/storage-file-share/src/generated/src/operations/index.js +0 -12
  937. package/dist-esm/storage-file-share/src/generated/src/operations/index.js.map +0 -1
  938. package/dist-esm/storage-file-share/src/generated/src/operations/service.js +0 -135
  939. package/dist-esm/storage-file-share/src/generated/src/operations/service.js.map +0 -1
  940. package/dist-esm/storage-file-share/src/generated/src/operations/share.js +0 -671
  941. package/dist-esm/storage-file-share/src/generated/src/operations/share.js.map +0 -1
  942. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/directory.js.map +0 -1
  943. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/file.js.map +0 -1
  944. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/index.js +0 -12
  945. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/index.js.map +0 -1
  946. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/service.js.map +0 -1
  947. package/dist-esm/storage-file-share/src/generated/src/operationsInterfaces/share.js.map +0 -1
  948. package/dist-esm/storage-file-share/src/generated/src/storageClient.js +0 -48
  949. package/dist-esm/storage-file-share/src/generated/src/storageClient.js.map +0 -1
  950. package/dist-esm/storage-file-share/src/generatedModels.js.map +0 -1
  951. package/dist-esm/storage-file-share/src/index.browser.js +0 -19
  952. package/dist-esm/storage-file-share/src/index.browser.js.map +0 -1
  953. package/dist-esm/storage-file-share/src/index.js +0 -30
  954. package/dist-esm/storage-file-share/src/index.js.map +0 -1
  955. package/dist-esm/storage-file-share/src/log.js.map +0 -1
  956. package/dist-esm/storage-file-share/src/models.js +0 -94
  957. package/dist-esm/storage-file-share/src/models.js.map +0 -1
  958. package/dist-esm/storage-file-share/src/policies/StorageRetryPolicy.js +0 -220
  959. package/dist-esm/storage-file-share/src/policies/StorageRetryPolicy.js.map +0 -1
  960. package/dist-esm/storage-file-share/src/policies/StorageRetryPolicyV2.js +0 -176
  961. package/dist-esm/storage-file-share/src/policies/StorageRetryPolicyV2.js.map +0 -1
  962. package/dist-esm/storage-file-share/src/utils/Batch.js.map +0 -1
  963. package/dist-esm/storage-file-share/src/utils/BufferScheduler.js.map +0 -1
  964. package/dist-esm/storage-file-share/src/utils/RetriableReadableStream.js +0 -119
  965. package/dist-esm/storage-file-share/src/utils/RetriableReadableStream.js.map +0 -1
  966. package/dist-esm/storage-file-share/src/utils/constants.js +0 -162
  967. package/dist-esm/storage-file-share/src/utils/constants.js.map +0 -1
  968. package/dist-esm/storage-file-share/src/utils/tracing.js +0 -14
  969. package/dist-esm/storage-file-share/src/utils/tracing.js.map +0 -1
  970. package/dist-esm/storage-file-share/src/utils/utils.browser.js +0 -30
  971. package/dist-esm/storage-file-share/src/utils/utils.browser.js.map +0 -1
  972. package/dist-esm/storage-file-share/src/utils/utils.common.js +0 -777
  973. package/dist-esm/storage-file-share/src/utils/utils.common.js.map +0 -1
  974. package/dist-esm/storage-file-share/src/utils/utils.node.js +0 -79
  975. package/dist-esm/storage-file-share/src/utils/utils.node.js.map +0 -1
  976. package/types/latest/storage-file-share.d.ts +0 -8411
  977. /package/{dist-esm/storage-file-share/src → dist/browser}/AccountSASPermissions.js +0 -0
  978. /package/{dist-esm/storage-blob/src/sas → dist/browser}/AccountSASResourceTypes.js +0 -0
  979. /package/{dist-esm/storage-blob/src/sas → dist/browser}/AccountSASServices.js +0 -0
  980. /package/{dist-esm/storage-file-share/src → dist/browser}/FileSASPermissions.js +0 -0
  981. /package/{dist-esm/storage-file-share/src → dist/browser}/FileSystemAttributes.js +0 -0
  982. /package/{dist-esm/storage-file-share/src → dist/browser}/Range.js +0 -0
  983. /package/{dist-esm/storage-file-share/src → dist/browser}/SasIPRange.js +0 -0
  984. /package/{dist-esm/storage-file-share/src → dist/browser}/ShareSASPermissions.js +0 -0
  985. /package/{dist-esm/storage-file-share/src → dist/browser}/generated/src/models/index.js +0 -0
  986. /package/{dist-esm/storage-file-share/src → dist/browser}/generated/src/models/mappers.js +0 -0
  987. /package/{dist-esm/storage-file-share/src → dist/browser}/generated/src/operationsInterfaces/directory.js +0 -0
  988. /package/{dist-esm/storage-file-share/src → dist/browser}/generated/src/operationsInterfaces/file.js +0 -0
  989. /package/{dist-esm/storage-blob/src → dist/browser}/generated/src/operationsInterfaces/service.js +0 -0
  990. /package/{dist-esm/storage-file-share/src → dist/browser}/generated/src/operationsInterfaces/share.js +0 -0
  991. /package/{dist-esm/storage-file-share/src → dist/browser}/generatedModels.js +0 -0
  992. /package/{dist-esm/storage-file-share/src → dist/browser}/log.js +0 -0
  993. /package/{dist-esm/storage-blob/src → dist/browser}/utils/Batch.js +0 -0
  994. /package/{dist-esm/storage-file-share/src → dist/browser}/utils/BufferScheduler.js +0 -0
  995. /package/{dist-esm/storage-file-share/src → dist/esm}/AccountSASResourceTypes.js +0 -0
  996. /package/{dist-esm/storage-file-share/src → dist/esm}/AccountSASServices.js +0 -0
  997. /package/{dist-esm/storage-file-share/src → dist/esm}/generated/src/operationsInterfaces/service.js +0 -0
  998. /package/{dist-esm/storage-file-share/src → dist/esm}/utils/Batch.js +0 -0
@@ -0,0 +1,3114 @@
1
+ import type { TokenCredential } from "@azure/core-auth";
2
+ import type { RequestBodyType as HttpRequestBody, TransferProgressEvent } from "@azure/core-rest-pipeline";
3
+ import type { AbortSignalLike } from "@azure/abort-controller";
4
+ import type { CopyFileSmbInfo, DeleteSnapshotsOptionType, DirectoryCreateResponse, DirectoryDeleteResponse, DirectoryGetPropertiesResponse, DirectoryItem, DirectoryListFilesAndDirectoriesSegmentResponse, DirectoryListHandlesResponse, DirectorySetMetadataResponse, DirectorySetPropertiesResponse, DirectoryForceCloseHandlesHeaders, FileAbortCopyResponse, FileCreateResponse, FileDeleteResponse, FileDownloadResponseModel, FileForceCloseHandlesHeaders, FileGetPropertiesResponse, FileGetRangeListHeaders, FileGetRangeListDiffResponse, FileItem, FileListHandlesResponse, FilePermissionFormat, FileSetHTTPHeadersResponse, FileSetMetadataResponse, FileStartCopyResponse, FileUploadRangeFromURLResponse, FileUploadRangeResponse, HandleItem, LeaseAccessConditions, ModeCopyMode, OwnerCopyMode, RangeModel, ShareCreatePermissionResponse, ShareCreateResponse, ShareCreateSnapshotResponse, ShareDeleteResponse, ShareGetAccessPolicyHeaders, ShareGetPermissionResponse, ShareGetPropertiesResponseModel, ShareGetStatisticsResponseModel, ShareSetAccessPolicyResponse, ShareSetMetadataResponse, ShareSetQuotaResponse, SignedIdentifierModel, SourceModifiedAccessConditions, ShareAccessTier, ShareSetPropertiesResponse, ShareRootSquash, FileRenameResponse, DirectoryRenameResponse, FileLastWrittenMode, SharePermission, FileCreateHardLinkResponse, FileCreateSymbolicLinkResponse, FileGetSymbolicLinkResponse } from "./generatedModels.js";
5
+ import type { Pipeline } from "./Pipeline.js";
6
+ import type { WithResponse } from "./utils/utils.common.js";
7
+ import { Credential } from "@azure/storage-blob";
8
+ import type { CommonOptions } from "./StorageClient.js";
9
+ import { StorageClient } from "./StorageClient.js";
10
+ import type { PagedAsyncIterableIterator } from "@azure/core-paging";
11
+ import type { Range } from "./Range.js";
12
+ import type { CloseHandlesInfo, FileAndDirectoryCreateCommonOptions, FileAndDirectorySetPropertiesCommonOptions, FileHttpHeaders, Metadata, ShareProtocols, HttpAuthorization, ShareClientOptions, ShareClientConfig, FilePosixProperties, TimeNowType } from "./models.js";
13
+ import type { ShareSASPermissions } from "./ShareSASPermissions.js";
14
+ import type { SASProtocol } from "./SASQueryParameters.js";
15
+ import type { SasIPRange } from "./SasIPRange.js";
16
+ import type { FileSASPermissions } from "./FileSASPermissions.js";
17
+ export { ShareClientOptions, ShareClientConfig } from "./models.js";
18
+ /**
19
+ * Options to configure the {@link ShareClient.create} operation.
20
+ */
21
+ export interface ShareCreateOptions extends CommonOptions {
22
+ /**
23
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
24
+ * For example, use the @azure/abort-controller to create an `AbortSignal`.
25
+ */
26
+ abortSignal?: AbortSignalLike;
27
+ /**
28
+ * A name-value pair to associate with a file storage object.
29
+ */
30
+ metadata?: {
31
+ [propertyName: string]: string;
32
+ };
33
+ /**
34
+ * Specifies the maximum size of the share, in
35
+ * gigabytes.
36
+ */
37
+ quota?: number;
38
+ /**
39
+ * Specifies the access tier of the share. Possible values include: 'TransactionOptimized',
40
+ * 'Hot', 'Cool'
41
+ */
42
+ accessTier?: ShareAccessTier;
43
+ /**
44
+ * Supported in version 2020-02-10 and above. Specifies the enabled protocols on the share. If not specified, the default is SMB.
45
+ */
46
+ protocols?: ShareProtocols;
47
+ /**
48
+ * Root squash to set on the share. Only valid for NFS shares. Possible values include:
49
+ * 'NoRootSquash', 'RootSquash', 'AllSquash'.
50
+ */
51
+ rootSquash?: ShareRootSquash;
52
+ /**
53
+ * Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled.
54
+ * If not specified, the default is true.
55
+ */
56
+ enableSnapshotVirtualDirectoryAccess?: boolean;
57
+ /**
58
+ * Optional. Boolean. Default if not specified is false. This property enables paid bursting.
59
+ */
60
+ paidBurstingEnabled?: boolean;
61
+ /**
62
+ * Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec.
63
+ */
64
+ paidBurstingMaxBandwidthMibps?: number;
65
+ /**
66
+ * Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS.
67
+ */
68
+ paidBurstingMaxIops?: number;
69
+ /**
70
+ * Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares.
71
+ * Specifies the provisioned number of input/output operations per second (IOPS) of the share. If this is not specified, the provisioned IOPS is set to value calculated based on recommendation formula.
72
+ */
73
+ shareProvisionedIops?: number;
74
+ /** Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned bandwidth of the share, in mebibytes per second (MiBps). If this is not specified, the provisioned bandwidth is set to value calculated based on recommendation formula. */
75
+ shareProvisionedBandwidthMibps?: number;
76
+ }
77
+ /**
78
+ * Options to configure the {@link ShareClient.delete} operation.
79
+ */
80
+ export interface ShareDeleteMethodOptions extends CommonOptions {
81
+ /**
82
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
83
+ * For example, use the @azure/abort-controller to create an `AbortSignal`.
84
+ */
85
+ abortSignal?: AbortSignalLike;
86
+ /**
87
+ * Specifies the option
88
+ * include to delete the base share and all of its snapshots. Possible values
89
+ * include: 'include'
90
+ */
91
+ deleteSnapshots?: DeleteSnapshotsOptionType;
92
+ /**
93
+ * If specified, the operation only succeeds if the resource's lease is active and matches this ID.
94
+ */
95
+ leaseAccessConditions?: LeaseAccessConditions;
96
+ }
97
+ /**
98
+ * Options to configure the {@link ShareClient.setMetadata} operation.
99
+ */
100
+ export interface ShareSetMetadataOptions extends CommonOptions {
101
+ /**
102
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
103
+ * For example, use the @azure/abort-controller to create an `AbortSignal`.
104
+ */
105
+ abortSignal?: AbortSignalLike;
106
+ /**
107
+ * If specified, the operation only succeeds if the resource's lease is active and matches this ID.
108
+ */
109
+ leaseAccessConditions?: LeaseAccessConditions;
110
+ }
111
+ /**
112
+ * Options to configure the {@link ShareClient.setAccessPolicy} operation.
113
+ */
114
+ export interface ShareSetAccessPolicyOptions extends CommonOptions {
115
+ /**
116
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
117
+ * For example, use the @azure/abort-controller to create an `AbortSignal`.
118
+ */
119
+ abortSignal?: AbortSignalLike;
120
+ /**
121
+ * If specified, the operation only succeeds if the resource's lease is active and matches this ID.
122
+ */
123
+ leaseAccessConditions?: LeaseAccessConditions;
124
+ }
125
+ /**
126
+ * Options to configure the {@link ShareClient.getAccessPolicy} operation.
127
+ */
128
+ export interface ShareGetAccessPolicyOptions extends CommonOptions {
129
+ /**
130
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
131
+ * For example, use the @azure/abort-controller to create an `AbortSignal`.
132
+ */
133
+ abortSignal?: AbortSignalLike;
134
+ /**
135
+ * If specified, the operation only succeeds if the resource's lease is active and matches this ID.
136
+ */
137
+ leaseAccessConditions?: LeaseAccessConditions;
138
+ }
139
+ /**
140
+ * Options to configure the {@link ShareClient.exists} operation.
141
+ */
142
+ export interface ShareExistsOptions extends CommonOptions {
143
+ /**
144
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
145
+ * For example, use the @azure/abort-controller to create an `AbortSignal`.
146
+ */
147
+ abortSignal?: AbortSignalLike;
148
+ /**
149
+ * If specified, the operation only succeeds if the resource's lease is active and matches this ID.
150
+ */
151
+ leaseAccessConditions?: LeaseAccessConditions;
152
+ }
153
+ /**
154
+ * Options to configure the {@link ShareClient.getProperties} operation.
155
+ */
156
+ export interface ShareGetPropertiesOptions extends CommonOptions {
157
+ /**
158
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
159
+ * For example, use the @azure/abort-controller to create an `AbortSignal`.
160
+ */
161
+ abortSignal?: AbortSignalLike;
162
+ /**
163
+ * If specified, the operation only succeeds if the resource's lease is active and matches this ID.
164
+ */
165
+ leaseAccessConditions?: LeaseAccessConditions;
166
+ }
167
+ /**
168
+ * Options to configure the {@link ShareClient.setQuota} operation.
169
+ */
170
+ export interface ShareSetQuotaOptions extends CommonOptions {
171
+ /**
172
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
173
+ * For example, use the @azure/abort-controller to create an `AbortSignal`.
174
+ */
175
+ abortSignal?: AbortSignalLike;
176
+ /**
177
+ * If specified, the operation only succeeds if the resource's lease is active and matches this ID.
178
+ */
179
+ leaseAccessConditions?: LeaseAccessConditions;
180
+ }
181
+ /**
182
+ * Options to configure the {@link ShareClient.setProperties} operation.
183
+ */
184
+ export interface ShareSetPropertiesOptions extends CommonOptions {
185
+ /**
186
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
187
+ * For example, use the @azure/abort-controller to create an `AbortSignal`.
188
+ */
189
+ abortSignal?: AbortSignalLike;
190
+ /**
191
+ * Specifies the access tier of the share. Possible values include: 'TransactionOptimized',
192
+ * 'Hot', 'Cool'.
193
+ */
194
+ accessTier?: ShareAccessTier;
195
+ /**
196
+ * Specifies the maximum size of the share, in gigabytes.
197
+ */
198
+ quotaInGB?: number;
199
+ /**
200
+ * Root squash to set on the share. Only valid for NFS shares. Possible values include:
201
+ * 'NoRootSquash', 'RootSquash', 'AllSquash'.
202
+ */
203
+ rootSquash?: ShareRootSquash;
204
+ /**
205
+ * If specified, the operation only succeeds if the resource's lease is active and matches this ID.
206
+ */
207
+ leaseAccessConditions?: LeaseAccessConditions;
208
+ /**
209
+ * Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled.
210
+ * If not specified, the default is true.
211
+ */
212
+ enableSnapshotVirtualDirectoryAccess?: boolean;
213
+ /**
214
+ * Optional. Boolean. Default if not specified is false. This property enables paid bursting.
215
+ */
216
+ paidBurstingEnabled?: boolean;
217
+ /**
218
+ * Optional. Integer. Default if not specified is the maximum throughput the file share can support. Current maximum for a file share is 10,340 MiB/sec.
219
+ */
220
+ paidBurstingMaxBandwidthMibps?: number;
221
+ /**
222
+ * Optional. Integer. Default if not specified is the maximum IOPS the file share can support. Current maximum for a file share is 102,400 IOPS.
223
+ */
224
+ paidBurstingMaxIops?: number;
225
+ /**
226
+ * Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares.
227
+ * Specifies the provisioned number of input/output operations per second (IOPS) of the share. If this is not specified, the provisioned IOPS is set to value calculated based on recommendation formula.
228
+ */
229
+ shareProvisionedIops?: number;
230
+ /** Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned bandwidth of the share, in mebibytes per second (MiBps). If this is not specified, the provisioned bandwidth is set to value calculated based on recommendation formula. */
231
+ shareProvisionedBandwidthMibps?: number;
232
+ }
233
+ /**
234
+ * Options to configure the {@link ShareClient.getStatistics} operation.
235
+ */
236
+ export interface ShareGetStatisticsOptions extends CommonOptions {
237
+ /**
238
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
239
+ * For example, use the @azure/abort-controller to create an `AbortSignal`.
240
+ */
241
+ abortSignal?: AbortSignalLike;
242
+ /**
243
+ * If specified, the operation only succeeds if the resource's lease is active and matches this ID.
244
+ */
245
+ leaseAccessConditions?: LeaseAccessConditions;
246
+ }
247
+ /**
248
+ * Signed Identifier
249
+ */
250
+ export interface SignedIdentifier {
251
+ /**
252
+ * a unique id
253
+ */
254
+ id: string;
255
+ /**
256
+ * Access Policy
257
+ */
258
+ accessPolicy: {
259
+ /**
260
+ * the date-time the policy is active.
261
+ */
262
+ startsOn: Date;
263
+ /**
264
+ * the date-time the policy expires.
265
+ */
266
+ expiresOn: Date;
267
+ /**
268
+ * the permissions for the acl policy
269
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-share-acl
270
+ */
271
+ permissions: string;
272
+ };
273
+ }
274
+ export declare type ShareGetAccessPolicyResponse = WithResponse<{
275
+ signedIdentifiers: SignedIdentifier[];
276
+ } & ShareGetAccessPolicyHeaders, ShareGetAccessPolicyHeaders, SignedIdentifierModel[]>;
277
+ /**
278
+ * Options to configure the {@link ShareClient.createSnapshot} operation.
279
+ */
280
+ export interface ShareCreateSnapshotOptions extends CommonOptions {
281
+ /**
282
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
283
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
284
+ */
285
+ abortSignal?: AbortSignalLike;
286
+ /**
287
+ * A name-value pair to associate with a file storage object.
288
+ */
289
+ metadata?: {
290
+ [propertyName: string]: string;
291
+ };
292
+ }
293
+ /**
294
+ * Options to configure the {@link ShareClient.createPermission} operation.
295
+ */
296
+ export interface ShareCreatePermissionOptions extends CommonOptions {
297
+ /**
298
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
299
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
300
+ */
301
+ abortSignal?: AbortSignalLike;
302
+ }
303
+ /**
304
+ * Options to configure the {@link ShareClient.getPermission} operation.
305
+ */
306
+ export interface ShareGetPermissionOptions extends CommonOptions {
307
+ /**
308
+ * Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned.
309
+ * Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format.
310
+ * If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission
311
+ */
312
+ filePermissionFormat?: FilePermissionFormat;
313
+ /**
314
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
315
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
316
+ */
317
+ abortSignal?: AbortSignalLike;
318
+ }
319
+ /**
320
+ * Response data for the {@link ShareClient.getStatistics} Operation.
321
+ */
322
+ export type ShareGetStatisticsResponse = ShareGetStatisticsResponseModel & {
323
+ /**
324
+ * @deprecated shareUsage is going to be deprecated. Please use ShareUsageBytes instead.
325
+ *
326
+ * The approximate size of the data stored on the share, rounded up to the nearest gigabyte. Note
327
+ * that this value may not include all recently created or recently resized files.
328
+ */
329
+ shareUsage: number;
330
+ };
331
+ /**
332
+ * Contains response data for the {@link ShareClient.createIfNotExists} operation.
333
+ */
334
+ export interface ShareCreateIfNotExistsResponse extends ShareCreateResponse {
335
+ /**
336
+ * Indicate whether the share is successfully created. Is false when the share is not changed as it already exists.
337
+ */
338
+ succeeded: boolean;
339
+ }
340
+ /**
341
+ * Contains response data for the {@link ShareClient.deleteIfExists} operation.
342
+ */
343
+ export interface ShareDeleteIfExistsResponse extends ShareDeleteResponse {
344
+ /**
345
+ * Indicate whether the share is successfully deleted. Is false if the share does not exist in the first place.
346
+ */
347
+ succeeded: boolean;
348
+ }
349
+ /**
350
+ * Contains response data for the {@link ShareClient.getProperties} operation.
351
+ */
352
+ export type ShareGetPropertiesResponse = ShareGetPropertiesResponseModel & {
353
+ /**
354
+ * The protocols that have been enabled on the share.
355
+ */
356
+ protocols?: ShareProtocols;
357
+ };
358
+ /**
359
+ * Common options of the {@link ShareGenerateSasUrlOptions} and {@link FileGenerateSasUrlOptions}.
360
+ */
361
+ export interface CommonGenerateSasUrlOptions {
362
+ /**
363
+ * The version of the service this SAS will target. If not specified, it will default to the version targeted by the
364
+ * library.
365
+ */
366
+ version?: string;
367
+ /**
368
+ * Optional. SAS protocols, HTTPS only or HTTPSandHTTP
369
+ */
370
+ protocol?: SASProtocol;
371
+ /**
372
+ * Optional. When the SAS will take effect.
373
+ */
374
+ startsOn?: Date;
375
+ /**
376
+ * Optional only when identifier is provided. The time after which the SAS will no longer work.
377
+ */
378
+ expiresOn?: Date;
379
+ /**
380
+ * Optional. IP ranges allowed in this SAS.
381
+ */
382
+ ipRange?: SasIPRange;
383
+ /**
384
+ * Optional. The name of the access policy on the share this SAS references if any.
385
+ *
386
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
387
+ */
388
+ identifier?: string;
389
+ /**
390
+ * Optional. The cache-control header for the SAS.
391
+ */
392
+ cacheControl?: string;
393
+ /**
394
+ * Optional. The content-disposition header for the SAS.
395
+ */
396
+ contentDisposition?: string;
397
+ /**
398
+ * Optional. The content-encoding header for the SAS.
399
+ */
400
+ contentEncoding?: string;
401
+ /**
402
+ * Optional. The content-language header for the SAS.
403
+ */
404
+ contentLanguage?: string;
405
+ /**
406
+ * Optional. The content-type header for the SAS.
407
+ */
408
+ contentType?: string;
409
+ }
410
+ /**
411
+ * Options to configure {@link ShareClient.generateSasUrl} operation.
412
+ */
413
+ export interface ShareGenerateSasUrlOptions extends CommonGenerateSasUrlOptions {
414
+ /**
415
+ * Optional only when identifier is provided. Specifies the list of permissions to be associated with the SAS.
416
+ */
417
+ permissions?: ShareSASPermissions;
418
+ }
419
+ /**
420
+ * A ShareClient represents a URL to the Azure Storage share allowing you to manipulate its directories and files.
421
+ */
422
+ export declare class ShareClient extends StorageClient {
423
+ /**
424
+ * Share operation context provided by protocol layer.
425
+ */
426
+ private context;
427
+ private _name;
428
+ private shareClientConfig?;
429
+ /**
430
+ * The name of the share
431
+ */
432
+ get name(): string;
433
+ /**
434
+ * @param connectionString - Account connection string or a SAS connection string of an Azure storage account.
435
+ * [ Note - Account connection string can only be used in NODE.JS runtime. ]
436
+ * Account connection string example -
437
+ * `DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`
438
+ * SAS connection string example -
439
+ * `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString`
440
+ * @param name - Share name.
441
+ * @param options - Optional. Options to configure the HTTP pipeline.
442
+ */
443
+ constructor(connectionString: string, name: string, options?: ShareClientOptions);
444
+ /**
445
+ * Creates an instance of ShareClient.
446
+ *
447
+ * @param url - A URL string pointing to Azure Storage file share, such as
448
+ * "https://myaccount.file.core.windows.net/share". You can
449
+ * append a SAS if using AnonymousCredential, such as
450
+ * "https://myaccount.file.core.windows.net/share?sasString".
451
+ * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
452
+ * If not specified, AnonymousCredential is used.
453
+ * @param options - Optional. Options to configure the HTTP pipeline.
454
+ */
455
+ constructor(url: string, credential?: Credential | TokenCredential, options?: ShareClientOptions);
456
+ /**
457
+ * Creates an instance of ShareClient.
458
+ *
459
+ * @param url - A URL string pointing to Azure Storage file share, such as
460
+ * "https://myaccount.file.core.windows.net/share". You can
461
+ * append a SAS if using AnonymousCredential, such as
462
+ * "https://myaccount.file.core.windows.net/share?sasString".
463
+ * @param pipeline - Call newPipeline() to create a default
464
+ * pipeline, or provide a customized pipeline.
465
+ */
466
+ constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
467
+ /**
468
+ * Creates a new ShareClient object identical to the source but with the specified snapshot timestamp.
469
+ * Provide "" will remove the snapshot and return a URL to the base share.
470
+ *
471
+ * @param snapshot - The snapshot timestamp.
472
+ * @returns A new ShareClient object identical to the source but with the specified snapshot timestamp
473
+ */
474
+ withSnapshot(snapshot: string): ShareClient;
475
+ /**
476
+ * Creates a new share under the specified account. If the share with
477
+ * the same name already exists, the operation fails.
478
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-share
479
+ *
480
+ * @param options - Options to Share Create operation.
481
+ * @returns Response data for the Share Create operation.
482
+ */
483
+ create(options?: ShareCreateOptions): Promise<ShareCreateResponse>;
484
+ /**
485
+ * Creates a new share under the specified account. If the share with
486
+ * the same name already exists, it is not changed.
487
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-share
488
+ *
489
+ * @param options -
490
+ */
491
+ createIfNotExists(options?: ShareCreateOptions): Promise<ShareCreateIfNotExistsResponse>;
492
+ /**
493
+ * Creates a {@link ShareDirectoryClient} object.
494
+ *
495
+ * @param directoryName - A directory name
496
+ * @returns The ShareDirectoryClient object for the given directory name.
497
+ */
498
+ getDirectoryClient(directoryName: string): ShareDirectoryClient;
499
+ /**
500
+ * Gets the directory client for the root directory of this share.
501
+ * Note that the root directory always exists and cannot be deleted.
502
+ *
503
+ * @readonly A new ShareDirectoryClient object for the root directory.
504
+ */
505
+ get rootDirectoryClient(): ShareDirectoryClient;
506
+ /**
507
+ * Creates a new subdirectory under this share.
508
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
509
+ *
510
+ * @param directoryName -
511
+ * @param options - Options to Directory Create operation.
512
+ * @returns Directory creation response data and the corresponding directory client.
513
+ */
514
+ createDirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<{
515
+ directoryClient: ShareDirectoryClient;
516
+ directoryCreateResponse: DirectoryCreateResponse;
517
+ }>;
518
+ /**
519
+ * Removes the specified empty sub directory under this share.
520
+ * Note that the directory must be empty before it can be deleted.
521
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
522
+ *
523
+ * @param directoryName -
524
+ * @param options - Options to Directory Delete operation.
525
+ * @returns Directory deletion response data.
526
+ */
527
+ deleteDirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>;
528
+ /**
529
+ * Creates a new file or replaces a file under the root directory of this share.
530
+ * Note it only initializes the file with no content.
531
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-file
532
+ *
533
+ * @param fileName -
534
+ * @param size - Specifies the maximum size in bytes for the file, up to 4 TB.
535
+ * @param options - Options to File Create operation.
536
+ * @returns File creation response data and the corresponding file client.
537
+ */
538
+ createFile(fileName: string, size: number, options?: FileCreateOptions): Promise<{
539
+ fileClient: ShareFileClient;
540
+ fileCreateResponse: FileCreateResponse;
541
+ }>;
542
+ /**
543
+ * Removes a file under the root directory of this share from the storage account.
544
+ * When a file is successfully deleted, it is immediately removed from the storage
545
+ * account's index and is no longer accessible to clients. The file's data is later
546
+ * removed from the service during garbage collection.
547
+ *
548
+ * Delete File will fail with status code 409 (Conflict) and error code `SharingViolation`
549
+ * if the file is open on an SMB client.
550
+ *
551
+ * Delete File is not supported on a share snapshot, which is a read-only copy of
552
+ * a share. An attempt to perform this operation on a share snapshot will fail with 400
553
+ * (`InvalidQueryParameterValue`)
554
+ *
555
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2
556
+ *
557
+ * @param directoryName -
558
+ * @param fileName -
559
+ * @param options - Options to File Delete operation.
560
+ * @returns Promise<FileDeleteResponse> File Delete response data.
561
+ */
562
+ deleteFile(fileName: string, options?: FileDeleteOptions): Promise<FileDeleteResponse>;
563
+ /**
564
+ * Returns true if the Azrue share resource represented by this client exists; false otherwise.
565
+ *
566
+ * NOTE: use this function with care since an existing share might be deleted by other clients or
567
+ * applications. Vice versa new shares might be added by other clients or applications after this
568
+ * function completes.
569
+ *
570
+ * @param options - options to Exists operation.
571
+ */
572
+ exists(options?: ShareExistsOptions): Promise<boolean>;
573
+ /**
574
+ * Returns all user-defined metadata and system properties for the specified
575
+ * share.
576
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-share-properties
577
+ *
578
+ * WARNING: The `metadata` object returned in the response will have its keys in lowercase, even if
579
+ * they originally contained uppercase characters. This differs from the metadata keys returned by
580
+ * the `listShares` method of {@link ShareServiceClient} using the `includeMetadata` option, which
581
+ * will retain their original casing.
582
+ *
583
+ * @returns Response data for the Share Get Properties operation.
584
+ */
585
+ getProperties(options?: ShareGetPropertiesOptions): Promise<ShareGetPropertiesResponse>;
586
+ /**
587
+ * Marks the specified share for deletion. The share and any directories or files
588
+ * contained within it are later deleted during garbage collection.
589
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-share
590
+ *
591
+ * @param options - Options to Share Delete operation.
592
+ * @returns Response data for the Share Delete operation.
593
+ */
594
+ delete(options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>;
595
+ /**
596
+ * Marks the specified share for deletion if it exists. The share and any directories or files
597
+ * contained within it are later deleted during garbage collection.
598
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-share
599
+ *
600
+ * @param options -
601
+ */
602
+ deleteIfExists(options?: ShareDeleteMethodOptions): Promise<ShareDeleteIfExistsResponse>;
603
+ /**
604
+ * Sets one or more user-defined name-value pairs for the specified share.
605
+ *
606
+ * If no option provided, or no metadata defined in the option parameter, the share
607
+ * metadata will be removed.
608
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-share-metadata
609
+ *
610
+ * @param metadata - If no metadata provided, all existing directory metadata will be removed.
611
+ * @param option - Options to Share Set Metadata operation.
612
+ * @returns Response data for the Share Set Metadata operation.
613
+ */
614
+ setMetadata(metadata?: Metadata, options?: ShareSetMetadataOptions): Promise<ShareSetMetadataResponse>;
615
+ /**
616
+ * Gets the permissions for the specified share. The permissions indicate
617
+ * whether share data may be accessed publicly.
618
+ *
619
+ * WARNING: JavaScript Date will potential lost precision when parsing start and expiry string.
620
+ * For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
621
+ *
622
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-share-acl
623
+ *
624
+ * @param option - Options to Share Get Access Policy operation.
625
+ * @returns Response data for the Share Get Access Policy operation.
626
+ */
627
+ getAccessPolicy(options?: ShareGetAccessPolicyOptions): Promise<ShareGetAccessPolicyResponse>;
628
+ /**
629
+ * Sets the permissions for the specified share. The permissions indicate
630
+ * whether directories or files in a share may be accessed publicly.
631
+ *
632
+ * When you set permissions for a share, the existing permissions are replaced.
633
+ * If no shareAcl provided, the existing share ACL will be
634
+ * removed.
635
+ *
636
+ * When you establish a stored access policy on a share, it may take up to 30 seconds to take effect.
637
+ * During this interval, a shared access signature that is associated with the stored access policy will
638
+ * fail with status code 403 (Forbidden), until the access policy becomes active.
639
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-share-acl
640
+ *
641
+ * @param shareAcl - Array of signed identifiers, each having a unique Id and details of access policy.
642
+ * @param option - Options to Share Set Access Policy operation.
643
+ * @returns Response data for the Share Set Access Policy operation.
644
+ */
645
+ setAccessPolicy(shareAcl?: SignedIdentifier[], options?: ShareSetAccessPolicyOptions): Promise<ShareSetAccessPolicyResponse>;
646
+ /**
647
+ * Creates a read-only snapshot of a share.
648
+ *
649
+ * @param options - Options to Share Create Snapshot operation.
650
+ * @returns Response data for the Share Create Snapshot operation.
651
+ */
652
+ createSnapshot(options?: ShareCreateSnapshotOptions): Promise<ShareCreateSnapshotResponse>;
653
+ /**
654
+ * Sets quota for the specified share.
655
+ *
656
+ * @deprecated Use {@link ShareClient.setProperties} instead.
657
+ *
658
+ * @param quotaInGB - Specifies the maximum size of the share in gigabytes
659
+ * @param option - Options to Share Set Quota operation.
660
+ * @returns Response data for the Share Get Quota operation.
661
+ */
662
+ setQuota(quotaInGB: number, options?: ShareSetQuotaOptions): Promise<ShareSetQuotaResponse>;
663
+ /**
664
+ * Sets properties of the share.
665
+ *
666
+ * @param option - Options to Share Set Properties operation.
667
+ * @returns Response data for the Share Set Properties operation.
668
+ */
669
+ setProperties(options?: ShareSetPropertiesOptions): Promise<ShareSetPropertiesResponse>;
670
+ /**
671
+ * Retrieves statistics related to the share.
672
+ *
673
+ * @param option - Options to Share Get Statistics operation.
674
+ * @returns Response data for the Share Get Statistics operation.
675
+ */
676
+ getStatistics(options?: ShareGetStatisticsOptions): Promise<ShareGetStatisticsResponse>;
677
+ /**
678
+ * Creates a file permission (a security descriptor) at the share level.
679
+ * The created security descriptor can be used for the files/directories in the share.
680
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-permission
681
+ *
682
+ * @param options - Options to Share Create Permission operation.
683
+ * @param filePermission - File permission described in the SDDL
684
+ */
685
+ createPermission(filePermission: string | SharePermission, options?: ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>;
686
+ /**
687
+ * Gets the Security Descriptor Definition Language (SDDL) for a given file permission key
688
+ * which indicates a security descriptor.
689
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-permission
690
+ *
691
+ * @param options - Options to Share Create Permission operation.
692
+ * @param filePermissionKey - File permission key which indicates the security descriptor of the permission.
693
+ */
694
+ getPermission(filePermissionKey: string, options?: ShareGetPermissionOptions): Promise<ShareGetPermissionResponse>;
695
+ /**
696
+ * Get a {@link ShareLeaseClient} that manages leases on the file.
697
+ *
698
+ * @param proposeLeaseId - Initial proposed lease Id.
699
+ * @returns A new ShareLeaseClient object for managing leases on the file.
700
+ */
701
+ getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient;
702
+ /**
703
+ * Only available for ShareClient constructed with a shared key credential.
704
+ *
705
+ * Generates a Service Shared Access Signature (SAS) URI based on the client properties
706
+ * and parameters passed in. The SAS is signed by the shared key credential of the client.
707
+ *
708
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
709
+ *
710
+ * @param options - Optional parameters.
711
+ * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
712
+ */
713
+ generateSasUrl(options: ShareGenerateSasUrlOptions): string;
714
+ /**
715
+ * Only available for ShareClient constructed with a shared key credential.
716
+ *
717
+ * Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
718
+ * and parameters passed in. The SAS is signed by the shared key credential of the client.
719
+ *
720
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
721
+ *
722
+ * @param options - Optional parameters.
723
+ * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
724
+ */
725
+ generateSasStringToSign(options: ShareGenerateSasUrlOptions): string;
726
+ }
727
+ /**
728
+ * Options to configure {@link ShareDirectoryClient.create} operation.
729
+ */
730
+ export interface DirectoryCreateOptions extends FileAndDirectoryCreateCommonOptions, CommonOptions {
731
+ /**
732
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
733
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
734
+ */
735
+ abortSignal?: AbortSignalLike;
736
+ /**
737
+ * A collection of key-value string pair to associate with the file storage object.
738
+ */
739
+ metadata?: Metadata;
740
+ }
741
+ export interface DirectoryProperties extends FileAndDirectorySetPropertiesCommonOptions, CommonOptions {
742
+ /**
743
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
744
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
745
+ */
746
+ abortSignal?: AbortSignalLike;
747
+ }
748
+ /**
749
+ * Options to configure {@link ShareDirectoryClient.listFilesAndDirectories} operation.
750
+ */
751
+ export interface DirectoryListFilesAndDirectoriesOptions extends CommonOptions {
752
+ /**
753
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
754
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
755
+ */
756
+ abortSignal?: AbortSignalLike;
757
+ /**
758
+ * Filters the results to return only entries whose
759
+ * name begins with the specified prefix.
760
+ */
761
+ prefix?: string;
762
+ includeTimestamps?: boolean;
763
+ includeEtag?: boolean;
764
+ includeAttributes?: boolean;
765
+ includePermissionKey?: boolean;
766
+ /**
767
+ * Optional. Specified that extended info should be included in the returned {@link FileItem} or {@link DirectoryItem}.
768
+ * If true, the Content-Length property will be up-to-date, FileId will be returned in response.
769
+ */
770
+ includeExtendedInfo?: boolean;
771
+ }
772
+ /**
773
+ * Options to configure the {@link ShareDirectoryClient.delete} operation.
774
+ */
775
+ export interface DirectoryDeleteOptions extends CommonOptions {
776
+ /**
777
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
778
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
779
+ */
780
+ abortSignal?: AbortSignalLike;
781
+ }
782
+ /**
783
+ * Options to configure the {@link ShareDirectoryClient.exists} operation.
784
+ */
785
+ export interface DirectoryExistsOptions extends CommonOptions {
786
+ /**
787
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
788
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
789
+ */
790
+ abortSignal?: AbortSignalLike;
791
+ }
792
+ /**
793
+ * Options to configure the {@link ShareDirectoryClient.getProperties} operation.
794
+ */
795
+ export interface DirectoryGetPropertiesOptions extends CommonOptions {
796
+ /**
797
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
798
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
799
+ */
800
+ abortSignal?: AbortSignalLike;
801
+ }
802
+ /**
803
+ * Options to configure the {@link ShareDirectoryClient.setMetadata} operation.
804
+ */
805
+ export interface DirectorySetMetadataOptions extends CommonOptions {
806
+ /**
807
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
808
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
809
+ */
810
+ abortSignal?: AbortSignalLike;
811
+ }
812
+ /**
813
+ * Options to configure Directory - List Handles Segment operations.
814
+ *
815
+ * See:
816
+ * - {@link ShareDirectoryClient.listHandlesSegment}
817
+ * - {@link ShareDirectoryClient.iterateHandleSegments}
818
+ * - {@link ShareDirectoryClient.listHandleItems}
819
+ *
820
+ */
821
+ export interface DirectoryListHandlesSegmentOptions extends CommonOptions {
822
+ /**
823
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
824
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
825
+ */
826
+ abortSignal?: AbortSignalLike;
827
+ /**
828
+ * Specifies the maximum number of entries to return. If the request does not specify maxResults,
829
+ * or specifies a value greater than 5,000, the server will return up to 5,000 items.
830
+ */
831
+ maxResults?: number;
832
+ /**
833
+ * Specifies operation should apply to the directory specified in the URI, its files, its
834
+ * subdirectories and their files.
835
+ */
836
+ recursive?: boolean;
837
+ }
838
+ /**
839
+ * Options to configure the {@link ShareDirectoryClient.listHandles} operation.
840
+ */
841
+ export interface DirectoryListHandlesOptions extends CommonOptions {
842
+ /**
843
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
844
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
845
+ */
846
+ abortSignal?: AbortSignalLike;
847
+ /**
848
+ * Specifies whether operation should apply to the directory specified in the URI, its files, its
849
+ * subdirectories and their files.
850
+ */
851
+ recursive?: boolean;
852
+ }
853
+ /**
854
+ * Options to configure Directory - Force Close Handles Segment operations.
855
+ *
856
+ * See:
857
+ * - {@link ShareDirectoryClient.forceCloseHandlesSegment}
858
+ * - {@link ShareDirectoryClient.forceCloseAllHandles}
859
+ */
860
+ export interface DirectoryForceCloseHandlesSegmentOptions extends CommonOptions {
861
+ /**
862
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
863
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
864
+ */
865
+ abortSignal?: AbortSignalLike;
866
+ /**
867
+ * Specifies operation should apply to the directory specified in the URI, its files, its
868
+ * subdirectories and their files.
869
+ */
870
+ recursive?: boolean;
871
+ }
872
+ /**
873
+ * Additional response header values for close handles request.
874
+ */
875
+ export interface DirectoryCloseHandlesHeaders {
876
+ /**
877
+ * This header uniquely identifies the request that was made and can be used for troubleshooting
878
+ * the request.
879
+ */
880
+ requestId?: string;
881
+ /**
882
+ * Indicates the version of the File service used to execute the request.
883
+ */
884
+ version?: string;
885
+ /**
886
+ * A UTC date/time value generated by the service that indicates the time at which the response
887
+ * was initiated.
888
+ */
889
+ date?: Date;
890
+ /**
891
+ * A string describing next handle to be closed. It is returned when more handles need to be
892
+ * closed to complete the request.
893
+ */
894
+ marker?: string;
895
+ }
896
+ /**
897
+ * Response type for {@link ShareDirectoryClient.forceCloseHandle}.
898
+ */
899
+ export type DirectoryForceCloseHandlesResponse = WithResponse<CloseHandlesInfo & DirectoryCloseHandlesHeaders, DirectoryForceCloseHandlesHeaders>;
900
+ /**
901
+ * Options to configure {@link ShareDirectoryClient.forceCloseHandle}.
902
+ */
903
+ export interface DirectoryForceCloseHandlesOptions extends CommonOptions {
904
+ /**
905
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
906
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
907
+ */
908
+ abortSignal?: AbortSignalLike;
909
+ }
910
+ /**
911
+ * Contains response data for the {@link DirectoryClient.createIfNotExists} operation.
912
+ */
913
+ export interface DirectoryCreateIfNotExistsResponse extends DirectoryCreateResponse {
914
+ /**
915
+ * Indicate whether the directory is successfully created. Is false when the directory is not changed as it already exists.
916
+ */
917
+ succeeded: boolean;
918
+ }
919
+ /**
920
+ * Contains response data for the {@link DirectoryClient.deleteIfExists} operation.
921
+ */
922
+ export interface DirectoryDeleteIfExistsResponse extends DirectoryDeleteResponse {
923
+ /**
924
+ * Indicate whether the directory is successfully deleted. Is false if the directory does not exist in the first place.
925
+ */
926
+ succeeded: boolean;
927
+ }
928
+ /**
929
+ * A ShareDirectoryClient represents a URL to the Azure Storage directory allowing you to manipulate its files and directories.
930
+ */
931
+ export declare class ShareDirectoryClient extends StorageClient {
932
+ /**
933
+ * context provided by protocol layer.
934
+ */
935
+ private context;
936
+ private _shareName;
937
+ private _path;
938
+ private _name;
939
+ private shareClientConfig?;
940
+ /**
941
+ * The share name corresponding to this directory client
942
+ */
943
+ get shareName(): string;
944
+ /**
945
+ * The full path of the directory
946
+ */
947
+ get path(): string;
948
+ /**
949
+ * The name of the directory
950
+ */
951
+ get name(): string;
952
+ /**
953
+ * Creates an instance of DirectoryClient.
954
+ *
955
+ * @param url - A URL string pointing to Azure Storage file directory, such as
956
+ * "https://myaccount.file.core.windows.net/myshare/mydirectory". You can
957
+ * append a SAS if using AnonymousCredential, such as
958
+ * "https://myaccount.file.core.windows.net/myshare/mydirectory?sasString".
959
+ * This method accepts an encoded URL or non-encoded URL pointing to a directory.
960
+ * Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
961
+ * However, if a directory name includes %, directory name must be encoded in the URL.
962
+ * Such as a directory named "mydir%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydir%25".
963
+ * @param credential - Such as AnonymousCredential or StorageSharedKeyCredential.
964
+ * If not specified, AnonymousCredential is used.
965
+ * @param options - Optional. Options to configure the HTTP pipeline.
966
+ */
967
+ constructor(url: string, credential?: Credential | TokenCredential, options?: ShareClientOptions);
968
+ /**
969
+ * Creates an instance of DirectoryClient.
970
+ *
971
+ * @param url - A URL string pointing to Azure Storage file directory, such as
972
+ * "https://myaccount.file.core.windows.net/myshare/mydirectory". You can
973
+ * append a SAS if using AnonymousCredential, such as
974
+ * "https://myaccount.file.core.windows.net/myshare/mydirectory?sasString".
975
+ * This method accepts an encoded URL or non-encoded URL pointing to a directory.
976
+ * Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
977
+ * However, if a directory name includes %, directory name must be encoded in the URL.
978
+ * Such as a directory named "mydir%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydir%25".
979
+ * @param pipeline - Call newPipeline() to create a default
980
+ * pipeline, or provide a customized pipeline.
981
+ */
982
+ constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
983
+ /**
984
+ * Creates a new directory under the specified share or parent directory.
985
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
986
+ *
987
+ * @param options - Options to Directory Create operation.
988
+ * @returns Response data for the Directory operation.
989
+ */
990
+ create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>;
991
+ /**
992
+ * Creates a new directory under the specified share or parent directory if it does not already exists.
993
+ * If the directory already exists, it is not modified.
994
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
995
+ *
996
+ * @param options -
997
+ */
998
+ createIfNotExists(options?: DirectoryCreateOptions): Promise<DirectoryCreateIfNotExistsResponse>;
999
+ /**
1000
+ * Sets properties on the directory.
1001
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-directory-properties
1002
+ *
1003
+ * @param DirectoryProperties - Directory properties. If no values are provided,
1004
+ * existing values will be preserved.
1005
+ */
1006
+ setProperties(properties?: DirectoryProperties): Promise<DirectorySetPropertiesResponse>;
1007
+ /**
1008
+ * Creates a ShareDirectoryClient object for a sub directory.
1009
+ *
1010
+ * @param subDirectoryName - A subdirectory name
1011
+ * @returns The ShareDirectoryClient object for the given subdirectory name.
1012
+ *
1013
+ * Example usage:
1014
+ *
1015
+ * ```ts snippet:ReadmeSampleGetDirectoryClient
1016
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
1017
+ *
1018
+ * const account = "<account>";
1019
+ * const accountKey = "<accountkey>";
1020
+ *
1021
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
1022
+ * const serviceClient = new ShareServiceClient(
1023
+ * `https://${account}.file.core.windows.net`,
1024
+ * credential,
1025
+ * );
1026
+ *
1027
+ * const shareName = "<share name>";
1028
+ * const directoryName = "<directory name>";
1029
+ * const shareClient = serviceClient.getShareClient(shareName);
1030
+ * const directoryClient = shareClient.getDirectoryClient(directoryName);
1031
+ * await directoryClient.create();
1032
+ * ```
1033
+ */
1034
+ getDirectoryClient(subDirectoryName: string): ShareDirectoryClient;
1035
+ /**
1036
+ * Creates a new subdirectory under this directory.
1037
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
1038
+ *
1039
+ * @param directoryName -
1040
+ * @param options - Options to Directory Create operation.
1041
+ * @returns Directory create response data and the corresponding DirectoryClient instance.
1042
+ */
1043
+ createSubdirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<{
1044
+ directoryClient: ShareDirectoryClient;
1045
+ directoryCreateResponse: DirectoryCreateResponse;
1046
+ }>;
1047
+ /**
1048
+ * Removes the specified empty sub directory under this directory.
1049
+ * Note that the directory must be empty before it can be deleted.
1050
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
1051
+ *
1052
+ * @param directoryName -
1053
+ * @param options - Options to Directory Delete operation.
1054
+ * @returns Directory deletion response data.
1055
+ */
1056
+ deleteSubdirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>;
1057
+ /**
1058
+ * Creates a new file or replaces a file under this directory. Note it only initializes the file with no content.
1059
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-file
1060
+ *
1061
+ * @param fileName -
1062
+ * @param size - Specifies the maximum size in bytes for the file, up to 4 TB.
1063
+ * @param options - Options to File Create operation.
1064
+ * @returns File creation response data and the corresponding file client.
1065
+ */
1066
+ createFile(fileName: string, size: number, options?: FileCreateOptions): Promise<{
1067
+ fileClient: ShareFileClient;
1068
+ fileCreateResponse: FileCreateResponse;
1069
+ }>;
1070
+ /**
1071
+ * Removes the specified file under this directory from the storage account.
1072
+ * When a file is successfully deleted, it is immediately removed from the storage
1073
+ * account's index and is no longer accessible to clients. The file's data is later
1074
+ * removed from the service during garbage collection.
1075
+ *
1076
+ * Delete File will fail with status code 409 (Conflict) and error code SharingViolation
1077
+ * if the file is open on an SMB client.
1078
+ *
1079
+ * Delete File is not supported on a share snapshot, which is a read-only copy of
1080
+ * a share. An attempt to perform this operation on a share snapshot will fail with 400 (InvalidQueryParameterValue)
1081
+ *
1082
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2
1083
+ *
1084
+ * @param fileName - Name of the file to delete
1085
+ * @param options - Options to File Delete operation.
1086
+ * @returns File deletion response data.
1087
+ */
1088
+ deleteFile(fileName: string, options?: FileDeleteOptions): Promise<FileDeleteResponse>;
1089
+ /**
1090
+ * Creates a {@link ShareFileClient} object.
1091
+ *
1092
+ * @param fileName - A file name.
1093
+ * @returns A new ShareFileClient object for the given file name.
1094
+ *
1095
+ * Example usage:
1096
+ *
1097
+ * ```ts snippet:ReadmeSampleCreateFileAndUpload
1098
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
1099
+ *
1100
+ * const account = "<account>";
1101
+ * const accountKey = "<accountkey>";
1102
+ *
1103
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
1104
+ * const serviceClient = new ShareServiceClient(
1105
+ * `https://${account}.file.core.windows.net`,
1106
+ * credential,
1107
+ * );
1108
+ *
1109
+ * const shareName = "<share name>";
1110
+ * const directoryName = "<directory name>";
1111
+ * const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
1112
+ *
1113
+ * const content = "Hello World!";
1114
+ * const fileName = `newdirectory${+new Date()}`;
1115
+ * const fileClient = directoryClient.getFileClient(fileName);
1116
+ * await fileClient.create(content.length);
1117
+ * console.log(`Create file ${fileName} successfully`);
1118
+ *
1119
+ * // Upload file range
1120
+ * await fileClient.uploadRange(content, 0, content.length);
1121
+ * console.log(`Upload file range "${content}" to ${fileName} successfully`);
1122
+ * ```
1123
+ */
1124
+ getFileClient(fileName: string): ShareFileClient;
1125
+ /**
1126
+ * Returns true if the specified directory exists; false otherwise.
1127
+ *
1128
+ * NOTE: use this function with care since an existing directory might be deleted by other clients or
1129
+ * applications. Vice versa new directories might be added by other clients or applications after this
1130
+ * function completes.
1131
+ *
1132
+ * @param options - options to Exists operation.
1133
+ */
1134
+ exists(options?: DirectoryExistsOptions): Promise<boolean>;
1135
+ /**
1136
+ * Returns all system properties for the specified directory, and can also be used to check the
1137
+ * existence of a directory. The data returned does not include the files in the directory or any
1138
+ * subdirectories.
1139
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-directory-properties
1140
+ *
1141
+ * @param options - Options to Directory Get Properties operation.
1142
+ * @returns Response data for the Directory Get Properties operation.
1143
+ */
1144
+ getProperties(options?: DirectoryGetPropertiesOptions): Promise<DirectoryGetPropertiesResponse>;
1145
+ /**
1146
+ * Removes the specified empty directory. Note that the directory must be empty before it can be
1147
+ * deleted.
1148
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
1149
+ *
1150
+ * @param options - Options to Directory Delete operation.
1151
+ * @returns Response data for the Directory Delete operation.
1152
+ */
1153
+ delete(options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>;
1154
+ /**
1155
+ * Removes the specified empty directory if it exists. Note that the directory must be empty before it can be
1156
+ * deleted.
1157
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
1158
+ *
1159
+ * @param options -
1160
+ */
1161
+ deleteIfExists(options?: DirectoryDeleteOptions): Promise<DirectoryDeleteIfExistsResponse>;
1162
+ /**
1163
+ * Updates user defined metadata for the specified directory.
1164
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-directory-metadata
1165
+ *
1166
+ * @param metadata - If no metadata provided, all existing directory metadata will be removed
1167
+ * @param options - Options to Directory Set Metadata operation.
1168
+ * @returns Response data for the Directory Set Metadata operation.
1169
+ */
1170
+ setMetadata(metadata?: Metadata, options?: DirectorySetMetadataOptions): Promise<DirectorySetMetadataResponse>;
1171
+ /**
1172
+ * Returns an AsyncIterableIterator for {@link DirectoryListFilesAndDirectoriesSegmentResponse} objects
1173
+ *
1174
+ * @param marker - A string value that identifies the portion of
1175
+ * the list of files and directories to be returned with the next listing operation. The
1176
+ * operation returns the ContinuationToken value within the response body if the
1177
+ * listing operation did not return all files and directories remaining to be listed
1178
+ * with the current page. The ContinuationToken value can be used as the value for
1179
+ * the marker parameter in a subsequent call to request the next page of list
1180
+ * items. The marker value is opaque to the client.
1181
+ * @param options - Options to list files and directories operation.
1182
+ */
1183
+ private iterateFilesAndDirectoriesSegments;
1184
+ /**
1185
+ * Returns an AsyncIterableIterator for file and directory items
1186
+ *
1187
+ * @param options - Options to list files and directories operation.
1188
+ */
1189
+ private listFilesAndDirectoriesItems;
1190
+ /**
1191
+ * Returns an async iterable iterator to list all the files and directories
1192
+ * under the specified account.
1193
+ *
1194
+ * .byPage() returns an async iterable iterator to list the files and directories in pages.
1195
+ *
1196
+ * Example using `for await` syntax:
1197
+ *
1198
+ * ```ts snippet:ReadmeSampleListFilesAndDirectories
1199
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
1200
+ *
1201
+ * const account = "<account>";
1202
+ * const accountKey = "<accountkey>";
1203
+ *
1204
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
1205
+ * const serviceClient = new ShareServiceClient(
1206
+ * `https://${account}.file.core.windows.net`,
1207
+ * credential,
1208
+ * );
1209
+ *
1210
+ * const shareName = "<share name>";
1211
+ * const directoryName = "<directory name>";
1212
+ * const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
1213
+ *
1214
+ * let i = 1;
1215
+ * for await (const item of directoryClient.listFilesAndDirectories()) {
1216
+ * if (item.kind === "directory") {
1217
+ * console.log(`${i} - directory\t: ${item.name}`);
1218
+ * } else {
1219
+ * console.log(`${i} - file\t: ${item.name}`);
1220
+ * }
1221
+ * i++;
1222
+ * }
1223
+ * ```
1224
+ *
1225
+ * Example using `iter.next()`:
1226
+ *
1227
+ * ```ts snippet:ReadmeSampleListFilesAndDirectories_Iterator
1228
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
1229
+ *
1230
+ * const account = "<account>";
1231
+ * const accountKey = "<accountkey>";
1232
+ *
1233
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
1234
+ * const serviceClient = new ShareServiceClient(
1235
+ * `https://${account}.file.core.windows.net`,
1236
+ * credential,
1237
+ * );
1238
+ *
1239
+ * const shareName = "<share name>";
1240
+ * const directoryName = "<directory name>";
1241
+ * const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
1242
+ *
1243
+ * let i = 1;
1244
+ * const iter = directoryClient.listFilesAndDirectories();
1245
+ * let { value, done } = await iter.next();
1246
+ * while (!done) {
1247
+ * if (value.kind === "directory") {
1248
+ * console.log(`${i} - directory\t: ${value.name}`);
1249
+ * } else {
1250
+ * console.log(`${i} - file\t: ${value.name}`);
1251
+ * }
1252
+ * ({ value, done } = await iter.next());
1253
+ * i++;
1254
+ * }
1255
+ * ```
1256
+ *
1257
+ * Example using `byPage()`:
1258
+ *
1259
+ * ```ts snippet:ReadmeSampleListFilesAndDirectories_ByPage
1260
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
1261
+ *
1262
+ * const account = "<account>";
1263
+ * const accountKey = "<accountkey>";
1264
+ *
1265
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
1266
+ * const serviceClient = new ShareServiceClient(
1267
+ * `https://${account}.file.core.windows.net`,
1268
+ * credential,
1269
+ * );
1270
+ *
1271
+ * const shareName = "<share name>";
1272
+ * const directoryName = "<directory name>";
1273
+ * const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
1274
+ *
1275
+ * let i = 1;
1276
+ * for await (const response of directoryClient
1277
+ * .listFilesAndDirectories()
1278
+ * .byPage({ maxPageSize: 20 })) {
1279
+ * console.log(`Page ${i++}:`);
1280
+ * for (const item of response.segment.directoryItems) {
1281
+ * console.log(`\tdirectory: ${item.name}`);
1282
+ * }
1283
+ * for (const item of response.segment.fileItems) {
1284
+ * console.log(`\tfile: ${item.name}`);
1285
+ * }
1286
+ * }
1287
+ * ```
1288
+ *
1289
+ * Example using paging with a marker:
1290
+ *
1291
+ * ```ts snippet:ReadmeSampleListFilesAndDirectories_Continuation
1292
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
1293
+ *
1294
+ * const account = "<account>";
1295
+ * const accountKey = "<accountkey>";
1296
+ *
1297
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
1298
+ * const serviceClient = new ShareServiceClient(
1299
+ * `https://${account}.file.core.windows.net`,
1300
+ * credential,
1301
+ * );
1302
+ *
1303
+ * const shareName = "<share name>";
1304
+ * const directoryName = "<directory name>";
1305
+ * const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
1306
+ *
1307
+ * let iterator = directoryClient.listFilesAndDirectories().byPage({ maxPageSize: 2 });
1308
+ * let response = (await iterator.next()).value;
1309
+ *
1310
+ * for await (const item of response.segment.directoryItems) {
1311
+ * console.log(`\tdirectory: ${item.name}`);
1312
+ * }
1313
+ *
1314
+ * for await (const item of response.segment.fileItems) {
1315
+ * console.log(`\tfile: ${item.name}`);
1316
+ * }
1317
+ *
1318
+ * // Gets next marker
1319
+ * let marker = response.continuationToken;
1320
+ *
1321
+ * // Passing next marker as continuationToken
1322
+ * iterator = directoryClient
1323
+ * .listFilesAndDirectories()
1324
+ * .byPage({ continuationToken: marker, maxPageSize: 10 });
1325
+ * response = (await iterator.next()).value;
1326
+ *
1327
+ * for await (const item of response.segment.directoryItems) {
1328
+ * console.log(`\tdirectory: ${item.name}`);
1329
+ * }
1330
+ *
1331
+ * for await (const item of response.segment.fileItems) {
1332
+ * console.log(`\tfile: ${item.name}`);
1333
+ * }
1334
+ * ```
1335
+ *
1336
+ * @param options - Options to list files and directories operation.
1337
+ * @returns An asyncIterableIterator that supports paging.
1338
+ */
1339
+ listFilesAndDirectories(options?: DirectoryListFilesAndDirectoriesOptions): PagedAsyncIterableIterator<({
1340
+ kind: "file";
1341
+ } & FileItem) | ({
1342
+ kind: "directory";
1343
+ } & DirectoryItem), DirectoryListFilesAndDirectoriesSegmentResponse>;
1344
+ /**
1345
+ * Returns a list of files or directories under the specified share or directory. It lists the
1346
+ * contents only for a single level of the directory hierarchy.
1347
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-directories-and-files
1348
+ *
1349
+ * @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
1350
+ * @param options - Options to Directory List Files and Directories Segment operation.
1351
+ * @returns Response data for the Directory List Files and Directories operation.
1352
+ */
1353
+ private listFilesAndDirectoriesSegment;
1354
+ /**
1355
+ * Returns an AsyncIterableIterator for {@link DirectoryListHandlesResponse}
1356
+ *
1357
+ * @param marker - A string value that identifies the portion of the list to be
1358
+ * returned with the next list handles operation. The operation returns a
1359
+ * marker value within the response body if the list returned was not complete.
1360
+ * The marker value may then be used in a subsequent call to request the next
1361
+ * set of list items.
1362
+ * @param options - Options to list handles operation.
1363
+ */
1364
+ private iterateHandleSegments;
1365
+ /**
1366
+ * Returns an AsyncIterableIterator for handles
1367
+ *
1368
+ * @param options - Options to list handles operation.
1369
+ */
1370
+ private listHandleItems;
1371
+ /**
1372
+ * Returns an async iterable iterator to list all the handles.
1373
+ * under the specified account.
1374
+ *
1375
+ * .byPage() returns an async iterable iterator to list the handles in pages.
1376
+ *
1377
+ * Example using `for await` syntax:
1378
+ *
1379
+ * ```ts snippet:ReadmeSampleListHandles
1380
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
1381
+ *
1382
+ * const account = "<account>";
1383
+ * const accountKey = "<accountkey>";
1384
+ *
1385
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
1386
+ * const serviceClient = new ShareServiceClient(
1387
+ * `https://${account}.file.core.windows.net`,
1388
+ * credential,
1389
+ * );
1390
+ *
1391
+ * const shareName = "<share name>";
1392
+ * const directoryName = "<directory name>";
1393
+ * const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
1394
+ *
1395
+ * for await (const handle of directoryClient.listHandles()) {
1396
+ * console.log(`Handle: ${handle.handleId}`);
1397
+ * }
1398
+ * ```
1399
+ *
1400
+ * Example using `iter.next()`:
1401
+ *
1402
+ * ```ts snippet:ReadmeSampleListHandles_Iterator
1403
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
1404
+ *
1405
+ * const account = "<account>";
1406
+ * const accountKey = "<accountkey>";
1407
+ *
1408
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
1409
+ * const serviceClient = new ShareServiceClient(
1410
+ * `https://${account}.file.core.windows.net`,
1411
+ * credential,
1412
+ * );
1413
+ *
1414
+ * const shareName = "<share name>";
1415
+ * const directoryName = "<directory name>";
1416
+ * const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
1417
+ *
1418
+ * const handleIter = directoryClient.listHandles();
1419
+ * let { value, done } = await handleIter.next();
1420
+ * while (!done) {
1421
+ * console.log(`Handle: ${value.handleId}`);
1422
+ * ({ value, done } = await handleIter.next());
1423
+ * }
1424
+ * ```
1425
+ *
1426
+ * Example using `byPage()`:
1427
+ *
1428
+ * ```ts snippet:ReadmeSampleListHandles_ByPage
1429
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
1430
+ *
1431
+ * const account = "<account>";
1432
+ * const accountKey = "<accountkey>";
1433
+ *
1434
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
1435
+ * const serviceClient = new ShareServiceClient(
1436
+ * `https://${account}.file.core.windows.net`,
1437
+ * credential,
1438
+ * );
1439
+ *
1440
+ * const shareName = "<share name>";
1441
+ * const directoryName = "<directory name>";
1442
+ * const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
1443
+ *
1444
+ * let i = 1;
1445
+ * for await (const response of directoryClient.listHandles().byPage({ maxPageSize: 20 })) {
1446
+ * console.log(`Page ${i++}:`);
1447
+ * for (const handle of response.handleList || []) {
1448
+ * console.log(`\thandle: ${handle.handleId}`);
1449
+ * }
1450
+ * }
1451
+ * ```
1452
+ *
1453
+ * Example using paging with a marker:
1454
+ *
1455
+ * ```ts snippet:ReadmeSampleListHandles_Continuation
1456
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
1457
+ *
1458
+ * const account = "<account>";
1459
+ * const accountKey = "<accountkey>";
1460
+ *
1461
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
1462
+ * const serviceClient = new ShareServiceClient(
1463
+ * `https://${account}.file.core.windows.net`,
1464
+ * credential,
1465
+ * );
1466
+ *
1467
+ * const shareName = "<share name>";
1468
+ * const directoryName = "<directory name>";
1469
+ * const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
1470
+ *
1471
+ * let iterator = directoryClient.listHandles().byPage({ maxPageSize: 2 });
1472
+ * let response = (await iterator.next()).value;
1473
+ *
1474
+ * for await (const handle of response.handleList || []) {
1475
+ * console.log(`\thandle: ${handle.handleId}`);
1476
+ * }
1477
+ *
1478
+ * // Gets next marker
1479
+ * let marker = response.continuationToken;
1480
+ *
1481
+ * // Passing next marker as continuationToken
1482
+ * iterator = directoryClient.listHandles().byPage({ continuationToken: marker, maxPageSize: 10 });
1483
+ * response = (await iterator.next()).value;
1484
+ *
1485
+ * for await (const handle of response.handleList || []) {
1486
+ * console.log(`\thandle: ${handle.handleId}`);
1487
+ * }
1488
+ * ```
1489
+ *
1490
+ * @param options - Options to list handles operation.
1491
+ *
1492
+ * An asyncIterableIterator that supports paging.
1493
+ */
1494
+ listHandles(options?: DirectoryListHandlesOptions): PagedAsyncIterableIterator<HandleItem, DirectoryListHandlesResponse>;
1495
+ /**
1496
+ * Lists handles for a directory.
1497
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-handles
1498
+ *
1499
+ * @param marker - Optional. A string value that identifies the portion of the list to be
1500
+ * returned with the next list handles operation. The operation returns a
1501
+ * marker value within the response body if the list returned was not complete.
1502
+ * The marker value may then be used in a subsequent call to request the next
1503
+ * set of list items.
1504
+ * @param options -
1505
+ */
1506
+ private listHandlesSegment;
1507
+ /**
1508
+ * Force close all handles for a directory.
1509
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
1510
+ *
1511
+ * @param marker - Optional. A string value that identifies the position of handles that will
1512
+ * be closed with the next force close handles operation.
1513
+ * The operation returns a marker value within the response
1514
+ * body if there are more handles to close. The marker value
1515
+ * may then be used in a subsequent call to close the next set of handles.
1516
+ * @param options -
1517
+ */
1518
+ private forceCloseHandlesSegment;
1519
+ /**
1520
+ * Force close all handles for a directory.
1521
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
1522
+ *
1523
+ * @param options -
1524
+ */
1525
+ forceCloseAllHandles(options?: DirectoryForceCloseHandlesSegmentOptions): Promise<CloseHandlesInfo>;
1526
+ /**
1527
+ * Force close a specific handle for a directory.
1528
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
1529
+ *
1530
+ * @param aborter - Create a new Aborter instance with Aborter.none or Aborter.timeout(),
1531
+ * goto documents of Aborter for more examples about request cancellation
1532
+ * @param handleId - Specific handle ID, cannot be asterisk "*".
1533
+ * Use forceCloseHandlesSegment() to close all handles.
1534
+ * @param options -
1535
+ */
1536
+ forceCloseHandle(handleId: string, options?: DirectoryForceCloseHandlesOptions): Promise<DirectoryForceCloseHandlesResponse>;
1537
+ /**
1538
+ * Renames a directory.
1539
+ * This API only supports renaming a directory in the same share.
1540
+ *
1541
+ * @param destinationPath - Specifies the destination path to rename to. The path will be encoded to put into a URL to specify the destination.
1542
+ * @param options - Options for the renaming operation.
1543
+ * @returns Response data for the file renaming operation.
1544
+ *
1545
+ * Example usage:
1546
+ *
1547
+ * ```ts snippet:ReadmeSampleRenameDirectory
1548
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
1549
+ *
1550
+ * const account = "<account>";
1551
+ * const accountKey = "<accountkey>";
1552
+ *
1553
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
1554
+ * const serviceClient = new ShareServiceClient(
1555
+ * `https://${account}.file.core.windows.net`,
1556
+ * credential,
1557
+ * );
1558
+ *
1559
+ * const shareName = "<share name>";
1560
+ * const directoryName = "<directory name>";
1561
+ * const destinationPath = "<destination path>";
1562
+ * const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
1563
+ *
1564
+ * await directoryClient.rename(destinationPath);
1565
+ * ```
1566
+ */
1567
+ rename(destinationPath: string, options?: DirectoryRenameOptions): Promise<{
1568
+ destinationDirectoryClient: ShareDirectoryClient;
1569
+ directoryRenameResponse: DirectoryRenameResponse;
1570
+ }>;
1571
+ }
1572
+ /**
1573
+ * Options to configure the {@link ShareFileClient.create} operation.
1574
+ */
1575
+ export interface FileCreateOptions extends FileAndDirectoryCreateCommonOptions, CommonOptions {
1576
+ /**
1577
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1578
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1579
+ */
1580
+ abortSignal?: AbortSignalLike;
1581
+ /**
1582
+ * File HTTP headers like Content-Type.
1583
+ */
1584
+ fileHttpHeaders?: FileHttpHeaders;
1585
+ /**
1586
+ * A collection of key-value string pair to associate with the file storage object.
1587
+ */
1588
+ metadata?: Metadata;
1589
+ /**
1590
+ * Lease access conditions.
1591
+ */
1592
+ leaseAccessConditions?: LeaseAccessConditions;
1593
+ }
1594
+ export interface FileProperties extends FileAndDirectorySetPropertiesCommonOptions, CommonOptions {
1595
+ /**
1596
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1597
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1598
+ */
1599
+ abortSignal?: AbortSignalLike;
1600
+ /**
1601
+ * File HTTP headers like Content-Type.
1602
+ */
1603
+ fileHttpHeaders?: FileHttpHeaders;
1604
+ /**
1605
+ * Lease access conditions.
1606
+ */
1607
+ leaseAccessConditions?: LeaseAccessConditions;
1608
+ }
1609
+ export interface SetPropertiesResponse extends FileSetHTTPHeadersResponse {
1610
+ }
1611
+ /**
1612
+ * Options to configure the {@link ShareFileClient.delete} operation.
1613
+ */
1614
+ export interface FileDeleteOptions extends CommonOptions {
1615
+ /**
1616
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1617
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1618
+ */
1619
+ abortSignal?: AbortSignalLike;
1620
+ /**
1621
+ * Lease access conditions.
1622
+ */
1623
+ leaseAccessConditions?: LeaseAccessConditions;
1624
+ }
1625
+ /**
1626
+ * Options to configure File - Download operations.
1627
+ *
1628
+ * See:
1629
+ * - {@link ShareFileClient.download}
1630
+ * - {@link ShareFileClient.downloadToFile}
1631
+ */
1632
+ export interface FileDownloadOptions extends CommonOptions {
1633
+ /**
1634
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1635
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1636
+ */
1637
+ abortSignal?: AbortSignalLike;
1638
+ /**
1639
+ * Optional. ONLY AVAILABLE IN NODE.JS.
1640
+ *
1641
+ * How many retries will perform when original body download stream unexpected ends.
1642
+ * Above kind of ends will not trigger retry policy defined in a pipeline,
1643
+ * because they doesn't emit network errors.
1644
+ *
1645
+ * With this option, every additional retry means an additional ShareFileClient.download() request will be made
1646
+ * from the broken point, until the requested range has been successfully downloaded or maxRetryRequests is reached.
1647
+ *
1648
+ * Default value is 5, please set a larger value when loading large files in poor network.
1649
+ */
1650
+ maxRetryRequests?: number;
1651
+ /**
1652
+ * When this header is set to true and
1653
+ * specified together with the Range header, the service returns the MD5 hash
1654
+ * for the range, as long as the range is less than or equal to 4 MB in size.
1655
+ */
1656
+ rangeGetContentMD5?: boolean;
1657
+ /**
1658
+ * Download progress updating event handler.
1659
+ */
1660
+ onProgress?: (progress: TransferProgressEvent) => void;
1661
+ /**
1662
+ * Lease access conditions.
1663
+ */
1664
+ leaseAccessConditions?: LeaseAccessConditions;
1665
+ }
1666
+ /**
1667
+ * Options to configure the {@link ShareFileClient.uploadRange} operation.
1668
+ */
1669
+ export interface FileUploadRangeOptions extends CommonOptions {
1670
+ /**
1671
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1672
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1673
+ */
1674
+ abortSignal?: AbortSignalLike;
1675
+ /**
1676
+ * An MD5 hash of the content. This hash is
1677
+ * used to verify the integrity of the data during transport. When the
1678
+ * Content-MD5 header is specified, the File service compares the hash of the
1679
+ * content that has arrived with the header value that was sent. If the two
1680
+ * hashes do not match, the operation will fail with error code 400 (Bad
1681
+ * Request).
1682
+ */
1683
+ contentMD5?: Uint8Array;
1684
+ /**
1685
+ * Progress updating event handler.
1686
+ */
1687
+ onProgress?: (progress: TransferProgressEvent) => void;
1688
+ /**
1689
+ * Lease access conditions.
1690
+ */
1691
+ leaseAccessConditions?: LeaseAccessConditions;
1692
+ /**
1693
+ * The last write time for the file.
1694
+ * A value of Preserve may be passed to keep an existing value unchanged.
1695
+ * A value of Now may be used to indicate the time of the request.
1696
+ * By default, the value will be set as Now.
1697
+ */
1698
+ fileLastWrittenMode?: FileLastWrittenMode;
1699
+ }
1700
+ /**
1701
+ * Options to configure the {@link ShareFileClient.uploadRangeFromURL} operation.
1702
+ */
1703
+ export interface FileUploadRangeFromURLOptions extends CommonOptions {
1704
+ /**
1705
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1706
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1707
+ */
1708
+ abortSignal?: AbortSignalLike;
1709
+ /**
1710
+ * The timeout parameter is expressed in seconds. For more information, see <a
1711
+ * href="https://learn.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting
1712
+ * Timeouts for File Service Operations.</a>
1713
+ */
1714
+ timeoutInSeconds?: number;
1715
+ /**
1716
+ * Specify the crc64 calculated for the range of bytes that must be read from the copy source.
1717
+ */
1718
+ sourceContentCrc64?: Uint8Array;
1719
+ /**
1720
+ * Additional parameters for the operation
1721
+ */
1722
+ sourceConditions?: SourceModifiedAccessConditions;
1723
+ /**
1724
+ * Lease access conditions.
1725
+ */
1726
+ leaseAccessConditions?: LeaseAccessConditions;
1727
+ /**
1728
+ * Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source.
1729
+ */
1730
+ sourceAuthorization?: HttpAuthorization;
1731
+ /**
1732
+ * The last write time for the file.
1733
+ * A value of preserve may be passed to keep an existing value unchanged.
1734
+ * A value of now may be used to indicate the time of the request.
1735
+ * By default, the value will be set as now.
1736
+ */
1737
+ fileLastWrittenMode?: FileLastWrittenMode;
1738
+ }
1739
+ /**
1740
+ * The option is defined as parity to REST definition.
1741
+ * While it's not ready to be used now, considering Crc64 of source content is
1742
+ * not accessible.
1743
+ */
1744
+ /**
1745
+ * Options to configure the {@link ShareFileClient.getRangeList} operation.
1746
+ */
1747
+ export interface FileGetRangeListOptions extends CommonOptions {
1748
+ /**
1749
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1750
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1751
+ */
1752
+ abortSignal?: AbortSignalLike;
1753
+ /**
1754
+ * Optional. Specifies the range of bytes over which to list ranges, inclusively.
1755
+ */
1756
+ range?: Range;
1757
+ /**
1758
+ * Lease access conditions.
1759
+ */
1760
+ leaseAccessConditions?: LeaseAccessConditions;
1761
+ /**
1762
+ * This header is allowed only when prevShareSnapshot parameter is set.
1763
+ * Determines whether the changed ranges for a file that has been renamed or moved between the target snapshot (or the live file) and the previous snapshot should be listed.
1764
+ * If the value is true, the valid changed ranges for the file will be returned. If the value is false, the operation will result in a failure with 409 (Conflict) response.
1765
+ * The default value is false.
1766
+ */
1767
+ includeRenames?: boolean;
1768
+ }
1769
+ /**
1770
+ * Options to configure the {@link ShareFileClient.exists} operation.
1771
+ */
1772
+ export interface FileExistsOptions extends CommonOptions {
1773
+ /**
1774
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1775
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1776
+ */
1777
+ abortSignal?: AbortSignalLike;
1778
+ }
1779
+ /**
1780
+ * Options to configure the {@link ShareFileClient.getProperties} operation.
1781
+ */
1782
+ export interface FileGetPropertiesOptions extends CommonOptions {
1783
+ /**
1784
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1785
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1786
+ */
1787
+ abortSignal?: AbortSignalLike;
1788
+ /**
1789
+ * Lease access conditions.
1790
+ */
1791
+ leaseAccessConditions?: LeaseAccessConditions;
1792
+ }
1793
+ /**
1794
+ * Contains response data for the {@link ShareFileClient.getRangeList} operation.
1795
+ */
1796
+ export type FileGetRangeListResponse = WithResponse<FileGetRangeListHeaders & {
1797
+ /**
1798
+ * Range list for an Azure file.
1799
+ */
1800
+ rangeList: RangeModel[];
1801
+ }, FileGetRangeListHeaders, RangeModel[]>;
1802
+ /**
1803
+ * Options to configure the {@link ShareFileClient.startCopyFromURL} operation.
1804
+ */
1805
+ export interface FileStartCopyOptions extends CommonOptions {
1806
+ /**
1807
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1808
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1809
+ */
1810
+ abortSignal?: AbortSignalLike;
1811
+ /**
1812
+ * A collection of key-value string pair to associate with the file storage object.
1813
+ */
1814
+ metadata?: Metadata;
1815
+ /**
1816
+ * Lease access conditions.
1817
+ */
1818
+ leaseAccessConditions?: LeaseAccessConditions;
1819
+ /**
1820
+ * If specified the permission (security descriptor) shall be set for the directory/file. This
1821
+ * header can be used if Permission size is lesser than or equal to 8KB, else x-ms-file-permission-key header shall be
1822
+ * used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and
1823
+ * dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be
1824
+ * specified.
1825
+ */
1826
+ filePermission?: string;
1827
+ /**
1828
+ * Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned.
1829
+ * Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format.
1830
+ * If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission
1831
+ */
1832
+ filePermissionFormat?: FilePermissionFormat;
1833
+ /**
1834
+ * Key of the permission to be set for the directory/file. Note: Only one of the
1835
+ * x-ms-file-permission or x-ms-file-permission-key should be specified.
1836
+ */
1837
+ filePermissionKey?: string;
1838
+ /**
1839
+ * SMB info.
1840
+ */
1841
+ copyFileSmbInfo?: CopyFileSmbInfo;
1842
+ /**
1843
+ * Optional properties to set on NFS files.
1844
+ Note that this property is only applicable to files created in NFS shares.
1845
+ */
1846
+ posixProperties?: FilePosixProperties;
1847
+ /**
1848
+ * Optional, only applicable to NFS Files.
1849
+ * Applicable only when the copy source is a File. Determines the copy behavior of the mode bits of the file.
1850
+ * source: The mode on the destination file is copied from the source file.
1851
+ * override: The mode on the destination file is determined via the x-ms-mode header.
1852
+ */
1853
+ fileModeCopyMode?: ModeCopyMode;
1854
+ /**
1855
+ * Optional, only applicable to NFS Files. Determines the copy behavior of the owner user identifier (UID) and group identifier (GID) of the file.
1856
+ * source: The owner user identifier (UID) and group identifier (GID) on the destination file is copied from the source file.
1857
+ * override: The owner user identifier (UID) and group identifier (GID) on the destination file is determined via the x-ms-owner and x-ms-group headers.
1858
+ */
1859
+ fileOwnerCopyMode?: OwnerCopyMode;
1860
+ }
1861
+ /**
1862
+ * Options to configure the {@link ShareFileClient.setMetadata} operation.
1863
+ */
1864
+ export interface FileSetMetadataOptions extends CommonOptions {
1865
+ /**
1866
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1867
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1868
+ */
1869
+ abortSignal?: AbortSignalLike;
1870
+ /**
1871
+ * Lease access conditions.
1872
+ */
1873
+ leaseAccessConditions?: LeaseAccessConditions;
1874
+ }
1875
+ /**
1876
+ * Options to configure the {@link ShareFileClient.setHttpHeaders} operation.
1877
+ */
1878
+ export interface FileSetHttpHeadersOptions extends FileAndDirectorySetPropertiesCommonOptions, CommonOptions {
1879
+ /**
1880
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1881
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1882
+ */
1883
+ abortSignal?: AbortSignalLike;
1884
+ /**
1885
+ * Lease access conditions.
1886
+ */
1887
+ leaseAccessConditions?: LeaseAccessConditions;
1888
+ }
1889
+ /**
1890
+ * Options to configure the {@link ShareFileClient.abortCopyFromURL} operation.
1891
+ */
1892
+ export interface FileAbortCopyFromURLOptions extends CommonOptions {
1893
+ /**
1894
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1895
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1896
+ */
1897
+ abortSignal?: AbortSignalLike;
1898
+ /**
1899
+ * Lease access conditions.
1900
+ */
1901
+ leaseAccessConditions?: LeaseAccessConditions;
1902
+ }
1903
+ /**
1904
+ * Options to configure the {@link ShareFileClient.resize} operation.
1905
+ */
1906
+ export interface FileResizeOptions extends FileAndDirectorySetPropertiesCommonOptions, CommonOptions {
1907
+ /**
1908
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1909
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1910
+ */
1911
+ abortSignal?: AbortSignalLike;
1912
+ /**
1913
+ * Lease access conditions.
1914
+ */
1915
+ leaseAccessConditions?: LeaseAccessConditions;
1916
+ }
1917
+ /**
1918
+ * Options to configure the {@link ShareFileClient.clearRange} operation.
1919
+ */
1920
+ export interface FileClearRangeOptions extends CommonOptions {
1921
+ /**
1922
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1923
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1924
+ */
1925
+ abortSignal?: AbortSignalLike;
1926
+ /**
1927
+ * Lease access conditions.
1928
+ */
1929
+ leaseAccessConditions?: LeaseAccessConditions;
1930
+ /**
1931
+ * The last write time for the file.
1932
+ * A value of preserve may be passed to keep an existing value unchanged.
1933
+ * A value of now may be used to indicate the time of the request.
1934
+ * By default, the value will be set as now.
1935
+ */
1936
+ fileLastWrittenMode?: FileLastWrittenMode;
1937
+ }
1938
+ /**
1939
+ * Options to configure File - List Handles Segment operations.
1940
+ *
1941
+ * See:
1942
+ * - {@link ShareFileClient.listHandlesSegment}
1943
+ * - {@link ShareFileClient.iterateHandleSegments}
1944
+ * - {@link ShareFileClient.listHandleItems}
1945
+ */
1946
+ export interface FileListHandlesSegmentOptions extends CommonOptions {
1947
+ /**
1948
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1949
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1950
+ */
1951
+ abortSignal?: AbortSignalLike;
1952
+ /**
1953
+ * Specifies the maximum number of entries to return. If the request does not specify maxResults,
1954
+ * or specifies a value greater than 5,000, the server will return up to 5,000 items.
1955
+ */
1956
+ maxPageSize?: number;
1957
+ }
1958
+ export interface FileListHandlesOptions extends CommonOptions {
1959
+ /**
1960
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1961
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1962
+ */
1963
+ abortSignal?: AbortSignalLike;
1964
+ }
1965
+ /**
1966
+ * Options to configure File - Force Close Handles operations.
1967
+ *
1968
+ * See:
1969
+ * - {@link ShareFileClient.forceCloseHandlesSegment}
1970
+ * - {@link ShareFileClient.forceCloseAllHandles}
1971
+ * - {@link ShareFileClient.forceCloseHandle}
1972
+ */
1973
+ export interface FileForceCloseHandlesOptions extends CommonOptions {
1974
+ /**
1975
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1976
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1977
+ */
1978
+ abortSignal?: AbortSignalLike;
1979
+ }
1980
+ /**
1981
+ * Options to configure File - Create Hard Link operations.
1982
+ *
1983
+ * See:
1984
+ * - {@link ShareFileClient.createHardLink}
1985
+ */
1986
+ export interface FileCreateHardLinkOptions extends CommonOptions {
1987
+ /**
1988
+ * Lease access conditions.
1989
+ */
1990
+ leaseAccessConditions?: LeaseAccessConditions;
1991
+ /**
1992
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
1993
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
1994
+ */
1995
+ abortSignal?: AbortSignalLike;
1996
+ }
1997
+ /**
1998
+ * Options to configure File - Create Symbolic Link operations.
1999
+ *
2000
+ * See:
2001
+ * - {@link ShareFileClient.createSymbolicLink}
2002
+ */
2003
+ export interface FileCreateSymbolicLinkOptions extends CommonOptions {
2004
+ /**
2005
+ * Metadata of the Azure file.
2006
+ */
2007
+ metadata?: Metadata;
2008
+ /**
2009
+ * The Coordinated Universal Time (UTC) creation time property for the directory.
2010
+ * A value of now may be used to indicate the time of the request.
2011
+ * By default, the value will be set as now.
2012
+ */
2013
+ creationTime?: Date | TimeNowType;
2014
+ /**
2015
+ * The Coordinated Universal Time (UTC) last write property for the directory.
2016
+ * A value of now may be used to indicate the time of the request.
2017
+ * By default, the value will be set as now.
2018
+ */
2019
+ lastWriteTime?: Date | TimeNowType;
2020
+ /** Optional, NFS only.
2021
+ * The owner of the file or directory.
2022
+ * */
2023
+ owner?: string;
2024
+ /** Optional, NFS only.
2025
+ * The owning group of the file or directory.
2026
+ * */
2027
+ group?: string;
2028
+ /**
2029
+ * Lease access conditions.
2030
+ */
2031
+ leaseAccessConditions?: LeaseAccessConditions;
2032
+ /**
2033
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
2034
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
2035
+ */
2036
+ abortSignal?: AbortSignalLike;
2037
+ }
2038
+ /**
2039
+ * Options to configure File - Get Symbolic Link operations.
2040
+ *
2041
+ * See:
2042
+ * - {@link ShareFileClient.getSymbolicLink}
2043
+ */
2044
+ export interface FileGetSymbolicLinkOptions extends CommonOptions {
2045
+ /**
2046
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
2047
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
2048
+ */
2049
+ abortSignal?: AbortSignalLike;
2050
+ }
2051
+ /**
2052
+ * Additional response header values for close handles request.
2053
+ */
2054
+ export interface FileCloseHandlesHeaders {
2055
+ /**
2056
+ * This header uniquely identifies the request that was made and can be used for troubleshooting
2057
+ * the request.
2058
+ */
2059
+ requestId?: string;
2060
+ /**
2061
+ * Indicates the version of the File service used to execute the request.
2062
+ */
2063
+ version?: string;
2064
+ /**
2065
+ * A UTC date/time value generated by the service that indicates the time at which the response
2066
+ * was initiated.
2067
+ */
2068
+ date?: Date;
2069
+ /**
2070
+ * A string describing next handle to be closed. It is returned when more handles need to be
2071
+ * closed to complete the request.
2072
+ */
2073
+ marker?: string;
2074
+ }
2075
+ /**
2076
+ * Response type for {@link ShareFileClient.forceCloseHandle}.
2077
+ */
2078
+ export type FileForceCloseHandlesResponse = WithResponse<CloseHandlesInfo & FileCloseHandlesHeaders, FileForceCloseHandlesHeaders>;
2079
+ /**
2080
+ * Option interface for ShareFileClient.uploadStream().
2081
+ */
2082
+ export interface FileUploadStreamOptions extends CommonOptions {
2083
+ /**
2084
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
2085
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
2086
+ */
2087
+ abortSignal?: AbortSignalLike;
2088
+ /**
2089
+ * Azure File HTTP Headers.
2090
+ */
2091
+ fileHttpHeaders?: FileHttpHeaders;
2092
+ /**
2093
+ * Metadata of the Azure file.
2094
+ */
2095
+ metadata?: Metadata;
2096
+ /**
2097
+ * Progress updater.
2098
+ */
2099
+ onProgress?: (progress: TransferProgressEvent) => void;
2100
+ /**
2101
+ * Lease access conditions.
2102
+ */
2103
+ leaseAccessConditions?: LeaseAccessConditions;
2104
+ }
2105
+ /**
2106
+ * Option interface for File - Upload operations
2107
+ *
2108
+ * See:
2109
+ * - {@link ShareFileClient.uploadFile}
2110
+ * - {@link ShareFileClient.uploadSeekableStream}
2111
+ */
2112
+ export interface FileParallelUploadOptions extends CommonOptions {
2113
+ /**
2114
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
2115
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
2116
+ */
2117
+ abortSignal?: AbortSignalLike;
2118
+ /**
2119
+ * RangeSize specifies the range size to use in each parallel upload,
2120
+ * the default (and maximum size) is FILE_RANGE_MAX_SIZE_BYTES.
2121
+ */
2122
+ rangeSize?: number;
2123
+ /**
2124
+ * Progress updater.
2125
+ */
2126
+ onProgress?: (progress: TransferProgressEvent) => void;
2127
+ /**
2128
+ * File HTTP Headers.
2129
+ */
2130
+ fileHttpHeaders?: FileHttpHeaders;
2131
+ /**
2132
+ * Metadata of an Azure file.
2133
+ */
2134
+ metadata?: Metadata;
2135
+ /**
2136
+ * Concurrency indicates the maximum number of ranges to upload in parallel.
2137
+ * If not provided, 5 concurrency will be used by default.
2138
+ */
2139
+ concurrency?: number;
2140
+ /**
2141
+ * Lease access conditions.
2142
+ */
2143
+ leaseAccessConditions?: LeaseAccessConditions;
2144
+ }
2145
+ /**
2146
+ * Option interface for the {@link ShareFileClient.downloadToBuffer} operation.
2147
+ */
2148
+ export interface FileDownloadToBufferOptions extends CommonOptions {
2149
+ /**
2150
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
2151
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
2152
+ */
2153
+ abortSignal?: AbortSignalLike;
2154
+ /**
2155
+ * When downloading Azure files, download method will try to split large file into small ranges.
2156
+ * Every small range will be downloaded via a separate request.
2157
+ * This option defines size data every small request trying to download.
2158
+ * Must be greater than 0, will use the default value if undefined,
2159
+ */
2160
+ rangeSize?: number;
2161
+ /**
2162
+ * Optional. ONLY AVAILABLE IN NODE.JS.
2163
+ *
2164
+ * How many retries will perform when original range download stream unexpected ends.
2165
+ * Above kind of ends will not trigger retry policy defined in a pipeline,
2166
+ * because they doesn't emit network errors.
2167
+ *
2168
+ * With this option, every additional retry means an additional ShareFileClient.download() request will be made
2169
+ * from the broken point, until the requested range has been successfully downloaded or
2170
+ * maxRetryRequestsPerRange is reached.
2171
+ *
2172
+ * Default value is 5, please set a larger value when in poor network.
2173
+ */
2174
+ maxRetryRequestsPerRange?: number;
2175
+ /**
2176
+ * Progress updater.
2177
+ */
2178
+ onProgress?: (progress: TransferProgressEvent) => void;
2179
+ /**
2180
+ * Concurrency indicates the maximum number of ranges to download in parallel.
2181
+ * If not provided, 5 concurrency will be used by default.
2182
+ */
2183
+ concurrency?: number;
2184
+ /**
2185
+ * Lease access conditions.
2186
+ */
2187
+ leaseAccessConditions?: LeaseAccessConditions;
2188
+ }
2189
+ /**
2190
+ * Contains response data for the {@link ShareFileClient.deleteIfExists} operation.
2191
+ */
2192
+ export interface FileDeleteIfExistsResponse extends FileDeleteResponse {
2193
+ /**
2194
+ * Indicate whether the file is successfully deleted. Is false if the file does not exist in the first place.
2195
+ */
2196
+ succeeded: boolean;
2197
+ }
2198
+ /**
2199
+ * Options to configure {@link ShareFileClient.generateSasUrl} operation.
2200
+ */
2201
+ export interface FileGenerateSasUrlOptions extends CommonGenerateSasUrlOptions {
2202
+ /**
2203
+ * Optional only when identifier is provided. Specifies the list of permissions to be associated with the SAS.
2204
+ */
2205
+ permissions?: FileSASPermissions;
2206
+ }
2207
+ /**
2208
+ * Options to configure the {@link ShareFileClient.rename} operation.
2209
+ */
2210
+ export interface FileRenameOptions extends CommonOptions {
2211
+ /**
2212
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
2213
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
2214
+ */
2215
+ abortSignal?: AbortSignalLike;
2216
+ /**
2217
+ * Lease access condition for source file. Required if the source file has an active infinite lease.
2218
+ */
2219
+ sourceLeaseAccessConditions?: LeaseAccessConditions;
2220
+ /**
2221
+ * Lease access condition for destination file. Required if the destination file has an active infinite lease.
2222
+ */
2223
+ destinationLeaseAccessConditions?: LeaseAccessConditions;
2224
+ /**
2225
+ * Optional.
2226
+ * Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key.
2227
+ */
2228
+ copyFileSmbInfo?: CopyFileSmbInfo;
2229
+ /**
2230
+ * A name-value pair to associate with a file storage object.
2231
+ */
2232
+ metadata?: Metadata;
2233
+ /**
2234
+ * Optional.
2235
+ * The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a>
2236
+ */
2237
+ timeoutInSeconds?: number;
2238
+ /**
2239
+ * Optional.
2240
+ * If specified the permission (security descriptor) shall be set for the directory/file.
2241
+ */
2242
+ filePermission?: string;
2243
+ /**
2244
+ * Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned.
2245
+ * Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format.
2246
+ * If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission
2247
+ */
2248
+ filePermissionFormat?: FilePermissionFormat;
2249
+ /**
2250
+ * Optional.
2251
+ * Key of the permission to be set for the directory/file. Note: Only one of the filePermission or filePermissionKey should be specified.
2252
+ */
2253
+ filePermissionKey?: string;
2254
+ /**
2255
+ * Optional.
2256
+ * 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.
2257
+ */
2258
+ replaceIfExists?: boolean;
2259
+ /**
2260
+ * Optional.
2261
+ * 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.
2262
+ */
2263
+ ignoreReadOnly?: boolean;
2264
+ /**
2265
+ * Optional.
2266
+ * Content type to set on the File.
2267
+ */
2268
+ contentType?: string;
2269
+ }
2270
+ /**
2271
+ * Options to configure the {@link ShareDirectoryClient.rename} operation.
2272
+ */
2273
+ export interface DirectoryRenameOptions extends CommonOptions {
2274
+ /**
2275
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
2276
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
2277
+ */
2278
+ abortSignal?: AbortSignalLike;
2279
+ /**
2280
+ * Lease access condition for source file. Required if the source file has an active infinite lease.
2281
+ */
2282
+ sourceLeaseAccessConditions?: LeaseAccessConditions;
2283
+ /**
2284
+ * Lease access condition for destination file. Required if the destination file has an active infinite lease.
2285
+ */
2286
+ destinationLeaseAccessConditions?: LeaseAccessConditions;
2287
+ /**
2288
+ * Optional.
2289
+ * Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key.
2290
+ */
2291
+ copyFileSmbInfo?: CopyFileSmbInfo;
2292
+ /**
2293
+ * Optional.
2294
+ * The timeout parameter is expressed in seconds. For more information, see <a href="https://learn.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a>
2295
+ */
2296
+ timeoutInSeconds?: number;
2297
+ /**
2298
+ * Optional.
2299
+ * A name-value pair to associate with a file storage object.
2300
+ */
2301
+ metadata?: Metadata;
2302
+ /**
2303
+ * Optional.
2304
+ * If specified the permission (security descriptor) shall be set for the directory/file.
2305
+ */
2306
+ filePermission?: string;
2307
+ /**
2308
+ * Optional. Available for version 2023-06-01 and later. Specifies the format in which the permission is returned.
2309
+ * Acceptable values are SDDL or binary. If x-ms-file-permission-format is unspecified or explicitly set to SDDL, the permission is returned in SDDL format.
2310
+ * If x-ms-file-permission-format is explicitly set to binary, the permission is returned as a base64 string representing the binary encoding of the permission
2311
+ */
2312
+ filePermissionFormat?: FilePermissionFormat;
2313
+ /**
2314
+ * Optional.
2315
+ * Key of the permission to be set for the directory/file. Note: Only one of the filePermission or filePermissionKey should be specified.
2316
+ */
2317
+ filePermissionKey?: string;
2318
+ /**
2319
+ * Optional.
2320
+ * 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.
2321
+ */
2322
+ replaceIfExists?: boolean;
2323
+ /**
2324
+ * Optional.
2325
+ * 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.
2326
+ */
2327
+ ignoreReadOnly?: boolean;
2328
+ }
2329
+ /**
2330
+ * A ShareFileClient represents a URL to an Azure Storage file.
2331
+ */
2332
+ export declare class ShareFileClient extends StorageClient {
2333
+ /**
2334
+ * context provided by protocol layer.
2335
+ */
2336
+ private context;
2337
+ private _shareName;
2338
+ private _path;
2339
+ private _name;
2340
+ private shareClientConfig?;
2341
+ /**
2342
+ * The share name corresponding to this file client
2343
+ */
2344
+ get shareName(): string;
2345
+ /**
2346
+ * The full path of the file
2347
+ */
2348
+ get path(): string;
2349
+ /**
2350
+ * The name of the file
2351
+ */
2352
+ get name(): string;
2353
+ /**
2354
+ * Creates an instance of ShareFileClient.
2355
+ *
2356
+ * @param url - A URL string pointing to Azure Storage file, such as
2357
+ * "https://myaccount.file.core.windows.net/myshare/mydirectory/file". You can
2358
+ * append a SAS if using AnonymousCredential, such as
2359
+ * "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString".
2360
+ * This method accepts an encoded URL or non-encoded URL pointing to a file.
2361
+ * Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
2362
+ * However, if a file or directory name includes %, file or directory name must be encoded in the URL.
2363
+ * Such as a file named "myfile%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".
2364
+ * @param credential - Such as , StorageSharedKeyCredential or TokenCredential,
2365
+ * If not specified, AnonymousCredential is used.
2366
+ * @param options - Optional. Options to configure the HTTP pipeline.
2367
+ */
2368
+ constructor(url: string, credential?: Credential | TokenCredential, options?: ShareClientOptions);
2369
+ /**
2370
+ * Creates an instance of ShareFileClient.
2371
+ *
2372
+ * @param url - A URL string pointing to Azure Storage file, such as
2373
+ * "https://myaccount.file.core.windows.net/myshare/mydirectory/file". You can
2374
+ * append a SAS if using AnonymousCredential, such as
2375
+ * "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString".
2376
+ * This method accepts an encoded URL or non-encoded URL pointing to a file.
2377
+ * Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
2378
+ * However, if a file or directory name includes %, file or directory name must be encoded in the URL.
2379
+ * Such as a file named "myfile%", the URL should be "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".
2380
+ * @param pipeline - Call newPipeline() to create a default
2381
+ * pipeline, or provide a customized pipeline.
2382
+ */
2383
+ constructor(url: string, pipeline: Pipeline, options?: ShareClientConfig);
2384
+ /**
2385
+ * Creates a new ShareFileClient object identical to the source but with the specified share snapshot timestamp.
2386
+ * Provide "" will remove the snapshot and return a URL to the base ShareFileClient.
2387
+ *
2388
+ * @param shareSnapshot - The share snapshot timestamp.
2389
+ * @returns A new ShareFileClient object identical to the source but with the specified share snapshot timestamp.
2390
+ */
2391
+ withShareSnapshot(shareSnapshot: string): ShareFileClient;
2392
+ /**
2393
+ * Creates a new file or replaces a file. Note it only initializes the file with no content.
2394
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-file
2395
+ *
2396
+ * @param size - Specifies the maximum size in bytes for the file, up to 4 TB.
2397
+ * @param options - Options to File Create operation.
2398
+ * @returns Response data for the File Create operation.
2399
+ *
2400
+ * Example usage:
2401
+ *
2402
+ * ```ts snippet:ReadmeSampleCreateFileAndUpload
2403
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
2404
+ *
2405
+ * const account = "<account>";
2406
+ * const accountKey = "<accountkey>";
2407
+ *
2408
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
2409
+ * const serviceClient = new ShareServiceClient(
2410
+ * `https://${account}.file.core.windows.net`,
2411
+ * credential,
2412
+ * );
2413
+ *
2414
+ * const shareName = "<share name>";
2415
+ * const directoryName = "<directory name>";
2416
+ * const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
2417
+ *
2418
+ * const content = "Hello World!";
2419
+ * const fileName = `newdirectory${+new Date()}`;
2420
+ * const fileClient = directoryClient.getFileClient(fileName);
2421
+ * await fileClient.create(content.length);
2422
+ * console.log(`Create file ${fileName} successfully`);
2423
+ *
2424
+ * // Upload file range
2425
+ * await fileClient.uploadRange(content, 0, content.length);
2426
+ * console.log(`Upload file range "${content}" to ${fileName} successfully`);
2427
+ * ```
2428
+ */
2429
+ create(size: number, options?: FileCreateOptions): Promise<FileCreateResponse>;
2430
+ /**
2431
+ * Reads or downloads a file from the system, including its metadata and properties.
2432
+ *
2433
+ * * In Node.js, data returns in a Readable stream `readableStreamBody`
2434
+ * * In browsers, data returns in a promise `contentAsBlob`
2435
+ *
2436
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-file
2437
+ *
2438
+ * @param offset - From which position of the file to download, greater than or equal to 0
2439
+ * @param count - How much data to be downloaded, greater than 0. Will download to the end when undefined
2440
+ * @param options - Options to File Download operation.
2441
+ * @returns Response data for the File Download operation.
2442
+ *
2443
+ * Example usage (Node.js):
2444
+ *
2445
+ * ```ts snippet:ReadmeSampleDownloadFileAndConvertToString_Node
2446
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
2447
+ *
2448
+ * const account = "<account>";
2449
+ * const accountKey = "<accountkey>";
2450
+ *
2451
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
2452
+ * const serviceClient = new ShareServiceClient(
2453
+ * `https://${account}.file.core.windows.net`,
2454
+ * credential,
2455
+ * );
2456
+ *
2457
+ * const shareName = "<share name>";
2458
+ * const fileName = "<file name>";
2459
+ * const fileClient = serviceClient
2460
+ * .getShareClient(shareName)
2461
+ * .rootDirectoryClient.getFileClient(fileName);
2462
+ *
2463
+ * // Get file content from position 0 to the end
2464
+ * // In Node.js, get downloaded data by accessing downloadFileResponse.readableStreamBody
2465
+ * const downloadFileResponse = await fileClient.download();
2466
+ * if (downloadFileResponse.readableStreamBody) {
2467
+ * const buffer = await streamToBuffer(downloadFileResponse.readableStreamBody);
2468
+ * console.log(`Downloaded file content: ${buffer.toString()}`);
2469
+ * }
2470
+ *
2471
+ * // [Node.js only] A helper method used to read a Node.js readable stream into a Buffer
2472
+ * async function streamToBuffer(readableStream: NodeJS.ReadableStream): Promise<Buffer> {
2473
+ * return new Promise((resolve, reject) => {
2474
+ * const chunks: Buffer[] = [];
2475
+ * readableStream.on("data", (data) => {
2476
+ * chunks.push(data instanceof Buffer ? data : Buffer.from(data));
2477
+ * });
2478
+ * readableStream.on("end", () => {
2479
+ * resolve(Buffer.concat(chunks));
2480
+ * });
2481
+ * readableStream.on("error", reject);
2482
+ * });
2483
+ * }
2484
+ * ```
2485
+ *
2486
+ * Example usage (browsers):
2487
+ *
2488
+ * ```ts snippet:ReadmeSampleDownloadFileAndConvertToString_Browser
2489
+ * import { ShareServiceClient } from "@azure/storage-file-share";
2490
+ *
2491
+ * const account = "<account name>";
2492
+ * const sas = "<service Shared Access Signature Token>";
2493
+ *
2494
+ * const serviceClient = new ShareServiceClient(`https://${account}.file.core.windows.net?${sas}`);
2495
+ *
2496
+ * const shareName = "<share name>";
2497
+ * const fileName = "<file name>";
2498
+ * const fileClient = serviceClient
2499
+ * .getShareClient(shareName)
2500
+ * .rootDirectoryClient.getFileClient(fileName);
2501
+ *
2502
+ * // Get file content from position 0 to the end
2503
+ * // In browsers, get downloaded data by accessing downloadFileResponse.blobBody
2504
+ * const downloadFileResponse = await fileClient.download(0);
2505
+ * if (downloadFileResponse.blobBody) {
2506
+ * console.log(`Downloaded file content: ${(await downloadFileResponse.blobBody).text()}`);
2507
+ * }
2508
+ * ```
2509
+ */
2510
+ download(offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>;
2511
+ /**
2512
+ * Returns true if the specified file exists; false otherwise.
2513
+ *
2514
+ * NOTE: use this function with care since an existing file might be deleted by other clients or
2515
+ * applications. Vice versa new files might be added by other clients or applications after this
2516
+ * function completes.
2517
+ *
2518
+ * @param options - options to Exists operation.
2519
+ */
2520
+ exists(options?: FileExistsOptions): Promise<boolean>;
2521
+ /**
2522
+ * Returns all user-defined metadata, standard HTTP properties, and system properties
2523
+ * for the file. It does not return the content of the file.
2524
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-file-properties
2525
+ *
2526
+ * @param options - Options to File Get Properties operation.
2527
+ * @returns Response data for the File Get Properties operation.
2528
+ */
2529
+ getProperties(options?: FileGetPropertiesOptions): Promise<FileGetPropertiesResponse>;
2530
+ /**
2531
+ * Sets properties on the file.
2532
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-file-properties
2533
+ *
2534
+ * @param properties - File properties. For file HTTP headers(e.g. Content-Type),
2535
+ * if no values are provided, existing HTTP headers will be removed.
2536
+ * For other file properties(e.g. fileAttributes), if no values are provided,
2537
+ * existing values will be preserved.
2538
+ */
2539
+ setProperties(properties?: FileProperties): Promise<SetPropertiesResponse>;
2540
+ /**
2541
+ * Removes the file from the storage account.
2542
+ * When a file is successfully deleted, it is immediately removed from the storage
2543
+ * account's index and is no longer accessible to clients. The file's data is later
2544
+ * removed from the service during garbage collection.
2545
+ *
2546
+ * Delete File will fail with status code 409 (Conflict) and error code SharingViolation
2547
+ * if the file is open on an SMB client.
2548
+ *
2549
+ * Delete File is not supported on a share snapshot, which is a read-only copy of
2550
+ * a share. An attempt to perform this operation on a share snapshot will fail with 400 (InvalidQueryParameterValue)
2551
+ *
2552
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2
2553
+ *
2554
+ * @param options - Options to File Delete operation.
2555
+ * @returns Response data for the File Delete operation.
2556
+ */
2557
+ delete(options?: FileDeleteOptions): Promise<FileDeleteResponse>;
2558
+ /**
2559
+ * Removes the file from the storage account if it exists.
2560
+ * When a file is successfully deleted, it is immediately removed from the storage
2561
+ * account's index and is no longer accessible to clients. The file's data is later
2562
+ * removed from the service during garbage collection.
2563
+ *
2564
+ * Delete File will fail with status code 409 (Conflict) and error code SharingViolation
2565
+ * if the file is open on an SMB client.
2566
+ *
2567
+ * Delete File is not supported on a share snapshot, which is a read-only copy of
2568
+ * a share. An attempt to perform this operation on a share snapshot will fail with 400 (InvalidQueryParameterValue)
2569
+ *
2570
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2
2571
+ *
2572
+ * @param options -
2573
+ */
2574
+ deleteIfExists(options?: FileDeleteOptions): Promise<FileDeleteIfExistsResponse>;
2575
+ /**
2576
+ * Sets HTTP headers on the file.
2577
+ *
2578
+ * If no option provided, or no value provided for the file HTTP headers in the options,
2579
+ * these file HTTP headers without a value will be cleared.
2580
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-file-properties
2581
+ *
2582
+ * @param FileHttpHeaders - File HTTP headers like Content-Type.
2583
+ * Provide undefined will remove existing HTTP headers.
2584
+ * @param options - Options to File Set HTTP Headers operation.
2585
+ * @returns Response data for the File Set HTTP Headers operation.
2586
+ */
2587
+ setHttpHeaders(fileHttpHeaders?: FileHttpHeaders, options?: FileSetHttpHeadersOptions): Promise<FileSetHTTPHeadersResponse>;
2588
+ /**
2589
+ * Resize file.
2590
+ *
2591
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-file-properties
2592
+ *
2593
+ * @param length - Resizes a file to the specified size in bytes.
2594
+ * If the specified byte value is less than the current size of the file,
2595
+ * then all ranges above the specified byte value are cleared.
2596
+ * @param options - Options to File Resize operation.
2597
+ * @returns Response data for the File Set HTTP Headers operation.
2598
+ */
2599
+ resize(length: number, options?: FileResizeOptions): Promise<FileSetHTTPHeadersResponse>;
2600
+ /**
2601
+ * Updates user-defined metadata for the specified file.
2602
+ *
2603
+ * If no metadata defined in the option parameter, the file
2604
+ * metadata will be removed.
2605
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-file-metadata
2606
+ *
2607
+ * @param metadata - If no metadata provided, all existing directory metadata will be removed
2608
+ * @param options - Options to File Set Metadata operation.
2609
+ * @returns Response data for the File Set Metadata operation.
2610
+ */
2611
+ setMetadata(metadata?: Metadata, options?: FileSetMetadataOptions): Promise<FileSetMetadataResponse>;
2612
+ /**
2613
+ * Upload a range of bytes to a file. This operation can only be called on an existing file.
2614
+ * It won't change the size, properties or metadata of the file.
2615
+ * Both the start and count of the range must be specified. The range can be up to 4 MB in size.
2616
+ *
2617
+ * @param body - Blob, string, ArrayBuffer, ArrayBufferView or a function
2618
+ * which returns a new Readable stream whose offset is from data source beginning.
2619
+ * @param offset - Offset position of the destination Azure File to upload.
2620
+ * @param contentLength - Length of body in bytes. Use Buffer.byteLength() to calculate body length for a
2621
+ * string including non non-Base64/Hex-encoded characters.
2622
+ * @param options - Options to File Upload Range operation.
2623
+ * @returns Response data for the File Upload Range operation.
2624
+ *
2625
+ * Example usage:
2626
+ *
2627
+ * ```ts snippet:ReadmeSampleCreateFileAndUpload
2628
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
2629
+ *
2630
+ * const account = "<account>";
2631
+ * const accountKey = "<accountkey>";
2632
+ *
2633
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
2634
+ * const serviceClient = new ShareServiceClient(
2635
+ * `https://${account}.file.core.windows.net`,
2636
+ * credential,
2637
+ * );
2638
+ *
2639
+ * const shareName = "<share name>";
2640
+ * const directoryName = "<directory name>";
2641
+ * const directoryClient = serviceClient.getShareClient(shareName).getDirectoryClient(directoryName);
2642
+ *
2643
+ * const content = "Hello World!";
2644
+ * const fileName = `newdirectory${+new Date()}`;
2645
+ * const fileClient = directoryClient.getFileClient(fileName);
2646
+ * await fileClient.create(content.length);
2647
+ * console.log(`Create file ${fileName} successfully`);
2648
+ *
2649
+ * // Upload file range
2650
+ * await fileClient.uploadRange(content, 0, content.length);
2651
+ * console.log(`Upload file range "${content}" to ${fileName} successfully`);
2652
+ * ```
2653
+ */
2654
+ uploadRange(body: HttpRequestBody, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>;
2655
+ /**
2656
+ * Upload a range of bytes to a file where the contents are read from a another file's URL.
2657
+ * The range can be up to 4 MB in size.
2658
+ *
2659
+ * @param sourceURL - Specify a URL to the copy source, Shared Access Signature(SAS) maybe needed for authentication.
2660
+ * @param sourceOffset - The source offset to copy from. Pass 0 to copy from the beginning of source file.
2661
+ * @param destOffset - Offset of destination file.
2662
+ * @param count - Number of bytes to be uploaded from source file.
2663
+ * @param options - Options to configure File - Upload Range from URL operation.
2664
+ */
2665
+ uploadRangeFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: FileUploadRangeFromURLOptions): Promise<FileUploadRangeFromURLResponse>;
2666
+ /**
2667
+ * Clears the specified range and
2668
+ * releases the space used in storage for that range.
2669
+ *
2670
+ * @param offset -
2671
+ * @param contentLength -
2672
+ * @param options - Options to File Clear Range operation.
2673
+ */
2674
+ clearRange(offset: number, contentLength: number, options?: FileClearRangeOptions): Promise<FileUploadRangeResponse>;
2675
+ /**
2676
+ * Returns the list of valid ranges for a file.
2677
+ *
2678
+ * @param options - Options to File Get range List operation.
2679
+ */
2680
+ getRangeList(options?: FileGetRangeListOptions): Promise<FileGetRangeListResponse>;
2681
+ /**
2682
+ * Returns the list of ranges that differ between a previous share snapshot and this file.
2683
+ *
2684
+ * @param prevShareSnapshot - The previous snapshot parameter is an opaque DateTime value that specifies the previous share snapshot to compare with.
2685
+ * @param options -
2686
+ */
2687
+ getRangeListDiff(prevShareSnapshot: string, options?: FileGetRangeListOptions): Promise<FileGetRangeListDiffResponse>;
2688
+ /**
2689
+ * Copies a blob or file to a destination file within the storage account.
2690
+ *
2691
+ * @param copySource - Specifies the URL of the source file or blob, up to 2 KB in length.
2692
+ * To copy a file to another file within the same storage account, you may use Shared Key to
2693
+ * authenticate the source file. If you are copying a file from another storage account, or if you
2694
+ * are copying a blob from the same storage account or another storage account, then you must
2695
+ * authenticate the source file or blob using a shared access signature. If the source is a public
2696
+ * blob, no authentication is required to perform the copy operation. A file in a share snapshot
2697
+ * can also be specified as a copy source.
2698
+ * @param options - Options to File Start Copy operation.
2699
+ */
2700
+ startCopyFromURL(copySource: string, options?: FileStartCopyOptions): Promise<FileStartCopyResponse>;
2701
+ /**
2702
+ * Aborts a pending Copy File operation, and leaves a destination file with zero length and full
2703
+ * metadata.
2704
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/abort-copy-file
2705
+ *
2706
+ * @param copyId - Id of the Copy File operation to abort.
2707
+ * @param options - Options to File Abort Copy From URL operation.
2708
+ */
2709
+ abortCopyFromURL(copyId: string, options?: FileAbortCopyFromURLOptions): Promise<FileAbortCopyResponse>;
2710
+ /**
2711
+ * Creates a new Azure File or replaces an existing Azure File, and then uploads a Buffer(Node)/Blob/ArrayBuffer/ArrayBufferView to it.
2712
+ *
2713
+ * @param data - Buffer(Node), Blob, ArrayBuffer or ArrayBufferView
2714
+ * @param options -
2715
+ */
2716
+ uploadData(data: Buffer | Blob | ArrayBuffer | ArrayBufferView, options?: FileParallelUploadOptions): Promise<void>;
2717
+ /**
2718
+ * ONLY AVAILABLE IN BROWSERS.
2719
+ *
2720
+ * Uploads a browser Blob object to an Azure file. Requires a blobFactory as the data source,
2721
+ * which need to return a Blob object with the offset and size provided.
2722
+ *
2723
+ * @param blobFactory -
2724
+ * @param size -
2725
+ * @param options -
2726
+ */
2727
+ uploadSeekableBlob(blobFactory: (offset: number, size: number) => Blob, size: number, options?: FileParallelUploadOptions): Promise<void>;
2728
+ /**
2729
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
2730
+ *
2731
+ * Creates a new Azure File or replaces an existing Azure File, and then uploads a local file to it.
2732
+ *
2733
+ * @param filePath - Full path of local file
2734
+ * @param fileClient - ShareFileClient
2735
+ * @param options -
2736
+ */
2737
+ uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<void>;
2738
+ /**
2739
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
2740
+ *
2741
+ * Accepts a Node.js Readable stream factory, and uploads in blocks to an Azure File.
2742
+ * The Readable stream factory must returns a Node.js Readable stream starting from the offset defined. The offset
2743
+ * is the offset in the Azure file to be uploaded.
2744
+ *
2745
+ * @param streamFactory - Returns a Node.js Readable stream starting
2746
+ * from the offset defined
2747
+ * @param size - Size of the Azure file
2748
+ * @param fileClient - ShareFileClient
2749
+ * @param options -
2750
+ */
2751
+ uploadResetableStream(streamFactory: (offset: number, count?: number) => NodeJS.ReadableStream, size: number, options?: FileParallelUploadOptions): Promise<void>;
2752
+ /**
2753
+ *
2754
+ * @param bodyFactory -
2755
+ * @param size - Size of the Azure file
2756
+ * @param fileClient - ShareFileClient
2757
+ * @param options -
2758
+ */
2759
+ private uploadSeekableInternal;
2760
+ /**
2761
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
2762
+ *
2763
+ * Downloads an Azure file in parallel to a buffer.
2764
+ * Offset and count are optional, pass 0 for both to download the entire file.
2765
+ *
2766
+ * Warning: Buffers can only support files up to about one gigabyte on 32-bit systems or about two
2767
+ * gigabytes on 64-bit systems due to limitations of Node.js/V8. For files larger than this size,
2768
+ * consider {@link downloadToFile}.
2769
+ *
2770
+ * @param buffer - Buffer to be fill, must have length larger than count
2771
+ * @param offset - From which position of the Azure File to download
2772
+ * @param count - How much data to be downloaded. Will download to the end when passing undefined
2773
+ * @param options -
2774
+ */
2775
+ downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>;
2776
+ /**
2777
+ * ONLY AVAILABLE IN NODE.JS RUNTIME
2778
+ *
2779
+ * Downloads an Azure file in parallel to a buffer.
2780
+ * Offset and count are optional, pass 0 for both to download the entire file
2781
+ *
2782
+ * Warning: Buffers can only support files up to about one gigabyte on 32-bit systems or about two
2783
+ * gigabytes on 64-bit systems due to limitations of Node.js/V8. For files larger than this size,
2784
+ * consider {@link downloadToFile}.
2785
+ *
2786
+ * @param offset - From which position of the Azure file to download
2787
+ * @param count - How much data to be downloaded. Will download to the end when passing undefined
2788
+ * @param options -
2789
+ */
2790
+ downloadToBuffer(offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>;
2791
+ /**
2792
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
2793
+ *
2794
+ * Creates a new Azure File or replaces an existing Azure File, and then uploads a Node.js Readable stream into it.
2795
+ * This method will try to create an Azure File, then starts uploading chunk by chunk.
2796
+ * Size of chunk is defined by `bufferSize` parameter.
2797
+ * Please make sure potential size of stream doesn't exceed file size.
2798
+ *
2799
+ * PERFORMANCE IMPROVEMENT TIPS:
2800
+ * * Input stream highWaterMark is better to set a same value with bufferSize
2801
+ * parameter, which will avoid Buffer.concat() operations.
2802
+ *
2803
+ * @param stream - Node.js Readable stream. Must be less or equal than file size.
2804
+ * @param size - Size of file to be created. Maximum size allowed is 4 TB.
2805
+ * If this value is larger than stream size, there will be empty bytes in file tail.
2806
+ * @param bufferSize - Size of every buffer allocated in bytes, also the chunk/range size during
2807
+ * the uploaded file. Size must be greater than 0 and lesser than or equal to 4 * 1024 * 1024 (4MB)
2808
+ * @param maxBuffers - Max buffers will allocate during uploading, positive correlation
2809
+ * with max uploading concurrency
2810
+ * @param options -
2811
+ */
2812
+ uploadStream(stream: NodeJS.ReadableStream, size: number, bufferSize: number, maxBuffers: number, options?: FileUploadStreamOptions): Promise<void>;
2813
+ /**
2814
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
2815
+ *
2816
+ * Downloads an Azure Blob to a local file.
2817
+ * Fails if the the given file path already exits.
2818
+ * Offset and count are optional, pass 0 and undefined respectively to download the entire blob.
2819
+ *
2820
+ * @param filePath -
2821
+ * @param offset - From which position of the block blob to download.
2822
+ * @param count - How much data to be downloaded. Will download to the end when passing undefined.
2823
+ * @param options - Options to Blob download options.
2824
+ * @returns The response data for blob download operation,
2825
+ * but with readableStreamBody set to undefined since its
2826
+ * content is already read and written into a local file
2827
+ * at the specified path.
2828
+ */
2829
+ downloadToFile(filePath: string, offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>;
2830
+ /**
2831
+ * Lists handles for a file.
2832
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-handles
2833
+ *
2834
+ * @param marker - Optional. A string value that identifies the portion of the list to be
2835
+ * returned with the next list handles operation. The operation returns a
2836
+ * marker value within the response body if the list returned was not complete.
2837
+ * The marker value may then be used in a subsequent call to request the next
2838
+ * set of list items.
2839
+ * @param options -
2840
+ */
2841
+ private listHandlesSegment;
2842
+ /**
2843
+ * Returns an AsyncIterableIterator for FileListHandlesResponse
2844
+ *
2845
+ * @param marker - A string value that identifies the portion of the list to be
2846
+ * returned with the next list handles operation. The operation returns a
2847
+ * marker value within the response body if the list returned was not complete.
2848
+ * The marker value may then be used in a subsequent call to request the next
2849
+ * set of list items.
2850
+ * @param options - Options to list handles operation.
2851
+ */
2852
+ private iterateHandleSegments;
2853
+ /**
2854
+ * Returns an AsyncIterableIterator for handles
2855
+ *
2856
+ * @param options - Options to list handles operation.
2857
+ */
2858
+ private listHandleItems;
2859
+ /**
2860
+ * Returns an async iterable iterator to list all the handles.
2861
+ * under the specified account.
2862
+ *
2863
+ * .byPage() returns an async iterable iterator to list the handles in pages.
2864
+ *
2865
+ * @param options - Options to list handles operation.
2866
+ *
2867
+ * An asyncIterableIterator that supports paging.
2868
+ */
2869
+ listHandles(options?: FileListHandlesOptions): PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse>;
2870
+ /**
2871
+ * Force close all handles for a file.
2872
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
2873
+ *
2874
+ * @param marker - Optional. A string value that identifies the position of handles that will
2875
+ * be closed with the next force close handles operation.
2876
+ * The operation returns a marker value within the response
2877
+ * body if there are more handles to close. The marker value
2878
+ * may then be used in a subsequent call to close the next set of handles.
2879
+ * @param options - Options to force close handles operation.
2880
+ */
2881
+ private forceCloseHandlesSegment;
2882
+ /**
2883
+ * Force close all handles for a file.
2884
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
2885
+ *
2886
+ * @param options - Options to force close handles operation.
2887
+ */
2888
+ forceCloseAllHandles(options?: FileForceCloseHandlesOptions): Promise<CloseHandlesInfo>;
2889
+ /**
2890
+ * Force close a specific handle for a file.
2891
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
2892
+ *
2893
+ * @param handleId - Specific handle ID, cannot be asterisk "*".
2894
+ * Use forceCloseAllHandles() to close all handles.
2895
+ * @param FileForceCloseHandlesOptions - Options to force close handles operation.
2896
+ */
2897
+ forceCloseHandle(handleId: string, options?: FileForceCloseHandlesOptions): Promise<FileForceCloseHandlesResponse>;
2898
+ /**
2899
+ * NFS only. Creates a hard link to the file file specified by path.
2900
+ * @param targetFile - Path of the file to create the hard link to, not including the share.
2901
+ * For example: "targetDirectory/targetSubDirectory/.../targetFile"
2902
+ * @param options - Options to create hard link operation.
2903
+ */
2904
+ createHardLink(targetFile: string, options?: FileCreateHardLinkOptions): Promise<FileCreateHardLinkResponse>;
2905
+ /**
2906
+ * NFS only. Creates a symbolic link.
2907
+ * @param linkText - The path to the original file, the symbolic link is pointing to.
2908
+ * The path is of type string which is not resolved and is stored as is. The path can be absolute path
2909
+ * or the relative path depending on the content stored in the symbolic link file.
2910
+ * @param options - Options to create hard link operation.
2911
+ */
2912
+ createSymbolicLink(linkText: string, options?: FileCreateSymbolicLinkOptions): Promise<FileCreateSymbolicLinkResponse>;
2913
+ /**
2914
+ * NFS only. Gets content of a symbolic link.
2915
+ * @param options - Options to get symbolic link operation.
2916
+ */
2917
+ getSymbolicLink(options?: FileGetSymbolicLinkOptions): Promise<FileGetSymbolicLinkResponse>;
2918
+ /**
2919
+ * Get a {@link ShareLeaseClient} that manages leases on the file.
2920
+ *
2921
+ * @param proposeLeaseId - Initial proposed lease Id.
2922
+ * @returns A new ShareLeaseClient object for managing leases on the file.
2923
+ */
2924
+ getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient;
2925
+ /**
2926
+ * Only available for clients constructed with a shared key credential.
2927
+ *
2928
+ * Generates a Service Shared Access Signature (SAS) URI based on the client properties
2929
+ * and parameters passed in. The SAS is signed by the shared key credential of the client.
2930
+ *
2931
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
2932
+ *
2933
+ * @param options - Optional parameters.
2934
+ * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
2935
+ */
2936
+ generateSasUrl(options: FileGenerateSasUrlOptions): string;
2937
+ /**
2938
+ * Only available for clients constructed with a shared key credential.
2939
+ *
2940
+ * Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
2941
+ * and parameters passed in. The SAS is signed by the shared key credential of the client.
2942
+ *
2943
+ * @see https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
2944
+ *
2945
+ * @param options - Optional parameters.
2946
+ * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
2947
+ */
2948
+ generateSasStringToSign(options: FileGenerateSasUrlOptions): string;
2949
+ /**
2950
+ * Renames a file.
2951
+ * This API only supports renaming a file in the same share.
2952
+ *
2953
+ * @param destinationPath - Specifies the destination path to rename to. The path will be encoded to put into a URL to specify the destination.
2954
+ * @param options - Options for the renaming operation.
2955
+ * @returns Response data for the file renaming operation.
2956
+ *
2957
+ * Example usage:
2958
+ *
2959
+ * ```ts snippet:ReadmeSampleRenameFile
2960
+ * import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";
2961
+ *
2962
+ * const account = "<account>";
2963
+ * const accountKey = "<accountkey>";
2964
+ *
2965
+ * const credential = new StorageSharedKeyCredential(account, accountKey);
2966
+ * const serviceClient = new ShareServiceClient(
2967
+ * `https://${account}.file.core.windows.net`,
2968
+ * credential,
2969
+ * );
2970
+ *
2971
+ * const shareName = "<share name>";
2972
+ * const directoryName = "<directory name>";
2973
+ * const fileName = "<file name>";
2974
+ * const destinationPath = "<destination path>";
2975
+ * const fileClient = serviceClient
2976
+ * .getShareClient(shareName)
2977
+ * .getDirectoryClient(directoryName)
2978
+ * .getFileClient(fileName);
2979
+ *
2980
+ * await fileClient.rename(destinationPath);
2981
+ * ```
2982
+ */
2983
+ rename(destinationPath: string, options?: FileRenameOptions): Promise<{
2984
+ destinationFileClient: ShareFileClient;
2985
+ fileRenameResponse: FileRenameResponse;
2986
+ }>;
2987
+ }
2988
+ /**
2989
+ * The details of the response for a specific lease operation.
2990
+ */
2991
+ export interface LeaseOperationResponseHeaders {
2992
+ /**
2993
+ * The ETag contains a value that you can use to perform operations conditionally. If the request
2994
+ * version is 2011-08-18 or newer, the ETag value will be in quotes.
2995
+ */
2996
+ etag?: string;
2997
+ /**
2998
+ * Returns the date and time the file was last modified. Any operation that modifies the file,
2999
+ * including an update of the file's metadata or properties, changes the last-modified time of
3000
+ * the file.
3001
+ */
3002
+ lastModified?: Date;
3003
+ /**
3004
+ * Approximate time remaining in the lease period, in seconds. Only availabe for {@link ShareLeaseClient.breakLease} for share lease.
3005
+ */
3006
+ leaseTimeInSeconds?: number;
3007
+ /**
3008
+ * Uniquely identifies a file's lease, won't be set when returned by releaseLease.
3009
+ */
3010
+ leaseId?: string;
3011
+ /**
3012
+ * This header uniquely identifies the request that was made and can be used for troubleshooting
3013
+ * the request.
3014
+ */
3015
+ requestId?: string;
3016
+ /**
3017
+ * Indicates the version of the Blob service used to execute the request. This header is returned
3018
+ * for requests made against version 2009-09-19 and above.
3019
+ */
3020
+ version?: string;
3021
+ /**
3022
+ * UTC date/time value generated by the service that indicates the time at which the response was
3023
+ * initiated
3024
+ */
3025
+ date?: Date;
3026
+ errorCode?: string;
3027
+ }
3028
+ /**
3029
+ * Contains the response data for operations that acquire, change, break or release a lease.
3030
+ *
3031
+ * See {@link ShareLeaseClient}.
3032
+ */
3033
+ export type LeaseOperationResponse = WithResponse<LeaseOperationResponseHeaders, LeaseOperationResponseHeaders>;
3034
+ /**
3035
+ * lease operations options.
3036
+ */
3037
+ export interface LeaseOperationOptions extends CommonOptions {
3038
+ /**
3039
+ * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
3040
+ * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
3041
+ */
3042
+ abortSignal?: AbortSignalLike;
3043
+ }
3044
+ /**
3045
+ * A client that manages leases for a {@link ShareFileClient} or {@link ShareClient}.
3046
+ * @see https://learn.microsoft.com/rest/api/storageservices/lease-file
3047
+ * and
3048
+ * @see https://learn.microsoft.com/rest/api/storageservices/lease-share
3049
+ */
3050
+ export declare class ShareLeaseClient {
3051
+ private _leaseId;
3052
+ private _url;
3053
+ private fileOrShare;
3054
+ private shareClientConfig?;
3055
+ /**
3056
+ * Gets the lease Id.
3057
+ *
3058
+ * @readonly
3059
+ */
3060
+ get leaseId(): string;
3061
+ /**
3062
+ * Gets the url.
3063
+ *
3064
+ * @readonly
3065
+ */
3066
+ get url(): string;
3067
+ /**
3068
+ * Creates an instance of ShareLeaseClient.
3069
+ * @param client - The client to make the lease operation requests.
3070
+ * @param leaseId - Initial proposed lease id.
3071
+ */
3072
+ constructor(client: ShareFileClient | ShareClient, leaseId?: string);
3073
+ /**
3074
+ * Establishes and manages a lock on a file, share or share snapshot for write and delete operations.
3075
+ *
3076
+ * @param duration - Specifies the duration of lease in seconds. For file, the only allowed value is -1 for a lease that never expires. For share, must be -1 or between 15 to 60.
3077
+ * @param options - Options for the lease management operation.
3078
+ * @returns Response data for acquire lease operation.
3079
+ */
3080
+ acquireLease(duration?: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>;
3081
+ /**
3082
+ * To change the ID of an existing lease.
3083
+ *
3084
+ * @param proposedLeaseId - the proposed new lease Id.
3085
+ * @param options - Options for the lease management operation.
3086
+ * @returns Response data for change lease operation.
3087
+ */
3088
+ changeLease(proposedLeaseId: string, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>;
3089
+ /**
3090
+ * To free the lease if it is no longer needed so that another client may
3091
+ * immediately acquire a lease.
3092
+ *
3093
+ * @param options - Options for the lease management operation.
3094
+ * @returns Response data for release lease operation.
3095
+ */
3096
+ releaseLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>;
3097
+ /**
3098
+ * To force end the lease.
3099
+ *
3100
+ * @param options - Options for the lease management operation.
3101
+ * @returns Response data for break lease operation.
3102
+ */
3103
+ breakLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>;
3104
+ /**
3105
+ * To renew the lease. Only available for lease on share or share snapshot.
3106
+ * Note that the lease may be renewed even if it has expired as long as the share has not been leased again since the expiration of that lease.
3107
+ * When you renew a lease, the lease duration clock resets.
3108
+ *
3109
+ * @param options - Options for the lease management operation.
3110
+ * @returns Response data for renew lease operation.
3111
+ */
3112
+ renewLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>;
3113
+ }
3114
+ //# sourceMappingURL=Clients.d.ts.map