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.
properties	object	The connection identifier.
systemData	object	Metadata pertaining to creation and last modification of the resource.
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.
properties	object	The connection identifier.
systemData	object	Metadata pertaining to creation and last modification of the resource.
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	subscriptionId, resourceGroupName, accountName, privateEndpointConnectionName	api-version	Get a private endpoint connection
list_by_account	select	subscriptionId, resourceGroupName, accountName	api-version, $skipToken	Get private endpoint connections for account
create_or_update	insert	subscriptionId, resourceGroupName, accountName, privateEndpointConnectionName	api-version	Create or update a private endpoint connection
delete	delete	subscriptionId, resourceGroupName, accountName, privateEndpointConnectionName	api-version	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
accountName	string	The name of the account.
privateEndpointConnectionName	string	Name of the private endpoint connection.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier
$skipToken	string	The skip token.
api-version	string	The api version to use.

SELECT examples

get

Get a private endpoint connection

SELECT
id,
name,
properties,
systemData,
type
FROM azure.purview.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_account

Get private endpoint connections for account

SELECT
id,
name,
properties,
systemData,
type
FROM azure.purview.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND api-version = '{{ api-version }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create or update a private endpoint connection

INSERT INTO azure.purview.private_endpoint_connections (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
privateEndpointConnectionName,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ privateEndpointConnectionName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: accountName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: privateEndpointConnectionName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: properties
      value: object
      description: |
        The connection identifier.
    - name: api-version
      value: string
      description: The api version to use.

DELETE examples

delete

Delete a private endpoint connection

DELETE FROM azure.purview.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
AND api-version = '{{ api-version }}'
;