private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.app_configuration.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	The properties of a private endpoint.
type	string	The type of the resource.

list_by_configuration_store

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	The properties of a private endpoint.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, configStoreName, privateEndpointConnectionName		Gets the specified private endpoint connection associated with the configuration store.
list_by_configuration_store	select	subscriptionId, resourceGroupName, configStoreName		Lists all private endpoint connections for a configuration store.
create_or_update	insert	subscriptionId, resourceGroupName, configStoreName, privateEndpointConnectionName		Update the state of the specified private endpoint connection associated with the configuration store. This operation cannot be used to create a private endpoint connection. Private endpoint connections must be created with the Network resource provider.
delete	delete	subscriptionId, resourceGroupName, configStoreName, privateEndpointConnectionName		Deletes a 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
configStoreName	string	The name of the configuration store.
privateEndpointConnectionName	string	Private endpoint connection name
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

Gets the specified private endpoint connection associated with the configuration store.

SELECT
id,
name,
properties,
type
FROM azure.app_configuration.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND configStoreName = '{{ configStoreName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;

list_by_configuration_store

Lists all private endpoint connections for a configuration store.

SELECT
id,
name,
properties,
type
FROM azure.app_configuration.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND configStoreName = '{{ configStoreName }}' -- required
;

INSERT examples

create_or_update

Update the state of the specified private endpoint connection associated with the configuration store. This operation cannot be used to create a private endpoint connection. Private endpoint connections must be created with the Network resource provider.

INSERT INTO azure.app_configuration.private_endpoint_connections (
data__properties,
subscriptionId,
resourceGroupName,
configStoreName,
privateEndpointConnectionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ configStoreName }}',
'{{ privateEndpointConnectionName }}'
RETURNING
id,
name,
properties,
type
;

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: configStoreName
      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 properties of a private endpoint.

DELETE examples

delete

Deletes a private endpoint connection.

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