@azure/arm-search 4.0.0-alpha.20250213.1 → 4.0.0-alpha.20250217.2

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 (634) hide show
  1. package/README.md +21 -12
  2. package/dist/browser/index.d.ts +5 -0
  3. package/{dist-esm/src → dist/browser}/index.d.ts.map +1 -1
  4. package/{dist-esm/src → dist/browser}/index.js +4 -4
  5. package/dist/browser/index.js.map +1 -0
  6. package/dist/browser/lroImpl.js.map +1 -0
  7. package/dist/browser/models/index.js.map +1 -0
  8. package/dist/browser/models/mappers.js.map +1 -0
  9. package/{dist-esm/src → dist/browser}/models/parameters.js +1 -1
  10. package/dist/browser/models/parameters.js.map +1 -0
  11. package/{dist-esm/src → dist/browser}/operations/adminKeys.d.ts +3 -3
  12. package/dist/browser/operations/adminKeys.d.ts.map +1 -0
  13. package/{dist-esm/src → dist/browser}/operations/adminKeys.js +2 -2
  14. package/dist/browser/operations/adminKeys.js.map +1 -0
  15. package/dist/browser/operations/index.d.ts +10 -0
  16. package/dist/browser/operations/index.d.ts.map +1 -0
  17. package/dist/browser/operations/index.js +17 -0
  18. package/dist/browser/operations/index.js.map +1 -0
  19. package/{dist-esm/src → dist/browser}/operations/networkSecurityPerimeterConfigurations.d.ts +3 -3
  20. package/dist/browser/operations/networkSecurityPerimeterConfigurations.d.ts.map +1 -0
  21. package/{dist-esm/src → dist/browser}/operations/networkSecurityPerimeterConfigurations.js +42 -46
  22. package/dist/browser/operations/networkSecurityPerimeterConfigurations.js.map +1 -0
  23. package/{dist-esm/src → dist/browser}/operations/operations.d.ts +3 -3
  24. package/dist/browser/operations/operations.d.ts.map +1 -0
  25. package/{dist-esm/src → dist/browser}/operations/operations.js +2 -2
  26. package/dist/browser/operations/operations.js.map +1 -0
  27. package/{dist-esm/src → dist/browser}/operations/privateEndpointConnections.d.ts +3 -3
  28. package/dist/browser/operations/privateEndpointConnections.d.ts.map +1 -0
  29. package/{dist-esm/src → dist/browser}/operations/privateEndpointConnections.js +3 -3
  30. package/dist/browser/operations/privateEndpointConnections.js.map +1 -0
  31. package/{dist-esm/src → dist/browser}/operations/privateLinkResources.d.ts +3 -3
  32. package/dist/browser/operations/privateLinkResources.d.ts.map +1 -0
  33. package/{dist-esm/src → dist/browser}/operations/privateLinkResources.js +2 -2
  34. package/dist/browser/operations/privateLinkResources.js.map +1 -0
  35. package/{dist-esm/src → dist/browser}/operations/queryKeys.d.ts +3 -3
  36. package/dist/browser/operations/queryKeys.d.ts.map +1 -0
  37. package/{dist-esm/src → dist/browser}/operations/queryKeys.js +3 -3
  38. package/dist/browser/operations/queryKeys.js.map +1 -0
  39. package/{dist-esm/src → dist/browser}/operations/services.d.ts +3 -3
  40. package/dist/browser/operations/services.d.ts.map +1 -0
  41. package/{dist-esm/src → dist/browser}/operations/services.js +41 -45
  42. package/dist/browser/operations/services.js.map +1 -0
  43. package/{dist-esm/src → dist/browser}/operations/sharedPrivateLinkResources.d.ts +3 -3
  44. package/dist/browser/operations/sharedPrivateLinkResources.d.ts.map +1 -0
  45. package/{dist-esm/src → dist/browser}/operations/sharedPrivateLinkResources.js +88 -96
  46. package/dist/browser/operations/sharedPrivateLinkResources.js.map +1 -0
  47. package/{dist-esm/src → dist/browser}/operations/usages.d.ts +3 -3
  48. package/dist/browser/operations/usages.d.ts.map +1 -0
  49. package/{dist-esm/src → dist/browser}/operations/usages.js +3 -3
  50. package/dist/browser/operations/usages.js.map +1 -0
  51. package/{dist-esm/src → dist/browser}/operationsInterfaces/adminKeys.d.ts +1 -1
  52. package/dist/browser/operationsInterfaces/adminKeys.d.ts.map +1 -0
  53. package/dist/browser/operationsInterfaces/adminKeys.js.map +1 -0
  54. package/dist/browser/operationsInterfaces/index.d.ts +10 -0
  55. package/dist/browser/operationsInterfaces/index.d.ts.map +1 -0
  56. package/dist/browser/operationsInterfaces/index.js +17 -0
  57. package/dist/browser/operationsInterfaces/index.js.map +1 -0
  58. package/{dist-esm/src → dist/browser}/operationsInterfaces/networkSecurityPerimeterConfigurations.d.ts +1 -1
  59. package/dist/browser/operationsInterfaces/networkSecurityPerimeterConfigurations.d.ts.map +1 -0
  60. package/dist/browser/operationsInterfaces/networkSecurityPerimeterConfigurations.js.map +1 -0
  61. package/{dist-esm/src → dist/browser}/operationsInterfaces/operations.d.ts +1 -1
  62. package/{dist-esm/src → dist/browser}/operationsInterfaces/operations.d.ts.map +1 -1
  63. package/dist/browser/operationsInterfaces/operations.js.map +1 -0
  64. package/{dist-esm/src → dist/browser}/operationsInterfaces/privateEndpointConnections.d.ts +1 -1
  65. package/dist/browser/operationsInterfaces/privateEndpointConnections.d.ts.map +1 -0
  66. package/dist/browser/operationsInterfaces/privateEndpointConnections.js.map +1 -0
  67. package/{dist-esm/src → dist/browser}/operationsInterfaces/privateLinkResources.d.ts +1 -1
  68. package/dist/browser/operationsInterfaces/privateLinkResources.d.ts.map +1 -0
  69. package/dist/browser/operationsInterfaces/privateLinkResources.js.map +1 -0
  70. package/{dist-esm/src → dist/browser}/operationsInterfaces/queryKeys.d.ts +1 -1
  71. package/dist/browser/operationsInterfaces/queryKeys.d.ts.map +1 -0
  72. package/dist/browser/operationsInterfaces/queryKeys.js.map +1 -0
  73. package/{dist-esm/src → dist/browser}/operationsInterfaces/services.d.ts +1 -1
  74. package/dist/browser/operationsInterfaces/services.d.ts.map +1 -0
  75. package/dist/browser/operationsInterfaces/services.js.map +1 -0
  76. package/{dist-esm/src → dist/browser}/operationsInterfaces/sharedPrivateLinkResources.d.ts +1 -1
  77. package/dist/browser/operationsInterfaces/sharedPrivateLinkResources.d.ts.map +1 -0
  78. package/dist/browser/operationsInterfaces/sharedPrivateLinkResources.js.map +1 -0
  79. package/{dist-esm/src → dist/browser}/operationsInterfaces/usages.d.ts +1 -1
  80. package/dist/browser/operationsInterfaces/usages.d.ts.map +1 -0
  81. package/dist/browser/operationsInterfaces/usages.js.map +1 -0
  82. package/dist/browser/package.json +3 -0
  83. package/dist/browser/pagingHelper.js.map +1 -0
  84. package/{dist-esm/src → dist/browser}/searchManagementClient.d.ts +2 -2
  85. package/dist/browser/searchManagementClient.d.ts.map +1 -0
  86. package/{dist-esm/src → dist/browser}/searchManagementClient.js +17 -20
  87. package/dist/browser/searchManagementClient.js.map +1 -0
  88. package/dist/commonjs/index.d.ts +5 -0
  89. package/dist/commonjs/index.d.ts.map +1 -0
  90. package/dist/commonjs/index.js +19 -0
  91. package/dist/commonjs/index.js.map +1 -0
  92. package/dist/commonjs/lroImpl.d.ts +11 -0
  93. package/dist/commonjs/lroImpl.d.ts.map +1 -0
  94. package/dist/commonjs/lroImpl.js +17 -0
  95. package/dist/commonjs/lroImpl.js.map +1 -0
  96. package/{types/arm-search.d.ts → dist/commonjs/models/index.d.ts} +1247 -1791
  97. package/dist/commonjs/models/index.d.ts.map +1 -0
  98. package/dist/commonjs/models/index.js +135 -0
  99. package/dist/commonjs/models/index.js.map +1 -0
  100. package/dist/commonjs/models/mappers.d.ts +60 -0
  101. package/dist/commonjs/models/mappers.d.ts.map +1 -0
  102. package/dist/commonjs/models/mappers.js +1841 -0
  103. package/dist/commonjs/models/mappers.js.map +1 -0
  104. package/dist/commonjs/models/parameters.d.ts +26 -0
  105. package/dist/commonjs/models/parameters.d.ts.map +1 -0
  106. package/dist/commonjs/models/parameters.js +233 -0
  107. package/dist/commonjs/models/parameters.js.map +1 -0
  108. package/dist/commonjs/operations/adminKeys.d.ts +33 -0
  109. package/dist/commonjs/operations/adminKeys.d.ts.map +1 -0
  110. package/dist/commonjs/operations/adminKeys.js +95 -0
  111. package/dist/commonjs/operations/adminKeys.js.map +1 -0
  112. package/dist/commonjs/operations/index.d.ts +10 -0
  113. package/dist/commonjs/operations/index.d.ts.map +1 -0
  114. package/dist/commonjs/operations/index.js +20 -0
  115. package/dist/commonjs/operations/index.js.map +1 -0
  116. package/dist/commonjs/operations/networkSecurityPerimeterConfigurations.d.ts +79 -0
  117. package/dist/commonjs/operations/networkSecurityPerimeterConfigurations.d.ts.map +1 -0
  118. package/dist/commonjs/operations/networkSecurityPerimeterConfigurations.js +289 -0
  119. package/dist/commonjs/operations/networkSecurityPerimeterConfigurations.js.map +1 -0
  120. package/dist/commonjs/operations/operations.d.ts +26 -0
  121. package/dist/commonjs/operations/operations.d.ts.map +1 -0
  122. package/dist/commonjs/operations/operations.js +100 -0
  123. package/dist/commonjs/operations/operations.js.map +1 -0
  124. package/dist/commonjs/operations/privateEndpointConnections.d.ts +79 -0
  125. package/dist/commonjs/operations/privateEndpointConnections.d.ts.map +1 -0
  126. package/dist/commonjs/operations/privateEndpointConnections.js +290 -0
  127. package/dist/commonjs/operations/privateEndpointConnections.js.map +1 -0
  128. package/dist/commonjs/operations/privateLinkResources.d.ts +34 -0
  129. package/dist/commonjs/operations/privateLinkResources.d.ts.map +1 -0
  130. package/dist/commonjs/operations/privateLinkResources.js +113 -0
  131. package/dist/commonjs/operations/privateLinkResources.js.map +1 -0
  132. package/dist/commonjs/operations/queryKeys.d.ts +66 -0
  133. package/dist/commonjs/operations/queryKeys.d.ts.map +1 -0
  134. package/dist/commonjs/operations/queryKeys.js +230 -0
  135. package/dist/commonjs/operations/queryKeys.js.map +1 -0
  136. package/dist/commonjs/operations/services.d.ts +123 -0
  137. package/dist/commonjs/operations/services.d.ts.map +1 -0
  138. package/dist/commonjs/operations/services.js +506 -0
  139. package/dist/commonjs/operations/services.js.map +1 -0
  140. package/dist/commonjs/operations/sharedPrivateLinkResources.d.ts +107 -0
  141. package/dist/commonjs/operations/sharedPrivateLinkResources.d.ts.map +1 -0
  142. package/dist/commonjs/operations/sharedPrivateLinkResources.js +400 -0
  143. package/dist/commonjs/operations/sharedPrivateLinkResources.js.map +1 -0
  144. package/dist/commonjs/operations/usages.d.ts +35 -0
  145. package/dist/commonjs/operations/usages.d.ts.map +1 -0
  146. package/dist/commonjs/operations/usages.js +149 -0
  147. package/dist/commonjs/operations/usages.js.map +1 -0
  148. package/dist/commonjs/operationsInterfaces/adminKeys.d.ts +25 -0
  149. package/dist/commonjs/operationsInterfaces/adminKeys.d.ts.map +1 -0
  150. package/dist/commonjs/operationsInterfaces/adminKeys.js +10 -0
  151. package/dist/commonjs/operationsInterfaces/adminKeys.js.map +1 -0
  152. package/dist/commonjs/operationsInterfaces/index.d.ts +10 -0
  153. package/dist/commonjs/operationsInterfaces/index.d.ts.map +1 -0
  154. package/dist/commonjs/operationsInterfaces/index.js +20 -0
  155. package/dist/commonjs/operationsInterfaces/index.js.map +1 -0
  156. package/dist/commonjs/operationsInterfaces/networkSecurityPerimeterConfigurations.d.ts +50 -0
  157. package/dist/commonjs/operationsInterfaces/networkSecurityPerimeterConfigurations.d.ts.map +1 -0
  158. package/dist/commonjs/operationsInterfaces/networkSecurityPerimeterConfigurations.js +10 -0
  159. package/dist/commonjs/operationsInterfaces/networkSecurityPerimeterConfigurations.js.map +1 -0
  160. package/dist/commonjs/operationsInterfaces/operations.d.ts +11 -0
  161. package/dist/commonjs/operationsInterfaces/operations.d.ts.map +1 -0
  162. package/dist/commonjs/operationsInterfaces/operations.js +10 -0
  163. package/dist/commonjs/operationsInterfaces/operations.js.map +1 -0
  164. package/dist/commonjs/operationsInterfaces/privateEndpointConnections.d.ts +50 -0
  165. package/dist/commonjs/operationsInterfaces/privateEndpointConnections.d.ts.map +1 -0
  166. package/dist/commonjs/operationsInterfaces/privateEndpointConnections.js +10 -0
  167. package/dist/commonjs/operationsInterfaces/privateEndpointConnections.js.map +1 -0
  168. package/dist/commonjs/operationsInterfaces/privateLinkResources.d.ts +15 -0
  169. package/dist/commonjs/operationsInterfaces/privateLinkResources.d.ts.map +1 -0
  170. package/dist/commonjs/operationsInterfaces/privateLinkResources.js +10 -0
  171. package/dist/commonjs/operationsInterfaces/privateLinkResources.js.map +1 -0
  172. package/dist/commonjs/operationsInterfaces/queryKeys.d.ts +37 -0
  173. package/dist/commonjs/operationsInterfaces/queryKeys.d.ts.map +1 -0
  174. package/dist/commonjs/operationsInterfaces/queryKeys.js +10 -0
  175. package/dist/commonjs/operationsInterfaces/queryKeys.js.map +1 -0
  176. package/dist/commonjs/operationsInterfaces/services.d.ts +85 -0
  177. package/dist/commonjs/operationsInterfaces/services.d.ts.map +1 -0
  178. package/dist/commonjs/operationsInterfaces/services.js +10 -0
  179. package/dist/commonjs/operationsInterfaces/services.js.map +1 -0
  180. package/dist/commonjs/operationsInterfaces/sharedPrivateLinkResources.d.ts +78 -0
  181. package/dist/commonjs/operationsInterfaces/sharedPrivateLinkResources.d.ts.map +1 -0
  182. package/dist/commonjs/operationsInterfaces/sharedPrivateLinkResources.js +10 -0
  183. package/dist/commonjs/operationsInterfaces/sharedPrivateLinkResources.js.map +1 -0
  184. package/dist/commonjs/operationsInterfaces/usages.d.ts +12 -0
  185. package/dist/commonjs/operationsInterfaces/usages.d.ts.map +1 -0
  186. package/dist/commonjs/operationsInterfaces/usages.js +10 -0
  187. package/dist/commonjs/operationsInterfaces/usages.js.map +1 -0
  188. package/dist/commonjs/package.json +3 -0
  189. package/dist/commonjs/pagingHelper.d.ts +13 -0
  190. package/dist/commonjs/pagingHelper.d.ts.map +1 -0
  191. package/dist/commonjs/pagingHelper.js +36 -0
  192. package/dist/commonjs/pagingHelper.js.map +1 -0
  193. package/dist/commonjs/searchManagementClient.d.ts +36 -0
  194. package/dist/commonjs/searchManagementClient.d.ts.map +1 -0
  195. package/dist/commonjs/searchManagementClient.js +146 -0
  196. package/dist/commonjs/searchManagementClient.js.map +1 -0
  197. package/dist/esm/index.d.ts +5 -0
  198. package/dist/esm/index.d.ts.map +1 -0
  199. package/{src/index.ts → dist/esm/index.js} +5 -5
  200. package/dist/esm/index.js.map +1 -0
  201. package/dist/esm/lroImpl.d.ts +11 -0
  202. package/dist/esm/lroImpl.d.ts.map +1 -0
  203. package/dist/esm/lroImpl.js +14 -0
  204. package/dist/esm/lroImpl.js.map +1 -0
  205. package/dist/esm/models/index.d.ts +1247 -0
  206. package/dist/esm/models/index.d.ts.map +1 -0
  207. package/dist/esm/models/index.js +132 -0
  208. package/dist/esm/models/index.js.map +1 -0
  209. package/dist/esm/models/mappers.d.ts +60 -0
  210. package/dist/esm/models/mappers.d.ts.map +1 -0
  211. package/dist/esm/models/mappers.js +1837 -0
  212. package/dist/esm/models/mappers.js.map +1 -0
  213. package/dist/esm/models/parameters.d.ts +26 -0
  214. package/dist/esm/models/parameters.d.ts.map +1 -0
  215. package/dist/esm/models/parameters.js +230 -0
  216. package/dist/esm/models/parameters.js.map +1 -0
  217. package/dist/esm/operations/adminKeys.d.ts +33 -0
  218. package/dist/esm/operations/adminKeys.d.ts.map +1 -0
  219. package/dist/esm/operations/adminKeys.js +90 -0
  220. package/dist/esm/operations/adminKeys.js.map +1 -0
  221. package/dist/esm/operations/index.d.ts +10 -0
  222. package/dist/esm/operations/index.d.ts.map +1 -0
  223. package/dist/esm/operations/index.js +17 -0
  224. package/dist/esm/operations/index.js.map +1 -0
  225. package/dist/esm/operations/networkSecurityPerimeterConfigurations.d.ts +79 -0
  226. package/dist/esm/operations/networkSecurityPerimeterConfigurations.d.ts.map +1 -0
  227. package/dist/esm/operations/networkSecurityPerimeterConfigurations.js +285 -0
  228. package/dist/esm/operations/networkSecurityPerimeterConfigurations.js.map +1 -0
  229. package/dist/esm/operations/operations.d.ts +26 -0
  230. package/dist/esm/operations/operations.d.ts.map +1 -0
  231. package/dist/esm/operations/operations.js +96 -0
  232. package/dist/esm/operations/operations.js.map +1 -0
  233. package/dist/esm/operations/privateEndpointConnections.d.ts +79 -0
  234. package/dist/esm/operations/privateEndpointConnections.d.ts.map +1 -0
  235. package/dist/esm/operations/privateEndpointConnections.js +286 -0
  236. package/dist/esm/operations/privateEndpointConnections.js.map +1 -0
  237. package/dist/esm/operations/privateLinkResources.d.ts +34 -0
  238. package/dist/esm/operations/privateLinkResources.d.ts.map +1 -0
  239. package/dist/esm/operations/privateLinkResources.js +109 -0
  240. package/dist/esm/operations/privateLinkResources.js.map +1 -0
  241. package/dist/esm/operations/queryKeys.d.ts +66 -0
  242. package/dist/esm/operations/queryKeys.d.ts.map +1 -0
  243. package/dist/esm/operations/queryKeys.js +226 -0
  244. package/dist/esm/operations/queryKeys.js.map +1 -0
  245. package/dist/esm/operations/services.d.ts +123 -0
  246. package/dist/esm/operations/services.d.ts.map +1 -0
  247. package/dist/esm/operations/services.js +502 -0
  248. package/dist/esm/operations/services.js.map +1 -0
  249. package/dist/esm/operations/sharedPrivateLinkResources.d.ts +107 -0
  250. package/dist/esm/operations/sharedPrivateLinkResources.d.ts.map +1 -0
  251. package/dist/esm/operations/sharedPrivateLinkResources.js +396 -0
  252. package/dist/esm/operations/sharedPrivateLinkResources.js.map +1 -0
  253. package/dist/esm/operations/usages.d.ts +35 -0
  254. package/dist/esm/operations/usages.d.ts.map +1 -0
  255. package/dist/esm/operations/usages.js +145 -0
  256. package/dist/esm/operations/usages.js.map +1 -0
  257. package/dist/esm/operationsInterfaces/adminKeys.d.ts +25 -0
  258. package/dist/esm/operationsInterfaces/adminKeys.d.ts.map +1 -0
  259. package/dist/esm/operationsInterfaces/adminKeys.js +9 -0
  260. package/dist/esm/operationsInterfaces/adminKeys.js.map +1 -0
  261. package/dist/esm/operationsInterfaces/index.d.ts +10 -0
  262. package/dist/esm/operationsInterfaces/index.d.ts.map +1 -0
  263. package/dist/esm/operationsInterfaces/index.js +17 -0
  264. package/dist/esm/operationsInterfaces/index.js.map +1 -0
  265. package/dist/esm/operationsInterfaces/networkSecurityPerimeterConfigurations.d.ts +50 -0
  266. package/dist/esm/operationsInterfaces/networkSecurityPerimeterConfigurations.d.ts.map +1 -0
  267. package/dist/esm/operationsInterfaces/networkSecurityPerimeterConfigurations.js +9 -0
  268. package/dist/esm/operationsInterfaces/networkSecurityPerimeterConfigurations.js.map +1 -0
  269. package/dist/esm/operationsInterfaces/operations.d.ts +11 -0
  270. package/dist/esm/operationsInterfaces/operations.d.ts.map +1 -0
  271. package/dist/esm/operationsInterfaces/operations.js +9 -0
  272. package/dist/esm/operationsInterfaces/operations.js.map +1 -0
  273. package/dist/esm/operationsInterfaces/privateEndpointConnections.d.ts +50 -0
  274. package/dist/esm/operationsInterfaces/privateEndpointConnections.d.ts.map +1 -0
  275. package/dist/esm/operationsInterfaces/privateEndpointConnections.js +9 -0
  276. package/dist/esm/operationsInterfaces/privateEndpointConnections.js.map +1 -0
  277. package/dist/esm/operationsInterfaces/privateLinkResources.d.ts +15 -0
  278. package/dist/esm/operationsInterfaces/privateLinkResources.d.ts.map +1 -0
  279. package/dist/esm/operationsInterfaces/privateLinkResources.js +9 -0
  280. package/dist/esm/operationsInterfaces/privateLinkResources.js.map +1 -0
  281. package/dist/esm/operationsInterfaces/queryKeys.d.ts +37 -0
  282. package/dist/esm/operationsInterfaces/queryKeys.d.ts.map +1 -0
  283. package/dist/esm/operationsInterfaces/queryKeys.js +9 -0
  284. package/dist/esm/operationsInterfaces/queryKeys.js.map +1 -0
  285. package/dist/esm/operationsInterfaces/services.d.ts +85 -0
  286. package/dist/esm/operationsInterfaces/services.d.ts.map +1 -0
  287. package/dist/esm/operationsInterfaces/services.js +9 -0
  288. package/dist/esm/operationsInterfaces/services.js.map +1 -0
  289. package/dist/esm/operationsInterfaces/sharedPrivateLinkResources.d.ts +78 -0
  290. package/dist/esm/operationsInterfaces/sharedPrivateLinkResources.d.ts.map +1 -0
  291. package/dist/esm/operationsInterfaces/sharedPrivateLinkResources.js +9 -0
  292. package/dist/esm/operationsInterfaces/sharedPrivateLinkResources.js.map +1 -0
  293. package/dist/esm/operationsInterfaces/usages.d.ts +12 -0
  294. package/dist/esm/operationsInterfaces/usages.d.ts.map +1 -0
  295. package/dist/esm/operationsInterfaces/usages.js +9 -0
  296. package/dist/esm/operationsInterfaces/usages.js.map +1 -0
  297. package/dist/esm/package.json +3 -0
  298. package/dist/esm/pagingHelper.d.ts +13 -0
  299. package/dist/esm/pagingHelper.d.ts.map +1 -0
  300. package/dist/esm/pagingHelper.js +32 -0
  301. package/dist/esm/pagingHelper.js.map +1 -0
  302. package/dist/esm/searchManagementClient.d.ts +36 -0
  303. package/dist/esm/searchManagementClient.d.ts.map +1 -0
  304. package/dist/esm/searchManagementClient.js +141 -0
  305. package/dist/esm/searchManagementClient.js.map +1 -0
  306. package/dist/react-native/index.d.ts +5 -0
  307. package/dist/react-native/index.d.ts.map +1 -0
  308. package/dist/react-native/index.js +13 -0
  309. package/dist/react-native/index.js.map +1 -0
  310. package/dist/react-native/lroImpl.d.ts +11 -0
  311. package/dist/react-native/lroImpl.d.ts.map +1 -0
  312. package/dist/react-native/lroImpl.js +14 -0
  313. package/dist/react-native/lroImpl.js.map +1 -0
  314. package/dist/react-native/models/index.d.ts +1247 -0
  315. package/dist/react-native/models/index.d.ts.map +1 -0
  316. package/dist/react-native/models/index.js +132 -0
  317. package/dist/react-native/models/index.js.map +1 -0
  318. package/dist/react-native/models/mappers.d.ts +60 -0
  319. package/dist/react-native/models/mappers.d.ts.map +1 -0
  320. package/dist/react-native/models/mappers.js +1837 -0
  321. package/dist/react-native/models/mappers.js.map +1 -0
  322. package/dist/react-native/models/parameters.d.ts +26 -0
  323. package/dist/react-native/models/parameters.d.ts.map +1 -0
  324. package/dist/react-native/models/parameters.js +230 -0
  325. package/dist/react-native/models/parameters.js.map +1 -0
  326. package/dist/react-native/operations/adminKeys.d.ts +33 -0
  327. package/dist/react-native/operations/adminKeys.d.ts.map +1 -0
  328. package/dist/react-native/operations/adminKeys.js +90 -0
  329. package/dist/react-native/operations/adminKeys.js.map +1 -0
  330. package/dist/react-native/operations/index.d.ts +10 -0
  331. package/dist/react-native/operations/index.d.ts.map +1 -0
  332. package/dist/react-native/operations/index.js +17 -0
  333. package/dist/react-native/operations/index.js.map +1 -0
  334. package/dist/react-native/operations/networkSecurityPerimeterConfigurations.d.ts +79 -0
  335. package/dist/react-native/operations/networkSecurityPerimeterConfigurations.d.ts.map +1 -0
  336. package/dist/react-native/operations/networkSecurityPerimeterConfigurations.js +285 -0
  337. package/dist/react-native/operations/networkSecurityPerimeterConfigurations.js.map +1 -0
  338. package/dist/react-native/operations/operations.d.ts +26 -0
  339. package/dist/react-native/operations/operations.d.ts.map +1 -0
  340. package/dist/react-native/operations/operations.js +96 -0
  341. package/dist/react-native/operations/operations.js.map +1 -0
  342. package/dist/react-native/operations/privateEndpointConnections.d.ts +79 -0
  343. package/dist/react-native/operations/privateEndpointConnections.d.ts.map +1 -0
  344. package/dist/react-native/operations/privateEndpointConnections.js +286 -0
  345. package/dist/react-native/operations/privateEndpointConnections.js.map +1 -0
  346. package/dist/react-native/operations/privateLinkResources.d.ts +34 -0
  347. package/dist/react-native/operations/privateLinkResources.d.ts.map +1 -0
  348. package/dist/react-native/operations/privateLinkResources.js +109 -0
  349. package/dist/react-native/operations/privateLinkResources.js.map +1 -0
  350. package/dist/react-native/operations/queryKeys.d.ts +66 -0
  351. package/dist/react-native/operations/queryKeys.d.ts.map +1 -0
  352. package/dist/react-native/operations/queryKeys.js +226 -0
  353. package/dist/react-native/operations/queryKeys.js.map +1 -0
  354. package/dist/react-native/operations/services.d.ts +123 -0
  355. package/dist/react-native/operations/services.d.ts.map +1 -0
  356. package/dist/react-native/operations/services.js +502 -0
  357. package/dist/react-native/operations/services.js.map +1 -0
  358. package/dist/react-native/operations/sharedPrivateLinkResources.d.ts +107 -0
  359. package/dist/react-native/operations/sharedPrivateLinkResources.d.ts.map +1 -0
  360. package/dist/react-native/operations/sharedPrivateLinkResources.js +396 -0
  361. package/dist/react-native/operations/sharedPrivateLinkResources.js.map +1 -0
  362. package/dist/react-native/operations/usages.d.ts +35 -0
  363. package/dist/react-native/operations/usages.d.ts.map +1 -0
  364. package/dist/react-native/operations/usages.js +145 -0
  365. package/dist/react-native/operations/usages.js.map +1 -0
  366. package/dist/react-native/operationsInterfaces/adminKeys.d.ts +25 -0
  367. package/dist/react-native/operationsInterfaces/adminKeys.d.ts.map +1 -0
  368. package/dist/react-native/operationsInterfaces/adminKeys.js +9 -0
  369. package/dist/react-native/operationsInterfaces/adminKeys.js.map +1 -0
  370. package/dist/react-native/operationsInterfaces/index.d.ts +10 -0
  371. package/dist/react-native/operationsInterfaces/index.d.ts.map +1 -0
  372. package/dist/react-native/operationsInterfaces/index.js +17 -0
  373. package/dist/react-native/operationsInterfaces/index.js.map +1 -0
  374. package/dist/react-native/operationsInterfaces/networkSecurityPerimeterConfigurations.d.ts +50 -0
  375. package/dist/react-native/operationsInterfaces/networkSecurityPerimeterConfigurations.d.ts.map +1 -0
  376. package/dist/react-native/operationsInterfaces/networkSecurityPerimeterConfigurations.js +9 -0
  377. package/dist/react-native/operationsInterfaces/networkSecurityPerimeterConfigurations.js.map +1 -0
  378. package/dist/react-native/operationsInterfaces/operations.d.ts +11 -0
  379. package/dist/react-native/operationsInterfaces/operations.d.ts.map +1 -0
  380. package/dist/react-native/operationsInterfaces/operations.js +9 -0
  381. package/dist/react-native/operationsInterfaces/operations.js.map +1 -0
  382. package/dist/react-native/operationsInterfaces/privateEndpointConnections.d.ts +50 -0
  383. package/dist/react-native/operationsInterfaces/privateEndpointConnections.d.ts.map +1 -0
  384. package/dist/react-native/operationsInterfaces/privateEndpointConnections.js +9 -0
  385. package/dist/react-native/operationsInterfaces/privateEndpointConnections.js.map +1 -0
  386. package/dist/react-native/operationsInterfaces/privateLinkResources.d.ts +15 -0
  387. package/dist/react-native/operationsInterfaces/privateLinkResources.d.ts.map +1 -0
  388. package/dist/react-native/operationsInterfaces/privateLinkResources.js +9 -0
  389. package/dist/react-native/operationsInterfaces/privateLinkResources.js.map +1 -0
  390. package/dist/react-native/operationsInterfaces/queryKeys.d.ts +37 -0
  391. package/dist/react-native/operationsInterfaces/queryKeys.d.ts.map +1 -0
  392. package/dist/react-native/operationsInterfaces/queryKeys.js +9 -0
  393. package/dist/react-native/operationsInterfaces/queryKeys.js.map +1 -0
  394. package/dist/react-native/operationsInterfaces/services.d.ts +85 -0
  395. package/dist/react-native/operationsInterfaces/services.d.ts.map +1 -0
  396. package/dist/react-native/operationsInterfaces/services.js +9 -0
  397. package/dist/react-native/operationsInterfaces/services.js.map +1 -0
  398. package/dist/react-native/operationsInterfaces/sharedPrivateLinkResources.d.ts +78 -0
  399. package/dist/react-native/operationsInterfaces/sharedPrivateLinkResources.d.ts.map +1 -0
  400. package/dist/react-native/operationsInterfaces/sharedPrivateLinkResources.js +9 -0
  401. package/dist/react-native/operationsInterfaces/sharedPrivateLinkResources.js.map +1 -0
  402. package/dist/react-native/operationsInterfaces/usages.d.ts +12 -0
  403. package/dist/react-native/operationsInterfaces/usages.d.ts.map +1 -0
  404. package/dist/react-native/operationsInterfaces/usages.js +9 -0
  405. package/dist/react-native/operationsInterfaces/usages.js.map +1 -0
  406. package/dist/react-native/package.json +3 -0
  407. package/dist/react-native/pagingHelper.d.ts +13 -0
  408. package/dist/react-native/pagingHelper.d.ts.map +1 -0
  409. package/dist/react-native/pagingHelper.js +32 -0
  410. package/dist/react-native/pagingHelper.js.map +1 -0
  411. package/dist/react-native/searchManagementClient.d.ts +36 -0
  412. package/dist/react-native/searchManagementClient.d.ts.map +1 -0
  413. package/dist/react-native/searchManagementClient.js +141 -0
  414. package/dist/react-native/searchManagementClient.js.map +1 -0
  415. package/package.json +67 -37
  416. package/dist/index.js +0 -4571
  417. package/dist/index.js.map +0 -1
  418. package/dist/index.min.js +0 -1
  419. package/dist/index.min.js.map +0 -1
  420. package/dist-esm/samples-dev/adminKeysGetSample.d.ts +0 -2
  421. package/dist-esm/samples-dev/adminKeysGetSample.d.ts.map +0 -1
  422. package/dist-esm/samples-dev/adminKeysGetSample.js +0 -36
  423. package/dist-esm/samples-dev/adminKeysGetSample.js.map +0 -1
  424. package/dist-esm/samples-dev/adminKeysRegenerateSample.d.ts +0 -2
  425. package/dist-esm/samples-dev/adminKeysRegenerateSample.d.ts.map +0 -1
  426. package/dist-esm/samples-dev/adminKeysRegenerateSample.js +0 -37
  427. package/dist-esm/samples-dev/adminKeysRegenerateSample.js.map +0 -1
  428. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsGetSample.d.ts +0 -2
  429. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsGetSample.d.ts.map +0 -1
  430. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsGetSample.js +0 -37
  431. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsGetSample.js.map +0 -1
  432. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsListByServiceSample.d.ts +0 -2
  433. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsListByServiceSample.d.ts.map +0 -1
  434. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsListByServiceSample.js +0 -52
  435. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsListByServiceSample.js.map +0 -1
  436. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsReconcileSample.d.ts +0 -2
  437. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsReconcileSample.d.ts.map +0 -1
  438. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsReconcileSample.js +0 -37
  439. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsReconcileSample.js.map +0 -1
  440. package/dist-esm/samples-dev/operationsListSample.d.ts +0 -2
  441. package/dist-esm/samples-dev/operationsListSample.d.ts.map +0 -1
  442. package/dist-esm/samples-dev/operationsListSample.js +0 -50
  443. package/dist-esm/samples-dev/operationsListSample.js.map +0 -1
  444. package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.d.ts +0 -2
  445. package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.d.ts.map +0 -1
  446. package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.js +0 -37
  447. package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.js.map +0 -1
  448. package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.d.ts +0 -2
  449. package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.d.ts.map +0 -1
  450. package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.js +0 -37
  451. package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.js.map +0 -1
  452. package/dist-esm/samples-dev/privateEndpointConnectionsListByServiceSample.d.ts +0 -2
  453. package/dist-esm/samples-dev/privateEndpointConnectionsListByServiceSample.d.ts.map +0 -1
  454. package/dist-esm/samples-dev/privateEndpointConnectionsListByServiceSample.js +0 -52
  455. package/dist-esm/samples-dev/privateEndpointConnectionsListByServiceSample.js.map +0 -1
  456. package/dist-esm/samples-dev/privateEndpointConnectionsUpdateSample.d.ts +0 -2
  457. package/dist-esm/samples-dev/privateEndpointConnectionsUpdateSample.d.ts.map +0 -1
  458. package/dist-esm/samples-dev/privateEndpointConnectionsUpdateSample.js +0 -38
  459. package/dist-esm/samples-dev/privateEndpointConnectionsUpdateSample.js.map +0 -1
  460. package/dist-esm/samples-dev/privateLinkResourcesListSupportedSample.d.ts +0 -2
  461. package/dist-esm/samples-dev/privateLinkResourcesListSupportedSample.d.ts.map +0 -1
  462. package/dist-esm/samples-dev/privateLinkResourcesListSupportedSample.js +0 -52
  463. package/dist-esm/samples-dev/privateLinkResourcesListSupportedSample.js.map +0 -1
  464. package/dist-esm/samples-dev/queryKeysCreateSample.d.ts +0 -2
  465. package/dist-esm/samples-dev/queryKeysCreateSample.d.ts.map +0 -1
  466. package/dist-esm/samples-dev/queryKeysCreateSample.js +0 -37
  467. package/dist-esm/samples-dev/queryKeysCreateSample.js.map +0 -1
  468. package/dist-esm/samples-dev/queryKeysDeleteSample.d.ts +0 -2
  469. package/dist-esm/samples-dev/queryKeysDeleteSample.d.ts.map +0 -1
  470. package/dist-esm/samples-dev/queryKeysDeleteSample.js +0 -37
  471. package/dist-esm/samples-dev/queryKeysDeleteSample.js.map +0 -1
  472. package/dist-esm/samples-dev/queryKeysListBySearchServiceSample.d.ts +0 -2
  473. package/dist-esm/samples-dev/queryKeysListBySearchServiceSample.d.ts.map +0 -1
  474. package/dist-esm/samples-dev/queryKeysListBySearchServiceSample.js +0 -52
  475. package/dist-esm/samples-dev/queryKeysListBySearchServiceSample.js.map +0 -1
  476. package/dist-esm/samples-dev/servicesCheckNameAvailabilitySample.d.ts +0 -2
  477. package/dist-esm/samples-dev/servicesCheckNameAvailabilitySample.d.ts.map +0 -1
  478. package/dist-esm/samples-dev/servicesCheckNameAvailabilitySample.js +0 -35
  479. package/dist-esm/samples-dev/servicesCheckNameAvailabilitySample.js.map +0 -1
  480. package/dist-esm/samples-dev/servicesCreateOrUpdateSample.d.ts +0 -2
  481. package/dist-esm/samples-dev/servicesCreateOrUpdateSample.d.ts.map +0 -1
  482. package/dist-esm/samples-dev/servicesCreateOrUpdateSample.js +0 -292
  483. package/dist-esm/samples-dev/servicesCreateOrUpdateSample.js.map +0 -1
  484. package/dist-esm/samples-dev/servicesDeleteSample.d.ts +0 -2
  485. package/dist-esm/samples-dev/servicesDeleteSample.d.ts.map +0 -1
  486. package/dist-esm/samples-dev/servicesDeleteSample.js +0 -36
  487. package/dist-esm/samples-dev/servicesDeleteSample.js.map +0 -1
  488. package/dist-esm/samples-dev/servicesGetSample.d.ts +0 -2
  489. package/dist-esm/samples-dev/servicesGetSample.d.ts.map +0 -1
  490. package/dist-esm/samples-dev/servicesGetSample.js +0 -36
  491. package/dist-esm/samples-dev/servicesGetSample.js.map +0 -1
  492. package/dist-esm/samples-dev/servicesListByResourceGroupSample.d.ts +0 -2
  493. package/dist-esm/samples-dev/servicesListByResourceGroupSample.d.ts.map +0 -1
  494. package/dist-esm/samples-dev/servicesListByResourceGroupSample.js +0 -51
  495. package/dist-esm/samples-dev/servicesListByResourceGroupSample.js.map +0 -1
  496. package/dist-esm/samples-dev/servicesListBySubscriptionSample.d.ts +0 -2
  497. package/dist-esm/samples-dev/servicesListBySubscriptionSample.d.ts.map +0 -1
  498. package/dist-esm/samples-dev/servicesListBySubscriptionSample.js +0 -50
  499. package/dist-esm/samples-dev/servicesListBySubscriptionSample.js.map +0 -1
  500. package/dist-esm/samples-dev/servicesUpdateSample.d.ts +0 -2
  501. package/dist-esm/samples-dev/servicesUpdateSample.d.ts.map +0 -1
  502. package/dist-esm/samples-dev/servicesUpdateSample.js +0 -248
  503. package/dist-esm/samples-dev/servicesUpdateSample.js.map +0 -1
  504. package/dist-esm/samples-dev/sharedPrivateLinkResourcesCreateOrUpdateSample.d.ts +0 -2
  505. package/dist-esm/samples-dev/sharedPrivateLinkResourcesCreateOrUpdateSample.d.ts.map +0 -1
  506. package/dist-esm/samples-dev/sharedPrivateLinkResourcesCreateOrUpdateSample.js +0 -38
  507. package/dist-esm/samples-dev/sharedPrivateLinkResourcesCreateOrUpdateSample.js.map +0 -1
  508. package/dist-esm/samples-dev/sharedPrivateLinkResourcesDeleteSample.d.ts +0 -2
  509. package/dist-esm/samples-dev/sharedPrivateLinkResourcesDeleteSample.d.ts.map +0 -1
  510. package/dist-esm/samples-dev/sharedPrivateLinkResourcesDeleteSample.js +0 -37
  511. package/dist-esm/samples-dev/sharedPrivateLinkResourcesDeleteSample.js.map +0 -1
  512. package/dist-esm/samples-dev/sharedPrivateLinkResourcesGetSample.d.ts +0 -2
  513. package/dist-esm/samples-dev/sharedPrivateLinkResourcesGetSample.d.ts.map +0 -1
  514. package/dist-esm/samples-dev/sharedPrivateLinkResourcesGetSample.js +0 -37
  515. package/dist-esm/samples-dev/sharedPrivateLinkResourcesGetSample.js.map +0 -1
  516. package/dist-esm/samples-dev/sharedPrivateLinkResourcesListByServiceSample.d.ts +0 -2
  517. package/dist-esm/samples-dev/sharedPrivateLinkResourcesListByServiceSample.d.ts.map +0 -1
  518. package/dist-esm/samples-dev/sharedPrivateLinkResourcesListByServiceSample.js +0 -52
  519. package/dist-esm/samples-dev/sharedPrivateLinkResourcesListByServiceSample.js.map +0 -1
  520. package/dist-esm/samples-dev/usageBySubscriptionSkuSample.d.ts +0 -2
  521. package/dist-esm/samples-dev/usageBySubscriptionSkuSample.d.ts.map +0 -1
  522. package/dist-esm/samples-dev/usageBySubscriptionSkuSample.js +0 -36
  523. package/dist-esm/samples-dev/usageBySubscriptionSkuSample.js.map +0 -1
  524. package/dist-esm/samples-dev/usagesListBySubscriptionSample.d.ts +0 -2
  525. package/dist-esm/samples-dev/usagesListBySubscriptionSample.d.ts.map +0 -1
  526. package/dist-esm/samples-dev/usagesListBySubscriptionSample.js +0 -51
  527. package/dist-esm/samples-dev/usagesListBySubscriptionSample.js.map +0 -1
  528. package/dist-esm/src/index.d.ts +0 -5
  529. package/dist-esm/src/index.js.map +0 -1
  530. package/dist-esm/src/lroImpl.js.map +0 -1
  531. package/dist-esm/src/models/index.js.map +0 -1
  532. package/dist-esm/src/models/mappers.js.map +0 -1
  533. package/dist-esm/src/models/parameters.js.map +0 -1
  534. package/dist-esm/src/operations/adminKeys.d.ts.map +0 -1
  535. package/dist-esm/src/operations/adminKeys.js.map +0 -1
  536. package/dist-esm/src/operations/index.d.ts +0 -10
  537. package/dist-esm/src/operations/index.d.ts.map +0 -1
  538. package/dist-esm/src/operations/index.js +0 -17
  539. package/dist-esm/src/operations/index.js.map +0 -1
  540. package/dist-esm/src/operations/networkSecurityPerimeterConfigurations.d.ts.map +0 -1
  541. package/dist-esm/src/operations/networkSecurityPerimeterConfigurations.js.map +0 -1
  542. package/dist-esm/src/operations/operations.d.ts.map +0 -1
  543. package/dist-esm/src/operations/operations.js.map +0 -1
  544. package/dist-esm/src/operations/privateEndpointConnections.d.ts.map +0 -1
  545. package/dist-esm/src/operations/privateEndpointConnections.js.map +0 -1
  546. package/dist-esm/src/operations/privateLinkResources.d.ts.map +0 -1
  547. package/dist-esm/src/operations/privateLinkResources.js.map +0 -1
  548. package/dist-esm/src/operations/queryKeys.d.ts.map +0 -1
  549. package/dist-esm/src/operations/queryKeys.js.map +0 -1
  550. package/dist-esm/src/operations/services.d.ts.map +0 -1
  551. package/dist-esm/src/operations/services.js.map +0 -1
  552. package/dist-esm/src/operations/sharedPrivateLinkResources.d.ts.map +0 -1
  553. package/dist-esm/src/operations/sharedPrivateLinkResources.js.map +0 -1
  554. package/dist-esm/src/operations/usages.d.ts.map +0 -1
  555. package/dist-esm/src/operations/usages.js.map +0 -1
  556. package/dist-esm/src/operationsInterfaces/adminKeys.d.ts.map +0 -1
  557. package/dist-esm/src/operationsInterfaces/adminKeys.js.map +0 -1
  558. package/dist-esm/src/operationsInterfaces/index.d.ts +0 -10
  559. package/dist-esm/src/operationsInterfaces/index.d.ts.map +0 -1
  560. package/dist-esm/src/operationsInterfaces/index.js +0 -17
  561. package/dist-esm/src/operationsInterfaces/index.js.map +0 -1
  562. package/dist-esm/src/operationsInterfaces/networkSecurityPerimeterConfigurations.d.ts.map +0 -1
  563. package/dist-esm/src/operationsInterfaces/networkSecurityPerimeterConfigurations.js.map +0 -1
  564. package/dist-esm/src/operationsInterfaces/operations.js.map +0 -1
  565. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts.map +0 -1
  566. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.js.map +0 -1
  567. package/dist-esm/src/operationsInterfaces/privateLinkResources.d.ts.map +0 -1
  568. package/dist-esm/src/operationsInterfaces/privateLinkResources.js.map +0 -1
  569. package/dist-esm/src/operationsInterfaces/queryKeys.d.ts.map +0 -1
  570. package/dist-esm/src/operationsInterfaces/queryKeys.js.map +0 -1
  571. package/dist-esm/src/operationsInterfaces/services.d.ts.map +0 -1
  572. package/dist-esm/src/operationsInterfaces/services.js.map +0 -1
  573. package/dist-esm/src/operationsInterfaces/sharedPrivateLinkResources.d.ts.map +0 -1
  574. package/dist-esm/src/operationsInterfaces/sharedPrivateLinkResources.js.map +0 -1
  575. package/dist-esm/src/operationsInterfaces/usages.d.ts.map +0 -1
  576. package/dist-esm/src/operationsInterfaces/usages.js.map +0 -1
  577. package/dist-esm/src/pagingHelper.js.map +0 -1
  578. package/dist-esm/src/searchManagementClient.d.ts.map +0 -1
  579. package/dist-esm/src/searchManagementClient.js.map +0 -1
  580. package/dist-esm/test/search_examples.d.ts +0 -4
  581. package/dist-esm/test/search_examples.d.ts.map +0 -1
  582. package/dist-esm/test/search_examples.js +0 -228
  583. package/dist-esm/test/search_examples.js.map +0 -1
  584. package/src/lroImpl.ts +0 -38
  585. package/src/models/index.ts +0 -1449
  586. package/src/models/mappers.ts +0 -1969
  587. package/src/models/parameters.ts +0 -267
  588. package/src/operations/adminKeys.ts +0 -120
  589. package/src/operations/index.ts +0 -17
  590. package/src/operations/networkSecurityPerimeterConfigurations.ts +0 -400
  591. package/src/operations/operations.ts +0 -103
  592. package/src/operations/privateEndpointConnections.ts +0 -373
  593. package/src/operations/privateLinkResources.ts +0 -144
  594. package/src/operations/queryKeys.ts +0 -298
  595. package/src/operations/services.ts +0 -634
  596. package/src/operations/sharedPrivateLinkResources.ts +0 -544
  597. package/src/operations/usages.ts +0 -176
  598. package/src/operationsInterfaces/adminKeys.ts +0 -48
  599. package/src/operationsInterfaces/index.ts +0 -17
  600. package/src/operationsInterfaces/networkSecurityPerimeterConfigurations.ts +0 -90
  601. package/src/operationsInterfaces/operations.ts +0 -22
  602. package/src/operationsInterfaces/privateEndpointConnections.ts +0 -88
  603. package/src/operationsInterfaces/privateLinkResources.ts +0 -31
  604. package/src/operationsInterfaces/queryKeys.ts +0 -66
  605. package/src/operationsInterfaces/services.ts +0 -144
  606. package/src/operationsInterfaces/sharedPrivateLinkResources.ts +0 -131
  607. package/src/operationsInterfaces/usages.ts +0 -27
  608. package/src/pagingHelper.ts +0 -39
  609. package/src/searchManagementClient.ts +0 -226
  610. package/tsconfig.json +0 -33
  611. /package/{dist-esm/src → dist/browser}/lroImpl.d.ts +0 -0
  612. /package/{dist-esm/src → dist/browser}/lroImpl.d.ts.map +0 -0
  613. /package/{dist-esm/src → dist/browser}/lroImpl.js +0 -0
  614. /package/{dist-esm/src → dist/browser}/models/index.d.ts +0 -0
  615. /package/{dist-esm/src → dist/browser}/models/index.d.ts.map +0 -0
  616. /package/{dist-esm/src → dist/browser}/models/index.js +0 -0
  617. /package/{dist-esm/src → dist/browser}/models/mappers.d.ts +0 -0
  618. /package/{dist-esm/src → dist/browser}/models/mappers.d.ts.map +0 -0
  619. /package/{dist-esm/src → dist/browser}/models/mappers.js +0 -0
  620. /package/{dist-esm/src → dist/browser}/models/parameters.d.ts +0 -0
  621. /package/{dist-esm/src → dist/browser}/models/parameters.d.ts.map +0 -0
  622. /package/{dist-esm/src → dist/browser}/operationsInterfaces/adminKeys.js +0 -0
  623. /package/{dist-esm/src → dist/browser}/operationsInterfaces/networkSecurityPerimeterConfigurations.js +0 -0
  624. /package/{dist-esm/src → dist/browser}/operationsInterfaces/operations.js +0 -0
  625. /package/{dist-esm/src → dist/browser}/operationsInterfaces/privateEndpointConnections.js +0 -0
  626. /package/{dist-esm/src → dist/browser}/operationsInterfaces/privateLinkResources.js +0 -0
  627. /package/{dist-esm/src → dist/browser}/operationsInterfaces/queryKeys.js +0 -0
  628. /package/{dist-esm/src → dist/browser}/operationsInterfaces/services.js +0 -0
  629. /package/{dist-esm/src → dist/browser}/operationsInterfaces/sharedPrivateLinkResources.js +0 -0
  630. /package/{dist-esm/src → dist/browser}/operationsInterfaces/usages.js +0 -0
  631. /package/{dist-esm/src → dist/browser}/pagingHelper.d.ts +0 -0
  632. /package/{dist-esm/src → dist/browser}/pagingHelper.d.ts.map +0 -0
  633. /package/{dist-esm/src → dist/browser}/pagingHelper.js +0 -0
  634. /package/{types → dist/commonjs}/tsdoc-metadata.json +0 -0
