mhsm_private_endpoint_connections

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

Overview

Name	mhsm_private_endpoint_connections
Type	Resource
Id	azure.key_vault.mhsm_private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Private endpoint connection successfully returned.

Name	Datatype	Description
id	string	The Azure Resource Manager resource ID for the managed HSM Pool.
name	string	The name of the managed HSM Pool.
etag	string	Modified whenever there is a change in the state of private endpoint connection.
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The supported Azure location where the managed HSM Pool should be created.
properties	object	Resource properties.
sku	object	SKU details
systemData	object	Metadata pertaining to creation and last modification of the key vault resource.
tags	object	Resource tags
type	string	The resource type of the managed HSM Pool.

list_by_resource

Get information about all managed HSM Pools in the specified subscription.

Name	Datatype	Description
id	string	The Azure Resource Manager resource ID for the managed HSM Pool.
name	string	The name of the managed HSM Pool.
etag	string	Modified whenever there is a change in the state of private endpoint connection.
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The supported Azure location where the managed HSM Pool should be created.
properties	object	Resource properties.
sku	object	SKU details
systemData	object	Metadata pertaining to creation and last modification of the key vault resource.
tags	object	Resource tags
type	string	The resource type of the managed HSM Pool.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, name, privateEndpointConnectionName		Gets the specified private endpoint connection associated with the managed HSM Pool.
list_by_resource	select	subscriptionId, resourceGroupName, name		The List operation gets information about the private endpoint connections associated with the managed HSM Pool.
put	replace	subscriptionId, resourceGroupName, name, privateEndpointConnectionName		Updates the specified private endpoint connection associated with the managed hsm pool.
delete	delete	subscriptionId, resourceGroupName, name, privateEndpointConnectionName		Deletes the specified private endpoint connection associated with the managed hsm pool.

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

SELECT examples

get

Gets the specified private endpoint connection associated with the managed HSM Pool.

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

list_by_resource

The List operation gets information about the private endpoint connections associated with the managed HSM Pool.

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

REPLACE examples

put

Updates the specified private endpoint connection associated with the managed hsm pool.

REPLACE azure.key_vault.mhsm_private_endpoint_connections
SET 
data__properties = '{{ properties }}',
data__etag = '{{ etag }}',
data__location = '{{ location }}',
data__sku = '{{ sku }}',
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified private endpoint connection associated with the managed hsm pool.

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