Skip to main content

private_endpoint_connections

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

Overview

Nameprivate_endpoint_connections
TypeResource
Idazure.key_vault.private_endpoint_connections

Fields

NameDatatypeDescription
idtextFully qualified identifier of the key vault resource.
nametextName of the key vault resource.
etagtextModified whenever there is a change in the state of private endpoint connection.
locationtextAzure location of the key vault resource.
privateEndpointConnectionNametextfield from the properties object
private_endpointtextfield from the properties object
private_link_service_connection_statetextfield from the properties object
provisioning_statetextfield from the properties object
resourceGroupNametextfield from the properties object
subscriptionIdtextfield from the properties object
tagstextTags assigned to the key vault resource.
typetextResource type of the key vault resource.
vaultNametextfield from the properties object

Methods

NameAccessible byRequired ParamsDescription
getSELECTprivateEndpointConnectionName, resourceGroupName, subscriptionId, vaultNameGets the specified private endpoint connection associated with the key vault.
list_by_resourceSELECTresourceGroupName, subscriptionId, vaultNameThe List operation gets information about the private endpoint connections associated with the vault.
deleteDELETEprivateEndpointConnectionName, resourceGroupName, subscriptionId, vaultNameDeletes the specified private endpoint connection associated with the key vault.
putREPLACEprivateEndpointConnectionName, resourceGroupName, subscriptionId, vaultNameUpdates the specified private endpoint connection associated with the key vault.

SELECT examples

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

SELECT
id,
name,
etag,
location,
privateEndpointConnectionName,
private_endpoint,
private_link_service_connection_state,
provisioning_state,
resourceGroupName,
subscriptionId,
tags,
type,
vaultName
FROM azure.key_vault.vw_private_endpoint_connections
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vaultName = '{{ vaultName }}';

REPLACE example

Replaces all fields in the specified private_endpoint_connections resource.

/*+ update */
REPLACE azure.key_vault.private_endpoint_connections
SET
properties = '{{ properties }}',
etag = '{{ etag }}'
WHERE
privateEndpointConnectionName = '{{ privateEndpointConnectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vaultName = '{{ vaultName }}';

DELETE example

Deletes the specified private_endpoint_connections resource.

/*+ delete */
DELETE FROM azure.key_vault.private_endpoint_connections
WHERE privateEndpointConnectionName = '{{ privateEndpointConnectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vaultName = '{{ vaultName }}';