private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.data_factory.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
etag	string	Etag identifies change in the resource.
properties	object	Core resource properties
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, factoryName, privateEndpointConnectionName	api-version, If-None-Match	Gets a private endpoint connection
create_or_update	insert	subscriptionId, resourceGroupName, factoryName, privateEndpointConnectionName	api-version, If-Match	Approves or rejects a private endpoint connection
delete	delete	subscriptionId, resourceGroupName, factoryName, privateEndpointConnectionName	api-version	Deletes 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
factoryName	string	The factory name.
privateEndpointConnectionName	string	The private endpoint connection name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription identifier.
If-Match	string	ETag of the private endpoint connection entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.
If-None-Match	string	ETag of the private endpoint connection entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.
api-version	string	The API version.

SELECT examples

get

Gets a private endpoint connection

SELECT
id,
name,
etag,
properties,
type
FROM azure.data_factory.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND factoryName = '{{ factoryName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
AND api-version = '{{ api-version }}'
AND If-None-Match = '{{ If-None-Match }}'
;

INSERT examples

create_or_update

Approves or rejects a private endpoint connection

INSERT INTO azure.data_factory.private_endpoint_connections (
data__properties,
subscriptionId,
resourceGroupName,
factoryName,
privateEndpointConnectionName,
api-version,
If-Match
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ factoryName }}',
'{{ privateEndpointConnectionName }}',
'{{ api-version }}',
'{{ If-Match }}'
RETURNING
id,
name,
etag,
properties,
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: factoryName
      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: |
        Core resource properties
    - name: api-version
      value: string
      description: The API version.
    - name: If-Match
      value: string
      description: ETag of the private endpoint connection entity.  Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

DELETE examples

delete

Deletes a private endpoint connection

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