Admin Keys - Get

Service:: Search Management

Version d’API:: 2023-11-01

Obtient les clés API d’administration primaire et secondaire pour le service de recherche spécifié.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?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é.
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	AdminKeyResult	Les clés d’administration ont été récupérées avec succès et sont dans la réponse. Vous pouvez utiliser la clé primaire ou secondaire comme valeur du paramètre « api-key » dans l’API REST du plan de données ou un Kit de développement logiciel (SDK) Azure pour effectuer toutes les opérations sur votre service de recherche, y compris les opérations privilégiées. Les opérations privilégiées incluent la gestion des ressources telles que les index et les sources de données, ainsi que le chargement, la modification ou la suppression de données dans vos index.
Other Status Codes	CloudError	HTTP 404 (introuvable) : l’abonnement, le groupe de ressources ou le service de recherche est introuvable. HTTP 409 (Conflit) : l’abonnement spécifié est désactivé.

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

SearchGetAdminKeys

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

Définitions

Nom	Description
AdminKeyResult	Réponse contenant les clés API d’administration primaire et secondaire pour un service de recherche donné.
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.

AdminKeyResult

Objet

Réponse contenant les clés API d’administration primaire et secondaire pour un service de recherche donné.

Nom	Type	Description
primaryKey	string	Clé API d’administration principale du service de recherche.
secondaryKey	string	Clé API d’administration secondaire du service de recherche.

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).