private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.maria_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_server

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	resourceGroupName, serverName, privateEndpointConnectionName, subscriptionId		Gets a private endpoint connection.
list_by_server	select	resourceGroupName, serverName, subscriptionId		Gets all private endpoint connections on a server.
create_or_update	insert	resourceGroupName, serverName, privateEndpointConnectionName, subscriptionId		Approve or reject a private endpoint connection with a given name.
delete	delete	resourceGroupName, serverName, privateEndpointConnectionName, subscriptionId		Deletes a private endpoint connection with a given name.
update_tags	exec	subscriptionId, resourceGroupName, serverName, privateEndpointConnectionName		Updates private endpoint connection with the specified tags.

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
privateEndpointConnectionName	string
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serverName	string	The name of the server.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a private endpoint connection.

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

list_by_server

Gets all private endpoint connections on a server.

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

INSERT examples

create_or_update

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

INSERT INTO azure.maria_db.private_endpoint_connections (
data__properties,
resourceGroupName,
serverName,
privateEndpointConnectionName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ privateEndpointConnectionName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoint_connections
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_endpoint_connections resource.
    - name: serverName
      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: subscriptionId
      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.maria_db.private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates private endpoint connection with the specified tags.

EXEC azure.maria_db.private_endpoint_connections.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required, 
@privateEndpointConnectionName='{{ privateEndpointConnectionName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;