@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.
Files changed (154) hide show
  1. package/CHANGELOG.md +53 -0
  2. package/LICENSE +1 -1
  3. package/README.md +2 -2
  4. package/dist/index.js +1805 -777
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.min.js +1 -1
  7. package/dist/index.min.js.map +1 -1
  8. package/dist-esm/samples-dev/adminKeysGetSample.js +3 -3
  9. package/dist-esm/samples-dev/adminKeysRegenerateSample.js +1 -1
  10. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsGetSample.d.ts +2 -0
  11. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsGetSample.d.ts.map +1 -0
  12. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsGetSample.js +39 -0
  13. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsGetSample.js.map +1 -0
  14. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsListByServiceSample.d.ts +2 -0
  15. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsListByServiceSample.d.ts.map +1 -0
  16. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsListByServiceSample.js +54 -0
  17. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsListByServiceSample.js.map +1 -0
  18. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsReconcileSample.d.ts +2 -0
  19. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsReconcileSample.d.ts.map +1 -0
  20. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsReconcileSample.js +39 -0
  21. package/dist-esm/samples-dev/networkSecurityPerimeterConfigurationsReconcileSample.js.map +1 -0
  22. package/dist-esm/samples-dev/operationsListSample.js +3 -3
  23. package/dist-esm/samples-dev/operationsListSample.js.map +1 -1
  24. package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.js +1 -1
  25. package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.js +1 -1
  26. package/dist-esm/samples-dev/privateEndpointConnectionsListByServiceSample.js +1 -1
  27. package/dist-esm/samples-dev/privateEndpointConnectionsListByServiceSample.js.map +1 -1
  28. package/dist-esm/samples-dev/privateEndpointConnectionsUpdateSample.js +8 -8
  29. package/dist-esm/samples-dev/privateEndpointConnectionsUpdateSample.js.map +1 -1
  30. package/dist-esm/samples-dev/privateLinkResourcesListSupportedSample.js +1 -1
  31. package/dist-esm/samples-dev/privateLinkResourcesListSupportedSample.js.map +1 -1
  32. package/dist-esm/samples-dev/queryKeysCreateSample.js +2 -2
  33. package/dist-esm/samples-dev/queryKeysCreateSample.js.map +1 -1
  34. package/dist-esm/samples-dev/queryKeysDeleteSample.js +1 -1
  35. package/dist-esm/samples-dev/queryKeysListBySearchServiceSample.js +3 -3
  36. package/dist-esm/samples-dev/queryKeysListBySearchServiceSample.js.map +1 -1
  37. package/dist-esm/samples-dev/servicesCheckNameAvailabilitySample.js +1 -1
  38. package/dist-esm/samples-dev/servicesCreateOrUpdateSample.js +81 -19
  39. package/dist-esm/samples-dev/servicesCreateOrUpdateSample.js.map +1 -1
  40. package/dist-esm/samples-dev/servicesDeleteSample.js +1 -1
  41. package/dist-esm/samples-dev/servicesGetSample.js +1 -1
  42. package/dist-esm/samples-dev/servicesListByResourceGroupSample.js +1 -1
  43. package/dist-esm/samples-dev/servicesListByResourceGroupSample.js.map +1 -1
  44. package/dist-esm/samples-dev/servicesListBySubscriptionSample.js +1 -1
  45. package/dist-esm/samples-dev/servicesListBySubscriptionSample.js.map +1 -1
  46. package/dist-esm/samples-dev/servicesUpdateSample.js +68 -18
  47. package/dist-esm/samples-dev/servicesUpdateSample.js.map +1 -1
  48. package/dist-esm/samples-dev/sharedPrivateLinkResourcesCreateOrUpdateSample.js +4 -4
  49. package/dist-esm/samples-dev/sharedPrivateLinkResourcesCreateOrUpdateSample.js.map +1 -1
  50. package/dist-esm/samples-dev/sharedPrivateLinkResourcesDeleteSample.js +1 -1
  51. package/dist-esm/samples-dev/sharedPrivateLinkResourcesGetSample.js +1 -1
  52. package/dist-esm/samples-dev/sharedPrivateLinkResourcesListByServiceSample.js +1 -1
  53. package/dist-esm/samples-dev/sharedPrivateLinkResourcesListByServiceSample.js.map +1 -1
  54. package/dist-esm/samples-dev/usageBySubscriptionSkuSample.js +1 -1
  55. package/dist-esm/samples-dev/usagesListBySubscriptionSample.js +3 -3
  56. package/dist-esm/samples-dev/usagesListBySubscriptionSample.js.map +1 -1
  57. package/dist-esm/src/lroImpl.js +1 -1
  58. package/dist-esm/src/models/index.d.ts +508 -113
  59. package/dist-esm/src/models/index.d.ts.map +1 -1
  60. package/dist-esm/src/models/index.js +90 -12
  61. package/dist-esm/src/models/index.js.map +1 -1
  62. package/dist-esm/src/models/mappers.d.ts +19 -0
  63. package/dist-esm/src/models/mappers.d.ts.map +1 -1
  64. package/dist-esm/src/models/mappers.js +1028 -411
  65. package/dist-esm/src/models/mappers.js.map +1 -1
  66. package/dist-esm/src/models/parameters.d.ts +2 -0
  67. package/dist-esm/src/models/parameters.d.ts.map +1 -1
  68. package/dist-esm/src/models/parameters.js +85 -57
  69. package/dist-esm/src/models/parameters.js.map +1 -1
  70. package/dist-esm/src/operations/adminKeys.d.ts +5 -5
  71. package/dist-esm/src/operations/adminKeys.js +15 -15
  72. package/dist-esm/src/operations/adminKeys.js.map +1 -1
  73. package/dist-esm/src/operations/index.d.ts +1 -0
  74. package/dist-esm/src/operations/index.d.ts.map +1 -1
  75. package/dist-esm/src/operations/index.js +1 -0
  76. package/dist-esm/src/operations/index.js.map +1 -1
  77. package/dist-esm/src/operations/networkSecurityPerimeterConfigurations.d.ts +79 -0
  78. package/dist-esm/src/operations/networkSecurityPerimeterConfigurations.d.ts.map +1 -0
  79. package/dist-esm/src/operations/networkSecurityPerimeterConfigurations.js +289 -0
  80. package/dist-esm/src/operations/networkSecurityPerimeterConfigurations.js.map +1 -0
  81. package/dist-esm/src/operations/operations.js +5 -5
  82. package/dist-esm/src/operations/operations.js.map +1 -1
  83. package/dist-esm/src/operations/privateEndpointConnections.d.ts +19 -19
  84. package/dist-esm/src/operations/privateEndpointConnections.d.ts.map +1 -1
  85. package/dist-esm/src/operations/privateEndpointConnections.js +49 -49
  86. package/dist-esm/src/operations/privateEndpointConnections.js.map +1 -1
  87. package/dist-esm/src/operations/privateLinkResources.d.ts +4 -4
  88. package/dist-esm/src/operations/privateLinkResources.js +10 -10
  89. package/dist-esm/src/operations/privateLinkResources.js.map +1 -1
  90. package/dist-esm/src/operations/queryKeys.d.ts +12 -12
  91. package/dist-esm/src/operations/queryKeys.js +32 -32
  92. package/dist-esm/src/operations/queryKeys.js.map +1 -1
  93. package/dist-esm/src/operations/services.d.ts +17 -17
  94. package/dist-esm/src/operations/services.d.ts.map +1 -1
  95. package/dist-esm/src/operations/services.js +75 -75
  96. package/dist-esm/src/operations/services.js.map +1 -1
  97. package/dist-esm/src/operations/sharedPrivateLinkResources.d.ts +21 -21
  98. package/dist-esm/src/operations/sharedPrivateLinkResources.d.ts.map +1 -1
  99. package/dist-esm/src/operations/sharedPrivateLinkResources.js +62 -62
  100. package/dist-esm/src/operations/sharedPrivateLinkResources.js.map +1 -1
  101. package/dist-esm/src/operations/usages.d.ts +2 -2
  102. package/dist-esm/src/operations/usages.js +13 -13
  103. package/dist-esm/src/operations/usages.js.map +1 -1
  104. package/dist-esm/src/operationsInterfaces/adminKeys.d.ts +5 -5
  105. package/dist-esm/src/operationsInterfaces/index.d.ts +1 -0
  106. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -1
  107. package/dist-esm/src/operationsInterfaces/index.js +1 -0
  108. package/dist-esm/src/operationsInterfaces/index.js.map +1 -1
  109. package/dist-esm/src/operationsInterfaces/networkSecurityPerimeterConfigurations.d.ts +50 -0
  110. package/dist-esm/src/operationsInterfaces/networkSecurityPerimeterConfigurations.d.ts.map +1 -0
  111. package/dist-esm/src/operationsInterfaces/networkSecurityPerimeterConfigurations.js +9 -0
  112. package/dist-esm/src/operationsInterfaces/networkSecurityPerimeterConfigurations.js.map +1 -0
  113. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts +15 -15
  114. package/dist-esm/src/operationsInterfaces/privateLinkResources.d.ts +2 -2
  115. package/dist-esm/src/operationsInterfaces/queryKeys.d.ts +7 -7
  116. package/dist-esm/src/operationsInterfaces/services.d.ts +17 -17
  117. package/dist-esm/src/operationsInterfaces/sharedPrivateLinkResources.d.ts +17 -17
  118. package/dist-esm/src/operationsInterfaces/usages.d.ts +1 -1
  119. package/dist-esm/src/pagingHelper.js.map +1 -1
  120. package/dist-esm/src/searchManagementClient.d.ts +3 -2
  121. package/dist-esm/src/searchManagementClient.d.ts.map +1 -1
  122. package/dist-esm/src/searchManagementClient.js +17 -15
  123. package/dist-esm/src/searchManagementClient.js.map +1 -1
  124. package/dist-esm/test/search_examples.js.map +1 -1
  125. package/package.json +12 -11
  126. package/review/arm-search.api.md +270 -6
  127. package/src/lroImpl.ts +3 -3
  128. package/src/models/index.ts +573 -140
  129. package/src/models/mappers.ts +1217 -561
  130. package/src/models/parameters.ts +90 -58
  131. package/src/operations/adminKeys.ts +22 -24
  132. package/src/operations/index.ts +1 -0
  133. package/src/operations/networkSecurityPerimeterConfigurations.ts +400 -0
  134. package/src/operations/operations.ts +10 -10
  135. package/src/operations/privateEndpointConnections.ts +74 -77
  136. package/src/operations/privateLinkResources.ts +21 -22
  137. package/src/operations/queryKeys.ts +52 -55
  138. package/src/operations/services.ts +118 -126
  139. package/src/operations/sharedPrivateLinkResources.ts +103 -108
  140. package/src/operations/usages.ts +24 -25
  141. package/src/operationsInterfaces/adminKeys.ts +8 -8
  142. package/src/operationsInterfaces/index.ts +1 -0
  143. package/src/operationsInterfaces/networkSecurityPerimeterConfigurations.ts +90 -0
  144. package/src/operationsInterfaces/operations.ts +1 -1
  145. package/src/operationsInterfaces/privateEndpointConnections.ts +20 -20
  146. package/src/operationsInterfaces/privateLinkResources.ts +4 -4
  147. package/src/operationsInterfaces/queryKeys.ts +11 -11
  148. package/src/operationsInterfaces/services.ts +26 -26
  149. package/src/operationsInterfaces/sharedPrivateLinkResources.ts +24 -24
  150. package/src/operationsInterfaces/usages.ts +3 -3
  151. package/src/pagingHelper.ts +1 -1
  152. package/src/searchManagementClient.ts +33 -28
  153. package/types/arm-search.d.ts +650 -171
  154. package/types/tsdoc-metadata.json +1 -1
