private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.azure_active_directory.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Private endpoint connection successfully returned.

Name	Datatype	Description
properties	object	Resource properties.

list_by_policy_name

Private Endpoint Connections for given policy returned successfully

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, policyName, privateEndpointConnectionName, subscriptionId		Gets the specified private endpoint connection associated with the given policy.
list_by_policy_name	select	resourceGroupName, policyName, subscriptionId		Lists all Private Endpoint Connections for the given policy.
create	insert	subscriptionId, resourceGroupName, policyName, privateEndpointConnectionName		Creates specified private endpoint connection associated with the given policy.
delete	delete	resourceGroupName, policyName, privateEndpointConnectionName, subscriptionId		Deletes the specified private endpoint connection associated with the given policy.

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
policyName	string	The name of the private link policy in Azure AD.
privateEndpointConnectionName	string	The PrivateEndpointConnection name.
resourceGroupName	string	Name of an Azure resource group.
subscriptionId	string	Azure subscription ID.

SELECT examples

get

Gets the specified private endpoint connection associated with the given policy.

SELECT
properties
FROM azure.azure_active_directory.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND policyName = '{{ policyName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_policy_name

Lists all Private Endpoint Connections for the given policy.

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

INSERT examples

create

Creates specified private endpoint connection associated with the given policy.

INSERT INTO azure.azure_active_directory.private_endpoint_connections (
data__properties,
subscriptionId,
resourceGroupName,
policyName,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ policyName }}',
'{{ privateEndpointConnectionName }}'
RETURNING
properties
;

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: policyName
      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: |
        Resource properties.

DELETE examples

delete

Deletes the specified private endpoint connection associated with the given policy.

DELETE FROM azure.azure_active_directory.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND policyName = '{{ policyName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;