Admin Keys - Regenerate
Régénère la clé API d’administration primaire ou secondaire. Vous ne pouvez régénérer qu’une seule clé à la fois.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}?api-version=2023-11-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
key
|
path | True |
Spécifie la clé à régénérer. Les valeurs valides incluent « principal » et « secondaire ». |
|
resource
|
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. |
search
|
path | True |
string |
Nom du service de recherche associé au groupe de ressources spécifié. |
subscription
|
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é, cela sera inclus dans les informations de réponse afin de suivre la demande. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
La clé d’administration spécifiée a été correctement régénérée. Les deux clés d’administration sont incluses dans la réponse, y compris la clé nouvellement régénérée. |
|
Other Status Codes |
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
SearchRegenerateAdminKey
Exemple de requête
Exemple de réponse
{
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
Définitions
Nom | Description |
---|---|
Admin |
Spécifie la clé à régénérer. Les valeurs valides incluent « principal » et « secondaire ». |
Admin |
Réponse contenant les clés API d’administration primaire et secondaire pour un service de recherche donné. |
Cloud |
Contient des informations sur une erreur d’API. |
Cloud |
Décrit une erreur d’API particulière avec un code d’erreur et un message. |
AdminKeyKind
Spécifie la clé à régénérer. Les valeurs valides incluent « principal » et « secondaire ».
Nom | Type | Description |
---|---|---|
primary |
string |
Clé API primaire pour le service de recherche. |
secondary |
string |
Clé API secondaire pour le service de recherche. |
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é d’API d’administration secondaire du service de recherche. |
CloudError
Contient des informations sur une erreur d’API.
Nom | Type | Description |
---|---|---|
error |
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 http status. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques. |
details |
Contient les 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é en erreur). |