@@ -10,7 +10,7 @@ export declare type AadAuthFailureMode = "http403" | "http401WithBearerChallenge
10
10
  /** Defines values for AdminKeyKind. */
11
11
  export declare type AdminKeyKind = "primary" | "secondary";
12
12
 
13
- /** Response containing the primary and secondary admin API keys for a given Azure Cognitive Search service. */
13
+ /** Response containing the primary and secondary admin API keys for a given Azure AI Search service. */
14
14
  export declare interface AdminKeyResult {
15
15
  /**
16
16
  * The primary admin API key of the search service.
@@ -27,11 +27,11 @@ export declare interface AdminKeyResult {
27
27
  /** Interface representing a AdminKeys. */
28
28
  export declare interface AdminKeys {
29
29
  /**
30
- * Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service.
30
+ * Gets the primary and secondary admin API keys for the specified Azure AI Search service.
31
31
  * @param resourceGroupName The name of the resource group within the current subscription. You can
32
32
  * obtain this value from the Azure Resource Manager API or the portal.
33
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
34
- * specified resource group.
33
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
34
+ * resource group.
35
35
  * @param options The options parameters.
36
36
  */
37
37
  get(resourceGroupName: string, searchServiceName: string, options?: AdminKeysGetOptionalParams): Promise<AdminKeysGetResponse>;
@@ -40,8 +40,8 @@ export declare interface AdminKeys {
40
40
  * time.
41
41
  * @param resourceGroupName The name of the resource group within the current subscription. You can
42
42
  * obtain this value from the Azure Resource Manager API or the portal.
43
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
44
- * specified resource group.
43
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
44
+ * resource group.
45
45
  * @param keyKind Specifies which key to regenerate. Valid values include 'primary' and 'secondary'.
46
46
  * @param options The options parameters.
47
47
  */
@@ -66,7 +66,7 @@ export declare interface AdminKeysRegenerateOptionalParams extends coreClient.Op
66
66
  /** Contains response data for the regenerate operation. */
67
67
  export declare type AdminKeysRegenerateResponse = AdminKeyResult;
68
68
 
69
- /** The details of a long running asynchronous shared private link resource operation */
69
+ /** The details of a long running asynchronous shared private link resource operation. */
70
70
  export declare interface AsyncOperationResult {
71
71
  /** The current status of the long running asynchronous shared private link resource operation. */
72
72
  status?: SharedPrivateLinkResourceAsyncOperationResult;
@@ -103,6 +103,8 @@ export declare interface CheckNameAvailabilityOutput {
103
103
  export declare interface CloudError {
104
104
  /** Describes a particular API error with an error code and a message. */
105
105
  error?: CloudErrorBody;
106
+ /** A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). */
107
+ message?: string;
106
108
  }
107
109
 
108
110
  /** Describes a particular API error with an error code and a message. */
@@ -117,26 +119,26 @@ export declare interface CloudErrorBody {
117
119
  details?: CloudErrorBody[];
118
120
  }
119
121
 
120
- /** Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. */
122
+ /** Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. */
121
123
  export declare interface DataPlaneAadOrApiKeyAuthOption {
122
- /** Describes what response the data plane API of a Search service would send for requests that failed authentication. */
124
+ /** Describes what response the data plane API of a search service would send for requests that failed authentication. */
123
125
  aadAuthFailureMode?: AadAuthFailureMode;
124
126
  }
125
127
 
126
- /** 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. */
128
+ /** Defines the options for how the search service authenticates a data plane request. This cannot be set if 'disableLocalAuth' is set to true. */
127
129
  export declare interface DataPlaneAuthOptions {
128
- /** Indicates that only the API key needs to be used for authentication. */
130
+ /** Indicates that only the API key can be used for authentication. */
129
131
  apiKeyOnly?: Record<string, unknown>;
130
- /** Indicates that either the API key or an access token from Azure Active Directory can be used for authentication. */
132
+ /** Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. */
131
133
  aadOrApiKey?: DataPlaneAadOrApiKeyAuthOption;
132
134
  }
133
135
 
134
- /** Describes a policy that determines how resources within the search service are to be encrypted with Customer Managed Keys. */
136
+ /** Describes a policy that determines how resources within the search service are to be encrypted with customer managed keys. */
135
137
  export declare interface EncryptionWithCmk {
136
- /** Describes how a search service should enforce having one or more non customer encrypted resources. */
138
+ /** Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. */
137
139
  enforcement?: SearchEncryptionWithCmk;
138
140
  /**
139
- * Describes whether the search service is compliant or not with respect to having non customer encrypted resources. If a service has more than one non customer encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'.
141
+ * 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.
140
142
  * NOTE: This property will not be serialized. It can only be populated by the server.
141
143
  */
142
144
  readonly encryptionComplianceStatus?: SearchEncryptionComplianceStatus;
@@ -154,7 +156,7 @@ export declare function getContinuationToken(page: unknown): string | undefined;
154
156
  /** Defines values for HostingMode. */
155
157
  export declare type HostingMode = "default" | "highDensity";
156
158
 
157
- /** Identity for the resource. */
159
+ /** Details about the search service identity. A null value indicates that the search service has no identity assigned. */
158
160
  export declare interface Identity {
159
161
  /**
160
162
  * The principal ID of the system-assigned identity of the search service.
@@ -166,19 +168,44 @@ export declare interface Identity {
166
168
  * NOTE: This property will not be serialized. It can only be populated by the server.
167
169
  */
168
170
  readonly tenantId?: string;
169
- /** The identity type. */
171
+ /** 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. */
170
172
  type: IdentityType;
173
+ /** 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}'. */
174
+ userAssignedIdentities?: {
175
+ [propertyName: string]: UserAssignedManagedIdentity;
176
+ };
171
177
  }
172
178
 
173
- /** Defines values for IdentityType. */
174
- export declare type IdentityType = "None" | "SystemAssigned";
179
+ /**
180
+ * Defines values for IdentityType. \
181
+ * {@link KnownIdentityType} can be used interchangeably with IdentityType,
182
+ * this enum contains the known values that the service supports.
183
+ * ### Known values supported by the service
184
+ * **None**: Indicates that any identity associated with the search service needs to be removed. \
185
+ * **SystemAssigned**: Indicates that system-assigned identity for the search service will be enabled. \
186
+ * **UserAssigned**: Indicates that one or more user assigned identities will be assigned to the search service. \
187
+ * **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.
188
+ */
189
+ export declare type IdentityType = string;
175
190
 
176
- /** The IP restriction rule of the Azure Cognitive Search service. */
191
+ /** The IP restriction rule of the Azure AI Search service. */
177
192
  export declare interface IpRule {
178
193
  /** 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. */
179
194
  value?: string;
180
195
  }
181
196
 
197
+ /** Known values of {@link IdentityType} that the service accepts. */
198
+ export declare enum KnownIdentityType {
199
+ /** Indicates that any identity associated with the search service needs to be removed. */
200
+ None = "None",
201
+ /** Indicates that system-assigned identity for the search service will be enabled. */
202
+ SystemAssigned = "SystemAssigned",
203
+ /** Indicates that one or more user assigned identities will be assigned to the search service. */
204
+ UserAssigned = "UserAssigned",
205
+ /** Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. */
206
+ SystemAssignedUserAssigned = "SystemAssigned, UserAssigned"
207
+ }
208
+
182
209
  /** Known values of {@link PrivateLinkServiceConnectionProvisioningState} that the service accepts. */
183
210
  export declare enum KnownPrivateLinkServiceConnectionProvisioningState {
184
211
  /** The private link service connection is in the process of being created along with other resources for it to be fully functional. */
@@ -191,17 +218,39 @@ export declare enum KnownPrivateLinkServiceConnectionProvisioningState {
191
218
  Succeeded = "Succeeded",
192
219
  /** Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. */
193
220
  Incomplete = "Incomplete",
194
- /** Provisioning request for the private link service connection resource has been canceled */
221
+ /** Provisioning request for the private link service connection resource has been canceled. */
195
222
  Canceled = "Canceled"
196
223
  }
197
224
 
225
+ /** Known values of {@link PublicNetworkAccess} that the service accepts. */
226
+ export declare enum KnownPublicNetworkAccess {
227
+ /** The search service is accessible from traffic originating from the public internet. */
228
+ Enabled = "enabled",
229
+ /** The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. */
230
+ Disabled = "disabled"
231
+ }
232
+
233
+ /** Known values of {@link SearchBypass} that the service accepts. */
234
+ export declare enum KnownSearchBypass {
235
+ /** Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. */
236
+ None = "None",
237
+ /** Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section. */
238
+ AzurePortal = "AzurePortal"
239
+ }
240
+
241
+ /** Known values of {@link SearchDisabledDataExfiltrationOption} that the service accepts. */
242
+ export declare enum KnownSearchDisabledDataExfiltrationOption {
243
+ /** Indicates that all data exfiltration scenarios are disabled. */
244
+ All = "All"
245
+ }
246
+
198
247
  /** Known values of {@link SearchSemanticSearch} that the service accepts. */
199
248
  export declare enum KnownSearchSemanticSearch {
200
- /** Indicates that semantic search is disabled for the search service. */
249
+ /** Indicates that semantic reranker is disabled for the search service. This is the default. */
201
250
  Disabled = "disabled",
202
- /** Enables semantic search on a search service and indicates that it is to be used within the limits of the free tier. This would cap the volume of semantic search requests and is offered at no extra charge. This is the default for newly provisioned search services. */
251
+ /** 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. */
203
252
  Free = "free",
204
- /** Enables semantic search on a search service as a billable feature, with higher throughput and volume of semantic search queries. */
253
+ /** Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. */
205
254
  Standard = "standard"
206
255
  }
207
256
 
@@ -215,18 +264,62 @@ export declare enum KnownSharedPrivateLinkResourceAsyncOperationResult {
215
264
  Failed = "Failed"
216
265
  }
217
266
 
267
+ /** Known values of {@link SharedPrivateLinkResourceProvisioningState} that the service accepts. */
268
+ export declare enum KnownSharedPrivateLinkResourceProvisioningState {
269
+ /** The shared private link resource is in the process of being created along with other resources for it to be fully functional. */
270
+ Updating = "Updating",
271
+ /** The shared private link resource is in the process of being deleted. */
272
+ Deleting = "Deleting",
273
+ /** The shared private link resource has failed to be provisioned or deleted. */
274
+ Failed = "Failed",
275
+ /** The shared private link resource has finished provisioning and is ready for approval. */
276
+ Succeeded = "Succeeded",
277
+ /** Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. */
278
+ Incomplete = "Incomplete"
279
+ }
280
+
281
+ /** Known values of {@link SharedPrivateLinkResourceStatus} that the service accepts. */
282
+ export declare enum KnownSharedPrivateLinkResourceStatus {
283
+ /** The shared private link resource has been created and is pending approval. */
284
+ Pending = "Pending",
285
+ /** The shared private link resource is approved and is ready for use. */
286
+ Approved = "Approved",
287
+ /** The shared private link resource has been rejected and cannot be used. */
288
+ Rejected = "Rejected",
289
+ /** The shared private link resource has been removed from the service. */
290
+ Disconnected = "Disconnected"
291
+ }
292
+
293
+ /** Known values of {@link SkuName} that the service accepts. */
294
+ export declare enum KnownSkuName {
295
+ /** Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. */
296
+ Free = "free",
297
+ /** Billable tier for a dedicated service having up to 3 replicas. */
298
+ Basic = "basic",
299
+ /** Billable tier for a dedicated service having up to 12 partitions and 12 replicas. */
300
+ Standard = "standard",
301
+ /** Similar to 'standard', but with more capacity per search unit. */
302
+ Standard2 = "standard2",
303
+ /** 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'). */
304
+ Standard3 = "standard3",
305
+ /** Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions. */
306
+ StorageOptimizedL1 = "storage_optimized_l1",
307
+ /** Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions. */
308
+ StorageOptimizedL2 = "storage_optimized_l2"
309
+ }
310
+
218
311
  /** Known values of {@link UnavailableNameReason} that the service accepts. */
219
312
  export declare enum KnownUnavailableNameReason {
220
- /** The search service name does not match naming requirements. */
313
+ /** The search service name doesn't match naming requirements. */
221
314
  Invalid = "Invalid",
222
315
  /** The search service name is already assigned to a different search service. */
223
316
  AlreadyExists = "AlreadyExists"
224
317
  }
225
318
 
226
- /** Response containing the query API keys for a given Azure Cognitive Search service. */
319
+ /** Response containing the query API keys for a given Azure AI Search service. */
227
320
  export declare interface ListQueryKeysResult {
228
321
  /**
229
- * The query keys for the Azure Cognitive Search service.
322
+ * The query keys for the Azure AI Search service.
230
323
  * NOTE: This property will not be serialized. It can only be populated by the server.
231
324
  */
232
325
  readonly value?: QueryKey[];
@@ -237,10 +330,182 @@ export declare interface ListQueryKeysResult {
237
330
  readonly nextLink?: string;
238
331
  }
239
332
 
240
- /** Network specific rules that determine how the Azure Cognitive Search service may be reached. */
333
+ /** Network specific rules that determine how the Azure AI Search service may be reached. */
241
334
  export declare interface NetworkRuleSet {
242
335
  /** 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. */
243
336
  ipRules?: IpRule[];
337
+ /** Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. */
338
+ bypass?: SearchBypass;
339
+ }
340
+
341
+ /** Network security perimeter configuration for a server. */
342
+ export declare interface NetworkSecurityPerimeterConfiguration extends ProxyResource {
343
+ /** NOTE: This property will not be serialized. It can only be populated by the server. */
344
+ readonly provisioningState?: string;
345
+ /** The perimeter for a network security perimeter configuration. */
346
+ networkSecurityPerimeter?: NSPConfigPerimeter;
347
+ /** The resource association for the network security perimeter. */
348
+ resourceAssociation?: NSPConfigAssociation;
349
+ /** The profile for a network security perimeter configuration. */
350
+ profile?: NSPConfigProfile;
351
+ provisioningIssues?: NSPProvisioningIssue[];
352
+ }
353
+
354
+ /** A list of network security perimeter configurations for a server. */
355
+ export declare interface NetworkSecurityPerimeterConfigurationListResult {
356
+ /**
357
+ * Array of results.
358
+ * NOTE: This property will not be serialized. It can only be populated by the server.
359
+ */
360
+ readonly value?: NetworkSecurityPerimeterConfiguration[];
361
+ /**
362
+ * Link to retrieve next page of results.
363
+ * NOTE: This property will not be serialized. It can only be populated by the server.
364
+ */
365
+ readonly nextLink?: string;
366
+ }
367
+
368
+ /** Interface representing a NetworkSecurityPerimeterConfigurations. */
369
+ export declare interface NetworkSecurityPerimeterConfigurations {
370
+ /**
371
+ * Gets a list of network security perimeter configurations for a search service.
372
+ * @param resourceGroupName The name of the resource group within the current subscription. You can
373
+ * obtain this value from the Azure Resource Manager API or the portal.
374
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
375
+ * resource group.
376
+ * @param options The options parameters.
377
+ */
378
+ listByService(resourceGroupName: string, searchServiceName: string, options?: NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams): PagedAsyncIterableIterator<NetworkSecurityPerimeterConfiguration>;
379
+ /**
380
+ * Gets a network security perimeter configuration.
381
+ * @param resourceGroupName The name of the resource group within the current subscription. You can
382
+ * obtain this value from the Azure Resource Manager API or the portal.
383
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
384
+ * resource group.
385
+ * @param nspConfigName The network security configuration name.
386
+ * @param options The options parameters.
387
+ */
388
+ get(resourceGroupName: string, searchServiceName: string, nspConfigName: string, options?: NetworkSecurityPerimeterConfigurationsGetOptionalParams): Promise<NetworkSecurityPerimeterConfigurationsGetResponse>;
389
+ /**
390
+ * Reconcile network security perimeter configuration for the Azure AI Search resource provider. This
391
+ * triggers a manual resync with network security perimeter configurations by ensuring the search
392
+ * service carries the latest configuration.
393
+ * @param resourceGroupName The name of the resource group within the current subscription. You can
394
+ * obtain this value from the Azure Resource Manager API or the portal.
395
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
396
+ * resource group.
397
+ * @param nspConfigName The network security configuration name.
398
+ * @param options The options parameters.
399
+ */
400
+ beginReconcile(resourceGroupName: string, searchServiceName: string, nspConfigName: string, options?: NetworkSecurityPerimeterConfigurationsReconcileOptionalParams): Promise<SimplePollerLike<OperationState<NetworkSecurityPerimeterConfigurationsReconcileResponse>, NetworkSecurityPerimeterConfigurationsReconcileResponse>>;
401
+ /**
402
+ * Reconcile network security perimeter configuration for the Azure AI Search resource provider. This
403
+ * triggers a manual resync with network security perimeter configurations by ensuring the search
404
+ * service carries the latest configuration.
405
+ * @param resourceGroupName The name of the resource group within the current subscription. You can
406
+ * obtain this value from the Azure Resource Manager API or the portal.
407
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
408
+ * resource group.
409
+ * @param nspConfigName The network security configuration name.
410
+ * @param options The options parameters.
411
+ */
412
+ beginReconcileAndWait(resourceGroupName: string, searchServiceName: string, nspConfigName: string, options?: NetworkSecurityPerimeterConfigurationsReconcileOptionalParams): Promise<NetworkSecurityPerimeterConfigurationsReconcileResponse>;
413
+ }
414
+
415
+ /** Optional parameters. */
416
+ export declare interface NetworkSecurityPerimeterConfigurationsGetOptionalParams extends coreClient.OperationOptions {
417
+ }
418
+
419
+ /** Contains response data for the get operation. */
420
+ export declare type NetworkSecurityPerimeterConfigurationsGetResponse = NetworkSecurityPerimeterConfiguration;
421
+
422
+ /** Optional parameters. */
423
+ export declare interface NetworkSecurityPerimeterConfigurationsListByServiceNextOptionalParams extends coreClient.OperationOptions {
424
+ }
425
+
426
+ /** Contains response data for the listByServiceNext operation. */
427
+ export declare type NetworkSecurityPerimeterConfigurationsListByServiceNextResponse = NetworkSecurityPerimeterConfigurationListResult;
428
+
429
+ /** Optional parameters. */
430
+ export declare interface NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams extends coreClient.OperationOptions {
431
+ }
432
+
433
+ /** Contains response data for the listByService operation. */
434
+ export declare type NetworkSecurityPerimeterConfigurationsListByServiceResponse = NetworkSecurityPerimeterConfigurationListResult;
435
+
436
+ /** Defines headers for NetworkSecurityPerimeterConfigurations_reconcile operation. */
437
+ export declare interface NetworkSecurityPerimeterConfigurationsReconcileHeaders {
438
+ location?: string;
439
+ }
440
+
441
+ /** Optional parameters. */
442
+ export declare interface NetworkSecurityPerimeterConfigurationsReconcileOptionalParams extends coreClient.OperationOptions {
443
+ /** Delay to wait until next poll, in milliseconds. */
444
+ updateIntervalInMs?: number;
445
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
446
+ resumeFrom?: string;
447
+ }
448
+
449
+ /** Contains response data for the reconcile operation. */
450
+ export declare type NetworkSecurityPerimeterConfigurationsReconcileResponse = NetworkSecurityPerimeterConfigurationsReconcileHeaders;
451
+
452
+ /** An access rule for a network security perimeter configuration. */
453
+ export declare interface NSPConfigAccessRule {
454
+ name?: string;
455
+ /** The properties for the access rules in a network security perimeter configuration. */
456
+ properties?: NSPConfigAccessRuleProperties;
457
+ }
458
+
459
+ /** The properties for the access rules in a network security perimeter configuration. */
460
+ export declare interface NSPConfigAccessRuleProperties {
461
+ direction?: string;
462
+ addressPrefixes?: string[];
463
+ fullyQualifiedDomainNames?: string[];
464
+ subscriptions?: string[];
465
+ networkSecurityPerimeters?: NSPConfigNetworkSecurityPerimeterRule[];
466
+ }
467
+
468
+ /** The resource association for the network security perimeter. */
469
+ export declare interface NSPConfigAssociation {
470
+ name?: string;
471
+ accessMode?: string;
472
+ }
473
+
474
+ /** The network security perimeter properties present in a configuration rule. */
475
+ export declare interface NSPConfigNetworkSecurityPerimeterRule {
476
+ id?: string;
477
+ perimeterGuid?: string;
478
+ location?: string;
479
+ }
480
+
481
+ /** The perimeter for a network security perimeter configuration. */
482
+ export declare interface NSPConfigPerimeter {
483
+ id?: string;
484
+ perimeterGuid?: string;
485
+ location?: string;
486
+ }
487
+
488
+ /** The profile for a network security perimeter configuration. */
489
+ export declare interface NSPConfigProfile {
490
+ name?: string;
491
+ accessRulesVersion?: string;
492
+ accessRules?: NSPConfigAccessRule[];
493
+ }
494
+
495
+ /** An object to describe any issues with provisioning network security perimeters to a search service. */
496
+ export declare interface NSPProvisioningIssue {
497
+ name?: string;
498
+ /** The properties to describe any issues with provisioning network security perimeters to a search service. */
499
+ properties?: NSPProvisioningIssueProperties;
500
+ }
501
+
502
+ /** The properties to describe any issues with provisioning network security perimeters to a search service. */
503
+ export declare interface NSPProvisioningIssueProperties {
504
+ issueType?: string;
505
+ severity?: string;
506
+ description?: string;
507
+ suggestedResourceIds?: string[];
508
+ suggestedAccessRules?: string[];
244
509
  }
245
510
 
246
511
  /** Describes a REST API operation. */
@@ -255,6 +520,35 @@ export declare interface Operation {
255
520
  * NOTE: This property will not be serialized. It can only be populated by the server.
256
521
  */
257
522
  readonly display?: OperationDisplay;
523
+ /**
524
+ * 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.
525
+ * NOTE: This property will not be serialized. It can only be populated by the server.
526
+ */
527
+ readonly isDataAction?: boolean;
528
+ /**
529
+ * Describes which originating entities are allowed to invoke this operation.
530
+ * NOTE: This property will not be serialized. It can only be populated by the server.
531
+ */
532
+ readonly origin?: string;
533
+ /**
534
+ * Describes additional properties for this operation.
535
+ * NOTE: This property will not be serialized. It can only be populated by the server.
536
+ */
537
+ readonly properties?: OperationProperties;
538
+ }
539
+
540
+ /** Describes a particular availability for the metric specification. */
541
+ export declare interface OperationAvailability {
542
+ /**
543
+ * The time grain for the dimension.
544
+ * NOTE: This property will not be serialized. It can only be populated by the server.
545
+ */
546
+ readonly timeGrain?: string;
547
+ /**
548
+ * The blob duration for the dimension.
549
+ * NOTE: This property will not be serialized. It can only be populated by the server.
550
+ */
551
+ readonly blobDuration?: string;
258
552
  }
259
553
 
260
554
  /** The object that describes the operation. */
@@ -281,10 +575,10 @@ export declare interface OperationDisplay {
281
575
  readonly description?: string;
282
576
  }
283
577
 
284
- /** 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. */
578
+ /** 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. */
285
579
  export declare interface OperationListResult {
286
580
  /**
287
- * The list of operations supported by the resource provider.
581
+ * The list of operations by Azure AI Search, some supported by the resource provider and others by data plane APIs.
288
582
  * NOTE: This property will not be serialized. It can only be populated by the server.
289
583
  */
290
584
  readonly value?: Operation[];
@@ -295,6 +589,87 @@ export declare interface OperationListResult {
295
589
  readonly nextLink?: string;
296
590
  }
297
591
 
592
+ /** Specifications of one type of log for this operation. */
593
+ export declare interface OperationLogsSpecification {
594
+ /**
595
+ * The name of the log specification.
596
+ * NOTE: This property will not be serialized. It can only be populated by the server.
597
+ */
598
+ readonly name?: string;
599
+ /**
600
+ * The display name of the log specification.
601
+ * NOTE: This property will not be serialized. It can only be populated by the server.
602
+ */
603
+ readonly displayName?: string;
604
+ /**
605
+ * The blob duration for the log specification.
606
+ * NOTE: This property will not be serialized. It can only be populated by the server.
607
+ */
608
+ readonly blobDuration?: string;
609
+ }
610
+
611
+ /** Describes a particular dimension for the metric specification. */
612
+ export declare interface OperationMetricDimension {
613
+ /**
614
+ * The name of the dimension.
615
+ * NOTE: This property will not be serialized. It can only be populated by the server.
616
+ */
617
+ readonly name?: string;
618
+ /**
619
+ * The display name of the dimension.
620
+ * NOTE: This property will not be serialized. It can only be populated by the server.
621
+ */
622
+ readonly displayName?: string;
623
+ }
624
+
625
+ /** Specifications of one type of metric for this operation. */
626
+ export declare interface OperationMetricsSpecification {
627
+ /**
628
+ * The name of the metric specification.
629
+ * NOTE: This property will not be serialized. It can only be populated by the server.
630
+ */
631
+ readonly name?: string;
632
+ /**
633
+ * The display name of the metric specification.
634
+ * NOTE: This property will not be serialized. It can only be populated by the server.
635
+ */
636
+ readonly displayName?: string;
637
+ /**
638
+ * The display description of the metric specification.
639
+ * NOTE: This property will not be serialized. It can only be populated by the server.
640
+ */
641
+ readonly displayDescription?: string;
642
+ /**
643
+ * The unit for the metric specification.
644
+ * NOTE: This property will not be serialized. It can only be populated by the server.
645
+ */
646
+ readonly unit?: string;
647
+ /**
648
+ * The type of aggregation for the metric specification.
649
+ * NOTE: This property will not be serialized. It can only be populated by the server.
650
+ */
651
+ readonly aggregationType?: string;
652
+ /**
653
+ * Dimensions for the metric specification.
654
+ * NOTE: This property will not be serialized. It can only be populated by the server.
655
+ */
656
+ readonly dimensions?: OperationMetricDimension[];
657
+ /**
658
+ * Availabilities for the metric specification.
659
+ * NOTE: This property will not be serialized. It can only be populated by the server.
660
+ */
661
+ readonly availabilities?: OperationAvailability[];
662
+ }
663
+
664
+ /** Describes additional properties for this operation. */
665
+ export declare interface OperationProperties {
666
+ /**
667
+ * Specifications of the service for this operation.
668
+ * NOTE: This property will not be serialized. It can only be populated by the server.
669
+ */
670
+ readonly serviceSpecification?: OperationServiceSpecification;
671
+ }
672
+
298
673
  /** Interface representing a Operations. */
299
674
  export declare interface Operations {
300
675
  /**
@@ -304,6 +679,20 @@ export declare interface Operations {
304
679
  list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
305
680
  }
306
681
 
682
+ /** Specifications of the service for this operation. */
683
+ export declare interface OperationServiceSpecification {
684
+ /**
685
+ * Specifications of metrics for this operation.
686
+ * NOTE: This property will not be serialized. It can only be populated by the server.
687
+ */
688
+ readonly metricSpecifications?: OperationMetricsSpecification[];
689
+ /**
690
+ * Specifications of logs for this operation.
691
+ * NOTE: This property will not be serialized. It can only be populated by the server.
692
+ */
693
+ readonly logSpecifications?: OperationLogsSpecification[];
694
+ }
695
+
307
696
  /** Optional parameters. */
308
697
  export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
309
698
  }
@@ -311,16 +700,16 @@ export declare interface OperationsListOptionalParams extends coreClient.Operati
311
700
  /** Contains response data for the list operation. */
312
701
  export declare type OperationsListResponse = OperationListResult;
313
702
 
314
- /** Describes an existing Private Endpoint connection to the Azure Cognitive Search service. */
703
+ /** Describes an existing private endpoint connection to the Azure AI Search service. */
315
704
  export declare interface PrivateEndpointConnection extends Resource {
316
- /** Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. */
705
+ /** Describes the properties of an existing private endpoint connection to the Azure AI Search service. */
317
706
  properties?: PrivateEndpointConnectionProperties;
318
707
  }
319
708
 
320
- /** Response containing a list of Private Endpoint connections. */
709
+ /** Response containing a list of private endpoint connections. */
321
710
  export declare interface PrivateEndpointConnectionListResult {
322
711
  /**
323
- * The list of Private Endpoint connections.
712
+ * The list of private endpoint connections.
324
713
  * NOTE: This property will not be serialized. It can only be populated by the server.
325
714
  */
326
715
  readonly value?: PrivateEndpointConnection[];
@@ -331,27 +720,27 @@ export declare interface PrivateEndpointConnectionListResult {
331
720
  readonly nextLink?: string;
332
721
  }
333
722
 
334
- /** Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. */
723
+ /** Describes the properties of an existing private endpoint connection to the search service. */
335
724
  export declare interface PrivateEndpointConnectionProperties {
336
725
  /** The private endpoint resource from Microsoft.Network provider. */
337
726
  privateEndpoint?: PrivateEndpointConnectionPropertiesPrivateEndpoint;
338
- /** Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint. */
727
+ /** Describes the current state of an existing Azure Private Link service connection to the private endpoint. */
339
728
  privateLinkServiceConnectionState?: PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState;
340
- /** The group id from the provider of resource the private link service connection is for. */
729
+ /** The group ID of the Azure resource for which the private link service is for. */
341
730
  groupId?: string;
342
- /** The provisioning state of the private link service connection. Can be Updating, Deleting, Failed, Succeeded, or Incomplete */
731
+ /** The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. */
343
732
  provisioningState?: PrivateLinkServiceConnectionProvisioningState;
344
733
  }
345
734
 
346
735
  /** The private endpoint resource from Microsoft.Network provider. */
347
736
  export declare interface PrivateEndpointConnectionPropertiesPrivateEndpoint {
348
- /** The resource id of the private endpoint resource from Microsoft.Network provider. */
737
+ /** The resource ID of the private endpoint resource from Microsoft.Network provider. */
349
738
  id?: string;
350
739
  }
351
740
 
352
- /** Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint. */
741
+ /** Describes the current state of an existing Azure Private Link service connection to the private endpoint. */
353
742
  export declare interface PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState {
354
- /** Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. */
743
+ /** Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. */
355
744
  status?: PrivateLinkServiceConnectionStatus;
356
745
  /** The description for the private link service connection state. */
357
746
  description?: string;
@@ -365,19 +754,19 @@ export declare interface PrivateEndpointConnections {
365
754
  * Gets a list of all private endpoint connections in the given service.
366
755
  * @param resourceGroupName The name of the resource group within the current subscription. You can
367
756
  * obtain this value from the Azure Resource Manager API or the portal.
368
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
369
- * specified resource group.
757
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
758
+ * resource group.
370
759
  * @param options The options parameters.
371
760
  */
372
761
  listByService(resourceGroupName: string, searchServiceName: string, options?: PrivateEndpointConnectionsListByServiceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection>;
373
762
  /**
374
- * Updates a Private Endpoint connection to the search service in the given resource group.
763
+ * Updates a private endpoint connection to the search service in the given resource group.
375
764
  * @param resourceGroupName The name of the resource group within the current subscription. You can
376
765
  * obtain this value from the Azure Resource Manager API or the portal.
377
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
378
- * specified resource group.
379
- * @param privateEndpointConnectionName The name of the private endpoint connection to the Azure
380
- * Cognitive Search service with the specified resource group.
766
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
767
+ * resource group.
768
+ * @param privateEndpointConnectionName The name of the private endpoint connection to the Azure AI
769
+ * Search service with the specified resource group.
381
770
  * @param privateEndpointConnection The definition of the private endpoint connection to update.
382
771
  * @param options The options parameters.
383
772
  */
@@ -387,10 +776,10 @@ export declare interface PrivateEndpointConnections {
387
776
  * group.
388
777
  * @param resourceGroupName The name of the resource group within the current subscription. You can
389
778
  * obtain this value from the Azure Resource Manager API or the portal.
390
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
391
- * specified resource group.
392
- * @param privateEndpointConnectionName The name of the private endpoint connection to the Azure
393
- * Cognitive Search service with the specified resource group.
779
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
780
+ * resource group.
781
+ * @param privateEndpointConnectionName The name of the private endpoint connection to the Azure AI
782
+ * Search service with the specified resource group.
394
783
  * @param options The options parameters.
395
784
  */
396
785
  get(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnectionsGetResponse>;
@@ -398,10 +787,10 @@ export declare interface PrivateEndpointConnections {
398
787
  * Disconnects the private endpoint connection and deletes it from the search service.
399
788
  * @param resourceGroupName The name of the resource group within the current subscription. You can
400
789
  * obtain this value from the Azure Resource Manager API or the portal.
401
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
402
- * specified resource group.
403
- * @param privateEndpointConnectionName The name of the private endpoint connection to the Azure
404
- * Cognitive Search service with the specified resource group.
790
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
791
+ * resource group.
792
+ * @param privateEndpointConnectionName The name of the private endpoint connection to the Azure AI
793
+ * Search service with the specified resource group.
405
794
  * @param options The options parameters.
406
795
  */
407
796
  delete(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PrivateEndpointConnectionsDeleteResponse>;
@@ -452,16 +841,16 @@ export declare interface PrivateEndpointConnectionsUpdateOptionalParams extends
452
841
  /** Contains response data for the update operation. */
453
842
  export declare type PrivateEndpointConnectionsUpdateResponse = PrivateEndpointConnection;
454
843
 
455
- /** Describes a supported private link resource for the Azure Cognitive Search service. */
844
+ /** Describes a supported private link resource for the Azure AI Search service. */
456
845
  export declare interface PrivateLinkResource extends Resource {
457
846
  /**
458
- * Describes the properties of a supported private link resource for the Azure Cognitive Search service.
847
+ * Describes the properties of a supported private link resource for the Azure AI Search service.
459
848
  * NOTE: This property will not be serialized. It can only be populated by the server.
460
849
  */
461
850
  readonly properties?: PrivateLinkResourceProperties;
462
851
  }
463
852
 
464
- /** 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. */
853
+ /** 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. */
465
854
  export declare interface PrivateLinkResourceProperties {
466
855
  /**
467
856
  * The group ID of the private link resource.
@@ -479,7 +868,7 @@ export declare interface PrivateLinkResourceProperties {
479
868
  */
480
869
  readonly requiredZoneNames?: string[];
481
870
  /**
482
- * The list of resources that are onboarded to private link service, that are supported by Azure Cognitive Search.
871
+ * The list of resources that are onboarded to private link service, that are supported by Azure AI Search.
483
872
  * NOTE: This property will not be serialized. It can only be populated by the server.
484
873
  */
485
874
  readonly shareablePrivateLinkResourceTypes?: ShareablePrivateLinkResourceType[];
@@ -491,8 +880,8 @@ export declare interface PrivateLinkResources {
491
880
  * Gets a list of all supported private link resource types for the given service.
492
881
  * @param resourceGroupName The name of the resource group within the current subscription. You can
493
882
  * obtain this value from the Azure Resource Manager API or the portal.
494
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
495
- * specified resource group.
883
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
884
+ * resource group.
496
885
  * @param options The options parameters.
497
886
  */
498
887
  listSupported(resourceGroupName: string, searchServiceName: string, options?: PrivateLinkResourcesListSupportedOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource>;
@@ -526,7 +915,7 @@ export declare interface PrivateLinkResourcesResult {
526
915
  * **Failed**: The private link service connection has failed to be provisioned or deleted. \
527
916
  * **Succeeded**: The private link service connection has finished provisioning and is ready for approval. \
528
917
  * **Incomplete**: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. \
529
- * **Canceled**: Provisioning request for the private link service connection resource has been canceled
918
+ * **Canceled**: Provisioning request for the private link service connection resource has been canceled.
530
919
  */
531
920
  export declare type PrivateLinkServiceConnectionProvisioningState = string;
532
921
 
@@ -536,13 +925,24 @@ export declare type PrivateLinkServiceConnectionStatus = "Pending" | "Approved"
536
925
  /** Defines values for ProvisioningState. */
537
926
  export declare type ProvisioningState = "succeeded" | "provisioning" | "failed";
538
927
 
539
- /** Defines values for PublicNetworkAccess. */
540
- export declare type PublicNetworkAccess = "enabled" | "disabled";
928
+ /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
929
+ export declare interface ProxyResource extends Resource {
930
+ }
931
+
932
+ /**
933
+ * Defines values for PublicNetworkAccess. \
934
+ * {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
935
+ * this enum contains the known values that the service supports.
936
+ * ### Known values supported by the service
937
+ * **enabled**: The search service is accessible from traffic originating from the public internet. \
938
+ * **disabled**: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections.
939
+ */
940
+ export declare type PublicNetworkAccess = string;
541
941
 
542
- /** Describes an API key for a given Azure Cognitive Search service that has permissions for query operations only. */
942
+ /** Describes an API key for a given Azure AI Search service that conveys read-only permissions on the docs collection of an index. */
543
943
  export declare interface QueryKey {
544
944
  /**
545
- * The name of the query API key; may be empty.
945
+ * The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used.
546
946
  * NOTE: This property will not be serialized. It can only be populated by the server.
547
947
  */
548
948
  readonly name?: string;
@@ -556,11 +956,11 @@ export declare interface QueryKey {
556
956
  /** Interface representing a QueryKeys. */
557
957
  export declare interface QueryKeys {
558
958
  /**
559
- * Returns the list of query API keys for the given Azure Cognitive Search service.
959
+ * Returns the list of query API keys for the given Azure AI Search service.
560
960
  * @param resourceGroupName The name of the resource group within the current subscription. You can
561
961
  * obtain this value from the Azure Resource Manager API or the portal.
562
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
563
- * specified resource group.
962
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
963
+ * resource group.
564
964
  * @param options The options parameters.
565
965
  */
566
966
  listBySearchService(resourceGroupName: string, searchServiceName: string, options?: QueryKeysListBySearchServiceOptionalParams): PagedAsyncIterableIterator<QueryKey>;
@@ -569,8 +969,8 @@ export declare interface QueryKeys {
569
969
  * service.
570
970
  * @param resourceGroupName The name of the resource group within the current subscription. You can
571
971
  * obtain this value from the Azure Resource Manager API or the portal.
572
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
573
- * specified resource group.
972
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
973
+ * resource group.
574
974
  * @param name The name of the new query API key.
575
975
  * @param options The options parameters.
576
976
  */
@@ -580,8 +980,8 @@ export declare interface QueryKeys {
580
980
  * regenerating a query key is to delete and then recreate it.
581
981
  * @param resourceGroupName The name of the resource group within the current subscription. You can
582
982
  * obtain this value from the Azure Resource Manager API or the portal.
583
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
584
- * specified resource group.
983
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
984
+ * resource group.
585
985
  * @param key The query key to be deleted. Query keys are identified by value, not by name.
586
986
  * @param options The options parameters.
587
987
  */
@@ -621,35 +1021,35 @@ export declare interface QueryKeysListBySearchServiceOptionalParams extends core
621
1021
  /** Contains response data for the listBySearchService operation. */
622
1022
  export declare type QueryKeysListBySearchServiceResponse = ListQueryKeysResult;
623
1023
 
624
- /** Describes the quota usage for a particular sku supported by Azure Cognitive Search. */
1024
+ /** Describes the quota usage for a particular SKU. */
625
1025
  export declare interface QuotaUsageResult {
626
- /** The resource id of the quota usage sku endpoint for Microsoft.Search provider. */
1026
+ /** The resource ID of the quota usage SKU endpoint for Microsoft.Search provider. */
627
1027
  id?: string;
628
- /** The unit of measurement for the search sku. */
1028
+ /** The unit of measurement for the search SKU. */
629
1029
  unit?: string;
630
- /** The currently used up value for the particular search sku. */
1030
+ /** The currently used up value for the particular search SKU. */
631
1031
  currentValue?: number;
632
- /** The quota limit for the particular search sku. */
1032
+ /** The quota limit for the particular search SKU. */
633
1033
  limit?: number;
634
1034
  /**
635
- * The name of the sku supported by Azure Cognitive Search.
1035
+ * The name of the SKU supported by Azure AI Search.
636
1036
  * NOTE: This property will not be serialized. It can only be populated by the server.
637
1037
  */
638
1038
  readonly name?: QuotaUsageResultName;
639
1039
  }
640
1040
 
641
- /** The name of the sku supported by Azure Cognitive Search. */
1041
+ /** The name of the SKU supported by Azure AI Search. */
642
1042
  export declare interface QuotaUsageResultName {
643
- /** The sku name supported by Azure Cognitive Search. */
1043
+ /** The SKU name supported by Azure AI Search. */
644
1044
  value?: string;
645
- /** The localized string value for the sku supported by Azure Cognitive Search. */
1045
+ /** The localized string value for the SKU name. */
646
1046
  localizedValue?: string;
647
1047
  }
648
1048
 
649
- /** Response containing the quota usage information for all the supported skus of Azure Cognitive Search service. */
1049
+ /** Response containing the quota usage information for all the supported SKUs of Azure AI Search. */
650
1050
  export declare interface QuotaUsagesListResult {
651
1051
  /**
652
- * The quota usages for the SKUs supported by Azure Cognitive Search.
1052
+ * The quota usages for the SKUs supported by Azure AI Search.
653
1053
  * NOTE: This property will not be serialized. It can only be populated by the server.
654
1054
  */
655
1055
  readonly value?: QuotaUsageResult[];
@@ -679,6 +1079,25 @@ export declare interface Resource {
679
1079
  readonly type?: string;
680
1080
  }
681
1081
 
1082
+ /**
1083
+ * Defines values for SearchBypass. \
1084
+ * {@link KnownSearchBypass} can be used interchangeably with SearchBypass,
1085
+ * this enum contains the known values that the service supports.
1086
+ * ### Known values supported by the service
1087
+ * **None**: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. \
1088
+ * **AzurePortal**: Indicates that requests originating from the Azure portal can bypass the rules defined in the 'ipRules' section.
1089
+ */
1090
+ export declare type SearchBypass = string;
1091
+
1092
+ /**
1093
+ * Defines values for SearchDisabledDataExfiltrationOption. \
1094
+ * {@link KnownSearchDisabledDataExfiltrationOption} can be used interchangeably with SearchDisabledDataExfiltrationOption,
1095
+ * this enum contains the known values that the service supports.
1096
+ * ### Known values supported by the service
1097
+ * **All**: Indicates that all data exfiltration scenarios are disabled.
1098
+ */
1099
+ export declare type SearchDisabledDataExfiltrationOption = string;
1100
+
682
1101
  /** Defines values for SearchEncryptionComplianceStatus. */
683
1102
  export declare type SearchEncryptionComplianceStatus = "Compliant" | "NonCompliant";
684
1103
 
@@ -702,7 +1121,7 @@ export declare class SearchManagementClient extends coreClient.ServiceClient {
702
1121
  /**
703
1122
  * Gets the quota usage for a search sku in the given subscription.
704
1123
  * @param location The unique location name for a Microsoft Azure geographic region.
705
- * @param skuName The unique search service sku name supported by Azure Cognitive Search.
1124
+ * @param skuName The unique SKU name that identifies a billable tier.
706
1125
  * @param options The options parameters.
707
1126
  */
708
1127
  usageBySubscriptionSku(location: string, skuName: string, options?: UsageBySubscriptionSkuOptionalParams): Promise<UsageBySubscriptionSkuResponse>;
@@ -714,6 +1133,7 @@ export declare class SearchManagementClient extends coreClient.ServiceClient {
714
1133
  privateEndpointConnections: PrivateEndpointConnections;
715
1134
  sharedPrivateLinkResources: SharedPrivateLinkResources;
716
1135
  usages: Usages;
1136
+ networkSecurityPerimeterConfigurations: NetworkSecurityPerimeterConfigurations;
717
1137
  }
718
1138
 
719
1139
  /** Optional parameters. */
@@ -737,15 +1157,15 @@ export declare interface SearchManagementRequestOptions {
737
1157
  * {@link KnownSearchSemanticSearch} can be used interchangeably with SearchSemanticSearch,
738
1158
  * this enum contains the known values that the service supports.
739
1159
  * ### Known values supported by the service
740
- * **disabled**: Indicates that semantic search is disabled for the search service. \
741
- * **free**: Enables semantic search on a search service and indicates that it is to be used within the limits of the free tier. This would cap the volume of semantic search requests and is offered at no extra charge. This is the default for newly provisioned search services. \
742
- * **standard**: Enables semantic search on a search service as a billable feature, with higher throughput and volume of semantic search queries.
1160
+ * **disabled**: Indicates that semantic reranker is disabled for the search service. This is the default. \
1161
+ * **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. \
1162
+ * **standard**: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries.
743
1163
  */
744
1164
  export declare type SearchSemanticSearch = string;
745
1165
 
746
- /** Describes an Azure Cognitive Search service and its current state. */
1166
+ /** Describes an Azure AI Search service and its current state. */
747
1167
  export declare interface SearchService extends TrackedResource {
748
- /** The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. */
1168
+ /** The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. */
749
1169
  sku?: Sku;
750
1170
  /** The identity of the resource. */
751
1171
  identity?: Identity;
@@ -758,7 +1178,7 @@ export declare interface SearchService extends TrackedResource {
758
1178
  /** 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. */
759
1179
  publicNetworkAccess?: PublicNetworkAccess;
760
1180
  /**
761
- * 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.
1181
+ * 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.
762
1182
  * NOTE: This property will not be serialized. It can only be populated by the server.
763
1183
  */
764
1184
  readonly status?: SearchServiceStatus;
@@ -772,32 +1192,39 @@ export declare interface SearchService extends TrackedResource {
772
1192
  * NOTE: This property will not be serialized. It can only be populated by the server.
773
1193
  */
774
1194
  readonly provisioningState?: ProvisioningState;
775
- /** Network specific rules that determine how the Azure Cognitive Search service may be reached. */
1195
+ /** Network specific rules that determine how the Azure AI Search service may be reached. */
776
1196
  networkRuleSet?: NetworkRuleSet;
1197
+ /** 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. */
1198
+ disabledDataExfiltrationOptions?: SearchDisabledDataExfiltrationOption[];
777
1199
  /** Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. */
778
1200
  encryptionWithCmk?: EncryptionWithCmk;
779
1201
  /** 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. */
780
1202
  disableLocalAuth?: boolean;
781
1203
  /** 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. */
782
1204
  authOptions?: DataPlaneAuthOptions;
1205
+ /** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. */
1206
+ semanticSearch?: SearchSemanticSearch;
783
1207
  /**
784
- * The list of private endpoint connections to the Azure Cognitive Search service.
1208
+ * The list of private endpoint connections to the Azure AI Search service.
785
1209
  * NOTE: This property will not be serialized. It can only be populated by the server.
786
1210
  */
787
1211
  readonly privateEndpointConnections?: PrivateEndpointConnection[];
788
- /** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. */
789
- semanticSearch?: SearchSemanticSearch;
790
1212
  /**
791
- * The list of shared private link resources managed by the Azure Cognitive Search service.
1213
+ * The list of shared private link resources managed by the Azure AI Search service.
792
1214
  * NOTE: This property will not be serialized. It can only be populated by the server.
793
1215
  */
794
1216
  readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
1217
+ /**
1218
+ * A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
1219
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1220
+ */
1221
+ readonly eTag?: string;
795
1222
  }
796
1223
 
797
- /** Response containing a list of Azure Cognitive Search services. */
1224
+ /** Response containing a list of Azure AI Search services. */
798
1225
  export declare interface SearchServiceListResult {
799
1226
  /**
800
- * The list of Search services.
1227
+ * The list of search services.
801
1228
  * NOTE: This property will not be serialized. It can only be populated by the server.
802
1229
  */
803
1230
  readonly value?: SearchService[];
@@ -809,19 +1236,19 @@ export declare interface SearchServiceListResult {
809
1236
  }
810
1237
 
811
1238
  /** Defines values for SearchServiceStatus. */
812
- export declare type SearchServiceStatus = "running" | "provisioning" | "deleting" | "degraded" | "disabled" | "error";
1239
+ export declare type SearchServiceStatus = "running" | "provisioning" | "deleting" | "degraded" | "disabled" | "error" | "stopped";
813
1240
 
814
- /** The parameters used to update an Azure Cognitive Search service. */
1241
+ /** The parameters used to update an Azure AI Search service. */
815
1242
  export declare interface SearchServiceUpdate extends Resource {
816
- /** The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. */
1243
+ /** The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. */
817
1244
  sku?: Sku;
818
- /** 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. */
1245
+ /** 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. */
819
1246
  location?: string;
820
1247
  /** Tags to help categorize the resource in the Azure portal. */
821
1248
  tags?: {
822
1249
  [propertyName: string]: string;
823
1250
  };
824
- /** The identity of the resource. */
1251
+ /** Details about the search service identity. A null value indicates that the search service has no identity assigned. */
825
1252
  identity?: Identity;
826
1253
  /** 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. */
827
1254
  replicaCount?: number;
@@ -832,7 +1259,7 @@ export declare interface SearchServiceUpdate extends Resource {
832
1259
  /** 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. */
833
1260
  publicNetworkAccess?: PublicNetworkAccess;
834
1261
  /**
835
- * 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.
1262
+ * 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.
836
1263
  * NOTE: This property will not be serialized. It can only be populated by the server.
837
1264
  */
838
1265
  readonly status?: SearchServiceStatus;
@@ -846,26 +1273,33 @@ export declare interface SearchServiceUpdate extends Resource {
846
1273
  * NOTE: This property will not be serialized. It can only be populated by the server.
847
1274
  */
848
1275
  readonly provisioningState?: ProvisioningState;
849
- /** Network specific rules that determine how the Azure Cognitive Search service may be reached. */
1276
+ /** Network specific rules that determine how the Azure AI Search service may be reached. */
850
1277
  networkRuleSet?: NetworkRuleSet;
1278
+ /** 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. */
1279
+ disabledDataExfiltrationOptions?: SearchDisabledDataExfiltrationOption[];
851
1280
  /** Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. */
852
1281
  encryptionWithCmk?: EncryptionWithCmk;
853
1282
  /** 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. */
854
1283
  disableLocalAuth?: boolean;
855
1284
  /** 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. */
856
1285
  authOptions?: DataPlaneAuthOptions;
1286
+ /** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. */
1287
+ semanticSearch?: SearchSemanticSearch;
857
1288
  /**
858
- * The list of private endpoint connections to the Azure Cognitive Search service.
1289
+ * The list of private endpoint connections to the Azure AI Search service.
859
1290
  * NOTE: This property will not be serialized. It can only be populated by the server.
860
1291
  */
861
1292
  readonly privateEndpointConnections?: PrivateEndpointConnection[];
862
- /** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. */
863
- semanticSearch?: SearchSemanticSearch;
864
1293
  /**
865
- * The list of shared private link resources managed by the Azure Cognitive Search service.
1294
+ * The list of shared private link resources managed by the Azure AI Search service.
866
1295
  * NOTE: This property will not be serialized. It can only be populated by the server.
867
1296
  */
868
1297
  readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
1298
+ /**
1299
+ * A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
1300
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1301
+ */
1302
+ readonly eTag?: string;
869
1303
  }
870
1304
 
871
1305
  /** Interface representing a Services. */
@@ -887,12 +1321,12 @@ export declare interface Services {
887
1321
  * exists, all properties will be updated with the given values.
888
1322
  * @param resourceGroupName The name of the resource group within the current subscription. You can
889
1323
  * obtain this value from the Azure Resource Manager API or the portal.
890
- * @param searchServiceName The name of the Azure Cognitive Search service to create or update. Search
891
- * service names must only contain lowercase letters, digits or dashes, cannot use dash as the first
892
- * two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60
893
- * characters in length. Search service names must be globally unique since they are part of the
894
- * service URI (https://<name>.search.windows.net). You cannot change the service name after the
895
- * service is created.
1324
+ * @param searchServiceName The name of the Azure AI Search service to create or update. Search service
1325
+ * names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or
1326
+ * last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in
1327
+ * length. Search service names must be globally unique since they are part of the service URI
1328
+ * (https://<name>.search.windows.net). You cannot change the service name after the service is
1329
+ * created.
896
1330
  * @param service The definition of the search service to create or update.
897
1331
  * @param options The options parameters.
898
1332
  */
@@ -902,12 +1336,12 @@ export declare interface Services {
902
1336
  * exists, all properties will be updated with the given values.
903
1337
  * @param resourceGroupName The name of the resource group within the current subscription. You can
904
1338
  * obtain this value from the Azure Resource Manager API or the portal.
905
- * @param searchServiceName The name of the Azure Cognitive Search service to create or update. Search
906
- * service names must only contain lowercase letters, digits or dashes, cannot use dash as the first
907
- * two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60
908
- * characters in length. Search service names must be globally unique since they are part of the
909
- * service URI (https://<name>.search.windows.net). You cannot change the service name after the
910
- * service is created.
1339
+ * @param searchServiceName The name of the Azure AI Search service to create or update. Search service
1340
+ * names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or
1341
+ * last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in
1342
+ * length. Search service names must be globally unique since they are part of the service URI
1343
+ * (https://<name>.search.windows.net). You cannot change the service name after the service is
1344
+ * created.
911
1345
  * @param service The definition of the search service to create or update.
912
1346
  * @param options The options parameters.
913
1347
  */
@@ -916,7 +1350,7 @@ export declare interface Services {
916
1350
  * Updates an existing search service in the given resource group.
917
1351
  * @param resourceGroupName The name of the resource group within the current subscription. You can
918
1352
  * obtain this value from the Azure Resource Manager API or the portal.
919
- * @param searchServiceName The name of the Azure Cognitive Search service to update.
1353
+ * @param searchServiceName The name of the Azure AI Search service to update.
920
1354
  * @param service The definition of the search service to update.
921
1355
  * @param options The options parameters.
922
1356
  */
@@ -925,8 +1359,8 @@ export declare interface Services {
925
1359
  * Gets the search service with the given name in the given resource group.
926
1360
  * @param resourceGroupName The name of the resource group within the current subscription. You can
927
1361
  * obtain this value from the Azure Resource Manager API or the portal.
928
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
929
- * specified resource group.
1362
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
1363
+ * resource group.
930
1364
  * @param options The options parameters.
931
1365
  */
932
1366
  get(resourceGroupName: string, searchServiceName: string, options?: ServicesGetOptionalParams): Promise<ServicesGetResponse>;
@@ -934,8 +1368,8 @@ export declare interface Services {
934
1368
  * Deletes a search service in the given resource group, along with its associated resources.
935
1369
  * @param resourceGroupName The name of the resource group within the current subscription. You can
936
1370
  * obtain this value from the Azure Resource Manager API or the portal.
937
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
938
- * specified resource group.
1371
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
1372
+ * resource group.
939
1373
  * @param options The options parameters.
940
1374
  */
941
1375
  delete(resourceGroupName: string, searchServiceName: string, options?: ServicesDeleteOptionalParams): Promise<void>;
@@ -1032,42 +1466,42 @@ export declare interface ServicesUpdateOptionalParams extends coreClient.Operati
1032
1466
  /** Contains response data for the update operation. */
1033
1467
  export declare type ServicesUpdateResponse = SearchService;
1034
1468
 
1035
- /** Describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search. */
1469
+ /** Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search. */
1036
1470
  export declare interface ShareablePrivateLinkResourceProperties {
1037
1471
  /**
1038
- * The resource provider type for the resource that has been onboarded to private link service, supported by Azure Cognitive Search.
1472
+ * The resource provider type for the resource that has been onboarded to private link service, supported by Azure AI Search.
1039
1473
  * NOTE: This property will not be serialized. It can only be populated by the server.
1040
1474
  */
1041
1475
  readonly type?: string;
1042
1476
  /**
1043
- * The resource provider group id for the resource that has been onboarded to private link service, supported by Azure Cognitive Search.
1477
+ * The resource provider group id for the resource that has been onboarded to private link service, supported by Azure AI Search.
1044
1478
  * NOTE: This property will not be serialized. It can only be populated by the server.
1045
1479
  */
1046
1480
  readonly groupId?: string;
1047
1481
  /**
1048
- * The description of the resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
1482
+ * The description of the resource type that has been onboarded to private link service, supported by Azure AI Search.
1049
1483
  * NOTE: This property will not be serialized. It can only be populated by the server.
1050
1484
  */
1051
1485
  readonly description?: string;
1052
1486
  }
1053
1487
 
1054
- /** Describes an resource type that has been onboarded to private link service, supported by Azure Cognitive Search. */
1488
+ /** Describes an resource type that has been onboarded to private link service, supported by Azure AI Search. */
1055
1489
  export declare interface ShareablePrivateLinkResourceType {
1056
1490
  /**
1057
- * The name of the resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
1491
+ * The name of the resource type that has been onboarded to private link service, supported by Azure AI Search.
1058
1492
  * NOTE: This property will not be serialized. It can only be populated by the server.
1059
1493
  */
1060
1494
  readonly name?: string;
1061
1495
  /**
1062
- * Describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
1496
+ * Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search.
1063
1497
  * NOTE: This property will not be serialized. It can only be populated by the server.
1064
1498
  */
1065
1499
  readonly properties?: ShareablePrivateLinkResourceProperties;
1066
1500
  }
1067
1501
 
1068
- /** Describes a Shared Private Link Resource managed by the Azure Cognitive Search service. */
1502
+ /** Describes a shared private link resource managed by the Azure AI Search service. */
1069
1503
  export declare interface SharedPrivateLinkResource extends Resource {
1070
- /** Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service. */
1504
+ /** Describes the properties of a shared private link resource managed by the Azure AI Search service. */
1071
1505
  properties?: SharedPrivateLinkResourceProperties;
1072
1506
  }
1073
1507
 
@@ -1082,10 +1516,10 @@ export declare interface SharedPrivateLinkResource extends Resource {
1082
1516
  */
1083
1517
  export declare type SharedPrivateLinkResourceAsyncOperationResult = string;
1084
1518
 
1085
- /** Response containing a list of Shared Private Link Resources. */
1519
+ /** Response containing a list of shared private link resources. */
1086
1520
  export declare interface SharedPrivateLinkResourceListResult {
1087
1521
  /**
1088
- * The list of Shared Private Link Resources.
1522
+ * The list of shared private link resources.
1089
1523
  * NOTE: This property will not be serialized. It can only be populated by the server.
1090
1524
  */
1091
1525
  readonly value?: SharedPrivateLinkResource[];
@@ -1093,24 +1527,34 @@ export declare interface SharedPrivateLinkResourceListResult {
1093
1527
  nextLink?: string;
1094
1528
  }
1095
1529
 
1096
- /** Describes the properties of an existing Shared Private Link Resource managed by the Azure Cognitive Search service. */
1530
+ /** Describes the properties of an existing shared private link resource managed by the Azure AI Search service. */
1097
1531
  export declare interface SharedPrivateLinkResourceProperties {
1098
- /** The resource id of the resource the shared private link resource is for. */
1532
+ /** The resource ID of the resource the shared private link resource is for. */
1099
1533
  privateLinkResourceId?: string;
1100
- /** The group id from the provider of resource the shared private link resource is for. */
1534
+ /** The group ID from the provider of resource the shared private link resource is for. */
1101
1535
  groupId?: string;
1102
- /** The request message for requesting approval of the shared private link resource. */
1536
+ /** The message for requesting approval of the shared private link resource. */
1103
1537
  requestMessage?: string;
1104
- /** 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). */
1538
+ /** 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). */
1105
1539
  resourceRegion?: string;
1106
- /** Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. */
1540
+ /** Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. */
1107
1541
  status?: SharedPrivateLinkResourceStatus;
1108
- /** The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete. */
1542
+ /** The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. */
1109
1543
  provisioningState?: SharedPrivateLinkResourceProvisioningState;
1110
1544
  }
1111
1545
 
1112
- /** Defines values for SharedPrivateLinkResourceProvisioningState. */
1113
- export declare type SharedPrivateLinkResourceProvisioningState = "Updating" | "Deleting" | "Failed" | "Succeeded" | "Incomplete";
1546
+ /**
1547
+ * Defines values for SharedPrivateLinkResourceProvisioningState. \
1548
+ * {@link KnownSharedPrivateLinkResourceProvisioningState} can be used interchangeably with SharedPrivateLinkResourceProvisioningState,
1549
+ * this enum contains the known values that the service supports.
1550
+ * ### Known values supported by the service
1551
+ * **Updating**: The shared private link resource is in the process of being created along with other resources for it to be fully functional. \
1552
+ * **Deleting**: The shared private link resource is in the process of being deleted. \
1553
+ * **Failed**: The shared private link resource has failed to be provisioned or deleted. \
1554
+ * **Succeeded**: The shared private link resource has finished provisioning and is ready for approval. \
1555
+ * **Incomplete**: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet.
1556
+ */
1557
+ export declare type SharedPrivateLinkResourceProvisioningState = string;
1114
1558
 
1115
1559
  /** Interface representing a SharedPrivateLinkResources. */
1116
1560
  export declare interface SharedPrivateLinkResources {
@@ -1118,8 +1562,8 @@ export declare interface SharedPrivateLinkResources {
1118
1562
  * Gets a list of all shared private link resources managed by the given service.
1119
1563
  * @param resourceGroupName The name of the resource group within the current subscription. You can
1120
1564
  * obtain this value from the Azure Resource Manager API or the portal.
1121
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
1122
- * specified resource group.
1565
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
1566
+ * resource group.
1123
1567
  * @param options The options parameters.
1124
1568
  */
1125
1569
  listByService(resourceGroupName: string, searchServiceName: string, options?: SharedPrivateLinkResourcesListByServiceOptionalParams): PagedAsyncIterableIterator<SharedPrivateLinkResource>;
@@ -1128,10 +1572,10 @@ export declare interface SharedPrivateLinkResources {
1128
1572
  * the given resource group.
1129
1573
  * @param resourceGroupName The name of the resource group within the current subscription. You can
1130
1574
  * obtain this value from the Azure Resource Manager API or the portal.
1131
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
1132
- * specified resource group.
1575
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
1576
+ * resource group.
1133
1577
  * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
1134
- * Azure Cognitive Search service within the specified resource group.
1578
+ * Azure AI Search service within the specified resource group.
1135
1579
  * @param sharedPrivateLinkResource The definition of the shared private link resource to create or
1136
1580
  * update.
1137
1581
  * @param options The options parameters.
@@ -1142,10 +1586,10 @@ export declare interface SharedPrivateLinkResources {
1142
1586
  * the given resource group.
1143
1587
  * @param resourceGroupName The name of the resource group within the current subscription. You can
1144
1588
  * obtain this value from the Azure Resource Manager API or the portal.
1145
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
1146
- * specified resource group.
1589
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
1590
+ * resource group.
1147
1591
  * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
1148
- * Azure Cognitive Search service within the specified resource group.
1592
+ * Azure AI Search service within the specified resource group.
1149
1593
  * @param sharedPrivateLinkResource The definition of the shared private link resource to create or
1150
1594
  * update.
1151
1595
  * @param options The options parameters.
@@ -1156,10 +1600,10 @@ export declare interface SharedPrivateLinkResources {
1156
1600
  * resource group.
1157
1601
  * @param resourceGroupName The name of the resource group within the current subscription. You can
1158
1602
  * obtain this value from the Azure Resource Manager API or the portal.
1159
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
1160
- * specified resource group.
1603
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
1604
+ * resource group.
1161
1605
  * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
1162
- * Azure Cognitive Search service within the specified resource group.
1606
+ * Azure AI Search service within the specified resource group.
1163
1607
  * @param options The options parameters.
1164
1608
  */
1165
1609
  get(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesGetOptionalParams): Promise<SharedPrivateLinkResourcesGetResponse>;
@@ -1167,10 +1611,10 @@ export declare interface SharedPrivateLinkResources {
1167
1611
  * Initiates the deletion of the shared private link resource from the search service.
1168
1612
  * @param resourceGroupName The name of the resource group within the current subscription. You can
1169
1613
  * obtain this value from the Azure Resource Manager API or the portal.
1170
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
1171
- * specified resource group.
1614
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
1615
+ * resource group.
1172
1616
  * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
1173
- * Azure Cognitive Search service within the specified resource group.
1617
+ * Azure AI Search service within the specified resource group.
1174
1618
  * @param options The options parameters.
1175
1619
  */
1176
1620
  beginDelete(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
@@ -1178,10 +1622,10 @@ export declare interface SharedPrivateLinkResources {
1178
1622
  * Initiates the deletion of the shared private link resource from the search service.
1179
1623
  * @param resourceGroupName The name of the resource group within the current subscription. You can
1180
1624
  * obtain this value from the Azure Resource Manager API or the portal.
1181
- * @param searchServiceName The name of the Azure Cognitive Search service associated with the
1182
- * specified resource group.
1625
+ * @param searchServiceName The name of the Azure AI Search service associated with the specified
1626
+ * resource group.
1183
1627
  * @param sharedPrivateLinkResourceName The name of the shared private link resource managed by the
1184
- * Azure Cognitive Search service within the specified resource group.
1628
+ * Azure AI Search service within the specified resource group.
1185
1629
  * @param options The options parameters.
1186
1630
  */
1187
1631
  beginDeleteAndWait(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesDeleteOptionalParams): Promise<void>;
@@ -1237,17 +1681,38 @@ export declare interface SharedPrivateLinkResourcesListByServiceOptionalParams e
1237
1681
  /** Contains response data for the listByService operation. */
1238
1682
  export declare type SharedPrivateLinkResourcesListByServiceResponse = SharedPrivateLinkResourceListResult;
1239
1683
 
1240
- /** Defines values for SharedPrivateLinkResourceStatus. */
1241
- export declare type SharedPrivateLinkResourceStatus = "Pending" | "Approved" | "Rejected" | "Disconnected";
1684
+ /**
1685
+ * Defines values for SharedPrivateLinkResourceStatus. \
1686
+ * {@link KnownSharedPrivateLinkResourceStatus} can be used interchangeably with SharedPrivateLinkResourceStatus,
1687
+ * this enum contains the known values that the service supports.
1688
+ * ### Known values supported by the service
1689
+ * **Pending**: The shared private link resource has been created and is pending approval. \
1690
+ * **Approved**: The shared private link resource is approved and is ready for use. \
1691
+ * **Rejected**: The shared private link resource has been rejected and cannot be used. \
1692
+ * **Disconnected**: The shared private link resource has been removed from the service.
1693
+ */
1694
+ export declare type SharedPrivateLinkResourceStatus = string;
1242
1695
 
1243
- /** Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits. */
1696
+ /** Defines the SKU of a search service, which determines billing rate and capacity limits. */
1244
1697
  export declare interface Sku {
1245
1698
  /** 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.' */
1246
1699
  name?: SkuName;
1247
1700
  }
1248
1701
 
1249
- /** Defines values for SkuName. */
1250
- export declare type SkuName = "free" | "basic" | "standard" | "standard2" | "standard3" | "storage_optimized_l1" | "storage_optimized_l2";
1702
+ /**
1703
+ * Defines values for SkuName. \
1704
+ * {@link KnownSkuName} can be used interchangeably with SkuName,
1705
+ * this enum contains the known values that the service supports.
1706
+ * ### Known values supported by the service
1707
+ * **free**: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. \
1708
+ * **basic**: Billable tier for a dedicated service having up to 3 replicas. \
1709
+ * **standard**: Billable tier for a dedicated service having up to 12 partitions and 12 replicas. \
1710
+ * **standard2**: Similar to 'standard', but with more capacity per search unit. \
1711
+ * **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'). \
1712
+ * **storage_optimized_l1**: Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions. \
1713
+ * **storage_optimized_l2**: Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.
1714
+ */
1715
+ export declare type SkuName = string;
1251
1716
 
1252
1717
  /** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
1253
1718
  export declare interface TrackedResource extends Resource {
@@ -1264,7 +1729,7 @@ export declare interface TrackedResource extends Resource {
1264
1729
  * {@link KnownUnavailableNameReason} can be used interchangeably with UnavailableNameReason,
1265
1730
  * this enum contains the known values that the service supports.
1266
1731
  * ### Known values supported by the service
1267
- * **Invalid**: The search service name does not match naming requirements. \
1732
+ * **Invalid**: The search service name doesn't match naming requirements. \
1268
1733
  * **AlreadyExists**: The search service name is already assigned to a different search service.
1269
1734
  */
1270
1735
  export declare type UnavailableNameReason = string;
@@ -1281,7 +1746,7 @@ export declare type UsageBySubscriptionSkuResponse = QuotaUsageResult;
1281
1746
  /** Interface representing a Usages. */
1282
1747
  export declare interface Usages {
1283
1748
  /**
1284
- * Gets a list of all Search quota usages in the given subscription.
1749
+ * Get a list of all Azure AI Search quota usages across the subscription.
1285
1750
  * @param location The unique location name for a Microsoft Azure geographic region.
1286
1751
  * @param options The options parameters.
1287
1752
  */
@@ -1306,4 +1771,18 @@ export declare interface UsagesListBySubscriptionOptionalParams extends coreClie
1306
1771
  /** Contains response data for the listBySubscription operation. */
1307
1772
  export declare type UsagesListBySubscriptionResponse = QuotaUsagesListResult;
1308
1773
 
1774
+ /** The details of the user assigned managed identity assigned to the search service. */
1775
+ export declare interface UserAssignedManagedIdentity {
1776
+ /**
1777
+ * The principal ID of user assigned identity.
1778
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1779
+ */
1780
+ readonly principalId?: string;
1781
+ /**
1782
+ * The client ID of user assigned identity.
1783
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1784
+ */
1785
+ readonly clientId?: string;
1786
+ }
1787
+
1309
1788
  export { }