private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.aks.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

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

list

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName, privateEndpointConnectionName		To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
list	select	subscriptionId, resourceGroupName, resourceName		To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
update	replace	subscriptionId, resourceGroupName, resourceName, privateEndpointConnectionName
delete	delete	subscriptionId, resourceGroupName, resourceName, privateEndpointConnectionName

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

SELECT examples

get

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters

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

list

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters

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

REPLACE examples

update

No description available.

REPLACE azure.aks.private_endpoint_connections
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

No description available.

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