Microsoft.BotService botServices/privateEndpointConnections

Template format

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

  "name": "string",
  "type": "Microsoft.BotService/botServices/privateEndpointConnections",
  "apiVersion": "2021-05-01-preview",
  "properties": {
    "privateEndpoint": {},
    "privateLinkServiceConnectionState": {
      "status": "string",
      "description": "string",
      "actionRequired": "string"

Property values

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

Microsoft.BotService/botServices/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 Azure resource
type enum Yes For JSON -privateEndpointConnections

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2021-05-01-preview
properties object Yes Resource properties. - PrivateEndpointConnectionProperties object

PrivateEndpointConnectionProperties object

Name Type Required Value
privateEndpoint object No The resource of private end point.
privateLinkServiceConnectionState object Yes A collection of information about the state of the connection between service consumer and provider. - PrivateLinkServiceConnectionState object

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
description string No The reason for approval/rejection of the connection.
actionRequired string No A message indicating if changes on the service provider require any updates on the consumer.