Admin Keys - Regenerate
Regenera la clave de API de administrador principal o secundaria. Solo puede regenerar una clave a la vez.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}?api-version=2025-05-01
Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
key
|
path | True |
Especifica la clave que desea volver a generar. Los valores válidos incluyen "primary" y "secondary". |
|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
|
search
|
path | True |
string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ |
Nombre del servicio Azure AI Search asociado al grupo de recursos especificado. |
|
subscription
|
path | True |
string (uuid) |
Identificador de la suscripción de destino. El valor debe ser un UUID. |
|
api-version
|
query | True |
string minLength: 1 |
Versión de la API que se va a usar para esta operación. |
Encabezado de la solicitud
| Nombre | Requerido | Tipo | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Valor GUID generado por el cliente que identifica esta solicitud. Si se especifica, se incluirá en la información de respuesta como una manera de realizar un seguimiento de la solicitud. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
La operación de Azure se completó correctamente. |
|
| Other Status Codes |
Una respuesta de error inesperada. |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
| Nombre | Description |
|---|---|
| user_impersonation | suplantar la cuenta de usuario |
Ejemplos
SearchRegenerateAdminKey
Solicitud de ejemplo
Respuesta de muestra
{
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
Definiciones
| Nombre | Description |
|---|---|
|
Admin |
|
|
Admin |
Respuesta que contiene las claves de API de administración principal y secundaria para un servicio de Azure AI Search determinado. |
|
Cloud |
Contiene información sobre un error de API. |
|
Cloud |
Describe un error de API determinado con un código de error y un mensaje. |
AdminKeyKind
| Valor | Description |
|---|---|
| primary |
Clave de API principal para el servicio de búsqueda. |
| secondary |
Clave de API secundaria del servicio de búsqueda. |
AdminKeyResult
Respuesta que contiene las claves de API de administración principal y secundaria para un servicio de Azure AI Search determinado.
| Nombre | Tipo | Description |
|---|---|---|
| primaryKey |
string |
Clave de API de administrador principal del servicio de búsqueda. |
| secondaryKey |
string |
Clave de API de administrador secundaria del servicio de búsqueda. |
CloudError
Contiene información sobre un error de API.
| Nombre | Tipo | Description |
|---|---|---|
| error |
Describe un error de API determinado con un código de error y un mensaje. |
|
| message |
string |
Una breve descripción del error que indica lo que salió mal (para obtener detalles o información de depuración, consulte la propiedad "error.message"). |
CloudErrorBody
Describe un error de API determinado con un código de error y un mensaje.
| Nombre | Tipo | Description |
|---|---|---|
| code |
string |
Código de error que describe la condición de error más precisamente que un código de estado HTTP. Se puede usar para controlar mediante programación casos de error específicos. |
| details |
Contiene errores anidados relacionados con este error. |
|
| message |
string |
Mensaje que describe el error con detalle y proporciona información de depuración. |
| target |
string |
Destino del error concreto (por ejemplo, el nombre de la propiedad en error). |