Microsoft.Search searchServices/privateEndpointConnections template reference

Template format

To create a Microsoft.Search/searchServices/privateEndpointConnections resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Search/searchServices/privateEndpointConnections",
  "apiVersion": "2020-03-13",
  "id": "string",
  "properties": {
    "privateEndpoint": {
      "id": "string"
    },
    "privateLinkServiceConnectionState": {
      "status": "string",
      "description": "string",
      "actionsRequired": "string"
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Search/searchServices/privateEndpointConnections object

Name Type Required Value
name string Yes The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
type enum Yes privateEndpointConnections
-or-
Microsoft.Search/searchServices/privateEndpointConnections

See Set name and type for child resources.
apiVersion enum Yes 2020-03-13
id string No The ID of the private endpoint connection. This can be used with the Azure Resource Manager to link resources together.
properties object Yes Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. - PrivateEndpointConnectionProperties object

PrivateEndpointConnectionProperties object

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

PrivateEndpointConnectionPropertiesPrivateEndpoint object

Name Type Required Value
id string No The resource id of the private endpoint resource from Microsoft.Network provider.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState object

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