private_endpoint_connection

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

Overview

Name	private_endpoint_connection
Type	Resource
Id	azure.data_factory.private_endpoint_connection

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
privateEndpoint	object	PrivateEndpoint of a remote private endpoint connection.
privateLinkServiceConnectionState	object	The state of a private link connection.
provisioningState	string	:vartype provisioning_state: str
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, factory_name, private_endpoint_connection_name, subscription_id		Gets a private endpoint connection.
create_or_update	insert	resource_group_name, factory_name, private_endpoint_connection_name, subscription_id		Approves or rejects a private endpoint connection.
create_or_update	replace	resource_group_name, factory_name, private_endpoint_connection_name, subscription_id		Approves or rejects a private endpoint connection.
delete	delete	resource_group_name, factory_name, private_endpoint_connection_name, subscription_id		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
factory_name	string	The factory name. Required.
private_endpoint_connection_name	string	The private endpoint connection name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a private endpoint connection.

SELECT
id,
name,
etag,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.data_factory.private_endpoint_connection
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND factory_name = '{{ factory_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Approves or rejects a private endpoint connection.

INSERT INTO azure.data_factory.private_endpoint_connection (
properties,
resource_group_name,
factory_name,
private_endpoint_connection_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ factory_name }}',
'{{ private_endpoint_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

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

REPLACE examples

create_or_update

Approves or rejects a private endpoint connection.

REPLACE azure.data_factory.private_endpoint_connection
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes a private endpoint connection.

DELETE FROM azure.data_factory.private_endpoint_connection
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND factory_name = '{{ factory_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;