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

vw_private_endpoint_connections

Name	Datatype	Description
id	text	Azure resource Id
name	text	Azure resource name
group_ids	text	field from the properties object
location	text	Resource location
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
scopeName	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters.
type	text	Azure resource type

private_endpoint_connections

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	Properties of the private endpoint connection.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters.
type	string	Azure resource type

Methods

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

SELECT examples

Gets all private endpoint connections on a private link scope.

vw_private_endpoint_connections

SELECT
id,
name,
group_ids,
location,
privateEndpointConnectionName,
private_endpoint,
private_link_service_connection_state,
provisioning_state,
resourceGroupName,
scopeName,
subscriptionId,
system_data,
tags,
type
FROM azure.monitor.vw_private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND scopeName = '{{ scopeName }}'
AND subscriptionId = '{{ subscriptionId }}';

private_endpoint_connections

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.monitor.private_endpoint_connections (
privateEndpointConnectionName,
resourceGroupName,
scopeName,
subscriptionId,
properties,
location,
tags
)
SELECT 
'{{ privateEndpointConnectionName }}',
'{{ resourceGroupName }}',
'{{ scopeName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: groupIds
          value:
            - string
        - name: privateEndpoint
          value:
            - name: id
              value: string
        - name: privateLinkServiceConnectionState
          value:
            - name: status
              value: []
            - name: description
              value: string
            - name: actionsRequired
              value: string
        - name: provisioningState
          value: []
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

DELETE example

Deletes the specified private_endpoint_connections resource.

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