private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.desktop_virtualization.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get_by_workspace

Successfully retrieved the connection.

Name	Datatype	Description
properties	object	Resource properties.

get_by_host_pool

Successfully retrieved the connection.

Name	Datatype	Description
properties	object	Resource properties.

list_by_workspace

Successfully retrieved connection list.

Name	Datatype	Description
properties	object	Resource properties.

list_by_host_pool

Successfully retrieved connection list.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_workspace	select	subscriptionId, resourceGroupName, workspaceName, privateEndpointConnectionName		Get a private endpoint connection.
get_by_host_pool	select	subscriptionId, resourceGroupName, hostPoolName, privateEndpointConnectionName		Get a private endpoint connection.
list_by_workspace	select	subscriptionId, resourceGroupName, workspaceName		List private endpoint connections.
list_by_host_pool	select	subscriptionId, resourceGroupName, hostPoolName	pageSize, isDescending, initialSkip	List private endpoint connections associated with hostpool.
delete_by_workspace	delete	subscriptionId, resourceGroupName, workspaceName, privateEndpointConnectionName		Remove a connection.
delete_by_host_pool	delete	subscriptionId, resourceGroupName, hostPoolName, privateEndpointConnectionName		Remove a connection.
update_by_workspace	exec	subscriptionId, resourceGroupName, workspaceName, privateEndpointConnectionName		Approve or reject a private endpoint connection.
update_by_host_pool	exec	subscriptionId, resourceGroupName, hostPoolName, privateEndpointConnectionName		Approve or reject a private endpoint connection.

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
hostPoolName	string	The name of the host pool within the specified resource group
privateEndpointConnectionName	string	The name of the private endpoint connection associated with the Azure resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
workspaceName	string	The name of the workspace
initialSkip	integer (int32)	Initial number of items to skip.
isDescending	boolean	Indicates whether the collection is descending.
pageSize	integer (int32)	Number of items per page.

SELECT examples

get_by_workspace

Get a private endpoint connection.

SELECT
properties
FROM azure.desktop_virtualization.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;

get_by_host_pool

Get a private endpoint connection.

SELECT
properties
FROM azure.desktop_virtualization.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND hostPoolName = '{{ hostPoolName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;

list_by_workspace

List private endpoint connections.

SELECT
properties
FROM azure.desktop_virtualization.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

list_by_host_pool

List private endpoint connections associated with hostpool.

SELECT
properties
FROM azure.desktop_virtualization.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND hostPoolName = '{{ hostPoolName }}' -- required
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

DELETE examples

delete_by_workspace

Remove a connection.

DELETE FROM azure.desktop_virtualization.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
;

delete_by_host_pool

Remove a connection.

DELETE FROM azure.desktop_virtualization.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND hostPoolName = '{{ hostPoolName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
;

Lifecycle Methods

update_by_workspace

Approve or reject a private endpoint connection.

EXEC azure.desktop_virtualization.private_endpoint_connections.update_by_workspace 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@privateEndpointConnectionName='{{ privateEndpointConnectionName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

update_by_host_pool

Approve or reject a private endpoint connection.

EXEC azure.desktop_virtualization.private_endpoint_connections.update_by_host_pool 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@hostPoolName='{{ hostPoolName }}' --required, 
@privateEndpointConnectionName='{{ privateEndpointConnectionName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;