Microsoft.Search searchServices/privateEndpointConnections

  • Article

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@2023-11-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    groupId: 'string'
    privateEndpoint: {
      id: 'string'
    }
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'
    }
    provisioningState: 'string'
  }
}

Property values

searchServices/privateEndpointConnections

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 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 search service. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Description Value
groupId The group id from the provider of resource the private link service connection is for. string
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. PrivateEndpointConnectionPropertiesPrivateLinkServic...
provisioningState The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, or Incomplete 'Canceled'
'Deleting'
'Failed'
'Incomplete'
'Succeeded'
'Updating'

PrivateEndpointConnectionPropertiesPrivateEndpoint

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

PrivateEndpointConnectionPropertiesPrivateLinkServic...

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": "2023-11-01",
  "name": "string",
  "properties": {
    "groupId": "string",
    "privateEndpoint": {
      "id": "string"
    },
    "privateLinkServiceConnectionState": {
      "actionsRequired": "string",
      "description": "string",
      "status": "string"
    },
    "provisioningState": "string"
  }
}

Property values

searchServices/privateEndpointConnections

Name Description Value
type The resource type 'Microsoft.Search/searchServices/privateEndpointConnections'
apiVersion The resource api version '2023-11-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Describes the properties of an existing private endpoint connection to the search service. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Description Value
groupId The group id from the provider of resource the private link service connection is for. string
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. PrivateEndpointConnectionPropertiesPrivateLinkServic...
provisioningState The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, or Incomplete 'Canceled'
'Deleting'
'Failed'
'Incomplete'
'Succeeded'
'Updating'

PrivateEndpointConnectionPropertiesPrivateEndpoint

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

PrivateEndpointConnectionPropertiesPrivateLinkServic...

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'

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@2023-11-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      groupId = "string"
      privateEndpoint = {
        id = "string"
      }
      privateLinkServiceConnectionState = {
        actionsRequired = "string"
        description = "string"
        status = "string"
      }
      provisioningState = "string"
    }
  })
}

Property values

searchServices/privateEndpointConnections

Name Description Value
type The resource type "Microsoft.Search/searchServices/privateEndpointConnections@2023-11-01"
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 search service. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Description Value
groupId The group id from the provider of resource the private link service connection is for. string
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. PrivateEndpointConnectionPropertiesPrivateLinkServic...
provisioningState The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, or Incomplete "Canceled"
"Deleting"
"Failed"
"Incomplete"
"Succeeded"
"Updating"

PrivateEndpointConnectionPropertiesPrivateEndpoint

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

PrivateEndpointConnectionPropertiesPrivateLinkServic...

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"