Microsoft.Search searchServices/privateEndpointConnections 2020-03-13

The searchServices/privateEndpointConnections resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Search/searchServices/privateEndpointConnections resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Search/searchServices/privateEndpointConnections@2020-03-13' = {
  name: 'string'
  parent: parentSymbolicName
  properties: {
    privateEndpoint: {
      id: 'string'
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'

Property values


Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
properties Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. PrivateEndpointConnectionProperties


Name Description Value
privateEndpoint The private endpoint resource from Microsoft.Network provider. PrivateEndpointConnectionPropertiesPrivateEndpoint
privateLinkServiceConnectionState Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint. PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState


Name Description Value
id The resource id of the private endpoint resource from Microsoft.Network provider. string


Name Description Value
actionsRequired A description of any extra actions that may be required. string
description The description for the private link service connection state. string
status Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. 'Approved'