managed_instance_private_endpoint_connections

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

Overview

Name	managed_instance_private_endpoint_connections
Type	Resource
Id	azure.sql.managed_instance_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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, managedInstanceName, privateEndpointConnectionName, subscriptionId		Gets a private endpoint connection.
create_or_update	insert	resourceGroupName, managedInstanceName, privateEndpointConnectionName, subscriptionId		Approve or reject a private endpoint connection with a given name.
delete	delete	resourceGroupName, managedInstanceName, privateEndpointConnectionName, subscriptionId		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
managedInstanceName	string	The name of the managed instance.
privateEndpointConnectionName	string
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a private endpoint connection.

SELECT
properties
FROM azure.sql.managed_instance_private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.sql.managed_instance_private_endpoint_connections (
data__properties,
resourceGroupName,
managedInstanceName,
privateEndpointConnectionName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ managedInstanceName }}',
'{{ privateEndpointConnectionName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

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