MHSM Private Endpoint Connections - Get

Reference

Service:: Key Vault

API Version:: 2022-07-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2022-07-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the managed HSM Pool
privateEndpointConnectionName	path	True	string	Name of the private endpoint connection associated with the managed hsm pool.
resourceGroupName	path	True	string	Name of the resource group that contains the managed HSM pool.
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	MHSMPrivateEndpointConnection	Private endpoint connection successfully returned.
Other Status Codes	ManagedHsmError	The error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ManagedHsmGetPrivateEndpointConnection

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/privateEndpointConnections/sample-pec?api-version=2022-07-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python managed_hsm_get_private_endpoint_connection.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.mhsm_private_endpoint_connections.get(
        resource_group_name="sample-group",
        name="sample-mhsm",
        private_endpoint_connection_name="sample-pec",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_getPrivateEndpointConnection.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
  "etag": "",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "This was automatically approved by user1234@contoso.com",
      "actionsRequired": "None"
    }
  }
}

Definitions

Name	Description
ActionsRequired	A message indicating if changes on the service provider require any updates on the consumer.
Error	The server error.
identityType	The type of identity that created the key vault resource.
ManagedHsmError	The error exception.
ManagedHsmSku	SKU details
ManagedHsmSkuFamily	SKU Family of the managed HSM Pool
ManagedHsmSkuName	SKU of the managed HSM Pool
MHSMPrivateEndpoint	Private endpoint object properties.
MHSMPrivateEndpointConnection	Private endpoint connection resource.
MHSMPrivateLinkServiceConnectionState	An object that represents the approval state of the private link connection.
PrivateEndpointConnectionProvisioningState	Provisioning state of the private endpoint connection.
PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been approved, rejected or removed by the key vault owner.
SystemData	Metadata pertaining to creation and last modification of the key vault resource.

ActionsRequired

A message indicating if changes on the service provider require any updates on the consumer.

Name	Type	Description
None	string

Error

The server error.

Name	Type	Description
code	string	The error code.
innererror	Error	The inner error, contains a more specific error code.
message	string	The error message.

identityType

The type of identity that created the key vault resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmError

The error exception.

Name	Type	Description
error	Error	The server error.

ManagedHsmSku

SKU details

Name	Type	Description
family	ManagedHsmSkuFamily	SKU Family of the managed HSM Pool
name	ManagedHsmSkuName	SKU of the managed HSM Pool

ManagedHsmSkuFamily

SKU Family of the managed HSM Pool

Name	Type	Description
B	string

ManagedHsmSkuName

SKU of the managed HSM Pool

Name	Type	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string