Partilhar via

AdminKeysOperations Classe

  • Referência

Aviso

NÃO instancia esta classe diretamente.

Em vez disso, deve aceder às seguintes operações através de

SearchManagementClient's

<xref:admin_keys> atributo.

Herança
builtins.object
AdminKeysOperations

Construtor

AdminKeysOperations(*args, **kwargs)

Métodos

get

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

Regenera a chave de API de administração primária ou secundária. Só pode regenerar uma chave de cada vez.

get

Obtém as chaves de API de administração primária e secundária para o serviço de Azure Cognitive Search especificado.

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
Necessário

O nome do grupo de recursos na subscrição atual. Pode obter este valor a partir da API do Azure Resource Manager ou do portal. Obrigatório.

search_service_name
str
Necessário

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

search_management_request_options
SearchManagementRequestOptions
Necessário

Grupo de parâmetros. O valor predefinido é Nenhum.

cls
callable

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

Devoluções

AdminKeyResult ou o resultado de cls(resposta)

Tipo de retorno

AdminKeyResult

Exceções

HttpResponseError
Ver também

regenerate

Regenera a chave de API de administração primária ou secundária. Só pode regenerar uma chave de cada vez.

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
Necessário

O nome do grupo de recursos na subscrição atual. Pode obter este valor a partir da API do Azure Resource Manager ou do portal. Obrigatório.

search_service_name
str
Necessário

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

key_kind
str ou AdminKeyKind
Necessário

Especifica a chave a regenerar. Os valores válidos incluem "primário" e "secundário". Os valores conhecidos são: "primário" e "secundário". Obrigatório.

search_management_request_options
SearchManagementRequestOptions
Necessário

Grupo de parâmetros. O valor predefinido é Nenhum.

cls
callable

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

Devoluções

AdminKeyResult ou o resultado de cls(resposta)

Tipo de retorno

AdminKeyResult

Exceções

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