Microsoft.Search searchServices/privateEndpointConnections

Bicep resource definition

The searchServices/privateEndpointConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.Search/searchServices/privateEndpointConnections@2026-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    groupId: 'string'
    privateEndpoint: {
      id: 'string'
    }
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'
    }
    provisioningState: 'string'
  }
}

Property Values

Microsoft.Search/searchServices/privateEndpointConnections

Name Description Value
name The resource name 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.		 Symbolic name for resource of type: searchServices
properties Describes the properties of an existing private endpoint connection to the Azure AI Search service. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Description Value
groupId The group ID of the Azure resource for which the private link service is for. string
privateEndpoint The private endpoint resource from Microsoft.Network provider. PrivateEndpointConnectionPropertiesPrivateEndpoint
privateLinkServiceConnectionState Describes the current state of an existing Azure Private Link service connection to the private endpoint. PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState
provisioningState The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. 'Canceled'
'Deleting'
'Failed'
'Incomplete'
'Succeeded'
'Updating'

PrivateEndpointConnectionPropertiesPrivateEndpoint

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

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

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. Valid values are Pending, Approved, Rejected, or Disconnected. 'Approved'
'Disconnected'
'Pending'
'Rejected'

ARM template resource definition

The searchServices/privateEndpointConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.Search/searchServices/privateEndpointConnections",
  "apiVersion": "2026-03-01-preview",
  "name": "string",
  "properties": {
    "groupId": "string",
    "privateEndpoint": {
      "id": "string"
    },
    "privateLinkServiceConnectionState": {
      "actionsRequired": "string",
      "description": "string",
      "status": "string"
    },
    "provisioningState": "string"
  }
}

Property Values

Microsoft.Search/searchServices/privateEndpointConnections

Name Description Value
apiVersion The api version '2026-03-01-preview'
name The resource name string (required)
properties Describes the properties of an existing private endpoint connection to the Azure AI Search service. PrivateEndpointConnectionProperties
type The resource type 'Microsoft.Search/searchServices/privateEndpointConnections'

PrivateEndpointConnectionProperties

Name Description Value
groupId The group ID of the Azure resource for which the private link service is for. string
privateEndpoint The private endpoint resource from Microsoft.Network provider. PrivateEndpointConnectionPropertiesPrivateEndpoint
privateLinkServiceConnectionState Describes the current state of an existing Azure Private Link service connection to the private endpoint. PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState
provisioningState The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. 'Canceled'
'Deleting'
'Failed'
'Incomplete'
'Succeeded'
'Updating'

PrivateEndpointConnectionPropertiesPrivateEndpoint

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

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

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. Valid values are Pending, Approved, Rejected, or Disconnected. 'Approved'
'Disconnected'
'Pending'
'Rejected'

Usage Examples

Terraform (AzAPI provider) resource definition

The searchServices/privateEndpointConnections resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Search/searchServices/privateEndpointConnections@2026-03-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      groupId = "string"
      privateEndpoint = {
        id = "string"
      }
      privateLinkServiceConnectionState = {
        actionsRequired = "string"
        description = "string"
        status = "string"
      }
      provisioningState = "string"
    }
  }
}

Property Values

Microsoft.Search/searchServices/privateEndpointConnections

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: searchServices
properties Describes the properties of an existing private endpoint connection to the Azure AI Search service. PrivateEndpointConnectionProperties
type The resource type "Microsoft.Search/searchServices/privateEndpointConnections@2026-03-01-preview"

PrivateEndpointConnectionProperties

Name Description Value
groupId The group ID of the Azure resource for which the private link service is for. string
privateEndpoint The private endpoint resource from Microsoft.Network provider. PrivateEndpointConnectionPropertiesPrivateEndpoint
privateLinkServiceConnectionState Describes the current state of an existing Azure Private Link service connection to the private endpoint. PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState
provisioningState The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. 'Canceled'
'Deleting'
'Failed'
'Incomplete'
'Succeeded'
'Updating'

PrivateEndpointConnectionPropertiesPrivateEndpoint

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

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

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. Valid values are Pending, Approved, Rejected, or Disconnected. 'Approved'
'Disconnected'
'Pending'
'Rejected'
  • Last updated on