@azure/arm-search 1.3.0 → 3.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/{LICENSE.txt → LICENSE} +21 -21
- package/README.md +98 -96
- package/dist/index.js +2926 -0
- package/dist/index.js.map +1 -0
- package/dist/index.min.js +1 -0
- package/dist/index.min.js.map +1 -0
- package/dist-esm/src/index.d.ts +5 -0
- package/dist-esm/src/index.d.ts.map +1 -0
- package/dist-esm/src/index.js +12 -0
- package/dist-esm/src/index.js.map +1 -0
- package/dist-esm/src/lroImpl.d.ts +16 -0
- package/dist-esm/src/lroImpl.d.ts.map +1 -0
- package/dist-esm/src/lroImpl.js +29 -0
- package/dist-esm/src/lroImpl.js.map +1 -0
- package/dist-esm/src/models/index.d.ts +692 -0
- package/dist-esm/src/models/index.d.ts.map +1 -0
- package/dist-esm/src/models/index.js +21 -0
- package/dist-esm/src/models/index.js.map +1 -0
- package/dist-esm/src/models/mappers.d.ts +35 -0
- package/dist-esm/src/models/mappers.d.ts.map +1 -0
- package/dist-esm/src/models/mappers.js +1013 -0
- package/dist-esm/src/models/mappers.js.map +1 -0
- package/dist-esm/src/models/parameters.d.ts +22 -0
- package/dist-esm/src/models/parameters.d.ts.map +1 -0
- package/dist-esm/src/models/parameters.js +182 -0
- package/dist-esm/src/models/parameters.js.map +1 -0
- package/dist-esm/src/operations/adminKeys.d.ts +33 -0
- package/dist-esm/src/operations/adminKeys.d.ts.map +1 -0
- package/dist-esm/src/operations/adminKeys.js +90 -0
- package/dist-esm/src/operations/adminKeys.js.map +1 -0
- package/dist-esm/src/operations/index.d.ts +8 -0
- package/dist-esm/src/operations/index.d.ts.map +1 -0
- package/dist-esm/src/operations/index.js +15 -0
- package/dist-esm/src/operations/index.js.map +1 -0
- package/dist-esm/src/operations/operations.d.ts +26 -0
- package/dist-esm/src/operations/operations.d.ts.map +1 -0
- package/dist-esm/src/operations/operations.js +90 -0
- package/dist-esm/src/operations/operations.js.map +1 -0
- package/dist-esm/src/operations/privateEndpointConnections.d.ts +79 -0
- package/dist-esm/src/operations/privateEndpointConnections.d.ts.map +1 -0
- package/dist-esm/src/operations/privateEndpointConnections.js +273 -0
- package/dist-esm/src/operations/privateEndpointConnections.js.map +1 -0
- package/dist-esm/src/operations/privateLinkResources.d.ts +34 -0
- package/dist-esm/src/operations/privateLinkResources.d.ts.map +1 -0
- package/dist-esm/src/operations/privateLinkResources.js +103 -0
- package/dist-esm/src/operations/privateLinkResources.js.map +1 -0
- package/dist-esm/src/operations/queryKeys.d.ts +66 -0
- package/dist-esm/src/operations/queryKeys.d.ts.map +1 -0
- package/dist-esm/src/operations/queryKeys.js +213 -0
- package/dist-esm/src/operations/queryKeys.js.map +1 -0
- package/dist-esm/src/operations/services.d.ts +123 -0
- package/dist-esm/src/operations/services.d.ts.map +1 -0
- package/dist-esm/src/operations/services.js +475 -0
- package/dist-esm/src/operations/services.js.map +1 -0
- package/dist-esm/src/operations/sharedPrivateLinkResources.d.ts +107 -0
- package/dist-esm/src/operations/sharedPrivateLinkResources.d.ts.map +1 -0
- package/dist-esm/src/operations/sharedPrivateLinkResources.js +379 -0
- package/dist-esm/src/operations/sharedPrivateLinkResources.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/adminKeys.d.ts +25 -0
- package/dist-esm/src/operationsInterfaces/adminKeys.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/adminKeys.js +9 -0
- package/dist-esm/src/operationsInterfaces/adminKeys.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/index.d.ts +8 -0
- package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/index.js +15 -0
- package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/operations.d.ts +11 -0
- package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/operations.js +9 -0
- package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts +50 -0
- package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/privateEndpointConnections.js +9 -0
- package/dist-esm/src/operationsInterfaces/privateEndpointConnections.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/privateLinkResources.d.ts +15 -0
- package/dist-esm/src/operationsInterfaces/privateLinkResources.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/privateLinkResources.js +9 -0
- package/dist-esm/src/operationsInterfaces/privateLinkResources.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/queryKeys.d.ts +37 -0
- package/dist-esm/src/operationsInterfaces/queryKeys.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/queryKeys.js +9 -0
- package/dist-esm/src/operationsInterfaces/queryKeys.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/services.d.ts +85 -0
- package/dist-esm/src/operationsInterfaces/services.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/services.js +9 -0
- package/dist-esm/src/operationsInterfaces/services.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/sharedPrivateLinkResources.d.ts +78 -0
- package/dist-esm/src/operationsInterfaces/sharedPrivateLinkResources.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/sharedPrivateLinkResources.js +9 -0
- package/dist-esm/src/operationsInterfaces/sharedPrivateLinkResources.js.map +1 -0
- package/dist-esm/src/searchManagementClient.d.ts +25 -0
- package/dist-esm/src/searchManagementClient.d.ts.map +1 -0
- package/dist-esm/src/searchManagementClient.js +58 -0
- package/dist-esm/src/searchManagementClient.js.map +1 -0
- package/dist-esm/test/search_examples.d.ts +4 -0
- package/dist-esm/test/search_examples.d.ts.map +1 -0
- package/dist-esm/test/search_examples.js +163 -0
- package/dist-esm/test/search_examples.js.map +1 -0
- package/package.json +70 -34
- package/review/arm-search.api.md +600 -0
- package/rollup.config.js +184 -27
- package/src/index.ts +12 -0
- package/src/lroImpl.ts +34 -0
- package/src/models/index.ts +837 -0
- package/src/models/mappers.ts +1092 -0
- package/src/models/parameters.ts +213 -0
- package/src/operations/adminKeys.ts +122 -0
- package/{lib → src}/operations/index.ts +6 -5
- package/src/operations/operations.ts +98 -0
- package/src/operations/privateEndpointConnections.ts +363 -0
- package/src/operations/privateLinkResources.ts +139 -0
- package/src/operations/queryKeys.ts +288 -0
- package/src/operations/services.ts +606 -0
- package/src/operations/sharedPrivateLinkResources.ts +525 -0
- package/src/operationsInterfaces/adminKeys.ts +48 -0
- package/{esm/operations/index.js → src/operationsInterfaces/index.ts} +7 -6
- package/src/operationsInterfaces/operations.ts +22 -0
- package/src/operationsInterfaces/privateEndpointConnections.ts +88 -0
- package/src/operationsInterfaces/privateLinkResources.ts +31 -0
- package/src/operationsInterfaces/queryKeys.ts +66 -0
- package/src/operationsInterfaces/services.ts +144 -0
- package/src/operationsInterfaces/sharedPrivateLinkResources.ts +131 -0
- package/src/searchManagementClient.ts +104 -0
- package/tsconfig.json +4 -4
- package/types/arm-search.d.ts +1104 -0
- package/types/tsdoc-metadata.json +11 -0
- package/dist/arm-search.js +0 -1329
- package/dist/arm-search.js.map +0 -1
- package/dist/arm-search.min.js +0 -1
- package/dist/arm-search.min.js.map +0 -1
- package/esm/models/adminKeysMappers.d.ts +0 -2
- package/esm/models/adminKeysMappers.d.ts.map +0 -1
- package/esm/models/adminKeysMappers.js +0 -11
- package/esm/models/adminKeysMappers.js.map +0 -1
- package/esm/models/index.d.ts +0 -788
- package/esm/models/index.d.ts.map +0 -1
- package/esm/models/index.js +0 -10
- package/esm/models/index.js.map +0 -1
- package/esm/models/mappers.d.ts +0 -18
- package/esm/models/mappers.d.ts.map +0 -1
- package/esm/models/mappers.js +0 -438
- package/esm/models/mappers.js.map +0 -1
- package/esm/models/operationsMappers.d.ts +0 -2
- package/esm/models/operationsMappers.d.ts.map +0 -1
- package/esm/models/operationsMappers.js +0 -11
- package/esm/models/operationsMappers.js.map +0 -1
- package/esm/models/parameters.d.ts +0 -11
- package/esm/models/parameters.d.ts.map +0 -1
- package/esm/models/parameters.js +0 -107
- package/esm/models/parameters.js.map +0 -1
- package/esm/models/queryKeysMappers.d.ts +0 -2
- package/esm/models/queryKeysMappers.d.ts.map +0 -1
- package/esm/models/queryKeysMappers.js +0 -11
- package/esm/models/queryKeysMappers.js.map +0 -1
- package/esm/models/servicesMappers.d.ts +0 -2
- package/esm/models/servicesMappers.d.ts.map +0 -1
- package/esm/models/servicesMappers.js +0 -11
- package/esm/models/servicesMappers.js.map +0 -1
- package/esm/operations/adminKeys.d.ts +0 -74
- package/esm/operations/adminKeys.d.ts.map +0 -1
- package/esm/operations/adminKeys.js +0 -93
- package/esm/operations/adminKeys.js.map +0 -1
- package/esm/operations/index.d.ts +0 -5
- package/esm/operations/index.d.ts.map +0 -1
- package/esm/operations/index.js.map +0 -1
- package/esm/operations/operations.d.ts +0 -28
- package/esm/operations/operations.d.ts.map +0 -1
- package/esm/operations/operations.js +0 -51
- package/esm/operations/operations.js.map +0 -1
- package/esm/operations/queryKeys.d.ts +0 -102
- package/esm/operations/queryKeys.d.ts.map +0 -1
- package/esm/operations/queryKeys.js +0 -127
- package/esm/operations/queryKeys.js.map +0 -1
- package/esm/operations/services.d.ts +0 -174
- package/esm/operations/services.d.ts.map +0 -1
- package/esm/operations/services.js +0 -268
- package/esm/operations/services.js.map +0 -1
- package/esm/searchManagementClient.d.ts +0 -22
- package/esm/searchManagementClient.d.ts.map +0 -1
- package/esm/searchManagementClient.js +0 -37
- package/esm/searchManagementClient.js.map +0 -1
- package/esm/searchManagementClientContext.d.ts +0 -17
- package/esm/searchManagementClientContext.d.ts.map +0 -1
- package/esm/searchManagementClientContext.js +0 -57
- package/esm/searchManagementClientContext.js.map +0 -1
- package/lib/models/adminKeysMappers.ts +0 -15
- package/lib/models/index.ts +0 -842
- package/lib/models/mappers.ts +0 -462
- package/lib/models/operationsMappers.ts +0 -17
- package/lib/models/parameters.ts +0 -109
- package/lib/models/queryKeysMappers.ts +0 -16
- package/lib/models/servicesMappers.ts +0 -22
- package/lib/operations/adminKeys.ts +0 -167
- package/lib/operations/operations.ts +0 -74
- package/lib/operations/queryKeys.ts +0 -234
- package/lib/operations/services.ts +0 -439
- package/lib/searchManagementClient.ts +0 -49
- package/lib/searchManagementClientContext.ts +0 -63
|
@@ -0,0 +1,1104 @@
|
|
|
1
|
+
import * as coreAuth from '@azure/core-auth';
|
|
2
|
+
import * as coreClient from '@azure/core-client';
|
|
3
|
+
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
4
|
+
import { PollerLike } from '@azure/core-lro';
|
|
5
|
+
import { PollOperationState } from '@azure/core-lro';
|
|
6
|
+
|
|
7
|
+
/** Defines values for AdminKeyKind. */
|
|
8
|
+
export declare type AdminKeyKind = "primary" | "secondary";
|
|
9
|
+
|
|
10
|
+
/** Response containing the primary and secondary admin API keys for a given Azure Cognitive Search service. */
|
|
11
|
+
export declare interface AdminKeyResult {
|
|
12
|
+
/**
|
|
13
|
+
* The primary admin API key of the search service.
|
|
14
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
15
|
+
*/
|
|
16
|
+
readonly primaryKey?: string;
|
|
17
|
+
/**
|
|
18
|
+
* The secondary admin API key of the search service.
|
|
19
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
20
|
+
*/
|
|
21
|
+
readonly secondaryKey?: string;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/** Interface representing a AdminKeys. */
|
|
25
|
+
export declare interface AdminKeys {
|
|
26
|
+
/**
|
|
27
|
+
* Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service.
|
|
28
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
29
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
30
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
31
|
+
* specified resource group.
|
|
32
|
+
* @param options The options parameters.
|
|
33
|
+
*/
|
|
34
|
+
get(resourceGroupName: string, searchServiceName: string, options?: AdminKeysGetOptionalParams): Promise<AdminKeysGetResponse>;
|
|
35
|
+
/**
|
|
36
|
+
* Regenerates either the primary or secondary admin API key. You can only regenerate one key at a
|
|
37
|
+
* time.
|
|
38
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
39
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
40
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
41
|
+
* specified resource group.
|
|
42
|
+
* @param keyKind Specifies which key to regenerate. Valid values include 'primary' and 'secondary'.
|
|
43
|
+
* @param options The options parameters.
|
|
44
|
+
*/
|
|
45
|
+
regenerate(resourceGroupName: string, searchServiceName: string, keyKind: AdminKeyKind, options?: AdminKeysRegenerateOptionalParams): Promise<AdminKeysRegenerateResponse>;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/** Optional parameters. */
|
|
49
|
+
export declare interface AdminKeysGetOptionalParams extends coreClient.OperationOptions {
|
|
50
|
+
/** Parameter group */
|
|
51
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/** Contains response data for the get operation. */
|
|
55
|
+
export declare type AdminKeysGetResponse = AdminKeyResult;
|
|
56
|
+
|
|
57
|
+
/** Optional parameters. */
|
|
58
|
+
export declare interface AdminKeysRegenerateOptionalParams extends coreClient.OperationOptions {
|
|
59
|
+
/** Parameter group */
|
|
60
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/** Contains response data for the regenerate operation. */
|
|
64
|
+
export declare type AdminKeysRegenerateResponse = AdminKeyResult;
|
|
65
|
+
|
|
66
|
+
/** The details of a long running asynchronous shared private link resource operation */
|
|
67
|
+
export declare interface AsyncOperationResult {
|
|
68
|
+
/** The current status of the long running asynchronous shared private link resource operation. */
|
|
69
|
+
status?: SharedPrivateLinkResourceAsyncOperationResult;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/** Input of check name availability API. */
|
|
73
|
+
export declare interface CheckNameAvailabilityInput {
|
|
74
|
+
/** The search service name to validate. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. */
|
|
75
|
+
name: string;
|
|
76
|
+
/** The type of the resource whose name is to be validated. This value must always be 'searchServices'. */
|
|
77
|
+
type: "searchServices";
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
/** Output of check name availability API. */
|
|
81
|
+
export declare interface CheckNameAvailabilityOutput {
|
|
82
|
+
/**
|
|
83
|
+
* A value indicating whether the name is available.
|
|
84
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
85
|
+
*/
|
|
86
|
+
readonly isNameAvailable?: boolean;
|
|
87
|
+
/**
|
|
88
|
+
* The reason why the name is not available. 'Invalid' indicates the name provided does not match the naming requirements (incorrect length, unsupported characters, etc.). 'AlreadyExists' indicates that the name is already in use and is therefore unavailable.
|
|
89
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
90
|
+
*/
|
|
91
|
+
readonly reason?: UnavailableNameReason;
|
|
92
|
+
/**
|
|
93
|
+
* A message that explains why the name is invalid and provides resource naming requirements. Available only if 'Invalid' is returned in the 'reason' property.
|
|
94
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
95
|
+
*/
|
|
96
|
+
readonly message?: string;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
/** Contains information about an API error. */
|
|
100
|
+
export declare interface CloudError {
|
|
101
|
+
/** Describes a particular API error with an error code and a message. */
|
|
102
|
+
error?: CloudErrorBody;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/** Describes a particular API error with an error code and a message. */
|
|
106
|
+
export declare interface CloudErrorBody {
|
|
107
|
+
/** An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. */
|
|
108
|
+
code?: string;
|
|
109
|
+
/** A message that describes the error in detail and provides debugging information. */
|
|
110
|
+
message?: string;
|
|
111
|
+
/** The target of the particular error (for example, the name of the property in error). */
|
|
112
|
+
target?: string;
|
|
113
|
+
/** Contains nested errors that are related to this error. */
|
|
114
|
+
details?: CloudErrorBody[];
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
/** Defines values for HostingMode. */
|
|
118
|
+
export declare type HostingMode = "default" | "highDensity";
|
|
119
|
+
|
|
120
|
+
/** Identity for the resource. */
|
|
121
|
+
export declare interface Identity {
|
|
122
|
+
/**
|
|
123
|
+
* The principal ID of resource identity.
|
|
124
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
125
|
+
*/
|
|
126
|
+
readonly principalId?: string;
|
|
127
|
+
/**
|
|
128
|
+
* The tenant ID of resource.
|
|
129
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
130
|
+
*/
|
|
131
|
+
readonly tenantId?: string;
|
|
132
|
+
/** The identity type. */
|
|
133
|
+
type: IdentityType;
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
/** Defines values for IdentityType. */
|
|
137
|
+
export declare type IdentityType = "None" | "SystemAssigned";
|
|
138
|
+
|
|
139
|
+
/** The IP restriction rule of the Azure Cognitive Search service. */
|
|
140
|
+
export declare interface IpRule {
|
|
141
|
+
/** 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. */
|
|
142
|
+
value?: string;
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
/** Known values of {@link SharedPrivateLinkResourceAsyncOperationResult} that the service accepts. */
|
|
146
|
+
export declare enum KnownSharedPrivateLinkResourceAsyncOperationResult {
|
|
147
|
+
Running = "Running",
|
|
148
|
+
Succeeded = "Succeeded",
|
|
149
|
+
Failed = "Failed"
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
/** Known values of {@link UnavailableNameReason} that the service accepts. */
|
|
153
|
+
export declare enum KnownUnavailableNameReason {
|
|
154
|
+
Invalid = "Invalid",
|
|
155
|
+
AlreadyExists = "AlreadyExists"
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
/** Response containing the query API keys for a given Azure Cognitive Search service. */
|
|
159
|
+
export declare interface ListQueryKeysResult {
|
|
160
|
+
/**
|
|
161
|
+
* The query keys for the Azure Cognitive Search service.
|
|
162
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
163
|
+
*/
|
|
164
|
+
readonly value?: QueryKey[];
|
|
165
|
+
/**
|
|
166
|
+
* Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size.
|
|
167
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
168
|
+
*/
|
|
169
|
+
readonly nextLink?: string;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
/** Network specific rules that determine how the Azure Cognitive Search service may be reached. */
|
|
173
|
+
export declare interface NetworkRuleSet {
|
|
174
|
+
/** 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. */
|
|
175
|
+
ipRules?: IpRule[];
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
/** Describes a REST API operation. */
|
|
179
|
+
export declare interface Operation {
|
|
180
|
+
/**
|
|
181
|
+
* The name of the operation. This name is of the form {provider}/{resource}/{operation}.
|
|
182
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
183
|
+
*/
|
|
184
|
+
readonly name?: string;
|
|
185
|
+
/**
|
|
186
|
+
* The object that describes the operation.
|
|
187
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
188
|
+
*/
|
|
189
|
+
readonly display?: OperationDisplay;
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
/** The object that describes the operation. */
|
|
193
|
+
export declare interface OperationDisplay {
|
|
194
|
+
/**
|
|
195
|
+
* The friendly name of the resource provider.
|
|
196
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
197
|
+
*/
|
|
198
|
+
readonly provider?: string;
|
|
199
|
+
/**
|
|
200
|
+
* The operation type: read, write, delete, listKeys/action, etc.
|
|
201
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
202
|
+
*/
|
|
203
|
+
readonly operation?: string;
|
|
204
|
+
/**
|
|
205
|
+
* The resource type on which the operation is performed.
|
|
206
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
207
|
+
*/
|
|
208
|
+
readonly resource?: string;
|
|
209
|
+
/**
|
|
210
|
+
* The friendly name of the operation.
|
|
211
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
212
|
+
*/
|
|
213
|
+
readonly description?: string;
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
/** 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. */
|
|
217
|
+
export declare interface OperationListResult {
|
|
218
|
+
/**
|
|
219
|
+
* The list of operations supported by the resource provider.
|
|
220
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
221
|
+
*/
|
|
222
|
+
readonly value?: Operation[];
|
|
223
|
+
/**
|
|
224
|
+
* The URL to get the next set of operation list results, if any.
|
|
225
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
226
|
+
*/
|
|
227
|
+
readonly nextLink?: string;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
/** Interface representing a Operations. */
|
|
231
|
+
export declare interface Operations {
|
|
232
|
+
/**
|
|
233
|
+
* Lists all of the available REST API operations of the Microsoft.Search provider.
|
|
234
|
+
* @param options The options parameters.
|
|
235
|
+
*/
|
|
236
|
+
list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
/** Optional parameters. */
|
|
240
|
+
export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
/** Contains response data for the list operation. */
|
|
244
|
+
export declare type OperationsListResponse = OperationListResult;
|
|
245
|
+
|
|
246
|
+
/** Describes an existing Private Endpoint connection to the Azure Cognitive Search service. */
|
|
247
|
+
export declare type PrivateEndpointConnection = Resource & {
|
|
248
|
+
/** Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. */
|
|
249
|
+
properties?: PrivateEndpointConnectionProperties;
|
|
250
|
+
};
|
|
251
|
+
|
|
252
|
+
/** Response containing a list of Private Endpoint connections. */
|
|
253
|
+
export declare interface PrivateEndpointConnectionListResult {
|
|
254
|
+
/**
|
|
255
|
+
* The list of Private Endpoint connections.
|
|
256
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
257
|
+
*/
|
|
258
|
+
readonly value?: PrivateEndpointConnection[];
|
|
259
|
+
/**
|
|
260
|
+
* Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.
|
|
261
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
262
|
+
*/
|
|
263
|
+
readonly nextLink?: string;
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
/** Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. */
|
|
267
|
+
export declare interface PrivateEndpointConnectionProperties {
|
|
268
|
+
/** The private endpoint resource from Microsoft.Network provider. */
|
|
269
|
+
privateEndpoint?: PrivateEndpointConnectionPropertiesPrivateEndpoint;
|
|
270
|
+
/** Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint. */
|
|
271
|
+
privateLinkServiceConnectionState?: PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState;
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
/** The private endpoint resource from Microsoft.Network provider. */
|
|
275
|
+
export declare interface PrivateEndpointConnectionPropertiesPrivateEndpoint {
|
|
276
|
+
/** The resource id of the private endpoint resource from Microsoft.Network provider. */
|
|
277
|
+
id?: string;
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
/** Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint. */
|
|
281
|
+
export declare interface PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState {
|
|
282
|
+
/** Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. */
|
|
283
|
+
status?: PrivateLinkServiceConnectionStatus;
|
|
284
|
+
/** The description for the private link service connection state. */
|
|
285
|
+
description?: string;
|
|
286
|
+
/** A description of any extra actions that may be required. */
|
|
287
|
+
actionsRequired?: string;
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
/** Interface representing a PrivateEndpointConnections. */
|
|
291
|
+
export declare interface PrivateEndpointConnections {
|
|
292
|
+
/**
|
|
293
|
+
* Gets a list of all private endpoint connections in the given service.
|
|
294
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
295
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
296
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
297
|
+
* specified resource group.
|
|
298
|
+
* @param options The options parameters.
|
|
299
|
+
*/
|
|
300
|
+
listByService(resourceGroupName: string, searchServiceName: string, options?: PrivateEndpointConnectionsListByServiceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection>;
|
|
301
|
+
/**
|
|
302
|
+
* Updates a Private Endpoint connection to the search service in the given resource group.
|
|
303
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
304
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
305
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
306
|
+
* specified resource group.
|
|
307
|
+
* @param privateEndpointConnectionName The name of the private endpoint connection to the Azure
|
|
308
|
+
* Cognitive Search service with the specified resource group.
|
|
309
|
+
* @param privateEndpointConnection The definition of the private endpoint connection to update.
|
|
310
|
+
* @param options The options parameters.
|
|
311
|
+
*/
|
|
312
|
+
update(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateOptionalParams): Promise<PrivateEndpointConnectionsUpdateResponse>;
|
|
313
|
+
/**
|
|
314
|
+
* Gets the details of the private endpoint connection to the search service in the given resource
|
|
315
|
+
* group.
|
|
316
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
317
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
318
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
319
|
+
* specified resource group.
|
|
320
|
+
* @param privateEndpointConnectionName The name of the private endpoint connection to the Azure
|
|
321
|
+
* Cognitive Search service with the specified resource group.
|
|
322
|
+
* @param options The options parameters.
|
|
323
|
+
*/
|
|
324
|
+
get(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnectionsGetResponse>;
|
|
325
|
+
/**
|
|
326
|
+
* Disconnects the private endpoint connection and deletes it from the search service.
|
|
327
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
328
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
329
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
330
|
+
* specified resource group.
|
|
331
|
+
* @param privateEndpointConnectionName The name of the private endpoint connection to the Azure
|
|
332
|
+
* Cognitive Search service with the specified resource group.
|
|
333
|
+
* @param options The options parameters.
|
|
334
|
+
*/
|
|
335
|
+
delete(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PrivateEndpointConnectionsDeleteResponse>;
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
/** Optional parameters. */
|
|
339
|
+
export declare interface PrivateEndpointConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
|
|
340
|
+
/** Parameter group */
|
|
341
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
/** Contains response data for the delete operation. */
|
|
345
|
+
export declare type PrivateEndpointConnectionsDeleteResponse = PrivateEndpointConnection;
|
|
346
|
+
|
|
347
|
+
/** Optional parameters. */
|
|
348
|
+
export declare interface PrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions {
|
|
349
|
+
/** Parameter group */
|
|
350
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
351
|
+
}
|
|
352
|
+
|
|
353
|
+
/** Contains response data for the get operation. */
|
|
354
|
+
export declare type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection;
|
|
355
|
+
|
|
356
|
+
/** Optional parameters. */
|
|
357
|
+
export declare interface PrivateEndpointConnectionsListByServiceNextOptionalParams extends coreClient.OperationOptions {
|
|
358
|
+
/** Parameter group */
|
|
359
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
360
|
+
}
|
|
361
|
+
|
|
362
|
+
/** Contains response data for the listByServiceNext operation. */
|
|
363
|
+
export declare type PrivateEndpointConnectionsListByServiceNextResponse = PrivateEndpointConnectionListResult;
|
|
364
|
+
|
|
365
|
+
/** Optional parameters. */
|
|
366
|
+
export declare interface PrivateEndpointConnectionsListByServiceOptionalParams extends coreClient.OperationOptions {
|
|
367
|
+
/** Parameter group */
|
|
368
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
369
|
+
}
|
|
370
|
+
|
|
371
|
+
/** Contains response data for the listByService operation. */
|
|
372
|
+
export declare type PrivateEndpointConnectionsListByServiceResponse = PrivateEndpointConnectionListResult;
|
|
373
|
+
|
|
374
|
+
/** Optional parameters. */
|
|
375
|
+
export declare interface PrivateEndpointConnectionsUpdateOptionalParams extends coreClient.OperationOptions {
|
|
376
|
+
/** Parameter group */
|
|
377
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
/** Contains response data for the update operation. */
|
|
381
|
+
export declare type PrivateEndpointConnectionsUpdateResponse = PrivateEndpointConnection;
|
|
382
|
+
|
|
383
|
+
/** Describes a supported private link resource for the Azure Cognitive Search service. */
|
|
384
|
+
export declare type PrivateLinkResource = Resource & {
|
|
385
|
+
/**
|
|
386
|
+
* Describes the properties of a supported private link resource for the Azure Cognitive Search service.
|
|
387
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
388
|
+
*/
|
|
389
|
+
readonly properties?: PrivateLinkResourceProperties;
|
|
390
|
+
};
|
|
391
|
+
|
|
392
|
+
/** Describes the properties of a supported private link resource for the Azure Cognitive Search service. For a given API version, this represents the 'supported' groupIds when creating a shared private link resource. */
|
|
393
|
+
export declare interface PrivateLinkResourceProperties {
|
|
394
|
+
/**
|
|
395
|
+
* The group ID of the private link resource.
|
|
396
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
397
|
+
*/
|
|
398
|
+
readonly groupId?: string;
|
|
399
|
+
/**
|
|
400
|
+
* The list of required members of the private link resource.
|
|
401
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
402
|
+
*/
|
|
403
|
+
readonly requiredMembers?: string[];
|
|
404
|
+
/**
|
|
405
|
+
* The list of required DNS zone names of the private link resource.
|
|
406
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
407
|
+
*/
|
|
408
|
+
readonly requiredZoneNames?: string[];
|
|
409
|
+
/**
|
|
410
|
+
* The list of resources that are onboarded to private link service, that are supported by Azure Cognitive Search.
|
|
411
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
412
|
+
*/
|
|
413
|
+
readonly shareablePrivateLinkResourceTypes?: ShareablePrivateLinkResourceType[];
|
|
414
|
+
}
|
|
415
|
+
|
|
416
|
+
/** Interface representing a PrivateLinkResources. */
|
|
417
|
+
export declare interface PrivateLinkResources {
|
|
418
|
+
/**
|
|
419
|
+
* Gets a list of all supported private link resource types for the given service.
|
|
420
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
421
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
422
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
423
|
+
* specified resource group.
|
|
424
|
+
* @param options The options parameters.
|
|
425
|
+
*/
|
|
426
|
+
listSupported(resourceGroupName: string, searchServiceName: string, options?: PrivateLinkResourcesListSupportedOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource>;
|
|
427
|
+
}
|
|
428
|
+
|
|
429
|
+
/** Optional parameters. */
|
|
430
|
+
export declare interface PrivateLinkResourcesListSupportedOptionalParams extends coreClient.OperationOptions {
|
|
431
|
+
/** Parameter group */
|
|
432
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
/** Contains response data for the listSupported operation. */
|
|
436
|
+
export declare type PrivateLinkResourcesListSupportedResponse = PrivateLinkResourcesResult;
|
|
437
|
+
|
|
438
|
+
/** Response containing a list of supported Private Link Resources. */
|
|
439
|
+
export declare interface PrivateLinkResourcesResult {
|
|
440
|
+
/**
|
|
441
|
+
* The list of supported Private Link Resources.
|
|
442
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
443
|
+
*/
|
|
444
|
+
readonly value?: PrivateLinkResource[];
|
|
445
|
+
}
|
|
446
|
+
|
|
447
|
+
/** Defines values for PrivateLinkServiceConnectionStatus. */
|
|
448
|
+
export declare type PrivateLinkServiceConnectionStatus = "Pending" | "Approved" | "Rejected" | "Disconnected";
|
|
449
|
+
|
|
450
|
+
/** Defines values for ProvisioningState. */
|
|
451
|
+
export declare type ProvisioningState = "succeeded" | "provisioning" | "failed";
|
|
452
|
+
|
|
453
|
+
/** Defines values for PublicNetworkAccess. */
|
|
454
|
+
export declare type PublicNetworkAccess = "enabled" | "disabled";
|
|
455
|
+
|
|
456
|
+
/** Describes an API key for a given Azure Cognitive Search service that has permissions for query operations only. */
|
|
457
|
+
export declare interface QueryKey {
|
|
458
|
+
/**
|
|
459
|
+
* The name of the query API key; may be empty.
|
|
460
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
461
|
+
*/
|
|
462
|
+
readonly name?: string;
|
|
463
|
+
/**
|
|
464
|
+
* The value of the query API key.
|
|
465
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
466
|
+
*/
|
|
467
|
+
readonly key?: string;
|
|
468
|
+
}
|
|
469
|
+
|
|
470
|
+
/** Interface representing a QueryKeys. */
|
|
471
|
+
export declare interface QueryKeys {
|
|
472
|
+
/**
|
|
473
|
+
* Returns the list of query API keys for the given Azure Cognitive Search service.
|
|
474
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
475
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
476
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
477
|
+
* specified resource group.
|
|
478
|
+
* @param options The options parameters.
|
|
479
|
+
*/
|
|
480
|
+
listBySearchService(resourceGroupName: string, searchServiceName: string, options?: QueryKeysListBySearchServiceOptionalParams): PagedAsyncIterableIterator<QueryKey>;
|
|
481
|
+
/**
|
|
482
|
+
* Generates a new query key for the specified search service. You can create up to 50 query keys per
|
|
483
|
+
* service.
|
|
484
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
485
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
486
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
487
|
+
* specified resource group.
|
|
488
|
+
* @param name The name of the new query API key.
|
|
489
|
+
* @param options The options parameters.
|
|
490
|
+
*/
|
|
491
|
+
create(resourceGroupName: string, searchServiceName: string, name: string, options?: QueryKeysCreateOptionalParams): Promise<QueryKeysCreateResponse>;
|
|
492
|
+
/**
|
|
493
|
+
* Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for
|
|
494
|
+
* regenerating a query key is to delete and then recreate it.
|
|
495
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
496
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
497
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
498
|
+
* specified resource group.
|
|
499
|
+
* @param key The query key to be deleted. Query keys are identified by value, not by name.
|
|
500
|
+
* @param options The options parameters.
|
|
501
|
+
*/
|
|
502
|
+
delete(resourceGroupName: string, searchServiceName: string, key: string, options?: QueryKeysDeleteOptionalParams): Promise<void>;
|
|
503
|
+
}
|
|
504
|
+
|
|
505
|
+
/** Optional parameters. */
|
|
506
|
+
export declare interface QueryKeysCreateOptionalParams extends coreClient.OperationOptions {
|
|
507
|
+
/** Parameter group */
|
|
508
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
/** Contains response data for the create operation. */
|
|
512
|
+
export declare type QueryKeysCreateResponse = QueryKey;
|
|
513
|
+
|
|
514
|
+
/** Optional parameters. */
|
|
515
|
+
export declare interface QueryKeysDeleteOptionalParams extends coreClient.OperationOptions {
|
|
516
|
+
/** Parameter group */
|
|
517
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
518
|
+
}
|
|
519
|
+
|
|
520
|
+
/** Optional parameters. */
|
|
521
|
+
export declare interface QueryKeysListBySearchServiceNextOptionalParams extends coreClient.OperationOptions {
|
|
522
|
+
/** Parameter group */
|
|
523
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
524
|
+
}
|
|
525
|
+
|
|
526
|
+
/** Contains response data for the listBySearchServiceNext operation. */
|
|
527
|
+
export declare type QueryKeysListBySearchServiceNextResponse = ListQueryKeysResult;
|
|
528
|
+
|
|
529
|
+
/** Optional parameters. */
|
|
530
|
+
export declare interface QueryKeysListBySearchServiceOptionalParams extends coreClient.OperationOptions {
|
|
531
|
+
/** Parameter group */
|
|
532
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
533
|
+
}
|
|
534
|
+
|
|
535
|
+
/** Contains response data for the listBySearchService operation. */
|
|
536
|
+
export declare type QueryKeysListBySearchServiceResponse = ListQueryKeysResult;
|
|
537
|
+
|
|
538
|
+
/** Common fields that are returned in the response for all Azure Resource Manager resources */
|
|
539
|
+
export declare interface Resource {
|
|
540
|
+
/**
|
|
541
|
+
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
542
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
543
|
+
*/
|
|
544
|
+
readonly id?: string;
|
|
545
|
+
/**
|
|
546
|
+
* The name of the resource
|
|
547
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
548
|
+
*/
|
|
549
|
+
readonly name?: string;
|
|
550
|
+
/**
|
|
551
|
+
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
|
|
552
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
553
|
+
*/
|
|
554
|
+
readonly type?: string;
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
export declare class SearchManagementClient extends coreClient.ServiceClient {
|
|
558
|
+
$host: string;
|
|
559
|
+
apiVersion: string;
|
|
560
|
+
subscriptionId: string;
|
|
561
|
+
/**
|
|
562
|
+
* Initializes a new instance of the SearchManagementClient class.
|
|
563
|
+
* @param credentials Subscription credentials which uniquely identify client subscription.
|
|
564
|
+
* @param subscriptionId The unique identifier for a Microsoft Azure subscription. You can obtain this
|
|
565
|
+
* value from the Azure Resource Manager API or the portal.
|
|
566
|
+
* @param options The parameter options
|
|
567
|
+
*/
|
|
568
|
+
constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: SearchManagementClientOptionalParams);
|
|
569
|
+
operations: Operations;
|
|
570
|
+
adminKeys: AdminKeys;
|
|
571
|
+
queryKeys: QueryKeys;
|
|
572
|
+
services: Services;
|
|
573
|
+
privateLinkResources: PrivateLinkResources;
|
|
574
|
+
privateEndpointConnections: PrivateEndpointConnections;
|
|
575
|
+
sharedPrivateLinkResources: SharedPrivateLinkResources;
|
|
576
|
+
}
|
|
577
|
+
|
|
578
|
+
/** Optional parameters. */
|
|
579
|
+
export declare interface SearchManagementClientOptionalParams extends coreClient.ServiceClientOptions {
|
|
580
|
+
/** server parameter */
|
|
581
|
+
$host?: string;
|
|
582
|
+
/** Api Version */
|
|
583
|
+
apiVersion?: string;
|
|
584
|
+
/** Overrides client endpoint. */
|
|
585
|
+
endpoint?: string;
|
|
586
|
+
}
|
|
587
|
+
|
|
588
|
+
/** Parameter group */
|
|
589
|
+
export declare interface SearchManagementRequestOptions {
|
|
590
|
+
/** 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. */
|
|
591
|
+
clientRequestId?: string;
|
|
592
|
+
}
|
|
593
|
+
|
|
594
|
+
/** Describes an Azure Cognitive Search service and its current state. */
|
|
595
|
+
export declare type SearchService = TrackedResource & {
|
|
596
|
+
/** The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. */
|
|
597
|
+
sku?: Sku;
|
|
598
|
+
/** The identity of the resource. */
|
|
599
|
+
identity?: Identity;
|
|
600
|
+
/** 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. */
|
|
601
|
+
replicaCount?: number;
|
|
602
|
+
/** The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3. */
|
|
603
|
+
partitionCount?: number;
|
|
604
|
+
/** Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'. */
|
|
605
|
+
hostingMode?: HostingMode;
|
|
606
|
+
/** 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. */
|
|
607
|
+
publicNetworkAccess?: PublicNetworkAccess;
|
|
608
|
+
/**
|
|
609
|
+
* The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
|
|
610
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
611
|
+
*/
|
|
612
|
+
readonly status?: SearchServiceStatus;
|
|
613
|
+
/**
|
|
614
|
+
* The details of the search service status.
|
|
615
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
616
|
+
*/
|
|
617
|
+
readonly statusDetails?: string;
|
|
618
|
+
/**
|
|
619
|
+
* The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
|
|
620
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
621
|
+
*/
|
|
622
|
+
readonly provisioningState?: ProvisioningState;
|
|
623
|
+
/** Network specific rules that determine how the Azure Cognitive Search service may be reached. */
|
|
624
|
+
networkRuleSet?: NetworkRuleSet;
|
|
625
|
+
/**
|
|
626
|
+
* The list of private endpoint connections to the Azure Cognitive Search service.
|
|
627
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
628
|
+
*/
|
|
629
|
+
readonly privateEndpointConnections?: PrivateEndpointConnection[];
|
|
630
|
+
/**
|
|
631
|
+
* The list of shared private link resources managed by the Azure Cognitive Search service.
|
|
632
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
633
|
+
*/
|
|
634
|
+
readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
|
|
635
|
+
};
|
|
636
|
+
|
|
637
|
+
/** Response containing a list of Azure Cognitive Search services. */
|
|
638
|
+
export declare interface SearchServiceListResult {
|
|
639
|
+
/**
|
|
640
|
+
* The list of search services.
|
|
641
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
642
|
+
*/
|
|
643
|
+
readonly value?: SearchService[];
|
|
644
|
+
/**
|
|
645
|
+
* Request URL that can be used to query next page of search services. Returned when the total number of requested search services exceed maximum page size.
|
|
646
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
647
|
+
*/
|
|
648
|
+
readonly nextLink?: string;
|
|
649
|
+
}
|
|
650
|
+
|
|
651
|
+
/** Defines values for SearchServiceStatus. */
|
|
652
|
+
export declare type SearchServiceStatus = "running" | "provisioning" | "deleting" | "degraded" | "disabled" | "error";
|
|
653
|
+
|
|
654
|
+
/** The parameters used to update an Azure Cognitive Search service. */
|
|
655
|
+
export declare type SearchServiceUpdate = Resource & {
|
|
656
|
+
/** The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. */
|
|
657
|
+
sku?: Sku;
|
|
658
|
+
/** 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. */
|
|
659
|
+
location?: string;
|
|
660
|
+
/** Tags to help categorize the resource in the Azure portal. */
|
|
661
|
+
tags?: {
|
|
662
|
+
[propertyName: string]: string;
|
|
663
|
+
};
|
|
664
|
+
/** The identity of the resource. */
|
|
665
|
+
identity?: Identity;
|
|
666
|
+
/** 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. */
|
|
667
|
+
replicaCount?: number;
|
|
668
|
+
/** The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3. */
|
|
669
|
+
partitionCount?: number;
|
|
670
|
+
/** Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'. */
|
|
671
|
+
hostingMode?: HostingMode;
|
|
672
|
+
/** 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. */
|
|
673
|
+
publicNetworkAccess?: PublicNetworkAccess;
|
|
674
|
+
/**
|
|
675
|
+
* The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
|
|
676
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
677
|
+
*/
|
|
678
|
+
readonly status?: SearchServiceStatus;
|
|
679
|
+
/**
|
|
680
|
+
* The details of the search service status.
|
|
681
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
682
|
+
*/
|
|
683
|
+
readonly statusDetails?: string;
|
|
684
|
+
/**
|
|
685
|
+
* The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
|
|
686
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
687
|
+
*/
|
|
688
|
+
readonly provisioningState?: ProvisioningState;
|
|
689
|
+
/** Network specific rules that determine how the Azure Cognitive Search service may be reached. */
|
|
690
|
+
networkRuleSet?: NetworkRuleSet;
|
|
691
|
+
/**
|
|
692
|
+
* The list of private endpoint connections to the Azure Cognitive Search service.
|
|
693
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
694
|
+
*/
|
|
695
|
+
readonly privateEndpointConnections?: PrivateEndpointConnection[];
|
|
696
|
+
/**
|
|
697
|
+
* The list of shared private link resources managed by the Azure Cognitive Search service.
|
|
698
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
699
|
+
*/
|
|
700
|
+
readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
|
|
701
|
+
};
|
|
702
|
+
|
|
703
|
+
/** Interface representing a Services. */
|
|
704
|
+
export declare interface Services {
|
|
705
|
+
/**
|
|
706
|
+
* Gets a list of all search services in the given resource group.
|
|
707
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
708
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
709
|
+
* @param options The options parameters.
|
|
710
|
+
*/
|
|
711
|
+
listByResourceGroup(resourceGroupName: string, options?: ServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SearchService>;
|
|
712
|
+
/**
|
|
713
|
+
* Gets a list of all search services in the given subscription.
|
|
714
|
+
* @param options The options parameters.
|
|
715
|
+
*/
|
|
716
|
+
listBySubscription(options?: ServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SearchService>;
|
|
717
|
+
/**
|
|
718
|
+
* Creates or updates a search service in the given resource group. If the search service already
|
|
719
|
+
* exists, all properties will be updated with the given values.
|
|
720
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
721
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
722
|
+
* @param searchServiceName The name of the Azure Cognitive Search service to create or update. Search
|
|
723
|
+
* service names must only contain lowercase letters, digits or dashes, cannot use dash as the first
|
|
724
|
+
* two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60
|
|
725
|
+
* characters in length. Search service names must be globally unique since they are part of the
|
|
726
|
+
* service URI (https://<name>.search.windows.net). You cannot change the service name after the
|
|
727
|
+
* service is created.
|
|
728
|
+
* @param service The definition of the search service to create or update.
|
|
729
|
+
* @param options The options parameters.
|
|
730
|
+
*/
|
|
731
|
+
beginCreateOrUpdate(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ServicesCreateOrUpdateResponse>, ServicesCreateOrUpdateResponse>>;
|
|
732
|
+
/**
|
|
733
|
+
* Creates or updates a search service in the given resource group. If the search service already
|
|
734
|
+
* exists, all properties will be updated with the given values.
|
|
735
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
736
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
737
|
+
* @param searchServiceName The name of the Azure Cognitive Search service to create or update. Search
|
|
738
|
+
* service names must only contain lowercase letters, digits or dashes, cannot use dash as the first
|
|
739
|
+
* two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60
|
|
740
|
+
* characters in length. Search service names must be globally unique since they are part of the
|
|
741
|
+
* service URI (https://<name>.search.windows.net). You cannot change the service name after the
|
|
742
|
+
* service is created.
|
|
743
|
+
* @param service The definition of the search service to create or update.
|
|
744
|
+
* @param options The options parameters.
|
|
745
|
+
*/
|
|
746
|
+
beginCreateOrUpdateAndWait(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<ServicesCreateOrUpdateResponse>;
|
|
747
|
+
/**
|
|
748
|
+
* Updates an existing search service in the given resource group.
|
|
749
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
750
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
751
|
+
* @param searchServiceName The name of the Azure Cognitive Search service to update.
|
|
752
|
+
* @param service The definition of the search service to update.
|
|
753
|
+
* @param options The options parameters.
|
|
754
|
+
*/
|
|
755
|
+
update(resourceGroupName: string, searchServiceName: string, service: SearchServiceUpdate, options?: ServicesUpdateOptionalParams): Promise<ServicesUpdateResponse>;
|
|
756
|
+
/**
|
|
757
|
+
* Gets the search service with the given name in the given resource group.
|
|
758
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
759
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
760
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
761
|
+
* specified resource group.
|
|
762
|
+
* @param options The options parameters.
|
|
763
|
+
*/
|
|
764
|
+
get(resourceGroupName: string, searchServiceName: string, options?: ServicesGetOptionalParams): Promise<ServicesGetResponse>;
|
|
765
|
+
/**
|
|
766
|
+
* Deletes a search service in the given resource group, along with its associated resources.
|
|
767
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
768
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
769
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
770
|
+
* specified resource group.
|
|
771
|
+
* @param options The options parameters.
|
|
772
|
+
*/
|
|
773
|
+
delete(resourceGroupName: string, searchServiceName: string, options?: ServicesDeleteOptionalParams): Promise<void>;
|
|
774
|
+
/**
|
|
775
|
+
* Checks whether or not the given search service name is available for use. Search service names must
|
|
776
|
+
* be globally unique since they are part of the service URI (https://<name>.search.windows.net).
|
|
777
|
+
* @param name The search service name to validate. Search service names must only contain lowercase
|
|
778
|
+
* letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain
|
|
779
|
+
* consecutive dashes, and must be between 2 and 60 characters in length.
|
|
780
|
+
* @param options The options parameters.
|
|
781
|
+
*/
|
|
782
|
+
checkNameAvailability(name: string, options?: ServicesCheckNameAvailabilityOptionalParams): Promise<ServicesCheckNameAvailabilityResponse>;
|
|
783
|
+
}
|
|
784
|
+
|
|
785
|
+
/** Optional parameters. */
|
|
786
|
+
export declare interface ServicesCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
|
|
787
|
+
/** Parameter group */
|
|
788
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
789
|
+
}
|
|
790
|
+
|
|
791
|
+
/** Contains response data for the checkNameAvailability operation. */
|
|
792
|
+
export declare type ServicesCheckNameAvailabilityResponse = CheckNameAvailabilityOutput;
|
|
793
|
+
|
|
794
|
+
/** Optional parameters. */
|
|
795
|
+
export declare interface ServicesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
796
|
+
/** Parameter group */
|
|
797
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
798
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
799
|
+
updateIntervalInMs?: number;
|
|
800
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
801
|
+
resumeFrom?: string;
|
|
802
|
+
}
|
|
803
|
+
|
|
804
|
+
/** Contains response data for the createOrUpdate operation. */
|
|
805
|
+
export declare type ServicesCreateOrUpdateResponse = SearchService;
|
|
806
|
+
|
|
807
|
+
/** Optional parameters. */
|
|
808
|
+
export declare interface ServicesDeleteOptionalParams extends coreClient.OperationOptions {
|
|
809
|
+
/** Parameter group */
|
|
810
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
811
|
+
}
|
|
812
|
+
|
|
813
|
+
/** Optional parameters. */
|
|
814
|
+
export declare interface ServicesGetOptionalParams extends coreClient.OperationOptions {
|
|
815
|
+
/** Parameter group */
|
|
816
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
817
|
+
}
|
|
818
|
+
|
|
819
|
+
/** Contains response data for the get operation. */
|
|
820
|
+
export declare type ServicesGetResponse = SearchService;
|
|
821
|
+
|
|
822
|
+
/** Optional parameters. */
|
|
823
|
+
export declare interface ServicesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
|
|
824
|
+
/** Parameter group */
|
|
825
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
826
|
+
}
|
|
827
|
+
|
|
828
|
+
/** Contains response data for the listByResourceGroupNext operation. */
|
|
829
|
+
export declare type ServicesListByResourceGroupNextResponse = SearchServiceListResult;
|
|
830
|
+
|
|
831
|
+
/** Optional parameters. */
|
|
832
|
+
export declare interface ServicesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
|
|
833
|
+
/** Parameter group */
|
|
834
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
835
|
+
}
|
|
836
|
+
|
|
837
|
+
/** Contains response data for the listByResourceGroup operation. */
|
|
838
|
+
export declare type ServicesListByResourceGroupResponse = SearchServiceListResult;
|
|
839
|
+
|
|
840
|
+
/** Optional parameters. */
|
|
841
|
+
export declare interface ServicesListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
|
|
842
|
+
/** Parameter group */
|
|
843
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
844
|
+
}
|
|
845
|
+
|
|
846
|
+
/** Contains response data for the listBySubscriptionNext operation. */
|
|
847
|
+
export declare type ServicesListBySubscriptionNextResponse = SearchServiceListResult;
|
|
848
|
+
|
|
849
|
+
/** Optional parameters. */
|
|
850
|
+
export declare interface ServicesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
|
|
851
|
+
/** Parameter group */
|
|
852
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
853
|
+
}
|
|
854
|
+
|
|
855
|
+
/** Contains response data for the listBySubscription operation. */
|
|
856
|
+
export declare type ServicesListBySubscriptionResponse = SearchServiceListResult;
|
|
857
|
+
|
|
858
|
+
/** Optional parameters. */
|
|
859
|
+
export declare interface ServicesUpdateOptionalParams extends coreClient.OperationOptions {
|
|
860
|
+
/** Parameter group */
|
|
861
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
862
|
+
}
|
|
863
|
+
|
|
864
|
+
/** Contains response data for the update operation. */
|
|
865
|
+
export declare type ServicesUpdateResponse = SearchService;
|
|
866
|
+
|
|
867
|
+
/** Describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search. */
|
|
868
|
+
export declare interface ShareablePrivateLinkResourceProperties {
|
|
869
|
+
/**
|
|
870
|
+
* The resource provider type for the resource that has been onboarded to private link service, supported by Azure Cognitive Search.
|
|
871
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
872
|
+
*/
|
|
873
|
+
readonly type?: string;
|
|
874
|
+
/**
|
|
875
|
+
* The resource provider group id for the resource that has been onboarded to private link service, supported by Azure Cognitive Search.
|
|
876
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
877
|
+
*/
|
|
878
|
+
readonly groupId?: string;
|
|
879
|
+
/**
|
|
880
|
+
* The description of the resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
|
|
881
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
882
|
+
*/
|
|
883
|
+
readonly description?: string;
|
|
884
|
+
}
|
|
885
|
+
|
|
886
|
+
/** Describes an resource type that has been onboarded to private link service, supported by Azure Cognitive Search. */
|
|
887
|
+
export declare interface ShareablePrivateLinkResourceType {
|
|
888
|
+
/**
|
|
889
|
+
* The name of the resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
|
|
890
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
891
|
+
*/
|
|
892
|
+
readonly name?: string;
|
|
893
|
+
/**
|
|
894
|
+
* Describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
|
|
895
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
896
|
+
*/
|
|
897
|
+
readonly properties?: ShareablePrivateLinkResourceProperties;
|
|
898
|
+
}
|
|
899
|
+
|
|
900
|
+
/** Describes a Shared Private Link Resource managed by the Azure Cognitive Search service. */
|
|
901
|
+
export declare type SharedPrivateLinkResource = Resource & {
|
|
902
|
+
/** Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service. */
|
|
903
|
+
properties?: SharedPrivateLinkResourceProperties;
|
|
904
|
+
};
|
|
905
|
+
|
|
906
|
+
/**
|
|
907
|
+
* Defines values for SharedPrivateLinkResourceAsyncOperationResult. \
|
|
908
|
+
* {@link KnownSharedPrivateLinkResourceAsyncOperationResult} can be used interchangeably with SharedPrivateLinkResourceAsyncOperationResult,
|
|
909
|
+
* this enum contains the known values that the service supports.
|
|
910
|
+
* ### Known values supported by the service
|
|
911
|
+
* **Running** \
|
|
912
|
+
* **Succeeded** \
|
|
913
|
+
* **Failed**
|
|
914
|
+
*/
|
|
915
|
+
export declare type SharedPrivateLinkResourceAsyncOperationResult = string;
|
|
916
|
+
|
|
917
|
+
/** Response containing a list of Shared Private Link Resources. */
|
|
918
|
+
export declare interface SharedPrivateLinkResourceListResult {
|
|
919
|
+
/**
|
|
920
|
+
* The list of Shared Private Link Resources.
|
|
921
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
922
|
+
*/
|
|
923
|
+
readonly value?: SharedPrivateLinkResource[];
|
|
924
|
+
/** The URL to get the next set of shared private link resources, if there are any. */
|
|
925
|
+
nextLink?: string;
|
|
926
|
+
}
|
|
927
|
+
|
|
928
|
+
/** Describes the properties of an existing Shared Private Link Resource managed by the Azure Cognitive Search service. */
|
|
929
|
+
export declare interface SharedPrivateLinkResourceProperties {
|
|
930
|
+
/** The resource id of the resource the shared private link resource is for. */
|
|
931
|
+
privateLinkResourceId?: string;
|
|
932
|
+
/** The group id from the provider of resource the shared private link resource is for. */
|
|
933
|
+
groupId?: string;
|
|
934
|
+
/** The request message for requesting approval of the shared private link resource. */
|
|
935
|
+
requestMessage?: string;
|
|
936
|
+
/** Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service). */
|
|
937
|
+
resourceRegion?: string;
|
|
938
|
+
/** Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. */
|
|
939
|
+
status?: SharedPrivateLinkResourceStatus;
|
|
940
|
+
/** The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete. */
|
|
941
|
+
provisioningState?: SharedPrivateLinkResourceProvisioningState;
|
|
942
|
+
}
|
|
943
|
+
|
|
944
|
+
/** Defines values for SharedPrivateLinkResourceProvisioningState. */
|
|
945
|
+
export declare type SharedPrivateLinkResourceProvisioningState = "Updating" | "Deleting" | "Failed" | "Succeeded" | "Incomplete";
|
|
946
|
+
|
|
947
|
+
/** Interface representing a SharedPrivateLinkResources. */
|
|
948
|
+
export declare interface SharedPrivateLinkResources {
|
|
949
|
+
/**
|
|
950
|
+
* Gets a list of all shared private link resources managed by the given service.
|
|
951
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
952
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
953
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
954
|
+
* specified resource group.
|
|
955
|
+
* @param options The options parameters.
|
|
956
|
+
*/
|
|
957
|
+
listByService(resourceGroupName: string, searchServiceName: string, options?: SharedPrivateLinkResourcesListByServiceOptionalParams): PagedAsyncIterableIterator<SharedPrivateLinkResource>;
|
|
958
|
+
/**
|
|
959
|
+
* Initiates the creation or update of a shared private link resource managed by the search service in
|
|
960
|
+
* the given resource group.
|
|
961
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
962
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
963
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
964
|
+
* specified resource group.
|
|
965
|
+
* @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
|
|
966
|
+
* Azure Cognitive Search service within the specified resource group.
|
|
967
|
+
* @param sharedPrivateLinkResource The definition of the shared private link resource to create or
|
|
968
|
+
* update.
|
|
969
|
+
* @param options The options parameters.
|
|
970
|
+
*/
|
|
971
|
+
beginCreateOrUpdate(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, sharedPrivateLinkResource: SharedPrivateLinkResource, options?: SharedPrivateLinkResourcesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<SharedPrivateLinkResourcesCreateOrUpdateResponse>, SharedPrivateLinkResourcesCreateOrUpdateResponse>>;
|
|
972
|
+
/**
|
|
973
|
+
* Initiates the creation or update of a shared private link resource managed by the search service in
|
|
974
|
+
* the given resource group.
|
|
975
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
976
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
977
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
978
|
+
* specified resource group.
|
|
979
|
+
* @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
|
|
980
|
+
* Azure Cognitive Search service within the specified resource group.
|
|
981
|
+
* @param sharedPrivateLinkResource The definition of the shared private link resource to create or
|
|
982
|
+
* update.
|
|
983
|
+
* @param options The options parameters.
|
|
984
|
+
*/
|
|
985
|
+
beginCreateOrUpdateAndWait(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, sharedPrivateLinkResource: SharedPrivateLinkResource, options?: SharedPrivateLinkResourcesCreateOrUpdateOptionalParams): Promise<SharedPrivateLinkResourcesCreateOrUpdateResponse>;
|
|
986
|
+
/**
|
|
987
|
+
* Gets the details of the shared private link resource managed by the search service in the given
|
|
988
|
+
* resource group.
|
|
989
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
990
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
991
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
992
|
+
* specified resource group.
|
|
993
|
+
* @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
|
|
994
|
+
* Azure Cognitive Search service within the specified resource group.
|
|
995
|
+
* @param options The options parameters.
|
|
996
|
+
*/
|
|
997
|
+
get(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesGetOptionalParams): Promise<SharedPrivateLinkResourcesGetResponse>;
|
|
998
|
+
/**
|
|
999
|
+
* Initiates the deletion of the shared private link resource from the search service.
|
|
1000
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
1001
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
1002
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
1003
|
+
* specified resource group.
|
|
1004
|
+
* @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
|
|
1005
|
+
* Azure Cognitive Search service within the specified resource group.
|
|
1006
|
+
* @param options The options parameters.
|
|
1007
|
+
*/
|
|
1008
|
+
beginDelete(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
|
|
1009
|
+
/**
|
|
1010
|
+
* Initiates the deletion of the shared private link resource from the search service.
|
|
1011
|
+
* @param resourceGroupName The name of the resource group within the current subscription. You can
|
|
1012
|
+
* obtain this value from the Azure Resource Manager API or the portal.
|
|
1013
|
+
* @param searchServiceName The name of the Azure Cognitive Search service associated with the
|
|
1014
|
+
* specified resource group.
|
|
1015
|
+
* @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
|
|
1016
|
+
* Azure Cognitive Search service within the specified resource group.
|
|
1017
|
+
* @param options The options parameters.
|
|
1018
|
+
*/
|
|
1019
|
+
beginDeleteAndWait(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesDeleteOptionalParams): Promise<void>;
|
|
1020
|
+
}
|
|
1021
|
+
|
|
1022
|
+
/** Optional parameters. */
|
|
1023
|
+
export declare interface SharedPrivateLinkResourcesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
1024
|
+
/** Parameter group */
|
|
1025
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
1026
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
1027
|
+
updateIntervalInMs?: number;
|
|
1028
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
1029
|
+
resumeFrom?: string;
|
|
1030
|
+
}
|
|
1031
|
+
|
|
1032
|
+
/** Contains response data for the createOrUpdate operation. */
|
|
1033
|
+
export declare type SharedPrivateLinkResourcesCreateOrUpdateResponse = SharedPrivateLinkResource;
|
|
1034
|
+
|
|
1035
|
+
/** Optional parameters. */
|
|
1036
|
+
export declare interface SharedPrivateLinkResourcesDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1037
|
+
/** Parameter group */
|
|
1038
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
1039
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
1040
|
+
updateIntervalInMs?: number;
|
|
1041
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
1042
|
+
resumeFrom?: string;
|
|
1043
|
+
}
|
|
1044
|
+
|
|
1045
|
+
/** Optional parameters. */
|
|
1046
|
+
export declare interface SharedPrivateLinkResourcesGetOptionalParams extends coreClient.OperationOptions {
|
|
1047
|
+
/** Parameter group */
|
|
1048
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
1049
|
+
}
|
|
1050
|
+
|
|
1051
|
+
/** Contains response data for the get operation. */
|
|
1052
|
+
export declare type SharedPrivateLinkResourcesGetResponse = SharedPrivateLinkResource;
|
|
1053
|
+
|
|
1054
|
+
/** Optional parameters. */
|
|
1055
|
+
export declare interface SharedPrivateLinkResourcesListByServiceNextOptionalParams extends coreClient.OperationOptions {
|
|
1056
|
+
/** Parameter group */
|
|
1057
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
1058
|
+
}
|
|
1059
|
+
|
|
1060
|
+
/** Contains response data for the listByServiceNext operation. */
|
|
1061
|
+
export declare type SharedPrivateLinkResourcesListByServiceNextResponse = SharedPrivateLinkResourceListResult;
|
|
1062
|
+
|
|
1063
|
+
/** Optional parameters. */
|
|
1064
|
+
export declare interface SharedPrivateLinkResourcesListByServiceOptionalParams extends coreClient.OperationOptions {
|
|
1065
|
+
/** Parameter group */
|
|
1066
|
+
searchManagementRequestOptions?: SearchManagementRequestOptions;
|
|
1067
|
+
}
|
|
1068
|
+
|
|
1069
|
+
/** Contains response data for the listByService operation. */
|
|
1070
|
+
export declare type SharedPrivateLinkResourcesListByServiceResponse = SharedPrivateLinkResourceListResult;
|
|
1071
|
+
|
|
1072
|
+
/** Defines values for SharedPrivateLinkResourceStatus. */
|
|
1073
|
+
export declare type SharedPrivateLinkResourceStatus = "Pending" | "Approved" | "Rejected" | "Disconnected";
|
|
1074
|
+
|
|
1075
|
+
/** Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits. */
|
|
1076
|
+
export declare interface Sku {
|
|
1077
|
+
/** 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.' */
|
|
1078
|
+
name?: SkuName;
|
|
1079
|
+
}
|
|
1080
|
+
|
|
1081
|
+
/** Defines values for SkuName. */
|
|
1082
|
+
export declare type SkuName = "free" | "basic" | "standard" | "standard2" | "standard3" | "storage_optimized_l1" | "storage_optimized_l2";
|
|
1083
|
+
|
|
1084
|
+
/** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
|
|
1085
|
+
export declare type TrackedResource = Resource & {
|
|
1086
|
+
/** Resource tags. */
|
|
1087
|
+
tags?: {
|
|
1088
|
+
[propertyName: string]: string;
|
|
1089
|
+
};
|
|
1090
|
+
/** The geo-location where the resource lives */
|
|
1091
|
+
location: string;
|
|
1092
|
+
};
|
|
1093
|
+
|
|
1094
|
+
/**
|
|
1095
|
+
* Defines values for UnavailableNameReason. \
|
|
1096
|
+
* {@link KnownUnavailableNameReason} can be used interchangeably with UnavailableNameReason,
|
|
1097
|
+
* this enum contains the known values that the service supports.
|
|
1098
|
+
* ### Known values supported by the service
|
|
1099
|
+
* **Invalid** \
|
|
1100
|
+
* **AlreadyExists**
|
|
1101
|
+
*/
|
|
1102
|
+
export declare type UnavailableNameReason = string;
|
|
1103
|
+
|
|
1104
|
+
export { }
|