@azure/arm-search 1.3.0 → 3.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (199) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/{LICENSE.txt → LICENSE} +21 -21
  3. package/README.md +98 -96
  4. package/dist/index.js +2926 -0
  5. package/dist/index.js.map +1 -0
  6. package/dist/index.min.js +1 -0
  7. package/dist/index.min.js.map +1 -0
  8. package/dist-esm/src/index.d.ts +5 -0
  9. package/dist-esm/src/index.d.ts.map +1 -0
  10. package/dist-esm/src/index.js +12 -0
  11. package/dist-esm/src/index.js.map +1 -0
  12. package/dist-esm/src/lroImpl.d.ts +16 -0
  13. package/dist-esm/src/lroImpl.d.ts.map +1 -0
  14. package/dist-esm/src/lroImpl.js +29 -0
  15. package/dist-esm/src/lroImpl.js.map +1 -0
  16. package/dist-esm/src/models/index.d.ts +692 -0
  17. package/dist-esm/src/models/index.d.ts.map +1 -0
  18. package/dist-esm/src/models/index.js +21 -0
  19. package/dist-esm/src/models/index.js.map +1 -0
  20. package/dist-esm/src/models/mappers.d.ts +35 -0
  21. package/dist-esm/src/models/mappers.d.ts.map +1 -0
  22. package/dist-esm/src/models/mappers.js +1013 -0
  23. package/dist-esm/src/models/mappers.js.map +1 -0
  24. package/dist-esm/src/models/parameters.d.ts +22 -0
  25. package/dist-esm/src/models/parameters.d.ts.map +1 -0
  26. package/dist-esm/src/models/parameters.js +182 -0
  27. package/dist-esm/src/models/parameters.js.map +1 -0
  28. package/dist-esm/src/operations/adminKeys.d.ts +33 -0
  29. package/dist-esm/src/operations/adminKeys.d.ts.map +1 -0
  30. package/dist-esm/src/operations/adminKeys.js +90 -0
  31. package/dist-esm/src/operations/adminKeys.js.map +1 -0
  32. package/dist-esm/src/operations/index.d.ts +8 -0
  33. package/dist-esm/src/operations/index.d.ts.map +1 -0
  34. package/dist-esm/src/operations/index.js +15 -0
  35. package/dist-esm/src/operations/index.js.map +1 -0
  36. package/dist-esm/src/operations/operations.d.ts +26 -0
  37. package/dist-esm/src/operations/operations.d.ts.map +1 -0
  38. package/dist-esm/src/operations/operations.js +90 -0
  39. package/dist-esm/src/operations/operations.js.map +1 -0
  40. package/dist-esm/src/operations/privateEndpointConnections.d.ts +79 -0
  41. package/dist-esm/src/operations/privateEndpointConnections.d.ts.map +1 -0
  42. package/dist-esm/src/operations/privateEndpointConnections.js +273 -0
  43. package/dist-esm/src/operations/privateEndpointConnections.js.map +1 -0
  44. package/dist-esm/src/operations/privateLinkResources.d.ts +34 -0
  45. package/dist-esm/src/operations/privateLinkResources.d.ts.map +1 -0
  46. package/dist-esm/src/operations/privateLinkResources.js +103 -0
  47. package/dist-esm/src/operations/privateLinkResources.js.map +1 -0
  48. package/dist-esm/src/operations/queryKeys.d.ts +66 -0
  49. package/dist-esm/src/operations/queryKeys.d.ts.map +1 -0
  50. package/dist-esm/src/operations/queryKeys.js +213 -0
  51. package/dist-esm/src/operations/queryKeys.js.map +1 -0
  52. package/dist-esm/src/operations/services.d.ts +123 -0
  53. package/dist-esm/src/operations/services.d.ts.map +1 -0
  54. package/dist-esm/src/operations/services.js +475 -0
  55. package/dist-esm/src/operations/services.js.map +1 -0
  56. package/dist-esm/src/operations/sharedPrivateLinkResources.d.ts +107 -0
  57. package/dist-esm/src/operations/sharedPrivateLinkResources.d.ts.map +1 -0
  58. package/dist-esm/src/operations/sharedPrivateLinkResources.js +379 -0
  59. package/dist-esm/src/operations/sharedPrivateLinkResources.js.map +1 -0
  60. package/dist-esm/src/operationsInterfaces/adminKeys.d.ts +25 -0
  61. package/dist-esm/src/operationsInterfaces/adminKeys.d.ts.map +1 -0
  62. package/dist-esm/src/operationsInterfaces/adminKeys.js +9 -0
  63. package/dist-esm/src/operationsInterfaces/adminKeys.js.map +1 -0
  64. package/dist-esm/src/operationsInterfaces/index.d.ts +8 -0
  65. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
  66. package/dist-esm/src/operationsInterfaces/index.js +15 -0
  67. package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
  68. package/dist-esm/src/operationsInterfaces/operations.d.ts +11 -0
  69. package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -0
  70. package/dist-esm/src/operationsInterfaces/operations.js +9 -0
  71. package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
  72. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts +50 -0
  73. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts.map +1 -0
  74. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.js +9 -0
  75. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.js.map +1 -0
  76. package/dist-esm/src/operationsInterfaces/privateLinkResources.d.ts +15 -0
  77. package/dist-esm/src/operationsInterfaces/privateLinkResources.d.ts.map +1 -0
  78. package/dist-esm/src/operationsInterfaces/privateLinkResources.js +9 -0
  79. package/dist-esm/src/operationsInterfaces/privateLinkResources.js.map +1 -0
  80. package/dist-esm/src/operationsInterfaces/queryKeys.d.ts +37 -0
  81. package/dist-esm/src/operationsInterfaces/queryKeys.d.ts.map +1 -0
  82. package/dist-esm/src/operationsInterfaces/queryKeys.js +9 -0
  83. package/dist-esm/src/operationsInterfaces/queryKeys.js.map +1 -0
  84. package/dist-esm/src/operationsInterfaces/services.d.ts +85 -0
  85. package/dist-esm/src/operationsInterfaces/services.d.ts.map +1 -0
  86. package/dist-esm/src/operationsInterfaces/services.js +9 -0
  87. package/dist-esm/src/operationsInterfaces/services.js.map +1 -0
  88. package/dist-esm/src/operationsInterfaces/sharedPrivateLinkResources.d.ts +78 -0
  89. package/dist-esm/src/operationsInterfaces/sharedPrivateLinkResources.d.ts.map +1 -0
  90. package/dist-esm/src/operationsInterfaces/sharedPrivateLinkResources.js +9 -0
  91. package/dist-esm/src/operationsInterfaces/sharedPrivateLinkResources.js.map +1 -0
  92. package/dist-esm/src/searchManagementClient.d.ts +25 -0
  93. package/dist-esm/src/searchManagementClient.d.ts.map +1 -0
  94. package/dist-esm/src/searchManagementClient.js +58 -0
  95. package/dist-esm/src/searchManagementClient.js.map +1 -0
  96. package/dist-esm/test/search_examples.d.ts +4 -0
  97. package/dist-esm/test/search_examples.d.ts.map +1 -0
  98. package/dist-esm/test/search_examples.js +163 -0
  99. package/dist-esm/test/search_examples.js.map +1 -0
  100. package/package.json +70 -34
  101. package/review/arm-search.api.md +600 -0
  102. package/rollup.config.js +184 -27
  103. package/src/index.ts +12 -0
  104. package/src/lroImpl.ts +34 -0
  105. package/src/models/index.ts +837 -0
  106. package/src/models/mappers.ts +1092 -0
  107. package/src/models/parameters.ts +213 -0
  108. package/src/operations/adminKeys.ts +122 -0
  109. package/{lib → src}/operations/index.ts +6 -5
  110. package/src/operations/operations.ts +98 -0
  111. package/src/operations/privateEndpointConnections.ts +363 -0
  112. package/src/operations/privateLinkResources.ts +139 -0
  113. package/src/operations/queryKeys.ts +288 -0
  114. package/src/operations/services.ts +606 -0
  115. package/src/operations/sharedPrivateLinkResources.ts +525 -0
  116. package/src/operationsInterfaces/adminKeys.ts +48 -0
  117. package/{esm/operations/index.js → src/operationsInterfaces/index.ts} +7 -6
  118. package/src/operationsInterfaces/operations.ts +22 -0
  119. package/src/operationsInterfaces/privateEndpointConnections.ts +88 -0
  120. package/src/operationsInterfaces/privateLinkResources.ts +31 -0
  121. package/src/operationsInterfaces/queryKeys.ts +66 -0
  122. package/src/operationsInterfaces/services.ts +144 -0
  123. package/src/operationsInterfaces/sharedPrivateLinkResources.ts +131 -0
  124. package/src/searchManagementClient.ts +104 -0
  125. package/tsconfig.json +4 -4
  126. package/types/arm-search.d.ts +1104 -0
  127. package/types/tsdoc-metadata.json +11 -0
  128. package/dist/arm-search.js +0 -1329
  129. package/dist/arm-search.js.map +0 -1
  130. package/dist/arm-search.min.js +0 -1
  131. package/dist/arm-search.min.js.map +0 -1
  132. package/esm/models/adminKeysMappers.d.ts +0 -2
  133. package/esm/models/adminKeysMappers.d.ts.map +0 -1
  134. package/esm/models/adminKeysMappers.js +0 -11
  135. package/esm/models/adminKeysMappers.js.map +0 -1
  136. package/esm/models/index.d.ts +0 -788
  137. package/esm/models/index.d.ts.map +0 -1
  138. package/esm/models/index.js +0 -10
  139. package/esm/models/index.js.map +0 -1
  140. package/esm/models/mappers.d.ts +0 -18
  141. package/esm/models/mappers.d.ts.map +0 -1
  142. package/esm/models/mappers.js +0 -438
  143. package/esm/models/mappers.js.map +0 -1
  144. package/esm/models/operationsMappers.d.ts +0 -2
  145. package/esm/models/operationsMappers.d.ts.map +0 -1
  146. package/esm/models/operationsMappers.js +0 -11
  147. package/esm/models/operationsMappers.js.map +0 -1
  148. package/esm/models/parameters.d.ts +0 -11
  149. package/esm/models/parameters.d.ts.map +0 -1
  150. package/esm/models/parameters.js +0 -107
  151. package/esm/models/parameters.js.map +0 -1
  152. package/esm/models/queryKeysMappers.d.ts +0 -2
  153. package/esm/models/queryKeysMappers.d.ts.map +0 -1
  154. package/esm/models/queryKeysMappers.js +0 -11
  155. package/esm/models/queryKeysMappers.js.map +0 -1
  156. package/esm/models/servicesMappers.d.ts +0 -2
  157. package/esm/models/servicesMappers.d.ts.map +0 -1
  158. package/esm/models/servicesMappers.js +0 -11
  159. package/esm/models/servicesMappers.js.map +0 -1
  160. package/esm/operations/adminKeys.d.ts +0 -74
  161. package/esm/operations/adminKeys.d.ts.map +0 -1
  162. package/esm/operations/adminKeys.js +0 -93
  163. package/esm/operations/adminKeys.js.map +0 -1
  164. package/esm/operations/index.d.ts +0 -5
  165. package/esm/operations/index.d.ts.map +0 -1
  166. package/esm/operations/index.js.map +0 -1
  167. package/esm/operations/operations.d.ts +0 -28
  168. package/esm/operations/operations.d.ts.map +0 -1
  169. package/esm/operations/operations.js +0 -51
  170. package/esm/operations/operations.js.map +0 -1
  171. package/esm/operations/queryKeys.d.ts +0 -102
  172. package/esm/operations/queryKeys.d.ts.map +0 -1
  173. package/esm/operations/queryKeys.js +0 -127
  174. package/esm/operations/queryKeys.js.map +0 -1
  175. package/esm/operations/services.d.ts +0 -174
  176. package/esm/operations/services.d.ts.map +0 -1
  177. package/esm/operations/services.js +0 -268
  178. package/esm/operations/services.js.map +0 -1
  179. package/esm/searchManagementClient.d.ts +0 -22
  180. package/esm/searchManagementClient.d.ts.map +0 -1
  181. package/esm/searchManagementClient.js +0 -37
  182. package/esm/searchManagementClient.js.map +0 -1
  183. package/esm/searchManagementClientContext.d.ts +0 -17
  184. package/esm/searchManagementClientContext.d.ts.map +0 -1
  185. package/esm/searchManagementClientContext.js +0 -57
  186. package/esm/searchManagementClientContext.js.map +0 -1
  187. package/lib/models/adminKeysMappers.ts +0 -15
  188. package/lib/models/index.ts +0 -842
  189. package/lib/models/mappers.ts +0 -462
  190. package/lib/models/operationsMappers.ts +0 -17
  191. package/lib/models/parameters.ts +0 -109
  192. package/lib/models/queryKeysMappers.ts +0 -16
  193. package/lib/models/servicesMappers.ts +0 -22
  194. package/lib/operations/adminKeys.ts +0 -167
  195. package/lib/operations/operations.ts +0 -74
  196. package/lib/operations/queryKeys.ts +0 -234
  197. package/lib/operations/services.ts +0 -439
  198. package/lib/searchManagementClient.ts +0 -49
  199. package/lib/searchManagementClientContext.ts +0 -63
