Compartir a través de

AdminKeysOperations Clase

  • Referencia

Advertencia

NO cree una instancia de esta clase directamente.

En su lugar, debe acceder a las siguientes operaciones a través de

SearchManagementClient's

Atributo<xref:admin_keys> .

Herencia
builtins.object
AdminKeysOperations

Constructor

AdminKeysOperations(*args, **kwargs)

Métodos

get

Obtiene las claves de API de administración principal y secundaria para el servicio de Azure Cognitive Search especificado.
regenerate

Vuelve a generar la clave de API de administración principal o secundaria. Solo puede volver a generar una clave en cada ocasión.

get

Obtiene las claves de API de administración principal y secundaria para el servicio de Azure Cognitive Search especificado.

async get(resource_group_name: str, search_service_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> AdminKeyResult

Parámetros

resource_group_name
str
Requerido

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. Necesario.

search_service_name
str
Requerido

Nombre del servicio Azure Cognitive Search asociado al grupo de recursos especificado. Necesario.

search_management_request_options
SearchManagementRequestOptions
Requerido

Grupo de parámetros. El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa.

Devoluciones

AdminKeyResult o el resultado de cls(response)

Tipo de valor devuelto

AdminKeyResult

Excepciones

HttpResponseError
Consulte también

regenerate

Vuelve a generar la clave de API de administración principal o secundaria. Solo puede volver a generar una clave en cada ocasión.

async regenerate(resource_group_name: str, search_service_name: str, key_kind: str | AdminKeyKind, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> AdminKeyResult

Parámetros

resource_group_name
str
Requerido

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. Necesario.

search_service_name
str
Requerido

Nombre del servicio Azure Cognitive Search asociado al grupo de recursos especificado. Necesario.

key_kind
str o AdminKeyKind
Requerido

Especifica la clave que desea volver a generar. Los valores válidos incluyen "primary" y "secondary". Los valores conocidos son: "primary" y "secondary". Necesario.

search_management_request_options
SearchManagementRequestOptions
Requerido

Grupo de parámetros. El valor predeterminado es Ninguno.

cls
callable

Un tipo o función personalizados que se pasarán a la respuesta directa.

Devoluciones

AdminKeyResult o el resultado de cls(response)

Tipo de valor devuelto

AdminKeyResult

Excepciones

HttpResponseError
Consulte también

Atributos

models 

models = <module 'azure.mgmt.search.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\search\\models\\__init__.py'>