private_endpoint_connections_private_link_hub

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

Overview

Name	private_endpoint_connections_private_link_hub
Type	Resource
Id	azure.synapse.private_endpoint_connections_private_link_hub

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	:vartype id: str
name	string	:vartype name: str
privateEndpoint	object	The private endpoint which the connection belongs to.
privateLinkServiceConnectionState	object	Connection state of the private endpoint connection.
provisioningState	string	Provisioning state of the private endpoint connection.
type	string	:vartype type: str

list

Name	Datatype	Description
id	string	:vartype id: str
name	string	:vartype name: str
privateEndpoint	object	The private endpoint which the connection belongs to.
privateLinkServiceConnectionState	object	Connection state of the private endpoint connection.
provisioningState	string	Provisioning state of the private endpoint connection.
type	string	:vartype type: str

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, private_link_hub_name, private_endpoint_connection_name, subscription_id		Get all PrivateEndpointConnection in the PrivateLinkHub by name.
list	select	resource_group_name, private_link_hub_name, subscription_id		Get all PrivateEndpointConnections in the PrivateLinkHub.

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	Name of the privateEndpointConnection. Required.
private_link_hub_name	string	Name of the privateLinkHub. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get all PrivateEndpointConnection in the PrivateLinkHub by name.

SELECT
id,
name,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
type
FROM azure.synapse.private_endpoint_connections_private_link_hub
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_link_hub_name = '{{ private_link_hub_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get all PrivateEndpointConnections in the PrivateLinkHub.

SELECT
id,
name,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
type
FROM azure.synapse.private_endpoint_connections_private_link_hub
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_link_hub_name = '{{ private_link_hub_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;