@@ -1,842 +0,0 @@
1
- /*
2
- * Copyright (c) Microsoft Corporation. All rights reserved.
3
- * Licensed under the MIT License. See License.txt in the project root for
4
- * license information.
5
- *
6
- * Code generated by Microsoft (R) AutoRest Code Generator.
7
- * Changes may cause incorrect behavior and will be lost if the code is
8
- * regenerated.
9
- */
10
-
11
- import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js";
12
- import * as msRest from "@azure/ms-rest-js";
13
-
14
- export { BaseResource, CloudError };
15
-
16
-
17
- /**
18
- * @interface
19
- * An interface representing CheckNameAvailabilityInput.
20
- * Input of check name availability API.
21
- *
22
- */
23
- export interface CheckNameAvailabilityInput {
24
- /**
25
- * @member {string} name The Search service name to validate. Search service
26
- * names must only contain lowercase letters, digits or dashes, cannot use
27
- * dash as the first two or last one characters, cannot contain consecutive
28
- * dashes, and must be between 2 and 60 characters in length.
29
- */
30
- name: string;
31
- }
32
-
33
- /**
34
- * @interface
35
- * An interface representing CheckNameAvailabilityOutput.
36
- * Output of check name availability API.
37
- *
38
- */
39
- export interface CheckNameAvailabilityOutput {
40
- /**
41
- * @member {boolean} [isNameAvailable] A value indicating whether the name is
42
- * available.
43
- * **NOTE: This property will not be serialized. It can only be populated by
44
- * the server.**
45
- */
46
- readonly isNameAvailable?: boolean;
47
- /**
48
- * @member {UnavailableNameReason} [reason] The reason why the name is not
49
- * available. 'Invalid' indicates the name provided does not match the naming
50
- * requirements (incorrect length, unsupported characters, etc.).
51
- * 'AlreadyExists' indicates that the name is already in use and is therefore
52
- * unavailable. Possible values include: 'Invalid', 'AlreadyExists'
53
- * **NOTE: This property will not be serialized. It can only be populated by
54
- * the server.**
55
- */
56
- readonly reason?: UnavailableNameReason;
57
- /**
58
- * @member {string} [message] A message that explains why the name is invalid
59
- * and provides resource naming requirements. Available only if 'Invalid' is
60
- * returned in the 'reason' property.
61
- * **NOTE: This property will not be serialized. It can only be populated by
62
- * the server.**
63
- */
64
- readonly message?: string;
65
- }
66
-
67
- /**
68
- * @interface
69
- * An interface representing AdminKeyResult.
70
- * Response containing the primary and secondary admin API keys for a given
71
- * Azure Search service.
72
- *
73
- */
74
- export interface AdminKeyResult {
75
- /**
76
- * @member {string} [primaryKey] The primary admin API key of the Search
77
- * service.
78
- * **NOTE: This property will not be serialized. It can only be populated by
79
- * the server.**
80
- */
81
- readonly primaryKey?: string;
82
- /**
83
- * @member {string} [secondaryKey] The secondary admin API key of the Search
84
- * service.
85
- * **NOTE: This property will not be serialized. It can only be populated by
86
- * the server.**
87
- */
88
- readonly secondaryKey?: string;
89
- }
90
-
91
- /**
92
- * @interface
93
- * An interface representing QueryKey.
94
- * Describes an API key for a given Azure Search service that has permissions
95
- * for query operations only.
96
- *
97
- */
98
- export interface QueryKey {
99
- /**
100
- * @member {string} [name] The name of the query API key; may be empty.
101
- * **NOTE: This property will not be serialized. It can only be populated by
102
- * the server.**
103
- */
104
- readonly name?: string;
105
- /**
106
- * @member {string} [key] The value of the query API key.
107
- * **NOTE: This property will not be serialized. It can only be populated by
108
- * the server.**
109
- */
110
- readonly key?: string;
111
- }
112
-
113
- /**
114
- * @interface
115
- * An interface representing Sku.
116
- * Defines the SKU of an Azure Search Service, which determines price tier and
117
- * capacity limits.
118
- *
119
- */
120
- export interface Sku {
121
- /**
122
- * @member {SkuName} [name] The SKU of the Search service. Valid values
123
- * include: 'free': Shared service. 'basic': Dedicated service with up to 3
124
- * replicas. 'standard': Dedicated service with up to 12 partitions and 12
125
- * replicas. 'standard2': Similar to standard, but with more capacity per
126
- * search unit. 'standard3': Offers maximum capacity per search unit with up
127
- * to 12 partitions and 12 replicas (or up to 3 partitions with more indexes
128
- * if you also set the hostingMode property to 'highDensity'). Possible
129
- * values include: 'free', 'basic', 'standard', 'standard2', 'standard3'
130
- */
131
- name?: SkuName;
132
- }
133
-
134
- /**
135
- * @interface
136
- * An interface representing Resource.
137
- * Base type for all Azure resources.
138
- *
139
- * @extends BaseResource
140
- */
141
- export interface Resource extends BaseResource {
142
- /**
143
- * @member {string} [id] The ID of the resource. This can be used with the
144
- * Azure Resource Manager to link resources together.
145
- * **NOTE: This property will not be serialized. It can only be populated by
146
- * the server.**
147
- */
148
- readonly id?: string;
149
- /**
150
- * @member {string} [name] The name of the resource.
151
- * **NOTE: This property will not be serialized. It can only be populated by
152
- * the server.**
153
- */
154
- readonly name?: string;
155
- /**
156
- * @member {string} [type] The resource type.
157
- * **NOTE: This property will not be serialized. It can only be populated by
158
- * the server.**
159
- */
160
- readonly type?: string;
161
- /**
162
- * @member {string} [location] The geographic location of the resource. This
163
- * must be one of the supported and registered Azure Geo Regions (for
164
- * example, West US, East US, Southeast Asia, and so forth). This property is
165
- * required when creating a new resource.
166
- */
167
- location?: string;
168
- /**
169
- * @member {{ [propertyName: string]: string }} [tags] Tags to help
170
- * categorize the resource in the Azure portal.
171
- */
172
- tags?: { [propertyName: string]: string };
173
- /**
174
- * @member {Identity} [identity] The identity of the resource.
175
- */
176
- identity?: Identity;
177
- }
178
-
179
- /**
180
- * @interface
181
- * An interface representing SearchService.
182
- * Describes an Azure Search service and its current state.
183
- *
184
- * @extends Resource
185
- */
186
- export interface SearchService extends Resource {
187
- /**
188
- * @member {number} [replicaCount] The number of replicas in the Search
189
- * service. If specified, it must be a value between 1 and 12 inclusive for
190
- * standard SKUs or between 1 and 3 inclusive for basic SKU. Default value: 1
191
- * .
192
- */
193
- replicaCount?: number;
194
- /**
195
- * @member {number} [partitionCount] The number of partitions in the Search
196
- * service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than
197
- * 1 are only valid for standard SKUs. For 'standard3' services with
198
- * hostingMode set to 'highDensity', the allowed values are between 1 and 3.
199
- * Default value: 1 .
200
- */
201
- partitionCount?: number;
202
- /**
203
- * @member {HostingMode} [hostingMode] Applicable only for the standard3 SKU.
204
- * You can set this property to enable up to 3 high density partitions that
205
- * allow up to 1000 indexes, which is much higher than the maximum indexes
206
- * allowed for any other SKU. For the standard3 SKU, the value is either
207
- * 'default' or 'highDensity'. For all other SKUs, this value must be
208
- * 'default'. Possible values include: 'default', 'highDensity'. Default
209
- * value: 'default' .
210
- */
211
- hostingMode?: HostingMode;
212
- /**
213
- * @member {SearchServiceStatus} [status] The status of the Search service.
214
- * Possible values include: 'running': The Search service is running and no
215
- * provisioning operations are underway. 'provisioning': The Search service
216
- * is being provisioned or scaled up or down. 'deleting': The Search service
217
- * is being deleted. 'degraded': The Search service is degraded. This can
218
- * occur when the underlying search units are not healthy. The Search service
219
- * is most likely operational, but performance might be slow and some
220
- * requests might be dropped. 'disabled': The Search service is disabled. In
221
- * this state, the service will reject all API requests. 'error': The Search
222
- * service is in an error state. If your service is in the degraded,
223
- * disabled, or error states, it means the Azure Search team is actively
224
- * investigating the underlying issue. Dedicated services in these states are
225
- * still chargeable based on the number of search units provisioned. Possible
226
- * values include: 'running', 'provisioning', 'deleting', 'degraded',
227
- * 'disabled', 'error'
228
- * **NOTE: This property will not be serialized. It can only be populated by
229
- * the server.**
230
- */
231
- readonly status?: SearchServiceStatus;
232
- /**
233
- * @member {string} [statusDetails] The details of the Search service status.
234
- * **NOTE: This property will not be serialized. It can only be populated by
235
- * the server.**
236
- */
237
- readonly statusDetails?: string;
238
- /**
239
- * @member {ProvisioningState} [provisioningState] The state of the last
240
- * provisioning operation performed on the Search service. Provisioning is an
241
- * intermediate state that occurs while service capacity is being
242
- * established. After capacity is set up, provisioningState changes to either
243
- * 'succeeded' or 'failed'. Client applications can poll provisioning status
244
- * (the recommended polling interval is from 30 seconds to one minute) by
245
- * using the Get Search Service operation to see when an operation is
246
- * completed. If you are using the free service, this value tends to come
247
- * back as 'succeeded' directly in the call to Create Search service. This is
248
- * because the free service uses capacity that is already set up. Possible
249
- * values include: 'succeeded', 'provisioning', 'failed'
250
- * **NOTE: This property will not be serialized. It can only be populated by
251
- * the server.**
252
- */
253
- readonly provisioningState?: ProvisioningState;
254
- /**
255
- * @member {Sku} [sku] The SKU of the Search Service, which determines price
256
- * tier and capacity limits. This property is required when creating a new
257
- * Search Service.
258
- */
259
- sku?: Sku;
260
- }
261
-
262
- /**
263
- * @interface
264
- * An interface representing Identity.
265
- * Identity for the resource.
266
- *
267
- */
268
- export interface Identity {
269
- /**
270
- * @member {string} [principalId] The principal ID of resource identity.
271
- * **NOTE: This property will not be serialized. It can only be populated by
272
- * the server.**
273
- */
274
- readonly principalId?: string;
275
- /**
276
- * @member {string} [tenantId] The tenant ID of resource.
277
- * **NOTE: This property will not be serialized. It can only be populated by
278
- * the server.**
279
- */
280
- readonly tenantId?: string;
281
- }
282
-
283
- /**
284
- * @interface
285
- * An interface representing OperationDisplay.
286
- * The object that describes the operation.
287
- *
288
- */
289
- export interface OperationDisplay {
290
- /**
291
- * @member {string} [provider] The friendly name of the resource provider.
292
- * **NOTE: This property will not be serialized. It can only be populated by
293
- * the server.**
294
- */
295
- readonly provider?: string;
296
- /**
297
- * @member {string} [operation] The operation type: read, write, delete,
298
- * listKeys/action, etc.
299
- * **NOTE: This property will not be serialized. It can only be populated by
300
- * the server.**
301
- */
302
- readonly operation?: string;
303
- /**
304
- * @member {string} [resource] The resource type on which the operation is
305
- * performed.
306
- * **NOTE: This property will not be serialized. It can only be populated by
307
- * the server.**
308
- */
309
- readonly resource?: string;
310
- /**
311
- * @member {string} [description] The friendly name of the operation.
312
- * **NOTE: This property will not be serialized. It can only be populated by
313
- * the server.**
314
- */
315
- readonly description?: string;
316
- }
317
-
318
- /**
319
- * @interface
320
- * An interface representing Operation.
321
- * Describes a REST API operation.
322
- *
323
- */
324
- export interface Operation {
325
- /**
326
- * @member {string} [name] The name of the operation. This name is of the
327
- * form {provider}/{resource}/{operation}.
328
- * **NOTE: This property will not be serialized. It can only be populated by
329
- * the server.**
330
- */
331
- readonly name?: string;
332
- /**
333
- * @member {OperationDisplay} [display] The object that describes the
334
- * operation.
335
- * **NOTE: This property will not be serialized. It can only be populated by
336
- * the server.**
337
- */
338
- readonly display?: OperationDisplay;
339
- }
340
-
341
- /**
342
- * @interface
343
- * An interface representing SearchManagementRequestOptions.
344
- * Additional parameters for a set of operations.
345
- *
346
- */
347
- export interface SearchManagementRequestOptions {
348
- /**
349
- * @member {string} [clientRequestId] A client-generated GUID value that
350
- * identifies this request. If specified, this will be included in response
351
- * information as a way to track the request.
352
- */
353
- clientRequestId?: string;
354
- }
355
-
356
- /**
357
- * @interface
358
- * An interface representing AdminKeysGetOptionalParams.
359
- * Optional Parameters.
360
- *
361
- * @extends RequestOptionsBase
362
- */
363
- export interface AdminKeysGetOptionalParams extends msRest.RequestOptionsBase {
364
- /**
365
- * @member {SearchManagementRequestOptions} [searchManagementRequestOptions]
366
- * Additional parameters for the operation
367
- */
368
- searchManagementRequestOptions?: SearchManagementRequestOptions;
369
- }
370
-
371
- /**
372
- * @interface
373
- * An interface representing AdminKeysRegenerateOptionalParams.
374
- * Optional Parameters.
375
- *
376
- * @extends RequestOptionsBase
377
- */
378
- export interface AdminKeysRegenerateOptionalParams extends msRest.RequestOptionsBase {
379
- /**
380
- * @member {SearchManagementRequestOptions} [searchManagementRequestOptions]
381
- * Additional parameters for the operation
382
- */
383
- searchManagementRequestOptions?: SearchManagementRequestOptions;
384
- }
385
-
386
- /**
387
- * @interface
388
- * An interface representing QueryKeysCreateOptionalParams.
389
- * Optional Parameters.
390
- *
391
- * @extends RequestOptionsBase
392
- */
393
- export interface QueryKeysCreateOptionalParams extends msRest.RequestOptionsBase {
394
- /**
395
- * @member {SearchManagementRequestOptions} [searchManagementRequestOptions]
396
- * Additional parameters for the operation
397
- */
398
- searchManagementRequestOptions?: SearchManagementRequestOptions;
399
- }
400
-
401
- /**
402
- * @interface
403
- * An interface representing QueryKeysListBySearchServiceOptionalParams.
404
- * Optional Parameters.
405
- *
406
- * @extends RequestOptionsBase
407
- */
408
- export interface QueryKeysListBySearchServiceOptionalParams extends msRest.RequestOptionsBase {
409
- /**
410
- * @member {SearchManagementRequestOptions} [searchManagementRequestOptions]
411
- * Additional parameters for the operation
412
- */
413
- searchManagementRequestOptions?: SearchManagementRequestOptions;
414
- }
415
-
416
- /**
417
- * @interface
418
- * An interface representing QueryKeysDeleteMethodOptionalParams.
419
- * Optional Parameters.
420
- *
421
- * @extends RequestOptionsBase
422
- */
423
- export interface QueryKeysDeleteMethodOptionalParams extends msRest.RequestOptionsBase {
424
- /**
425
- * @member {SearchManagementRequestOptions} [searchManagementRequestOptions]
426
- * Additional parameters for the operation
427
- */
428
- searchManagementRequestOptions?: SearchManagementRequestOptions;
429
- }
430
-
431
- /**
432
- * @interface
433
- * An interface representing ServicesCreateOrUpdateOptionalParams.
434
- * Optional Parameters.
435
- *
436
- * @extends RequestOptionsBase
437
- */
438
- export interface ServicesCreateOrUpdateOptionalParams extends msRest.RequestOptionsBase {
439
- /**
440
- * @member {SearchManagementRequestOptions} [searchManagementRequestOptions]
441
- * Additional parameters for the operation
442
- */
443
- searchManagementRequestOptions?: SearchManagementRequestOptions;
444
- }
445
-
446
- /**
447
- * @interface
448
- * An interface representing ServicesUpdateOptionalParams.
449
- * Optional Parameters.
450
- *
451
- * @extends RequestOptionsBase
452
- */
453
- export interface ServicesUpdateOptionalParams extends msRest.RequestOptionsBase {
454
- /**
455
- * @member {SearchManagementRequestOptions} [searchManagementRequestOptions]
456
- * Additional parameters for the operation
457
- */
458
- searchManagementRequestOptions?: SearchManagementRequestOptions;
459
- }
460
-
461
- /**
462
- * @interface
463
- * An interface representing ServicesGetOptionalParams.
464
- * Optional Parameters.
465
- *
466
- * @extends RequestOptionsBase
467
- */
468
- export interface ServicesGetOptionalParams extends msRest.RequestOptionsBase {
469
- /**
470
- * @member {SearchManagementRequestOptions} [searchManagementRequestOptions]
471
- * Additional parameters for the operation
472
- */
473
- searchManagementRequestOptions?: SearchManagementRequestOptions;
474
- }
475
-
476
- /**
477
- * @interface
478
- * An interface representing ServicesDeleteMethodOptionalParams.
479
- * Optional Parameters.
480
- *
481
- * @extends RequestOptionsBase
482
- */
483
- export interface ServicesDeleteMethodOptionalParams extends msRest.RequestOptionsBase {
484
- /**
485
- * @member {SearchManagementRequestOptions} [searchManagementRequestOptions]
486
- * Additional parameters for the operation
487
- */
488
- searchManagementRequestOptions?: SearchManagementRequestOptions;
489
- }
490
-
491
- /**
492
- * @interface
493
- * An interface representing ServicesListByResourceGroupOptionalParams.
494
- * Optional Parameters.
495
- *
496
- * @extends RequestOptionsBase
497
- */
498
- export interface ServicesListByResourceGroupOptionalParams extends msRest.RequestOptionsBase {
499
- /**
500
- * @member {SearchManagementRequestOptions} [searchManagementRequestOptions]
501
- * Additional parameters for the operation
502
- */
503
- searchManagementRequestOptions?: SearchManagementRequestOptions;
504
- }
505
-
506
- /**
507
- * @interface
508
- * An interface representing ServicesCheckNameAvailabilityOptionalParams.
509
- * Optional Parameters.
510
- *
511
- * @extends RequestOptionsBase
512
- */
513
- export interface ServicesCheckNameAvailabilityOptionalParams extends msRest.RequestOptionsBase {
514
- /**
515
- * @member {SearchManagementRequestOptions} [searchManagementRequestOptions]
516
- * Additional parameters for the operation
517
- */
518
- searchManagementRequestOptions?: SearchManagementRequestOptions;
519
- }
520
-
521
- /**
522
- * @interface
523
- * An interface representing ServicesBeginCreateOrUpdateOptionalParams.
524
- * Optional Parameters.
525
- *
526
- * @extends RequestOptionsBase
527
- */
528
- export interface ServicesBeginCreateOrUpdateOptionalParams extends msRest.RequestOptionsBase {
529
- /**
530
- * @member {SearchManagementRequestOptions} [searchManagementRequestOptions]
531
- * Additional parameters for the operation
532
- */
533
- searchManagementRequestOptions?: SearchManagementRequestOptions;
534
- }
535
-
536
- /**
537
- * @interface
538
- * An interface representing SearchManagementClientOptions.
539
- * @extends AzureServiceClientOptions
540
- */
541
- export interface SearchManagementClientOptions extends AzureServiceClientOptions {
542
- /**
543
- * @member {string} [baseUri]
544
- */
545
- baseUri?: string;
546
- }
547
-
548
-
549
- /**
550
- * @interface
551
- * An interface representing the OperationListResult.
552
- * The result of the request to list REST API operations. It contains a list of
553
- * operations and a URL to get the next set of results.
554
- *
555
- * @extends Array<Operation>
556
- */
557
- export interface OperationListResult extends Array<Operation> {
558
- /**
559
- * @member {string} [nextLink] The URL to get the next set of operation list
560
- * results, if any.
561
- * **NOTE: This property will not be serialized. It can only be populated by
562
- * the server.**
563
- */
564
- readonly nextLink?: string;
565
- }
566
-
567
- /**
568
- * @interface
569
- * An interface representing the ListQueryKeysResult.
570
- * Response containing the query API keys for a given Azure Search service.
571
- *
572
- * @extends Array<QueryKey>
573
- */
574
- export interface ListQueryKeysResult extends Array<QueryKey> {
575
- }
576
-
577
- /**
578
- * @interface
579
- * An interface representing the SearchServiceListResult.
580
- * Response containing a list of Azure Search services.
581
- *
582
- * @extends Array<SearchService>
583
- */
584
- export interface SearchServiceListResult extends Array<SearchService> {
585
- }
586
-
587
- /**
588
- * Defines values for UnavailableNameReason.
589
- * Possible values include: 'Invalid', 'AlreadyExists'
590
- * @readonly
591
- * @enum {string}
592
- */
593
- export type UnavailableNameReason = 'Invalid' | 'AlreadyExists';
594
-
595
- /**
596
- * Defines values for SkuName.
597
- * Possible values include: 'free', 'basic', 'standard', 'standard2', 'standard3'
598
- * @readonly
599
- * @enum {string}
600
- */
601
- export type SkuName = 'free' | 'basic' | 'standard' | 'standard2' | 'standard3';
602
-
603
- /**
604
- * Defines values for HostingMode.
605
- * Possible values include: 'default', 'highDensity'
606
- * @readonly
607
- * @enum {string}
608
- */
609
- export type HostingMode = 'default' | 'highDensity';
610
-
611
- /**
612
- * Defines values for SearchServiceStatus.
613
- * Possible values include: 'running', 'provisioning', 'deleting', 'degraded', 'disabled', 'error'
614
- * @readonly
615
- * @enum {string}
616
- */
617
- export type SearchServiceStatus = 'running' | 'provisioning' | 'deleting' | 'degraded' | 'disabled' | 'error';
618
-
619
- /**
620
- * Defines values for ProvisioningState.
621
- * Possible values include: 'succeeded', 'provisioning', 'failed'
622
- * @readonly
623
- * @enum {string}
624
- */
625
- export type ProvisioningState = 'succeeded' | 'provisioning' | 'failed';
626
-
627
- /**
628
- * Defines values for AdminKeyKind.
629
- * Possible values include: 'primary', 'secondary'
630
- * @readonly
631
- * @enum {string}
632
- */
633
- export type AdminKeyKind = 'primary' | 'secondary';
634
-
635
- /**
636
- * Contains response data for the list operation.
637
- */
638
- export type OperationsListResponse = OperationListResult & {
639
- /**
640
- * The underlying HTTP response.
641
- */
642
- _response: msRest.HttpResponse & {
643
- /**
644
- * The response body as text (string format)
645
- */
646
- bodyAsText: string;
647
- /**
648
- * The response body as parsed JSON or XML
649
- */
650
- parsedBody: OperationListResult;
651
- };
652
- };
653
-
654
- /**
655
- * Contains response data for the get operation.
656
- */
657
- export type AdminKeysGetResponse = AdminKeyResult & {
658
- /**
659
- * The underlying HTTP response.
660
- */
661
- _response: msRest.HttpResponse & {
662
- /**
663
- * The response body as text (string format)
664
- */
665
- bodyAsText: string;
666
- /**
667
- * The response body as parsed JSON or XML
668
- */
669
- parsedBody: AdminKeyResult;
670
- };
671
- };
672
-
673
- /**
674
- * Contains response data for the regenerate operation.
675
- */
676
- export type AdminKeysRegenerateResponse = AdminKeyResult & {
677
- /**
678
- * The underlying HTTP response.
679
- */
680
- _response: msRest.HttpResponse & {
681
- /**
682
- * The response body as text (string format)
683
- */
684
- bodyAsText: string;
685
- /**
686
- * The response body as parsed JSON or XML
687
- */
688
- parsedBody: AdminKeyResult;
689
- };
690
- };
691
-
692
- /**
693
- * Contains response data for the create operation.
694
- */
695
- export type QueryKeysCreateResponse = QueryKey & {
696
- /**
697
- * The underlying HTTP response.
698
- */
699
- _response: msRest.HttpResponse & {
700
- /**
701
- * The response body as text (string format)
702
- */
703
- bodyAsText: string;
704
- /**
705
- * The response body as parsed JSON or XML
706
- */
707
- parsedBody: QueryKey;
708
- };
709
- };
710
-
711
- /**
712
- * Contains response data for the listBySearchService operation.
713
- */
714
- export type QueryKeysListBySearchServiceResponse = ListQueryKeysResult & {
715
- /**
716
- * The underlying HTTP response.
717
- */
718
- _response: msRest.HttpResponse & {
719
- /**
720
- * The response body as text (string format)
721
- */
722
- bodyAsText: string;
723
- /**
724
- * The response body as parsed JSON or XML
725
- */
726
- parsedBody: ListQueryKeysResult;
727
- };
728
- };
729
-
730
- /**
731
- * Contains response data for the createOrUpdate operation.
732
- */
733
- export type ServicesCreateOrUpdateResponse = SearchService & {
734
- /**
735
- * The underlying HTTP response.
736
- */
737
- _response: msRest.HttpResponse & {
738
- /**
739
- * The response body as text (string format)
740
- */
741
- bodyAsText: string;
742
- /**
743
- * The response body as parsed JSON or XML
744
- */
745
- parsedBody: SearchService;
746
- };
747
- };
748
-
749
- /**
750
- * Contains response data for the update operation.
751
- */
752
- export type ServicesUpdateResponse = SearchService & {
753
- /**
754
- * The underlying HTTP response.
755
- */
756
- _response: msRest.HttpResponse & {
757
- /**
758
- * The response body as text (string format)
759
- */
760
- bodyAsText: string;
761
- /**
762
- * The response body as parsed JSON or XML
763
- */
764
- parsedBody: SearchService;
765
- };
766
- };
767
-
768
- /**
769
- * Contains response data for the get operation.
770
- */
771
- export type ServicesGetResponse = SearchService & {
772
- /**
773
- * The underlying HTTP response.
774
- */
775
- _response: msRest.HttpResponse & {
776
- /**
777
- * The response body as text (string format)
778
- */
779
- bodyAsText: string;
780
- /**
781
- * The response body as parsed JSON or XML
782
- */
783
- parsedBody: SearchService;
784
- };
785
- };
786
-
787
- /**
788
- * Contains response data for the listByResourceGroup operation.
789
- */
790
- export type ServicesListByResourceGroupResponse = SearchServiceListResult & {
791
- /**
792
- * The underlying HTTP response.
793
- */
794
- _response: msRest.HttpResponse & {
795
- /**
796
- * The response body as text (string format)
797
- */
798
- bodyAsText: string;
799
- /**
800
- * The response body as parsed JSON or XML
801
- */
802
- parsedBody: SearchServiceListResult;
803
- };
804
- };
805
-
806
- /**
807
- * Contains response data for the checkNameAvailability operation.
808
- */
809
- export type ServicesCheckNameAvailabilityResponse = CheckNameAvailabilityOutput & {
810
- /**
811
- * The underlying HTTP response.
812
- */
813
- _response: msRest.HttpResponse & {
814
- /**
815
- * The response body as text (string format)
816
- */
817
- bodyAsText: string;
818
- /**
819
- * The response body as parsed JSON or XML
820
- */
821
- parsedBody: CheckNameAvailabilityOutput;
822
- };
823
- };
824
-
825
- /**
826
- * Contains response data for the beginCreateOrUpdate operation.
827
- */
828
- export type ServicesBeginCreateOrUpdateResponse = SearchService & {
829
- /**
830
- * The underlying HTTP response.
831
- */
832
- _response: msRest.HttpResponse & {
833
- /**
834
- * The response body as text (string format)
835
- */
836
- bodyAsText: string;
837
- /**
838
- * The response body as parsed JSON or XML
839
- */
840
- parsedBody: SearchService;
841
- };
842
- };