Udostępnij za pośrednictwem

AdminKeysOperations Klasa

  • Odwołanie

Ostrzeżenie

NIE tworzy wystąpienia tej klasy bezpośrednio.

Zamiast tego należy uzyskać dostęp do następujących operacji za pomocą polecenia

SearchManagementClient's

<xref:admin_keys> Atrybut.

Dziedziczenie
builtins.object
AdminKeysOperations

Konstruktor

AdminKeysOperations(*args, **kwargs)

Metody

get

Pobiera podstawowe i pomocnicze klucze interfejsu API administratora dla określonej usługi Azure Cognitive Search.
regenerate

Ponownie generuje podstawowy lub pomocniczy klucz interfejsu API administratora. Jednocześnie można ponownie wygenerować tylko jeden klucz.

get

Pobiera podstawowe i pomocnicze klucze interfejsu API administratora dla określonej usługi Azure Cognitive Search.

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

Parametry

resource_group_name
str
Wymagane

Nazwa grupy zasobów w ramach bieżącej subskrypcji. Tę wartość można uzyskać z interfejsu API Resource Manager platformy Azure lub portalu. Wymagane.

search_service_name
str
Wymagane

Nazwa usługi Azure Cognitive Search skojarzonej z określoną grupą zasobów. Wymagane.

search_management_request_options
SearchManagementRequestOptions
Wymagane

Grupa parametrów. Wartość domyślna to Brak.

cls
callable

Niestandardowy typ lub funkcja, która zostanie przekazana bezpośrednia odpowiedź

Zwraca

AdminKeyResult lub wynik cls(response)

Typ zwracany

AdminKeyResult

Wyjątki

HttpResponseError
Zobacz też

regenerate

Ponownie generuje podstawowy lub pomocniczy klucz interfejsu API administratora. Jednocześnie można ponownie wygenerować tylko jeden klucz.

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

Parametry

resource_group_name
str
Wymagane

Nazwa grupy zasobów w ramach bieżącej subskrypcji. Tę wartość można uzyskać z interfejsu API Resource Manager platformy Azure lub portalu. Wymagane.

search_service_name
str
Wymagane

Nazwa usługi Azure Cognitive Search skojarzonej z określoną grupą zasobów. Wymagane.

key_kind
str lub AdminKeyKind
Wymagane

Określa, który klucz ma być ponownie wygenerowany. Prawidłowe wartości to "primary" i "secondary". Znane wartości to: "primary" i "secondary". Wymagane.

search_management_request_options
SearchManagementRequestOptions
Wymagane

Grupa parametrów. Wartość domyślna to Brak.

cls
callable

Niestandardowy typ lub funkcja, która zostanie przekazana bezpośrednia odpowiedź

Zwraca

AdminKeyResult lub wynik cls(response)

Typ zwracany

AdminKeyResult

Wyjątki

HttpResponseError
Zobacz też

Atrybuty

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