Partager via


MHSM Private Endpoint Connections - Get

Obtient la connexion de point de terminaison privé spécifiée associée au pool HSM managé.

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

Paramètres URI

Nom Dans Obligatoire Type Description
name
path True

string

Nom du pool HSM managé

privateEndpointConnectionName
path True

string

Nom de la connexion de point de terminaison privé associée au pool hsm managé.

resourceGroupName
path True

string

Nom du groupe de ressources qui contient le pool HSM managé.

subscriptionId
path True

string

Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True

string

Version de l’API cliente.

Réponses

Nom Type Description
200 OK

MHSMPrivateEndpointConnection

La connexion de point de terminaison privé a été retournée.

Other Status Codes

ManagedHsmError

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

ManagedHsmGetPrivateEndpointConnection

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
ActionsRequired

Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.

Error

Erreur du serveur.

identityType

Type d’identité qui a créé la ressource de coffre de clés.

ManagedHsmError

Exception d'erreur.

ManagedHsmSku

Détails de la référence SKU

ManagedHsmSkuFamily

Famille de références SKU du pool HSM managé

ManagedHsmSkuName

Référence SKU du pool HSM managé

MHSMPrivateEndpoint

Propriétés de l’objet de point de terminaison privé.

MHSMPrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

MHSMPrivateLinkServiceConnectionState

Objet qui représente l’état d’approbation de la connexion de liaison privée.

PrivateEndpointConnectionProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.

PrivateEndpointServiceConnectionStatus

Indique si la connexion a été approuvée, rejetée ou supprimée par le propriétaire du coffre de clés.

SystemData

Métadonnées relatives à la création et à la dernière modification de la ressource de coffre de clés.

ActionsRequired

Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.

Nom Type Description
None

string

Error

Erreur du serveur.

Nom Type Description
code

string

Code d'erreur.

innererror

Error

L’erreur interne contient un code d’erreur plus spécifique.

message

string

Message d’erreur.

identityType

Type d’identité qui a créé la ressource de coffre de clés.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ManagedHsmError

Exception d'erreur.

Nom Type Description
error

Error

Erreur du serveur.

ManagedHsmSku

Détails de la référence SKU

Nom Type Description
family

ManagedHsmSkuFamily

Famille de références SKU du pool HSM managé

name

ManagedHsmSkuName

Référence SKU du pool HSM managé

ManagedHsmSkuFamily

Famille de références SKU du pool HSM managé

Nom Type Description
B

string

ManagedHsmSkuName

Référence SKU du pool HSM managé

Nom Type Description
Custom_B32

string

Custom_B6

string

Standard_B1

string

MHSMPrivateEndpoint

Propriétés de l’objet de point de terminaison privé.

Nom Type Description
id

string

Identificateur complet de la ressource de point de terminaison privé.

MHSMPrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

Nom Type Description
etag

string

Modifié chaque fois qu’il y a un changement dans l’état de la connexion de point de terminaison privé.

id

string

L’ID de ressource Azure Resource Manager pour le pool HSM managé.

location

string

Emplacement Azure pris en charge où le pool HSM managé doit être créé.

name

string

Nom du pool HSM managé.

properties.privateEndpoint

MHSMPrivateEndpoint

Propriétés de l’objet de point de terminaison privé.

properties.privateLinkServiceConnectionState

MHSMPrivateLinkServiceConnectionState

État d’approbation de la connexion de liaison privée.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.

sku

ManagedHsmSku

Détails de la référence SKU

systemData

SystemData

Métadonnées relatives à la création et à la dernière modification de la ressource de coffre de clés.

tags

object

Balises de ressource

type

string

Type de ressource du pool HSM managé.

MHSMPrivateLinkServiceConnectionState

Objet qui représente l’état d’approbation de la connexion de liaison privée.

Nom Type Description
actionsRequired

ActionsRequired

Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.

description

string

Motif de l’approbation ou du rejet.

status

PrivateEndpointServiceConnectionStatus

Indique si la connexion a été approuvée, rejetée ou supprimée par le propriétaire du coffre de clés.

PrivateEndpointConnectionProvisioningState

État d’approvisionnement de la connexion de point de terminaison privé.

Nom Type Description
Creating

string

Deleting

string

Disconnected

string

Failed

string

Succeeded

string

Updating

string

PrivateEndpointServiceConnectionStatus

Indique si la connexion a été approuvée, rejetée ou supprimée par le propriétaire du coffre de clés.

Nom Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

SystemData

Métadonnées relatives à la création et à la dernière modification de la ressource de coffre de clés.

Nom Type Description
createdAt

string

Horodatage de la création de la ressource de coffre de clés (UTC).

createdBy

string

Identité qui a créé la ressource de coffre de clés.

createdByType

identityType

Type d’identité qui a créé la ressource de coffre de clés.

lastModifiedAt

string

Horodatage de la dernière modification (UTC) de la ressource de coffre de clés.

lastModifiedBy

string

Identité qui a modifié la dernière ressource de coffre de clés.

lastModifiedByType

identityType

Type d’identité qui a modifié la dernière ressource de coffre de clés.