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

The body contains the private endpoint connection properties.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name. (pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$)
properties	object	The connection properties.
systemData	object	Metadata pertaining to creation and last modification of the private endpoint connection.
type	string	The resource type.

list

The body contains the list of private endpoint connection properties.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name. (pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$)
properties	object	The connection properties.
systemData	object	Metadata pertaining to creation and last modification of the private endpoint connection.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName, privateEndpointConnectionName	api-version	Get private endpoint connection properties for the given private endpoint.
list	select	subscriptionId, resourceGroupName, resourceName	api-version	List private endpoint connection properties.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName, privateEndpointConnectionName, data__properties	api-version	Update the status of a private endpoint connection with the given name.
delete	delete	subscriptionId, resourceGroupName, resourceName, privateEndpointConnectionName	api-version	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
privateEndpointConnectionName	string	The name of the private endpoint connection.
resourceGroupName	string	The name of the resource group that contains the DigitalTwinsInstance.
resourceName	string	The name of the DigitalTwinsInstance.
subscriptionId	string	The subscription identifier.
api-version	string	Version of the DigitalTwinsInstance Management API.

SELECT examples

get

Get private endpoint connection properties for the given private endpoint.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.digital_twins.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
AND api-version = '{{ api-version }}'
;

list

List private endpoint connection properties.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.digital_twins.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND api-version = '{{ api-version }}'
;

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 (
data__properties,
subscriptionId,
resourceGroupName,
resourceName,
privateEndpointConnectionName,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ privateEndpointConnectionName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: resourceName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: privateEndpointConnectionName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: properties
      value: object
      description: |
        The connection properties.
    - name: api-version
      value: string
      description: Version of the DigitalTwinsInstance Management API.

DELETE examples

delete

Delete private endpoint connection with the specified name.

DELETE FROM azure.digital_twins.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
AND api-version = '{{ api-version }}'
;