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

vw_private_endpoint_connections

Name	Datatype	Description
privateEndpointConnectionName	text	field from the properties object
private_endpoint	text	field from the properties object
private_link_service_connection_state	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
workspaceName	text	field from the properties object

private_endpoint_connections

Name	Datatype	Description
properties	object	Properties of a private endpoint connection.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	privateEndpointConnectionName, resourceGroupName, subscriptionId, workspaceName	Gets a private endpoint connection.
list	SELECT	resourceGroupName, subscriptionId, workspaceName	Lists private endpoint connection in workspace.
create	INSERT	privateEndpointConnectionName, resourceGroupName, subscriptionId, workspaceName	Approve or reject a private endpoint connection.
delete	DELETE	privateEndpointConnectionName, resourceGroupName, subscriptionId, workspaceName	Delete a private endpoint connection.

SELECT examples

Lists private endpoint connection in workspace.

vw_private_endpoint_connections

SELECT
privateEndpointConnectionName,
private_endpoint,
private_link_service_connection_state,
provisioning_state,
resourceGroupName,
subscriptionId,
workspaceName
FROM azure.synapse.vw_private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

private_endpoint_connections

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

INSERT example

Use the following StackQL query and manifest file to create a new private_endpoint_connections resource.

All Properties

/*+ create */
INSERT INTO azure.synapse.private_endpoint_connections (
privateEndpointConnectionName,
resourceGroupName,
subscriptionId,
workspaceName,
properties
)
SELECT 
'{{ privateEndpointConnectionName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: privateEndpoint
          value:
            - name: id
              value: string
        - name: privateLinkServiceConnectionState
          value:
            - name: status
              value: string
            - name: description
              value: string
            - name: actionsRequired
              value: string
        - name: provisioningState
          value: string

DELETE example

Deletes the specified private_endpoint_connections resource.

/*+ delete */
DELETE FROM azure.synapse.private_endpoint_connections
WHERE privateEndpointConnectionName = '{{ privateEndpointConnectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';