@azure/arm-search 2.0.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 (209) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/{LICENSE.txt → LICENSE} +1 -1
  3. package/README.md +70 -78
  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/{esm/models/adminKeysMappers.js → dist-esm/src/index.js} +5 -2
  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/{esm → dist-esm/src}/models/mappers.js +503 -558
  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/{esm → dist-esm/src}/models/parameters.js +92 -47
  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/{esm → dist-esm/src}/operations/index.d.ts +0 -0
  33. package/dist-esm/src/operations/index.d.ts.map +1 -0
  34. package/{esm → dist-esm/src}/operations/index.js +1 -2
  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/{src/models/adminKeysMappers.ts → dist-esm/src/operationsInterfaces/adminKeys.js} +2 -5
  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/{src/models/queryKeysMappers.ts → dist-esm/src/operationsInterfaces/operations.js} +2 -6
  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/{src/models/operationsMappers.ts → dist-esm/src/operationsInterfaces/privateEndpointConnections.js} +2 -7
  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/{esm/models/index.js → dist-esm/src/operationsInterfaces/services.js} +2 -1
  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 +65 -32
  101. package/review/arm-search.api.md +600 -0
  102. package/rollup.config.js +181 -30
  103. package/{esm/models/queryKeysMappers.js → src/index.ts} +5 -2
  104. package/src/lroImpl.ts +34 -0
  105. package/src/models/index.ts +563 -1357
  106. package/src/models/mappers.ts +516 -575
  107. package/src/models/parameters.ts +122 -48
  108. package/src/operations/adminKeys.ts +65 -109
  109. package/src/operations/index.ts +1 -2
  110. package/src/operations/operations.ts +64 -39
  111. package/src/operations/privateEndpointConnections.ts +223 -235
  112. package/src/operations/privateLinkResources.ts +100 -54
  113. package/src/operations/queryKeys.ts +192 -190
  114. package/src/operations/services.ts +423 -409
  115. package/src/operations/sharedPrivateLinkResources.ts +390 -232
  116. package/src/operationsInterfaces/adminKeys.ts +48 -0
  117. package/src/operationsInterfaces/index.ts +15 -0
  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 +90 -46
  125. package/tsconfig.json +3 -3
  126. package/types/arm-search.d.ts +1104 -0
  127. package/types/tsdoc-metadata.json +11 -0
  128. package/dist/arm-search.js +0 -2737
  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.map +0 -1
  135. package/esm/models/index.d.ts +0 -1499
  136. package/esm/models/index.d.ts.map +0 -1
  137. package/esm/models/index.js.map +0 -1
  138. package/esm/models/mappers.d.ts +0 -38
  139. package/esm/models/mappers.d.ts.map +0 -1
  140. package/esm/models/mappers.js.map +0 -1
  141. package/esm/models/operationsMappers.d.ts +0 -2
  142. package/esm/models/operationsMappers.d.ts.map +0 -1
  143. package/esm/models/operationsMappers.js +0 -9
  144. package/esm/models/operationsMappers.js.map +0 -1
  145. package/esm/models/parameters.d.ts +0 -14
  146. package/esm/models/parameters.d.ts.map +0 -1
  147. package/esm/models/parameters.js.map +0 -1
  148. package/esm/models/privateEndpointConnectionsMappers.d.ts +0 -2
  149. package/esm/models/privateEndpointConnectionsMappers.d.ts.map +0 -1
  150. package/esm/models/privateEndpointConnectionsMappers.js +0 -9
  151. package/esm/models/privateEndpointConnectionsMappers.js.map +0 -1
  152. package/esm/models/privateLinkResourcesMappers.d.ts +0 -2
  153. package/esm/models/privateLinkResourcesMappers.d.ts.map +0 -1
  154. package/esm/models/privateLinkResourcesMappers.js +0 -9
  155. package/esm/models/privateLinkResourcesMappers.js.map +0 -1
  156. package/esm/models/queryKeysMappers.d.ts +0 -2
  157. package/esm/models/queryKeysMappers.d.ts.map +0 -1
  158. package/esm/models/queryKeysMappers.js.map +0 -1
  159. package/esm/models/servicesMappers.d.ts +0 -2
  160. package/esm/models/servicesMappers.d.ts.map +0 -1
  161. package/esm/models/servicesMappers.js +0 -9
  162. package/esm/models/servicesMappers.js.map +0 -1
  163. package/esm/models/sharedPrivateLinkResourcesMappers.d.ts +0 -2
  164. package/esm/models/sharedPrivateLinkResourcesMappers.d.ts.map +0 -1
  165. package/esm/models/sharedPrivateLinkResourcesMappers.js +0 -9
  166. package/esm/models/sharedPrivateLinkResourcesMappers.js.map +0 -1
  167. package/esm/operations/adminKeys.d.ts +0 -74
  168. package/esm/operations/adminKeys.d.ts.map +0 -1
  169. package/esm/operations/adminKeys.js +0 -92
  170. package/esm/operations/adminKeys.js.map +0 -1
  171. package/esm/operations/index.d.ts.map +0 -1
  172. package/esm/operations/index.js.map +0 -1
  173. package/esm/operations/operations.d.ts +0 -28
  174. package/esm/operations/operations.d.ts.map +0 -1
  175. package/esm/operations/operations.js +0 -50
  176. package/esm/operations/operations.js.map +0 -1
  177. package/esm/operations/privateEndpointConnections.d.ts +0 -161
  178. package/esm/operations/privateEndpointConnections.d.ts.map +0 -1
  179. package/esm/operations/privateEndpointConnections.js +0 -197
  180. package/esm/operations/privateEndpointConnections.js.map +0 -1
  181. package/esm/operations/privateLinkResources.d.ts +0 -40
  182. package/esm/operations/privateLinkResources.d.ts.map +0 -1
  183. package/esm/operations/privateLinkResources.js +0 -58
  184. package/esm/operations/privateLinkResources.js.map +0 -1
  185. package/esm/operations/queryKeys.d.ts +0 -120
  186. package/esm/operations/queryKeys.d.ts.map +0 -1
  187. package/esm/operations/queryKeys.js +0 -156
  188. package/esm/operations/queryKeys.js.map +0 -1
  189. package/esm/operations/services.d.ts +0 -225
  190. package/esm/operations/services.d.ts.map +0 -1
  191. package/esm/operations/services.js +0 -355
  192. package/esm/operations/services.js.map +0 -1
  193. package/esm/operations/sharedPrivateLinkResources.d.ts +0 -147
  194. package/esm/operations/sharedPrivateLinkResources.d.ts.map +0 -1
  195. package/esm/operations/sharedPrivateLinkResources.js +0 -255
  196. package/esm/operations/sharedPrivateLinkResources.js.map +0 -1
  197. package/esm/searchManagementClient.d.ts +0 -31
  198. package/esm/searchManagementClient.d.ts.map +0 -1
  199. package/esm/searchManagementClient.js +0 -44
  200. package/esm/searchManagementClient.js.map +0 -1
  201. package/esm/searchManagementClientContext.d.ts +0 -23
  202. package/esm/searchManagementClientContext.d.ts.map +0 -1
  203. package/esm/searchManagementClientContext.js +0 -61
  204. package/esm/searchManagementClientContext.js.map +0 -1
  205. package/src/models/privateEndpointConnectionsMappers.ts +0 -33
  206. package/src/models/privateLinkResourcesMappers.ts +0 -33
  207. package/src/models/servicesMappers.ts +0 -35
  208. package/src/models/sharedPrivateLinkResourcesMappers.ts +0 -33
  209. package/src/searchManagementClientContext.ts +0 -68
