Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The iotHubs/privateEndpointConnections resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Devices/iotHubs/privateEndpointConnections resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Devices/iotHubs/privateEndpointConnections@2021-07-02-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
Property Values
Microsoft.Devices/iotHubs/privateEndpointConnections
Name | Description | Value |
---|---|---|
name | The resource name | 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. |
Symbolic name for resource of type: iotHubs |
properties | The properties of a private endpoint connection | PrivateEndpointConnectionProperties (required) |
PrivateEndpoint
Name | Description | Value |
---|
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) |
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' (required) |
ARM template resource definition
The iotHubs/privateEndpointConnections resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Devices/iotHubs/privateEndpointConnections resource, add the following JSON to your template.
{
"type": "Microsoft.Devices/iotHubs/privateEndpointConnections",
"apiVersion": "2021-07-02-preview",
"name": "string",
"properties": {
"privateEndpoint": {
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
Property Values
Microsoft.Devices/iotHubs/privateEndpointConnections
Name | Description | Value |
---|---|---|
apiVersion | The api version | '2021-07-02-preview' |
name | The resource name | string (required) |
properties | The properties of a private endpoint connection | PrivateEndpointConnectionProperties (required) |
type | The resource type | 'Microsoft.Devices/iotHubs/privateEndpointConnections' |
PrivateEndpoint
Name | Description | Value |
---|
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) |
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' (required) |
Usage Examples
Terraform (AzAPI provider) resource definition
The iotHubs/privateEndpointConnections resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Devices/iotHubs/privateEndpointConnections resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/iotHubs/privateEndpointConnections@2021-07-02-preview"
name = "string"
parent_id = "string"
body = {
properties = {
privateEndpoint = {
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
}
Property Values
Microsoft.Devices/iotHubs/privateEndpointConnections
Name | Description | Value |
---|---|---|
name | The resource name | string (required) |
parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: iotHubs |
properties | The properties of a private endpoint connection | PrivateEndpointConnectionProperties (required) |
type | The resource type | "Microsoft.Devices/iotHubs/privateEndpointConnections@2021-07-02-preview" |
PrivateEndpoint
Name | Description | Value |
---|
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) |
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' (required) |