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
- vw_private_endpoint_connections
- private_endpoint_connections
Name | Datatype | Description |
---|---|---|
group_ids | text | field from the properties object |
mongoClusterName | 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 |
Name | Datatype | Description |
---|---|---|
properties | object | Properties of the private endpoint connection. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | mongoClusterName, privateEndpointConnectionName, resourceGroupName, subscriptionId | Get a specific private connection |
list_by_mongo_cluster | SELECT | mongoClusterName, resourceGroupName, subscriptionId | List existing private connections |
create | INSERT | mongoClusterName, privateEndpointConnectionName, resourceGroupName, subscriptionId | Create a Private endpoint connection |
delete | DELETE | mongoClusterName, privateEndpointConnectionName, resourceGroupName, subscriptionId | Delete the private endpoint connection |
SELECT
examples
List existing private connections
- vw_private_endpoint_connections
- private_endpoint_connections
SELECT
group_ids,
mongoClusterName,
privateEndpointConnectionName,
private_endpoint,
private_link_service_connection_state,
provisioning_state,
resourceGroupName,
subscriptionId
FROM azure_isv.mongo_db.vw_private_endpoint_connections
WHERE mongoClusterName = '{{ mongoClusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
SELECT
properties
FROM azure_isv.mongo_db.private_endpoint_connections
WHERE mongoClusterName = '{{ mongoClusterName }}'
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
- Manifest
/*+ create */
INSERT INTO azure_isv.mongo_db.private_endpoint_connections (
mongoClusterName,
privateEndpointConnectionName,
resourceGroupName,
subscriptionId,
properties
)
SELECT
'{{ mongoClusterName }}',
'{{ privateEndpointConnectionName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;
- 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: []
DELETE
example
Deletes the specified private_endpoint_connections
resource.
/*+ delete */
DELETE FROM azure_isv.mongo_db.private_endpoint_connections
WHERE mongoClusterName = '{{ mongoClusterName }}'
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';