private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure_isv.mongo_db.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list_by_mongo_cluster

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, mongoClusterName, privateEndpointConnectionName		Get a specific private connection
list_by_mongo_cluster	select	subscriptionId, resourceGroupName, mongoClusterName		List existing private connections
create	insert	subscriptionId, resourceGroupName, mongoClusterName, privateEndpointConnectionName		Create a Private endpoint connection
delete	delete	subscriptionId, resourceGroupName, mongoClusterName, privateEndpointConnectionName		Delete the private endpoint connection

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
mongoClusterName	string	The name of the mongo cluster.
privateEndpointConnectionName	string	The name of the private endpoint connection associated with the Azure resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a specific private connection

SELECT
properties
FROM azure_isv.mongo_db.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND mongoClusterName = '{{ mongoClusterName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;

list_by_mongo_cluster

List existing private connections

SELECT
properties
FROM azure_isv.mongo_db.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND mongoClusterName = '{{ mongoClusterName }}' -- required
;

INSERT examples

create

Create a Private endpoint connection

INSERT INTO azure_isv.mongo_db.private_endpoint_connections (
data__properties,
subscriptionId,
resourceGroupName,
mongoClusterName,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ mongoClusterName }}',
'{{ privateEndpointConnectionName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the private_endpoint_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: mongoClusterName
      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: |
        The resource-specific properties for this resource.

DELETE examples

delete

Delete the private endpoint connection

DELETE FROM azure_isv.mongo_db.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND mongoClusterName = '{{ mongoClusterName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
;