Microsoft.EventGrid topics/privateEndpointConnections

Template format

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

  "name": "string",
  "type": "Microsoft.EventGrid/topics/privateEndpointConnections",
  "apiVersion": "2020-06-01",
  "properties": {
    "privateEndpoint": {
      "id": "string"
    "groupIds": [
    "privateLinkServiceConnectionState": {
      "status": "string",
      "description": "string",
      "actionsRequired": "string"

Property values

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

Microsoft.EventGrid/topics/privateEndpointConnections object

Name Type Required Value
name string Yes The name of the private endpoint connection connection.
type enum Yes privateEndpointConnections

See Set name and type for child resources.
apiVersion enum Yes 2020-06-01
properties object Yes Properties of the PrivateEndpointConnection. - PrivateEndpointConnectionProperties object

PrivateEndpointConnectionProperties object

Name Type Required Value
privateEndpoint object No The Private Endpoint resource for this Connection. - PrivateEndpoint object
groupIds array No GroupIds from the private link service resource. - string
privateLinkServiceConnectionState object No Details about the state of the connection. - ConnectionState object

PrivateEndpoint object

Name Type Required Value
id string No The ARM identifier for Private Endpoint.

ConnectionState object

Name Type Required Value
status enum No Status of the connection. - Pending, Approved, Rejected, Disconnected
description string No Description of the connection state.
actionsRequired string No Actions required (if any).