@@ -1,1499 +0,0 @@
1
- import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js";
2
- import * as msRest from "@azure/ms-rest-js";
3
- export { BaseResource, CloudError };
4
- /**
5
- * Input of check name availability API.
6
- */
7
- export interface CheckNameAvailabilityInput {
8
- /**
9
- * The search service name to validate. Search service names must only contain lowercase letters,
10
- * digits or dashes, cannot use dash as the first two or last one characters, cannot contain
11
- * consecutive dashes, and must be between 2 and 60 characters in length.
12
- */
13
- name: string;
14
- }
15
- /**
16
- * Output of check name availability API.
17
- */
18
- export interface CheckNameAvailabilityOutput {
19
- /**
20
- * A value indicating whether the name is available.
21
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
22
- */
23
- readonly isNameAvailable?: boolean;
24
- /**
25
- * The reason why the name is not available. 'Invalid' indicates the name provided does not match
26
- * the naming requirements (incorrect length, unsupported characters, etc.). 'AlreadyExists'
27
- * indicates that the name is already in use and is therefore unavailable. Possible values
28
- * include: 'Invalid', 'AlreadyExists'
29
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
30
- */
31
- readonly reason?: UnavailableNameReason;
32
- /**
33
- * A message that explains why the name is invalid and provides resource naming requirements.
34
- * Available only if 'Invalid' is returned in the 'reason' property.
35
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
36
- */
37
- readonly message?: string;
38
- }
39
- /**
40
- * Response containing the primary and secondary admin API keys for a given Azure Cognitive Search
41
- * service.
42
- */
43
- export interface AdminKeyResult {
44
- /**
45
- * The primary admin API key of the search service.
46
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
47
- */
48
- readonly primaryKey?: string;
49
- /**
50
- * The secondary admin API key of the search service.
51
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
52
- */
53
- readonly secondaryKey?: string;
54
- }
55
- /**
56
- * Describes an API key for a given Azure Cognitive Search service that has permissions for query
57
- * operations only.
58
- */
59
- export interface QueryKey {
60
- /**
61
- * The name of the query API key; may be empty.
62
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
63
- */
64
- readonly name?: string;
65
- /**
66
- * The value of the query API key.
67
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
68
- */
69
- readonly key?: string;
70
- }
71
- /**
72
- * Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity
73
- * limits.
74
- */
75
- export interface Sku {
76
- /**
77
- * The SKU of the search service. Valid values include: 'free': Shared service. 'basic':
78
- * Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12
79
- * partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per
80
- * search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12
81
- * replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to
82
- * 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions.
83
- * 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.'. Possible values
84
- * include: 'free', 'basic', 'standard', 'standard2', 'standard3', 'storage_optimized_l1',
85
- * 'storage_optimized_l2'
86
- */
87
- name?: SkuName;
88
- }
89
- /**
90
- * The private endpoint resource from Microsoft.Network provider.
91
- */
92
- export interface PrivateEndpointConnectionPropertiesPrivateEndpoint {
93
- /**
94
- * The resource id of the private endpoint resource from Microsoft.Network provider.
95
- */
96
- id?: string;
97
- }
98
- /**
99
- * Describes the current state of an existing Private Link Service connection to the Azure Private
100
- * Endpoint.
101
- */
102
- export interface PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState {
103
- /**
104
- * Status of the the private link service connection. Can be Pending, Approved, Rejected, or
105
- * Disconnected. Possible values include: 'Pending', 'Approved', 'Rejected', 'Disconnected'
106
- */
107
- status?: PrivateLinkServiceConnectionStatus;
108
- /**
109
- * The description for the private link service connection state.
110
- */
111
- description?: string;
112
- /**
113
- * A description of any extra actions that may be required. Default value: 'None'.
114
- */
115
- actionsRequired?: string;
116
- }
117
- /**
118
- * Describes the properties of an existing Private Endpoint connection to the Azure Cognitive
119
- * Search service.
120
- */
121
- export interface PrivateEndpointConnectionProperties {
122
- /**
123
- * The private endpoint resource from Microsoft.Network provider.
124
- */
125
- privateEndpoint?: PrivateEndpointConnectionPropertiesPrivateEndpoint;
126
- /**
127
- * Describes the current state of an existing Private Link Service connection to the Azure
128
- * Private Endpoint.
129
- */
130
- privateLinkServiceConnectionState?: PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState;
131
- }
132
- /**
133
- * Common fields that are returned in the response for all Azure Resource Manager resources
134
- * @summary Resource
135
- */
136
- export interface Resource extends BaseResource {
137
- /**
138
- * Fully qualified resource ID for the resource. Ex -
139
- * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
140
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
141
- */
142
- readonly id?: string;
143
- /**
144
- * The name of the resource
145
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
146
- */
147
- readonly name?: string;
148
- /**
149
- * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
150
- * "Microsoft.Storage/storageAccounts"
151
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
152
- */
153
- readonly type?: string;
154
- }
155
- /**
156
- * Describes an existing Private Endpoint connection to the Azure Cognitive Search service.
157
- */
158
- export interface PrivateEndpointConnection extends Resource {
159
- /**
160
- * Describes the properties of an existing Private Endpoint connection to the Azure Cognitive
161
- * Search service.
162
- */
163
- properties?: PrivateEndpointConnectionProperties;
164
- }
165
- /**
166
- * The IP restriction rule of the Azure Cognitive Search service.
167
- */
168
- export interface IpRule {
169
- /**
170
- * Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format
171
- * (eg., 123.1.2.3/24) to be allowed.
172
- */
173
- value?: string;
174
- }
175
- /**
176
- * Network specific rules that determine how the Azure Cognitive Search service may be reached.
177
- */
178
- export interface NetworkRuleSet {
179
- /**
180
- * A list of IP restriction rules that defines the inbound network(s) with allowing access to the
181
- * search service endpoint. At the meantime, all other public IP networks are blocked by the
182
- * firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the
183
- * search service is 'enabled'; otherwise, traffic over public interface is not allowed even with
184
- * any public IP rules, and private endpoint connections would be the exclusive access method.
185
- */
186
- ipRules?: IpRule[];
187
- }
188
- /**
189
- * Describes the properties of an existing Shared Private Link Resource managed by the Azure
190
- * Cognitive Search service.
191
- */
192
- export interface SharedPrivateLinkResourceProperties {
193
- /**
194
- * The resource id of the resource the shared private link resource is for.
195
- */
196
- privateLinkResourceId?: string;
197
- /**
198
- * The group id from the provider of resource the shared private link resource is for.
199
- */
200
- groupId?: string;
201
- /**
202
- * The request message for requesting approval of the shared private link resource.
203
- */
204
- requestMessage?: string;
205
- /**
206
- * Optional. Can be used to specify the Azure Resource Manager location of the resource to which
207
- * a shared private link is to be created. This is only required for those resources whose DNS
208
- * configuration are regional (such as Azure Kubernetes Service).
209
- */
210
- resourceRegion?: string;
211
- /**
212
- * Status of the shared private link resource. Can be Pending, Approved, Rejected or
213
- * Disconnected. Possible values include: 'Pending', 'Approved', 'Rejected', 'Disconnected'
214
- */
215
- status?: SharedPrivateLinkResourceStatus;
216
- /**
217
- * The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed,
218
- * Succeeded or Incomplete. Possible values include: 'Updating', 'Deleting', 'Failed',
219
- * 'Succeeded', 'Incomplete'
220
- */
221
- provisioningState?: SharedPrivateLinkResourceProvisioningState;
222
- }
223
- /**
224
- * Describes a Shared Private Link Resource managed by the Azure Cognitive Search service.
225
- */
226
- export interface SharedPrivateLinkResource extends Resource {
227
- /**
228
- * Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive
229
- * Search service.
230
- */
231
- properties?: SharedPrivateLinkResourceProperties;
232
- }
233
- /**
234
- * Describes the properties of a resource type that has been onboarded to private link service,
235
- * supported by Azure Cognitive Search.
236
- */
237
- export interface ShareablePrivateLinkResourceProperties {
238
- /**
239
- * The resource provider type for the resource that has been onboarded to private link service,
240
- * supported by Azure Cognitive Search.
241
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
242
- */
243
- readonly type?: string;
244
- /**
245
- * The resource provider group id for the resource that has been onboarded to private link
246
- * service, supported by Azure Cognitive Search.
247
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
248
- */
249
- readonly groupId?: string;
250
- /**
251
- * The description of the resource type that has been onboarded to private link service,
252
- * supported by Azure Cognitive Search.
253
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
254
- */
255
- readonly description?: string;
256
- }
257
- /**
258
- * Describes an resource type that has been onboarded to private link service, supported by Azure
259
- * Cognitive Search.
260
- */
261
- export interface ShareablePrivateLinkResourceType {
262
- /**
263
- * The name of the resource type that has been onboarded to private link service, supported by
264
- * Azure Cognitive Search.
265
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
266
- */
267
- readonly name?: string;
268
- /**
269
- * Describes the properties of a resource type that has been onboarded to private link service,
270
- * supported by Azure Cognitive Search.
271
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
272
- */
273
- readonly properties?: ShareablePrivateLinkResourceProperties;
274
- }
275
- /**
276
- * Describes the properties of a supported private link resource for the Azure Cognitive Search
277
- * service. For a given API version, this represents the 'supported' groupIds when creating a
278
- * shared private link resource.
279
- */
280
- export interface PrivateLinkResourceProperties {
281
- /**
282
- * The group ID of the private link resource.
283
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
284
- */
285
- readonly groupId?: string;
286
- /**
287
- * The list of required members of the private link resource.
288
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
289
- */
290
- readonly requiredMembers?: string[];
291
- /**
292
- * The list of required DNS zone names of the private link resource.
293
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
294
- */
295
- readonly requiredZoneNames?: string[];
296
- /**
297
- * The list of resources that are onboarded to private link service, that are supported by Azure
298
- * Cognitive Search.
299
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
300
- */
301
- readonly shareablePrivateLinkResourceTypes?: ShareablePrivateLinkResourceType[];
302
- }
303
- /**
304
- * Describes a supported private link resource for the Azure Cognitive Search service.
305
- */
306
- export interface PrivateLinkResource extends Resource {
307
- /**
308
- * Describes the properties of a supported private link resource for the Azure Cognitive Search
309
- * service.
310
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
311
- */
312
- readonly properties?: PrivateLinkResourceProperties;
313
- }
314
- /**
315
- * Identity for the resource.
316
- */
317
- export interface Identity {
318
- /**
319
- * The principal ID of resource identity.
320
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
321
- */
322
- readonly principalId?: string;
323
- /**
324
- * The tenant ID of resource.
325
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
326
- */
327
- readonly tenantId?: string;
328
- /**
329
- * The identity type. Possible values include: 'None', 'SystemAssigned'
330
- */
331
- type: IdentityType;
332
- }
333
- /**
334
- * The resource model definition for an Azure Resource Manager tracked top level resource which has
335
- * 'tags' and a 'location'
336
- * @summary Tracked Resource
337
- */
338
- export interface TrackedResource extends Resource {
339
- /**
340
- * Resource tags.
341
- */
342
- tags?: {
343
- [propertyName: string]: string;
344
- };
345
- /**
346
- * The geo-location where the resource lives
347
- */
348
- location: string;
349
- }
350
- /**
351
- * Describes an Azure Cognitive Search service and its current state.
352
- */
353
- export interface SearchService extends TrackedResource {
354
- /**
355
- * The number of replicas in the search service. If specified, it must be a value between 1 and
356
- * 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU. Default value: 1.
357
- */
358
- replicaCount?: number;
359
- /**
360
- * The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12.
361
- * Values greater than 1 are only valid for standard SKUs. For 'standard3' services with
362
- * hostingMode set to 'highDensity', the allowed values are between 1 and 3. Default value: 1.
363
- */
364
- partitionCount?: number;
365
- /**
366
- * Applicable only for the standard3 SKU. You can set this property to enable up to 3 high
367
- * density partitions that allow up to 1000 indexes, which is much higher than the maximum
368
- * indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or
369
- * 'highDensity'. For all other SKUs, this value must be 'default'. Possible values include:
370
- * 'default', 'highDensity'. Default value: 'default'.
371
- */
372
- hostingMode?: HostingMode;
373
- /**
374
- * This value can be set to 'enabled' to avoid breaking changes on existing customer resources
375
- * and templates. If set to 'disabled', traffic over public interface is not allowed, and private
376
- * endpoint connections would be the exclusive access method. Possible values include: 'enabled',
377
- * 'disabled'. Default value: 'enabled'.
378
- */
379
- publicNetworkAccess?: PublicNetworkAccess;
380
- /**
381
- * The status of the search service. Possible values include: 'running': The search service is
382
- * running and no provisioning operations are underway. 'provisioning': The search service is
383
- * being provisioned or scaled up or down. 'deleting': The search service is being deleted.
384
- * 'degraded': The search service is degraded. This can occur when the underlying search units
385
- * are not healthy. The search service is most likely operational, but performance might be slow
386
- * and some requests might be dropped. 'disabled': The search service is disabled. In this state,
387
- * the service will reject all API requests. 'error': The search service is in an error state. If
388
- * your service is in the degraded, disabled, or error states, it means the Azure Cognitive
389
- * Search team is actively investigating the underlying issue. Dedicated services in these states
390
- * are still chargeable based on the number of search units provisioned. Possible values include:
391
- * 'running', 'provisioning', 'deleting', 'degraded', 'disabled', 'error'
392
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
393
- */
394
- readonly status?: SearchServiceStatus;
395
- /**
396
- * The details of the search service status.
397
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
398
- */
399
- readonly statusDetails?: string;
400
- /**
401
- * The state of the last provisioning operation performed on the search service. Provisioning is
402
- * an intermediate state that occurs while service capacity is being established. After capacity
403
- * is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications
404
- * can poll provisioning status (the recommended polling interval is from 30 seconds to one
405
- * minute) by using the Get Search Service operation to see when an operation is completed. If
406
- * you are using the free service, this value tends to come back as 'succeeded' directly in the
407
- * call to Create search service. This is because the free service uses capacity that is already
408
- * set up. Possible values include: 'succeeded', 'provisioning', 'failed'
409
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
410
- */
411
- readonly provisioningState?: ProvisioningState;
412
- /**
413
- * Network specific rules that determine how the Azure Cognitive Search service may be reached.
414
- */
415
- networkRuleSet?: NetworkRuleSet;
416
- /**
417
- * The list of private endpoint connections to the Azure Cognitive Search service.
418
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
419
- */
420
- readonly privateEndpointConnections?: PrivateEndpointConnection[];
421
- /**
422
- * The list of shared private link resources managed by the Azure Cognitive Search service.
423
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
424
- */
425
- readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
426
- /**
427
- * The SKU of the Search Service, which determines price tier and capacity limits. This property
428
- * is required when creating a new Search Service.
429
- */
430
- sku?: Sku;
431
- /**
432
- * The identity of the resource.
433
- */
434
- identity?: Identity;
435
- }
436
- /**
437
- * The parameters used to update an Azure Cognitive Search service.
438
- */
439
- export interface SearchServiceUpdate extends Resource {
440
- /**
441
- * The number of replicas in the search service. If specified, it must be a value between 1 and
442
- * 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU. Default value: 1.
443
- */
444
- replicaCount?: number;
445
- /**
446
- * The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12.
447
- * Values greater than 1 are only valid for standard SKUs. For 'standard3' services with
448
- * hostingMode set to 'highDensity', the allowed values are between 1 and 3. Default value: 1.
449
- */
450
- partitionCount?: number;
451
- /**
452
- * Applicable only for the standard3 SKU. You can set this property to enable up to 3 high
453
- * density partitions that allow up to 1000 indexes, which is much higher than the maximum
454
- * indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or
455
- * 'highDensity'. For all other SKUs, this value must be 'default'. Possible values include:
456
- * 'default', 'highDensity'. Default value: 'default'.
457
- */
458
- hostingMode?: HostingMode;
459
- /**
460
- * This value can be set to 'enabled' to avoid breaking changes on existing customer resources
461
- * and templates. If set to 'disabled', traffic over public interface is not allowed, and private
462
- * endpoint connections would be the exclusive access method. Possible values include: 'enabled',
463
- * 'disabled'. Default value: 'enabled'.
464
- */
465
- publicNetworkAccess?: PublicNetworkAccess;
466
- /**
467
- * The status of the search service. Possible values include: 'running': The search service is
468
- * running and no provisioning operations are underway. 'provisioning': The search service is
469
- * being provisioned or scaled up or down. 'deleting': The search service is being deleted.
470
- * 'degraded': The search service is degraded. This can occur when the underlying search units
471
- * are not healthy. The search service is most likely operational, but performance might be slow
472
- * and some requests might be dropped. 'disabled': The search service is disabled. In this state,
473
- * the service will reject all API requests. 'error': The search service is in an error state. If
474
- * your service is in the degraded, disabled, or error states, it means the Azure Cognitive
475
- * Search team is actively investigating the underlying issue. Dedicated services in these states
476
- * are still chargeable based on the number of search units provisioned. Possible values include:
477
- * 'running', 'provisioning', 'deleting', 'degraded', 'disabled', 'error'
478
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
479
- */
480
- readonly status?: SearchServiceStatus;
481
- /**
482
- * The details of the search service status.
483
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
484
- */
485
- readonly statusDetails?: string;
486
- /**
487
- * The state of the last provisioning operation performed on the search service. Provisioning is
488
- * an intermediate state that occurs while service capacity is being established. After capacity
489
- * is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications
490
- * can poll provisioning status (the recommended polling interval is from 30 seconds to one
491
- * minute) by using the Get Search Service operation to see when an operation is completed. If
492
- * you are using the free service, this value tends to come back as 'succeeded' directly in the
493
- * call to Create search service. This is because the free service uses capacity that is already
494
- * set up. Possible values include: 'succeeded', 'provisioning', 'failed'
495
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
496
- */
497
- readonly provisioningState?: ProvisioningState;
498
- /**
499
- * Network specific rules that determine how the Azure Cognitive Search service may be reached.
500
- */
501
- networkRuleSet?: NetworkRuleSet;
502
- /**
503
- * The list of private endpoint connections to the Azure Cognitive Search service.
504
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
505
- */
506
- readonly privateEndpointConnections?: PrivateEndpointConnection[];
507
- /**
508
- * The list of shared private link resources managed by the Azure Cognitive Search service.
509
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
510
- */
511
- readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
512
- /**
513
- * The SKU of the Search Service, which determines price tier and capacity limits. This property
514
- * is required when creating a new Search Service.
515
- */
516
- sku?: Sku;
517
- /**
518
- * The geographic location of the resource. This must be one of the supported and registered
519
- * Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). This property
520
- * is required when creating a new resource.
521
- */
522
- location?: string;
523
- /**
524
- * Tags to help categorize the resource in the Azure portal.
525
- */
526
- tags?: {
527
- [propertyName: string]: string;
528
- };
529
- /**
530
- * The identity of the resource.
531
- */
532
- identity?: Identity;
533
- }
534
- /**
535
- * The details of a long running asynchronous shared private link resource operation
536
- */
537
- export interface AsyncOperationResult {
538
- /**
539
- * The current status of the long running asynchronous shared private link resource operation.
540
- * Possible values include: 'Running', 'Succeeded', 'Failed'
541
- */
542
- status?: SharedPrivateLinkResourceAsyncOperationResult;
543
- }
544
- /**
545
- * The object that describes the operation.
546
- */
547
- export interface OperationDisplay {
548
- /**
549
- * The friendly name of the resource provider.
550
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
551
- */
552
- readonly provider?: string;
553
- /**
554
- * The operation type: read, write, delete, listKeys/action, etc.
555
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
556
- */
557
- readonly operation?: string;
558
- /**
559
- * The resource type on which the operation is performed.
560
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
561
- */
562
- readonly resource?: string;
563
- /**
564
- * The friendly name of the operation.
565
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
566
- */
567
- readonly description?: string;
568
- }
569
- /**
570
- * Describes a REST API operation.
571
- */
572
- export interface Operation {
573
- /**
574
- * The name of the operation. This name is of the form {provider}/{resource}/{operation}.
575
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
576
- */
577
- readonly name?: string;
578
- /**
579
- * The object that describes the operation.
580
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
581
- */
582
- readonly display?: OperationDisplay;
583
- }
584
- /**
585
- * The resource model definition for a Azure Resource Manager proxy resource. It will not have tags
586
- * and a location
587
- * @summary Proxy Resource
588
- */
589
- export interface ProxyResource extends Resource {
590
- }
591
- /**
592
- * The resource model definition for an Azure Resource Manager resource with an etag.
593
- * @summary Entity Resource
594
- */
595
- export interface AzureEntityResource extends Resource {
596
- /**
597
- * Resource Etag.
598
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
599
- */
600
- readonly etag?: string;
601
- }
602
- /**
603
- * Additional parameters for a set of operations.
604
- */
605
- export interface SearchManagementRequestOptions {
606
- /**
607
- * A client-generated GUID value that identifies this request. If specified, this will be
608
- * included in response information as a way to track the request.
609
- */
610
- clientRequestId?: string;
611
- }
612
- /**
613
- * Optional Parameters.
614
- */
615
- export interface AdminKeysGetOptionalParams extends msRest.RequestOptionsBase {
616
- /**
617
- * Additional parameters for the operation
618
- */
619
- searchManagementRequestOptions?: SearchManagementRequestOptions;
620
- }
621
- /**
622
- * Optional Parameters.
623
- */
624
- export interface AdminKeysRegenerateOptionalParams extends msRest.RequestOptionsBase {
625
- /**
626
- * Additional parameters for the operation
627
- */
628
- searchManagementRequestOptions?: SearchManagementRequestOptions;
629
- }
630
- /**
631
- * Optional Parameters.
632
- */
633
- export interface QueryKeysCreateOptionalParams extends msRest.RequestOptionsBase {
634
- /**
635
- * Additional parameters for the operation
636
- */
637
- searchManagementRequestOptions?: SearchManagementRequestOptions;
638
- }
639
- /**
640
- * Optional Parameters.
641
- */
642
- export interface QueryKeysListBySearchServiceOptionalParams extends msRest.RequestOptionsBase {
643
- /**
644
- * Additional parameters for the operation
645
- */
646
- searchManagementRequestOptions?: SearchManagementRequestOptions;
647
- }
648
- /**
649
- * Optional Parameters.
650
- */
651
- export interface QueryKeysDeleteMethodOptionalParams extends msRest.RequestOptionsBase {
652
- /**
653
- * Additional parameters for the operation
654
- */
655
- searchManagementRequestOptions?: SearchManagementRequestOptions;
656
- }
657
- /**
658
- * Optional Parameters.
659
- */
660
- export interface QueryKeysListBySearchServiceNextOptionalParams extends msRest.RequestOptionsBase {
661
- /**
662
- * Additional parameters for the operation
663
- */
664
- searchManagementRequestOptions?: SearchManagementRequestOptions;
665
- }
666
- /**
667
- * Optional Parameters.
668
- */
669
- export interface ServicesCreateOrUpdateOptionalParams extends msRest.RequestOptionsBase {
670
- /**
671
- * Additional parameters for the operation
672
- */
673
- searchManagementRequestOptions?: SearchManagementRequestOptions;
674
- }
675
- /**
676
- * Optional Parameters.
677
- */
678
- export interface ServicesUpdateOptionalParams extends msRest.RequestOptionsBase {
679
- /**
680
- * Additional parameters for the operation
681
- */
682
- searchManagementRequestOptions?: SearchManagementRequestOptions;
683
- }
684
- /**
685
- * Optional Parameters.
686
- */
687
- export interface ServicesGetOptionalParams extends msRest.RequestOptionsBase {
688
- /**
689
- * Additional parameters for the operation
690
- */
691
- searchManagementRequestOptions?: SearchManagementRequestOptions;
692
- }
693
- /**
694
- * Optional Parameters.
695
- */
696
- export interface ServicesDeleteMethodOptionalParams extends msRest.RequestOptionsBase {
697
- /**
698
- * Additional parameters for the operation
699
- */
700
- searchManagementRequestOptions?: SearchManagementRequestOptions;
701
- }
702
- /**
703
- * Optional Parameters.
704
- */
705
- export interface ServicesListByResourceGroupOptionalParams extends msRest.RequestOptionsBase {
706
- /**
707
- * Additional parameters for the operation
708
- */
709
- searchManagementRequestOptions?: SearchManagementRequestOptions;
710
- }
711
- /**
712
- * Optional Parameters.
713
- */
714
- export interface ServicesListBySubscriptionOptionalParams extends msRest.RequestOptionsBase {
715
- /**
716
- * Additional parameters for the operation
717
- */
718
- searchManagementRequestOptions?: SearchManagementRequestOptions;
719
- }
720
- /**
721
- * Optional Parameters.
722
- */
723
- export interface ServicesCheckNameAvailabilityOptionalParams extends msRest.RequestOptionsBase {
724
- /**
725
- * Additional parameters for the operation
726
- */
727
- searchManagementRequestOptions?: SearchManagementRequestOptions;
728
- }
729
- /**
730
- * Optional Parameters.
731
- */
732
- export interface ServicesBeginCreateOrUpdateOptionalParams extends msRest.RequestOptionsBase {
733
- /**
734
- * Additional parameters for the operation
735
- */
736
- searchManagementRequestOptions?: SearchManagementRequestOptions;
737
- }
738
- /**
739
- * Optional Parameters.
740
- */
741
- export interface ServicesListByResourceGroupNextOptionalParams extends msRest.RequestOptionsBase {
742
- /**
743
- * Additional parameters for the operation
744
- */
745
- searchManagementRequestOptions?: SearchManagementRequestOptions;
746
- }
747
- /**
748
- * Optional Parameters.
749
- */
750
- export interface ServicesListBySubscriptionNextOptionalParams extends msRest.RequestOptionsBase {
751
- /**
752
- * Additional parameters for the operation
753
- */
754
- searchManagementRequestOptions?: SearchManagementRequestOptions;
755
- }
756
- /**
757
- * Optional Parameters.
758
- */
759
- export interface PrivateLinkResourcesListSupportedOptionalParams extends msRest.RequestOptionsBase {
760
- /**
761
- * Additional parameters for the operation
762
- */
763
- searchManagementRequestOptions?: SearchManagementRequestOptions;
764
- }
765
- /**
766
- * Optional Parameters.
767
- */
768
- export interface PrivateEndpointConnectionsUpdateOptionalParams extends msRest.RequestOptionsBase {
769
- /**
770
- * Additional parameters for the operation
771
- */
772
- searchManagementRequestOptions?: SearchManagementRequestOptions;
773
- }
774
- /**
775
- * Optional Parameters.
776
- */
777
- export interface PrivateEndpointConnectionsGetOptionalParams extends msRest.RequestOptionsBase {
778
- /**
779
- * Additional parameters for the operation
780
- */
781
- searchManagementRequestOptions?: SearchManagementRequestOptions;
782
- }
783
- /**
784
- * Optional Parameters.
785
- */
786
- export interface PrivateEndpointConnectionsDeleteMethodOptionalParams extends msRest.RequestOptionsBase {
787
- /**
788
- * Additional parameters for the operation
789
- */
790
- searchManagementRequestOptions?: SearchManagementRequestOptions;
791
- }
792
- /**
793
- * Optional Parameters.
794
- */
795
- export interface PrivateEndpointConnectionsListByServiceOptionalParams extends msRest.RequestOptionsBase {
796
- /**
797
- * Additional parameters for the operation
798
- */
799
- searchManagementRequestOptions?: SearchManagementRequestOptions;
800
- }
801
- /**
802
- * Optional Parameters.
803
- */
804
- export interface PrivateEndpointConnectionsListByServiceNextOptionalParams extends msRest.RequestOptionsBase {
805
- /**
806
- * Additional parameters for the operation
807
- */
808
- searchManagementRequestOptions?: SearchManagementRequestOptions;
809
- }
810
- /**
811
- * Optional Parameters.
812
- */
813
- export interface SharedPrivateLinkResourcesCreateOrUpdateOptionalParams extends msRest.RequestOptionsBase {
814
- /**
815
- * Additional parameters for the operation
816
- */
817
- searchManagementRequestOptions?: SearchManagementRequestOptions;
818
- }
819
- /**
820
- * Optional Parameters.
821
- */
822
- export interface SharedPrivateLinkResourcesGetOptionalParams extends msRest.RequestOptionsBase {
823
- /**
824
- * Additional parameters for the operation
825
- */
826
- searchManagementRequestOptions?: SearchManagementRequestOptions;
827
- }
828
- /**
829
- * Optional Parameters.
830
- */
831
- export interface SharedPrivateLinkResourcesDeleteMethodOptionalParams extends msRest.RequestOptionsBase {
832
- /**
833
- * Additional parameters for the operation
834
- */
835
- searchManagementRequestOptions?: SearchManagementRequestOptions;
836
- }
837
- /**
838
- * Optional Parameters.
839
- */
840
- export interface SharedPrivateLinkResourcesListByServiceOptionalParams extends msRest.RequestOptionsBase {
841
- /**
842
- * Additional parameters for the operation
843
- */
844
- searchManagementRequestOptions?: SearchManagementRequestOptions;
845
- }
846
- /**
847
- * Optional Parameters.
848
- */
849
- export interface SharedPrivateLinkResourcesBeginCreateOrUpdateOptionalParams extends msRest.RequestOptionsBase {
850
- /**
851
- * Additional parameters for the operation
852
- */
853
- searchManagementRequestOptions?: SearchManagementRequestOptions;
854
- }
855
- /**
856
- * Optional Parameters.
857
- */
858
- export interface SharedPrivateLinkResourcesBeginDeleteMethodOptionalParams extends msRest.RequestOptionsBase {
859
- /**
860
- * Additional parameters for the operation
861
- */
862
- searchManagementRequestOptions?: SearchManagementRequestOptions;
863
- }
864
- /**
865
- * Optional Parameters.
866
- */
867
- export interface SharedPrivateLinkResourcesListByServiceNextOptionalParams extends msRest.RequestOptionsBase {
868
- /**
869
- * Additional parameters for the operation
870
- */
871
- searchManagementRequestOptions?: SearchManagementRequestOptions;
872
- }
873
- /**
874
- * An interface representing SearchManagementClientOptions.
875
- */
876
- export interface SearchManagementClientOptions extends AzureServiceClientOptions {
877
- baseUri?: string;
878
- }
879
- /**
880
- * @interface
881
- * The result of the request to list REST API operations. It contains a list of operations and a
882
- * URL to get the next set of results.
883
- * @extends Array<Operation>
884
- */
885
- export interface OperationListResult extends Array<Operation> {
886
- /**
887
- * The URL to get the next set of operation list results, if any.
888
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
889
- */
890
- readonly nextLink?: string;
891
- }
892
- /**
893
- * @interface
894
- * Response containing the query API keys for a given Azure Cognitive Search service.
895
- * @extends Array<QueryKey>
896
- */
897
- export interface ListQueryKeysResult extends Array<QueryKey> {
898
- /**
899
- * Request URL that can be used to query next page of query keys. Returned when the total number
900
- * of requested query keys exceed maximum page size.
901
- */
902
- readonly nextLink?: string;
903
- }
904
- /**
905
- * @interface
906
- * Response containing a list of Azure Cognitive Search services.
907
- * @extends Array<SearchService>
908
- */
909
- export interface SearchServiceListResult extends Array<SearchService> {
910
- /**
911
- * Request URL that can be used to query next page of search services. Returned when the total
912
- * number of requested search services exceed maximum page size.
913
- */
914
- readonly nextLink?: string;
915
- }
916
- /**
917
- * @interface
918
- * Response containing a list of supported Private Link Resources.
919
- * @extends Array<PrivateLinkResource>
920
- */
921
- export interface PrivateLinkResourcesResult extends Array<PrivateLinkResource> {
922
- }
923
- /**
924
- * @interface
925
- * Response containing a list of Private Endpoint connections.
926
- * @extends Array<PrivateEndpointConnection>
927
- */
928
- export interface PrivateEndpointConnectionListResult extends Array<PrivateEndpointConnection> {
929
- /**
930
- * Request URL that can be used to query next page of private endpoint connections. Returned when
931
- * the total number of requested private endpoint connections exceed maximum page size.
932
- */
933
- readonly nextLink?: string;
934
- }
935
- /**
936
- * @interface
937
- * Response containing a list of Shared Private Link Resources.
938
- * @extends Array<SharedPrivateLinkResource>
939
- */
940
- export interface SharedPrivateLinkResourceListResult extends Array<SharedPrivateLinkResource> {
941
- /**
942
- * The URL to get the next set of shared private link resources, if there are any.
943
- */
944
- nextLink?: string;
945
- }
946
- /**
947
- * Defines values for UnavailableNameReason.
948
- * Possible values include: 'Invalid', 'AlreadyExists'
949
- * @readonly
950
- * @enum {string}
951
- */
952
- export declare type UnavailableNameReason = 'Invalid' | 'AlreadyExists';
953
- /**
954
- * Defines values for SkuName.
955
- * Possible values include: 'free', 'basic', 'standard', 'standard2', 'standard3',
956
- * 'storage_optimized_l1', 'storage_optimized_l2'
957
- * @readonly
958
- * @enum {string}
959
- */
960
- export declare type SkuName = 'free' | 'basic' | 'standard' | 'standard2' | 'standard3' | 'storage_optimized_l1' | 'storage_optimized_l2';
961
- /**
962
- * Defines values for PrivateLinkServiceConnectionStatus.
963
- * Possible values include: 'Pending', 'Approved', 'Rejected', 'Disconnected'
964
- * @readonly
965
- * @enum {string}
966
- */
967
- export declare type PrivateLinkServiceConnectionStatus = 'Pending' | 'Approved' | 'Rejected' | 'Disconnected';
968
- /**
969
- * Defines values for SharedPrivateLinkResourceStatus.
970
- * Possible values include: 'Pending', 'Approved', 'Rejected', 'Disconnected'
971
- * @readonly
972
- * @enum {string}
973
- */
974
- export declare type SharedPrivateLinkResourceStatus = 'Pending' | 'Approved' | 'Rejected' | 'Disconnected';
975
- /**
976
- * Defines values for SharedPrivateLinkResourceProvisioningState.
977
- * Possible values include: 'Updating', 'Deleting', 'Failed', 'Succeeded', 'Incomplete'
978
- * @readonly
979
- * @enum {string}
980
- */
981
- export declare type SharedPrivateLinkResourceProvisioningState = 'Updating' | 'Deleting' | 'Failed' | 'Succeeded' | 'Incomplete';
982
- /**
983
- * Defines values for HostingMode.
984
- * Possible values include: 'default', 'highDensity'
985
- * @readonly
986
- * @enum {string}
987
- */
988
- export declare type HostingMode = 'default' | 'highDensity';
989
- /**
990
- * Defines values for PublicNetworkAccess.
991
- * Possible values include: 'enabled', 'disabled'
992
- * @readonly
993
- * @enum {string}
994
- */
995
- export declare type PublicNetworkAccess = 'enabled' | 'disabled';
996
- /**
997
- * Defines values for SearchServiceStatus.
998
- * Possible values include: 'running', 'provisioning', 'deleting', 'degraded', 'disabled', 'error'
999
- * @readonly
1000
- * @enum {string}
1001
- */
1002
- export declare type SearchServiceStatus = 'running' | 'provisioning' | 'deleting' | 'degraded' | 'disabled' | 'error';
1003
- /**
1004
- * Defines values for ProvisioningState.
1005
- * Possible values include: 'succeeded', 'provisioning', 'failed'
1006
- * @readonly
1007
- * @enum {string}
1008
- */
1009
- export declare type ProvisioningState = 'succeeded' | 'provisioning' | 'failed';
1010
- /**
1011
- * Defines values for IdentityType.
1012
- * Possible values include: 'None', 'SystemAssigned'
1013
- * @readonly
1014
- * @enum {string}
1015
- */
1016
- export declare type IdentityType = 'None' | 'SystemAssigned';
1017
- /**
1018
- * Defines values for SharedPrivateLinkResourceAsyncOperationResult.
1019
- * Possible values include: 'Running', 'Succeeded', 'Failed'
1020
- * @readonly
1021
- * @enum {string}
1022
- */
1023
- export declare type SharedPrivateLinkResourceAsyncOperationResult = 'Running' | 'Succeeded' | 'Failed';
1024
- /**
1025
- * Defines values for AdminKeyKind.
1026
- * Possible values include: 'primary', 'secondary'
1027
- * @readonly
1028
- * @enum {string}
1029
- */
1030
- export declare type AdminKeyKind = 'primary' | 'secondary';
1031
- /**
1032
- * Contains response data for the list operation.
1033
- */
1034
- export declare type OperationsListResponse = OperationListResult & {
1035
- /**
1036
- * The underlying HTTP response.
1037
- */
1038
- _response: msRest.HttpResponse & {
1039
- /**
1040
- * The response body as text (string format)
1041
- */
1042
- bodyAsText: string;
1043
- /**
1044
- * The response body as parsed JSON or XML
1045
- */
1046
- parsedBody: OperationListResult;
1047
- };
1048
- };
1049
- /**
1050
- * Contains response data for the get operation.
1051
- */
1052
- export declare type AdminKeysGetResponse = AdminKeyResult & {
1053
- /**
1054
- * The underlying HTTP response.
1055
- */
1056
- _response: msRest.HttpResponse & {
1057
- /**
1058
- * The response body as text (string format)
1059
- */
1060
- bodyAsText: string;
1061
- /**
1062
- * The response body as parsed JSON or XML
1063
- */
1064
- parsedBody: AdminKeyResult;
1065
- };
1066
- };
1067
- /**
1068
- * Contains response data for the regenerate operation.
1069
- */
1070
- export declare type AdminKeysRegenerateResponse = AdminKeyResult & {
1071
- /**
1072
- * The underlying HTTP response.
1073
- */
1074
- _response: msRest.HttpResponse & {
1075
- /**
1076
- * The response body as text (string format)
1077
- */
1078
- bodyAsText: string;
1079
- /**
1080
- * The response body as parsed JSON or XML
1081
- */
1082
- parsedBody: AdminKeyResult;
1083
- };
1084
- };
1085
- /**
1086
- * Contains response data for the create operation.
1087
- */
1088
- export declare type QueryKeysCreateResponse = QueryKey & {
1089
- /**
1090
- * The underlying HTTP response.
1091
- */
1092
- _response: msRest.HttpResponse & {
1093
- /**
1094
- * The response body as text (string format)
1095
- */
1096
- bodyAsText: string;
1097
- /**
1098
- * The response body as parsed JSON or XML
1099
- */
1100
- parsedBody: QueryKey;
1101
- };
1102
- };
1103
- /**
1104
- * Contains response data for the listBySearchService operation.
1105
- */
1106
- export declare type QueryKeysListBySearchServiceResponse = ListQueryKeysResult & {
1107
- /**
1108
- * The underlying HTTP response.
1109
- */
1110
- _response: msRest.HttpResponse & {
1111
- /**
1112
- * The response body as text (string format)
1113
- */
1114
- bodyAsText: string;
1115
- /**
1116
- * The response body as parsed JSON or XML
1117
- */
1118
- parsedBody: ListQueryKeysResult;
1119
- };
1120
- };
1121
- /**
1122
- * Contains response data for the listBySearchServiceNext operation.
1123
- */
1124
- export declare type QueryKeysListBySearchServiceNextResponse = ListQueryKeysResult & {
1125
- /**
1126
- * The underlying HTTP response.
1127
- */
1128
- _response: msRest.HttpResponse & {
1129
- /**
1130
- * The response body as text (string format)
1131
- */
1132
- bodyAsText: string;
1133
- /**
1134
- * The response body as parsed JSON or XML
1135
- */
1136
- parsedBody: ListQueryKeysResult;
1137
- };
1138
- };
1139
- /**
1140
- * Contains response data for the createOrUpdate operation.
1141
- */
1142
- export declare type ServicesCreateOrUpdateResponse = SearchService & {
1143
- /**
1144
- * The underlying HTTP response.
1145
- */
1146
- _response: msRest.HttpResponse & {
1147
- /**
1148
- * The response body as text (string format)
1149
- */
1150
- bodyAsText: string;
1151
- /**
1152
- * The response body as parsed JSON or XML
1153
- */
1154
- parsedBody: SearchService;
1155
- };
1156
- };
1157
- /**
1158
- * Contains response data for the update operation.
1159
- */
1160
- export declare type ServicesUpdateResponse = SearchService & {
1161
- /**
1162
- * The underlying HTTP response.
1163
- */
1164
- _response: msRest.HttpResponse & {
1165
- /**
1166
- * The response body as text (string format)
1167
- */
1168
- bodyAsText: string;
1169
- /**
1170
- * The response body as parsed JSON or XML
1171
- */
1172
- parsedBody: SearchService;
1173
- };
1174
- };
1175
- /**
1176
- * Contains response data for the get operation.
1177
- */
1178
- export declare type ServicesGetResponse = SearchService & {
1179
- /**
1180
- * The underlying HTTP response.
1181
- */
1182
- _response: msRest.HttpResponse & {
1183
- /**
1184
- * The response body as text (string format)
1185
- */
1186
- bodyAsText: string;
1187
- /**
1188
- * The response body as parsed JSON or XML
1189
- */
1190
- parsedBody: SearchService;
1191
- };
1192
- };
1193
- /**
1194
- * Contains response data for the listByResourceGroup operation.
1195
- */
1196
- export declare type ServicesListByResourceGroupResponse = SearchServiceListResult & {
1197
- /**
1198
- * The underlying HTTP response.
1199
- */
1200
- _response: msRest.HttpResponse & {
1201
- /**
1202
- * The response body as text (string format)
1203
- */
1204
- bodyAsText: string;
1205
- /**
1206
- * The response body as parsed JSON or XML
1207
- */
1208
- parsedBody: SearchServiceListResult;
1209
- };
1210
- };
1211
- /**
1212
- * Contains response data for the listBySubscription operation.
1213
- */
1214
- export declare type ServicesListBySubscriptionResponse = SearchServiceListResult & {
1215
- /**
1216
- * The underlying HTTP response.
1217
- */
1218
- _response: msRest.HttpResponse & {
1219
- /**
1220
- * The response body as text (string format)
1221
- */
1222
- bodyAsText: string;
1223
- /**
1224
- * The response body as parsed JSON or XML
1225
- */
1226
- parsedBody: SearchServiceListResult;
1227
- };
1228
- };
1229
- /**
1230
- * Contains response data for the checkNameAvailability operation.
1231
- */
1232
- export declare type ServicesCheckNameAvailabilityResponse = CheckNameAvailabilityOutput & {
1233
- /**
1234
- * The underlying HTTP response.
1235
- */
1236
- _response: msRest.HttpResponse & {
1237
- /**
1238
- * The response body as text (string format)
1239
- */
1240
- bodyAsText: string;
1241
- /**
1242
- * The response body as parsed JSON or XML
1243
- */
1244
- parsedBody: CheckNameAvailabilityOutput;
1245
- };
1246
- };
1247
- /**
1248
- * Contains response data for the beginCreateOrUpdate operation.
1249
- */
1250
- export declare type ServicesBeginCreateOrUpdateResponse = SearchService & {
1251
- /**
1252
- * The underlying HTTP response.
1253
- */
1254
- _response: msRest.HttpResponse & {
1255
- /**
1256
- * The response body as text (string format)
1257
- */
1258
- bodyAsText: string;
1259
- /**
1260
- * The response body as parsed JSON or XML
1261
- */
1262
- parsedBody: SearchService;
1263
- };
1264
- };
1265
- /**
1266
- * Contains response data for the listByResourceGroupNext operation.
1267
- */
1268
- export declare type ServicesListByResourceGroupNextResponse = SearchServiceListResult & {
1269
- /**
1270
- * The underlying HTTP response.
1271
- */
1272
- _response: msRest.HttpResponse & {
1273
- /**
1274
- * The response body as text (string format)
1275
- */
1276
- bodyAsText: string;
1277
- /**
1278
- * The response body as parsed JSON or XML
1279
- */
1280
- parsedBody: SearchServiceListResult;
1281
- };
1282
- };
1283
- /**
1284
- * Contains response data for the listBySubscriptionNext operation.
1285
- */
1286
- export declare type ServicesListBySubscriptionNextResponse = SearchServiceListResult & {
1287
- /**
1288
- * The underlying HTTP response.
1289
- */
1290
- _response: msRest.HttpResponse & {
1291
- /**
1292
- * The response body as text (string format)
1293
- */
1294
- bodyAsText: string;
1295
- /**
1296
- * The response body as parsed JSON or XML
1297
- */
1298
- parsedBody: SearchServiceListResult;
1299
- };
1300
- };
1301
- /**
1302
- * Contains response data for the listSupported operation.
1303
- */
1304
- export declare type PrivateLinkResourcesListSupportedResponse = PrivateLinkResourcesResult & {
1305
- /**
1306
- * The underlying HTTP response.
1307
- */
1308
- _response: msRest.HttpResponse & {
1309
- /**
1310
- * The response body as text (string format)
1311
- */
1312
- bodyAsText: string;
1313
- /**
1314
- * The response body as parsed JSON or XML
1315
- */
1316
- parsedBody: PrivateLinkResourcesResult;
1317
- };
1318
- };
1319
- /**
1320
- * Contains response data for the update operation.
1321
- */
1322
- export declare type PrivateEndpointConnectionsUpdateResponse = PrivateEndpointConnection & {
1323
- /**
1324
- * The underlying HTTP response.
1325
- */
1326
- _response: msRest.HttpResponse & {
1327
- /**
1328
- * The response body as text (string format)
1329
- */
1330
- bodyAsText: string;
1331
- /**
1332
- * The response body as parsed JSON or XML
1333
- */
1334
- parsedBody: PrivateEndpointConnection;
1335
- };
1336
- };
1337
- /**
1338
- * Contains response data for the get operation.
1339
- */
1340
- export declare type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection & {
1341
- /**
1342
- * The underlying HTTP response.
1343
- */
1344
- _response: msRest.HttpResponse & {
1345
- /**
1346
- * The response body as text (string format)
1347
- */
1348
- bodyAsText: string;
1349
- /**
1350
- * The response body as parsed JSON or XML
1351
- */
1352
- parsedBody: PrivateEndpointConnection;
1353
- };
1354
- };
1355
- /**
1356
- * Contains response data for the deleteMethod operation.
1357
- */
1358
- export declare type PrivateEndpointConnectionsDeleteMethodResponse = PrivateEndpointConnection & {
1359
- /**
1360
- * The underlying HTTP response.
1361
- */
1362
- _response: msRest.HttpResponse & {
1363
- /**
1364
- * The response body as text (string format)
1365
- */
1366
- bodyAsText: string;
1367
- /**
1368
- * The response body as parsed JSON or XML
1369
- */
1370
- parsedBody: PrivateEndpointConnection;
1371
- };
1372
- };
1373
- /**
1374
- * Contains response data for the listByService operation.
1375
- */
1376
- export declare type PrivateEndpointConnectionsListByServiceResponse = PrivateEndpointConnectionListResult & {
1377
- /**
1378
- * The underlying HTTP response.
1379
- */
1380
- _response: msRest.HttpResponse & {
1381
- /**
1382
- * The response body as text (string format)
1383
- */
1384
- bodyAsText: string;
1385
- /**
1386
- * The response body as parsed JSON or XML
1387
- */
1388
- parsedBody: PrivateEndpointConnectionListResult;
1389
- };
1390
- };
1391
- /**
1392
- * Contains response data for the listByServiceNext operation.
1393
- */
1394
- export declare type PrivateEndpointConnectionsListByServiceNextResponse = PrivateEndpointConnectionListResult & {
1395
- /**
1396
- * The underlying HTTP response.
1397
- */
1398
- _response: msRest.HttpResponse & {
1399
- /**
1400
- * The response body as text (string format)
1401
- */
1402
- bodyAsText: string;
1403
- /**
1404
- * The response body as parsed JSON or XML
1405
- */
1406
- parsedBody: PrivateEndpointConnectionListResult;
1407
- };
1408
- };
1409
- /**
1410
- * Contains response data for the createOrUpdate operation.
1411
- */
1412
- export declare type SharedPrivateLinkResourcesCreateOrUpdateResponse = SharedPrivateLinkResource & {
1413
- /**
1414
- * The underlying HTTP response.
1415
- */
1416
- _response: msRest.HttpResponse & {
1417
- /**
1418
- * The response body as text (string format)
1419
- */
1420
- bodyAsText: string;
1421
- /**
1422
- * The response body as parsed JSON or XML
1423
- */
1424
- parsedBody: SharedPrivateLinkResource;
1425
- };
1426
- };
1427
- /**
1428
- * Contains response data for the get operation.
1429
- */
1430
- export declare type SharedPrivateLinkResourcesGetResponse = SharedPrivateLinkResource & {
1431
- /**
1432
- * The underlying HTTP response.
1433
- */
1434
- _response: msRest.HttpResponse & {
1435
- /**
1436
- * The response body as text (string format)
1437
- */
1438
- bodyAsText: string;
1439
- /**
1440
- * The response body as parsed JSON or XML
1441
- */
1442
- parsedBody: SharedPrivateLinkResource;
1443
- };
1444
- };
1445
- /**
1446
- * Contains response data for the listByService operation.
1447
- */
1448
- export declare type SharedPrivateLinkResourcesListByServiceResponse = SharedPrivateLinkResourceListResult & {
1449
- /**
1450
- * The underlying HTTP response.
1451
- */
1452
- _response: msRest.HttpResponse & {
1453
- /**
1454
- * The response body as text (string format)
1455
- */
1456
- bodyAsText: string;
1457
- /**
1458
- * The response body as parsed JSON or XML
1459
- */
1460
- parsedBody: SharedPrivateLinkResourceListResult;
1461
- };
1462
- };
1463
- /**
1464
- * Contains response data for the beginCreateOrUpdate operation.
1465
- */
1466
- export declare type SharedPrivateLinkResourcesBeginCreateOrUpdateResponse = SharedPrivateLinkResource & {
1467
- /**
1468
- * The underlying HTTP response.
1469
- */
1470
- _response: msRest.HttpResponse & {
1471
- /**
1472
- * The response body as text (string format)
1473
- */
1474
- bodyAsText: string;
1475
- /**
1476
- * The response body as parsed JSON or XML
1477
- */
1478
- parsedBody: SharedPrivateLinkResource;
1479
- };
1480
- };
1481
- /**
1482
- * Contains response data for the listByServiceNext operation.
1483
- */
1484
- export declare type SharedPrivateLinkResourcesListByServiceNextResponse = SharedPrivateLinkResourceListResult & {
1485
- /**
1486
- * The underlying HTTP response.
1487
- */
1488
- _response: msRest.HttpResponse & {
1489
- /**
1490
- * The response body as text (string format)
1491
- */
1492
- bodyAsText: string;
1493
- /**
1494
- * The response body as parsed JSON or XML
1495
- */
1496
- parsedBody: SharedPrivateLinkResourceListResult;
1497
- };
1498
- };
1499
- //# sourceMappingURL=index.d.ts.map