private_link_services_private_endpoint_connections

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

Overview

Name	private_link_services_private_endpoint_connections
Type	Resource
Id	azure.network.private_link_services_private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting private end point connection resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the private end point connection.
type	string	The resource type.

list

Request successful. The operation returns a list of private end point connection resources.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the private end point 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	resourceGroupName, serviceName, peConnectionName, subscriptionId	$expand	Get the specific private end point connection by specific private link service in the resource group.
list	select	resourceGroupName, serviceName, subscriptionId		Gets all private end point connections for a specific private link service.
update	replace	resourceGroupName, serviceName, peConnectionName, subscriptionId		Approve or reject private end point connection for a private link service in a subscription.
delete	delete	resourceGroupName, serviceName, peConnectionName, subscriptionId		Delete private end point connection for a private link service in a subscription.

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
peConnectionName	string	The name of the private end point connection.
resourceGroupName	string	The name of the resource group.
serviceName	string	The name of the private link service.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$expand	string	Expands referenced resources.

SELECT examples

get

Get the specific private end point connection by specific private link service in the resource group.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.private_link_services_private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND peConnectionName = '{{ peConnectionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all private end point connections for a specific private link service.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.private_link_services_private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

REPLACE examples

update

Approve or reject private end point connection for a private link service in a subscription.

REPLACE azure.network.private_link_services_private_endpoint_connections
SET 
data__properties = '{{ properties }}',
data__name = '{{ name }}',
data__id = '{{ id }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND peConnectionName = '{{ peConnectionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Delete private end point connection for a private link service in a subscription.

DELETE FROM azure.network.private_link_services_private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND peConnectionName = '{{ peConnectionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;