private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.synapse.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Private endpoint connection

Name	Datatype	Description
properties	object	Private endpoint connection properties.

list

Private endpoint connection

Name	Datatype	Description
properties	object	Private endpoint connection properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Gets a private endpoint connection.
list	select	subscriptionId, resourceGroupName, workspaceName		Lists private endpoint connection in workspace.
create	insert			Approve or reject a private endpoint connection.
delete	delete			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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets a private endpoint connection.

SELECT
properties
FROM azure.synapse.private_endpoint_connections
;

list

Lists private endpoint connection in workspace.

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

INSERT examples

create

Approve or reject a private endpoint connection.

INSERT INTO azure.synapse.private_endpoint_connections (
data__properties
)
SELECT 
'{{ properties }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
  props:
    - name: properties
      value: object
      description: |
        Private endpoint connection properties.

DELETE examples

delete

Delete a private endpoint connection.

DELETE FROM azure.synapse.private_endpoint_connections
;