Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. hardwaresecuritymodules
  5. getCloudHsmClusterPrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.hardwaresecuritymodules.getCloudHsmClusterPrivateEndpointConnection

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the private endpoint connection for the Cloud Hsm Cluster.

    Uses Azure REST API version 2024-06-30-preview.

    Other available API versions: 2022-08-31-preview, 2023-12-10-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native hardwaresecuritymodules [ApiVersion]. See the version guide for details.

    Using getCloudHsmClusterPrivateEndpointConnection

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCloudHsmClusterPrivateEndpointConnection(args: GetCloudHsmClusterPrivateEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetCloudHsmClusterPrivateEndpointConnectionResult>
function getCloudHsmClusterPrivateEndpointConnectionOutput(args: GetCloudHsmClusterPrivateEndpointConnectionOutputArgs, opts?: InvokeOptions): Output<GetCloudHsmClusterPrivateEndpointConnectionResult>
    def get_cloud_hsm_cluster_private_endpoint_connection(cloud_hsm_cluster_name: Optional[str] = None,
                                                      pe_connection_name: Optional[str] = None,
                                                      resource_group_name: Optional[str] = None,
                                                      opts: Optional[InvokeOptions] = None) -> GetCloudHsmClusterPrivateEndpointConnectionResult
def get_cloud_hsm_cluster_private_endpoint_connection_output(cloud_hsm_cluster_name: Optional[pulumi.Input[str]] = None,
                                                      pe_connection_name: Optional[pulumi.Input[str]] = None,
                                                      resource_group_name: Optional[pulumi.Input[str]] = None,
                                                      opts: Optional[InvokeOptions] = None) -> Output[GetCloudHsmClusterPrivateEndpointConnectionResult]
    func LookupCloudHsmClusterPrivateEndpointConnection(ctx *Context, args *LookupCloudHsmClusterPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupCloudHsmClusterPrivateEndpointConnectionResult, error)
func LookupCloudHsmClusterPrivateEndpointConnectionOutput(ctx *Context, args *LookupCloudHsmClusterPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupCloudHsmClusterPrivateEndpointConnectionResultOutput

    > Note: This function is named LookupCloudHsmClusterPrivateEndpointConnection in the Go SDK.

    public static class GetCloudHsmClusterPrivateEndpointConnection 
{
    public static Task<GetCloudHsmClusterPrivateEndpointConnectionResult> InvokeAsync(GetCloudHsmClusterPrivateEndpointConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudHsmClusterPrivateEndpointConnectionResult> Invoke(GetCloudHsmClusterPrivateEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCloudHsmClusterPrivateEndpointConnectionResult> getCloudHsmClusterPrivateEndpointConnection(GetCloudHsmClusterPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetCloudHsmClusterPrivateEndpointConnectionResult> getCloudHsmClusterPrivateEndpointConnection(GetCloudHsmClusterPrivateEndpointConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:hardwaresecuritymodules:getCloudHsmClusterPrivateEndpointConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    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.
    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.
    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.
    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.
    cloud_hsm_cluster_name str
    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.
    pe_connection_name str
    Name of the private endpoint connection associated with the Cloud HSM Cluster.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    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.

    getCloudHsmClusterPrivateEndpointConnection Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    GroupIds List<string>
    The group ids for the private endpoint resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    PrivateLinkServiceConnectionState Pulumi.AzureNative.HardwareSecurityModules.Outputs.PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    ProvisioningState string
    The provisioning state of the private endpoint connection resource.
    SystemData Pulumi.AzureNative.HardwareSecurityModules.Outputs.SystemDataResponse
    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"
    Etag string
    Modified whenever there is a change in the state of private endpoint connection.
    PrivateEndpoint Pulumi.AzureNative.HardwareSecurityModules.Outputs.PrivateEndpointResponse
    The private endpoint resource.
    AzureApiVersion string
    The Azure API version of the resource.
    GroupIds []string
    The group ids for the private endpoint resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    ProvisioningState string
    The provisioning state of the private endpoint connection resource.
    SystemData SystemDataResponse
    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"
    Etag string
    Modified whenever there is a change in the state of private endpoint connection.
    PrivateEndpoint PrivateEndpointResponse
    The private endpoint resource.
    azureApiVersion String
    The Azure API version of the resource.
    groupIds List<String>
    The group ids for the private endpoint resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState String
    The provisioning state of the private endpoint connection resource.
    systemData SystemDataResponse
    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"
    etag String
    Modified whenever there is a change in the state of private endpoint connection.
    privateEndpoint PrivateEndpointResponse
    The private endpoint resource.
    azureApiVersion string
    The Azure API version of the resource.
    groupIds string[]
    The group ids for the private endpoint resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState string
    The provisioning state of the private endpoint connection resource.
    systemData SystemDataResponse
    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"
    etag string
    Modified whenever there is a change in the state of private endpoint connection.
    privateEndpoint PrivateEndpointResponse
    The private endpoint resource.
    azure_api_version str
    The Azure API version of the resource.
    group_ids Sequence[str]
    The group ids for the private endpoint resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioning_state str
    The provisioning state of the private endpoint connection resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    etag str
    Modified whenever there is a change in the state of private endpoint connection.
    private_endpoint PrivateEndpointResponse
    The private endpoint resource.
    azureApiVersion String
    The Azure API version of the resource.
    groupIds List<String>
    The group ids for the private endpoint resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    privateLinkServiceConnectionState Property Map
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState String
    The provisioning state of the private endpoint connection resource.
    systemData Property Map
    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"
    etag String
    Modified whenever there is a change in the state of private endpoint connection.
    privateEndpoint Property Map
    The private endpoint resource.

    Supporting Types

    PrivateEndpointResponse

    Id string
    The ARM identifier for private endpoint.
    Id string
    The ARM identifier for private endpoint.
    id String
    The ARM identifier for private endpoint.
    id string
    The ARM identifier for private endpoint.
    id str
    The ARM identifier for private endpoint.
    id String
    The ARM identifier for private endpoint.

    PrivateLinkServiceConnectionStateResponse

    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The reason for approval/rejection of the connection.
    status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actions_required str
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The reason for approval/rejection of the connection.
    status str
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
    pulumi/pulumi-azure-native