Partager via


Admin Keys - Get

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 au sein de 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 demande. S’il est spécifié, il est inclus dans les informations de réponse afin 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 figurent 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

Microsoft Entra ID flux d’autorisation OAuth2.

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

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

Exemple de réponse

{
  "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

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

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

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 status 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 l’erreur en détail et fournit des informations de débogage.

target

string

Cible de l’erreur particulière (par exemple, le nom de la propriété dans l’erreur).