Private Endpoint Connections - Get

Service:: Search Management

Version d’API:: 2025-05-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=2025-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
privateEndpointConnectionName	path	True	string	Nom de la connexion de point de terminaison privé au service Recherche d’IA Azure avec le groupe de ressources spécifié.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nom du service Recherche IA Azure associé au groupe de ressources spécifié.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

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	L’opération Azure s’est terminée avec succès.
Other Status Codes	CloudError	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

PrivateEndpointConnectionGet

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546?api-version=2025-05-01

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch/v2"
)

// Generated from example definition: 2025-05-01/GetPrivateEndpointConnection.json
func ExamplePrivateEndpointConnectionsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateEndpointConnectionsClient().Get(ctx, "rg1", "mysearchservice", "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsearch.PrivateEndpointConnectionsClientGetResponse{
	// 	PrivateEndpointConnection: &armsearch.PrivateEndpointConnection{
	// 		Name: to.Ptr("testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
	// 		Type: to.Ptr("Microsoft.Search/searchServices/privateEndpointConnections"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
	// 		Properties: &armsearch.PrivateEndpointConnectionProperties{
	// 			PrivateEndpoint: &armsearch.PrivateEndpointConnectionPropertiesPrivateEndpoint{
	// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"),
	// 			},
	// 			PrivateLinkServiceConnectionState: &armsearch.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState{
	// 				Description: to.Ptr(""),
	// 				ActionsRequired: to.Ptr("None"),
	// 				Status: to.Ptr(armsearch.PrivateLinkServiceConnectionStatusApproved),
	// 			},
	// 		},
	// 	},
	// }
}

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

Exemple de réponse

Code d’état:: 200

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

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.
createdByType	Type d’identité qui a créé la ressource.
PrivateEndpointConnection	Décrit une connexion de point de terminaison privé existante au service Recherche d’IA Azure.
PrivateEndpointConnectionProperties	Décrit les propriétés d’une connexion de point de terminaison privé existante au service de recherche.
PrivateEndpointConnectionPropertiesPrivateEndpoint	Ressource de point de terminaison privé du fournisseur Microsoft.Network.
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Décrit l’état actuel d’une connexion de service Azure Private Link existante au point de terminaison privé.
PrivateLinkServiceConnectionProvisioningState	État d’approvisionnement de la connexion de service de liaison privée. Les valeurs valides sont La mise à jour, la suppression, l’échec, la réussite, l’annulation ou l’annulation.
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.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

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.
message	string	Brève description de l’erreur qui indique ce qui s’est passé (pour plus d’informations/débogage, reportez-vous à la propriété « error.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).

createdByType

Énumération

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

Valeur	Description
User
Application
ManagedIdentity
Key

PrivateEndpointConnection

Objet

Décrit une connexion de point de terminaison privé existante au service Recherche d’IA Azure.

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	PrivateEndpointConnectionProperties	Décrit les propriétés d’une connexion de point de terminaison privé existante au service Recherche d’IA Azure.
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 »

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	ID de groupe de la ressource Azure pour laquelle le service de liaison privée est destiné.
privateEndpoint	PrivateEndpointConnectionPropertiesPrivateEndpoint	Ressource de point de terminaison privé du fournisseur Microsoft.Network.
privateLinkServiceConnectionState	PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Décrit l’état actuel d’une connexion de service Azure Private Link existante au point de terminaison privé.
provisioningState	PrivateLinkServiceConnectionProvisioningState	État d’approvisionnement de la connexion de service de liaison privée. Les valeurs valides sont La mise à jour, la suppression, l’échec, la réussite, l’annulation ou l’annulation.

PrivateEndpointConnectionPropertiesPrivateEndpoint

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.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Objet

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

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.

PrivateLinkServiceConnectionProvisioningState

Énumération

État d’approvisionnement de la connexion de service de liaison privée. Les valeurs valides sont La mise à jour, la suppression, l’échec, la réussite, l’annulation ou l’annulation.

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.

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.

systemData

Objet

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.