Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. keyvault
  5. getMHSMPrivateEndpointConnection
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.keyvault.getMHSMPrivateEndpointConnection

Explore with Pulumi AI

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

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

    Uses Azure REST API version 2024-11-01.

    Other available API versions: 2023-02-01, 2023-07-01, 2024-04-01-preview, 2024-12-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native keyvault [ApiVersion]. See the version guide for details.

    Using getMHSMPrivateEndpointConnection

    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 getMHSMPrivateEndpointConnection(args: GetMHSMPrivateEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetMHSMPrivateEndpointConnectionResult>
function getMHSMPrivateEndpointConnectionOutput(args: GetMHSMPrivateEndpointConnectionOutputArgs, opts?: InvokeOptions): Output<GetMHSMPrivateEndpointConnectionResult>
    def get_mhsm_private_endpoint_connection(name: Optional[str] = None,
                                         private_endpoint_connection_name: Optional[str] = None,
                                         resource_group_name: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetMHSMPrivateEndpointConnectionResult
def get_mhsm_private_endpoint_connection_output(name: Optional[pulumi.Input[str]] = None,
                                         private_endpoint_connection_name: Optional[pulumi.Input[str]] = None,
                                         resource_group_name: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetMHSMPrivateEndpointConnectionResult]
    func LookupMHSMPrivateEndpointConnection(ctx *Context, args *LookupMHSMPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupMHSMPrivateEndpointConnectionResult, error)
func LookupMHSMPrivateEndpointConnectionOutput(ctx *Context, args *LookupMHSMPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupMHSMPrivateEndpointConnectionResultOutput

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

    public static class GetMHSMPrivateEndpointConnection 
{
    public static Task<GetMHSMPrivateEndpointConnectionResult> InvokeAsync(GetMHSMPrivateEndpointConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetMHSMPrivateEndpointConnectionResult> Invoke(GetMHSMPrivateEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMHSMPrivateEndpointConnectionResult> getMHSMPrivateEndpointConnection(GetMHSMPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetMHSMPrivateEndpointConnectionResult> getMHSMPrivateEndpointConnection(GetMHSMPrivateEndpointConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:keyvault:getMHSMPrivateEndpointConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    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.
    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.
    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.
    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.
    name str
    Name of the managed HSM Pool
    private_endpoint_connection_name str
    Name of the private endpoint connection associated with the managed hsm pool.
    resource_group_name str
    Name of the resource group that contains the managed HSM pool.
    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.

    getMHSMPrivateEndpointConnection Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The Azure Resource Manager resource ID for the managed HSM Pool.
    Name string
    The name of the managed HSM Pool.
    ProvisioningState string
    Provisioning state of the private endpoint connection.
    SystemData Pulumi.AzureNative.KeyVault.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the key vault resource.
    Type string
    The resource type of the managed HSM Pool.
    Etag string
    Modified whenever there is a change in the state of private endpoint connection.
    Identity Pulumi.AzureNative.KeyVault.Outputs.ManagedServiceIdentityResponse
    Managed service identity (system assigned and/or user assigned identities)
    Location string
    The supported Azure location where the managed HSM Pool should be created.
    PrivateEndpoint Pulumi.AzureNative.KeyVault.Outputs.MHSMPrivateEndpointResponse
    Properties of the private endpoint object.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.KeyVault.Outputs.MHSMPrivateLinkServiceConnectionStateResponse
    Approval state of the private link connection.
    Sku Pulumi.AzureNative.KeyVault.Outputs.ManagedHsmSkuResponse
    SKU details
    Tags Dictionary<string, string>
    Resource tags
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The Azure Resource Manager resource ID for the managed HSM Pool.
    Name string
    The name of the managed HSM Pool.
    ProvisioningState string
    Provisioning state of the private endpoint connection.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the key vault resource.
    Type string
    The resource type of the managed HSM Pool.
    Etag string
    Modified whenever there is a change in the state of private endpoint connection.
    Identity ManagedServiceIdentityResponse
    Managed service identity (system assigned and/or user assigned identities)
    Location string
    The supported Azure location where the managed HSM Pool should be created.
    PrivateEndpoint MHSMPrivateEndpointResponse
    Properties of the private endpoint object.
    PrivateLinkServiceConnectionState MHSMPrivateLinkServiceConnectionStateResponse
    Approval state of the private link connection.
    Sku ManagedHsmSkuResponse
    SKU details
    Tags map[string]string
    Resource tags
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The Azure Resource Manager resource ID for the managed HSM Pool.
    name String
    The name of the managed HSM Pool.
    provisioningState String
    Provisioning state of the private endpoint connection.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the key vault resource.
    type String
    The resource type of the managed HSM Pool.
    etag String
    Modified whenever there is a change in the state of private endpoint connection.
    identity ManagedServiceIdentityResponse
    Managed service identity (system assigned and/or user assigned identities)
    location String
    The supported Azure location where the managed HSM Pool should be created.
    privateEndpoint MHSMPrivateEndpointResponse
    Properties of the private endpoint object.
    privateLinkServiceConnectionState MHSMPrivateLinkServiceConnectionStateResponse
    Approval state of the private link connection.
    sku ManagedHsmSkuResponse
    SKU details
    tags Map<String,String>
    Resource tags
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The Azure Resource Manager resource ID for the managed HSM Pool.
    name string
    The name of the managed HSM Pool.
    provisioningState string
    Provisioning state of the private endpoint connection.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the key vault resource.
    type string
    The resource type of the managed HSM Pool.
    etag string
    Modified whenever there is a change in the state of private endpoint connection.
    identity ManagedServiceIdentityResponse
    Managed service identity (system assigned and/or user assigned identities)
    location string
    The supported Azure location where the managed HSM Pool should be created.
    privateEndpoint MHSMPrivateEndpointResponse
    Properties of the private endpoint object.
    privateLinkServiceConnectionState MHSMPrivateLinkServiceConnectionStateResponse
    Approval state of the private link connection.
    sku ManagedHsmSkuResponse
    SKU details
    tags {[key: string]: string}
    Resource tags
    azure_api_version str
    The Azure API version of the resource.
    id str
    The Azure Resource Manager resource ID for the managed HSM Pool.
    name str
    The name of the managed HSM Pool.
    provisioning_state str
    Provisioning state of the private endpoint connection.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the key vault resource.
    type str
    The resource type of the managed HSM Pool.
    etag str
    Modified whenever there is a change in the state of private endpoint connection.
    identity ManagedServiceIdentityResponse
    Managed service identity (system assigned and/or user assigned identities)
    location str
    The supported Azure location where the managed HSM Pool should be created.
    private_endpoint MHSMPrivateEndpointResponse
    Properties of the private endpoint object.
    private_link_service_connection_state MHSMPrivateLinkServiceConnectionStateResponse
    Approval state of the private link connection.
    sku ManagedHsmSkuResponse
    SKU details
    tags Mapping[str, str]
    Resource tags
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The Azure Resource Manager resource ID for the managed HSM Pool.
    name String
    The name of the managed HSM Pool.
    provisioningState String
    Provisioning state of the private endpoint connection.
    systemData Property Map
    Metadata pertaining to creation and last modification of the key vault resource.
    type String
    The resource type of the managed HSM Pool.
    etag String
    Modified whenever there is a change in the state of private endpoint connection.
    identity Property Map
    Managed service identity (system assigned and/or user assigned identities)
    location String
    The supported Azure location where the managed HSM Pool should be created.
    privateEndpoint Property Map
    Properties of the private endpoint object.
    privateLinkServiceConnectionState Property Map
    Approval state of the private link connection.
    sku Property Map
    SKU details
    tags Map<String>
    Resource tags

    Supporting Types

    MHSMPrivateEndpointResponse

    Id string
    Full identifier of the private endpoint resource.
    Id string
    Full identifier of the private endpoint resource.
    id String
    Full identifier of the private endpoint resource.
    id string
    Full identifier of the private endpoint resource.
    id str
    Full identifier of the private endpoint resource.
    id String
    Full identifier of the private endpoint resource.

    MHSMPrivateLinkServiceConnectionStateResponse

    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval or rejection.
    Status string
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval or rejection.
    Status string
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval or rejection.
    status String
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    actionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The reason for approval or rejection.
    status string
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    actions_required str
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The reason for approval or rejection.
    status str
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval or rejection.
    status String
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.

    ManagedHsmSkuResponse

    Family string
    SKU Family of the managed HSM Pool
    Name string
    SKU of the managed HSM Pool
    Family string
    SKU Family of the managed HSM Pool
    Name string
    SKU of the managed HSM Pool
    family String
    SKU Family of the managed HSM Pool
    name String
    SKU of the managed HSM Pool
    family string
    SKU Family of the managed HSM Pool
    name string
    SKU of the managed HSM Pool
    family str
    SKU Family of the managed HSM Pool
    name str
    SKU of the managed HSM Pool
    family String
    SKU Family of the managed HSM Pool
    name String
    SKU of the managed HSM Pool

    ManagedServiceIdentityResponse

    PrincipalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.KeyVault.Inputs.UserAssignedIdentityResponse>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    PrincipalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    UserAssignedIdentities map[string]UserAssignedIdentityResponse
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId String
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities Map<String,UserAssignedIdentityResponse>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principal_id str
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenant_id str
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type str
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId String
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities Map<Property Map>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

    SystemDataResponse

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

    UserAssignedIdentityResponse

    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.
    clientId string
    The client ID of the assigned identity.
    principalId string
    The principal ID of the assigned identity.
    client_id str
    The client ID of the assigned identity.
    principal_id str
    The principal ID of the assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.

    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.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native