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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the 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.
privateEndpoint	object	Properties of the private endpoint object.
privateLinkServiceConnectionState	object	Approval state of the private link connection.
provisioningState	string	Provisioning state of the private endpoint connection. Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Failed", and "Disconnected". (Succeeded, Creating, Updating, Deleting, Failed, Disconnected)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags assigned to the key vault resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the 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.
privateEndpoint	object	Properties of the private endpoint object.
privateLinkServiceConnectionState	object	Approval state of the private link connection.
provisioningState	string	Provisioning state of the private endpoint connection. Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Failed", and "Disconnected". (Succeeded, Creating, Updating, Deleting, Failed, Disconnected)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags assigned to the key vault resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, vault_name, private_endpoint_connection_name, subscription_id		Gets the specified private endpoint connection associated with the key vault.
list_by_resource	select	resource_group_name, vault_name, subscription_id		The List operation gets information about the private endpoint connections associated with the vault.
delete	delete	resource_group_name, vault_name, private_endpoint_connection_name, subscription_id		Deletes the specified private endpoint connection associated with the key vault.
put	exec	resource_group_name, vault_name, private_endpoint_connection_name, subscription_id		Updates 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
private_endpoint_connection_name	string	Name of the private endpoint connection associated with the key vault. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vault_name	string	The name of the vault. Required.

SELECT examples

get

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

SELECT
id,
name,
etag,
location,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
tags,
type
FROM azure.key_vault.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource

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

SELECT
id,
name,
etag,
location,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
tags,
type
FROM azure.key_vault.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

delete

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

DELETE FROM azure.key_vault.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

put

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

EXEC azure.key_vault.private_endpoint_connections.put 
@resource_group_name='{{ resource_group_name }}' --required, 
@vault_name='{{ vault_name }}' --required, 
@private_endpoint_connection_name='{{ private_endpoint_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"etag": "{{ etag }}"
}'
;