Microsoft.DigitalTwins digitalTwinsInstances/privateEndpointConnections 2023-01-31
Bicep resource definition
The digitalTwinsInstances/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.DigitalTwins/digitalTwinsInstances/privateEndpointConnections resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DigitalTwins/digitalTwinsInstances/privateEndpointConnections@2023-01-31' = {
name: 'string'
parent: resourceSymbolicName
properties: {
groupIds: [
'string'
]
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
Property values
digitalTwinsInstances/privateEndpointConnections
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
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: digitalTwinsInstances |
| properties | The connection properties. | ConnectionProperties (required) |
ConnectionProperties
| Name | Description | Value |
|---|---|---|
| groupIds | The list of group ids for the private endpoint connection. | string[] |
| privateEndpoint | The private endpoint. | PrivateEndpoint |
| privateLinkServiceConnectionState | The connection state. | ConnectionPropertiesPrivateLinkServiceConnectionStat... |
PrivateEndpoint
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
ConnectionPropertiesPrivateLinkServiceConnectionStat...
| 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 digitalTwinsInstances/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.DigitalTwins/digitalTwinsInstances/privateEndpointConnections resource, add the following JSON to your template.
{
"type": "Microsoft.DigitalTwins/digitalTwinsInstances/privateEndpointConnections",
"apiVersion": "2023-01-31",
"name": "string",
"properties": {
"groupIds": [ "string" ],
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
Property values
digitalTwinsInstances/privateEndpointConnections
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.DigitalTwins/digitalTwinsInstances/privateEndpointConnections' |
| apiVersion | The resource api version | '2023-01-31' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | The connection properties. | ConnectionProperties (required) |
ConnectionProperties
| Name | Description | Value |
|---|---|---|
| groupIds | The list of group ids for the private endpoint connection. | string[] |
| privateEndpoint | The private endpoint. | PrivateEndpoint |
| privateLinkServiceConnectionState | The connection state. | ConnectionPropertiesPrivateLinkServiceConnectionStat... |
PrivateEndpoint
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
ConnectionPropertiesPrivateLinkServiceConnectionStat...
| 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) |
Terraform (AzAPI provider) resource definition
The digitalTwinsInstances/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.DigitalTwins/digitalTwinsInstances/privateEndpointConnections resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DigitalTwins/digitalTwinsInstances/privateEndpointConnections@2023-01-31"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
groupIds = [
"string"
]
privateEndpoint = {}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
})
}
Property values
digitalTwinsInstances/privateEndpointConnections
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.DigitalTwins/digitalTwinsInstances/privateEndpointConnections@2023-01-31" |
| 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: digitalTwinsInstances |
| properties | The connection properties. | ConnectionProperties (required) |
ConnectionProperties
| Name | Description | Value |
|---|---|---|
| groupIds | The list of group ids for the private endpoint connection. | string[] |
| privateEndpoint | The private endpoint. | PrivateEndpoint |
| privateLinkServiceConnectionState | The connection state. | ConnectionPropertiesPrivateLinkServiceConnectionStat... |
PrivateEndpoint
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
ConnectionPropertiesPrivateLinkServiceConnectionStat...
| 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) |