Microsoft.Devices iotHubs/privateEndpointConnections template reference

Template format

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

{
  "name": "string",
  "type": "Microsoft.Devices/iotHubs/privateEndpointConnections",
  "apiVersion": "2020-03-01",
  "properties": {
    "privateEndpoint": {},
    "privateLinkServiceConnectionState": {
      "status": "string",
      "description": "string",
      "actionsRequired": "string"
    }
  }
}

Property values

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

Microsoft.Devices/iotHubs/privateEndpointConnections object

Name Type Required Value
name string Yes The name of the private endpoint connection
type enum Yes privateEndpointConnections
-or-
Microsoft.Devices/iotHubs/privateEndpointConnections

See Set name and type for child resources.
apiVersion enum Yes 2020-03-01
properties object Yes PrivateEndpointConnectionProperties object

PrivateEndpointConnectionProperties object

Name Type Required Value
privateEndpoint object No PrivateEndpoint object
privateLinkServiceConnectionState object Yes PrivateLinkServiceConnectionState object

PrivateLinkServiceConnectionState object

Name Type Required Value
status enum Yes The status of a private endpoint connection. - Pending, Approved, Rejected, Disconnected
description string Yes The description for the current state of a private endpoint connection
actionsRequired string No Actions required for a private endpoint connection