Compartilhar via

AdminKeysOperations Classe

  • Referência

Aviso

NÃO instancie essa classe diretamente.

Em vez disso, você deve acessar as operações a seguir por meio de

SearchManagementClient's

Atributo <xref:admin_keys>.

Herança
builtins.object
AdminKeysOperations

Construtor

AdminKeysOperations(*args, **kwargs)

Métodos

get

Obtém as chaves de API de administrador primário e secundário para o serviço de Azure Cognitive Search especificado.
regenerate

Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.

get

Obtém as chaves de API de administrador primário e secundário para o serviço 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
Obrigatório

O nome do grupo de recursos na assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal. Obrigatórios.

search_service_name
str
Obrigatório

O nome do serviço Azure Cognitive Search associado ao grupo de recursos especificado. Obrigatórios.

search_management_request_options
SearchManagementRequestOptions
Obrigatório

Grupo de parâmetros. O valor padrão é Nenhum.

cls
callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

AdminKeyResult ou o resultado de cls(response)

Tipo de retorno

AdminKeyResult

Exceções

HttpResponseError
Confira também

regenerate

Regenera a chave de API de administrador primário ou secundário. Você só pode regenerar uma chave de cada vez.

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
Obrigatório

O nome do grupo de recursos na assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal. Obrigatórios.

search_service_name
str
Obrigatório

O nome do serviço Azure Cognitive Search associado ao grupo de recursos especificado. Obrigatórios.

key_kind
str ou AdminKeyKind
Obrigatório

Especifica qual chave deve ser regenerada. Os valores válidos incluem 'primary' e 'secondary'. Os valores conhecidos são: "primário" e "secundário". Obrigatórios.

search_management_request_options
SearchManagementRequestOptions
Obrigatório

Grupo de parâmetros. O valor padrão é Nenhum.

cls
callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

AdminKeyResult ou o resultado de cls(response)

Tipo de retorno

AdminKeyResult

Exceções

HttpResponseError
Confira também

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'>