private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.cosmos_db.private_endpoint_connections

Fields

vw_private_endpoint_connections

Name	Datatype	Description
accountName	text	field from the properties object
group_id	text	field from the properties object
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
subscriptionId	text	field from the properties object

private_endpoint_connections

Name	Datatype	Description
properties	object	Properties of a private endpoint connection.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	accountName, privateEndpointConnectionName, resourceGroupName, subscriptionId	Gets a private endpoint connection.
list_by_database_account	SELECT	accountName, resourceGroupName, subscriptionId	List all private endpoint connections on a Cosmos DB account.
create_or_update	INSERT	accountName, privateEndpointConnectionName, resourceGroupName, subscriptionId	Approve or reject a private endpoint connection with a given name.
delete	DELETE	accountName, privateEndpointConnectionName, resourceGroupName, subscriptionId	Deletes a private endpoint connection with a given name.

SELECT examples

List all private endpoint connections on a Cosmos DB account.

vw_private_endpoint_connections

SELECT
accountName,
group_id,
privateEndpointConnectionName,
private_endpoint,
private_link_service_connection_state,
provisioning_state,
resourceGroupName,
subscriptionId
FROM azure.cosmos_db.vw_private_endpoint_connections
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

private_endpoint_connections

SELECT
properties
FROM azure.cosmos_db.private_endpoint_connections
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
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.cosmos_db.private_endpoint_connections (
accountName,
privateEndpointConnectionName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ accountName }}',
'{{ privateEndpointConnectionName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: privateEndpoint
          value:
            - name: id
              value: string
        - name: privateLinkServiceConnectionState
          value:
            - name: status
              value: string
            - name: description
              value: string
            - name: actionsRequired
              value: string
        - name: groupId
          value: string
        - name: provisioningState
          value: string

DELETE example

Deletes the specified private_endpoint_connections resource.

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