Admin Keys - Regenerate

Servicio:: Search Management

Versión de la API:: 2025-02-01-preview

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-02-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
keyKind	path	True	AdminKeyKind	Especifica la clave que se va a regenerar. Los valores válidos incluyen "primary" y "secondary".
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción actual. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
searchServiceName	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.
subscriptionId	path	True	string	Identificador único de una suscripción de Microsoft Azure. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
api-version	query	True	string	Versión de la API que se va a usar para cada solicitud.

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	AdminKeyResult	La clave de administración especificada se ha regenerado correctamente. Ambas claves de administrador se incluyen en la respuesta, incluida la clave recién regenerada.
Other Status Codes	CloudError	HTTP 404 (no encontrado): no se encontró la suscripción, el grupo de recursos o el servicio de búsqueda. HTTP 409 (Conflicto): la suscripción especificada está deshabilitada.

Seguridad

azure_auth

Especifica un flujo de concesión implícito, como se admite en la plataforma de identidad de Microsoft.

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

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/regenerateAdminKey/primary?api-version=2025-02-01-preview

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
AdminKeyKind	Especifica la clave que se va a regenerar. Los valores válidos incluyen "primary" y "secondary".
AdminKeyResult	Respuesta que contiene las claves de API de administración principal y secundaria para un servicio de Azure AI Search determinado.
CloudError	Contiene información sobre un error de API.
CloudErrorBody	Describe un error de API determinado con un código de error y un mensaje.

AdminKeyKind

Enumeración

Especifica la clave que se va a regenerar. Los valores válidos incluyen "primary" y "secondary".

Valor	Description
primary	Clave de API principal para el servicio de búsqueda.
secondary	Clave de API secundaria del servicio de búsqueda.

AdminKeyResult

Objeto

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

Objeto

Contiene información sobre un error de API.

Nombre	Tipo	Description
error	CloudErrorBody	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

Objeto

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	CloudErrorBody[]	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).