Shared Private Link Resources - Get

Service:: Search Management

Version d’API:: 2023-11-01

Obtient les détails de la ressource de liaison privée partagée gérée par le service de recherche dans le groupe de ressources donné.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
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é.
sharedPrivateLinkResourceName	path	True	string	Nom de la ressource de liaison privée partagée gérée par le service de recherche dans le 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	SharedPrivateLinkResource	La définition de la ressource de liaison privée partagée a été récupérée avec succès et se trouve dans la réponse.
Other Status Codes	CloudError	HTTP 404 (introuvable) : l’abonnement, le groupe de ressources, le service de recherche ou la ressource de liaison privée partagée sont introuvables.

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

SharedPrivateLinkResourceGet

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource?api-version=2023-11-01

Exemple de réponse

Code d’état:: 200

{
  "name": "testResource",
  "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource",
  "properties": {
    "requestMessage": "please approve",
    "groupId": "blob",
    "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
    "status": "Pending",
    "resourceRegion": null
  }
}

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.
SharedPrivateLinkResource	Décrit une ressource de liaison privée partagée gérée par le service de recherche.
SharedPrivateLinkResourceProperties	Décrit les propriétés d’une ressource de liaison privée partagée existante gérée par le service de recherche.
SharedPrivateLinkResourceProvisioningState	État d’approvisionnement de la ressource de liaison privée partagée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussite ou Incomplet.
SharedPrivateLinkResourceStatus	État de la ressource de liaison privée partagé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).

SharedPrivateLinkResource

Objet

Décrit une ressource de liaison privée partagée gérée par le 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	SharedPrivateLinkResourceProperties	Décrit les propriétés d’une ressource de liaison privée partagée gérée par le service de recherche.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SharedPrivateLinkResourceProperties

Objet

Décrit les propriétés d’une ressource de liaison privée partagée existante gérée par le service de recherche.

Nom	Type	Description
groupId	string	L’ID de groupe du fournisseur de ressources pour laquelle la ressource de liaison privée partagée est destinée.
privateLinkResourceId	string	L’ID de ressource de la ressource pour laquelle la ressource de liaison privée partagée est destinée.
provisioningState	SharedPrivateLinkResourceProvisioningState	État d’approvisionnement de la ressource de liaison privée partagée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussite ou Incomplet.
requestMessage	string	Message de demande d’approbation de la ressource de liaison privée partagée.
resourceRegion	string	Optionnel. Peut être utilisé pour spécifier l’emplacement Azure Resource Manager de la ressource à laquelle une liaison privée partagée doit être créée. Cela n’est nécessaire que pour les ressources dont la configuration DNS est régionale (par exemple, Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	État de la ressource de liaison privée partagée. Les valeurs valides sont en attente, approuvées, rejetées ou déconnectées.

SharedPrivateLinkResourceProvisioningState

Énumération

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

Valeur	Description
Updating
Deleting
Failed
Succeeded
Incomplete

SharedPrivateLinkResourceStatus

Énumération

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

Valeur	Description
Pending
Approved
Rejected
Disconnected