Private Endpoint Connections - Get

Service:: Search Management

Version d’API:: 2023-11-01

Obtient les détails de la connexion de point de terminaison privé au service de recherche dans le groupe de ressources donné.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2023-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
privateEndpointConnectionName	path	True	string	Nom de la connexion de point de terminaison privé au service de recherche avec le groupe de ressources spécifié.
resourceGroupName	path	True	string	Nom du groupe de ressources dans l’abonnement actuel. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
searchServiceName	path	True	string	Nom du service de recherche associé au groupe de ressources spécifié.
subscriptionId	path	True	string	Identificateur unique d’un abonnement Microsoft Azure. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager, des outils en ligne de commande ou du portail.
api-version	query	True	string	Version de l’API à utiliser pour chaque requête.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string (uuid)	Valeur GUID générée par le client qui identifie cette requête. S’il est spécifié, cela sera inclus dans les informations de réponse comme moyen de suivre la demande.

Réponses

Nom	Type	Description
200 OK	PrivateEndpointConnection	La définition de la connexion de point de terminaison privé a été récupérée avec succès et se trouve dans la réponse.
Other Status Codes	CloudError	HTTP 404 (introuvable) : impossible de trouver l’abonnement, le groupe de ressources, le service de recherche ou la connexion de point de terminaison privé.

Sécurité

azure_auth

Flux d’autorisation OAuth2 d’ID Microsoft Entra.

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

PrivateEndpointConnectionGet

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546?api-version=2023-11-01

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
  "name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
  "type": "Microsoft.Search/searchServices/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "",
      "actionsRequired": "None"
    }
  }
}

Définitions

Nom	Description
CloudError	Contient des informations sur une erreur d’API.
CloudErrorBody	Décrit une erreur d’API particulière avec un code d’erreur et un message.
PrivateEndpoint	Ressource de point de terminaison privé du fournisseur Microsoft.Network.
PrivateEndpointConnection	Décrit une connexion de point de terminaison privé existante au service de recherche.
PrivateEndpointConnectionProperties	Décrit les propriétés d’une connexion de point de terminaison privé existante au service de recherche.
PrivateLinkServiceConnectionProvisioningState	État d’approvisionnement de la connexion de service de liaison privée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussite ou Incomplet
PrivateLinkServiceConnectionState	Décrit l’état actuel d’une connexion de service Private Link existante au point de terminaison privé Azure.
PrivateLinkServiceConnectionStatus	État de la connexion du service de liaison privée. Les valeurs valides sont en attente, approuvées, rejetées ou déconnectées.

CloudError

Objet

Contient des informations sur une erreur d’API.

Nom	Type	Description
error	CloudErrorBody	Décrit une erreur d’API particulière avec un code d’erreur et un message.

CloudErrorBody

Objet

Décrit une erreur d’API particulière avec un code d’erreur et un message.

Nom	Type	Description
code	string	Code d’erreur qui décrit la condition d’erreur plus précisément qu’un code d’état HTTP. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
details	CloudErrorBody[]	Contient des erreurs imbriquées liées à cette erreur.
message	string	Message qui décrit en détail l’erreur et fournit des informations de débogage.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur).

PrivateEndpoint

Objet

Ressource de point de terminaison privé du fournisseur Microsoft.Network.

Nom	Type	Description
id	string	ID de ressource de la ressource de point de terminaison privé du fournisseur Microsoft.Network.

PrivateEndpointConnection

Objet

Décrit une connexion de point de terminaison privé existante au service de recherche.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties	PrivateEndpointConnectionProperties	Décrit les propriétés d’une connexion de point de terminaison privé existante au service de recherche.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointConnectionProperties

Objet

Décrit les propriétés d’une connexion de point de terminaison privé existante au service de recherche.

Nom	Type	Description
groupId	string	L’ID de groupe du fournisseur de ressources pour laquelle la connexion de service de liaison privée est activée.
privateEndpoint	PrivateEndpoint	Ressource de point de terminaison privé du fournisseur Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Décrit l’état actuel d’une connexion de service Private Link existante au point de terminaison privé Azure.
provisioningState	PrivateLinkServiceConnectionProvisioningState	État d’approvisionnement de la connexion de service de liaison privée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussite ou Incomplet

PrivateLinkServiceConnectionProvisioningState

Énumération

État d’approvisionnement de la connexion de service de liaison privée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussite ou Incomplet

Valeur	Description
Updating	La connexion de service de liaison privée est en cours de création ainsi que d’autres ressources pour qu’elle soit entièrement fonctionnelle.
Deleting	La connexion de service de liaison privée est en cours de suppression.
Failed	La connexion de service de liaison privée n’a pas pu être provisionnée ou supprimée.
Succeeded	La connexion de service de liaison privée a terminé l’approvisionnement et est prête à être approuvée.
Incomplete	La demande d’approvisionnement de la ressource de connexion de service de liaison privée a été acceptée, mais le processus de création n’a pas encore commencé.
Canceled	La demande d’approvisionnement de la ressource de connexion de service de liaison privée a été annulée

PrivateLinkServiceConnectionState

Objet

Décrit l’état actuel d’une connexion de service Private Link existante au point de terminaison privé Azure.

Nom	Type	Valeur par défaut	Description
actionsRequired	string	None	Description de toutes les actions supplémentaires qui peuvent être requises.
description	string		Description de l’état de connexion du service de liaison privée.
status	PrivateLinkServiceConnectionStatus		État de la connexion du service de liaison privée. Les valeurs valides sont en attente, approuvées, rejetées ou déconnectées.

PrivateLinkServiceConnectionStatus

Énumération

État de la connexion du service de liaison privée. Les valeurs valides sont en attente, approuvées, rejetées ou déconnectées.

Valeur	Description
Pending	La connexion de point de terminaison privé a été créée et est en attente d’approbation.
Approved	La connexion de point de terminaison privé est approuvée et prête à être utilisée.
Rejected	La connexion de point de terminaison privé a été rejetée et ne peut pas être utilisée.
Disconnected	La connexion de point de terminaison privé a été supprimée du service.