Compartir a través de


Admin Keys - Get

Obtiene las claves de API de administración principal y secundaria del servicio de búsqueda especificado.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?api-version=2023-11-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
path True

string

Nombre del grupo de recursos dentro de la suscripción actual. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.

searchServiceName
path True

string

Nombre del servicio de búsqueda asociado al grupo de recursos especificado.

subscriptionId
path True

string

Identificador único de una suscripción de Microsoft Azure. Puede obtener este valor de la API de Azure Resource Manager, las herramientas de línea de comandos o el portal.

api-version
query True

string

La versión de API que se va a usar para cada solicitud.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-request-id

string

uuid

Un 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

Las claves de administrador se recuperaron correctamente y están en la respuesta. Puede usar la clave principal o secundaria como el valor del parámetro "api-key" en la API REST del plano de datos o un SDK de Azure para realizar cualquier operación en el servicio de búsqueda, incluidas las operaciones con privilegios. Entre las operaciones con privilegios se incluyen la administración de recursos como índices y orígenes de datos, así como la carga, modificación o eliminación de datos en los índices.

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

Microsoft Entra ID flujo de autorización de OAuth2.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

SearchGetAdminKeys

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
AdminKeyResult

Respuesta que contiene las claves de API de administración principal y secundaria de un servicio de búsqueda 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.

AdminKeyResult

Respuesta que contiene las claves de API de administración principal y secundaria de un servicio de búsqueda 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

CloudErrorBody

Describe un error de API determinado con un código de error y un mensaje.

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 de forma más precisa 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 en detalle y proporciona información de depuración.

target

string

Destino del error determinado (por ejemplo, el nombre de la propiedad en error).