private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.key_vault.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Private endpoint connection successfully returned.

Name	Datatype	Description
id	string	Fully qualified identifier of the key vault resource.
name	string	Name of the key vault resource.
etag	string	Modified whenever there is a change in the state of private endpoint connection.
location	string	Azure location of the key vault resource.
properties	object	Resource properties.
tags	object	Tags assigned to the key vault resource.
type	string	Resource type of the key vault resource.

list_by_resource

Get information about all private endpoint connections in the specified resource group.

Name	Datatype	Description
id	string	Fully qualified identifier of the key vault resource.
name	string	Name of the key vault resource.
etag	string	Modified whenever there is a change in the state of private endpoint connection.
location	string	Azure location of the key vault resource.
properties	object	Resource properties.
tags	object	Tags assigned to the key vault resource.
type	string	Resource type of the key vault resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, vaultName, privateEndpointConnectionName		Gets the specified private endpoint connection associated with the key vault.
list_by_resource	select	subscriptionId, resourceGroupName, vaultName		The List operation gets information about the private endpoint connections associated with the vault.
put	replace	subscriptionId, resourceGroupName, vaultName, privateEndpointConnectionName		Updates the specified private endpoint connection associated with the key vault.
delete	delete	subscriptionId, resourceGroupName, vaultName, privateEndpointConnectionName		Deletes the specified private endpoint connection associated with the key vault.

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	Name of the private endpoint connection associated with the key vault.
resourceGroupName	string	Name of the resource group that contains the key vault.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vaultName	string	The name of the key vault.

SELECT examples

get

Gets the specified private endpoint connection associated with the key vault.

SELECT
id,
name,
etag,
location,
properties,
tags,
type
FROM azure.key_vault.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;

list_by_resource

The List operation gets information about the private endpoint connections associated with the vault.

SELECT
id,
name,
etag,
location,
properties,
tags,
type
FROM azure.key_vault.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
;

REPLACE examples

put

Updates the specified private endpoint connection associated with the key vault.

REPLACE azure.key_vault.private_endpoint_connections
SET 
data__properties = '{{ properties }}',
data__etag = '{{ etag }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vaultName = '{{ vaultName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified private endpoint connection associated with the key vault.

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