Microsoft.Network privateLinkServices/privateEndpointConnections 2019-11-01

Template format

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

{
  "name": "string",
  "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections",
  "apiVersion": "2019-11-01",
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "string",
      "description": "string",
      "actionsRequired": "string"
    }
  }
}

Property values

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

Microsoft.Network/privateLinkServices/privateEndpointConnections object

Name Type Required Value
name string Yes The name of the private end point connection.
type enum Yes privateEndpointConnections
-or-
Microsoft.Network/privateLinkServices/privateEndpointConnections

See Set name and type for child resources.
apiVersion enum Yes 2019-11-01
properties object Yes Properties of the private end point connection. - PrivateEndpointConnectionProperties object

PrivateEndpointConnectionProperties object

Name Type Required Value
privateLinkServiceConnectionState object No A collection of information about the state of the connection between service consumer and provider. - PrivateLinkServiceConnectionState object

PrivateLinkServiceConnectionState object

Name Type Required Value
status string No Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
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.