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=2024-03-01-preview
Paramètres URI
Nom |
Dans |
Obligatoire |
Type |
Description |
keyKind
|
path |
True
|
AdminKeyKind
|
Spécifie la clé à régénérer. Les valeurs valides incluent « principal » et « secondaire ».
|
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 Search Azure AI associé au groupe de ressources spécifié.
Modèle d’expression régulière: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$
|
subscriptionId
|
path |
True
|
string
|
Identificateur unique d’un abonnement Microsoft Azure. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
|
api-version
|
query |
True
|
string
|
Version de l’API à utiliser pour chaque requête.
|
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
|
AdminKeyResult
|
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
|
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
Spécifie un flux d’octroi implicite, tel que pris en charge sur la plateforme Microsoft Identity.
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
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/regenerateAdminKey/primary?api-version=2024-03-01-preview
from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-search
# USAGE
python search_regenerate_admin_key.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = SearchManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.admin_keys.regenerate(
resource_group_name="rg1",
search_service_name="mysearchservice",
key_kind="primary",
)
print(response)
# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchRegenerateAdminKey.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchRegenerateAdminKey.json
func ExampleAdminKeysClient_Regenerate() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewAdminKeysClient().Regenerate(ctx, "rg1", "mysearchservice", armsearch.AdminKeyKindPrimary, &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, 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.AdminKeyResult = armsearch.AdminKeyResult{
// PrimaryKey: to.Ptr("<your primary admin API key>"),
// SecondaryKey: to.Ptr("<your secondary admin API key>"),
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
*
* @summary Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchRegenerateAdminKey.json
*/
async function searchRegenerateAdminKey() {
const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
const searchServiceName = "mysearchservice";
const keyKind = "primary";
const credential = new DefaultAzureCredential();
const client = new SearchManagementClient(credential, subscriptionId);
const result = await client.adminKeys.regenerate(resourceGroupName, searchServiceName, keyKind);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchRegenerateAdminKey.json
// this example is just showing the usage of "AdminKeys_Regenerate" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://zcusa.951200.xyz/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServiceAdminKeyKind keyKind = SearchServiceAdminKeyKind.Primary;
SearchServiceAdminKeyResult result = await searchService.RegenerateAdminKeyAsync(keyKind);
Console.WriteLine($"Succeeded: {result}");
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
{
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
Définitions
Nom |
Description |
AdminKeyKind
|
Spécifie la clé à régénérer. Les valeurs valides incluent « principal » et « secondaire ».
|
AdminKeyResult
|
Réponse contenant les clés API d’administration primaire et secondaire pour un service Search Azure AI 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.
|
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 Search Azure AI 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
|
CloudErrorBody
|
Décrit une erreur d’API particulière avec un code d’erreur et un message.
|
message
|
string
|
Une brève description de l’erreur qui indique ce qui s’est mal passé (pour plus d’informations/débogage, reportez-vous à la propriété « error.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
|
CloudErrorBody[]
|
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).
|