Private Endpoint Connections - Get

Service:

Data Replication

Version d'API:

2024-09-01

Obtient les détails de la connexion du point de terminaison privé.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-09-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
privateEndpointConnectionName	path	True	string pattern: ^[a-zA-Z0-9]*$	Nom de la connexion du point de terminaison privé.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
vaultName	path	True	string pattern: ^[a-zA-Z0-9]*$	Nom du coffre.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	PrivateEndpointConnection	L’opération Azure s’est terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

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

Gets the Private Endpoint Connection

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/930CEC23-4430-4513-B855-DBA237E2F3BF/resourceGroups/rgswagger_2024-09-01/providers/Microsoft.DataReplication/replicationVaults/4/privateEndpointConnections/vbkm?api-version=2024-09-01

Exemple de réponse

Code d’état:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DataReplication/replicationVaults/vault1/privateEndpointConnections/connection1",
  "name": "kadsmyhrosefybpbwvwxs",
  "type": "ztysngp",
  "properties": {
    "provisioningState": "Canceled",
    "privateEndpoint": {
      "id": "cwcdqoynostmqwdwy"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "y",
      "actionsRequired": "afwbq"
    }
  }
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
PrivateEndpoint	Représente la ressource réseau de point de terminaison privée liée à la connexion de point de terminaison privé.
PrivateEndpointConnection	Représente une connexion de point de terminaison privé.
PrivateEndpointConnectionResponseProperties	Représente les propriétés de réponse de la connexion de point de terminaison privé.
PrivateEndpointConnectionStatus	Obtient ou définit l’état.
PrivateLinkServiceConnectionState	Représente l’état de la connexion au service de liaison privée.
ProvisioningState	Obtient ou définit l’état de provisionnement de la configuration de la messagerie.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

PrivateEndpoint

Object

Représente la ressource réseau de point de terminaison privée liée à la connexion de point de terminaison privé.

Nom	Type	Description
id	string	Obtient ou définit l’id.

PrivateEndpointConnection

Object

Représente une connexion de point de terminaison privé.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties	PrivateEndpointConnectionResponseProperties	Propriétés spécifiques à la ressource pour cette ressource.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointConnectionResponseProperties

Object

Représente les propriétés de réponse de la connexion de point de terminaison privé.

Nom	Type	Description
privateEndpoint	PrivateEndpoint	Représente la ressource réseau de point de terminaison privée liée à la connexion de point de terminaison privé.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Représente l’état de la connexion au service de liaison privée.
provisioningState	ProvisioningState	Obtient ou définit l’état d’approvisionnement de la connexion de point de terminaison privé.

PrivateEndpointConnectionStatus

Énumération

Obtient ou définit l’état.

Valeur	Description
Approved	Statut Approuvé.
Disconnected	État déconnecté.
Pending	Statut en attente.
Rejected	Statut Rejeté.

PrivateLinkServiceConnectionState

Object

Représente l’état de la connexion au service de liaison privée.

Nom	Type	Description
actionsRequired	string	Obtient ou définit les actions requises.
description	string	Obtient ou définit la description.
status	PrivateEndpointConnectionStatus	Obtient ou définit l’état.

ProvisioningState

Énumération

Obtient ou définit l’état de provisionnement de la configuration de la messagerie.

Valeur	Description
Canceled	La création de ressources a été annulée
Creating	La ressource est en cours de création.
Deleting	La ressource est en cours de suppression.
Deleted	La ressource a été supprimée.
Failed	Echec de la création de la ressource.
Succeeded	La création/mise à jour de la ressource a réussi.
Updating	La ressource est en cours de mise à jour.

systemData

Object

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

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.