Microsoft.Devices iotHubs/privateEndpointConnections 2021-07-01-preview

The iotHubs/privateEndpointConnections resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Devices/iotHubs/privateEndpointConnections resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Devices/iotHubs/privateEndpointConnections@2021-07-01-preview' = {
  name: 'string'
  parent: parentSymbolicName
  properties: {
    privateEndpoint: {}
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'
    }
  }
}

Property values

iotHubs/privateEndpointConnections

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Devices/iotHubs/privateEndpointConnections'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-07-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
parentSymbolicName
properties The properties of a private endpoint connection PrivateEndpointConnectionProperties (required)

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint The private endpoint property of a private endpoint connection PrivateEndpoint
privateLinkServiceConnectionState The current state of a private endpoint connection PrivateLinkServiceConnectionState (required)

PrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

PrivateLinkServiceConnectionState

Name Description Value
actionsRequired Actions required for a private endpoint connection string
description The description for the current state of a private endpoint connection string (required)
status The status of a private endpoint connection 'Approved'
'Disconnected'
'Pending'
'Rejected'