private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.purview.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Gets or sets the identifier.
name	string	Gets or sets the name.
privateEndpoint	object	The private endpoint information.
privateLinkServiceConnectionState	object	The private link service connection state.
provisioningState	string	The provisioning state.
type	string	Gets or sets the type.

list_by_account

Name	Datatype	Description
id	string	Gets or sets the identifier.
name	string	Gets or sets the name.
privateEndpoint	object	The private endpoint information.
privateLinkServiceConnectionState	object	The private link service connection state.
provisioningState	string	The provisioning state.
type	string	Gets or sets the type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, private_endpoint_connection_name, subscription_id		Gets private endpoint connection information. Get a private endpoint connection.
list_by_account	select	resource_group_name, account_name, subscription_id	$skipToken	Gets private endpoint connections. Get private endpoint connections for account.
create_or_update	insert	resource_group_name, account_name, private_endpoint_connection_name, subscription_id		Approves/Rejects private endpoint connection request. Create or update a private endpoint connection.
create_or_update	replace	resource_group_name, account_name, private_endpoint_connection_name, subscription_id		Approves/Rejects private endpoint connection request. Create or update a private endpoint connection.
delete	delete	resource_group_name, account_name, private_endpoint_connection_name, subscription_id		Deletes private endpoint connection. Delete 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
account_name	string	The name of the account. Required.
private_endpoint_connection_name	string	Name of the private endpoint connection. Required.
resource_group_name	string	The resource group name. Required.
subscription_id	string
$skipToken	string	The skip token. Default value is None.

SELECT examples

get

Gets private endpoint connection information. Get a private endpoint connection.

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

list_by_account

Gets private endpoint connections. Get private endpoint connections for account.

SELECT
id,
name,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
type
FROM azure.purview.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Approves/Rejects private endpoint connection request. Create or update a private endpoint connection.

INSERT INTO azure.purview.private_endpoint_connections (
properties,
resource_group_name,
account_name,
private_endpoint_connection_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ private_endpoint_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: private_endpoint_connection_name
    value: "{{ private_endpoint_connection_name }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_endpoint_connections resource.
  - name: properties
    value:
      privateEndpoint:
        id: "{{ id }}"
      privateLinkServiceConnectionState:
        actionsRequired: "{{ actionsRequired }}"
        description: "{{ description }}"
        status: "{{ status }}"

REPLACE examples

create_or_update

Approves/Rejects private endpoint connection request. Create or update a private endpoint connection.

REPLACE azure.purview.private_endpoint_connections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes private endpoint connection. Delete a private endpoint connection.

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