Package-level declarations

Types

Link copied to clipboard

Describes an existing Private Endpoint connection to the Azure Cognitive Search service.

Link copied to clipboard
data class GetServiceResult(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 sharedPrivateLinkResources: List<SharedPrivateLinkResourceResponse>, val sku: SkuResponse? = null, val status: String, val statusDetails: String, val tags: Map<String, String>? = null, val type: String)

Describes an Azure Cognitive Search service and its current state.

Link copied to clipboard

Describes a Shared Private Link Resource managed by the Azure Cognitive 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 Azure Cognitive 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 Azure Cognitive 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 Azure Cognitive Search service.

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

Network specific rules that determine how the Azure Cognitive Search service may be reached.

Describes the properties of an existing Private Endpoint connection to the Azure Cognitive 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 Azure Cognitive Search service.

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

Describes an API key for a given Azure Cognitive 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 Azure Cognitive 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 Azure Cognitive Search service.

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

Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.