private_endpoint_connections

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

Overview

Name	private_endpoint_connections
Type	Resource
Id	azure.hardware_security_modules.private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

list_by_cloud_hsm_cluster

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.
groupIds	array	The group ids for the private endpoint resource.
privateEndpoint	object	The private endpoint resource.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider. Required.
provisioningState	string	The provisioning state of the private endpoint connection resource. Known values are: "Succeeded", "Creating", "Deleting", "Failed", "Updating", "InternalError", and "Canceled". (Succeeded, Creating, Deleting, Failed, Updating, InternalError, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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
list_by_cloud_hsm_cluster	select	resource_group_name, cloud_hsm_cluster_name, subscription_id		The List operation gets information about the private endpoint connections associated with the Cloud HSM Cluster.

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
cloud_hsm_cluster_name	string	The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

list_by_cloud_hsm_cluster

The List operation gets information about the private endpoint connections associated with the Cloud HSM Cluster.

SELECT
id,
name,
etag,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.hardware_security_modules.private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_hsm_cluster_name = '{{ cloud_hsm_cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;