cloud_hsm_cluster_private_endpoint_connections

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

Overview

Name	cloud_hsm_cluster_private_endpoint_connections
Type	Resource
Id	azure.hardware_security_modules.cloud_hsm_cluster_private_endpoint_connections

Fields

The following fields are returned by SELECT queries:

get

Private endpoint connection successfully returned.

Name	Datatype	Description
etag	string	Modified whenever there is a change in the state of private endpoint connection.
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, cloudHsmClusterName, peConnectionName		Gets the private endpoint connection for the Cloud Hsm Cluster.
create	insert	subscriptionId, resourceGroupName, cloudHsmClusterName, peConnectionName		Creates or updates the private endpoint connection for the Cloud Hsm Cluster.
delete	delete	subscriptionId, resourceGroupName, cloudHsmClusterName, peConnectionName		Deletes the private endpoint connection for 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
cloudHsmClusterName	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.
peConnectionName	string	Name of the private endpoint connection associated with the Cloud HSM Cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the private endpoint connection for the Cloud Hsm Cluster.

SELECT
etag,
properties
FROM azure.hardware_security_modules.cloud_hsm_cluster_private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND cloudHsmClusterName = '{{ cloudHsmClusterName }}' -- required
AND peConnectionName = '{{ peConnectionName }}' -- required
;

INSERT examples

create

Creates or updates the private endpoint connection for the Cloud Hsm Cluster.

INSERT INTO azure.hardware_security_modules.cloud_hsm_cluster_private_endpoint_connections (
data__properties,
data__etag,
subscriptionId,
resourceGroupName,
cloudHsmClusterName,
peConnectionName
)
SELECT 
'{{ properties }}',
'{{ etag }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ cloudHsmClusterName }}',
'{{ peConnectionName }}'
RETURNING
etag,
properties
;

Manifest

# Description fields are for documentation purposes
- name: cloud_hsm_cluster_private_endpoint_connections
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the cloud_hsm_cluster_private_endpoint_connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the cloud_hsm_cluster_private_endpoint_connections resource.
    - name: cloudHsmClusterName
      value: string
      description: Required parameter for the cloud_hsm_cluster_private_endpoint_connections resource.
    - name: peConnectionName
      value: string
      description: Required parameter for the cloud_hsm_cluster_private_endpoint_connections resource.
    - name: properties
      value: object
      description: |
        Resource properties.
    - name: etag
      value: string
      description: |
        Modified whenever there is a change in the state of private endpoint connection.

DELETE examples

delete

Deletes the private endpoint connection for the Cloud Hsm Cluster.

DELETE FROM azure.hardware_security_modules.cloud_hsm_cluster_private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND cloudHsmClusterName = '{{ cloudHsmClusterName }}' --required
AND peConnectionName = '{{ peConnectionName }}' --required
;