Package-level declarations

Types

Link copied to clipboard
data class DataPlaneAadOrApiKeyAuthOptionResponse(val aadAuthFailureMode: String? = null)

Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.

Link copied to clipboard
data class DataPlaneAuthOptionsResponse(val aadOrApiKey: DataPlaneAadOrApiKeyAuthOptionResponse? = null, val apiKeyOnly: Any? = null)

Defines the options for how the search service authenticates a data plane request. This cannot be set if 'disableLocalAuth' is set to true.

Link copied to clipboard
data class EncryptionWithCmkResponse(val encryptionComplianceStatus: String, val enforcement: String? = null)

Describes a policy that determines how resources within the search service are to be encrypted with customer=managed keys.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val azureApiVersion: String, val id: String, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse, val type: String)

Describes an existing private endpoint connection to the search service.

Link copied to clipboard
data class GetServiceResult(val authOptions: DataPlaneAuthOptionsResponse? = null, val azureApiVersion: String, val disableLocalAuth: Boolean? = null, val encryptionWithCmk: EncryptionWithCmkResponse? = null, val hostingMode: String? = null, val id: String, val identity: IdentityResponse? = null, val location: String, val name: String, val networkRuleSet: NetworkRuleSetResponse? = null, val partitionCount: Int? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val replicaCount: Int? = null, val semanticSearch: String? = null, val sharedPrivateLinkResources: List<SharedPrivateLinkResourceResponse>, val sku: SkuResponse? = null, val status: String, val statusDetails: String, val tags: Map<String, String>? = null, val type: String)

Describes a search service and its current state.

Link copied to clipboard
data class GetSharedPrivateLinkResourceResult(val azureApiVersion: String, val id: String, val name: String, val properties: SharedPrivateLinkResourcePropertiesResponse, val type: String)

Describes a Shared Private Link Resource managed by the search service.

Link copied to clipboard
data class IdentityResponse(val principalId: String, val tenantId: String, val type: String)

Identity for the resource.

Link copied to clipboard
data class IpRuleResponse(val value: String? = null)

The IP restriction rule of the search service.

Link copied to clipboard
data class ListAdminKeyResult(val primaryKey: String, val secondaryKey: String)

Response containing the primary and secondary admin API keys for a given search service.

Link copied to clipboard
data class ListQueryKeyBySearchServiceResult(val nextLink: String, val value: List<QueryKeyResponse>)

Response containing the query API keys for a given search service.

Link copied to clipboard
data class NetworkRuleSetResponse(val ipRules: List<IpRuleResponse>? = null)

Network-specific rules that determine how the search service can be reached.

data class PrivateEndpointConnectionPropertiesResponse(val groupId: String? = null, val privateEndpoint: PrivateEndpointConnectionPropertiesResponsePrivateEndpoint? = null, val privateLinkServiceConnectionState: PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState? = null, val provisioningState: String? = null)

Describes the properties of an existing Private Endpoint connection to the search service.

The private endpoint resource from Microsoft.Network provider.

data class PrivateEndpointConnectionPropertiesResponsePrivateLinkServiceConnectionState(val actionsRequired: String? = null, val description: String? = null, val status: String? = null)

Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val id: String, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse? = null, val type: String)

Describes an existing private endpoint connection to the search service.

Link copied to clipboard
data class QueryKeyResponse(val key: String, val name: String)

Describes an API key for a given search service that has permissions for query operations only.

data class SharedPrivateLinkResourcePropertiesResponse(val groupId: String? = null, val privateLinkResourceId: String? = null, val provisioningState: String? = null, val requestMessage: String? = null, val resourceRegion: String? = null, val status: String? = null)

Describes the properties of an existing Shared Private Link Resource managed by the search service.

Link copied to clipboard
data class SharedPrivateLinkResourceResponse(val id: String, val name: String, val properties: SharedPrivateLinkResourcePropertiesResponse? = null, val type: String)

Describes a Shared Private Link Resource managed by the search service.

Link copied to clipboard
data class SkuResponse(val name: String? = null)

Defines the SKU of a search service, which determines billing rate and capacity limits.