private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.monitor.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved a specified private endpoint connection.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	Resource properties.
tags		Resource tags
type	string	Azure resource type

list_by_private_link_scope

Successfully retrieved private endpoint connections.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	Resource properties.
tags		Resource tags
type	string	Azure resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, scopeName, privateEndpointConnectionName		Gets a private endpoint connection.
list_by_private_link_scope	select	subscriptionId, resourceGroupName, scopeName		Gets all private endpoint connections on a private link scope.
create_or_update	insert	subscriptionId, resourceGroupName, scopeName, privateEndpointConnectionName		Approve or reject a private endpoint connection with a given name.
delete	delete	subscriptionId, resourceGroupName, scopeName, privateEndpointConnectionName		Deletes a private endpoint connection with a given name.

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
privateEndpointConnectionName	string	The name of the private endpoint connection.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
scopeName	string	The name of the Azure Monitor PrivateLinkScope resource.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a private endpoint connection.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.monitor.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND scopeName = '{{ scopeName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;

list_by_private_link_scope

Gets all private endpoint connections on a private link scope.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.monitor.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND scopeName = '{{ scopeName }}' -- required
;

INSERT examples

create_or_update

Approve or reject a private endpoint connection with a given name.

INSERT INTO azure.monitor.private_endpoint_connections (
data__properties,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
scopeName,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ scopeName }}',
'{{ privateEndpointConnectionName }}'
RETURNING
id,
name,
location,
properties,
tags,
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: scopeName
      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.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: string
      description: |
        Resource tags

DELETE examples

delete

Deletes a private endpoint connection with a given name.

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