private_endpoint_connections

Creates, updates, deletes, gets or lists a private_endpoint_connections resource.

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.digital_twins.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
groupIds	array	The list of group ids for the private endpoint connection.
privateEndpoint	object	The private endpoint.
privateLinkServiceConnectionState	object	The connection state.
provisioningState	string	The provisioning state. Known values are: "Pending", "Approved", "Rejected", and "Disconnected".
systemData	object	Metadata pertaining to creation and last modification of the private endpoint connection.
type	string	The resource type.

list

Name	Datatype	Description
value	array	The list of available private link connections for a Digital Twin.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, private_endpoint_connection_name, subscription_id		Get private endpoint connection properties for the given private endpoint.
list	select	resource_group_name, resource_name, subscription_id		List private endpoint connection properties.
create_or_update	insert	resource_group_name, resource_name, private_endpoint_connection_name, subscription_id, properties		Update the status of a private endpoint connection with the given name.
create_or_update	replace	resource_group_name, resource_name, private_endpoint_connection_name, subscription_id, properties		Update the status of a private endpoint connection with the given name.
delete	delete	resource_group_name, resource_name, private_endpoint_connection_name, subscription_id		Delete private endpoint connection with the specified name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
private_endpoint_connection_name	string	The name of the private endpoint connection. Required.
resource_group_name	string	The name of the resource group that contains the DigitalTwinsInstance. Required.
resource_name	string	The name of the DigitalTwinsInstance. Required.
subscription_id	string

SELECT examples

get

Get private endpoint connection properties for the given private endpoint.

SELECT
id,
name,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.digital_twins.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List private endpoint connection properties.

SELECT
value
FROM azure.digital_twins.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Update the status of a private endpoint connection with the given name.

INSERT INTO azure.digital_twins.private_endpoint_connections (
properties,
resource_group_name,
resource_name,
private_endpoint_connection_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ private_endpoint_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: private_endpoint_connection_name
    value: "{{ private_endpoint_connection_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: properties
    description: |
      The connection properties. Required.
    value:
      provisioningState: "{{ provisioningState }}"
      privateEndpoint:
        id: "{{ id }}"
      groupIds:
        - "{{ groupIds }}"
      privateLinkServiceConnectionState:
        status: "{{ status }}"
        description: "{{ description }}"
        actionsRequired: "{{ actionsRequired }}"

REPLACE examples

create_or_update

Update the status of a private endpoint connection with the given name.

REPLACE azure.digital_twins.private_endpoint_connections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete private endpoint connection with the specified name.

DELETE FROM azure.digital_twins.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;