@@ -1,1791 +1,1247 @@
1
- import * as coreAuth from '@azure/core-auth';
2
- import * as coreClient from '@azure/core-client';
3
- import { OperationState } from '@azure/core-lro';
4
- import { PagedAsyncIterableIterator } from '@azure/core-paging';
5
- import { SimplePollerLike } from '@azure/core-lro';
6
-
7
- /** Defines values for AadAuthFailureMode. */
8
- export declare type AadAuthFailureMode = "http403" | "http401WithBearerChallenge";
9
-
10
- /** Defines values for AdminKeyKind. */
11
- export declare type AdminKeyKind = "primary" | "secondary";
12
-
13
- /** Response containing the primary and secondary admin API keys for a given Azure AI Search service. */
14
- export declare interface AdminKeyResult {
15
- /**
16
- * The primary admin API key of the search service.
17
- * NOTE: This property will not be serialized. It can only be populated by the server.
18
- */
19
- readonly primaryKey?: string;
20
- /**
21
- * The secondary admin API key of the search service.
22
- * NOTE: This property will not be serialized. It can only be populated by the server.
23
- */
24
- readonly secondaryKey?: string;
25
- }
26
-
27
- /** Interface representing a AdminKeys. */
28
- export declare interface AdminKeys {
29
- /**
30
- * Gets the primary and secondary admin API keys for the specified Azure AI Search service.
31
- * @param resourceGroupName The name of the resource group within the current subscription. You can
32
- * obtain this value from the Azure Resource Manager API or the portal.
33
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
34
- * resource group.
35
- * @param options The options parameters.
36
- */
37
- get(resourceGroupName: string, searchServiceName: string, options?: AdminKeysGetOptionalParams): Promise<AdminKeysGetResponse>;
38
- /**
39
- * Regenerates either the primary or secondary admin API key. You can only regenerate one key at a
40
- * time.
41
- * @param resourceGroupName The name of the resource group within the current subscription. You can
42
- * obtain this value from the Azure Resource Manager API or the portal.
43
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
44
- * resource group.
45
- * @param keyKind Specifies which key to regenerate. Valid values include 'primary' and 'secondary'.
46
- * @param options The options parameters.
47
- */
48
- regenerate(resourceGroupName: string, searchServiceName: string, keyKind: AdminKeyKind, options?: AdminKeysRegenerateOptionalParams): Promise<AdminKeysRegenerateResponse>;
49
- }
50
-
51
- /** Optional parameters. */
52
- export declare interface AdminKeysGetOptionalParams extends coreClient.OperationOptions {
53
- /** Parameter group */
54
- searchManagementRequestOptions?: SearchManagementRequestOptions;
55
- }
56
-
57
- /** Contains response data for the get operation. */
58
- export declare type AdminKeysGetResponse = AdminKeyResult;
59
-
60
- /** Optional parameters. */
61
- export declare interface AdminKeysRegenerateOptionalParams extends coreClient.OperationOptions {
62
- /** Parameter group */
63
- searchManagementRequestOptions?: SearchManagementRequestOptions;
64
- }
65
-
66
- /** Contains response data for the regenerate operation. */
67
- export declare type AdminKeysRegenerateResponse = AdminKeyResult;
68
-
69
- /** The details of a long running asynchronous shared private link resource operation. */
70
- export declare interface AsyncOperationResult {
71
- /** The current status of the long running asynchronous shared private link resource operation. */
72
- status?: SharedPrivateLinkResourceAsyncOperationResult;
73
- }
74
-
75
- /** Input of check name availability API. */
76
- export declare interface CheckNameAvailabilityInput {
77
- /** The search service name to validate. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. */
78
- name: string;
79
- /** The type of the resource whose name is to be validated. This value must always be 'searchServices'. */
80
- type: "searchServices";
81
- }
82
-
83
- /** Output of check name availability API. */
84
- export declare interface CheckNameAvailabilityOutput {
85
- /**
86
- * A value indicating whether the name is available.
87
- * NOTE: This property will not be serialized. It can only be populated by the server.
88
- */
89
- readonly isNameAvailable?: boolean;
90
- /**
91
- * The reason why the name is not available. 'Invalid' indicates the name provided does not match the naming requirements (incorrect length, unsupported characters, etc.). 'AlreadyExists' indicates that the name is already in use and is therefore unavailable.
92
- * NOTE: This property will not be serialized. It can only be populated by the server.
93
- */
94
- readonly reason?: UnavailableNameReason;
95
- /**
96
- * A message that explains why the name is invalid and provides resource naming requirements. Available only if 'Invalid' is returned in the 'reason' property.
97
- * NOTE: This property will not be serialized. It can only be populated by the server.
98
- */
99
- readonly message?: string;
100
- }
101
-
102
- /** Contains information about an API error. */
103
- export declare interface CloudError {
104
- /** Describes a particular API error with an error code and a message. */
105
- error?: CloudErrorBody;
106
- /** A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). */
107
- message?: string;
108
- }
109
-
110
- /** Describes a particular API error with an error code and a message. */
111
- export declare interface CloudErrorBody {
112
- /** An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. */
113
- code?: string;
114
- /** A message that describes the error in detail and provides debugging information. */
115
- message?: string;
116
- /** The target of the particular error (for example, the name of the property in error). */
117
- target?: string;
118
- /** Contains nested errors that are related to this error. */
119
- details?: CloudErrorBody[];
120
- }
121
-
122
- /** Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. */
123
- export declare interface DataPlaneAadOrApiKeyAuthOption {
124
- /** Describes what response the data plane API of a search service would send for requests that failed authentication. */
125
- aadAuthFailureMode?: AadAuthFailureMode;
126
- }
127
-
128
- /** Defines the options for how the search service authenticates a data plane request. This cannot be set if 'disableLocalAuth' is set to true. */
129
- export declare interface DataPlaneAuthOptions {
130
- /** Indicates that only the API key can be used for authentication. */
131
- apiKeyOnly?: Record<string, unknown>;
132
- /** Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. */
133
- aadOrApiKey?: DataPlaneAadOrApiKeyAuthOption;
134
- }
135
-
136
- /** Describes a policy that determines how resources within the search service are to be encrypted with customer managed keys. */
137
- export declare interface EncryptionWithCmk {
138
- /** Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. */
139
- enforcement?: SearchEncryptionWithCmk;
140
- /**
141
- * Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.
142
- * NOTE: This property will not be serialized. It can only be populated by the server.
143
- */
144
- readonly encryptionComplianceStatus?: SearchEncryptionComplianceStatus;
145
- }
146
-
147
- /**
148
- * Given the last `.value` produced by the `byPage` iterator,
149
- * returns a continuation token that can be used to begin paging from
150
- * that point later.
151
- * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
152
- * @returns The continuation token that can be passed into byPage() during future calls.
153
- */
154
- export declare function getContinuationToken(page: unknown): string | undefined;
155
-
156
- /** Defines values for HostingMode. */
157
- export declare type HostingMode = "default" | "highDensity";
158
-
159
- /** Details about the search service identity. A null value indicates that the search service has no identity assigned. */
160
- export declare interface Identity {
161
- /**
162
- * The principal ID of the system-assigned identity of the search service.
163
- * NOTE: This property will not be serialized. It can only be populated by the server.
164
- */
165
- readonly principalId?: string;
166
- /**
167
- * The tenant ID of the system-assigned identity of the search service.
168
- * NOTE: This property will not be serialized. It can only be populated by the server.
169
- */
170
- readonly tenantId?: string;
171
- /** The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service. */
172
- type: IdentityType;
173
- /** The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */
174
- userAssignedIdentities?: {
175
- [propertyName: string]: UserAssignedManagedIdentity;
176
- };
177
- }
178
-
179
- /**
180
- * Defines values for IdentityType. \
181
- * {@link KnownIdentityType} can be used interchangeably with IdentityType,
182
- * this enum contains the known values that the service supports.
183
- * ### Known values supported by the service
184
- * **None**: Indicates that any identity associated with the search service needs to be removed. \
185
- * **SystemAssigned**: Indicates that system-assigned identity for the search service will be enabled. \
186
- * **UserAssigned**: Indicates that one or more user assigned identities will be assigned to the search service. \
187
- * **SystemAssigned, UserAssigned**: Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities.
188
- */
189
- export declare type IdentityType = string;
190
-
191
- /** The IP restriction rule of the Azure AI Search service. */
192
- export declare interface IpRule {
193
- /** Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed. */
194
- value?: string;
195
- }
196
-
197
- /** Known values of {@link IdentityType} that the service accepts. */
198
- export declare enum KnownIdentityType {
199
- /** Indicates that any identity associated with the search service needs to be removed. */
200
- None = "None",
201
- /** Indicates that system-assigned identity for the search service will be enabled. */
202
- SystemAssigned = "SystemAssigned",
203
- /** Indicates that one or more user assigned identities will be assigned to the search service. */
204
- UserAssigned = "UserAssigned",
205
- /** Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. */
206
- SystemAssignedUserAssigned = "SystemAssigned, UserAssigned"
207
- }
208
-
209
- /** Known values of {@link PrivateLinkServiceConnectionProvisioningState} that the service accepts. */
210
- export declare enum KnownPrivateLinkServiceConnectionProvisioningState {
211
- /** The private link service connection is in the process of being created along with other resources for it to be fully functional. */
212
- Updating = "Updating",
213
- /** The private link service connection is in the process of being deleted. */
214
- Deleting = "Deleting",
215
- /** The private link service connection has failed to be provisioned or deleted. */
216
- Failed = "Failed",
217
- /** The private link service connection has finished provisioning and is ready for approval. */
218
- Succeeded = "Succeeded",
219
- /** Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. */
220
- Incomplete = "Incomplete",
221
- /** Provisioning request for the private link service connection resource has been canceled. */
222
- Canceled = "Canceled"
223
- }
224
-
225
- /** Known values of {@link PublicNetworkAccess} that the service accepts. */
226
- export declare enum KnownPublicNetworkAccess {
227
- /** The search service is accessible from traffic originating from the public internet. */
228
- Enabled = "enabled",
229
- /** The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. */
230
- Disabled = "disabled"
231
- }
232
-
233
- /** Known values of {@link SearchBypass} that the service accepts. */
234
- export declare enum KnownSearchBypass {
235
- /** Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. */
236
- None = "None",
237
- /** Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. */
238
- AzurePortal = "AzurePortal",
239
- /** Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section. */
240
- AzureServices = "AzureServices"
241
- }
242
-
243
- /** Known values of {@link SearchDisabledDataExfiltrationOption} that the service accepts. */
244
- export declare enum KnownSearchDisabledDataExfiltrationOption {
245
- /** Indicates that all data exfiltration scenarios are disabled. */
246
- All = "All"
247
- }
248
-
249
- /** Known values of {@link SearchSemanticSearch} that the service accepts. */
250
- export declare enum KnownSearchSemanticSearch {
251
- /** Indicates that semantic reranker is disabled for the search service. This is the default. */
252
- Disabled = "disabled",
253
- /** Enables semantic reranker on a search service and indicates that it is to be used within the limits of the free plan. The free plan would cap the volume of semantic ranking requests and is offered at no extra charge. This is the default for newly provisioned search services. */
254
- Free = "free",
255
- /** Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. */
256
- Standard = "standard"
257
- }
258
-
259
- /** Known values of {@link SharedPrivateLinkResourceAsyncOperationResult} that the service accepts. */
260
- export declare enum KnownSharedPrivateLinkResourceAsyncOperationResult {
261
- /** Running */
262
- Running = "Running",
263
- /** Succeeded */
264
- Succeeded = "Succeeded",
265
- /** Failed */
266
- Failed = "Failed"
267
- }
268
-
269
- /** Known values of {@link SharedPrivateLinkResourceProvisioningState} that the service accepts. */
270
- export declare enum KnownSharedPrivateLinkResourceProvisioningState {
271
- /** The shared private link resource is in the process of being created along with other resources for it to be fully functional. */
272
- Updating = "Updating",
273
- /** The shared private link resource is in the process of being deleted. */
274
- Deleting = "Deleting",
275
- /** The shared private link resource has failed to be provisioned or deleted. */
276
- Failed = "Failed",
277
- /** The shared private link resource has finished provisioning and is ready for approval. */
278
- Succeeded = "Succeeded",
279
- /** Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. */
280
- Incomplete = "Incomplete"
281
- }
282
-
283
- /** Known values of {@link SharedPrivateLinkResourceStatus} that the service accepts. */
284
- export declare enum KnownSharedPrivateLinkResourceStatus {
285
- /** The shared private link resource has been created and is pending approval. */
286
- Pending = "Pending",
287
- /** The shared private link resource is approved and is ready for use. */
288
- Approved = "Approved",
289
- /** The shared private link resource has been rejected and cannot be used. */
290
- Rejected = "Rejected",
291
- /** The shared private link resource has been removed from the service. */
292
- Disconnected = "Disconnected"
293
- }
294
-
295
- /** Known values of {@link SkuName} that the service accepts. */
296
- export declare enum KnownSkuName {
297
- /** Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. */
298
- Free = "free",
299
- /** Billable tier for a dedicated service having up to 3 replicas. */
300
- Basic = "basic",
301
- /** Billable tier for a dedicated service having up to 12 partitions and 12 replicas. */
302
- Standard = "standard",
303
- /** Similar to 'standard', but with more capacity per search unit. */
304
- Standard2 = "standard2",
305
- /** The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). */
306
- Standard3 = "standard3",
307
- /** Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions. */
308
- StorageOptimizedL1 = "storage_optimized_l1",
309
- /** Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions. */
310
- StorageOptimizedL2 = "storage_optimized_l2"
311
- }
312
-
313
- /** Known values of {@link UnavailableNameReason} that the service accepts. */
314
- export declare enum KnownUnavailableNameReason {
315
- /** The search service name doesn't match naming requirements. */
316
- Invalid = "Invalid",
317
- /** The search service name is already assigned to a different search service. */
318
- AlreadyExists = "AlreadyExists"
319
- }
320
-
321
- /** Response containing the query API keys for a given Azure AI Search service. */
322
- export declare interface ListQueryKeysResult {
323
- /**
324
- * The query keys for the Azure AI Search service.
325
- * NOTE: This property will not be serialized. It can only be populated by the server.
326
- */
327
- readonly value?: QueryKey[];
328
- /**
329
- * Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size.
330
- * NOTE: This property will not be serialized. It can only be populated by the server.
331
- */
332
- readonly nextLink?: string;
333
- }
334
-
335
- /** Network specific rules that determine how the Azure AI Search service may be reached. */
336
- export declare interface NetworkRuleSet {
337
- /** A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. */
338
- ipRules?: IpRule[];
339
- /** Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. */
340
- bypass?: SearchBypass;
341
- }
342
-
343
- /** Network security perimeter configuration for a server. */
344
- export declare interface NetworkSecurityPerimeterConfiguration extends ProxyResource {
345
- /** NOTE: This property will not be serialized. It can only be populated by the server. */
346
- readonly provisioningState?: string;
347
- /** The perimeter for a network security perimeter configuration. */
348
- networkSecurityPerimeter?: NSPConfigPerimeter;
349
- /** The resource association for the network security perimeter. */
350
- resourceAssociation?: NSPConfigAssociation;
351
- /** The profile for a network security perimeter configuration. */
352
- profile?: NSPConfigProfile;
353
- provisioningIssues?: NSPProvisioningIssue[];
354
- }
355
-
356
- /** A list of network security perimeter configurations for a server. */
357
- export declare interface NetworkSecurityPerimeterConfigurationListResult {
358
- /**
359
- * Array of results.
360
- * NOTE: This property will not be serialized. It can only be populated by the server.
361
- */
362
- readonly value?: NetworkSecurityPerimeterConfiguration[];
363
- /**
364
- * Link to retrieve next page of results.
365
- * NOTE: This property will not be serialized. It can only be populated by the server.
366
- */
367
- readonly nextLink?: string;
368
- }
369
-
370
- /** Interface representing a NetworkSecurityPerimeterConfigurations. */
371
- export declare interface NetworkSecurityPerimeterConfigurations {
372
- /**
373
- * Gets a list of network security perimeter configurations for a search service.
374
- * @param resourceGroupName The name of the resource group within the current subscription. You can
375
- * obtain this value from the Azure Resource Manager API or the portal.
376
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
377
- * resource group.
378
- * @param options The options parameters.
379
- */
380
- listByService(resourceGroupName: string, searchServiceName: string, options?: NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams): PagedAsyncIterableIterator<NetworkSecurityPerimeterConfiguration>;
381
- /**
382
- * Gets a network security perimeter configuration.
383
- * @param resourceGroupName The name of the resource group within the current subscription. You can
384
- * obtain this value from the Azure Resource Manager API or the portal.
385
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
386
- * resource group.
387
- * @param nspConfigName The network security configuration name.
388
- * @param options The options parameters.
389
- */
390
- get(resourceGroupName: string, searchServiceName: string, nspConfigName: string, options?: NetworkSecurityPerimeterConfigurationsGetOptionalParams): Promise<NetworkSecurityPerimeterConfigurationsGetResponse>;
391
- /**
392
- * Reconcile network security perimeter configuration for the Azure AI Search resource provider. This
393
- * triggers a manual resync with network security perimeter configurations by ensuring the search
394
- * service carries the latest configuration.
395
- * @param resourceGroupName The name of the resource group within the current subscription. You can
396
- * obtain this value from the Azure Resource Manager API or the portal.
397
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
398
- * resource group.
399
- * @param nspConfigName The network security configuration name.
400
- * @param options The options parameters.
401
- */
402
- beginReconcile(resourceGroupName: string, searchServiceName: string, nspConfigName: string, options?: NetworkSecurityPerimeterConfigurationsReconcileOptionalParams): Promise<SimplePollerLike<OperationState<NetworkSecurityPerimeterConfigurationsReconcileResponse>, NetworkSecurityPerimeterConfigurationsReconcileResponse>>;
403
- /**
404
- * Reconcile network security perimeter configuration for the Azure AI Search resource provider. This
405
- * triggers a manual resync with network security perimeter configurations by ensuring the search
406
- * service carries the latest configuration.
407
- * @param resourceGroupName The name of the resource group within the current subscription. You can
408
- * obtain this value from the Azure Resource Manager API or the portal.
409
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
410
- * resource group.
411
- * @param nspConfigName The network security configuration name.
412
- * @param options The options parameters.
413
- */
414
- beginReconcileAndWait(resourceGroupName: string, searchServiceName: string, nspConfigName: string, options?: NetworkSecurityPerimeterConfigurationsReconcileOptionalParams): Promise<NetworkSecurityPerimeterConfigurationsReconcileResponse>;
415
- }
416
-
417
- /** Optional parameters. */
418
- export declare interface NetworkSecurityPerimeterConfigurationsGetOptionalParams extends coreClient.OperationOptions {
419
- }
420
-
421
- /** Contains response data for the get operation. */
422
- export declare type NetworkSecurityPerimeterConfigurationsGetResponse = NetworkSecurityPerimeterConfiguration;
423
-
424
- /** Optional parameters. */
425
- export declare interface NetworkSecurityPerimeterConfigurationsListByServiceNextOptionalParams extends coreClient.OperationOptions {
426
- }
427
-
428
- /** Contains response data for the listByServiceNext operation. */
429
- export declare type NetworkSecurityPerimeterConfigurationsListByServiceNextResponse = NetworkSecurityPerimeterConfigurationListResult;
430
-
431
- /** Optional parameters. */
432
- export declare interface NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams extends coreClient.OperationOptions {
433
- }
434
-
435
- /** Contains response data for the listByService operation. */
436
- export declare type NetworkSecurityPerimeterConfigurationsListByServiceResponse = NetworkSecurityPerimeterConfigurationListResult;
437
-
438
- /** Defines headers for NetworkSecurityPerimeterConfigurations_reconcile operation. */
439
- export declare interface NetworkSecurityPerimeterConfigurationsReconcileHeaders {
440
- location?: string;
441
- }
442
-
443
- /** Optional parameters. */
444
- export declare interface NetworkSecurityPerimeterConfigurationsReconcileOptionalParams extends coreClient.OperationOptions {
445
- /** Delay to wait until next poll, in milliseconds. */
446
- updateIntervalInMs?: number;
447
- /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
448
- resumeFrom?: string;
449
- }
450
-
451
- /** Contains response data for the reconcile operation. */
452
- export declare type NetworkSecurityPerimeterConfigurationsReconcileResponse = NetworkSecurityPerimeterConfigurationsReconcileHeaders;
453
-
454
- /** An access rule for a network security perimeter configuration. */
455
- export declare interface NSPConfigAccessRule {
456
- name?: string;
457
- /** The properties for the access rules in a network security perimeter configuration. */
458
- properties?: NSPConfigAccessRuleProperties;
459
- }
460
-
461
- /** The properties for the access rules in a network security perimeter configuration. */
462
- export declare interface NSPConfigAccessRuleProperties {
463
- direction?: string;
464
- addressPrefixes?: string[];
465
- fullyQualifiedDomainNames?: string[];
466
- subscriptions?: string[];
467
- networkSecurityPerimeters?: NSPConfigNetworkSecurityPerimeterRule[];
468
- }
469
-
470
- /** The resource association for the network security perimeter. */
471
- export declare interface NSPConfigAssociation {
472
- name?: string;
473
- accessMode?: string;
474
- }
475
-
476
- /** The network security perimeter properties present in a configuration rule. */
477
- export declare interface NSPConfigNetworkSecurityPerimeterRule {
478
- id?: string;
479
- perimeterGuid?: string;
480
- location?: string;
481
- }
482
-
483
- /** The perimeter for a network security perimeter configuration. */
484
- export declare interface NSPConfigPerimeter {
485
- id?: string;
486
- perimeterGuid?: string;
487
- location?: string;
488
- }
489
-
490
- /** The profile for a network security perimeter configuration. */
491
- export declare interface NSPConfigProfile {
492
- name?: string;
493
- accessRulesVersion?: string;
494
- accessRules?: NSPConfigAccessRule[];
495
- }
496
-
497
- /** An object to describe any issues with provisioning network security perimeters to a search service. */
498
- export declare interface NSPProvisioningIssue {
499
- name?: string;
500
- /** The properties to describe any issues with provisioning network security perimeters to a search service. */
501
- properties?: NSPProvisioningIssueProperties;
502
- }
503
-
504
- /** The properties to describe any issues with provisioning network security perimeters to a search service. */
505
- export declare interface NSPProvisioningIssueProperties {
506
- issueType?: string;
507
- severity?: string;
508
- description?: string;
509
- suggestedResourceIds?: string[];
510
- suggestedAccessRules?: string[];
511
- }
512
-
513
- /** Describes a REST API operation. */
514
- export declare interface Operation {
515
- /**
516
- * The name of the operation. This name is of the form {provider}/{resource}/{operation}.
517
- * NOTE: This property will not be serialized. It can only be populated by the server.
518
- */
519
- readonly name?: string;
520
- /**
521
- * The object that describes the operation.
522
- * NOTE: This property will not be serialized. It can only be populated by the server.
523
- */
524
- readonly display?: OperationDisplay;
525
- /**
526
- * Describes if the specified operation is a data plane API operation. Operations where this value is not true are supported directly by the resource provider.
527
- * NOTE: This property will not be serialized. It can only be populated by the server.
528
- */
529
- readonly isDataAction?: boolean;
530
- /**
531
- * Describes which originating entities are allowed to invoke this operation.
532
- * NOTE: This property will not be serialized. It can only be populated by the server.
533
- */
534
- readonly origin?: string;
535
- /**
536
- * Describes additional properties for this operation.
537
- * NOTE: This property will not be serialized. It can only be populated by the server.
538
- */
539
- readonly properties?: OperationProperties;
540
- }
541
-
542
- /** Describes a particular availability for the metric specification. */
543
- export declare interface OperationAvailability {
544
- /**
545
- * The time grain for the dimension.
546
- * NOTE: This property will not be serialized. It can only be populated by the server.
547
- */
548
- readonly timeGrain?: string;
549
- /**
550
- * The blob duration for the dimension.
551
- * NOTE: This property will not be serialized. It can only be populated by the server.
552
- */
553
- readonly blobDuration?: string;
554
- }
555
-
556
- /** The object that describes the operation. */
557
- export declare interface OperationDisplay {
558
- /**
559
- * The friendly name of the resource provider.
560
- * NOTE: This property will not be serialized. It can only be populated by the server.
561
- */
562
- readonly provider?: string;
563
- /**
564
- * The operation type: read, write, delete, listKeys/action, etc.
565
- * NOTE: This property will not be serialized. It can only be populated by the server.
566
- */
567
- readonly operation?: string;
568
- /**
569
- * The resource type on which the operation is performed.
570
- * NOTE: This property will not be serialized. It can only be populated by the server.
571
- */
572
- readonly resource?: string;
573
- /**
574
- * The friendly name of the operation.
575
- * NOTE: This property will not be serialized. It can only be populated by the server.
576
- */
577
- readonly description?: string;
578
- }
579
-
580
- /** The result of the request to list REST API operations. It contains a list of operations and a URL to get the next set of results. */
581
- export declare interface OperationListResult {
582
- /**
583
- * The list of operations by Azure AI Search, some supported by the resource provider and others by data plane APIs.
584
- * NOTE: This property will not be serialized. It can only be populated by the server.
585
- */
586
- readonly value?: Operation[];
587
- /**
588
- * The URL to get the next set of operation list results, if any.
589
- * NOTE: This property will not be serialized. It can only be populated by the server.
590
- */
591
- readonly nextLink?: string;
592
- }
593
-
594
- /** Specifications of one type of log for this operation. */
595
- export declare interface OperationLogsSpecification {
596
- /**
597
- * The name of the log specification.
598
- * NOTE: This property will not be serialized. It can only be populated by the server.
599
- */
600
- readonly name?: string;
601
- /**
602
- * The display name of the log specification.
603
- * NOTE: This property will not be serialized. It can only be populated by the server.
604
- */
605
- readonly displayName?: string;
606
- /**
607
- * The blob duration for the log specification.
608
- * NOTE: This property will not be serialized. It can only be populated by the server.
609
- */
610
- readonly blobDuration?: string;
611
- }
612
-
613
- /** Describes a particular dimension for the metric specification. */
614
- export declare interface OperationMetricDimension {
615
- /**
616
- * The name of the dimension.
617
- * NOTE: This property will not be serialized. It can only be populated by the server.
618
- */
619
- readonly name?: string;
620
- /**
621
- * The display name of the dimension.
622
- * NOTE: This property will not be serialized. It can only be populated by the server.
623
- */
624
- readonly displayName?: string;
625
- }
626
-
627
- /** Specifications of one type of metric for this operation. */
628
- export declare interface OperationMetricsSpecification {
629
- /**
630
- * The name of the metric specification.
631
- * NOTE: This property will not be serialized. It can only be populated by the server.
632
- */
633
- readonly name?: string;
634
- /**
635
- * The display name of the metric specification.
636
- * NOTE: This property will not be serialized. It can only be populated by the server.
637
- */
638
- readonly displayName?: string;
639
- /**
640
- * The display description of the metric specification.
641
- * NOTE: This property will not be serialized. It can only be populated by the server.
642
- */
643
- readonly displayDescription?: string;
644
- /**
645
- * The unit for the metric specification.
646
- * NOTE: This property will not be serialized. It can only be populated by the server.
647
- */
648
- readonly unit?: string;
649
- /**
650
- * The type of aggregation for the metric specification.
651
- * NOTE: This property will not be serialized. It can only be populated by the server.
652
- */
653
- readonly aggregationType?: string;
654
- /**
655
- * Dimensions for the metric specification.
656
- * NOTE: This property will not be serialized. It can only be populated by the server.
657
- */
658
- readonly dimensions?: OperationMetricDimension[];
659
- /**
660
- * Availabilities for the metric specification.
661
- * NOTE: This property will not be serialized. It can only be populated by the server.
662
- */
663
- readonly availabilities?: OperationAvailability[];
664
- }
665
-
666
- /** Describes additional properties for this operation. */
667
- export declare interface OperationProperties {
668
- /**
669
- * Specifications of the service for this operation.
670
- * NOTE: This property will not be serialized. It can only be populated by the server.
671
- */
672
- readonly serviceSpecification?: OperationServiceSpecification;
673
- }
674
-
675
- /** Interface representing a Operations. */
676
- export declare interface Operations {
677
- /**
678
- * Lists all of the available REST API operations of the Microsoft.Search provider.
679
- * @param options The options parameters.
680
- */
681
- list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
682
- }
683
-
684
- /** Specifications of the service for this operation. */
685
- export declare interface OperationServiceSpecification {
686
- /**
687
- * Specifications of metrics for this operation.
688
- * NOTE: This property will not be serialized. It can only be populated by the server.
689
- */
690
- readonly metricSpecifications?: OperationMetricsSpecification[];
691
- /**
692
- * Specifications of logs for this operation.
693
- * NOTE: This property will not be serialized. It can only be populated by the server.
694
- */
695
- readonly logSpecifications?: OperationLogsSpecification[];
696
- }
697
-
698
- /** Optional parameters. */
699
- export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
700
- }
701
-
702
- /** Contains response data for the list operation. */
703
- export declare type OperationsListResponse = OperationListResult;
704
-
705
- /** Describes an existing private endpoint connection to the Azure AI Search service. */
706
- export declare interface PrivateEndpointConnection extends Resource {
707
- /** Describes the properties of an existing private endpoint connection to the Azure AI Search service. */
708
- properties?: PrivateEndpointConnectionProperties;
709
- }
710
-
711
- /** Response containing a list of private endpoint connections. */
712
- export declare interface PrivateEndpointConnectionListResult {
713
- /**
714
- * The list of private endpoint connections.
715
- * NOTE: This property will not be serialized. It can only be populated by the server.
716
- */
717
- readonly value?: PrivateEndpointConnection[];
718
- /**
719
- * Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.
720
- * NOTE: This property will not be serialized. It can only be populated by the server.
721
- */
722
- readonly nextLink?: string;
723
- }
724
-
725
- /** Describes the properties of an existing private endpoint connection to the search service. */
726
- export declare interface PrivateEndpointConnectionProperties {
727
- /** The private endpoint resource from Microsoft.Network provider. */
728
- privateEndpoint?: PrivateEndpointConnectionPropertiesPrivateEndpoint;
729
- /** Describes the current state of an existing Azure Private Link service connection to the private endpoint. */
730
- privateLinkServiceConnectionState?: PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState;
731
- /** The group ID of the Azure resource for which the private link service is for. */
732
- groupId?: string;
733
- /** The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. */
734
- provisioningState?: PrivateLinkServiceConnectionProvisioningState;
735
- }
736
-
737
- /** The private endpoint resource from Microsoft.Network provider. */
738
- export declare interface PrivateEndpointConnectionPropertiesPrivateEndpoint {
739
- /** The resource ID of the private endpoint resource from Microsoft.Network provider. */
740
- id?: string;
741
- }
742
-
743
- /** Describes the current state of an existing Azure Private Link service connection to the private endpoint. */
744
- export declare interface PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState {
745
- /** Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. */
746
- status?: PrivateLinkServiceConnectionStatus;
747
- /** The description for the private link service connection state. */
748
- description?: string;
749
- /** A description of any extra actions that may be required. */
750
- actionsRequired?: string;
751
- }
752
-
753
- /** Interface representing a PrivateEndpointConnections. */
754
- export declare interface PrivateEndpointConnections {
755
- /**
756
- * Gets a list of all private endpoint connections in the given service.
757
- * @param resourceGroupName The name of the resource group within the current subscription. You can
758
- * obtain this value from the Azure Resource Manager API or the portal.
759
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
760
- * resource group.
761
- * @param options The options parameters.
762
- */
763
- listByService(resourceGroupName: string, searchServiceName: string, options?: PrivateEndpointConnectionsListByServiceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection>;
764
- /**
765
- * Updates a private endpoint connection to the search service in the given resource group.
766
- * @param resourceGroupName The name of the resource group within the current subscription. You can
767
- * obtain this value from the Azure Resource Manager API or the portal.
768
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
769
- * resource group.
770
- * @param privateEndpointConnectionName The name of the private endpoint connection to the Azure AI
771
- * Search service with the specified resource group.
772
- * @param privateEndpointConnection The definition of the private endpoint connection to update.
773
- * @param options The options parameters.
774
- */
775
- update(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateOptionalParams): Promise<PrivateEndpointConnectionsUpdateResponse>;
776
- /**
777
- * Gets the details of the private endpoint connection to the search service in the given resource
778
- * group.
779
- * @param resourceGroupName The name of the resource group within the current subscription. You can
780
- * obtain this value from the Azure Resource Manager API or the portal.
781
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
782
- * resource group.
783
- * @param privateEndpointConnectionName The name of the private endpoint connection to the Azure AI
784
- * Search service with the specified resource group.
785
- * @param options The options parameters.
786
- */
787
- get(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnectionsGetResponse>;
788
- /**
789
- * Disconnects the private endpoint connection and deletes it from the search service.
790
- * @param resourceGroupName The name of the resource group within the current subscription. You can
791
- * obtain this value from the Azure Resource Manager API or the portal.
792
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
793
- * resource group.
794
- * @param privateEndpointConnectionName The name of the private endpoint connection to the Azure AI
795
- * Search service with the specified resource group.
796
- * @param options The options parameters.
797
- */
798
- delete(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PrivateEndpointConnectionsDeleteResponse>;
799
- }
800
-
801
- /** Optional parameters. */
802
- export declare interface PrivateEndpointConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
803
- /** Parameter group */
804
- searchManagementRequestOptions?: SearchManagementRequestOptions;
805
- }
806
-
807
- /** Contains response data for the delete operation. */
808
- export declare type PrivateEndpointConnectionsDeleteResponse = PrivateEndpointConnection;
809
-
810
- /** Optional parameters. */
811
- export declare interface PrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions {
812
- /** Parameter group */
813
- searchManagementRequestOptions?: SearchManagementRequestOptions;
814
- }
815
-
816
- /** Contains response data for the get operation. */
817
- export declare type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection;
818
-
819
- /** Optional parameters. */
820
- export declare interface PrivateEndpointConnectionsListByServiceNextOptionalParams extends coreClient.OperationOptions {
821
- /** Parameter group */
822
- searchManagementRequestOptions?: SearchManagementRequestOptions;
823
- }
824
-
825
- /** Contains response data for the listByServiceNext operation. */
826
- export declare type PrivateEndpointConnectionsListByServiceNextResponse = PrivateEndpointConnectionListResult;
827
-
828
- /** Optional parameters. */
829
- export declare interface PrivateEndpointConnectionsListByServiceOptionalParams extends coreClient.OperationOptions {
830
- /** Parameter group */
831
- searchManagementRequestOptions?: SearchManagementRequestOptions;
832
- }
833
-
834
- /** Contains response data for the listByService operation. */
835
- export declare type PrivateEndpointConnectionsListByServiceResponse = PrivateEndpointConnectionListResult;
836
-
837
- /** Optional parameters. */
838
- export declare interface PrivateEndpointConnectionsUpdateOptionalParams extends coreClient.OperationOptions {
839
- /** Parameter group */
840
- searchManagementRequestOptions?: SearchManagementRequestOptions;
841
- }
842
-
843
- /** Contains response data for the update operation. */
844
- export declare type PrivateEndpointConnectionsUpdateResponse = PrivateEndpointConnection;
845
-
846
- /** Describes a supported private link resource for the Azure AI Search service. */
847
- export declare interface PrivateLinkResource extends Resource {
848
- /**
849
- * Describes the properties of a supported private link resource for the Azure AI Search service.
850
- * NOTE: This property will not be serialized. It can only be populated by the server.
851
- */
852
- readonly properties?: PrivateLinkResourceProperties;
853
- }
854
-
855
- /** Describes the properties of a supported private link resource for the Azure AI Search service. For a given API version, this represents the 'supported' groupIds when creating a shared private link resource. */
856
- export declare interface PrivateLinkResourceProperties {
857
- /**
858
- * The group ID of the private link resource.
859
- * NOTE: This property will not be serialized. It can only be populated by the server.
860
- */
861
- readonly groupId?: string;
862
- /**
863
- * The list of required members of the private link resource.
864
- * NOTE: This property will not be serialized. It can only be populated by the server.
865
- */
866
- readonly requiredMembers?: string[];
867
- /**
868
- * The list of required DNS zone names of the private link resource.
869
- * NOTE: This property will not be serialized. It can only be populated by the server.
870
- */
871
- readonly requiredZoneNames?: string[];
872
- /**
873
- * The list of resources that are onboarded to private link service, that are supported by Azure AI Search.
874
- * NOTE: This property will not be serialized. It can only be populated by the server.
875
- */
876
- readonly shareablePrivateLinkResourceTypes?: ShareablePrivateLinkResourceType[];
877
- }
878
-
879
- /** Interface representing a PrivateLinkResources. */
880
- export declare interface PrivateLinkResources {
881
- /**
882
- * Gets a list of all supported private link resource types for the given service.
883
- * @param resourceGroupName The name of the resource group within the current subscription. You can
884
- * obtain this value from the Azure Resource Manager API or the portal.
885
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
886
- * resource group.
887
- * @param options The options parameters.
888
- */
889
- listSupported(resourceGroupName: string, searchServiceName: string, options?: PrivateLinkResourcesListSupportedOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource>;
890
- }
891
-
892
- /** Optional parameters. */
893
- export declare interface PrivateLinkResourcesListSupportedOptionalParams extends coreClient.OperationOptions {
894
- /** Parameter group */
895
- searchManagementRequestOptions?: SearchManagementRequestOptions;
896
- }
897
-
898
- /** Contains response data for the listSupported operation. */
899
- export declare type PrivateLinkResourcesListSupportedResponse = PrivateLinkResourcesResult;
900
-
901
- /** Response containing a list of supported Private Link Resources. */
902
- export declare interface PrivateLinkResourcesResult {
903
- /**
904
- * The list of supported Private Link Resources.
905
- * NOTE: This property will not be serialized. It can only be populated by the server.
906
- */
907
- readonly value?: PrivateLinkResource[];
908
- }
909
-
910
- /**
911
- * Defines values for PrivateLinkServiceConnectionProvisioningState. \
912
- * {@link KnownPrivateLinkServiceConnectionProvisioningState} can be used interchangeably with PrivateLinkServiceConnectionProvisioningState,
913
- * this enum contains the known values that the service supports.
914
- * ### Known values supported by the service
915
- * **Updating**: The private link service connection is in the process of being created along with other resources for it to be fully functional. \
916
- * **Deleting**: The private link service connection is in the process of being deleted. \
917
- * **Failed**: The private link service connection has failed to be provisioned or deleted. \
918
- * **Succeeded**: The private link service connection has finished provisioning and is ready for approval. \
919
- * **Incomplete**: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. \
920
- * **Canceled**: Provisioning request for the private link service connection resource has been canceled.
921
- */
922
- export declare type PrivateLinkServiceConnectionProvisioningState = string;
923
-
924
- /** Defines values for PrivateLinkServiceConnectionStatus. */
925
- export declare type PrivateLinkServiceConnectionStatus = "Pending" | "Approved" | "Rejected" | "Disconnected";
926
-
927
- /** Defines values for ProvisioningState. */
928
- export declare type ProvisioningState = "Succeeded" | "Provisioning" | "Failed";
929
-
930
- /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
931
- export declare interface ProxyResource extends Resource {
932
- }
933
-
934
- /**
935
- * Defines values for PublicNetworkAccess. \
936
- * {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
937
- * this enum contains the known values that the service supports.
938
- * ### Known values supported by the service
939
- * **enabled**: The search service is accessible from traffic originating from the public internet. \
940
- * **disabled**: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections.
941
- */
942
- export declare type PublicNetworkAccess = string;
943
-
944
- /** Describes an API key for a given Azure AI Search service that conveys read-only permissions on the docs collection of an index. */
945
- export declare interface QueryKey {
946
- /**
947
- * The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used.
948
- * NOTE: This property will not be serialized. It can only be populated by the server.
949
- */
950
- readonly name?: string;
951
- /**
952
- * The value of the query API key.
953
- * NOTE: This property will not be serialized. It can only be populated by the server.
954
- */
955
- readonly key?: string;
956
- }
957
-
958
- /** Interface representing a QueryKeys. */
959
- export declare interface QueryKeys {
960
- /**
961
- * Returns the list of query API keys for the given Azure AI Search service.
962
- * @param resourceGroupName The name of the resource group within the current subscription. You can
963
- * obtain this value from the Azure Resource Manager API or the portal.
964
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
965
- * resource group.
966
- * @param options The options parameters.
967
- */
968
- listBySearchService(resourceGroupName: string, searchServiceName: string, options?: QueryKeysListBySearchServiceOptionalParams): PagedAsyncIterableIterator<QueryKey>;
969
- /**
970
- * Generates a new query key for the specified search service. You can create up to 50 query keys per
971
- * service.
972
- * @param resourceGroupName The name of the resource group within the current subscription. You can
973
- * obtain this value from the Azure Resource Manager API or the portal.
974
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
975
- * resource group.
976
- * @param name The name of the new query API key.
977
- * @param options The options parameters.
978
- */
979
- create(resourceGroupName: string, searchServiceName: string, name: string, options?: QueryKeysCreateOptionalParams): Promise<QueryKeysCreateResponse>;
980
- /**
981
- * Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for
982
- * regenerating a query key is to delete and then recreate it.
983
- * @param resourceGroupName The name of the resource group within the current subscription. You can
984
- * obtain this value from the Azure Resource Manager API or the portal.
985
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
986
- * resource group.
987
- * @param key The query key to be deleted. Query keys are identified by value, not by name.
988
- * @param options The options parameters.
989
- */
990
- delete(resourceGroupName: string, searchServiceName: string, key: string, options?: QueryKeysDeleteOptionalParams): Promise<void>;
991
- }
992
-
993
- /** Optional parameters. */
994
- export declare interface QueryKeysCreateOptionalParams extends coreClient.OperationOptions {
995
- /** Parameter group */
996
- searchManagementRequestOptions?: SearchManagementRequestOptions;
997
- }
998
-
999
- /** Contains response data for the create operation. */
1000
- export declare type QueryKeysCreateResponse = QueryKey;
1001
-
1002
- /** Optional parameters. */
1003
- export declare interface QueryKeysDeleteOptionalParams extends coreClient.OperationOptions {
1004
- /** Parameter group */
1005
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1006
- }
1007
-
1008
- /** Optional parameters. */
1009
- export declare interface QueryKeysListBySearchServiceNextOptionalParams extends coreClient.OperationOptions {
1010
- /** Parameter group */
1011
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1012
- }
1013
-
1014
- /** Contains response data for the listBySearchServiceNext operation. */
1015
- export declare type QueryKeysListBySearchServiceNextResponse = ListQueryKeysResult;
1016
-
1017
- /** Optional parameters. */
1018
- export declare interface QueryKeysListBySearchServiceOptionalParams extends coreClient.OperationOptions {
1019
- /** Parameter group */
1020
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1021
- }
1022
-
1023
- /** Contains response data for the listBySearchService operation. */
1024
- export declare type QueryKeysListBySearchServiceResponse = ListQueryKeysResult;
1025
-
1026
- /** Describes the quota usage for a particular SKU. */
1027
- export declare interface QuotaUsageResult {
1028
- /** The resource ID of the quota usage SKU endpoint for Microsoft.Search provider. */
1029
- id?: string;
1030
- /** The unit of measurement for the search SKU. */
1031
- unit?: string;
1032
- /** The currently used up value for the particular search SKU. */
1033
- currentValue?: number;
1034
- /** The quota limit for the particular search SKU. */
1035
- limit?: number;
1036
- /**
1037
- * The name of the SKU supported by Azure AI Search.
1038
- * NOTE: This property will not be serialized. It can only be populated by the server.
1039
- */
1040
- readonly name?: QuotaUsageResultName;
1041
- }
1042
-
1043
- /** The name of the SKU supported by Azure AI Search. */
1044
- export declare interface QuotaUsageResultName {
1045
- /** The SKU name supported by Azure AI Search. */
1046
- value?: string;
1047
- /** The localized string value for the SKU name. */
1048
- localizedValue?: string;
1049
- }
1050
-
1051
- /** Response containing the quota usage information for all the supported SKUs of Azure AI Search. */
1052
- export declare interface QuotaUsagesListResult {
1053
- /**
1054
- * The quota usages for the SKUs supported by Azure AI Search.
1055
- * NOTE: This property will not be serialized. It can only be populated by the server.
1056
- */
1057
- readonly value?: QuotaUsageResult[];
1058
- /**
1059
- * Request URL that can be used to query next page of quota usages. Returned when the total number of requested quota usages exceed maximum page size.
1060
- * NOTE: This property will not be serialized. It can only be populated by the server.
1061
- */
1062
- readonly nextLink?: string;
1063
- }
1064
-
1065
- /** Common fields that are returned in the response for all Azure Resource Manager resources */
1066
- export declare interface Resource {
1067
- /**
1068
- * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
1069
- * NOTE: This property will not be serialized. It can only be populated by the server.
1070
- */
1071
- readonly id?: string;
1072
- /**
1073
- * The name of the resource
1074
- * NOTE: This property will not be serialized. It can only be populated by the server.
1075
- */
1076
- readonly name?: string;
1077
- /**
1078
- * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
1079
- * NOTE: This property will not be serialized. It can only be populated by the server.
1080
- */
1081
- readonly type?: string;
1082
- }
1083
-
1084
- /**
1085
- * Defines values for SearchBypass. \
1086
- * {@link KnownSearchBypass} can be used interchangeably with SearchBypass,
1087
- * this enum contains the known values that the service supports.
1088
- * ### Known values supported by the service
1089
- * **None**: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. \
1090
- * **AzurePortal**: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. \
1091
- * **AzureServices**: Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section.
1092
- */
1093
- export declare type SearchBypass = string;
1094
-
1095
- /**
1096
- * Defines values for SearchDisabledDataExfiltrationOption. \
1097
- * {@link KnownSearchDisabledDataExfiltrationOption} can be used interchangeably with SearchDisabledDataExfiltrationOption,
1098
- * this enum contains the known values that the service supports.
1099
- * ### Known values supported by the service
1100
- * **All**: Indicates that all data exfiltration scenarios are disabled.
1101
- */
1102
- export declare type SearchDisabledDataExfiltrationOption = string;
1103
-
1104
- /** Defines values for SearchEncryptionComplianceStatus. */
1105
- export declare type SearchEncryptionComplianceStatus = "Compliant" | "NonCompliant";
1106
-
1107
- /** Defines values for SearchEncryptionWithCmk. */
1108
- export declare type SearchEncryptionWithCmk = "Disabled" | "Enabled" | "Unspecified";
1109
-
1110
- export declare class SearchManagementClient extends coreClient.ServiceClient {
1111
- $host: string;
1112
- apiVersion: string;
1113
- subscriptionId: string;
1114
- /**
1115
- * Initializes a new instance of the SearchManagementClient class.
1116
- * @param credentials Subscription credentials which uniquely identify client subscription.
1117
- * @param subscriptionId The unique identifier for a Microsoft Azure subscription. You can obtain this
1118
- * value from the Azure Resource Manager API or the portal.
1119
- * @param options The parameter options
1120
- */
1121
- constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: SearchManagementClientOptionalParams);
1122
- /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
1123
- private addCustomApiVersionPolicy;
1124
- /**
1125
- * Gets the quota usage for a search sku in the given subscription.
1126
- * @param location The unique location name for a Microsoft Azure geographic region.
1127
- * @param skuName The unique SKU name that identifies a billable tier.
1128
- * @param options The options parameters.
1129
- */
1130
- usageBySubscriptionSku(location: string, skuName: string, options?: UsageBySubscriptionSkuOptionalParams): Promise<UsageBySubscriptionSkuResponse>;
1131
- operations: Operations;
1132
- adminKeys: AdminKeys;
1133
- queryKeys: QueryKeys;
1134
- services: Services;
1135
- privateLinkResources: PrivateLinkResources;
1136
- privateEndpointConnections: PrivateEndpointConnections;
1137
- sharedPrivateLinkResources: SharedPrivateLinkResources;
1138
- usages: Usages;
1139
- networkSecurityPerimeterConfigurations: NetworkSecurityPerimeterConfigurations;
1140
- }
1141
-
1142
- /** Optional parameters. */
1143
- export declare interface SearchManagementClientOptionalParams extends coreClient.ServiceClientOptions {
1144
- /** server parameter */
1145
- $host?: string;
1146
- /** Api Version */
1147
- apiVersion?: string;
1148
- /** Overrides client endpoint. */
1149
- endpoint?: string;
1150
- }
1151
-
1152
- /** Parameter group */
1153
- export declare interface SearchManagementRequestOptions {
1154
- /** A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request. */
1155
- clientRequestId?: string;
1156
- }
1157
-
1158
- /**
1159
- * Defines values for SearchSemanticSearch. \
1160
- * {@link KnownSearchSemanticSearch} can be used interchangeably with SearchSemanticSearch,
1161
- * this enum contains the known values that the service supports.
1162
- * ### Known values supported by the service
1163
- * **disabled**: Indicates that semantic reranker is disabled for the search service. This is the default. \
1164
- * **free**: Enables semantic reranker on a search service and indicates that it is to be used within the limits of the free plan. The free plan would cap the volume of semantic ranking requests and is offered at no extra charge. This is the default for newly provisioned search services. \
1165
- * **standard**: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries.
1166
- */
1167
- export declare type SearchSemanticSearch = string;
1168
-
1169
- /** Describes an Azure AI Search service and its current state. */
1170
- export declare interface SearchService extends TrackedResource {
1171
- /** The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. */
1172
- sku?: Sku;
1173
- /** The identity of the resource. */
1174
- identity?: Identity;
1175
- /** The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU. */
1176
- replicaCount?: number;
1177
- /** The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3. */
1178
- partitionCount?: number;
1179
- /** Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'. */
1180
- hostingMode?: HostingMode;
1181
- /** This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. */
1182
- publicNetworkAccess?: PublicNetworkAccess;
1183
- /**
1184
- * The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
1185
- * NOTE: This property will not be serialized. It can only be populated by the server.
1186
- */
1187
- readonly status?: SearchServiceStatus;
1188
- /**
1189
- * The details of the search service status.
1190
- * NOTE: This property will not be serialized. It can only be populated by the server.
1191
- */
1192
- readonly statusDetails?: string;
1193
- /**
1194
- * The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'Succeeded' or 'Failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'Succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
1195
- * NOTE: This property will not be serialized. It can only be populated by the server.
1196
- */
1197
- readonly provisioningState?: ProvisioningState;
1198
- /** Network specific rules that determine how the Azure AI Search service may be reached. */
1199
- networkRuleSet?: NetworkRuleSet;
1200
- /** A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future. */
1201
- disabledDataExfiltrationOptions?: SearchDisabledDataExfiltrationOption[];
1202
- /** Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. */
1203
- encryptionWithCmk?: EncryptionWithCmk;
1204
- /** When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. */
1205
- disableLocalAuth?: boolean;
1206
- /** Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. */
1207
- authOptions?: DataPlaneAuthOptions;
1208
- /** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. */
1209
- semanticSearch?: SearchSemanticSearch;
1210
- /**
1211
- * The list of private endpoint connections to the Azure AI Search service.
1212
- * NOTE: This property will not be serialized. It can only be populated by the server.
1213
- */
1214
- readonly privateEndpointConnections?: PrivateEndpointConnection[];
1215
- /**
1216
- * The list of shared private link resources managed by the Azure AI Search service.
1217
- * NOTE: This property will not be serialized. It can only be populated by the server.
1218
- */
1219
- readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
1220
- /**
1221
- * A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
1222
- * NOTE: This property will not be serialized. It can only be populated by the server.
1223
- */
1224
- readonly eTag?: string;
1225
- }
1226
-
1227
- /** Response containing a list of Azure AI Search services. */
1228
- export declare interface SearchServiceListResult {
1229
- /**
1230
- * The list of search services.
1231
- * NOTE: This property will not be serialized. It can only be populated by the server.
1232
- */
1233
- readonly value?: SearchService[];
1234
- /**
1235
- * Request URL that can be used to query next page of search services. Returned when the total number of requested search services exceed maximum page size.
1236
- * NOTE: This property will not be serialized. It can only be populated by the server.
1237
- */
1238
- readonly nextLink?: string;
1239
- }
1240
-
1241
- /** Defines values for SearchServiceStatus. */
1242
- export declare type SearchServiceStatus = "running" | "provisioning" | "deleting" | "degraded" | "disabled" | "error" | "stopped";
1243
-
1244
- /** The parameters used to update an Azure AI Search service. */
1245
- export declare interface SearchServiceUpdate extends Resource {
1246
- /** The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. */
1247
- sku?: Sku;
1248
- /** The geographic location of the resource. This must be one of the supported and registered Azure geo regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource. */
1249
- location?: string;
1250
- /** Tags to help categorize the resource in the Azure portal. */
1251
- tags?: {
1252
- [propertyName: string]: string;
1253
- };
1254
- /** Details about the search service identity. A null value indicates that the search service has no identity assigned. */
1255
- identity?: Identity;
1256
- /** The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU. */
1257
- replicaCount?: number;
1258
- /** The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3. */
1259
- partitionCount?: number;
1260
- /** Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'. */
1261
- hostingMode?: HostingMode;
1262
- /** This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. */
1263
- publicNetworkAccess?: PublicNetworkAccess;
1264
- /**
1265
- * The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
1266
- * NOTE: This property will not be serialized. It can only be populated by the server.
1267
- */
1268
- readonly status?: SearchServiceStatus;
1269
- /**
1270
- * The details of the search service status.
1271
- * NOTE: This property will not be serialized. It can only be populated by the server.
1272
- */
1273
- readonly statusDetails?: string;
1274
- /**
1275
- * The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'Succeeded' or 'Failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'Succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
1276
- * NOTE: This property will not be serialized. It can only be populated by the server.
1277
- */
1278
- readonly provisioningState?: ProvisioningState;
1279
- /** Network specific rules that determine how the Azure AI Search service may be reached. */
1280
- networkRuleSet?: NetworkRuleSet;
1281
- /** A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future. */
1282
- disabledDataExfiltrationOptions?: SearchDisabledDataExfiltrationOption[];
1283
- /** Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. */
1284
- encryptionWithCmk?: EncryptionWithCmk;
1285
- /** When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. */
1286
- disableLocalAuth?: boolean;
1287
- /** Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. */
1288
- authOptions?: DataPlaneAuthOptions;
1289
- /** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. */
1290
- semanticSearch?: SearchSemanticSearch;
1291
- /**
1292
- * The list of private endpoint connections to the Azure AI Search service.
1293
- * NOTE: This property will not be serialized. It can only be populated by the server.
1294
- */
1295
- readonly privateEndpointConnections?: PrivateEndpointConnection[];
1296
- /**
1297
- * The list of shared private link resources managed by the Azure AI Search service.
1298
- * NOTE: This property will not be serialized. It can only be populated by the server.
1299
- */
1300
- readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
1301
- /**
1302
- * A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
1303
- * NOTE: This property will not be serialized. It can only be populated by the server.
1304
- */
1305
- readonly eTag?: string;
1306
- }
1307
-
1308
- /** Interface representing a Services. */
1309
- export declare interface Services {
1310
- /**
1311
- * Gets a list of all Search services in the given resource group.
1312
- * @param resourceGroupName The name of the resource group within the current subscription. You can
1313
- * obtain this value from the Azure Resource Manager API or the portal.
1314
- * @param options The options parameters.
1315
- */
1316
- listByResourceGroup(resourceGroupName: string, options?: ServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SearchService>;
1317
- /**
1318
- * Gets a list of all Search services in the given subscription.
1319
- * @param options The options parameters.
1320
- */
1321
- listBySubscription(options?: ServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SearchService>;
1322
- /**
1323
- * Creates or updates a search service in the given resource group. If the search service already
1324
- * exists, all properties will be updated with the given values.
1325
- * @param resourceGroupName The name of the resource group within the current subscription. You can
1326
- * obtain this value from the Azure Resource Manager API or the portal.
1327
- * @param searchServiceName The name of the Azure AI Search service to create or update. Search service
1328
- * names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or
1329
- * last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in
1330
- * length. Search service names must be globally unique since they are part of the service URI
1331
- * (https://<name>.search.windows.net). You cannot change the service name after the service is
1332
- * created.
1333
- * @param service The definition of the search service to create or update.
1334
- * @param options The options parameters.
1335
- */
1336
- beginCreateOrUpdate(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ServicesCreateOrUpdateResponse>, ServicesCreateOrUpdateResponse>>;
1337
- /**
1338
- * Creates or updates a search service in the given resource group. If the search service already
1339
- * exists, all properties will be updated with the given values.
1340
- * @param resourceGroupName The name of the resource group within the current subscription. You can
1341
- * obtain this value from the Azure Resource Manager API or the portal.
1342
- * @param searchServiceName The name of the Azure AI Search service to create or update. Search service
1343
- * names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or
1344
- * last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in
1345
- * length. Search service names must be globally unique since they are part of the service URI
1346
- * (https://<name>.search.windows.net). You cannot change the service name after the service is
1347
- * created.
1348
- * @param service The definition of the search service to create or update.
1349
- * @param options The options parameters.
1350
- */
1351
- beginCreateOrUpdateAndWait(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<ServicesCreateOrUpdateResponse>;
1352
- /**
1353
- * Updates an existing search service in the given resource group.
1354
- * @param resourceGroupName The name of the resource group within the current subscription. You can
1355
- * obtain this value from the Azure Resource Manager API or the portal.
1356
- * @param searchServiceName The name of the Azure AI Search service to update.
1357
- * @param service The definition of the search service to update.
1358
- * @param options The options parameters.
1359
- */
1360
- update(resourceGroupName: string, searchServiceName: string, service: SearchServiceUpdate, options?: ServicesUpdateOptionalParams): Promise<ServicesUpdateResponse>;
1361
- /**
1362
- * Gets the search service with the given name in the given resource group.
1363
- * @param resourceGroupName The name of the resource group within the current subscription. You can
1364
- * obtain this value from the Azure Resource Manager API or the portal.
1365
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
1366
- * resource group.
1367
- * @param options The options parameters.
1368
- */
1369
- get(resourceGroupName: string, searchServiceName: string, options?: ServicesGetOptionalParams): Promise<ServicesGetResponse>;
1370
- /**
1371
- * Deletes a search service in the given resource group, along with its associated resources.
1372
- * @param resourceGroupName The name of the resource group within the current subscription. You can
1373
- * obtain this value from the Azure Resource Manager API or the portal.
1374
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
1375
- * resource group.
1376
- * @param options The options parameters.
1377
- */
1378
- delete(resourceGroupName: string, searchServiceName: string, options?: ServicesDeleteOptionalParams): Promise<void>;
1379
- /**
1380
- * Checks whether or not the given search service name is available for use. Search service names must
1381
- * be globally unique since they are part of the service URI (https://<name>.search.windows.net).
1382
- * @param name The search service name to validate. Search service names must only contain lowercase
1383
- * letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain
1384
- * consecutive dashes, and must be between 2 and 60 characters in length.
1385
- * @param options The options parameters.
1386
- */
1387
- checkNameAvailability(name: string, options?: ServicesCheckNameAvailabilityOptionalParams): Promise<ServicesCheckNameAvailabilityResponse>;
1388
- }
1389
-
1390
- /** Optional parameters. */
1391
- export declare interface ServicesCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
1392
- /** Parameter group */
1393
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1394
- }
1395
-
1396
- /** Contains response data for the checkNameAvailability operation. */
1397
- export declare type ServicesCheckNameAvailabilityResponse = CheckNameAvailabilityOutput;
1398
-
1399
- /** Optional parameters. */
1400
- export declare interface ServicesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
1401
- /** Parameter group */
1402
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1403
- /** Delay to wait until next poll, in milliseconds. */
1404
- updateIntervalInMs?: number;
1405
- /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1406
- resumeFrom?: string;
1407
- }
1408
-
1409
- /** Contains response data for the createOrUpdate operation. */
1410
- export declare type ServicesCreateOrUpdateResponse = SearchService;
1411
-
1412
- /** Optional parameters. */
1413
- export declare interface ServicesDeleteOptionalParams extends coreClient.OperationOptions {
1414
- /** Parameter group */
1415
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1416
- }
1417
-
1418
- /** Optional parameters. */
1419
- export declare interface ServicesGetOptionalParams extends coreClient.OperationOptions {
1420
- /** Parameter group */
1421
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1422
- }
1423
-
1424
- /** Contains response data for the get operation. */
1425
- export declare type ServicesGetResponse = SearchService;
1426
-
1427
- /** Optional parameters. */
1428
- export declare interface ServicesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
1429
- /** Parameter group */
1430
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1431
- }
1432
-
1433
- /** Contains response data for the listByResourceGroupNext operation. */
1434
- export declare type ServicesListByResourceGroupNextResponse = SearchServiceListResult;
1435
-
1436
- /** Optional parameters. */
1437
- export declare interface ServicesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
1438
- /** Parameter group */
1439
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1440
- }
1441
-
1442
- /** Contains response data for the listByResourceGroup operation. */
1443
- export declare type ServicesListByResourceGroupResponse = SearchServiceListResult;
1444
-
1445
- /** Optional parameters. */
1446
- export declare interface ServicesListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
1447
- /** Parameter group */
1448
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1449
- }
1450
-
1451
- /** Contains response data for the listBySubscriptionNext operation. */
1452
- export declare type ServicesListBySubscriptionNextResponse = SearchServiceListResult;
1453
-
1454
- /** Optional parameters. */
1455
- export declare interface ServicesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
1456
- /** Parameter group */
1457
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1458
- }
1459
-
1460
- /** Contains response data for the listBySubscription operation. */
1461
- export declare type ServicesListBySubscriptionResponse = SearchServiceListResult;
1462
-
1463
- /** Optional parameters. */
1464
- export declare interface ServicesUpdateOptionalParams extends coreClient.OperationOptions {
1465
- /** Parameter group */
1466
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1467
- }
1468
-
1469
- /** Contains response data for the update operation. */
1470
- export declare type ServicesUpdateResponse = SearchService;
1471
-
1472
- /** Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search. */
1473
- export declare interface ShareablePrivateLinkResourceProperties {
1474
- /**
1475
- * The resource provider type for the resource that has been onboarded to private link service, supported by Azure AI Search.
1476
- * NOTE: This property will not be serialized. It can only be populated by the server.
1477
- */
1478
- readonly type?: string;
1479
- /**
1480
- * The resource provider group id for the resource that has been onboarded to private link service, supported by Azure AI Search.
1481
- * NOTE: This property will not be serialized. It can only be populated by the server.
1482
- */
1483
- readonly groupId?: string;
1484
- /**
1485
- * The description of the resource type that has been onboarded to private link service, supported by Azure AI Search.
1486
- * NOTE: This property will not be serialized. It can only be populated by the server.
1487
- */
1488
- readonly description?: string;
1489
- }
1490
-
1491
- /** Describes an resource type that has been onboarded to private link service, supported by Azure AI Search. */
1492
- export declare interface ShareablePrivateLinkResourceType {
1493
- /**
1494
- * The name of the resource type that has been onboarded to private link service, supported by Azure AI Search.
1495
- * NOTE: This property will not be serialized. It can only be populated by the server.
1496
- */
1497
- readonly name?: string;
1498
- /**
1499
- * Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search.
1500
- * NOTE: This property will not be serialized. It can only be populated by the server.
1501
- */
1502
- readonly properties?: ShareablePrivateLinkResourceProperties;
1503
- }
1504
-
1505
- /** Describes a shared private link resource managed by the Azure AI Search service. */
1506
- export declare interface SharedPrivateLinkResource extends Resource {
1507
- /** Describes the properties of a shared private link resource managed by the Azure AI Search service. */
1508
- properties?: SharedPrivateLinkResourceProperties;
1509
- }
1510
-
1511
- /**
1512
- * Defines values for SharedPrivateLinkResourceAsyncOperationResult. \
1513
- * {@link KnownSharedPrivateLinkResourceAsyncOperationResult} can be used interchangeably with SharedPrivateLinkResourceAsyncOperationResult,
1514
- * this enum contains the known values that the service supports.
1515
- * ### Known values supported by the service
1516
- * **Running** \
1517
- * **Succeeded** \
1518
- * **Failed**
1519
- */
1520
- export declare type SharedPrivateLinkResourceAsyncOperationResult = string;
1521
-
1522
- /** Response containing a list of shared private link resources. */
1523
- export declare interface SharedPrivateLinkResourceListResult {
1524
- /**
1525
- * The list of shared private link resources.
1526
- * NOTE: This property will not be serialized. It can only be populated by the server.
1527
- */
1528
- readonly value?: SharedPrivateLinkResource[];
1529
- /** The URL to get the next set of shared private link resources, if there are any. */
1530
- nextLink?: string;
1531
- }
1532
-
1533
- /** Describes the properties of an existing shared private link resource managed by the Azure AI Search service. */
1534
- export declare interface SharedPrivateLinkResourceProperties {
1535
- /** The resource ID of the resource the shared private link resource is for. */
1536
- privateLinkResourceId?: string;
1537
- /** The group ID from the provider of resource the shared private link resource is for. */
1538
- groupId?: string;
1539
- /** The message for requesting approval of the shared private link resource. */
1540
- requestMessage?: string;
1541
- /** Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service). */
1542
- resourceRegion?: string;
1543
- /** Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. */
1544
- status?: SharedPrivateLinkResourceStatus;
1545
- /** The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. */
1546
- provisioningState?: SharedPrivateLinkResourceProvisioningState;
1547
- }
1548
-
1549
- /**
1550
- * Defines values for SharedPrivateLinkResourceProvisioningState. \
1551
- * {@link KnownSharedPrivateLinkResourceProvisioningState} can be used interchangeably with SharedPrivateLinkResourceProvisioningState,
1552
- * this enum contains the known values that the service supports.
1553
- * ### Known values supported by the service
1554
- * **Updating**: The shared private link resource is in the process of being created along with other resources for it to be fully functional. \
1555
- * **Deleting**: The shared private link resource is in the process of being deleted. \
1556
- * **Failed**: The shared private link resource has failed to be provisioned or deleted. \
1557
- * **Succeeded**: The shared private link resource has finished provisioning and is ready for approval. \
1558
- * **Incomplete**: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet.
1559
- */
1560
- export declare type SharedPrivateLinkResourceProvisioningState = string;
1561
-
1562
- /** Interface representing a SharedPrivateLinkResources. */
1563
- export declare interface SharedPrivateLinkResources {
1564
- /**
1565
- * Gets a list of all shared private link resources managed by the given service.
1566
- * @param resourceGroupName The name of the resource group within the current subscription. You can
1567
- * obtain this value from the Azure Resource Manager API or the portal.
1568
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
1569
- * resource group.
1570
- * @param options The options parameters.
1571
- */
1572
- listByService(resourceGroupName: string, searchServiceName: string, options?: SharedPrivateLinkResourcesListByServiceOptionalParams): PagedAsyncIterableIterator<SharedPrivateLinkResource>;
1573
- /**
1574
- * Initiates the creation or update of a shared private link resource managed by the search service in
1575
- * the given resource group.
1576
- * @param resourceGroupName The name of the resource group within the current subscription. You can
1577
- * obtain this value from the Azure Resource Manager API or the portal.
1578
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
1579
- * resource group.
1580
- * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
1581
- * Azure AI Search service within the specified resource group.
1582
- * @param sharedPrivateLinkResource The definition of the shared private link resource to create or
1583
- * update.
1584
- * @param options The options parameters.
1585
- */
1586
- beginCreateOrUpdate(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, sharedPrivateLinkResource: SharedPrivateLinkResource, options?: SharedPrivateLinkResourcesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SharedPrivateLinkResourcesCreateOrUpdateResponse>, SharedPrivateLinkResourcesCreateOrUpdateResponse>>;
1587
- /**
1588
- * Initiates the creation or update of a shared private link resource managed by the search service in
1589
- * the given resource group.
1590
- * @param resourceGroupName The name of the resource group within the current subscription. You can
1591
- * obtain this value from the Azure Resource Manager API or the portal.
1592
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
1593
- * resource group.
1594
- * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
1595
- * Azure AI Search service within the specified resource group.
1596
- * @param sharedPrivateLinkResource The definition of the shared private link resource to create or
1597
- * update.
1598
- * @param options The options parameters.
1599
- */
1600
- beginCreateOrUpdateAndWait(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, sharedPrivateLinkResource: SharedPrivateLinkResource, options?: SharedPrivateLinkResourcesCreateOrUpdateOptionalParams): Promise<SharedPrivateLinkResourcesCreateOrUpdateResponse>;
1601
- /**
1602
- * Gets the details of the shared private link resource managed by the search service in the given
1603
- * resource group.
1604
- * @param resourceGroupName The name of the resource group within the current subscription. You can
1605
- * obtain this value from the Azure Resource Manager API or the portal.
1606
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
1607
- * resource group.
1608
- * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
1609
- * Azure AI Search service within the specified resource group.
1610
- * @param options The options parameters.
1611
- */
1612
- get(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesGetOptionalParams): Promise<SharedPrivateLinkResourcesGetResponse>;
1613
- /**
1614
- * Initiates the deletion of the shared private link resource from the search service.
1615
- * @param resourceGroupName The name of the resource group within the current subscription. You can
1616
- * obtain this value from the Azure Resource Manager API or the portal.
1617
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
1618
- * resource group.
1619
- * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
1620
- * Azure AI Search service within the specified resource group.
1621
- * @param options The options parameters.
1622
- */
1623
- beginDelete(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
1624
- /**
1625
- * Initiates the deletion of the shared private link resource from the search service.
1626
- * @param resourceGroupName The name of the resource group within the current subscription. You can
1627
- * obtain this value from the Azure Resource Manager API or the portal.
1628
- * @param searchServiceName The name of the Azure AI Search service associated with the specified
1629
- * resource group.
1630
- * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
1631
- * Azure AI Search service within the specified resource group.
1632
- * @param options The options parameters.
1633
- */
1634
- beginDeleteAndWait(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesDeleteOptionalParams): Promise<void>;
1635
- }
1636
-
1637
- /** Optional parameters. */
1638
- export declare interface SharedPrivateLinkResourcesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
1639
- /** Parameter group */
1640
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1641
- /** Delay to wait until next poll, in milliseconds. */
1642
- updateIntervalInMs?: number;
1643
- /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1644
- resumeFrom?: string;
1645
- }
1646
-
1647
- /** Contains response data for the createOrUpdate operation. */
1648
- export declare type SharedPrivateLinkResourcesCreateOrUpdateResponse = SharedPrivateLinkResource;
1649
-
1650
- /** Optional parameters. */
1651
- export declare interface SharedPrivateLinkResourcesDeleteOptionalParams extends coreClient.OperationOptions {
1652
- /** Parameter group */
1653
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1654
- /** Delay to wait until next poll, in milliseconds. */
1655
- updateIntervalInMs?: number;
1656
- /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1657
- resumeFrom?: string;
1658
- }
1659
-
1660
- /** Optional parameters. */
1661
- export declare interface SharedPrivateLinkResourcesGetOptionalParams extends coreClient.OperationOptions {
1662
- /** Parameter group */
1663
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1664
- }
1665
-
1666
- /** Contains response data for the get operation. */
1667
- export declare type SharedPrivateLinkResourcesGetResponse = SharedPrivateLinkResource;
1668
-
1669
- /** Optional parameters. */
1670
- export declare interface SharedPrivateLinkResourcesListByServiceNextOptionalParams extends coreClient.OperationOptions {
1671
- /** Parameter group */
1672
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1673
- }
1674
-
1675
- /** Contains response data for the listByServiceNext operation. */
1676
- export declare type SharedPrivateLinkResourcesListByServiceNextResponse = SharedPrivateLinkResourceListResult;
1677
-
1678
- /** Optional parameters. */
1679
- export declare interface SharedPrivateLinkResourcesListByServiceOptionalParams extends coreClient.OperationOptions {
1680
- /** Parameter group */
1681
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1682
- }
1683
-
1684
- /** Contains response data for the listByService operation. */
1685
- export declare type SharedPrivateLinkResourcesListByServiceResponse = SharedPrivateLinkResourceListResult;
1686
-
1687
- /**
1688
- * Defines values for SharedPrivateLinkResourceStatus. \
1689
- * {@link KnownSharedPrivateLinkResourceStatus} can be used interchangeably with SharedPrivateLinkResourceStatus,
1690
- * this enum contains the known values that the service supports.
1691
- * ### Known values supported by the service
1692
- * **Pending**: The shared private link resource has been created and is pending approval. \
1693
- * **Approved**: The shared private link resource is approved and is ready for use. \
1694
- * **Rejected**: The shared private link resource has been rejected and cannot be used. \
1695
- * **Disconnected**: The shared private link resource has been removed from the service.
1696
- */
1697
- export declare type SharedPrivateLinkResourceStatus = string;
1698
-
1699
- /** Defines the SKU of a search service, which determines billing rate and capacity limits. */
1700
- export declare interface Sku {
1701
- /** The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.' */
1702
- name?: SkuName;
1703
- }
1704
-
1705
- /**
1706
- * Defines values for SkuName. \
1707
- * {@link KnownSkuName} can be used interchangeably with SkuName,
1708
- * this enum contains the known values that the service supports.
1709
- * ### Known values supported by the service
1710
- * **free**: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. \
1711
- * **basic**: Billable tier for a dedicated service having up to 3 replicas. \
1712
- * **standard**: Billable tier for a dedicated service having up to 12 partitions and 12 replicas. \
1713
- * **standard2**: Similar to 'standard', but with more capacity per search unit. \
1714
- * **standard3**: The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). \
1715
- * **storage_optimized_l1**: Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions. \
1716
- * **storage_optimized_l2**: Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.
1717
- */
1718
- export declare type SkuName = string;
1719
-
1720
- /** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
1721
- export declare interface TrackedResource extends Resource {
1722
- /** Resource tags. */
1723
- tags?: {
1724
- [propertyName: string]: string;
1725
- };
1726
- /** The geo-location where the resource lives */
1727
- location: string;
1728
- }
1729
-
1730
- /**
1731
- * Defines values for UnavailableNameReason. \
1732
- * {@link KnownUnavailableNameReason} can be used interchangeably with UnavailableNameReason,
1733
- * this enum contains the known values that the service supports.
1734
- * ### Known values supported by the service
1735
- * **Invalid**: The search service name doesn't match naming requirements. \
1736
- * **AlreadyExists**: The search service name is already assigned to a different search service.
1737
- */
1738
- export declare type UnavailableNameReason = string;
1739
-
1740
- /** Optional parameters. */
1741
- export declare interface UsageBySubscriptionSkuOptionalParams extends coreClient.OperationOptions {
1742
- /** Parameter group */
1743
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1744
- }
1745
-
1746
- /** Contains response data for the usageBySubscriptionSku operation. */
1747
- export declare type UsageBySubscriptionSkuResponse = QuotaUsageResult;
1748
-
1749
- /** Interface representing a Usages. */
1750
- export declare interface Usages {
1751
- /**
1752
- * Get a list of all Azure AI Search quota usages across the subscription.
1753
- * @param location The unique location name for a Microsoft Azure geographic region.
1754
- * @param options The options parameters.
1755
- */
1756
- listBySubscription(location: string, options?: UsagesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<QuotaUsageResult>;
1757
- }
1758
-
1759
- /** Optional parameters. */
1760
- export declare interface UsagesListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
1761
- /** Parameter group */
1762
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1763
- }
1764
-
1765
- /** Contains response data for the listBySubscriptionNext operation. */
1766
- export declare type UsagesListBySubscriptionNextResponse = QuotaUsagesListResult;
1767
-
1768
- /** Optional parameters. */
1769
- export declare interface UsagesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
1770
- /** Parameter group */
1771
- searchManagementRequestOptions?: SearchManagementRequestOptions;
1772
- }
1773
-
1774
- /** Contains response data for the listBySubscription operation. */
1775
- export declare type UsagesListBySubscriptionResponse = QuotaUsagesListResult;
1776
-
1777
- /** The details of the user assigned managed identity assigned to the search service. */
1778
- export declare interface UserAssignedManagedIdentity {
1779
- /**
1780
- * The principal ID of user assigned identity.
1781
- * NOTE: This property will not be serialized. It can only be populated by the server.
1782
- */
1783
- readonly principalId?: string;
1784
- /**
1785
- * The client ID of user assigned identity.
1786
- * NOTE: This property will not be serialized. It can only be populated by the server.
1787
- */
1788
- readonly clientId?: string;
1789
- }
1790
-
1791
- export { }
1
+ import * as coreClient from "@azure/core-client";
2
+ /** The result of the request to list REST API operations. It contains a list of operations and a URL to get the next set of results. */
3
+ export interface OperationListResult {
4
+ /**
5
+ * The list of operations by Azure AI Search, some supported by the resource provider and others by data plane APIs.
6
+ * NOTE: This property will not be serialized. It can only be populated by the server.
7
+ */
8
+ readonly value?: Operation[];
9
+ /**
10
+ * The URL to get the next set of operation list results, if any.
11
+ * NOTE: This property will not be serialized. It can only be populated by the server.
12
+ */
13
+ readonly nextLink?: string;
14
+ }
15
+ /** Describes a REST API operation. */
16
+ export interface Operation {
17
+ /**
18
+ * The name of the operation. This name is of the form {provider}/{resource}/{operation}.
19
+ * NOTE: This property will not be serialized. It can only be populated by the server.
20
+ */
21
+ readonly name?: string;
22
+ /**
23
+ * The object that describes the operation.
24
+ * NOTE: This property will not be serialized. It can only be populated by the server.
25
+ */
26
+ readonly display?: OperationDisplay;
27
+ /**
28
+ * Describes if the specified operation is a data plane API operation. Operations where this value is not true are supported directly by the resource provider.
29
+ * NOTE: This property will not be serialized. It can only be populated by the server.
30
+ */
31
+ readonly isDataAction?: boolean;
32
+ /**
33
+ * Describes which originating entities are allowed to invoke this operation.
34
+ * NOTE: This property will not be serialized. It can only be populated by the server.
35
+ */
36
+ readonly origin?: string;
37
+ /**
38
+ * Describes additional properties for this operation.
39
+ * NOTE: This property will not be serialized. It can only be populated by the server.
40
+ */
41
+ readonly properties?: OperationProperties;
42
+ }
43
+ /** The object that describes the operation. */
44
+ export interface OperationDisplay {
45
+ /**
46
+ * The friendly name of the resource provider.
47
+ * NOTE: This property will not be serialized. It can only be populated by the server.
48
+ */
49
+ readonly provider?: string;
50
+ /**
51
+ * The operation type: read, write, delete, listKeys/action, etc.
52
+ * NOTE: This property will not be serialized. It can only be populated by the server.
53
+ */
54
+ readonly operation?: string;
55
+ /**
56
+ * The resource type on which the operation is performed.
57
+ * NOTE: This property will not be serialized. It can only be populated by the server.
58
+ */
59
+ readonly resource?: string;
60
+ /**
61
+ * The friendly name of the operation.
62
+ * NOTE: This property will not be serialized. It can only be populated by the server.
63
+ */
64
+ readonly description?: string;
65
+ }
66
+ /** Describes additional properties for this operation. */
67
+ export interface OperationProperties {
68
+ /**
69
+ * Specifications of the service for this operation.
70
+ * NOTE: This property will not be serialized. It can only be populated by the server.
71
+ */
72
+ readonly serviceSpecification?: OperationServiceSpecification;
73
+ }
74
+ /** Specifications of the service for this operation. */
75
+ export interface OperationServiceSpecification {
76
+ /**
77
+ * Specifications of metrics for this operation.
78
+ * NOTE: This property will not be serialized. It can only be populated by the server.
79
+ */
80
+ readonly metricSpecifications?: OperationMetricsSpecification[];
81
+ /**
82
+ * Specifications of logs for this operation.
83
+ * NOTE: This property will not be serialized. It can only be populated by the server.
84
+ */
85
+ readonly logSpecifications?: OperationLogsSpecification[];
86
+ }
87
+ /** Specifications of one type of metric for this operation. */
88
+ export interface OperationMetricsSpecification {
89
+ /**
90
+ * The name of the metric specification.
91
+ * NOTE: This property will not be serialized. It can only be populated by the server.
92
+ */
93
+ readonly name?: string;
94
+ /**
95
+ * The display name of the metric specification.
96
+ * NOTE: This property will not be serialized. It can only be populated by the server.
97
+ */
98
+ readonly displayName?: string;
99
+ /**
100
+ * The display description of the metric specification.
101
+ * NOTE: This property will not be serialized. It can only be populated by the server.
102
+ */
103
+ readonly displayDescription?: string;
104
+ /**
105
+ * The unit for the metric specification.
106
+ * NOTE: This property will not be serialized. It can only be populated by the server.
107
+ */
108
+ readonly unit?: string;
109
+ /**
110
+ * The type of aggregation for the metric specification.
111
+ * NOTE: This property will not be serialized. It can only be populated by the server.
112
+ */
113
+ readonly aggregationType?: string;
114
+ /**
115
+ * Dimensions for the metric specification.
116
+ * NOTE: This property will not be serialized. It can only be populated by the server.
117
+ */
118
+ readonly dimensions?: OperationMetricDimension[];
119
+ /**
120
+ * Availabilities for the metric specification.
121
+ * NOTE: This property will not be serialized. It can only be populated by the server.
122
+ */
123
+ readonly availabilities?: OperationAvailability[];
124
+ }
125
+ /** Describes a particular dimension for the metric specification. */
126
+ export interface OperationMetricDimension {
127
+ /**
128
+ * The name of the dimension.
129
+ * NOTE: This property will not be serialized. It can only be populated by the server.
130
+ */
131
+ readonly name?: string;
132
+ /**
133
+ * The display name of the dimension.
134
+ * NOTE: This property will not be serialized. It can only be populated by the server.
135
+ */
136
+ readonly displayName?: string;
137
+ }
138
+ /** Describes a particular availability for the metric specification. */
139
+ export interface OperationAvailability {
140
+ /**
141
+ * The time grain for the dimension.
142
+ * NOTE: This property will not be serialized. It can only be populated by the server.
143
+ */
144
+ readonly timeGrain?: string;
145
+ /**
146
+ * The blob duration for the dimension.
147
+ * NOTE: This property will not be serialized. It can only be populated by the server.
148
+ */
149
+ readonly blobDuration?: string;
150
+ }
151
+ /** Specifications of one type of log for this operation. */
152
+ export interface OperationLogsSpecification {
153
+ /**
154
+ * The name of the log specification.
155
+ * NOTE: This property will not be serialized. It can only be populated by the server.
156
+ */
157
+ readonly name?: string;
158
+ /**
159
+ * The display name of the log specification.
160
+ * NOTE: This property will not be serialized. It can only be populated by the server.
161
+ */
162
+ readonly displayName?: string;
163
+ /**
164
+ * The blob duration for the log specification.
165
+ * NOTE: This property will not be serialized. It can only be populated by the server.
166
+ */
167
+ readonly blobDuration?: string;
168
+ }
169
+ /** Contains information about an API error. */
170
+ export interface CloudError {
171
+ /** Describes a particular API error with an error code and a message. */
172
+ error?: CloudErrorBody;
173
+ /** A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). */
174
+ message?: string;
175
+ }
176
+ /** Describes a particular API error with an error code and a message. */
177
+ export interface CloudErrorBody {
178
+ /** An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. */
179
+ code?: string;
180
+ /** A message that describes the error in detail and provides debugging information. */
181
+ message?: string;
182
+ /** The target of the particular error (for example, the name of the property in error). */
183
+ target?: string;
184
+ /** Contains nested errors that are related to this error. */
185
+ details?: CloudErrorBody[];
186
+ }
187
+ /** Response containing the primary and secondary admin API keys for a given Azure AI Search service. */
188
+ export interface AdminKeyResult {
189
+ /**
190
+ * The primary admin API key of the search service.
191
+ * NOTE: This property will not be serialized. It can only be populated by the server.
192
+ */
193
+ readonly primaryKey?: string;
194
+ /**
195
+ * The secondary admin API key of the search service.
196
+ * NOTE: This property will not be serialized. It can only be populated by the server.
197
+ */
198
+ readonly secondaryKey?: string;
199
+ }
200
+ /** Describes an API key for a given Azure AI Search service that conveys read-only permissions on the docs collection of an index. */
201
+ export interface QueryKey {
202
+ /**
203
+ * The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used.
204
+ * NOTE: This property will not be serialized. It can only be populated by the server.
205
+ */
206
+ readonly name?: string;
207
+ /**
208
+ * The value of the query API key.
209
+ * NOTE: This property will not be serialized. It can only be populated by the server.
210
+ */
211
+ readonly key?: string;
212
+ }
213
+ /** Response containing the query API keys for a given Azure AI Search service. */
214
+ export interface ListQueryKeysResult {
215
+ /**
216
+ * The query keys for the Azure AI Search service.
217
+ * NOTE: This property will not be serialized. It can only be populated by the server.
218
+ */
219
+ readonly value?: QueryKey[];
220
+ /**
221
+ * Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size.
222
+ * NOTE: This property will not be serialized. It can only be populated by the server.
223
+ */
224
+ readonly nextLink?: string;
225
+ }
226
+ /** Network specific rules that determine how the Azure AI Search service may be reached. */
227
+ export interface NetworkRuleSet {
228
+ /** A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. */
229
+ ipRules?: IpRule[];
230
+ /** Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. */
231
+ bypass?: SearchBypass;
232
+ }
233
+ /** The IP restriction rule of the Azure AI Search service. */
234
+ export interface IpRule {
235
+ /** Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed. */
236
+ value?: string;
237
+ }
238
+ /** Describes a policy that determines how resources within the search service are to be encrypted with customer managed keys. */
239
+ export interface EncryptionWithCmk {
240
+ /** Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. */
241
+ enforcement?: SearchEncryptionWithCmk;
242
+ /**
243
+ * Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.
244
+ * NOTE: This property will not be serialized. It can only be populated by the server.
245
+ */
246
+ readonly encryptionComplianceStatus?: SearchEncryptionComplianceStatus;
247
+ }
248
+ /** Defines the options for how the search service authenticates a data plane request. This cannot be set if 'disableLocalAuth' is set to true. */
249
+ export interface DataPlaneAuthOptions {
250
+ /** Indicates that only the API key can be used for authentication. */
251
+ apiKeyOnly?: Record<string, unknown>;
252
+ /** Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. */
253
+ aadOrApiKey?: DataPlaneAadOrApiKeyAuthOption;
254
+ }
255
+ /** Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. */
256
+ export interface DataPlaneAadOrApiKeyAuthOption {
257
+ /** Describes what response the data plane API of a search service would send for requests that failed authentication. */
258
+ aadAuthFailureMode?: AadAuthFailureMode;
259
+ }
260
+ /** Describes the properties of an existing private endpoint connection to the search service. */
261
+ export interface PrivateEndpointConnectionProperties {
262
+ /** The private endpoint resource from Microsoft.Network provider. */
263
+ privateEndpoint?: PrivateEndpointConnectionPropertiesPrivateEndpoint;
264
+ /** Describes the current state of an existing Azure Private Link service connection to the private endpoint. */
265
+ privateLinkServiceConnectionState?: PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState;
266
+ /** The group ID of the Azure resource for which the private link service is for. */
267
+ groupId?: string;
268
+ /** The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. */
269
+ provisioningState?: PrivateLinkServiceConnectionProvisioningState;
270
+ }
271
+ /** The private endpoint resource from Microsoft.Network provider. */
272
+ export interface PrivateEndpointConnectionPropertiesPrivateEndpoint {
273
+ /** The resource ID of the private endpoint resource from Microsoft.Network provider. */
274
+ id?: string;
275
+ }
276
+ /** Describes the current state of an existing Azure Private Link service connection to the private endpoint. */
277
+ export interface PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState {
278
+ /** Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. */
279
+ status?: PrivateLinkServiceConnectionStatus;
280
+ /** The description for the private link service connection state. */
281
+ description?: string;
282
+ /** A description of any extra actions that may be required. */
283
+ actionsRequired?: string;
284
+ }
285
+ /** Common fields that are returned in the response for all Azure Resource Manager resources */
286
+ export interface Resource {
287
+ /**
288
+ * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
289
+ * NOTE: This property will not be serialized. It can only be populated by the server.
290
+ */
291
+ readonly id?: string;
292
+ /**
293
+ * The name of the resource
294
+ * NOTE: This property will not be serialized. It can only be populated by the server.
295
+ */
296
+ readonly name?: string;
297
+ /**
298
+ * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
299
+ * NOTE: This property will not be serialized. It can only be populated by the server.
300
+ */
301
+ readonly type?: string;
302
+ }
303
+ /** Describes the properties of an existing shared private link resource managed by the Azure AI Search service. */
304
+ export interface SharedPrivateLinkResourceProperties {
305
+ /** The resource ID of the resource the shared private link resource is for. */
306
+ privateLinkResourceId?: string;
307
+ /** The group ID from the provider of resource the shared private link resource is for. */
308
+ groupId?: string;
309
+ /** The message for requesting approval of the shared private link resource. */
310
+ requestMessage?: string;
311
+ /** Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service). */
312
+ resourceRegion?: string;
313
+ /** Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. */
314
+ status?: SharedPrivateLinkResourceStatus;
315
+ /** The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. */
316
+ provisioningState?: SharedPrivateLinkResourceProvisioningState;
317
+ }
318
+ /** Defines the SKU of a search service, which determines billing rate and capacity limits. */
319
+ export interface Sku {
320
+ /** The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.' */
321
+ name?: SkuName;
322
+ }
323
+ /** Details about the search service identity. A null value indicates that the search service has no identity assigned. */
324
+ export interface Identity {
325
+ /**
326
+ * The principal ID of the system-assigned identity of the search service.
327
+ * NOTE: This property will not be serialized. It can only be populated by the server.
328
+ */
329
+ readonly principalId?: string;
330
+ /**
331
+ * The tenant ID of the system-assigned identity of the search service.
332
+ * NOTE: This property will not be serialized. It can only be populated by the server.
333
+ */
334
+ readonly tenantId?: string;
335
+ /** The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service. */
336
+ type: IdentityType;
337
+ /** The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */
338
+ userAssignedIdentities?: {
339
+ [propertyName: string]: UserAssignedManagedIdentity;
340
+ };
341
+ }
342
+ /** The details of the user assigned managed identity assigned to the search service. */
343
+ export interface UserAssignedManagedIdentity {
344
+ /**
345
+ * The principal ID of user assigned identity.
346
+ * NOTE: This property will not be serialized. It can only be populated by the server.
347
+ */
348
+ readonly principalId?: string;
349
+ /**
350
+ * The client ID of user assigned identity.
351
+ * NOTE: This property will not be serialized. It can only be populated by the server.
352
+ */
353
+ readonly clientId?: string;
354
+ }
355
+ /** Response containing a list of Azure AI Search services. */
356
+ export interface SearchServiceListResult {
357
+ /**
358
+ * The list of search services.
359
+ * NOTE: This property will not be serialized. It can only be populated by the server.
360
+ */
361
+ readonly value?: SearchService[];
362
+ /**
363
+ * Request URL that can be used to query next page of search services. Returned when the total number of requested search services exceed maximum page size.
364
+ * NOTE: This property will not be serialized. It can only be populated by the server.
365
+ */
366
+ readonly nextLink?: string;
367
+ }
368
+ /** Response containing a list of supported Private Link Resources. */
369
+ export interface PrivateLinkResourcesResult {
370
+ /**
371
+ * The list of supported Private Link Resources.
372
+ * NOTE: This property will not be serialized. It can only be populated by the server.
373
+ */
374
+ readonly value?: PrivateLinkResource[];
375
+ }
376
+ /** Describes the properties of a supported private link resource for the Azure AI Search service. For a given API version, this represents the 'supported' groupIds when creating a shared private link resource. */
377
+ export interface PrivateLinkResourceProperties {
378
+ /**
379
+ * The group ID of the private link resource.
380
+ * NOTE: This property will not be serialized. It can only be populated by the server.
381
+ */
382
+ readonly groupId?: string;
383
+ /**
384
+ * The list of required members of the private link resource.
385
+ * NOTE: This property will not be serialized. It can only be populated by the server.
386
+ */
387
+ readonly requiredMembers?: string[];
388
+ /**
389
+ * The list of required DNS zone names of the private link resource.
390
+ * NOTE: This property will not be serialized. It can only be populated by the server.
391
+ */
392
+ readonly requiredZoneNames?: string[];
393
+ /**
394
+ * The list of resources that are onboarded to private link service, that are supported by Azure AI Search.
395
+ * NOTE: This property will not be serialized. It can only be populated by the server.
396
+ */
397
+ readonly shareablePrivateLinkResourceTypes?: ShareablePrivateLinkResourceType[];
398
+ }
399
+ /** Describes an resource type that has been onboarded to private link service, supported by Azure AI Search. */
400
+ export interface ShareablePrivateLinkResourceType {
401
+ /**
402
+ * The name of the resource type that has been onboarded to private link service, supported by Azure AI Search.
403
+ * NOTE: This property will not be serialized. It can only be populated by the server.
404
+ */
405
+ readonly name?: string;
406
+ /**
407
+ * Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search.
408
+ * NOTE: This property will not be serialized. It can only be populated by the server.
409
+ */
410
+ readonly properties?: ShareablePrivateLinkResourceProperties;
411
+ }
412
+ /** Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search. */
413
+ export interface ShareablePrivateLinkResourceProperties {
414
+ /**
415
+ * The resource provider type for the resource that has been onboarded to private link service, supported by Azure AI Search.
416
+ * NOTE: This property will not be serialized. It can only be populated by the server.
417
+ */
418
+ readonly type?: string;
419
+ /**
420
+ * The resource provider group id for the resource that has been onboarded to private link service, supported by Azure AI Search.
421
+ * NOTE: This property will not be serialized. It can only be populated by the server.
422
+ */
423
+ readonly groupId?: string;
424
+ /**
425
+ * The description of the resource type that has been onboarded to private link service, supported by Azure AI Search.
426
+ * NOTE: This property will not be serialized. It can only be populated by the server.
427
+ */
428
+ readonly description?: string;
429
+ }
430
+ /** Response containing a list of private endpoint connections. */
431
+ export interface PrivateEndpointConnectionListResult {
432
+ /**
433
+ * The list of private endpoint connections.
434
+ * NOTE: This property will not be serialized. It can only be populated by the server.
435
+ */
436
+ readonly value?: PrivateEndpointConnection[];
437
+ /**
438
+ * Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.
439
+ * NOTE: This property will not be serialized. It can only be populated by the server.
440
+ */
441
+ readonly nextLink?: string;
442
+ }
443
+ /** Response containing a list of shared private link resources. */
444
+ export interface SharedPrivateLinkResourceListResult {
445
+ /**
446
+ * The list of shared private link resources.
447
+ * NOTE: This property will not be serialized. It can only be populated by the server.
448
+ */
449
+ readonly value?: SharedPrivateLinkResource[];
450
+ /** The URL to get the next set of shared private link resources, if there are any. */
451
+ nextLink?: string;
452
+ }
453
+ /** Input of check name availability API. */
454
+ export interface CheckNameAvailabilityInput {
455
+ /** The search service name to validate. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. */
456
+ name: string;
457
+ /** The type of the resource whose name is to be validated. This value must always be 'searchServices'. */
458
+ type: "searchServices";
459
+ }
460
+ /** Output of check name availability API. */
461
+ export interface CheckNameAvailabilityOutput {
462
+ /**
463
+ * A value indicating whether the name is available.
464
+ * NOTE: This property will not be serialized. It can only be populated by the server.
465
+ */
466
+ readonly isNameAvailable?: boolean;
467
+ /**
468
+ * The reason why the name is not available. 'Invalid' indicates the name provided does not match the naming requirements (incorrect length, unsupported characters, etc.). 'AlreadyExists' indicates that the name is already in use and is therefore unavailable.
469
+ * NOTE: This property will not be serialized. It can only be populated by the server.
470
+ */
471
+ readonly reason?: UnavailableNameReason;
472
+ /**
473
+ * A message that explains why the name is invalid and provides resource naming requirements. Available only if 'Invalid' is returned in the 'reason' property.
474
+ * NOTE: This property will not be serialized. It can only be populated by the server.
475
+ */
476
+ readonly message?: string;
477
+ }
478
+ /** Response containing the quota usage information for all the supported SKUs of Azure AI Search. */
479
+ export interface QuotaUsagesListResult {
480
+ /**
481
+ * The quota usages for the SKUs supported by Azure AI Search.
482
+ * NOTE: This property will not be serialized. It can only be populated by the server.
483
+ */
484
+ readonly value?: QuotaUsageResult[];
485
+ /**
486
+ * Request URL that can be used to query next page of quota usages. Returned when the total number of requested quota usages exceed maximum page size.
487
+ * NOTE: This property will not be serialized. It can only be populated by the server.
488
+ */
489
+ readonly nextLink?: string;
490
+ }
491
+ /** Describes the quota usage for a particular SKU. */
492
+ export interface QuotaUsageResult {
493
+ /** The resource ID of the quota usage SKU endpoint for Microsoft.Search provider. */
494
+ id?: string;
495
+ /** The unit of measurement for the search SKU. */
496
+ unit?: string;
497
+ /** The currently used up value for the particular search SKU. */
498
+ currentValue?: number;
499
+ /** The quota limit for the particular search SKU. */
500
+ limit?: number;
501
+ /**
502
+ * The name of the SKU supported by Azure AI Search.
503
+ * NOTE: This property will not be serialized. It can only be populated by the server.
504
+ */
505
+ readonly name?: QuotaUsageResultName;
506
+ }
507
+ /** The name of the SKU supported by Azure AI Search. */
508
+ export interface QuotaUsageResultName {
509
+ /** The SKU name supported by Azure AI Search. */
510
+ value?: string;
511
+ /** The localized string value for the SKU name. */
512
+ localizedValue?: string;
513
+ }
514
+ /** A list of network security perimeter configurations for a server. */
515
+ export interface NetworkSecurityPerimeterConfigurationListResult {
516
+ /**
517
+ * Array of results.
518
+ * NOTE: This property will not be serialized. It can only be populated by the server.
519
+ */
520
+ readonly value?: NetworkSecurityPerimeterConfiguration[];
521
+ /**
522
+ * Link to retrieve next page of results.
523
+ * NOTE: This property will not be serialized. It can only be populated by the server.
524
+ */
525
+ readonly nextLink?: string;
526
+ }
527
+ /** The perimeter for a network security perimeter configuration. */
528
+ export interface NSPConfigPerimeter {
529
+ id?: string;
530
+ perimeterGuid?: string;
531
+ location?: string;
532
+ }
533
+ /** The resource association for the network security perimeter. */
534
+ export interface NSPConfigAssociation {
535
+ name?: string;
536
+ accessMode?: string;
537
+ }
538
+ /** The profile for a network security perimeter configuration. */
539
+ export interface NSPConfigProfile {
540
+ name?: string;
541
+ accessRulesVersion?: string;
542
+ accessRules?: NSPConfigAccessRule[];
543
+ }
544
+ /** An access rule for a network security perimeter configuration. */
545
+ export interface NSPConfigAccessRule {
546
+ name?: string;
547
+ /** The properties for the access rules in a network security perimeter configuration. */
548
+ properties?: NSPConfigAccessRuleProperties;
549
+ }
550
+ /** The properties for the access rules in a network security perimeter configuration. */
551
+ export interface NSPConfigAccessRuleProperties {
552
+ direction?: string;
553
+ addressPrefixes?: string[];
554
+ fullyQualifiedDomainNames?: string[];
555
+ subscriptions?: string[];
556
+ networkSecurityPerimeters?: NSPConfigNetworkSecurityPerimeterRule[];
557
+ }
558
+ /** The network security perimeter properties present in a configuration rule. */
559
+ export interface NSPConfigNetworkSecurityPerimeterRule {
560
+ id?: string;
561
+ perimeterGuid?: string;
562
+ location?: string;
563
+ }
564
+ /** An object to describe any issues with provisioning network security perimeters to a search service. */
565
+ export interface NSPProvisioningIssue {
566
+ name?: string;
567
+ /** The properties to describe any issues with provisioning network security perimeters to a search service. */
568
+ properties?: NSPProvisioningIssueProperties;
569
+ }
570
+ /** The properties to describe any issues with provisioning network security perimeters to a search service. */
571
+ export interface NSPProvisioningIssueProperties {
572
+ issueType?: string;
573
+ severity?: string;
574
+ description?: string;
575
+ suggestedResourceIds?: string[];
576
+ suggestedAccessRules?: string[];
577
+ }
578
+ /** The details of a long running asynchronous shared private link resource operation. */
579
+ export interface AsyncOperationResult {
580
+ /** The current status of the long running asynchronous shared private link resource operation. */
581
+ status?: SharedPrivateLinkResourceAsyncOperationResult;
582
+ }
583
+ /** Describes an existing private endpoint connection to the Azure AI Search service. */
584
+ export interface PrivateEndpointConnection extends Resource {
585
+ /** Describes the properties of an existing private endpoint connection to the Azure AI Search service. */
586
+ properties?: PrivateEndpointConnectionProperties;
587
+ }
588
+ /** Describes a shared private link resource managed by the Azure AI Search service. */
589
+ export interface SharedPrivateLinkResource extends Resource {
590
+ /** Describes the properties of a shared private link resource managed by the Azure AI Search service. */
591
+ properties?: SharedPrivateLinkResourceProperties;
592
+ }
593
+ /** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
594
+ export interface TrackedResource extends Resource {
595
+ /** Resource tags. */
596
+ tags?: {
597
+ [propertyName: string]: string;
598
+ };
599
+ /** The geo-location where the resource lives */
600
+ location: string;
601
+ }
602
+ /** The parameters used to update an Azure AI Search service. */
603
+ export interface SearchServiceUpdate extends Resource {
604
+ /** The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. */
605
+ sku?: Sku;
606
+ /** The geographic location of the resource. This must be one of the supported and registered Azure geo regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource. */
607
+ location?: string;
608
+ /** Tags to help categorize the resource in the Azure portal. */
609
+ tags?: {
610
+ [propertyName: string]: string;
611
+ };
612
+ /** Details about the search service identity. A null value indicates that the search service has no identity assigned. */
613
+ identity?: Identity;
614
+ /** The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU. */
615
+ replicaCount?: number;
616
+ /** The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3. */
617
+ partitionCount?: number;
618
+ /** Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'. */
619
+ hostingMode?: HostingMode;
620
+ /** This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. */
621
+ publicNetworkAccess?: PublicNetworkAccess;
622
+ /**
623
+ * The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
624
+ * NOTE: This property will not be serialized. It can only be populated by the server.
625
+ */
626
+ readonly status?: SearchServiceStatus;
627
+ /**
628
+ * The details of the search service status.
629
+ * NOTE: This property will not be serialized. It can only be populated by the server.
630
+ */
631
+ readonly statusDetails?: string;
632
+ /**
633
+ * The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'Succeeded' or 'Failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'Succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
634
+ * NOTE: This property will not be serialized. It can only be populated by the server.
635
+ */
636
+ readonly provisioningState?: ProvisioningState;
637
+ /** Network specific rules that determine how the Azure AI Search service may be reached. */
638
+ networkRuleSet?: NetworkRuleSet;
639
+ /** A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future. */
640
+ disabledDataExfiltrationOptions?: SearchDisabledDataExfiltrationOption[];
641
+ /** Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. */
642
+ encryptionWithCmk?: EncryptionWithCmk;
643
+ /** When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. */
644
+ disableLocalAuth?: boolean;
645
+ /** Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. */
646
+ authOptions?: DataPlaneAuthOptions;
647
+ /** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. */
648
+ semanticSearch?: SearchSemanticSearch;
649
+ /**
650
+ * The list of private endpoint connections to the Azure AI Search service.
651
+ * NOTE: This property will not be serialized. It can only be populated by the server.
652
+ */
653
+ readonly privateEndpointConnections?: PrivateEndpointConnection[];
654
+ /**
655
+ * The list of shared private link resources managed by the Azure AI Search service.
656
+ * NOTE: This property will not be serialized. It can only be populated by the server.
657
+ */
658
+ readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
659
+ /**
660
+ * A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
661
+ * NOTE: This property will not be serialized. It can only be populated by the server.
662
+ */
663
+ readonly eTag?: string;
664
+ }
665
+ /** Describes a supported private link resource for the Azure AI Search service. */
666
+ export interface PrivateLinkResource extends Resource {
667
+ /**
668
+ * Describes the properties of a supported private link resource for the Azure AI Search service.
669
+ * NOTE: This property will not be serialized. It can only be populated by the server.
670
+ */
671
+ readonly properties?: PrivateLinkResourceProperties;
672
+ }
673
+ /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
674
+ export interface ProxyResource extends Resource {
675
+ }
676
+ /** Describes an Azure AI Search service and its current state. */
677
+ export interface SearchService extends TrackedResource {
678
+ /** The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. */
679
+ sku?: Sku;
680
+ /** The identity of the resource. */
681
+ identity?: Identity;
682
+ /** The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU. */
683
+ replicaCount?: number;
684
+ /** The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3. */
685
+ partitionCount?: number;
686
+ /** Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'. */
687
+ hostingMode?: HostingMode;
688
+ /** This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. */
689
+ publicNetworkAccess?: PublicNetworkAccess;
690
+ /**
691
+ * The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
692
+ * NOTE: This property will not be serialized. It can only be populated by the server.
693
+ */
694
+ readonly status?: SearchServiceStatus;
695
+ /**
696
+ * The details of the search service status.
697
+ * NOTE: This property will not be serialized. It can only be populated by the server.
698
+ */
699
+ readonly statusDetails?: string;
700
+ /**
701
+ * The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'Succeeded' or 'Failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'Succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
702
+ * NOTE: This property will not be serialized. It can only be populated by the server.
703
+ */
704
+ readonly provisioningState?: ProvisioningState;
705
+ /** Network specific rules that determine how the Azure AI Search service may be reached. */
706
+ networkRuleSet?: NetworkRuleSet;
707
+ /** A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future. */
708
+ disabledDataExfiltrationOptions?: SearchDisabledDataExfiltrationOption[];
709
+ /** Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. */
710
+ encryptionWithCmk?: EncryptionWithCmk;
711
+ /** When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. */
712
+ disableLocalAuth?: boolean;
713
+ /** Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. */
714
+ authOptions?: DataPlaneAuthOptions;
715
+ /** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. */
716
+ semanticSearch?: SearchSemanticSearch;
717
+ /**
718
+ * The list of private endpoint connections to the Azure AI Search service.
719
+ * NOTE: This property will not be serialized. It can only be populated by the server.
720
+ */
721
+ readonly privateEndpointConnections?: PrivateEndpointConnection[];
722
+ /**
723
+ * The list of shared private link resources managed by the Azure AI Search service.
724
+ * NOTE: This property will not be serialized. It can only be populated by the server.
725
+ */
726
+ readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
727
+ /**
728
+ * A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
729
+ * NOTE: This property will not be serialized. It can only be populated by the server.
730
+ */
731
+ readonly eTag?: string;
732
+ }
733
+ /** Network security perimeter configuration for a server. */
734
+ export interface NetworkSecurityPerimeterConfiguration extends ProxyResource {
735
+ /** NOTE: This property will not be serialized. It can only be populated by the server. */
736
+ readonly provisioningState?: string;
737
+ /** The perimeter for a network security perimeter configuration. */
738
+ networkSecurityPerimeter?: NSPConfigPerimeter;
739
+ /** The resource association for the network security perimeter. */
740
+ resourceAssociation?: NSPConfigAssociation;
741
+ /** The profile for a network security perimeter configuration. */
742
+ profile?: NSPConfigProfile;
743
+ provisioningIssues?: NSPProvisioningIssue[];
744
+ }
745
+ /** Defines headers for NetworkSecurityPerimeterConfigurations_reconcile operation. */
746
+ export interface NetworkSecurityPerimeterConfigurationsReconcileHeaders {
747
+ location?: string;
748
+ }
749
+ /** Parameter group */
750
+ export interface SearchManagementRequestOptions {
751
+ /** A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request. */
752
+ clientRequestId?: string;
753
+ }
754
+ /** Known values of {@link PublicNetworkAccess} that the service accepts. */
755
+ export declare enum KnownPublicNetworkAccess {
756
+ /** The search service is accessible from traffic originating from the public internet. */
757
+ Enabled = "enabled",
758
+ /** The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. */
759
+ Disabled = "disabled"
760
+ }
761
+ /**
762
+ * Defines values for PublicNetworkAccess. \
763
+ * {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
764
+ * this enum contains the known values that the service supports.
765
+ * ### Known values supported by the service
766
+ * **enabled**: The search service is accessible from traffic originating from the public internet. \
767
+ * **disabled**: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections.
768
+ */
769
+ export type PublicNetworkAccess = string;
770
+ /** Known values of {@link SearchBypass} that the service accepts. */
771
+ export declare enum KnownSearchBypass {
772
+ /** Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. */
773
+ None = "None",
774
+ /** Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. */
775
+ AzurePortal = "AzurePortal",
776
+ /** Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section. */
777
+ AzureServices = "AzureServices"
778
+ }
779
+ /**
780
+ * Defines values for SearchBypass. \
781
+ * {@link KnownSearchBypass} can be used interchangeably with SearchBypass,
782
+ * this enum contains the known values that the service supports.
783
+ * ### Known values supported by the service
784
+ * **None**: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. \
785
+ * **AzurePortal**: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. \
786
+ * **AzureServices**: Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section.
787
+ */
788
+ export type SearchBypass = string;
789
+ /** Known values of {@link SearchDisabledDataExfiltrationOption} that the service accepts. */
790
+ export declare enum KnownSearchDisabledDataExfiltrationOption {
791
+ /** Indicates that all data exfiltration scenarios are disabled. */
792
+ All = "All"
793
+ }
794
+ /**
795
+ * Defines values for SearchDisabledDataExfiltrationOption. \
796
+ * {@link KnownSearchDisabledDataExfiltrationOption} can be used interchangeably with SearchDisabledDataExfiltrationOption,
797
+ * this enum contains the known values that the service supports.
798
+ * ### Known values supported by the service
799
+ * **All**: Indicates that all data exfiltration scenarios are disabled.
800
+ */
801
+ export type SearchDisabledDataExfiltrationOption = string;
802
+ /** Known values of {@link SearchSemanticSearch} that the service accepts. */
803
+ export declare enum KnownSearchSemanticSearch {
804
+ /** Indicates that semantic reranker is disabled for the search service. This is the default. */
805
+ Disabled = "disabled",
806
+ /** Enables semantic reranker on a search service and indicates that it is to be used within the limits of the free plan. The free plan would cap the volume of semantic ranking requests and is offered at no extra charge. This is the default for newly provisioned search services. */
807
+ Free = "free",
808
+ /** Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. */
809
+ Standard = "standard"
810
+ }
811
+ /**
812
+ * Defines values for SearchSemanticSearch. \
813
+ * {@link KnownSearchSemanticSearch} can be used interchangeably with SearchSemanticSearch,
814
+ * this enum contains the known values that the service supports.
815
+ * ### Known values supported by the service
816
+ * **disabled**: Indicates that semantic reranker is disabled for the search service. This is the default. \
817
+ * **free**: Enables semantic reranker on a search service and indicates that it is to be used within the limits of the free plan. The free plan would cap the volume of semantic ranking requests and is offered at no extra charge. This is the default for newly provisioned search services. \
818
+ * **standard**: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries.
819
+ */
820
+ export type SearchSemanticSearch = string;
821
+ /** Known values of {@link PrivateLinkServiceConnectionProvisioningState} that the service accepts. */
822
+ export declare enum KnownPrivateLinkServiceConnectionProvisioningState {
823
+ /** The private link service connection is in the process of being created along with other resources for it to be fully functional. */
824
+ Updating = "Updating",
825
+ /** The private link service connection is in the process of being deleted. */
826
+ Deleting = "Deleting",
827
+ /** The private link service connection has failed to be provisioned or deleted. */
828
+ Failed = "Failed",
829
+ /** The private link service connection has finished provisioning and is ready for approval. */
830
+ Succeeded = "Succeeded",
831
+ /** Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. */
832
+ Incomplete = "Incomplete",
833
+ /** Provisioning request for the private link service connection resource has been canceled. */
834
+ Canceled = "Canceled"
835
+ }
836
+ /**
837
+ * Defines values for PrivateLinkServiceConnectionProvisioningState. \
838
+ * {@link KnownPrivateLinkServiceConnectionProvisioningState} can be used interchangeably with PrivateLinkServiceConnectionProvisioningState,
839
+ * this enum contains the known values that the service supports.
840
+ * ### Known values supported by the service
841
+ * **Updating**: The private link service connection is in the process of being created along with other resources for it to be fully functional. \
842
+ * **Deleting**: The private link service connection is in the process of being deleted. \
843
+ * **Failed**: The private link service connection has failed to be provisioned or deleted. \
844
+ * **Succeeded**: The private link service connection has finished provisioning and is ready for approval. \
845
+ * **Incomplete**: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. \
846
+ * **Canceled**: Provisioning request for the private link service connection resource has been canceled.
847
+ */
848
+ export type PrivateLinkServiceConnectionProvisioningState = string;
849
+ /** Known values of {@link SharedPrivateLinkResourceStatus} that the service accepts. */
850
+ export declare enum KnownSharedPrivateLinkResourceStatus {
851
+ /** The shared private link resource has been created and is pending approval. */
852
+ Pending = "Pending",
853
+ /** The shared private link resource is approved and is ready for use. */
854
+ Approved = "Approved",
855
+ /** The shared private link resource has been rejected and cannot be used. */
856
+ Rejected = "Rejected",
857
+ /** The shared private link resource has been removed from the service. */
858
+ Disconnected = "Disconnected"
859
+ }
860
+ /**
861
+ * Defines values for SharedPrivateLinkResourceStatus. \
862
+ * {@link KnownSharedPrivateLinkResourceStatus} can be used interchangeably with SharedPrivateLinkResourceStatus,
863
+ * this enum contains the known values that the service supports.
864
+ * ### Known values supported by the service
865
+ * **Pending**: The shared private link resource has been created and is pending approval. \
866
+ * **Approved**: The shared private link resource is approved and is ready for use. \
867
+ * **Rejected**: The shared private link resource has been rejected and cannot be used. \
868
+ * **Disconnected**: The shared private link resource has been removed from the service.
869
+ */
870
+ export type SharedPrivateLinkResourceStatus = string;
871
+ /** Known values of {@link SharedPrivateLinkResourceProvisioningState} that the service accepts. */
872
+ export declare enum KnownSharedPrivateLinkResourceProvisioningState {
873
+ /** The shared private link resource is in the process of being created along with other resources for it to be fully functional. */
874
+ Updating = "Updating",
875
+ /** The shared private link resource is in the process of being deleted. */
876
+ Deleting = "Deleting",
877
+ /** The shared private link resource has failed to be provisioned or deleted. */
878
+ Failed = "Failed",
879
+ /** The shared private link resource has finished provisioning and is ready for approval. */
880
+ Succeeded = "Succeeded",
881
+ /** Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. */
882
+ Incomplete = "Incomplete"
883
+ }
884
+ /**
885
+ * Defines values for SharedPrivateLinkResourceProvisioningState. \
886
+ * {@link KnownSharedPrivateLinkResourceProvisioningState} can be used interchangeably with SharedPrivateLinkResourceProvisioningState,
887
+ * this enum contains the known values that the service supports.
888
+ * ### Known values supported by the service
889
+ * **Updating**: The shared private link resource is in the process of being created along with other resources for it to be fully functional. \
890
+ * **Deleting**: The shared private link resource is in the process of being deleted. \
891
+ * **Failed**: The shared private link resource has failed to be provisioned or deleted. \
892
+ * **Succeeded**: The shared private link resource has finished provisioning and is ready for approval. \
893
+ * **Incomplete**: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet.
894
+ */
895
+ export type SharedPrivateLinkResourceProvisioningState = string;
896
+ /** Known values of {@link SkuName} that the service accepts. */
897
+ export declare enum KnownSkuName {
898
+ /** Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. */
899
+ Free = "free",
900
+ /** Billable tier for a dedicated service having up to 3 replicas. */
901
+ Basic = "basic",
902
+ /** Billable tier for a dedicated service having up to 12 partitions and 12 replicas. */
903
+ Standard = "standard",
904
+ /** Similar to 'standard', but with more capacity per search unit. */
905
+ Standard2 = "standard2",
906
+ /** The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). */
907
+ Standard3 = "standard3",
908
+ /** Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions. */
909
+ StorageOptimizedL1 = "storage_optimized_l1",
910
+ /** Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions. */
911
+ StorageOptimizedL2 = "storage_optimized_l2"
912
+ }
913
+ /**
914
+ * Defines values for SkuName. \
915
+ * {@link KnownSkuName} can be used interchangeably with SkuName,
916
+ * this enum contains the known values that the service supports.
917
+ * ### Known values supported by the service
918
+ * **free**: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. \
919
+ * **basic**: Billable tier for a dedicated service having up to 3 replicas. \
920
+ * **standard**: Billable tier for a dedicated service having up to 12 partitions and 12 replicas. \
921
+ * **standard2**: Similar to 'standard', but with more capacity per search unit. \
922
+ * **standard3**: The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). \
923
+ * **storage_optimized_l1**: Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions. \
924
+ * **storage_optimized_l2**: Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.
925
+ */
926
+ export type SkuName = string;
927
+ /** Known values of {@link IdentityType} that the service accepts. */
928
+ export declare enum KnownIdentityType {
929
+ /** Indicates that any identity associated with the search service needs to be removed. */
930
+ None = "None",
931
+ /** Indicates that system-assigned identity for the search service will be enabled. */
932
+ SystemAssigned = "SystemAssigned",
933
+ /** Indicates that one or more user assigned identities will be assigned to the search service. */
934
+ UserAssigned = "UserAssigned",
935
+ /** Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. */
936
+ SystemAssignedUserAssigned = "SystemAssigned, UserAssigned"
937
+ }
938
+ /**
939
+ * Defines values for IdentityType. \
940
+ * {@link KnownIdentityType} can be used interchangeably with IdentityType,
941
+ * this enum contains the known values that the service supports.
942
+ * ### Known values supported by the service
943
+ * **None**: Indicates that any identity associated with the search service needs to be removed. \
944
+ * **SystemAssigned**: Indicates that system-assigned identity for the search service will be enabled. \
945
+ * **UserAssigned**: Indicates that one or more user assigned identities will be assigned to the search service. \
946
+ * **SystemAssigned, UserAssigned**: Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities.
947
+ */
948
+ export type IdentityType = string;
949
+ /** Known values of {@link UnavailableNameReason} that the service accepts. */
950
+ export declare enum KnownUnavailableNameReason {
951
+ /** The search service name doesn't match naming requirements. */
952
+ Invalid = "Invalid",
953
+ /** The search service name is already assigned to a different search service. */
954
+ AlreadyExists = "AlreadyExists"
955
+ }
956
+ /**
957
+ * Defines values for UnavailableNameReason. \
958
+ * {@link KnownUnavailableNameReason} can be used interchangeably with UnavailableNameReason,
959
+ * this enum contains the known values that the service supports.
960
+ * ### Known values supported by the service
961
+ * **Invalid**: The search service name doesn't match naming requirements. \
962
+ * **AlreadyExists**: The search service name is already assigned to a different search service.
963
+ */
964
+ export type UnavailableNameReason = string;
965
+ /** Known values of {@link SharedPrivateLinkResourceAsyncOperationResult} that the service accepts. */
966
+ export declare enum KnownSharedPrivateLinkResourceAsyncOperationResult {
967
+ /** Running */
968
+ Running = "Running",
969
+ /** Succeeded */
970
+ Succeeded = "Succeeded",
971
+ /** Failed */
972
+ Failed = "Failed"
973
+ }
974
+ /**
975
+ * Defines values for SharedPrivateLinkResourceAsyncOperationResult. \
976
+ * {@link KnownSharedPrivateLinkResourceAsyncOperationResult} can be used interchangeably with SharedPrivateLinkResourceAsyncOperationResult,
977
+ * this enum contains the known values that the service supports.
978
+ * ### Known values supported by the service
979
+ * **Running** \
980
+ * **Succeeded** \
981
+ * **Failed**
982
+ */
983
+ export type SharedPrivateLinkResourceAsyncOperationResult = string;
984
+ /** Defines values for AdminKeyKind. */
985
+ export type AdminKeyKind = "primary" | "secondary";
986
+ /** Defines values for HostingMode. */
987
+ export type HostingMode = "default" | "highDensity";
988
+ /** Defines values for SearchServiceStatus. */
989
+ export type SearchServiceStatus = "running" | "provisioning" | "deleting" | "degraded" | "disabled" | "error" | "stopped";
990
+ /** Defines values for ProvisioningState. */
991
+ export type ProvisioningState = "Succeeded" | "Provisioning" | "Failed";
992
+ /** Defines values for SearchEncryptionWithCmk. */
993
+ export type SearchEncryptionWithCmk = "Disabled" | "Enabled" | "Unspecified";
994
+ /** Defines values for SearchEncryptionComplianceStatus. */
995
+ export type SearchEncryptionComplianceStatus = "Compliant" | "NonCompliant";
996
+ /** Defines values for AadAuthFailureMode. */
997
+ export type AadAuthFailureMode = "http403" | "http401WithBearerChallenge";
998
+ /** Defines values for PrivateLinkServiceConnectionStatus. */
999
+ export type PrivateLinkServiceConnectionStatus = "Pending" | "Approved" | "Rejected" | "Disconnected";
1000
+ /** Optional parameters. */
1001
+ export interface OperationsListOptionalParams extends coreClient.OperationOptions {
1002
+ }
1003
+ /** Contains response data for the list operation. */
1004
+ export type OperationsListResponse = OperationListResult;
1005
+ /** Optional parameters. */
1006
+ export interface AdminKeysGetOptionalParams extends coreClient.OperationOptions {
1007
+ /** Parameter group */
1008
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1009
+ }
1010
+ /** Contains response data for the get operation. */
1011
+ export type AdminKeysGetResponse = AdminKeyResult;
1012
+ /** Optional parameters. */
1013
+ export interface AdminKeysRegenerateOptionalParams extends coreClient.OperationOptions {
1014
+ /** Parameter group */
1015
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1016
+ }
1017
+ /** Contains response data for the regenerate operation. */
1018
+ export type AdminKeysRegenerateResponse = AdminKeyResult;
1019
+ /** Optional parameters. */
1020
+ export interface QueryKeysCreateOptionalParams extends coreClient.OperationOptions {
1021
+ /** Parameter group */
1022
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1023
+ }
1024
+ /** Contains response data for the create operation. */
1025
+ export type QueryKeysCreateResponse = QueryKey;
1026
+ /** Optional parameters. */
1027
+ export interface QueryKeysListBySearchServiceOptionalParams extends coreClient.OperationOptions {
1028
+ /** Parameter group */
1029
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1030
+ }
1031
+ /** Contains response data for the listBySearchService operation. */
1032
+ export type QueryKeysListBySearchServiceResponse = ListQueryKeysResult;
1033
+ /** Optional parameters. */
1034
+ export interface QueryKeysDeleteOptionalParams extends coreClient.OperationOptions {
1035
+ /** Parameter group */
1036
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1037
+ }
1038
+ /** Optional parameters. */
1039
+ export interface QueryKeysListBySearchServiceNextOptionalParams extends coreClient.OperationOptions {
1040
+ /** Parameter group */
1041
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1042
+ }
1043
+ /** Contains response data for the listBySearchServiceNext operation. */
1044
+ export type QueryKeysListBySearchServiceNextResponse = ListQueryKeysResult;
1045
+ /** Optional parameters. */
1046
+ export interface ServicesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
1047
+ /** Parameter group */
1048
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1049
+ /** Delay to wait until next poll, in milliseconds. */
1050
+ updateIntervalInMs?: number;
1051
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1052
+ resumeFrom?: string;
1053
+ }
1054
+ /** Contains response data for the createOrUpdate operation. */
1055
+ export type ServicesCreateOrUpdateResponse = SearchService;
1056
+ /** Optional parameters. */
1057
+ export interface ServicesUpdateOptionalParams extends coreClient.OperationOptions {
1058
+ /** Parameter group */
1059
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1060
+ }
1061
+ /** Contains response data for the update operation. */
1062
+ export type ServicesUpdateResponse = SearchService;
1063
+ /** Optional parameters. */
1064
+ export interface ServicesGetOptionalParams extends coreClient.OperationOptions {
1065
+ /** Parameter group */
1066
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1067
+ }
1068
+ /** Contains response data for the get operation. */
1069
+ export type ServicesGetResponse = SearchService;
1070
+ /** Optional parameters. */
1071
+ export interface ServicesDeleteOptionalParams extends coreClient.OperationOptions {
1072
+ /** Parameter group */
1073
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1074
+ }
1075
+ /** Optional parameters. */
1076
+ export interface ServicesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
1077
+ /** Parameter group */
1078
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1079
+ }
1080
+ /** Contains response data for the listByResourceGroup operation. */
1081
+ export type ServicesListByResourceGroupResponse = SearchServiceListResult;
1082
+ /** Optional parameters. */
1083
+ export interface ServicesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
1084
+ /** Parameter group */
1085
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1086
+ }
1087
+ /** Contains response data for the listBySubscription operation. */
1088
+ export type ServicesListBySubscriptionResponse = SearchServiceListResult;
1089
+ /** Optional parameters. */
1090
+ export interface ServicesCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
1091
+ /** Parameter group */
1092
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1093
+ }
1094
+ /** Contains response data for the checkNameAvailability operation. */
1095
+ export type ServicesCheckNameAvailabilityResponse = CheckNameAvailabilityOutput;
1096
+ /** Optional parameters. */
1097
+ export interface ServicesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
1098
+ /** Parameter group */
1099
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1100
+ }
1101
+ /** Contains response data for the listByResourceGroupNext operation. */
1102
+ export type ServicesListByResourceGroupNextResponse = SearchServiceListResult;
1103
+ /** Optional parameters. */
1104
+ export interface ServicesListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
1105
+ /** Parameter group */
1106
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1107
+ }
1108
+ /** Contains response data for the listBySubscriptionNext operation. */
1109
+ export type ServicesListBySubscriptionNextResponse = SearchServiceListResult;
1110
+ /** Optional parameters. */
1111
+ export interface PrivateLinkResourcesListSupportedOptionalParams extends coreClient.OperationOptions {
1112
+ /** Parameter group */
1113
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1114
+ }
1115
+ /** Contains response data for the listSupported operation. */
1116
+ export type PrivateLinkResourcesListSupportedResponse = PrivateLinkResourcesResult;
1117
+ /** Optional parameters. */
1118
+ export interface PrivateEndpointConnectionsUpdateOptionalParams extends coreClient.OperationOptions {
1119
+ /** Parameter group */
1120
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1121
+ }
1122
+ /** Contains response data for the update operation. */
1123
+ export type PrivateEndpointConnectionsUpdateResponse = PrivateEndpointConnection;
1124
+ /** Optional parameters. */
1125
+ export interface PrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions {
1126
+ /** Parameter group */
1127
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1128
+ }
1129
+ /** Contains response data for the get operation. */
1130
+ export type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection;
1131
+ /** Optional parameters. */
1132
+ export interface PrivateEndpointConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
1133
+ /** Parameter group */
1134
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1135
+ }
1136
+ /** Contains response data for the delete operation. */
1137
+ export type PrivateEndpointConnectionsDeleteResponse = PrivateEndpointConnection;
1138
+ /** Optional parameters. */
1139
+ export interface PrivateEndpointConnectionsListByServiceOptionalParams extends coreClient.OperationOptions {
1140
+ /** Parameter group */
1141
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1142
+ }
1143
+ /** Contains response data for the listByService operation. */
1144
+ export type PrivateEndpointConnectionsListByServiceResponse = PrivateEndpointConnectionListResult;
1145
+ /** Optional parameters. */
1146
+ export interface PrivateEndpointConnectionsListByServiceNextOptionalParams extends coreClient.OperationOptions {
1147
+ /** Parameter group */
1148
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1149
+ }
1150
+ /** Contains response data for the listByServiceNext operation. */
1151
+ export type PrivateEndpointConnectionsListByServiceNextResponse = PrivateEndpointConnectionListResult;
1152
+ /** Optional parameters. */
1153
+ export interface SharedPrivateLinkResourcesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
1154
+ /** Parameter group */
1155
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1156
+ /** Delay to wait until next poll, in milliseconds. */
1157
+ updateIntervalInMs?: number;
1158
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1159
+ resumeFrom?: string;
1160
+ }
1161
+ /** Contains response data for the createOrUpdate operation. */
1162
+ export type SharedPrivateLinkResourcesCreateOrUpdateResponse = SharedPrivateLinkResource;
1163
+ /** Optional parameters. */
1164
+ export interface SharedPrivateLinkResourcesGetOptionalParams extends coreClient.OperationOptions {
1165
+ /** Parameter group */
1166
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1167
+ }
1168
+ /** Contains response data for the get operation. */
1169
+ export type SharedPrivateLinkResourcesGetResponse = SharedPrivateLinkResource;
1170
+ /** Optional parameters. */
1171
+ export interface SharedPrivateLinkResourcesDeleteOptionalParams extends coreClient.OperationOptions {
1172
+ /** Parameter group */
1173
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1174
+ /** Delay to wait until next poll, in milliseconds. */
1175
+ updateIntervalInMs?: number;
1176
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1177
+ resumeFrom?: string;
1178
+ }
1179
+ /** Optional parameters. */
1180
+ export interface SharedPrivateLinkResourcesListByServiceOptionalParams extends coreClient.OperationOptions {
1181
+ /** Parameter group */
1182
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1183
+ }
1184
+ /** Contains response data for the listByService operation. */
1185
+ export type SharedPrivateLinkResourcesListByServiceResponse = SharedPrivateLinkResourceListResult;
1186
+ /** Optional parameters. */
1187
+ export interface SharedPrivateLinkResourcesListByServiceNextOptionalParams extends coreClient.OperationOptions {
1188
+ /** Parameter group */
1189
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1190
+ }
1191
+ /** Contains response data for the listByServiceNext operation. */
1192
+ export type SharedPrivateLinkResourcesListByServiceNextResponse = SharedPrivateLinkResourceListResult;
1193
+ /** Optional parameters. */
1194
+ export interface UsagesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
1195
+ /** Parameter group */
1196
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1197
+ }
1198
+ /** Contains response data for the listBySubscription operation. */
1199
+ export type UsagesListBySubscriptionResponse = QuotaUsagesListResult;
1200
+ /** Optional parameters. */
1201
+ export interface UsagesListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
1202
+ /** Parameter group */
1203
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1204
+ }
1205
+ /** Contains response data for the listBySubscriptionNext operation. */
1206
+ export type UsagesListBySubscriptionNextResponse = QuotaUsagesListResult;
1207
+ /** Optional parameters. */
1208
+ export interface UsageBySubscriptionSkuOptionalParams extends coreClient.OperationOptions {
1209
+ /** Parameter group */
1210
+ searchManagementRequestOptions?: SearchManagementRequestOptions;
1211
+ }
1212
+ /** Contains response data for the usageBySubscriptionSku operation. */
1213
+ export type UsageBySubscriptionSkuResponse = QuotaUsageResult;
1214
+ /** Optional parameters. */
1215
+ export interface NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams extends coreClient.OperationOptions {
1216
+ }
1217
+ /** Contains response data for the listByService operation. */
1218
+ export type NetworkSecurityPerimeterConfigurationsListByServiceResponse = NetworkSecurityPerimeterConfigurationListResult;
1219
+ /** Optional parameters. */
1220
+ export interface NetworkSecurityPerimeterConfigurationsGetOptionalParams extends coreClient.OperationOptions {
1221
+ }
1222
+ /** Contains response data for the get operation. */
1223
+ export type NetworkSecurityPerimeterConfigurationsGetResponse = NetworkSecurityPerimeterConfiguration;
1224
+ /** Optional parameters. */
1225
+ export interface NetworkSecurityPerimeterConfigurationsReconcileOptionalParams extends coreClient.OperationOptions {
1226
+ /** Delay to wait until next poll, in milliseconds. */
1227
+ updateIntervalInMs?: number;
1228
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1229
+ resumeFrom?: string;
1230
+ }
1231
+ /** Contains response data for the reconcile operation. */
1232
+ export type NetworkSecurityPerimeterConfigurationsReconcileResponse = NetworkSecurityPerimeterConfigurationsReconcileHeaders;
1233
+ /** Optional parameters. */
1234
+ export interface NetworkSecurityPerimeterConfigurationsListByServiceNextOptionalParams extends coreClient.OperationOptions {
1235
+ }
1236
+ /** Contains response data for the listByServiceNext operation. */
1237
+ export type NetworkSecurityPerimeterConfigurationsListByServiceNextResponse = NetworkSecurityPerimeterConfigurationListResult;
1238
+ /** Optional parameters. */
1239
+ export interface SearchManagementClientOptionalParams extends coreClient.ServiceClientOptions {
1240
+ /** server parameter */
1241
+ $host?: string;
1242
+ /** Api Version */
1243
+ apiVersion?: string;
1244
+ /** Overrides client endpoint. */
1245
+ endpoint?: string;
1246
+ }
1247
+ //# sourceMappingURL=index.d.ts.map