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

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
get	select	resource_group_name, cloud_hsm_cluster_name, pe_connection_name, subscription_id		Gets the private endpoint connection for the Cloud Hsm Cluster.
create	insert	resource_group_name, cloud_hsm_cluster_name, pe_connection_name, subscription_id		Creates or updates the private endpoint connection for the Cloud Hsm Cluster.
delete	delete	resource_group_name, cloud_hsm_cluster_name, pe_connection_name, subscription_id		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
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.
pe_connection_name	string	Name of the private endpoint connection associated with the Cloud HSM Cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the private endpoint connection for the Cloud Hsm Cluster.

SELECT
id,
name,
etag,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.hardware_security_modules.cloud_hsm_cluster_private_endpoint_connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_hsm_cluster_name = '{{ cloud_hsm_cluster_name }}' -- required
AND pe_connection_name = '{{ pe_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
properties,
etag,
resource_group_name,
cloud_hsm_cluster_name,
pe_connection_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ etag }}',
'{{ resource_group_name }}',
'{{ cloud_hsm_cluster_name }}',
'{{ pe_connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: cloud_hsm_cluster_private_endpoint_connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the cloud_hsm_cluster_private_endpoint_connections resource.
  - name: cloud_hsm_cluster_name
    value: "{{ cloud_hsm_cluster_name }}"
    description: Required parameter for the cloud_hsm_cluster_private_endpoint_connections resource.
  - name: pe_connection_name
    value: "{{ pe_connection_name }}"
    description: Required parameter for the cloud_hsm_cluster_private_endpoint_connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the cloud_hsm_cluster_private_endpoint_connections resource.
  - name: properties
    description: |
      Resource properties.
    value:
      privateEndpoint:
        id: "{{ id }}"
      privateLinkServiceConnectionState:
        status: "{{ status }}"
        description: "{{ description }}"
        actionsRequired: "{{ actionsRequired }}"
      provisioningState: "{{ provisioningState }}"
      groupIds:
        - "{{ groupIds }}"
  - name: etag
    value: "{{ etag }}"
    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 resource_group_name = '{{ resource_group_name }}' --required
AND cloud_hsm_cluster_name = '{{ cloud_hsm_cluster_name }}' --required
AND pe_connection_name = '{{ pe_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;