@azure/arm-search 3.2.0 → 3.3.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 +53 -0
- package/LICENSE +1 -1
- package/README.md +2 -2
- package/dist/index.js +1805 -777
- package/dist/index.js.map +1 -1
- package/dist/index.min.js +1 -1
- package/dist/index.min.js.map +1 -1
- package/dist-esm/samples-dev/adminKeysGetSample.js +3 -3
- package/dist-esm/samples-dev/adminKeysRegenerateSample.js +1 -1
- package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsGetSample.d.ts +2 -0
- package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsGetSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsGetSample.js +39 -0
- package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsGetSample.js.map +1 -0
- package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsListByServiceSample.d.ts +2 -0
- package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsListByServiceSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsListByServiceSample.js +54 -0
- package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsListByServiceSample.js.map +1 -0
- package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsReconcileSample.d.ts +2 -0
- package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsReconcileSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsReconcileSample.js +39 -0
- package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsReconcileSample.js.map +1 -0
- package/dist-esm/samples-dev/operationsListSample.js +3 -3
- package/dist-esm/samples-dev/operationsListSample.js.map +1 -1
- package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.js +1 -1
- package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.js +1 -1
- package/dist-esm/samples-dev/privateEndpointConnectionsListByServiceSample.js +1 -1
- package/dist-esm/samples-dev/privateEndpointConnectionsListByServiceSample.js.map +1 -1
- package/dist-esm/samples-dev/privateEndpointConnectionsUpdateSample.js +8 -8
- package/dist-esm/samples-dev/privateEndpointConnectionsUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/privateLinkResourcesListSupportedSample.js +1 -1
- package/dist-esm/samples-dev/privateLinkResourcesListSupportedSample.js.map +1 -1
- package/dist-esm/samples-dev/queryKeysCreateSample.js +2 -2
- package/dist-esm/samples-dev/queryKeysCreateSample.js.map +1 -1
- package/dist-esm/samples-dev/queryKeysDeleteSample.js +1 -1
- package/dist-esm/samples-dev/queryKeysListBySearchServiceSample.js +3 -3
- package/dist-esm/samples-dev/queryKeysListBySearchServiceSample.js.map +1 -1
- package/dist-esm/samples-dev/servicesCheckNameAvailabilitySample.js +1 -1
- package/dist-esm/samples-dev/servicesCreateOrUpdateSample.js +81 -19
- package/dist-esm/samples-dev/servicesCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/servicesDeleteSample.js +1 -1
- package/dist-esm/samples-dev/servicesGetSample.js +1 -1
- package/dist-esm/samples-dev/servicesListByResourceGroupSample.js +1 -1
- package/dist-esm/samples-dev/servicesListByResourceGroupSample.js.map +1 -1
- package/dist-esm/samples-dev/servicesListBySubscriptionSample.js +1 -1
- package/dist-esm/samples-dev/servicesListBySubscriptionSample.js.map +1 -1
- package/dist-esm/samples-dev/servicesUpdateSample.js +68 -18
- package/dist-esm/samples-dev/servicesUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/sharedPrivateLinkResourcesCreateOrUpdateSample.js +4 -4
- package/dist-esm/samples-dev/sharedPrivateLinkResourcesCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/sharedPrivateLinkResourcesDeleteSample.js +1 -1
- package/dist-esm/samples-dev/sharedPrivateLinkResourcesGetSample.js +1 -1
- package/dist-esm/samples-dev/sharedPrivateLinkResourcesListByServiceSample.js +1 -1
- package/dist-esm/samples-dev/sharedPrivateLinkResourcesListByServiceSample.js.map +1 -1
- package/dist-esm/samples-dev/usageBySubscriptionSkuSample.js +1 -1
- package/dist-esm/samples-dev/usagesListBySubscriptionSample.js +3 -3
- package/dist-esm/samples-dev/usagesListBySubscriptionSample.js.map +1 -1
- package/dist-esm/src/lroImpl.js +1 -1
- package/dist-esm/src/models/index.d.ts +508 -113
- package/dist-esm/src/models/index.d.ts.map +1 -1
- package/dist-esm/src/models/index.js +90 -12
- package/dist-esm/src/models/index.js.map +1 -1
- package/dist-esm/src/models/mappers.d.ts +19 -0
- package/dist-esm/src/models/mappers.d.ts.map +1 -1
- package/dist-esm/src/models/mappers.js +1028 -411
- package/dist-esm/src/models/mappers.js.map +1 -1
- package/dist-esm/src/models/parameters.d.ts +2 -0
- package/dist-esm/src/models/parameters.d.ts.map +1 -1
- package/dist-esm/src/models/parameters.js +85 -57
- package/dist-esm/src/models/parameters.js.map +1 -1
- package/dist-esm/src/operations/adminKeys.d.ts +5 -5
- package/dist-esm/src/operations/adminKeys.js +15 -15
- package/dist-esm/src/operations/adminKeys.js.map +1 -1
- package/dist-esm/src/operations/index.d.ts +1 -0
- package/dist-esm/src/operations/index.d.ts.map +1 -1
- package/dist-esm/src/operations/index.js +1 -0
- package/dist-esm/src/operations/index.js.map +1 -1
- package/dist-esm/src/operations/networkSecurityPerimeterConfigurations.d.ts +79 -0
- package/dist-esm/src/operations/networkSecurityPerimeterConfigurations.d.ts.map +1 -0
- package/dist-esm/src/operations/networkSecurityPerimeterConfigurations.js +289 -0
- package/dist-esm/src/operations/networkSecurityPerimeterConfigurations.js.map +1 -0
- package/dist-esm/src/operations/operations.js +5 -5
- package/dist-esm/src/operations/operations.js.map +1 -1
- package/dist-esm/src/operations/privateEndpointConnections.d.ts +19 -19
- package/dist-esm/src/operations/privateEndpointConnections.d.ts.map +1 -1
- package/dist-esm/src/operations/privateEndpointConnections.js +49 -49
- package/dist-esm/src/operations/privateEndpointConnections.js.map +1 -1
- package/dist-esm/src/operations/privateLinkResources.d.ts +4 -4
- package/dist-esm/src/operations/privateLinkResources.js +10 -10
- package/dist-esm/src/operations/privateLinkResources.js.map +1 -1
- package/dist-esm/src/operations/queryKeys.d.ts +12 -12
- package/dist-esm/src/operations/queryKeys.js +32 -32
- package/dist-esm/src/operations/queryKeys.js.map +1 -1
- package/dist-esm/src/operations/services.d.ts +17 -17
- package/dist-esm/src/operations/services.d.ts.map +1 -1
- package/dist-esm/src/operations/services.js +75 -75
- package/dist-esm/src/operations/services.js.map +1 -1
- package/dist-esm/src/operations/sharedPrivateLinkResources.d.ts +21 -21
- package/dist-esm/src/operations/sharedPrivateLinkResources.d.ts.map +1 -1
- package/dist-esm/src/operations/sharedPrivateLinkResources.js +62 -62
- package/dist-esm/src/operations/sharedPrivateLinkResources.js.map +1 -1
- package/dist-esm/src/operations/usages.d.ts +2 -2
- package/dist-esm/src/operations/usages.js +13 -13
- package/dist-esm/src/operations/usages.js.map +1 -1
- package/dist-esm/src/operationsInterfaces/adminKeys.d.ts +5 -5
- package/dist-esm/src/operationsInterfaces/index.d.ts +1 -0
- package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -1
- package/dist-esm/src/operationsInterfaces/index.js +1 -0
- package/dist-esm/src/operationsInterfaces/index.js.map +1 -1
- package/dist-esm/src/operationsInterfaces/networkSecurityPerimeterConfigurations.d.ts +50 -0
- package/dist-esm/src/operationsInterfaces/networkSecurityPerimeterConfigurations.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/networkSecurityPerimeterConfigurations.js +9 -0
- package/dist-esm/src/operationsInterfaces/networkSecurityPerimeterConfigurations.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts +15 -15
- package/dist-esm/src/operationsInterfaces/privateLinkResources.d.ts +2 -2
- package/dist-esm/src/operationsInterfaces/queryKeys.d.ts +7 -7
- package/dist-esm/src/operationsInterfaces/services.d.ts +17 -17
- package/dist-esm/src/operationsInterfaces/sharedPrivateLinkResources.d.ts +17 -17
- package/dist-esm/src/operationsInterfaces/usages.d.ts +1 -1
- package/dist-esm/src/pagingHelper.js.map +1 -1
- package/dist-esm/src/searchManagementClient.d.ts +3 -2
- package/dist-esm/src/searchManagementClient.d.ts.map +1 -1
- package/dist-esm/src/searchManagementClient.js +17 -15
- package/dist-esm/src/searchManagementClient.js.map +1 -1
- package/dist-esm/test/search_examples.js.map +1 -1
- package/package.json +12 -11
- package/review/arm-search.api.md +270 -6
- package/src/lroImpl.ts +3 -3
- package/src/models/index.ts +573 -140
- package/src/models/mappers.ts +1217 -561
- package/src/models/parameters.ts +90 -58
- package/src/operations/adminKeys.ts +22 -24
- package/src/operations/index.ts +1 -0
- package/src/operations/networkSecurityPerimeterConfigurations.ts +400 -0
- package/src/operations/operations.ts +10 -10
- package/src/operations/privateEndpointConnections.ts +74 -77
- package/src/operations/privateLinkResources.ts +21 -22
- package/src/operations/queryKeys.ts +52 -55
- package/src/operations/services.ts +118 -126
- package/src/operations/sharedPrivateLinkResources.ts +103 -108
- package/src/operations/usages.ts +24 -25
- package/src/operationsInterfaces/adminKeys.ts +8 -8
- package/src/operationsInterfaces/index.ts +1 -0
- package/src/operationsInterfaces/networkSecurityPerimeterConfigurations.ts +90 -0
- package/src/operationsInterfaces/operations.ts +1 -1
- package/src/operationsInterfaces/privateEndpointConnections.ts +20 -20
- package/src/operationsInterfaces/privateLinkResources.ts +4 -4
- package/src/operationsInterfaces/queryKeys.ts +11 -11
- package/src/operationsInterfaces/services.ts +26 -26
- package/src/operationsInterfaces/sharedPrivateLinkResources.ts +24 -24
- package/src/operationsInterfaces/usages.ts +3 -3
- package/src/pagingHelper.ts +1 -1
- package/src/searchManagementClient.ts +33 -28
- package/types/arm-search.d.ts +650 -171
- package/types/tsdoc-metadata.json +1 -1
package/src/models/index.ts
CHANGED
|
@@ -8,10 +8,10 @@
|
|
|
8
8
|
|
|
9
9
|
import * as coreClient from "@azure/core-client";
|
|
10
10
|
|
|
11
|
-
/** The result of the request to list REST API operations. It contains a list of operations and a URL
|
|
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
12
|
export interface OperationListResult {
|
|
13
13
|
/**
|
|
14
|
-
* The list of operations supported by the resource provider.
|
|
14
|
+
* The list of operations by Azure AI Search, some supported by the resource provider and others by data plane APIs.
|
|
15
15
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
16
16
|
*/
|
|
17
17
|
readonly value?: Operation[];
|
|
@@ -34,6 +34,21 @@ export interface Operation {
|
|
|
34
34
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
35
35
|
*/
|
|
36
36
|
readonly display?: OperationDisplay;
|
|
37
|
+
/**
|
|
38
|
+
* Describes if the specified operation is a data plane API operation. Operations where this value is not true are supported directly by the resource provider.
|
|
39
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
40
|
+
*/
|
|
41
|
+
readonly isDataAction?: boolean;
|
|
42
|
+
/**
|
|
43
|
+
* Describes which originating entities are allowed to invoke this operation.
|
|
44
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
45
|
+
*/
|
|
46
|
+
readonly origin?: string;
|
|
47
|
+
/**
|
|
48
|
+
* Describes additional properties for this operation.
|
|
49
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
50
|
+
*/
|
|
51
|
+
readonly properties?: OperationProperties;
|
|
37
52
|
}
|
|
38
53
|
|
|
39
54
|
/** The object that describes the operation. */
|
|
@@ -60,10 +75,121 @@ export interface OperationDisplay {
|
|
|
60
75
|
readonly description?: string;
|
|
61
76
|
}
|
|
62
77
|
|
|
78
|
+
/** Describes additional properties for this operation. */
|
|
79
|
+
export interface OperationProperties {
|
|
80
|
+
/**
|
|
81
|
+
* Specifications of the service for this operation.
|
|
82
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
83
|
+
*/
|
|
84
|
+
readonly serviceSpecification?: OperationServiceSpecification;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
/** Specifications of the service for this operation. */
|
|
88
|
+
export interface OperationServiceSpecification {
|
|
89
|
+
/**
|
|
90
|
+
* Specifications of metrics for this operation.
|
|
91
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
92
|
+
*/
|
|
93
|
+
readonly metricSpecifications?: OperationMetricsSpecification[];
|
|
94
|
+
/**
|
|
95
|
+
* Specifications of logs for this operation.
|
|
96
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
97
|
+
*/
|
|
98
|
+
readonly logSpecifications?: OperationLogsSpecification[];
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
/** Specifications of one type of metric for this operation. */
|
|
102
|
+
export interface OperationMetricsSpecification {
|
|
103
|
+
/**
|
|
104
|
+
* The name of the metric specification.
|
|
105
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
106
|
+
*/
|
|
107
|
+
readonly name?: string;
|
|
108
|
+
/**
|
|
109
|
+
* The display name of the metric specification.
|
|
110
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
111
|
+
*/
|
|
112
|
+
readonly displayName?: string;
|
|
113
|
+
/**
|
|
114
|
+
* The display description of the metric specification.
|
|
115
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
116
|
+
*/
|
|
117
|
+
readonly displayDescription?: string;
|
|
118
|
+
/**
|
|
119
|
+
* The unit for the metric specification.
|
|
120
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
121
|
+
*/
|
|
122
|
+
readonly unit?: string;
|
|
123
|
+
/**
|
|
124
|
+
* The type of aggregation for the metric specification.
|
|
125
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
126
|
+
*/
|
|
127
|
+
readonly aggregationType?: string;
|
|
128
|
+
/**
|
|
129
|
+
* Dimensions for the metric specification.
|
|
130
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
131
|
+
*/
|
|
132
|
+
readonly dimensions?: OperationMetricDimension[];
|
|
133
|
+
/**
|
|
134
|
+
* Availabilities for the metric specification.
|
|
135
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
136
|
+
*/
|
|
137
|
+
readonly availabilities?: OperationAvailability[];
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
/** Describes a particular dimension for the metric specification. */
|
|
141
|
+
export interface OperationMetricDimension {
|
|
142
|
+
/**
|
|
143
|
+
* The name of the dimension.
|
|
144
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
145
|
+
*/
|
|
146
|
+
readonly name?: string;
|
|
147
|
+
/**
|
|
148
|
+
* The display name of the dimension.
|
|
149
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
150
|
+
*/
|
|
151
|
+
readonly displayName?: string;
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
/** Describes a particular availability for the metric specification. */
|
|
155
|
+
export interface OperationAvailability {
|
|
156
|
+
/**
|
|
157
|
+
* The time grain for the dimension.
|
|
158
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
159
|
+
*/
|
|
160
|
+
readonly timeGrain?: string;
|
|
161
|
+
/**
|
|
162
|
+
* The blob duration for the dimension.
|
|
163
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
164
|
+
*/
|
|
165
|
+
readonly blobDuration?: string;
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
/** Specifications of one type of log for this operation. */
|
|
169
|
+
export interface OperationLogsSpecification {
|
|
170
|
+
/**
|
|
171
|
+
* The name of the log specification.
|
|
172
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
173
|
+
*/
|
|
174
|
+
readonly name?: string;
|
|
175
|
+
/**
|
|
176
|
+
* The display name of the log specification.
|
|
177
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
178
|
+
*/
|
|
179
|
+
readonly displayName?: string;
|
|
180
|
+
/**
|
|
181
|
+
* The blob duration for the log specification.
|
|
182
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
183
|
+
*/
|
|
184
|
+
readonly blobDuration?: string;
|
|
185
|
+
}
|
|
186
|
+
|
|
63
187
|
/** Contains information about an API error. */
|
|
64
188
|
export interface CloudError {
|
|
65
189
|
/** Describes a particular API error with an error code and a message. */
|
|
66
190
|
error?: CloudErrorBody;
|
|
191
|
+
/** A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). */
|
|
192
|
+
message?: string;
|
|
67
193
|
}
|
|
68
194
|
|
|
69
195
|
/** Describes a particular API error with an error code and a message. */
|
|
@@ -78,7 +204,7 @@ export interface CloudErrorBody {
|
|
|
78
204
|
details?: CloudErrorBody[];
|
|
79
205
|
}
|
|
80
206
|
|
|
81
|
-
/** Response containing the primary and secondary admin API keys for a given Azure
|
|
207
|
+
/** Response containing the primary and secondary admin API keys for a given Azure AI Search service. */
|
|
82
208
|
export interface AdminKeyResult {
|
|
83
209
|
/**
|
|
84
210
|
* The primary admin API key of the search service.
|
|
@@ -92,10 +218,10 @@ export interface AdminKeyResult {
|
|
|
92
218
|
readonly secondaryKey?: string;
|
|
93
219
|
}
|
|
94
220
|
|
|
95
|
-
/** Describes an API key for a given Azure
|
|
221
|
+
/** Describes an API key for a given Azure AI Search service that conveys read-only permissions on the docs collection of an index. */
|
|
96
222
|
export interface QueryKey {
|
|
97
223
|
/**
|
|
98
|
-
* The name of the query API key
|
|
224
|
+
* The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used.
|
|
99
225
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
100
226
|
*/
|
|
101
227
|
readonly name?: string;
|
|
@@ -106,10 +232,10 @@ export interface QueryKey {
|
|
|
106
232
|
readonly key?: string;
|
|
107
233
|
}
|
|
108
234
|
|
|
109
|
-
/** Response containing the query API keys for a given Azure
|
|
235
|
+
/** Response containing the query API keys for a given Azure AI Search service. */
|
|
110
236
|
export interface ListQueryKeysResult {
|
|
111
237
|
/**
|
|
112
|
-
* The query keys for the Azure
|
|
238
|
+
* The query keys for the Azure AI Search service.
|
|
113
239
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
114
240
|
*/
|
|
115
241
|
readonly value?: QueryKey[];
|
|
@@ -120,64 +246,66 @@ export interface ListQueryKeysResult {
|
|
|
120
246
|
readonly nextLink?: string;
|
|
121
247
|
}
|
|
122
248
|
|
|
123
|
-
/** Network specific rules that determine how the Azure
|
|
249
|
+
/** Network specific rules that determine how the Azure AI Search service may be reached. */
|
|
124
250
|
export interface NetworkRuleSet {
|
|
125
251
|
/** 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
252
|
ipRules?: IpRule[];
|
|
253
|
+
/** Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. */
|
|
254
|
+
bypass?: SearchBypass;
|
|
127
255
|
}
|
|
128
256
|
|
|
129
|
-
/** The IP restriction rule of the Azure
|
|
257
|
+
/** The IP restriction rule of the Azure AI Search service. */
|
|
130
258
|
export interface IpRule {
|
|
131
259
|
/** 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
260
|
value?: string;
|
|
133
261
|
}
|
|
134
262
|
|
|
135
|
-
/** Describes a policy that determines how resources within the search service are to be encrypted with
|
|
263
|
+
/** Describes a policy that determines how resources within the search service are to be encrypted with customer managed keys. */
|
|
136
264
|
export interface EncryptionWithCmk {
|
|
137
|
-
/** Describes how a search service should enforce
|
|
265
|
+
/** Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. */
|
|
138
266
|
enforcement?: SearchEncryptionWithCmk;
|
|
139
267
|
/**
|
|
140
|
-
*
|
|
268
|
+
* Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.
|
|
141
269
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
142
270
|
*/
|
|
143
271
|
readonly encryptionComplianceStatus?: SearchEncryptionComplianceStatus;
|
|
144
272
|
}
|
|
145
273
|
|
|
146
|
-
/** Defines the options for how the
|
|
274
|
+
/** Defines the options for how the search service authenticates a data plane request. This cannot be set if 'disableLocalAuth' is set to true. */
|
|
147
275
|
export interface DataPlaneAuthOptions {
|
|
148
|
-
/** Indicates that only the API key
|
|
276
|
+
/** Indicates that only the API key can be used for authentication. */
|
|
149
277
|
apiKeyOnly?: Record<string, unknown>;
|
|
150
|
-
/** Indicates that either the API key or an access token from
|
|
278
|
+
/** Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. */
|
|
151
279
|
aadOrApiKey?: DataPlaneAadOrApiKeyAuthOption;
|
|
152
280
|
}
|
|
153
281
|
|
|
154
|
-
/** Indicates that either the API key or an access token from
|
|
282
|
+
/** Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. */
|
|
155
283
|
export interface DataPlaneAadOrApiKeyAuthOption {
|
|
156
|
-
/** Describes what response the data plane API of a
|
|
284
|
+
/** Describes what response the data plane API of a search service would send for requests that failed authentication. */
|
|
157
285
|
aadAuthFailureMode?: AadAuthFailureMode;
|
|
158
286
|
}
|
|
159
287
|
|
|
160
|
-
/** Describes the properties of an existing
|
|
288
|
+
/** Describes the properties of an existing private endpoint connection to the search service. */
|
|
161
289
|
export interface PrivateEndpointConnectionProperties {
|
|
162
290
|
/** The private endpoint resource from Microsoft.Network provider. */
|
|
163
291
|
privateEndpoint?: PrivateEndpointConnectionPropertiesPrivateEndpoint;
|
|
164
|
-
/** Describes the current state of an existing Private Link
|
|
292
|
+
/** Describes the current state of an existing Azure Private Link service connection to the private endpoint. */
|
|
165
293
|
privateLinkServiceConnectionState?: PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState;
|
|
166
|
-
/** The group
|
|
294
|
+
/** The group ID of the Azure resource for which the private link service is for. */
|
|
167
295
|
groupId?: string;
|
|
168
|
-
/** The provisioning state of the private link service connection.
|
|
296
|
+
/** The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. */
|
|
169
297
|
provisioningState?: PrivateLinkServiceConnectionProvisioningState;
|
|
170
298
|
}
|
|
171
299
|
|
|
172
300
|
/** The private endpoint resource from Microsoft.Network provider. */
|
|
173
301
|
export interface PrivateEndpointConnectionPropertiesPrivateEndpoint {
|
|
174
|
-
/** The resource
|
|
302
|
+
/** The resource ID of the private endpoint resource from Microsoft.Network provider. */
|
|
175
303
|
id?: string;
|
|
176
304
|
}
|
|
177
305
|
|
|
178
|
-
/** Describes the current state of an existing Private Link
|
|
306
|
+
/** Describes the current state of an existing Azure Private Link service connection to the private endpoint. */
|
|
179
307
|
export interface PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState {
|
|
180
|
-
/** Status of the the private link service connection.
|
|
308
|
+
/** Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. */
|
|
181
309
|
status?: PrivateLinkServiceConnectionStatus;
|
|
182
310
|
/** The description for the private link service connection state. */
|
|
183
311
|
description?: string;
|
|
@@ -204,29 +332,29 @@ export interface Resource {
|
|
|
204
332
|
readonly type?: string;
|
|
205
333
|
}
|
|
206
334
|
|
|
207
|
-
/** Describes the properties of an existing
|
|
335
|
+
/** Describes the properties of an existing shared private link resource managed by the Azure AI Search service. */
|
|
208
336
|
export interface SharedPrivateLinkResourceProperties {
|
|
209
|
-
/** The resource
|
|
337
|
+
/** The resource ID of the resource the shared private link resource is for. */
|
|
210
338
|
privateLinkResourceId?: string;
|
|
211
|
-
/** The group
|
|
339
|
+
/** The group ID from the provider of resource the shared private link resource is for. */
|
|
212
340
|
groupId?: string;
|
|
213
|
-
/** The
|
|
341
|
+
/** The message for requesting approval of the shared private link resource. */
|
|
214
342
|
requestMessage?: string;
|
|
215
|
-
/** Optional. Can be used to specify the Azure Resource Manager location of the resource
|
|
343
|
+
/** Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service). */
|
|
216
344
|
resourceRegion?: string;
|
|
217
|
-
/** Status of the shared private link resource.
|
|
345
|
+
/** Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. */
|
|
218
346
|
status?: SharedPrivateLinkResourceStatus;
|
|
219
|
-
/** The provisioning state of the shared private link resource.
|
|
347
|
+
/** The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. */
|
|
220
348
|
provisioningState?: SharedPrivateLinkResourceProvisioningState;
|
|
221
349
|
}
|
|
222
350
|
|
|
223
|
-
/** Defines the SKU of
|
|
351
|
+
/** Defines the SKU of a search service, which determines billing rate and capacity limits. */
|
|
224
352
|
export interface Sku {
|
|
225
353
|
/** 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.' */
|
|
226
354
|
name?: SkuName;
|
|
227
355
|
}
|
|
228
356
|
|
|
229
|
-
/**
|
|
357
|
+
/** Details about the search service identity. A null value indicates that the search service has no identity assigned. */
|
|
230
358
|
export interface Identity {
|
|
231
359
|
/**
|
|
232
360
|
* The principal ID of the system-assigned identity of the search service.
|
|
@@ -238,14 +366,32 @@ export interface Identity {
|
|
|
238
366
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
239
367
|
*/
|
|
240
368
|
readonly tenantId?: string;
|
|
241
|
-
/** The identity type. */
|
|
369
|
+
/** The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service. */
|
|
242
370
|
type: IdentityType;
|
|
371
|
+
/** The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */
|
|
372
|
+
userAssignedIdentities?: {
|
|
373
|
+
[propertyName: string]: UserAssignedManagedIdentity;
|
|
374
|
+
};
|
|
375
|
+
}
|
|
376
|
+
|
|
377
|
+
/** The details of the user assigned managed identity assigned to the search service. */
|
|
378
|
+
export interface UserAssignedManagedIdentity {
|
|
379
|
+
/**
|
|
380
|
+
* The principal ID of user assigned identity.
|
|
381
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
382
|
+
*/
|
|
383
|
+
readonly principalId?: string;
|
|
384
|
+
/**
|
|
385
|
+
* The client ID of user assigned identity.
|
|
386
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
387
|
+
*/
|
|
388
|
+
readonly clientId?: string;
|
|
243
389
|
}
|
|
244
390
|
|
|
245
|
-
/** Response containing a list of Azure
|
|
391
|
+
/** Response containing a list of Azure AI Search services. */
|
|
246
392
|
export interface SearchServiceListResult {
|
|
247
393
|
/**
|
|
248
|
-
* The list of
|
|
394
|
+
* The list of search services.
|
|
249
395
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
250
396
|
*/
|
|
251
397
|
readonly value?: SearchService[];
|
|
@@ -265,7 +411,7 @@ export interface PrivateLinkResourcesResult {
|
|
|
265
411
|
readonly value?: PrivateLinkResource[];
|
|
266
412
|
}
|
|
267
413
|
|
|
268
|
-
/** Describes the properties of a supported private link resource for the Azure
|
|
414
|
+
/** Describes the properties of a supported private link resource for the Azure AI Search service. For a given API version, this represents the 'supported' groupIds when creating a shared private link resource. */
|
|
269
415
|
export interface PrivateLinkResourceProperties {
|
|
270
416
|
/**
|
|
271
417
|
* The group ID of the private link resource.
|
|
@@ -283,49 +429,49 @@ export interface PrivateLinkResourceProperties {
|
|
|
283
429
|
*/
|
|
284
430
|
readonly requiredZoneNames?: string[];
|
|
285
431
|
/**
|
|
286
|
-
* The list of resources that are onboarded to private link service, that are supported by Azure
|
|
432
|
+
* The list of resources that are onboarded to private link service, that are supported by Azure AI Search.
|
|
287
433
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
288
434
|
*/
|
|
289
435
|
readonly shareablePrivateLinkResourceTypes?: ShareablePrivateLinkResourceType[];
|
|
290
436
|
}
|
|
291
437
|
|
|
292
|
-
/** Describes an resource type that has been onboarded to private link service, supported by Azure
|
|
438
|
+
/** Describes an resource type that has been onboarded to private link service, supported by Azure AI Search. */
|
|
293
439
|
export interface ShareablePrivateLinkResourceType {
|
|
294
440
|
/**
|
|
295
|
-
* The name of the resource type that has been onboarded to private link service, supported by Azure
|
|
441
|
+
* The name of the resource type that has been onboarded to private link service, supported by Azure AI Search.
|
|
296
442
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
297
443
|
*/
|
|
298
444
|
readonly name?: string;
|
|
299
445
|
/**
|
|
300
|
-
* Describes the properties of a resource type that has been onboarded to private link service, supported by Azure
|
|
446
|
+
* Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search.
|
|
301
447
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
302
448
|
*/
|
|
303
449
|
readonly properties?: ShareablePrivateLinkResourceProperties;
|
|
304
450
|
}
|
|
305
451
|
|
|
306
|
-
/** Describes the properties of a resource type that has been onboarded to private link service, supported by Azure
|
|
452
|
+
/** Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search. */
|
|
307
453
|
export interface ShareablePrivateLinkResourceProperties {
|
|
308
454
|
/**
|
|
309
|
-
* The resource provider type for the resource that has been onboarded to private link service, supported by Azure
|
|
455
|
+
* The resource provider type for the resource that has been onboarded to private link service, supported by Azure AI Search.
|
|
310
456
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
311
457
|
*/
|
|
312
458
|
readonly type?: string;
|
|
313
459
|
/**
|
|
314
|
-
* The resource provider group id for the resource that has been onboarded to private link service, supported by Azure
|
|
460
|
+
* The resource provider group id for the resource that has been onboarded to private link service, supported by Azure AI Search.
|
|
315
461
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
316
462
|
*/
|
|
317
463
|
readonly groupId?: string;
|
|
318
464
|
/**
|
|
319
|
-
* The description of the resource type that has been onboarded to private link service, supported by Azure
|
|
465
|
+
* The description of the resource type that has been onboarded to private link service, supported by Azure AI Search.
|
|
320
466
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
321
467
|
*/
|
|
322
468
|
readonly description?: string;
|
|
323
469
|
}
|
|
324
470
|
|
|
325
|
-
/** Response containing a list of
|
|
471
|
+
/** Response containing a list of private endpoint connections. */
|
|
326
472
|
export interface PrivateEndpointConnectionListResult {
|
|
327
473
|
/**
|
|
328
|
-
* The list of
|
|
474
|
+
* The list of private endpoint connections.
|
|
329
475
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
330
476
|
*/
|
|
331
477
|
readonly value?: PrivateEndpointConnection[];
|
|
@@ -336,10 +482,10 @@ export interface PrivateEndpointConnectionListResult {
|
|
|
336
482
|
readonly nextLink?: string;
|
|
337
483
|
}
|
|
338
484
|
|
|
339
|
-
/** Response containing a list of
|
|
485
|
+
/** Response containing a list of shared private link resources. */
|
|
340
486
|
export interface SharedPrivateLinkResourceListResult {
|
|
341
487
|
/**
|
|
342
|
-
* The list of
|
|
488
|
+
* The list of shared private link resources.
|
|
343
489
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
344
490
|
*/
|
|
345
491
|
readonly value?: SharedPrivateLinkResource[];
|
|
@@ -374,10 +520,10 @@ export interface CheckNameAvailabilityOutput {
|
|
|
374
520
|
readonly message?: string;
|
|
375
521
|
}
|
|
376
522
|
|
|
377
|
-
/** Response containing the quota usage information for all the supported
|
|
523
|
+
/** Response containing the quota usage information for all the supported SKUs of Azure AI Search. */
|
|
378
524
|
export interface QuotaUsagesListResult {
|
|
379
525
|
/**
|
|
380
|
-
* The quota usages for the SKUs supported by Azure
|
|
526
|
+
* The quota usages for the SKUs supported by Azure AI Search.
|
|
381
527
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
382
528
|
*/
|
|
383
529
|
readonly value?: QuotaUsageResult[];
|
|
@@ -388,46 +534,119 @@ export interface QuotaUsagesListResult {
|
|
|
388
534
|
readonly nextLink?: string;
|
|
389
535
|
}
|
|
390
536
|
|
|
391
|
-
/** Describes the quota usage for a particular
|
|
537
|
+
/** Describes the quota usage for a particular SKU. */
|
|
392
538
|
export interface QuotaUsageResult {
|
|
393
|
-
/** The resource
|
|
539
|
+
/** The resource ID of the quota usage SKU endpoint for Microsoft.Search provider. */
|
|
394
540
|
id?: string;
|
|
395
|
-
/** The unit of measurement for the search
|
|
541
|
+
/** The unit of measurement for the search SKU. */
|
|
396
542
|
unit?: string;
|
|
397
|
-
/** The currently used up value for the particular search
|
|
543
|
+
/** The currently used up value for the particular search SKU. */
|
|
398
544
|
currentValue?: number;
|
|
399
|
-
/** The quota limit for the particular search
|
|
545
|
+
/** The quota limit for the particular search SKU. */
|
|
400
546
|
limit?: number;
|
|
401
547
|
/**
|
|
402
|
-
* The name of the
|
|
548
|
+
* The name of the SKU supported by Azure AI Search.
|
|
403
549
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
404
550
|
*/
|
|
405
551
|
readonly name?: QuotaUsageResultName;
|
|
406
552
|
}
|
|
407
553
|
|
|
408
|
-
/** The name of the
|
|
554
|
+
/** The name of the SKU supported by Azure AI Search. */
|
|
409
555
|
export interface QuotaUsageResultName {
|
|
410
|
-
/** The
|
|
556
|
+
/** The SKU name supported by Azure AI Search. */
|
|
411
557
|
value?: string;
|
|
412
|
-
/** The localized string value for the
|
|
558
|
+
/** The localized string value for the SKU name. */
|
|
413
559
|
localizedValue?: string;
|
|
414
560
|
}
|
|
415
561
|
|
|
416
|
-
/**
|
|
562
|
+
/** A list of network security perimeter configurations for a server. */
|
|
563
|
+
export interface NetworkSecurityPerimeterConfigurationListResult {
|
|
564
|
+
/**
|
|
565
|
+
* Array of results.
|
|
566
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
567
|
+
*/
|
|
568
|
+
readonly value?: NetworkSecurityPerimeterConfiguration[];
|
|
569
|
+
/**
|
|
570
|
+
* Link to retrieve next page of results.
|
|
571
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
572
|
+
*/
|
|
573
|
+
readonly nextLink?: string;
|
|
574
|
+
}
|
|
575
|
+
|
|
576
|
+
/** The perimeter for a network security perimeter configuration. */
|
|
577
|
+
export interface NSPConfigPerimeter {
|
|
578
|
+
id?: string;
|
|
579
|
+
perimeterGuid?: string;
|
|
580
|
+
location?: string;
|
|
581
|
+
}
|
|
582
|
+
|
|
583
|
+
/** The resource association for the network security perimeter. */
|
|
584
|
+
export interface NSPConfigAssociation {
|
|
585
|
+
name?: string;
|
|
586
|
+
accessMode?: string;
|
|
587
|
+
}
|
|
588
|
+
|
|
589
|
+
/** The profile for a network security perimeter configuration. */
|
|
590
|
+
export interface NSPConfigProfile {
|
|
591
|
+
name?: string;
|
|
592
|
+
accessRulesVersion?: string;
|
|
593
|
+
accessRules?: NSPConfigAccessRule[];
|
|
594
|
+
}
|
|
595
|
+
|
|
596
|
+
/** An access rule for a network security perimeter configuration. */
|
|
597
|
+
export interface NSPConfigAccessRule {
|
|
598
|
+
name?: string;
|
|
599
|
+
/** The properties for the access rules in a network security perimeter configuration. */
|
|
600
|
+
properties?: NSPConfigAccessRuleProperties;
|
|
601
|
+
}
|
|
602
|
+
|
|
603
|
+
/** The properties for the access rules in a network security perimeter configuration. */
|
|
604
|
+
export interface NSPConfigAccessRuleProperties {
|
|
605
|
+
direction?: string;
|
|
606
|
+
addressPrefixes?: string[];
|
|
607
|
+
fullyQualifiedDomainNames?: string[];
|
|
608
|
+
subscriptions?: string[];
|
|
609
|
+
networkSecurityPerimeters?: NSPConfigNetworkSecurityPerimeterRule[];
|
|
610
|
+
}
|
|
611
|
+
|
|
612
|
+
/** The network security perimeter properties present in a configuration rule. */
|
|
613
|
+
export interface NSPConfigNetworkSecurityPerimeterRule {
|
|
614
|
+
id?: string;
|
|
615
|
+
perimeterGuid?: string;
|
|
616
|
+
location?: string;
|
|
617
|
+
}
|
|
618
|
+
|
|
619
|
+
/** An object to describe any issues with provisioning network security perimeters to a search service. */
|
|
620
|
+
export interface NSPProvisioningIssue {
|
|
621
|
+
name?: string;
|
|
622
|
+
/** The properties to describe any issues with provisioning network security perimeters to a search service. */
|
|
623
|
+
properties?: NSPProvisioningIssueProperties;
|
|
624
|
+
}
|
|
625
|
+
|
|
626
|
+
/** The properties to describe any issues with provisioning network security perimeters to a search service. */
|
|
627
|
+
export interface NSPProvisioningIssueProperties {
|
|
628
|
+
issueType?: string;
|
|
629
|
+
severity?: string;
|
|
630
|
+
description?: string;
|
|
631
|
+
suggestedResourceIds?: string[];
|
|
632
|
+
suggestedAccessRules?: string[];
|
|
633
|
+
}
|
|
634
|
+
|
|
635
|
+
/** The details of a long running asynchronous shared private link resource operation. */
|
|
417
636
|
export interface AsyncOperationResult {
|
|
418
637
|
/** The current status of the long running asynchronous shared private link resource operation. */
|
|
419
638
|
status?: SharedPrivateLinkResourceAsyncOperationResult;
|
|
420
639
|
}
|
|
421
640
|
|
|
422
|
-
/** Describes an existing
|
|
641
|
+
/** Describes an existing private endpoint connection to the Azure AI Search service. */
|
|
423
642
|
export interface PrivateEndpointConnection extends Resource {
|
|
424
|
-
/** Describes the properties of an existing
|
|
643
|
+
/** Describes the properties of an existing private endpoint connection to the Azure AI Search service. */
|
|
425
644
|
properties?: PrivateEndpointConnectionProperties;
|
|
426
645
|
}
|
|
427
646
|
|
|
428
|
-
/** Describes a
|
|
647
|
+
/** Describes a shared private link resource managed by the Azure AI Search service. */
|
|
429
648
|
export interface SharedPrivateLinkResource extends Resource {
|
|
430
|
-
/** Describes the properties of a
|
|
649
|
+
/** Describes the properties of a shared private link resource managed by the Azure AI Search service. */
|
|
431
650
|
properties?: SharedPrivateLinkResourceProperties;
|
|
432
651
|
}
|
|
433
652
|
|
|
@@ -439,15 +658,15 @@ export interface TrackedResource extends Resource {
|
|
|
439
658
|
location: string;
|
|
440
659
|
}
|
|
441
660
|
|
|
442
|
-
/** The parameters used to update an Azure
|
|
661
|
+
/** The parameters used to update an Azure AI Search service. */
|
|
443
662
|
export interface SearchServiceUpdate extends Resource {
|
|
444
|
-
/** The SKU of the
|
|
663
|
+
/** The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. */
|
|
445
664
|
sku?: Sku;
|
|
446
|
-
/** The geographic location of the resource. This must be one of the supported and registered Azure
|
|
665
|
+
/** 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. */
|
|
447
666
|
location?: string;
|
|
448
667
|
/** Tags to help categorize the resource in the Azure portal. */
|
|
449
668
|
tags?: { [propertyName: string]: string };
|
|
450
|
-
/**
|
|
669
|
+
/** Details about the search service identity. A null value indicates that the search service has no identity assigned. */
|
|
451
670
|
identity?: Identity;
|
|
452
671
|
/** 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. */
|
|
453
672
|
replicaCount?: number;
|
|
@@ -458,7 +677,7 @@ export interface SearchServiceUpdate extends Resource {
|
|
|
458
677
|
/** 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. */
|
|
459
678
|
publicNetworkAccess?: PublicNetworkAccess;
|
|
460
679
|
/**
|
|
461
|
-
* 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
|
|
680
|
+
* The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
|
|
462
681
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
463
682
|
*/
|
|
464
683
|
readonly status?: SearchServiceStatus;
|
|
@@ -472,40 +691,50 @@ export interface SearchServiceUpdate extends Resource {
|
|
|
472
691
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
473
692
|
*/
|
|
474
693
|
readonly provisioningState?: ProvisioningState;
|
|
475
|
-
/** Network specific rules that determine how the Azure
|
|
694
|
+
/** Network specific rules that determine how the Azure AI Search service may be reached. */
|
|
476
695
|
networkRuleSet?: NetworkRuleSet;
|
|
696
|
+
/** A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future. */
|
|
697
|
+
disabledDataExfiltrationOptions?: SearchDisabledDataExfiltrationOption[];
|
|
477
698
|
/** Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. */
|
|
478
699
|
encryptionWithCmk?: EncryptionWithCmk;
|
|
479
700
|
/** When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. */
|
|
480
701
|
disableLocalAuth?: boolean;
|
|
481
702
|
/** Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. */
|
|
482
703
|
authOptions?: DataPlaneAuthOptions;
|
|
704
|
+
/** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. */
|
|
705
|
+
semanticSearch?: SearchSemanticSearch;
|
|
483
706
|
/**
|
|
484
|
-
* The list of private endpoint connections to the Azure
|
|
707
|
+
* The list of private endpoint connections to the Azure AI Search service.
|
|
485
708
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
486
709
|
*/
|
|
487
710
|
readonly privateEndpointConnections?: PrivateEndpointConnection[];
|
|
488
|
-
/** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. */
|
|
489
|
-
semanticSearch?: SearchSemanticSearch;
|
|
490
711
|
/**
|
|
491
|
-
* The list of shared private link resources managed by the Azure
|
|
712
|
+
* The list of shared private link resources managed by the Azure AI Search service.
|
|
492
713
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
493
714
|
*/
|
|
494
715
|
readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
|
|
716
|
+
/**
|
|
717
|
+
* A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
|
|
718
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
719
|
+
*/
|
|
720
|
+
readonly eTag?: string;
|
|
495
721
|
}
|
|
496
722
|
|
|
497
|
-
/** Describes a supported private link resource for the Azure
|
|
723
|
+
/** Describes a supported private link resource for the Azure AI Search service. */
|
|
498
724
|
export interface PrivateLinkResource extends Resource {
|
|
499
725
|
/**
|
|
500
|
-
* Describes the properties of a supported private link resource for the Azure
|
|
726
|
+
* Describes the properties of a supported private link resource for the Azure AI Search service.
|
|
501
727
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
502
728
|
*/
|
|
503
729
|
readonly properties?: PrivateLinkResourceProperties;
|
|
504
730
|
}
|
|
505
731
|
|
|
506
|
-
/**
|
|
732
|
+
/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
|
|
733
|
+
export interface ProxyResource extends Resource {}
|
|
734
|
+
|
|
735
|
+
/** Describes an Azure AI Search service and its current state. */
|
|
507
736
|
export interface SearchService extends TrackedResource {
|
|
508
|
-
/** The SKU of the
|
|
737
|
+
/** The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. */
|
|
509
738
|
sku?: Sku;
|
|
510
739
|
/** The identity of the resource. */
|
|
511
740
|
identity?: Identity;
|
|
@@ -518,7 +747,7 @@ export interface SearchService extends TrackedResource {
|
|
|
518
747
|
/** 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. */
|
|
519
748
|
publicNetworkAccess?: PublicNetworkAccess;
|
|
520
749
|
/**
|
|
521
|
-
* 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
|
|
750
|
+
* The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
|
|
522
751
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
523
752
|
*/
|
|
524
753
|
readonly status?: SearchServiceStatus;
|
|
@@ -532,26 +761,51 @@ export interface SearchService extends TrackedResource {
|
|
|
532
761
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
533
762
|
*/
|
|
534
763
|
readonly provisioningState?: ProvisioningState;
|
|
535
|
-
/** Network specific rules that determine how the Azure
|
|
764
|
+
/** Network specific rules that determine how the Azure AI Search service may be reached. */
|
|
536
765
|
networkRuleSet?: NetworkRuleSet;
|
|
766
|
+
/** A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future. */
|
|
767
|
+
disabledDataExfiltrationOptions?: SearchDisabledDataExfiltrationOption[];
|
|
537
768
|
/** Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. */
|
|
538
769
|
encryptionWithCmk?: EncryptionWithCmk;
|
|
539
770
|
/** When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. */
|
|
540
771
|
disableLocalAuth?: boolean;
|
|
541
772
|
/** Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. */
|
|
542
773
|
authOptions?: DataPlaneAuthOptions;
|
|
774
|
+
/** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. */
|
|
775
|
+
semanticSearch?: SearchSemanticSearch;
|
|
543
776
|
/**
|
|
544
|
-
* The list of private endpoint connections to the Azure
|
|
777
|
+
* The list of private endpoint connections to the Azure AI Search service.
|
|
545
778
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
546
779
|
*/
|
|
547
780
|
readonly privateEndpointConnections?: PrivateEndpointConnection[];
|
|
548
|
-
/** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. */
|
|
549
|
-
semanticSearch?: SearchSemanticSearch;
|
|
550
781
|
/**
|
|
551
|
-
* The list of shared private link resources managed by the Azure
|
|
782
|
+
* The list of shared private link resources managed by the Azure AI Search service.
|
|
552
783
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
553
784
|
*/
|
|
554
785
|
readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
|
|
786
|
+
/**
|
|
787
|
+
* A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
|
|
788
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
789
|
+
*/
|
|
790
|
+
readonly eTag?: string;
|
|
791
|
+
}
|
|
792
|
+
|
|
793
|
+
/** Network security perimeter configuration for a server. */
|
|
794
|
+
export interface NetworkSecurityPerimeterConfiguration extends ProxyResource {
|
|
795
|
+
/** NOTE: This property will not be serialized. It can only be populated by the server. */
|
|
796
|
+
readonly provisioningState?: string;
|
|
797
|
+
/** The perimeter for a network security perimeter configuration. */
|
|
798
|
+
networkSecurityPerimeter?: NSPConfigPerimeter;
|
|
799
|
+
/** The resource association for the network security perimeter. */
|
|
800
|
+
resourceAssociation?: NSPConfigAssociation;
|
|
801
|
+
/** The profile for a network security perimeter configuration. */
|
|
802
|
+
profile?: NSPConfigProfile;
|
|
803
|
+
provisioningIssues?: NSPProvisioningIssue[];
|
|
804
|
+
}
|
|
805
|
+
|
|
806
|
+
/** Defines headers for NetworkSecurityPerimeterConfigurations_reconcile operation. */
|
|
807
|
+
export interface NetworkSecurityPerimeterConfigurationsReconcileHeaders {
|
|
808
|
+
location?: string;
|
|
555
809
|
}
|
|
556
810
|
|
|
557
811
|
/** Parameter group */
|
|
@@ -560,6 +814,78 @@ export interface SearchManagementRequestOptions {
|
|
|
560
814
|
clientRequestId?: string;
|
|
561
815
|
}
|
|
562
816
|
|
|
817
|
+
/** Known values of {@link PublicNetworkAccess} that the service accepts. */
|
|
818
|
+
export enum KnownPublicNetworkAccess {
|
|
819
|
+
/** The search service is accessible from traffic originating from the public internet. */
|
|
820
|
+
Enabled = "enabled",
|
|
821
|
+
/** The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. */
|
|
822
|
+
Disabled = "disabled",
|
|
823
|
+
}
|
|
824
|
+
|
|
825
|
+
/**
|
|
826
|
+
* Defines values for PublicNetworkAccess. \
|
|
827
|
+
* {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
|
|
828
|
+
* this enum contains the known values that the service supports.
|
|
829
|
+
* ### Known values supported by the service
|
|
830
|
+
* **enabled**: The search service is accessible from traffic originating from the public internet. \
|
|
831
|
+
* **disabled**: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections.
|
|
832
|
+
*/
|
|
833
|
+
export type PublicNetworkAccess = string;
|
|
834
|
+
|
|
835
|
+
/** Known values of {@link SearchBypass} that the service accepts. */
|
|
836
|
+
export enum KnownSearchBypass {
|
|
837
|
+
/** Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. */
|
|
838
|
+
None = "None",
|
|
839
|
+
/** Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. */
|
|
840
|
+
AzurePortal = "AzurePortal",
|
|
841
|
+
}
|
|
842
|
+
|
|
843
|
+
/**
|
|
844
|
+
* Defines values for SearchBypass. \
|
|
845
|
+
* {@link KnownSearchBypass} can be used interchangeably with SearchBypass,
|
|
846
|
+
* this enum contains the known values that the service supports.
|
|
847
|
+
* ### Known values supported by the service
|
|
848
|
+
* **None**: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. \
|
|
849
|
+
* **AzurePortal**: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section.
|
|
850
|
+
*/
|
|
851
|
+
export type SearchBypass = string;
|
|
852
|
+
|
|
853
|
+
/** Known values of {@link SearchDisabledDataExfiltrationOption} that the service accepts. */
|
|
854
|
+
export enum KnownSearchDisabledDataExfiltrationOption {
|
|
855
|
+
/** Indicates that all data exfiltration scenarios are disabled. */
|
|
856
|
+
All = "All",
|
|
857
|
+
}
|
|
858
|
+
|
|
859
|
+
/**
|
|
860
|
+
* Defines values for SearchDisabledDataExfiltrationOption. \
|
|
861
|
+
* {@link KnownSearchDisabledDataExfiltrationOption} can be used interchangeably with SearchDisabledDataExfiltrationOption,
|
|
862
|
+
* this enum contains the known values that the service supports.
|
|
863
|
+
* ### Known values supported by the service
|
|
864
|
+
* **All**: Indicates that all data exfiltration scenarios are disabled.
|
|
865
|
+
*/
|
|
866
|
+
export type SearchDisabledDataExfiltrationOption = string;
|
|
867
|
+
|
|
868
|
+
/** Known values of {@link SearchSemanticSearch} that the service accepts. */
|
|
869
|
+
export enum KnownSearchSemanticSearch {
|
|
870
|
+
/** Indicates that semantic reranker is disabled for the search service. This is the default. */
|
|
871
|
+
Disabled = "disabled",
|
|
872
|
+
/** Enables semantic reranker on a search service and indicates that it is to be used within the limits of the free plan. The free plan would cap the volume of semantic ranking requests and is offered at no extra charge. This is the default for newly provisioned search services. */
|
|
873
|
+
Free = "free",
|
|
874
|
+
/** Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. */
|
|
875
|
+
Standard = "standard",
|
|
876
|
+
}
|
|
877
|
+
|
|
878
|
+
/**
|
|
879
|
+
* Defines values for SearchSemanticSearch. \
|
|
880
|
+
* {@link KnownSearchSemanticSearch} can be used interchangeably with SearchSemanticSearch,
|
|
881
|
+
* this enum contains the known values that the service supports.
|
|
882
|
+
* ### Known values supported by the service
|
|
883
|
+
* **disabled**: Indicates that semantic reranker is disabled for the search service. This is the default. \
|
|
884
|
+
* **free**: Enables semantic reranker on a search service and indicates that it is to be used within the limits of the free plan. The free plan would cap the volume of semantic ranking requests and is offered at no extra charge. This is the default for newly provisioned search services. \
|
|
885
|
+
* **standard**: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries.
|
|
886
|
+
*/
|
|
887
|
+
export type SearchSemanticSearch = string;
|
|
888
|
+
|
|
563
889
|
/** Known values of {@link PrivateLinkServiceConnectionProvisioningState} that the service accepts. */
|
|
564
890
|
export enum KnownPrivateLinkServiceConnectionProvisioningState {
|
|
565
891
|
/** The private link service connection is in the process of being created along with other resources for it to be fully functional. */
|
|
@@ -572,8 +898,8 @@ export enum KnownPrivateLinkServiceConnectionProvisioningState {
|
|
|
572
898
|
Succeeded = "Succeeded",
|
|
573
899
|
/** Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. */
|
|
574
900
|
Incomplete = "Incomplete",
|
|
575
|
-
/** Provisioning request for the private link service connection resource has been canceled */
|
|
576
|
-
Canceled = "Canceled"
|
|
901
|
+
/** Provisioning request for the private link service connection resource has been canceled. */
|
|
902
|
+
Canceled = "Canceled",
|
|
577
903
|
}
|
|
578
904
|
|
|
579
905
|
/**
|
|
@@ -586,37 +912,124 @@ export enum KnownPrivateLinkServiceConnectionProvisioningState {
|
|
|
586
912
|
* **Failed**: The private link service connection has failed to be provisioned or deleted. \
|
|
587
913
|
* **Succeeded**: The private link service connection has finished provisioning and is ready for approval. \
|
|
588
914
|
* **Incomplete**: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. \
|
|
589
|
-
* **Canceled**: Provisioning request for the private link service connection resource has been canceled
|
|
915
|
+
* **Canceled**: Provisioning request for the private link service connection resource has been canceled.
|
|
590
916
|
*/
|
|
591
917
|
export type PrivateLinkServiceConnectionProvisioningState = string;
|
|
592
918
|
|
|
593
|
-
/** Known values of {@link
|
|
594
|
-
export enum
|
|
595
|
-
/**
|
|
596
|
-
|
|
597
|
-
/**
|
|
919
|
+
/** Known values of {@link SharedPrivateLinkResourceStatus} that the service accepts. */
|
|
920
|
+
export enum KnownSharedPrivateLinkResourceStatus {
|
|
921
|
+
/** The shared private link resource has been created and is pending approval. */
|
|
922
|
+
Pending = "Pending",
|
|
923
|
+
/** The shared private link resource is approved and is ready for use. */
|
|
924
|
+
Approved = "Approved",
|
|
925
|
+
/** The shared private link resource has been rejected and cannot be used. */
|
|
926
|
+
Rejected = "Rejected",
|
|
927
|
+
/** The shared private link resource has been removed from the service. */
|
|
928
|
+
Disconnected = "Disconnected",
|
|
929
|
+
}
|
|
930
|
+
|
|
931
|
+
/**
|
|
932
|
+
* Defines values for SharedPrivateLinkResourceStatus. \
|
|
933
|
+
* {@link KnownSharedPrivateLinkResourceStatus} can be used interchangeably with SharedPrivateLinkResourceStatus,
|
|
934
|
+
* this enum contains the known values that the service supports.
|
|
935
|
+
* ### Known values supported by the service
|
|
936
|
+
* **Pending**: The shared private link resource has been created and is pending approval. \
|
|
937
|
+
* **Approved**: The shared private link resource is approved and is ready for use. \
|
|
938
|
+
* **Rejected**: The shared private link resource has been rejected and cannot be used. \
|
|
939
|
+
* **Disconnected**: The shared private link resource has been removed from the service.
|
|
940
|
+
*/
|
|
941
|
+
export type SharedPrivateLinkResourceStatus = string;
|
|
942
|
+
|
|
943
|
+
/** Known values of {@link SharedPrivateLinkResourceProvisioningState} that the service accepts. */
|
|
944
|
+
export enum KnownSharedPrivateLinkResourceProvisioningState {
|
|
945
|
+
/** The shared private link resource is in the process of being created along with other resources for it to be fully functional. */
|
|
946
|
+
Updating = "Updating",
|
|
947
|
+
/** The shared private link resource is in the process of being deleted. */
|
|
948
|
+
Deleting = "Deleting",
|
|
949
|
+
/** The shared private link resource has failed to be provisioned or deleted. */
|
|
950
|
+
Failed = "Failed",
|
|
951
|
+
/** The shared private link resource has finished provisioning and is ready for approval. */
|
|
952
|
+
Succeeded = "Succeeded",
|
|
953
|
+
/** Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. */
|
|
954
|
+
Incomplete = "Incomplete",
|
|
955
|
+
}
|
|
956
|
+
|
|
957
|
+
/**
|
|
958
|
+
* Defines values for SharedPrivateLinkResourceProvisioningState. \
|
|
959
|
+
* {@link KnownSharedPrivateLinkResourceProvisioningState} can be used interchangeably with SharedPrivateLinkResourceProvisioningState,
|
|
960
|
+
* this enum contains the known values that the service supports.
|
|
961
|
+
* ### Known values supported by the service
|
|
962
|
+
* **Updating**: The shared private link resource is in the process of being created along with other resources for it to be fully functional. \
|
|
963
|
+
* **Deleting**: The shared private link resource is in the process of being deleted. \
|
|
964
|
+
* **Failed**: The shared private link resource has failed to be provisioned or deleted. \
|
|
965
|
+
* **Succeeded**: The shared private link resource has finished provisioning and is ready for approval. \
|
|
966
|
+
* **Incomplete**: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet.
|
|
967
|
+
*/
|
|
968
|
+
export type SharedPrivateLinkResourceProvisioningState = string;
|
|
969
|
+
|
|
970
|
+
/** Known values of {@link SkuName} that the service accepts. */
|
|
971
|
+
export enum KnownSkuName {
|
|
972
|
+
/** Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. */
|
|
598
973
|
Free = "free",
|
|
599
|
-
/**
|
|
600
|
-
|
|
974
|
+
/** Billable tier for a dedicated service having up to 3 replicas. */
|
|
975
|
+
Basic = "basic",
|
|
976
|
+
/** Billable tier for a dedicated service having up to 12 partitions and 12 replicas. */
|
|
977
|
+
Standard = "standard",
|
|
978
|
+
/** Similar to 'standard', but with more capacity per search unit. */
|
|
979
|
+
Standard2 = "standard2",
|
|
980
|
+
/** 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'). */
|
|
981
|
+
Standard3 = "standard3",
|
|
982
|
+
/** Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions. */
|
|
983
|
+
StorageOptimizedL1 = "storage_optimized_l1",
|
|
984
|
+
/** Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions. */
|
|
985
|
+
StorageOptimizedL2 = "storage_optimized_l2",
|
|
601
986
|
}
|
|
602
987
|
|
|
603
988
|
/**
|
|
604
|
-
* Defines values for
|
|
605
|
-
* {@link
|
|
989
|
+
* Defines values for SkuName. \
|
|
990
|
+
* {@link KnownSkuName} can be used interchangeably with SkuName,
|
|
606
991
|
* this enum contains the known values that the service supports.
|
|
607
992
|
* ### Known values supported by the service
|
|
608
|
-
* **
|
|
609
|
-
* **
|
|
610
|
-
* **standard**:
|
|
993
|
+
* **free**: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. \
|
|
994
|
+
* **basic**: Billable tier for a dedicated service having up to 3 replicas. \
|
|
995
|
+
* **standard**: Billable tier for a dedicated service having up to 12 partitions and 12 replicas. \
|
|
996
|
+
* **standard2**: Similar to 'standard', but with more capacity per search unit. \
|
|
997
|
+
* **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'). \
|
|
998
|
+
* **storage_optimized_l1**: Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions. \
|
|
999
|
+
* **storage_optimized_l2**: Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.
|
|
611
1000
|
*/
|
|
612
|
-
export type
|
|
1001
|
+
export type SkuName = string;
|
|
1002
|
+
|
|
1003
|
+
/** Known values of {@link IdentityType} that the service accepts. */
|
|
1004
|
+
export enum KnownIdentityType {
|
|
1005
|
+
/** Indicates that any identity associated with the search service needs to be removed. */
|
|
1006
|
+
None = "None",
|
|
1007
|
+
/** Indicates that system-assigned identity for the search service will be enabled. */
|
|
1008
|
+
SystemAssigned = "SystemAssigned",
|
|
1009
|
+
/** Indicates that one or more user assigned identities will be assigned to the search service. */
|
|
1010
|
+
UserAssigned = "UserAssigned",
|
|
1011
|
+
/** Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. */
|
|
1012
|
+
SystemAssignedUserAssigned = "SystemAssigned, UserAssigned",
|
|
1013
|
+
}
|
|
1014
|
+
|
|
1015
|
+
/**
|
|
1016
|
+
* Defines values for IdentityType. \
|
|
1017
|
+
* {@link KnownIdentityType} can be used interchangeably with IdentityType,
|
|
1018
|
+
* this enum contains the known values that the service supports.
|
|
1019
|
+
* ### Known values supported by the service
|
|
1020
|
+
* **None**: Indicates that any identity associated with the search service needs to be removed. \
|
|
1021
|
+
* **SystemAssigned**: Indicates that system-assigned identity for the search service will be enabled. \
|
|
1022
|
+
* **UserAssigned**: Indicates that one or more user assigned identities will be assigned to the search service. \
|
|
1023
|
+
* **SystemAssigned, UserAssigned**: Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities.
|
|
1024
|
+
*/
|
|
1025
|
+
export type IdentityType = string;
|
|
613
1026
|
|
|
614
1027
|
/** Known values of {@link UnavailableNameReason} that the service accepts. */
|
|
615
1028
|
export enum KnownUnavailableNameReason {
|
|
616
|
-
/** The search service name
|
|
1029
|
+
/** The search service name doesn't match naming requirements. */
|
|
617
1030
|
Invalid = "Invalid",
|
|
618
1031
|
/** The search service name is already assigned to a different search service. */
|
|
619
|
-
AlreadyExists = "AlreadyExists"
|
|
1032
|
+
AlreadyExists = "AlreadyExists",
|
|
620
1033
|
}
|
|
621
1034
|
|
|
622
1035
|
/**
|
|
@@ -624,7 +1037,7 @@ export enum KnownUnavailableNameReason {
|
|
|
624
1037
|
* {@link KnownUnavailableNameReason} can be used interchangeably with UnavailableNameReason,
|
|
625
1038
|
* this enum contains the known values that the service supports.
|
|
626
1039
|
* ### Known values supported by the service
|
|
627
|
-
* **Invalid**: The search service name
|
|
1040
|
+
* **Invalid**: The search service name doesn't match naming requirements. \
|
|
628
1041
|
* **AlreadyExists**: The search service name is already assigned to a different search service.
|
|
629
1042
|
*/
|
|
630
1043
|
export type UnavailableNameReason = string;
|
|
@@ -636,7 +1049,7 @@ export enum KnownSharedPrivateLinkResourceAsyncOperationResult {
|
|
|
636
1049
|
/** Succeeded */
|
|
637
1050
|
Succeeded = "Succeeded",
|
|
638
1051
|
/** Failed */
|
|
639
|
-
Failed = "Failed"
|
|
1052
|
+
Failed = "Failed",
|
|
640
1053
|
}
|
|
641
1054
|
|
|
642
1055
|
/**
|
|
@@ -653,8 +1066,6 @@ export type SharedPrivateLinkResourceAsyncOperationResult = string;
|
|
|
653
1066
|
export type AdminKeyKind = "primary" | "secondary";
|
|
654
1067
|
/** Defines values for HostingMode. */
|
|
655
1068
|
export type HostingMode = "default" | "highDensity";
|
|
656
|
-
/** Defines values for PublicNetworkAccess. */
|
|
657
|
-
export type PublicNetworkAccess = "enabled" | "disabled";
|
|
658
1069
|
/** Defines values for SearchServiceStatus. */
|
|
659
1070
|
export type SearchServiceStatus =
|
|
660
1071
|
| "running"
|
|
@@ -662,7 +1073,8 @@ export type SearchServiceStatus =
|
|
|
662
1073
|
| "deleting"
|
|
663
1074
|
| "degraded"
|
|
664
1075
|
| "disabled"
|
|
665
|
-
| "error"
|
|
1076
|
+
| "error"
|
|
1077
|
+
| "stopped";
|
|
666
1078
|
/** Defines values for ProvisioningState. */
|
|
667
1079
|
export type ProvisioningState = "succeeded" | "provisioning" | "failed";
|
|
668
1080
|
/** Defines values for SearchEncryptionWithCmk. */
|
|
@@ -677,30 +1089,6 @@ export type PrivateLinkServiceConnectionStatus =
|
|
|
677
1089
|
| "Approved"
|
|
678
1090
|
| "Rejected"
|
|
679
1091
|
| "Disconnected";
|
|
680
|
-
/** Defines values for SharedPrivateLinkResourceStatus. */
|
|
681
|
-
export type SharedPrivateLinkResourceStatus =
|
|
682
|
-
| "Pending"
|
|
683
|
-
| "Approved"
|
|
684
|
-
| "Rejected"
|
|
685
|
-
| "Disconnected";
|
|
686
|
-
/** Defines values for SharedPrivateLinkResourceProvisioningState. */
|
|
687
|
-
export type SharedPrivateLinkResourceProvisioningState =
|
|
688
|
-
| "Updating"
|
|
689
|
-
| "Deleting"
|
|
690
|
-
| "Failed"
|
|
691
|
-
| "Succeeded"
|
|
692
|
-
| "Incomplete";
|
|
693
|
-
/** Defines values for SkuName. */
|
|
694
|
-
export type SkuName =
|
|
695
|
-
| "free"
|
|
696
|
-
| "basic"
|
|
697
|
-
| "standard"
|
|
698
|
-
| "standard2"
|
|
699
|
-
| "standard3"
|
|
700
|
-
| "storage_optimized_l1"
|
|
701
|
-
| "storage_optimized_l2";
|
|
702
|
-
/** Defines values for IdentityType. */
|
|
703
|
-
export type IdentityType = "None" | "SystemAssigned";
|
|
704
1092
|
|
|
705
1093
|
/** Optional parameters. */
|
|
706
1094
|
export interface OperationsListOptionalParams
|
|
@@ -864,7 +1252,8 @@ export interface PrivateLinkResourcesListSupportedOptionalParams
|
|
|
864
1252
|
}
|
|
865
1253
|
|
|
866
1254
|
/** Contains response data for the listSupported operation. */
|
|
867
|
-
export type PrivateLinkResourcesListSupportedResponse =
|
|
1255
|
+
export type PrivateLinkResourcesListSupportedResponse =
|
|
1256
|
+
PrivateLinkResourcesResult;
|
|
868
1257
|
|
|
869
1258
|
/** Optional parameters. */
|
|
870
1259
|
export interface PrivateEndpointConnectionsUpdateOptionalParams
|
|
@@ -874,7 +1263,8 @@ export interface PrivateEndpointConnectionsUpdateOptionalParams
|
|
|
874
1263
|
}
|
|
875
1264
|
|
|
876
1265
|
/** Contains response data for the update operation. */
|
|
877
|
-
export type PrivateEndpointConnectionsUpdateResponse =
|
|
1266
|
+
export type PrivateEndpointConnectionsUpdateResponse =
|
|
1267
|
+
PrivateEndpointConnection;
|
|
878
1268
|
|
|
879
1269
|
/** Optional parameters. */
|
|
880
1270
|
export interface PrivateEndpointConnectionsGetOptionalParams
|
|
@@ -894,7 +1284,8 @@ export interface PrivateEndpointConnectionsDeleteOptionalParams
|
|
|
894
1284
|
}
|
|
895
1285
|
|
|
896
1286
|
/** Contains response data for the delete operation. */
|
|
897
|
-
export type PrivateEndpointConnectionsDeleteResponse =
|
|
1287
|
+
export type PrivateEndpointConnectionsDeleteResponse =
|
|
1288
|
+
PrivateEndpointConnection;
|
|
898
1289
|
|
|
899
1290
|
/** Optional parameters. */
|
|
900
1291
|
export interface PrivateEndpointConnectionsListByServiceOptionalParams
|
|
@@ -904,7 +1295,8 @@ export interface PrivateEndpointConnectionsListByServiceOptionalParams
|
|
|
904
1295
|
}
|
|
905
1296
|
|
|
906
1297
|
/** Contains response data for the listByService operation. */
|
|
907
|
-
export type PrivateEndpointConnectionsListByServiceResponse =
|
|
1298
|
+
export type PrivateEndpointConnectionsListByServiceResponse =
|
|
1299
|
+
PrivateEndpointConnectionListResult;
|
|
908
1300
|
|
|
909
1301
|
/** Optional parameters. */
|
|
910
1302
|
export interface PrivateEndpointConnectionsListByServiceNextOptionalParams
|
|
@@ -914,7 +1306,8 @@ export interface PrivateEndpointConnectionsListByServiceNextOptionalParams
|
|
|
914
1306
|
}
|
|
915
1307
|
|
|
916
1308
|
/** Contains response data for the listByServiceNext operation. */
|
|
917
|
-
export type PrivateEndpointConnectionsListByServiceNextResponse =
|
|
1309
|
+
export type PrivateEndpointConnectionsListByServiceNextResponse =
|
|
1310
|
+
PrivateEndpointConnectionListResult;
|
|
918
1311
|
|
|
919
1312
|
/** Optional parameters. */
|
|
920
1313
|
export interface SharedPrivateLinkResourcesCreateOrUpdateOptionalParams
|
|
@@ -928,7 +1321,8 @@ export interface SharedPrivateLinkResourcesCreateOrUpdateOptionalParams
|
|
|
928
1321
|
}
|
|
929
1322
|
|
|
930
1323
|
/** Contains response data for the createOrUpdate operation. */
|
|
931
|
-
export type SharedPrivateLinkResourcesCreateOrUpdateResponse =
|
|
1324
|
+
export type SharedPrivateLinkResourcesCreateOrUpdateResponse =
|
|
1325
|
+
SharedPrivateLinkResource;
|
|
932
1326
|
|
|
933
1327
|
/** Optional parameters. */
|
|
934
1328
|
export interface SharedPrivateLinkResourcesGetOptionalParams
|
|
@@ -959,7 +1353,8 @@ export interface SharedPrivateLinkResourcesListByServiceOptionalParams
|
|
|
959
1353
|
}
|
|
960
1354
|
|
|
961
1355
|
/** Contains response data for the listByService operation. */
|
|
962
|
-
export type SharedPrivateLinkResourcesListByServiceResponse =
|
|
1356
|
+
export type SharedPrivateLinkResourcesListByServiceResponse =
|
|
1357
|
+
SharedPrivateLinkResourceListResult;
|
|
963
1358
|
|
|
964
1359
|
/** Optional parameters. */
|
|
965
1360
|
export interface SharedPrivateLinkResourcesListByServiceNextOptionalParams
|
|
@@ -969,7 +1364,8 @@ export interface SharedPrivateLinkResourcesListByServiceNextOptionalParams
|
|
|
969
1364
|
}
|
|
970
1365
|
|
|
971
1366
|
/** Contains response data for the listByServiceNext operation. */
|
|
972
|
-
export type SharedPrivateLinkResourcesListByServiceNextResponse =
|
|
1367
|
+
export type SharedPrivateLinkResourcesListByServiceNextResponse =
|
|
1368
|
+
SharedPrivateLinkResourceListResult;
|
|
973
1369
|
|
|
974
1370
|
/** Optional parameters. */
|
|
975
1371
|
export interface UsagesListBySubscriptionOptionalParams
|
|
@@ -1001,6 +1397,43 @@ export interface UsageBySubscriptionSkuOptionalParams
|
|
|
1001
1397
|
/** Contains response data for the usageBySubscriptionSku operation. */
|
|
1002
1398
|
export type UsageBySubscriptionSkuResponse = QuotaUsageResult;
|
|
1003
1399
|
|
|
1400
|
+
/** Optional parameters. */
|
|
1401
|
+
export interface NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams
|
|
1402
|
+
extends coreClient.OperationOptions {}
|
|
1403
|
+
|
|
1404
|
+
/** Contains response data for the listByService operation. */
|
|
1405
|
+
export type NetworkSecurityPerimeterConfigurationsListByServiceResponse =
|
|
1406
|
+
NetworkSecurityPerimeterConfigurationListResult;
|
|
1407
|
+
|
|
1408
|
+
/** Optional parameters. */
|
|
1409
|
+
export interface NetworkSecurityPerimeterConfigurationsGetOptionalParams
|
|
1410
|
+
extends coreClient.OperationOptions {}
|
|
1411
|
+
|
|
1412
|
+
/** Contains response data for the get operation. */
|
|
1413
|
+
export type NetworkSecurityPerimeterConfigurationsGetResponse =
|
|
1414
|
+
NetworkSecurityPerimeterConfiguration;
|
|
1415
|
+
|
|
1416
|
+
/** Optional parameters. */
|
|
1417
|
+
export interface NetworkSecurityPerimeterConfigurationsReconcileOptionalParams
|
|
1418
|
+
extends coreClient.OperationOptions {
|
|
1419
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
1420
|
+
updateIntervalInMs?: number;
|
|
1421
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
1422
|
+
resumeFrom?: string;
|
|
1423
|
+
}
|
|
1424
|
+
|
|
1425
|
+
/** Contains response data for the reconcile operation. */
|
|
1426
|
+
export type NetworkSecurityPerimeterConfigurationsReconcileResponse =
|
|
1427
|
+
NetworkSecurityPerimeterConfigurationsReconcileHeaders;
|
|
1428
|
+
|
|
1429
|
+
/** Optional parameters. */
|
|
1430
|
+
export interface NetworkSecurityPerimeterConfigurationsListByServiceNextOptionalParams
|
|
1431
|
+
extends coreClient.OperationOptions {}
|
|
1432
|
+
|
|
1433
|
+
/** Contains response data for the listByServiceNext operation. */
|
|
1434
|
+
export type NetworkSecurityPerimeterConfigurationsListByServiceNextResponse =
|
|
1435
|
+
NetworkSecurityPerimeterConfigurationListResult;
|
|
1436
|
+
|
|
1004
1437
|
/** Optional parameters. */
|
|
1005
1438
|
export interface SearchManagementClientOptionalParams
|
|
1006
1439
|
extends coreClient.ServiceClientOptions {
|