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