@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
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import * as coreClient from "@azure/core-client";
|
|
2
|
-
/** The result of the request to list REST API operations. It contains a list of operations and a URL
|
|
2
|
+
/** The result of the request to list REST API operations. It contains a list of operations and a URL to get the next set of results. */
|
|
3
3
|
export interface OperationListResult {
|
|
4
4
|
/**
|
|
5
|
-
* The list of operations supported by the resource provider.
|
|
5
|
+
* The list of operations by Azure AI Search, some supported by the resource provider and others by data plane APIs.
|
|
6
6
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
7
7
|
*/
|
|
8
8
|
readonly value?: Operation[];
|
|
@@ -24,6 +24,21 @@ export interface Operation {
|
|
|
24
24
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
25
25
|
*/
|
|
26
26
|
readonly display?: OperationDisplay;
|
|
27
|
+
/**
|
|
28
|
+
* Describes if the specified operation is a data plane API operation. Operations where this value is not true are supported directly by the resource provider.
|
|
29
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
30
|
+
*/
|
|
31
|
+
readonly isDataAction?: boolean;
|
|
32
|
+
/**
|
|
33
|
+
* Describes which originating entities are allowed to invoke this operation.
|
|
34
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
35
|
+
*/
|
|
36
|
+
readonly origin?: string;
|
|
37
|
+
/**
|
|
38
|
+
* Describes additional properties for this operation.
|
|
39
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
40
|
+
*/
|
|
41
|
+
readonly properties?: OperationProperties;
|
|
27
42
|
}
|
|
28
43
|
/** The object that describes the operation. */
|
|
29
44
|
export interface OperationDisplay {
|
|
@@ -48,10 +63,115 @@ export interface OperationDisplay {
|
|
|
48
63
|
*/
|
|
49
64
|
readonly description?: string;
|
|
50
65
|
}
|
|
66
|
+
/** Describes additional properties for this operation. */
|
|
67
|
+
export interface OperationProperties {
|
|
68
|
+
/**
|
|
69
|
+
* Specifications of the service for this operation.
|
|
70
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
71
|
+
*/
|
|
72
|
+
readonly serviceSpecification?: OperationServiceSpecification;
|
|
73
|
+
}
|
|
74
|
+
/** Specifications of the service for this operation. */
|
|
75
|
+
export interface OperationServiceSpecification {
|
|
76
|
+
/**
|
|
77
|
+
* Specifications of metrics for this operation.
|
|
78
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
79
|
+
*/
|
|
80
|
+
readonly metricSpecifications?: OperationMetricsSpecification[];
|
|
81
|
+
/**
|
|
82
|
+
* Specifications of logs for this operation.
|
|
83
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
84
|
+
*/
|
|
85
|
+
readonly logSpecifications?: OperationLogsSpecification[];
|
|
86
|
+
}
|
|
87
|
+
/** Specifications of one type of metric for this operation. */
|
|
88
|
+
export interface OperationMetricsSpecification {
|
|
89
|
+
/**
|
|
90
|
+
* The name of the metric specification.
|
|
91
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
92
|
+
*/
|
|
93
|
+
readonly name?: string;
|
|
94
|
+
/**
|
|
95
|
+
* The display name of the metric specification.
|
|
96
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
97
|
+
*/
|
|
98
|
+
readonly displayName?: string;
|
|
99
|
+
/**
|
|
100
|
+
* The display description of the metric specification.
|
|
101
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
102
|
+
*/
|
|
103
|
+
readonly displayDescription?: string;
|
|
104
|
+
/**
|
|
105
|
+
* The unit for the metric specification.
|
|
106
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
107
|
+
*/
|
|
108
|
+
readonly unit?: string;
|
|
109
|
+
/**
|
|
110
|
+
* The type of aggregation for the metric specification.
|
|
111
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
112
|
+
*/
|
|
113
|
+
readonly aggregationType?: string;
|
|
114
|
+
/**
|
|
115
|
+
* Dimensions for the metric specification.
|
|
116
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
117
|
+
*/
|
|
118
|
+
readonly dimensions?: OperationMetricDimension[];
|
|
119
|
+
/**
|
|
120
|
+
* Availabilities for the metric specification.
|
|
121
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
122
|
+
*/
|
|
123
|
+
readonly availabilities?: OperationAvailability[];
|
|
124
|
+
}
|
|
125
|
+
/** Describes a particular dimension for the metric specification. */
|
|
126
|
+
export interface OperationMetricDimension {
|
|
127
|
+
/**
|
|
128
|
+
* The name of the dimension.
|
|
129
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
130
|
+
*/
|
|
131
|
+
readonly name?: string;
|
|
132
|
+
/**
|
|
133
|
+
* The display name of the dimension.
|
|
134
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
135
|
+
*/
|
|
136
|
+
readonly displayName?: string;
|
|
137
|
+
}
|
|
138
|
+
/** Describes a particular availability for the metric specification. */
|
|
139
|
+
export interface OperationAvailability {
|
|
140
|
+
/**
|
|
141
|
+
* The time grain for the dimension.
|
|
142
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
143
|
+
*/
|
|
144
|
+
readonly timeGrain?: string;
|
|
145
|
+
/**
|
|
146
|
+
* The blob duration for the dimension.
|
|
147
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
148
|
+
*/
|
|
149
|
+
readonly blobDuration?: string;
|
|
150
|
+
}
|
|
151
|
+
/** Specifications of one type of log for this operation. */
|
|
152
|
+
export interface OperationLogsSpecification {
|
|
153
|
+
/**
|
|
154
|
+
* The name of the log specification.
|
|
155
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
156
|
+
*/
|
|
157
|
+
readonly name?: string;
|
|
158
|
+
/**
|
|
159
|
+
* The display name of the log specification.
|
|
160
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
161
|
+
*/
|
|
162
|
+
readonly displayName?: string;
|
|
163
|
+
/**
|
|
164
|
+
* The blob duration for the log specification.
|
|
165
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
166
|
+
*/
|
|
167
|
+
readonly blobDuration?: string;
|
|
168
|
+
}
|
|
51
169
|
/** Contains information about an API error. */
|
|
52
170
|
export interface CloudError {
|
|
53
171
|
/** Describes a particular API error with an error code and a message. */
|
|
54
172
|
error?: CloudErrorBody;
|
|
173
|
+
/** A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). */
|
|
174
|
+
message?: string;
|
|
55
175
|
}
|
|
56
176
|
/** Describes a particular API error with an error code and a message. */
|
|
57
177
|
export interface CloudErrorBody {
|
|
@@ -64,7 +184,7 @@ export interface CloudErrorBody {
|
|
|
64
184
|
/** Contains nested errors that are related to this error. */
|
|
65
185
|
details?: CloudErrorBody[];
|
|
66
186
|
}
|
|
67
|
-
/** Response containing the primary and secondary admin API keys for a given Azure
|
|
187
|
+
/** Response containing the primary and secondary admin API keys for a given Azure AI Search service. */
|
|
68
188
|
export interface AdminKeyResult {
|
|
69
189
|
/**
|
|
70
190
|
* The primary admin API key of the search service.
|
|
@@ -77,10 +197,10 @@ export interface AdminKeyResult {
|
|
|
77
197
|
*/
|
|
78
198
|
readonly secondaryKey?: string;
|
|
79
199
|
}
|
|
80
|
-
/** Describes an API key for a given Azure
|
|
200
|
+
/** Describes an API key for a given Azure AI Search service that conveys read-only permissions on the docs collection of an index. */
|
|
81
201
|
export interface QueryKey {
|
|
82
202
|
/**
|
|
83
|
-
* The name of the query API key
|
|
203
|
+
* The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used.
|
|
84
204
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
85
205
|
*/
|
|
86
206
|
readonly name?: string;
|
|
@@ -90,10 +210,10 @@ export interface QueryKey {
|
|
|
90
210
|
*/
|
|
91
211
|
readonly key?: string;
|
|
92
212
|
}
|
|
93
|
-
/** Response containing the query API keys for a given Azure
|
|
213
|
+
/** Response containing the query API keys for a given Azure AI Search service. */
|
|
94
214
|
export interface ListQueryKeysResult {
|
|
95
215
|
/**
|
|
96
|
-
* The query keys for the Azure
|
|
216
|
+
* The query keys for the Azure AI Search service.
|
|
97
217
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
98
218
|
*/
|
|
99
219
|
readonly value?: QueryKey[];
|
|
@@ -103,57 +223,59 @@ export interface ListQueryKeysResult {
|
|
|
103
223
|
*/
|
|
104
224
|
readonly nextLink?: string;
|
|
105
225
|
}
|
|
106
|
-
/** Network specific rules that determine how the Azure
|
|
226
|
+
/** Network specific rules that determine how the Azure AI Search service may be reached. */
|
|
107
227
|
export interface NetworkRuleSet {
|
|
108
228
|
/** A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. */
|
|
109
229
|
ipRules?: IpRule[];
|
|
230
|
+
/** Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. */
|
|
231
|
+
bypass?: SearchBypass;
|
|
110
232
|
}
|
|
111
|
-
/** The IP restriction rule of the Azure
|
|
233
|
+
/** The IP restriction rule of the Azure AI Search service. */
|
|
112
234
|
export interface IpRule {
|
|
113
235
|
/** Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed. */
|
|
114
236
|
value?: string;
|
|
115
237
|
}
|
|
116
|
-
/** Describes a policy that determines how resources within the search service are to be encrypted with
|
|
238
|
+
/** Describes a policy that determines how resources within the search service are to be encrypted with customer managed keys. */
|
|
117
239
|
export interface EncryptionWithCmk {
|
|
118
|
-
/** Describes how a search service should enforce
|
|
240
|
+
/** Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. */
|
|
119
241
|
enforcement?: SearchEncryptionWithCmk;
|
|
120
242
|
/**
|
|
121
|
-
*
|
|
243
|
+
* Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.
|
|
122
244
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
123
245
|
*/
|
|
124
246
|
readonly encryptionComplianceStatus?: SearchEncryptionComplianceStatus;
|
|
125
247
|
}
|
|
126
|
-
/** Defines the options for how the
|
|
248
|
+
/** Defines the options for how the search service authenticates a data plane request. This cannot be set if 'disableLocalAuth' is set to true. */
|
|
127
249
|
export interface DataPlaneAuthOptions {
|
|
128
|
-
/** Indicates that only the API key
|
|
250
|
+
/** Indicates that only the API key can be used for authentication. */
|
|
129
251
|
apiKeyOnly?: Record<string, unknown>;
|
|
130
|
-
/** Indicates that either the API key or an access token from
|
|
252
|
+
/** Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. */
|
|
131
253
|
aadOrApiKey?: DataPlaneAadOrApiKeyAuthOption;
|
|
132
254
|
}
|
|
133
|
-
/** Indicates that either the API key or an access token from
|
|
255
|
+
/** Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. */
|
|
134
256
|
export interface DataPlaneAadOrApiKeyAuthOption {
|
|
135
|
-
/** Describes what response the data plane API of a
|
|
257
|
+
/** Describes what response the data plane API of a search service would send for requests that failed authentication. */
|
|
136
258
|
aadAuthFailureMode?: AadAuthFailureMode;
|
|
137
259
|
}
|
|
138
|
-
/** Describes the properties of an existing
|
|
260
|
+
/** Describes the properties of an existing private endpoint connection to the search service. */
|
|
139
261
|
export interface PrivateEndpointConnectionProperties {
|
|
140
262
|
/** The private endpoint resource from Microsoft.Network provider. */
|
|
141
263
|
privateEndpoint?: PrivateEndpointConnectionPropertiesPrivateEndpoint;
|
|
142
|
-
/** Describes the current state of an existing Private Link
|
|
264
|
+
/** Describes the current state of an existing Azure Private Link service connection to the private endpoint. */
|
|
143
265
|
privateLinkServiceConnectionState?: PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState;
|
|
144
|
-
/** The group
|
|
266
|
+
/** The group ID of the Azure resource for which the private link service is for. */
|
|
145
267
|
groupId?: string;
|
|
146
|
-
/** The provisioning state of the private link service connection.
|
|
268
|
+
/** The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. */
|
|
147
269
|
provisioningState?: PrivateLinkServiceConnectionProvisioningState;
|
|
148
270
|
}
|
|
149
271
|
/** The private endpoint resource from Microsoft.Network provider. */
|
|
150
272
|
export interface PrivateEndpointConnectionPropertiesPrivateEndpoint {
|
|
151
|
-
/** The resource
|
|
273
|
+
/** The resource ID of the private endpoint resource from Microsoft.Network provider. */
|
|
152
274
|
id?: string;
|
|
153
275
|
}
|
|
154
|
-
/** Describes the current state of an existing Private Link
|
|
276
|
+
/** Describes the current state of an existing Azure Private Link service connection to the private endpoint. */
|
|
155
277
|
export interface PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState {
|
|
156
|
-
/** Status of the the private link service connection.
|
|
278
|
+
/** Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. */
|
|
157
279
|
status?: PrivateLinkServiceConnectionStatus;
|
|
158
280
|
/** The description for the private link service connection state. */
|
|
159
281
|
description?: string;
|
|
@@ -178,27 +300,27 @@ export interface Resource {
|
|
|
178
300
|
*/
|
|
179
301
|
readonly type?: string;
|
|
180
302
|
}
|
|
181
|
-
/** Describes the properties of an existing
|
|
303
|
+
/** Describes the properties of an existing shared private link resource managed by the Azure AI Search service. */
|
|
182
304
|
export interface SharedPrivateLinkResourceProperties {
|
|
183
|
-
/** The resource
|
|
305
|
+
/** The resource ID of the resource the shared private link resource is for. */
|
|
184
306
|
privateLinkResourceId?: string;
|
|
185
|
-
/** The group
|
|
307
|
+
/** The group ID from the provider of resource the shared private link resource is for. */
|
|
186
308
|
groupId?: string;
|
|
187
|
-
/** The
|
|
309
|
+
/** The message for requesting approval of the shared private link resource. */
|
|
188
310
|
requestMessage?: string;
|
|
189
|
-
/** Optional. Can be used to specify the Azure Resource Manager location of the resource
|
|
311
|
+
/** Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service). */
|
|
190
312
|
resourceRegion?: string;
|
|
191
|
-
/** Status of the shared private link resource.
|
|
313
|
+
/** Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. */
|
|
192
314
|
status?: SharedPrivateLinkResourceStatus;
|
|
193
|
-
/** The provisioning state of the shared private link resource.
|
|
315
|
+
/** The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. */
|
|
194
316
|
provisioningState?: SharedPrivateLinkResourceProvisioningState;
|
|
195
317
|
}
|
|
196
|
-
/** Defines the SKU of
|
|
318
|
+
/** Defines the SKU of a search service, which determines billing rate and capacity limits. */
|
|
197
319
|
export interface Sku {
|
|
198
320
|
/** The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions.' */
|
|
199
321
|
name?: SkuName;
|
|
200
322
|
}
|
|
201
|
-
/**
|
|
323
|
+
/** Details about the search service identity. A null value indicates that the search service has no identity assigned. */
|
|
202
324
|
export interface Identity {
|
|
203
325
|
/**
|
|
204
326
|
* The principal ID of the system-assigned identity of the search service.
|
|
@@ -210,13 +332,30 @@ export interface Identity {
|
|
|
210
332
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
211
333
|
*/
|
|
212
334
|
readonly tenantId?: string;
|
|
213
|
-
/** The identity type. */
|
|
335
|
+
/** The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service. */
|
|
214
336
|
type: IdentityType;
|
|
337
|
+
/** The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */
|
|
338
|
+
userAssignedIdentities?: {
|
|
339
|
+
[propertyName: string]: UserAssignedManagedIdentity;
|
|
340
|
+
};
|
|
341
|
+
}
|
|
342
|
+
/** The details of the user assigned managed identity assigned to the search service. */
|
|
343
|
+
export interface UserAssignedManagedIdentity {
|
|
344
|
+
/**
|
|
345
|
+
* The principal ID of user assigned identity.
|
|
346
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
347
|
+
*/
|
|
348
|
+
readonly principalId?: string;
|
|
349
|
+
/**
|
|
350
|
+
* The client ID of user assigned identity.
|
|
351
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
352
|
+
*/
|
|
353
|
+
readonly clientId?: string;
|
|
215
354
|
}
|
|
216
|
-
/** Response containing a list of Azure
|
|
355
|
+
/** Response containing a list of Azure AI Search services. */
|
|
217
356
|
export interface SearchServiceListResult {
|
|
218
357
|
/**
|
|
219
|
-
* The list of
|
|
358
|
+
* The list of search services.
|
|
220
359
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
221
360
|
*/
|
|
222
361
|
readonly value?: SearchService[];
|
|
@@ -234,7 +373,7 @@ export interface PrivateLinkResourcesResult {
|
|
|
234
373
|
*/
|
|
235
374
|
readonly value?: PrivateLinkResource[];
|
|
236
375
|
}
|
|
237
|
-
/** Describes the properties of a supported private link resource for the Azure
|
|
376
|
+
/** Describes the properties of a supported private link resource for the Azure AI Search service. For a given API version, this represents the 'supported' groupIds when creating a shared private link resource. */
|
|
238
377
|
export interface PrivateLinkResourceProperties {
|
|
239
378
|
/**
|
|
240
379
|
* The group ID of the private link resource.
|
|
@@ -252,46 +391,46 @@ export interface PrivateLinkResourceProperties {
|
|
|
252
391
|
*/
|
|
253
392
|
readonly requiredZoneNames?: string[];
|
|
254
393
|
/**
|
|
255
|
-
* The list of resources that are onboarded to private link service, that are supported by Azure
|
|
394
|
+
* The list of resources that are onboarded to private link service, that are supported by Azure AI Search.
|
|
256
395
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
257
396
|
*/
|
|
258
397
|
readonly shareablePrivateLinkResourceTypes?: ShareablePrivateLinkResourceType[];
|
|
259
398
|
}
|
|
260
|
-
/** Describes an resource type that has been onboarded to private link service, supported by Azure
|
|
399
|
+
/** Describes an resource type that has been onboarded to private link service, supported by Azure AI Search. */
|
|
261
400
|
export interface ShareablePrivateLinkResourceType {
|
|
262
401
|
/**
|
|
263
|
-
* The name of the resource type that has been onboarded to private link service, supported by Azure
|
|
402
|
+
* The name of the resource type that has been onboarded to private link service, supported by Azure AI Search.
|
|
264
403
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
265
404
|
*/
|
|
266
405
|
readonly name?: string;
|
|
267
406
|
/**
|
|
268
|
-
* Describes the properties of a resource type that has been onboarded to private link service, supported by Azure
|
|
407
|
+
* Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search.
|
|
269
408
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
270
409
|
*/
|
|
271
410
|
readonly properties?: ShareablePrivateLinkResourceProperties;
|
|
272
411
|
}
|
|
273
|
-
/** Describes the properties of a resource type that has been onboarded to private link service, supported by Azure
|
|
412
|
+
/** Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search. */
|
|
274
413
|
export interface ShareablePrivateLinkResourceProperties {
|
|
275
414
|
/**
|
|
276
|
-
* The resource provider type for the resource that has been onboarded to private link service, supported by Azure
|
|
415
|
+
* The resource provider type for the resource that has been onboarded to private link service, supported by Azure AI Search.
|
|
277
416
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
278
417
|
*/
|
|
279
418
|
readonly type?: string;
|
|
280
419
|
/**
|
|
281
|
-
* The resource provider group id for the resource that has been onboarded to private link service, supported by Azure
|
|
420
|
+
* The resource provider group id for the resource that has been onboarded to private link service, supported by Azure AI Search.
|
|
282
421
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
283
422
|
*/
|
|
284
423
|
readonly groupId?: string;
|
|
285
424
|
/**
|
|
286
|
-
* The description of the resource type that has been onboarded to private link service, supported by Azure
|
|
425
|
+
* The description of the resource type that has been onboarded to private link service, supported by Azure AI Search.
|
|
287
426
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
288
427
|
*/
|
|
289
428
|
readonly description?: string;
|
|
290
429
|
}
|
|
291
|
-
/** Response containing a list of
|
|
430
|
+
/** Response containing a list of private endpoint connections. */
|
|
292
431
|
export interface PrivateEndpointConnectionListResult {
|
|
293
432
|
/**
|
|
294
|
-
* The list of
|
|
433
|
+
* The list of private endpoint connections.
|
|
295
434
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
296
435
|
*/
|
|
297
436
|
readonly value?: PrivateEndpointConnection[];
|
|
@@ -301,10 +440,10 @@ export interface PrivateEndpointConnectionListResult {
|
|
|
301
440
|
*/
|
|
302
441
|
readonly nextLink?: string;
|
|
303
442
|
}
|
|
304
|
-
/** Response containing a list of
|
|
443
|
+
/** Response containing a list of shared private link resources. */
|
|
305
444
|
export interface SharedPrivateLinkResourceListResult {
|
|
306
445
|
/**
|
|
307
|
-
* The list of
|
|
446
|
+
* The list of shared private link resources.
|
|
308
447
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
309
448
|
*/
|
|
310
449
|
readonly value?: SharedPrivateLinkResource[];
|
|
@@ -336,10 +475,10 @@ export interface CheckNameAvailabilityOutput {
|
|
|
336
475
|
*/
|
|
337
476
|
readonly message?: string;
|
|
338
477
|
}
|
|
339
|
-
/** Response containing the quota usage information for all the supported
|
|
478
|
+
/** Response containing the quota usage information for all the supported SKUs of Azure AI Search. */
|
|
340
479
|
export interface QuotaUsagesListResult {
|
|
341
480
|
/**
|
|
342
|
-
* The quota usages for the SKUs supported by Azure
|
|
481
|
+
* The quota usages for the SKUs supported by Azure AI Search.
|
|
343
482
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
344
483
|
*/
|
|
345
484
|
readonly value?: QuotaUsageResult[];
|
|
@@ -349,42 +488,106 @@ export interface QuotaUsagesListResult {
|
|
|
349
488
|
*/
|
|
350
489
|
readonly nextLink?: string;
|
|
351
490
|
}
|
|
352
|
-
/** Describes the quota usage for a particular
|
|
491
|
+
/** Describes the quota usage for a particular SKU. */
|
|
353
492
|
export interface QuotaUsageResult {
|
|
354
|
-
/** The resource
|
|
493
|
+
/** The resource ID of the quota usage SKU endpoint for Microsoft.Search provider. */
|
|
355
494
|
id?: string;
|
|
356
|
-
/** The unit of measurement for the search
|
|
495
|
+
/** The unit of measurement for the search SKU. */
|
|
357
496
|
unit?: string;
|
|
358
|
-
/** The currently used up value for the particular search
|
|
497
|
+
/** The currently used up value for the particular search SKU. */
|
|
359
498
|
currentValue?: number;
|
|
360
|
-
/** The quota limit for the particular search
|
|
499
|
+
/** The quota limit for the particular search SKU. */
|
|
361
500
|
limit?: number;
|
|
362
501
|
/**
|
|
363
|
-
* The name of the
|
|
502
|
+
* The name of the SKU supported by Azure AI Search.
|
|
364
503
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
365
504
|
*/
|
|
366
505
|
readonly name?: QuotaUsageResultName;
|
|
367
506
|
}
|
|
368
|
-
/** The name of the
|
|
507
|
+
/** The name of the SKU supported by Azure AI Search. */
|
|
369
508
|
export interface QuotaUsageResultName {
|
|
370
|
-
/** The
|
|
509
|
+
/** The SKU name supported by Azure AI Search. */
|
|
371
510
|
value?: string;
|
|
372
|
-
/** The localized string value for the
|
|
511
|
+
/** The localized string value for the SKU name. */
|
|
373
512
|
localizedValue?: string;
|
|
374
513
|
}
|
|
375
|
-
/**
|
|
514
|
+
/** A list of network security perimeter configurations for a server. */
|
|
515
|
+
export interface NetworkSecurityPerimeterConfigurationListResult {
|
|
516
|
+
/**
|
|
517
|
+
* Array of results.
|
|
518
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
519
|
+
*/
|
|
520
|
+
readonly value?: NetworkSecurityPerimeterConfiguration[];
|
|
521
|
+
/**
|
|
522
|
+
* Link to retrieve next page of results.
|
|
523
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
524
|
+
*/
|
|
525
|
+
readonly nextLink?: string;
|
|
526
|
+
}
|
|
527
|
+
/** The perimeter for a network security perimeter configuration. */
|
|
528
|
+
export interface NSPConfigPerimeter {
|
|
529
|
+
id?: string;
|
|
530
|
+
perimeterGuid?: string;
|
|
531
|
+
location?: string;
|
|
532
|
+
}
|
|
533
|
+
/** The resource association for the network security perimeter. */
|
|
534
|
+
export interface NSPConfigAssociation {
|
|
535
|
+
name?: string;
|
|
536
|
+
accessMode?: string;
|
|
537
|
+
}
|
|
538
|
+
/** The profile for a network security perimeter configuration. */
|
|
539
|
+
export interface NSPConfigProfile {
|
|
540
|
+
name?: string;
|
|
541
|
+
accessRulesVersion?: string;
|
|
542
|
+
accessRules?: NSPConfigAccessRule[];
|
|
543
|
+
}
|
|
544
|
+
/** An access rule for a network security perimeter configuration. */
|
|
545
|
+
export interface NSPConfigAccessRule {
|
|
546
|
+
name?: string;
|
|
547
|
+
/** The properties for the access rules in a network security perimeter configuration. */
|
|
548
|
+
properties?: NSPConfigAccessRuleProperties;
|
|
549
|
+
}
|
|
550
|
+
/** The properties for the access rules in a network security perimeter configuration. */
|
|
551
|
+
export interface NSPConfigAccessRuleProperties {
|
|
552
|
+
direction?: string;
|
|
553
|
+
addressPrefixes?: string[];
|
|
554
|
+
fullyQualifiedDomainNames?: string[];
|
|
555
|
+
subscriptions?: string[];
|
|
556
|
+
networkSecurityPerimeters?: NSPConfigNetworkSecurityPerimeterRule[];
|
|
557
|
+
}
|
|
558
|
+
/** The network security perimeter properties present in a configuration rule. */
|
|
559
|
+
export interface NSPConfigNetworkSecurityPerimeterRule {
|
|
560
|
+
id?: string;
|
|
561
|
+
perimeterGuid?: string;
|
|
562
|
+
location?: string;
|
|
563
|
+
}
|
|
564
|
+
/** An object to describe any issues with provisioning network security perimeters to a search service. */
|
|
565
|
+
export interface NSPProvisioningIssue {
|
|
566
|
+
name?: string;
|
|
567
|
+
/** The properties to describe any issues with provisioning network security perimeters to a search service. */
|
|
568
|
+
properties?: NSPProvisioningIssueProperties;
|
|
569
|
+
}
|
|
570
|
+
/** The properties to describe any issues with provisioning network security perimeters to a search service. */
|
|
571
|
+
export interface NSPProvisioningIssueProperties {
|
|
572
|
+
issueType?: string;
|
|
573
|
+
severity?: string;
|
|
574
|
+
description?: string;
|
|
575
|
+
suggestedResourceIds?: string[];
|
|
576
|
+
suggestedAccessRules?: string[];
|
|
577
|
+
}
|
|
578
|
+
/** The details of a long running asynchronous shared private link resource operation. */
|
|
376
579
|
export interface AsyncOperationResult {
|
|
377
580
|
/** The current status of the long running asynchronous shared private link resource operation. */
|
|
378
581
|
status?: SharedPrivateLinkResourceAsyncOperationResult;
|
|
379
582
|
}
|
|
380
|
-
/** Describes an existing
|
|
583
|
+
/** Describes an existing private endpoint connection to the Azure AI Search service. */
|
|
381
584
|
export interface PrivateEndpointConnection extends Resource {
|
|
382
|
-
/** Describes the properties of an existing
|
|
585
|
+
/** Describes the properties of an existing private endpoint connection to the Azure AI Search service. */
|
|
383
586
|
properties?: PrivateEndpointConnectionProperties;
|
|
384
587
|
}
|
|
385
|
-
/** Describes a
|
|
588
|
+
/** Describes a shared private link resource managed by the Azure AI Search service. */
|
|
386
589
|
export interface SharedPrivateLinkResource extends Resource {
|
|
387
|
-
/** Describes the properties of a
|
|
590
|
+
/** Describes the properties of a shared private link resource managed by the Azure AI Search service. */
|
|
388
591
|
properties?: SharedPrivateLinkResourceProperties;
|
|
389
592
|
}
|
|
390
593
|
/** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
|
|
@@ -396,17 +599,17 @@ export interface TrackedResource extends Resource {
|
|
|
396
599
|
/** The geo-location where the resource lives */
|
|
397
600
|
location: string;
|
|
398
601
|
}
|
|
399
|
-
/** The parameters used to update an Azure
|
|
602
|
+
/** The parameters used to update an Azure AI Search service. */
|
|
400
603
|
export interface SearchServiceUpdate extends Resource {
|
|
401
|
-
/** The SKU of the
|
|
604
|
+
/** The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. */
|
|
402
605
|
sku?: Sku;
|
|
403
|
-
/** The geographic location of the resource. This must be one of the supported and registered Azure
|
|
606
|
+
/** The geographic location of the resource. This must be one of the supported and registered Azure geo regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource. */
|
|
404
607
|
location?: string;
|
|
405
608
|
/** Tags to help categorize the resource in the Azure portal. */
|
|
406
609
|
tags?: {
|
|
407
610
|
[propertyName: string]: string;
|
|
408
611
|
};
|
|
409
|
-
/**
|
|
612
|
+
/** Details about the search service identity. A null value indicates that the search service has no identity assigned. */
|
|
410
613
|
identity?: Identity;
|
|
411
614
|
/** The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU. */
|
|
412
615
|
replicaCount?: number;
|
|
@@ -417,7 +620,7 @@ export interface SearchServiceUpdate extends Resource {
|
|
|
417
620
|
/** This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. */
|
|
418
621
|
publicNetworkAccess?: PublicNetworkAccess;
|
|
419
622
|
/**
|
|
420
|
-
* 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
|
|
623
|
+
* The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
|
|
421
624
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
422
625
|
*/
|
|
423
626
|
readonly status?: SearchServiceStatus;
|
|
@@ -431,38 +634,48 @@ export interface SearchServiceUpdate extends Resource {
|
|
|
431
634
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
432
635
|
*/
|
|
433
636
|
readonly provisioningState?: ProvisioningState;
|
|
434
|
-
/** Network specific rules that determine how the Azure
|
|
637
|
+
/** Network specific rules that determine how the Azure AI Search service may be reached. */
|
|
435
638
|
networkRuleSet?: NetworkRuleSet;
|
|
639
|
+
/** A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future. */
|
|
640
|
+
disabledDataExfiltrationOptions?: SearchDisabledDataExfiltrationOption[];
|
|
436
641
|
/** Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. */
|
|
437
642
|
encryptionWithCmk?: EncryptionWithCmk;
|
|
438
643
|
/** When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. */
|
|
439
644
|
disableLocalAuth?: boolean;
|
|
440
645
|
/** Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. */
|
|
441
646
|
authOptions?: DataPlaneAuthOptions;
|
|
647
|
+
/** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. */
|
|
648
|
+
semanticSearch?: SearchSemanticSearch;
|
|
442
649
|
/**
|
|
443
|
-
* The list of private endpoint connections to the Azure
|
|
650
|
+
* The list of private endpoint connections to the Azure AI Search service.
|
|
444
651
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
445
652
|
*/
|
|
446
653
|
readonly privateEndpointConnections?: PrivateEndpointConnection[];
|
|
447
|
-
/** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. */
|
|
448
|
-
semanticSearch?: SearchSemanticSearch;
|
|
449
654
|
/**
|
|
450
|
-
* The list of shared private link resources managed by the Azure
|
|
655
|
+
* The list of shared private link resources managed by the Azure AI Search service.
|
|
451
656
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
452
657
|
*/
|
|
453
658
|
readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
|
|
659
|
+
/**
|
|
660
|
+
* A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
|
|
661
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
662
|
+
*/
|
|
663
|
+
readonly eTag?: string;
|
|
454
664
|
}
|
|
455
|
-
/** Describes a supported private link resource for the Azure
|
|
665
|
+
/** Describes a supported private link resource for the Azure AI Search service. */
|
|
456
666
|
export interface PrivateLinkResource extends Resource {
|
|
457
667
|
/**
|
|
458
|
-
* Describes the properties of a supported private link resource for the Azure
|
|
668
|
+
* Describes the properties of a supported private link resource for the Azure AI Search service.
|
|
459
669
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
460
670
|
*/
|
|
461
671
|
readonly properties?: PrivateLinkResourceProperties;
|
|
462
672
|
}
|
|
463
|
-
/**
|
|
673
|
+
/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
|
|
674
|
+
export interface ProxyResource extends Resource {
|
|
675
|
+
}
|
|
676
|
+
/** Describes an Azure AI Search service and its current state. */
|
|
464
677
|
export interface SearchService extends TrackedResource {
|
|
465
|
-
/** The SKU of the
|
|
678
|
+
/** The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. */
|
|
466
679
|
sku?: Sku;
|
|
467
680
|
/** The identity of the resource. */
|
|
468
681
|
identity?: Identity;
|
|
@@ -475,7 +688,7 @@ export interface SearchService extends TrackedResource {
|
|
|
475
688
|
/** This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. */
|
|
476
689
|
publicNetworkAccess?: PublicNetworkAccess;
|
|
477
690
|
/**
|
|
478
|
-
* 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
|
|
691
|
+
* The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
|
|
479
692
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
480
693
|
*/
|
|
481
694
|
readonly status?: SearchServiceStatus;
|
|
@@ -489,32 +702,119 @@ export interface SearchService extends TrackedResource {
|
|
|
489
702
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
490
703
|
*/
|
|
491
704
|
readonly provisioningState?: ProvisioningState;
|
|
492
|
-
/** Network specific rules that determine how the Azure
|
|
705
|
+
/** Network specific rules that determine how the Azure AI Search service may be reached. */
|
|
493
706
|
networkRuleSet?: NetworkRuleSet;
|
|
707
|
+
/** A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future. */
|
|
708
|
+
disabledDataExfiltrationOptions?: SearchDisabledDataExfiltrationOption[];
|
|
494
709
|
/** Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. */
|
|
495
710
|
encryptionWithCmk?: EncryptionWithCmk;
|
|
496
711
|
/** When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. */
|
|
497
712
|
disableLocalAuth?: boolean;
|
|
498
713
|
/** Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. */
|
|
499
714
|
authOptions?: DataPlaneAuthOptions;
|
|
715
|
+
/** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. */
|
|
716
|
+
semanticSearch?: SearchSemanticSearch;
|
|
500
717
|
/**
|
|
501
|
-
* The list of private endpoint connections to the Azure
|
|
718
|
+
* The list of private endpoint connections to the Azure AI Search service.
|
|
502
719
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
503
720
|
*/
|
|
504
721
|
readonly privateEndpointConnections?: PrivateEndpointConnection[];
|
|
505
|
-
/** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. */
|
|
506
|
-
semanticSearch?: SearchSemanticSearch;
|
|
507
722
|
/**
|
|
508
|
-
* The list of shared private link resources managed by the Azure
|
|
723
|
+
* The list of shared private link resources managed by the Azure AI Search service.
|
|
509
724
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
510
725
|
*/
|
|
511
726
|
readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
|
|
727
|
+
/**
|
|
728
|
+
* A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
|
|
729
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
730
|
+
*/
|
|
731
|
+
readonly eTag?: string;
|
|
732
|
+
}
|
|
733
|
+
/** Network security perimeter configuration for a server. */
|
|
734
|
+
export interface NetworkSecurityPerimeterConfiguration extends ProxyResource {
|
|
735
|
+
/** NOTE: This property will not be serialized. It can only be populated by the server. */
|
|
736
|
+
readonly provisioningState?: string;
|
|
737
|
+
/** The perimeter for a network security perimeter configuration. */
|
|
738
|
+
networkSecurityPerimeter?: NSPConfigPerimeter;
|
|
739
|
+
/** The resource association for the network security perimeter. */
|
|
740
|
+
resourceAssociation?: NSPConfigAssociation;
|
|
741
|
+
/** The profile for a network security perimeter configuration. */
|
|
742
|
+
profile?: NSPConfigProfile;
|
|
743
|
+
provisioningIssues?: NSPProvisioningIssue[];
|
|
744
|
+
}
|
|
745
|
+
/** Defines headers for NetworkSecurityPerimeterConfigurations_reconcile operation. */
|
|
746
|
+
export interface NetworkSecurityPerimeterConfigurationsReconcileHeaders {
|
|
747
|
+
location?: string;
|
|
512
748
|
}
|
|
513
749
|
/** Parameter group */
|
|
514
750
|
export interface SearchManagementRequestOptions {
|
|
515
751
|
/** A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request. */
|
|
516
752
|
clientRequestId?: string;
|
|
517
753
|
}
|
|
754
|
+
/** Known values of {@link PublicNetworkAccess} that the service accepts. */
|
|
755
|
+
export declare enum KnownPublicNetworkAccess {
|
|
756
|
+
/** The search service is accessible from traffic originating from the public internet. */
|
|
757
|
+
Enabled = "enabled",
|
|
758
|
+
/** The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. */
|
|
759
|
+
Disabled = "disabled"
|
|
760
|
+
}
|
|
761
|
+
/**
|
|
762
|
+
* Defines values for PublicNetworkAccess. \
|
|
763
|
+
* {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
|
|
764
|
+
* this enum contains the known values that the service supports.
|
|
765
|
+
* ### Known values supported by the service
|
|
766
|
+
* **enabled**: The search service is accessible from traffic originating from the public internet. \
|
|
767
|
+
* **disabled**: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections.
|
|
768
|
+
*/
|
|
769
|
+
export type PublicNetworkAccess = string;
|
|
770
|
+
/** Known values of {@link SearchBypass} that the service accepts. */
|
|
771
|
+
export declare enum KnownSearchBypass {
|
|
772
|
+
/** Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. */
|
|
773
|
+
None = "None",
|
|
774
|
+
/** Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. */
|
|
775
|
+
AzurePortal = "AzurePortal"
|
|
776
|
+
}
|
|
777
|
+
/**
|
|
778
|
+
* Defines values for SearchBypass. \
|
|
779
|
+
* {@link KnownSearchBypass} can be used interchangeably with SearchBypass,
|
|
780
|
+
* this enum contains the known values that the service supports.
|
|
781
|
+
* ### Known values supported by the service
|
|
782
|
+
* **None**: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. \
|
|
783
|
+
* **AzurePortal**: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section.
|
|
784
|
+
*/
|
|
785
|
+
export type SearchBypass = string;
|
|
786
|
+
/** Known values of {@link SearchDisabledDataExfiltrationOption} that the service accepts. */
|
|
787
|
+
export declare enum KnownSearchDisabledDataExfiltrationOption {
|
|
788
|
+
/** Indicates that all data exfiltration scenarios are disabled. */
|
|
789
|
+
All = "All"
|
|
790
|
+
}
|
|
791
|
+
/**
|
|
792
|
+
* Defines values for SearchDisabledDataExfiltrationOption. \
|
|
793
|
+
* {@link KnownSearchDisabledDataExfiltrationOption} can be used interchangeably with SearchDisabledDataExfiltrationOption,
|
|
794
|
+
* this enum contains the known values that the service supports.
|
|
795
|
+
* ### Known values supported by the service
|
|
796
|
+
* **All**: Indicates that all data exfiltration scenarios are disabled.
|
|
797
|
+
*/
|
|
798
|
+
export type SearchDisabledDataExfiltrationOption = string;
|
|
799
|
+
/** Known values of {@link SearchSemanticSearch} that the service accepts. */
|
|
800
|
+
export declare enum KnownSearchSemanticSearch {
|
|
801
|
+
/** Indicates that semantic reranker is disabled for the search service. This is the default. */
|
|
802
|
+
Disabled = "disabled",
|
|
803
|
+
/** 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. */
|
|
804
|
+
Free = "free",
|
|
805
|
+
/** Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. */
|
|
806
|
+
Standard = "standard"
|
|
807
|
+
}
|
|
808
|
+
/**
|
|
809
|
+
* Defines values for SearchSemanticSearch. \
|
|
810
|
+
* {@link KnownSearchSemanticSearch} can be used interchangeably with SearchSemanticSearch,
|
|
811
|
+
* this enum contains the known values that the service supports.
|
|
812
|
+
* ### Known values supported by the service
|
|
813
|
+
* **disabled**: Indicates that semantic reranker is disabled for the search service. This is the default. \
|
|
814
|
+
* **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. \
|
|
815
|
+
* **standard**: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries.
|
|
816
|
+
*/
|
|
817
|
+
export type SearchSemanticSearch = string;
|
|
518
818
|
/** Known values of {@link PrivateLinkServiceConnectionProvisioningState} that the service accepts. */
|
|
519
819
|
export declare enum KnownPrivateLinkServiceConnectionProvisioningState {
|
|
520
820
|
/** The private link service connection is in the process of being created along with other resources for it to be fully functional. */
|
|
@@ -527,7 +827,7 @@ export declare enum KnownPrivateLinkServiceConnectionProvisioningState {
|
|
|
527
827
|
Succeeded = "Succeeded",
|
|
528
828
|
/** Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. */
|
|
529
829
|
Incomplete = "Incomplete",
|
|
530
|
-
/** Provisioning request for the private link service connection resource has been canceled */
|
|
830
|
+
/** Provisioning request for the private link service connection resource has been canceled. */
|
|
531
831
|
Canceled = "Canceled"
|
|
532
832
|
}
|
|
533
833
|
/**
|
|
@@ -540,31 +840,112 @@ export declare enum KnownPrivateLinkServiceConnectionProvisioningState {
|
|
|
540
840
|
* **Failed**: The private link service connection has failed to be provisioned or deleted. \
|
|
541
841
|
* **Succeeded**: The private link service connection has finished provisioning and is ready for approval. \
|
|
542
842
|
* **Incomplete**: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. \
|
|
543
|
-
* **Canceled**: Provisioning request for the private link service connection resource has been canceled
|
|
843
|
+
* **Canceled**: Provisioning request for the private link service connection resource has been canceled.
|
|
544
844
|
*/
|
|
545
845
|
export type PrivateLinkServiceConnectionProvisioningState = string;
|
|
546
|
-
/** Known values of {@link
|
|
547
|
-
export declare enum
|
|
548
|
-
/**
|
|
549
|
-
|
|
550
|
-
/**
|
|
846
|
+
/** Known values of {@link SharedPrivateLinkResourceStatus} that the service accepts. */
|
|
847
|
+
export declare enum KnownSharedPrivateLinkResourceStatus {
|
|
848
|
+
/** The shared private link resource has been created and is pending approval. */
|
|
849
|
+
Pending = "Pending",
|
|
850
|
+
/** The shared private link resource is approved and is ready for use. */
|
|
851
|
+
Approved = "Approved",
|
|
852
|
+
/** The shared private link resource has been rejected and cannot be used. */
|
|
853
|
+
Rejected = "Rejected",
|
|
854
|
+
/** The shared private link resource has been removed from the service. */
|
|
855
|
+
Disconnected = "Disconnected"
|
|
856
|
+
}
|
|
857
|
+
/**
|
|
858
|
+
* Defines values for SharedPrivateLinkResourceStatus. \
|
|
859
|
+
* {@link KnownSharedPrivateLinkResourceStatus} can be used interchangeably with SharedPrivateLinkResourceStatus,
|
|
860
|
+
* this enum contains the known values that the service supports.
|
|
861
|
+
* ### Known values supported by the service
|
|
862
|
+
* **Pending**: The shared private link resource has been created and is pending approval. \
|
|
863
|
+
* **Approved**: The shared private link resource is approved and is ready for use. \
|
|
864
|
+
* **Rejected**: The shared private link resource has been rejected and cannot be used. \
|
|
865
|
+
* **Disconnected**: The shared private link resource has been removed from the service.
|
|
866
|
+
*/
|
|
867
|
+
export type SharedPrivateLinkResourceStatus = string;
|
|
868
|
+
/** Known values of {@link SharedPrivateLinkResourceProvisioningState} that the service accepts. */
|
|
869
|
+
export declare enum KnownSharedPrivateLinkResourceProvisioningState {
|
|
870
|
+
/** The shared private link resource is in the process of being created along with other resources for it to be fully functional. */
|
|
871
|
+
Updating = "Updating",
|
|
872
|
+
/** The shared private link resource is in the process of being deleted. */
|
|
873
|
+
Deleting = "Deleting",
|
|
874
|
+
/** The shared private link resource has failed to be provisioned or deleted. */
|
|
875
|
+
Failed = "Failed",
|
|
876
|
+
/** The shared private link resource has finished provisioning and is ready for approval. */
|
|
877
|
+
Succeeded = "Succeeded",
|
|
878
|
+
/** Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. */
|
|
879
|
+
Incomplete = "Incomplete"
|
|
880
|
+
}
|
|
881
|
+
/**
|
|
882
|
+
* Defines values for SharedPrivateLinkResourceProvisioningState. \
|
|
883
|
+
* {@link KnownSharedPrivateLinkResourceProvisioningState} can be used interchangeably with SharedPrivateLinkResourceProvisioningState,
|
|
884
|
+
* this enum contains the known values that the service supports.
|
|
885
|
+
* ### Known values supported by the service
|
|
886
|
+
* **Updating**: The shared private link resource is in the process of being created along with other resources for it to be fully functional. \
|
|
887
|
+
* **Deleting**: The shared private link resource is in the process of being deleted. \
|
|
888
|
+
* **Failed**: The shared private link resource has failed to be provisioned or deleted. \
|
|
889
|
+
* **Succeeded**: The shared private link resource has finished provisioning and is ready for approval. \
|
|
890
|
+
* **Incomplete**: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet.
|
|
891
|
+
*/
|
|
892
|
+
export type SharedPrivateLinkResourceProvisioningState = string;
|
|
893
|
+
/** Known values of {@link SkuName} that the service accepts. */
|
|
894
|
+
export declare enum KnownSkuName {
|
|
895
|
+
/** Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. */
|
|
551
896
|
Free = "free",
|
|
552
|
-
/**
|
|
553
|
-
|
|
897
|
+
/** Billable tier for a dedicated service having up to 3 replicas. */
|
|
898
|
+
Basic = "basic",
|
|
899
|
+
/** Billable tier for a dedicated service having up to 12 partitions and 12 replicas. */
|
|
900
|
+
Standard = "standard",
|
|
901
|
+
/** Similar to 'standard', but with more capacity per search unit. */
|
|
902
|
+
Standard2 = "standard2",
|
|
903
|
+
/** 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'). */
|
|
904
|
+
Standard3 = "standard3",
|
|
905
|
+
/** Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions. */
|
|
906
|
+
StorageOptimizedL1 = "storage_optimized_l1",
|
|
907
|
+
/** Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions. */
|
|
908
|
+
StorageOptimizedL2 = "storage_optimized_l2"
|
|
554
909
|
}
|
|
555
910
|
/**
|
|
556
|
-
* Defines values for
|
|
557
|
-
* {@link
|
|
911
|
+
* Defines values for SkuName. \
|
|
912
|
+
* {@link KnownSkuName} can be used interchangeably with SkuName,
|
|
558
913
|
* this enum contains the known values that the service supports.
|
|
559
914
|
* ### Known values supported by the service
|
|
560
|
-
* **
|
|
561
|
-
* **
|
|
562
|
-
* **standard**:
|
|
915
|
+
* **free**: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. \
|
|
916
|
+
* **basic**: Billable tier for a dedicated service having up to 3 replicas. \
|
|
917
|
+
* **standard**: Billable tier for a dedicated service having up to 12 partitions and 12 replicas. \
|
|
918
|
+
* **standard2**: Similar to 'standard', but with more capacity per search unit. \
|
|
919
|
+
* **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'). \
|
|
920
|
+
* **storage_optimized_l1**: Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions. \
|
|
921
|
+
* **storage_optimized_l2**: Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.
|
|
563
922
|
*/
|
|
564
|
-
export type
|
|
923
|
+
export type SkuName = string;
|
|
924
|
+
/** Known values of {@link IdentityType} that the service accepts. */
|
|
925
|
+
export declare enum KnownIdentityType {
|
|
926
|
+
/** Indicates that any identity associated with the search service needs to be removed. */
|
|
927
|
+
None = "None",
|
|
928
|
+
/** Indicates that system-assigned identity for the search service will be enabled. */
|
|
929
|
+
SystemAssigned = "SystemAssigned",
|
|
930
|
+
/** Indicates that one or more user assigned identities will be assigned to the search service. */
|
|
931
|
+
UserAssigned = "UserAssigned",
|
|
932
|
+
/** Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. */
|
|
933
|
+
SystemAssignedUserAssigned = "SystemAssigned, UserAssigned"
|
|
934
|
+
}
|
|
935
|
+
/**
|
|
936
|
+
* Defines values for IdentityType. \
|
|
937
|
+
* {@link KnownIdentityType} can be used interchangeably with IdentityType,
|
|
938
|
+
* this enum contains the known values that the service supports.
|
|
939
|
+
* ### Known values supported by the service
|
|
940
|
+
* **None**: Indicates that any identity associated with the search service needs to be removed. \
|
|
941
|
+
* **SystemAssigned**: Indicates that system-assigned identity for the search service will be enabled. \
|
|
942
|
+
* **UserAssigned**: Indicates that one or more user assigned identities will be assigned to the search service. \
|
|
943
|
+
* **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.
|
|
944
|
+
*/
|
|
945
|
+
export type IdentityType = string;
|
|
565
946
|
/** Known values of {@link UnavailableNameReason} that the service accepts. */
|
|
566
947
|
export declare enum KnownUnavailableNameReason {
|
|
567
|
-
/** The search service name
|
|
948
|
+
/** The search service name doesn't match naming requirements. */
|
|
568
949
|
Invalid = "Invalid",
|
|
569
950
|
/** The search service name is already assigned to a different search service. */
|
|
570
951
|
AlreadyExists = "AlreadyExists"
|
|
@@ -574,7 +955,7 @@ export declare enum KnownUnavailableNameReason {
|
|
|
574
955
|
* {@link KnownUnavailableNameReason} can be used interchangeably with UnavailableNameReason,
|
|
575
956
|
* this enum contains the known values that the service supports.
|
|
576
957
|
* ### Known values supported by the service
|
|
577
|
-
* **Invalid**: The search service name
|
|
958
|
+
* **Invalid**: The search service name doesn't match naming requirements. \
|
|
578
959
|
* **AlreadyExists**: The search service name is already assigned to a different search service.
|
|
579
960
|
*/
|
|
580
961
|
export type UnavailableNameReason = string;
|
|
@@ -601,10 +982,8 @@ export type SharedPrivateLinkResourceAsyncOperationResult = string;
|
|
|
601
982
|
export type AdminKeyKind = "primary" | "secondary";
|
|
602
983
|
/** Defines values for HostingMode. */
|
|
603
984
|
export type HostingMode = "default" | "highDensity";
|
|
604
|
-
/** Defines values for PublicNetworkAccess. */
|
|
605
|
-
export type PublicNetworkAccess = "enabled" | "disabled";
|
|
606
985
|
/** Defines values for SearchServiceStatus. */
|
|
607
|
-
export type SearchServiceStatus = "running" | "provisioning" | "deleting" | "degraded" | "disabled" | "error";
|
|
986
|
+
export type SearchServiceStatus = "running" | "provisioning" | "deleting" | "degraded" | "disabled" | "error" | "stopped";
|
|
608
987
|
/** Defines values for ProvisioningState. */
|
|
609
988
|
export type ProvisioningState = "succeeded" | "provisioning" | "failed";
|
|
610
989
|
/** Defines values for SearchEncryptionWithCmk. */
|
|
@@ -615,14 +994,6 @@ export type SearchEncryptionComplianceStatus = "Compliant" | "NonCompliant";
|
|
|
615
994
|
export type AadAuthFailureMode = "http403" | "http401WithBearerChallenge";
|
|
616
995
|
/** Defines values for PrivateLinkServiceConnectionStatus. */
|
|
617
996
|
export type PrivateLinkServiceConnectionStatus = "Pending" | "Approved" | "Rejected" | "Disconnected";
|
|
618
|
-
/** Defines values for SharedPrivateLinkResourceStatus. */
|
|
619
|
-
export type SharedPrivateLinkResourceStatus = "Pending" | "Approved" | "Rejected" | "Disconnected";
|
|
620
|
-
/** Defines values for SharedPrivateLinkResourceProvisioningState. */
|
|
621
|
-
export type SharedPrivateLinkResourceProvisioningState = "Updating" | "Deleting" | "Failed" | "Succeeded" | "Incomplete";
|
|
622
|
-
/** Defines values for SkuName. */
|
|
623
|
-
export type SkuName = "free" | "basic" | "standard" | "standard2" | "standard3" | "storage_optimized_l1" | "storage_optimized_l2";
|
|
624
|
-
/** Defines values for IdentityType. */
|
|
625
|
-
export type IdentityType = "None" | "SystemAssigned";
|
|
626
997
|
/** Optional parameters. */
|
|
627
998
|
export interface OperationsListOptionalParams extends coreClient.OperationOptions {
|
|
628
999
|
}
|
|
@@ -838,6 +1209,30 @@ export interface UsageBySubscriptionSkuOptionalParams extends coreClient.Operati
|
|
|
838
1209
|
/** Contains response data for the usageBySubscriptionSku operation. */
|
|
839
1210
|
export type UsageBySubscriptionSkuResponse = QuotaUsageResult;
|
|
840
1211
|
/** Optional parameters. */
|
|
1212
|
+
export interface NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams extends coreClient.OperationOptions {
|
|
1213
|
+
}
|
|
1214
|
+
/** Contains response data for the listByService operation. */
|
|
1215
|
+
export type NetworkSecurityPerimeterConfigurationsListByServiceResponse = NetworkSecurityPerimeterConfigurationListResult;
|
|
1216
|
+
/** Optional parameters. */
|
|
1217
|
+
export interface NetworkSecurityPerimeterConfigurationsGetOptionalParams extends coreClient.OperationOptions {
|
|
1218
|
+
}
|
|
1219
|
+
/** Contains response data for the get operation. */
|
|
1220
|
+
export type NetworkSecurityPerimeterConfigurationsGetResponse = NetworkSecurityPerimeterConfiguration;
|
|
1221
|
+
/** Optional parameters. */
|
|
1222
|
+
export interface NetworkSecurityPerimeterConfigurationsReconcileOptionalParams extends coreClient.OperationOptions {
|
|
1223
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
1224
|
+
updateIntervalInMs?: number;
|
|
1225
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
1226
|
+
resumeFrom?: string;
|
|
1227
|
+
}
|
|
1228
|
+
/** Contains response data for the reconcile operation. */
|
|
1229
|
+
export type NetworkSecurityPerimeterConfigurationsReconcileResponse = NetworkSecurityPerimeterConfigurationsReconcileHeaders;
|
|
1230
|
+
/** Optional parameters. */
|
|
1231
|
+
export interface NetworkSecurityPerimeterConfigurationsListByServiceNextOptionalParams extends coreClient.OperationOptions {
|
|
1232
|
+
}
|
|
1233
|
+
/** Contains response data for the listByServiceNext operation. */
|
|
1234
|
+
export type NetworkSecurityPerimeterConfigurationsListByServiceNextResponse = NetworkSecurityPerimeterConfigurationListResult;
|
|
1235
|
+
/** Optional parameters. */
|
|
841
1236
|
export interface SearchManagementClientOptionalParams extends coreClient.ServiceClientOptions {
|
|
842
1237
|
/** server parameter */
|
|
843
1238
|
$host?: string;
|