Microsoft.SignalRService signalR/privateEndpointConnections 2020-05-01

Template format

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

  "name": "string",
  "type": "Microsoft.SignalRService/signalR/privateEndpointConnections",
  "apiVersion": "2020-05-01",
  "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.SignalRService/signalR/privateEndpointConnections object


In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes The name of the private endpoint connection associated with the SignalR resource.
type enum Yes For JSON -privateEndpointConnections

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2020-05-01
properties object Yes Properties of the private endpoint connection - PrivateEndpointConnectionProperties object

PrivateEndpointConnectionProperties object

Name Type Required Value
privateEndpoint object No Private endpoint associated with the private endpoint connection - PrivateEndpoint object
privateLinkServiceConnectionState object No Connection state - PrivateLinkServiceConnectionState object

PrivateEndpoint object

Name Type Required Value
id string No Full qualified Id of the private endpoint

PrivateLinkServiceConnectionState object

Name Type Required Value
status enum No Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. - Pending, Approved, Rejected, Disconnected
description string No The reason for approval/rejection of the connection.
actionsRequired string No A message indicating if changes on the service provider require any updates on the consumer.