MHSM Private Endpoint Connections - Get

Referência

Service:: Key Vault

API Version:: 2022-07-01

Obtém a ligação de ponto final privado especificada associada ao Conjunto de HSM gerido.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
name	path	True	string	Nome do Conjunto de HSM gerido
privateEndpointConnectionName	path	True	string	Nome da ligação de ponto final privado associada ao conjunto hsm gerido.
resourceGroupName	path	True	string	Nome do grupo de recursos que contém o conjunto de HSM gerido.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do Cliente.

Respostas

Name	Tipo	Description
200 OK	MHSMPrivateEndpointConnection	Ligação de ponto final privado devolvida com êxito.
Other Status Codes	ManagedHsmError	A resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

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"
    }
  }
}

Definições

Name	Description
ActionsRequired	Uma mensagem a indicar se as alterações no fornecedor de serviços requerem atualizações no consumidor.
Error	O erro do servidor.
identityType	O tipo de identidade que criou o recurso do cofre de chaves.
ManagedHsmError	A exceção de erro.
ManagedHsmSku	Detalhes do SKU
ManagedHsmSkuFamily	Família de SKU do Conjunto de HSM gerido
ManagedHsmSkuName	SKU do Conjunto de HSM gerido
MHSMPrivateEndpoint	Propriedades do objeto de ponto final privado.
MHSMPrivateEndpointConnection	Recurso de ligação de ponto final privado.
MHSMPrivateLinkServiceConnectionState	Um objeto que representa o estado de aprovação da ligação de ligação privada.
PrivateEndpointConnectionProvisioningState	Estado de aprovisionamento da ligação de ponto final privado.
PrivateEndpointServiceConnectionStatus	Indica se a ligação foi aprovada, rejeitada ou removida pelo proprietário do cofre de chaves.
SystemData	Metadados relativos à criação e última modificação do recurso do cofre de chaves.

ActionsRequired

Uma mensagem a indicar se as alterações no fornecedor de serviços requerem atualizações no consumidor.

Name	Tipo	Description
None	string

Error

O erro do servidor.

Name	Tipo	Description
code	string	O código de erro.
innererror	Error	O erro interno contém um código de erro mais específico.
message	string	A mensagem de erro.

identityType

O tipo de identidade que criou o recurso do cofre de chaves.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmError

A exceção de erro.

Name	Tipo	Description
error	Error	O erro do servidor.

ManagedHsmSku

Detalhes do SKU

Name	Tipo	Description
family	ManagedHsmSkuFamily	Família de SKU do Conjunto de HSM gerido
name	ManagedHsmSkuName	SKU do Conjunto de HSM gerido

ManagedHsmSkuFamily

Família de SKU do Conjunto de HSM gerido

Name	Tipo	Description
B	string

ManagedHsmSkuName

SKU do Conjunto de HSM gerido

Name	Tipo	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string