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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
groupIds	array	The group ids for the private endpoint resource.
privateEndpoint	object	The private endpoint resource.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider.
provisioningState	string	The provisioning state of the private endpoint connection resource. Known values are: "Succeeded", "Creating", "Deleting", and "Failed".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_by_host_pool

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
groupIds	array	The group ids for the private endpoint resource.
privateEndpoint	object	The private endpoint resource.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider.
provisioningState	string	The provisioning state of the private endpoint connection resource. Known values are: "Succeeded", "Creating", "Deleting", and "Failed".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workspace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
groupIds	array	The group ids for the private endpoint resource.
privateEndpoint	object	The private endpoint resource.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider.
provisioningState	string	The provisioning state of the private endpoint connection resource. Known values are: "Succeeded", "Creating", "Deleting", and "Failed".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_host_pool

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
groupIds	array	The group ids for the private endpoint resource.
privateEndpoint	object	The private endpoint resource.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider.
provisioningState	string	The provisioning state of the private endpoint connection resource. Known values are: "Succeeded", "Creating", "Deleting", and "Failed".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_workspace	select	resource_group_name, workspace_name, private_endpoint_connection_name, subscription_id		Get a private endpoint connection.
get_by_host_pool	select	resource_group_name, host_pool_name, private_endpoint_connection_name, subscription_id		Get a private endpoint connection.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		List private endpoint connections.
list_by_host_pool	select	resource_group_name, host_pool_name, subscription_id	pageSize, isDescending, initialSkip	List private endpoint connections associated with hostpool.
update_by_workspace	update	resource_group_name, workspace_name, private_endpoint_connection_name, subscription_id		Approve or reject a private endpoint connection.
update_by_host_pool	update	resource_group_name, host_pool_name, private_endpoint_connection_name, subscription_id		Approve or reject a private endpoint connection.
delete_by_workspace	delete	resource_group_name, workspace_name, private_endpoint_connection_name, subscription_id		Remove a connection.
delete_by_host_pool	delete	resource_group_name, host_pool_name, private_endpoint_connection_name, subscription_id		Remove a 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
host_pool_name	string	The name of the host pool within the specified resource group. Required.
private_endpoint_connection_name	string	The name of the private endpoint connection associated with the Azure resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.
initialSkip	integer	Initial number of items to skip. Default value is None.
isDescending	boolean	Indicates whether the collection is descending. Default value is None.
pageSize	integer	Number of items per page. Default value is None.

SELECT examples

get_by_workspace

Get a private endpoint connection.

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

get_by_host_pool

Get a private endpoint connection.

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

list_by_workspace

List private endpoint connections.

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

list_by_host_pool

List private endpoint connections associated with hostpool.

SELECT
id,
name,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.desktop_virtualization.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND host_pool_name = '{{ host_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

UPDATE examples

update_by_workspace

Approve or reject a private endpoint connection.

UPDATE azure.desktop_virtualization.private_endpoint_connections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

update_by_host_pool

Approve or reject a private endpoint connection.

UPDATE azure.desktop_virtualization.private_endpoint_connections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND host_pool_name = '{{ host_pool_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete_by_workspace

Remove a connection.

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

delete_by_host_pool

Remove a connection.

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