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

The following fields are returned by SELECT queries:

get

Successfully retrieved a specified private endpoint connection.

Name	Datatype	Description
properties	object	Resource properties.

list_by_database_account

Successfully retrieved private endpoint connections.

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	subscriptionId, resourceGroupName, accountName, privateEndpointConnectionName		Gets a private endpoint connection.
list_by_database_account	select	subscriptionId, resourceGroupName, accountName		List all private endpoint connections on a Cosmos DB account.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, privateEndpointConnectionName		Approve or reject a private endpoint connection with a given name.
delete	delete	subscriptionId, resourceGroupName, accountName, 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
accountName	string	Cosmos DB database account name.
privateEndpointConnectionName	string	The name of the private endpoint connection.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a private endpoint connection.

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

list_by_database_account

List all private endpoint connections on a Cosmos DB account.

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

INSERT examples

create_or_update

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

INSERT INTO azure.cosmos_db.private_endpoint_connections (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ 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: accountName
      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 a private endpoint connection with a given name.

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