Freigeben über

AdminKeysOperations Klasse

  • Referenz

Warnung

Instanziieren Sie diese Klasse NICHT direkt.

Stattdessen sollten Sie auf die folgenden Vorgänge zugreifen:

SearchManagementClient's

<xref:admin_keys> -Attribut.

Vererbung
builtins.object
AdminKeysOperations

Konstruktor

AdminKeysOperations(*args, **kwargs)

Methoden

get

Ruft die primären und sekundären Administrator-API-Schlüssel für den angegebenen Azure Cognitive Search-Dienst ab.
regenerate

Generiert entweder den primären oder sekundären Administrator-API-Schlüssel. Mit einer Operation kann jeweils nur ein Schlüssel neu generiert werden.

get

Ruft die primären und sekundären Administrator-API-Schlüssel für den angegebenen Azure Cognitive Search-Dienst ab.

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

Parameter

resource_group_name
str
Erforderlich

Der Name der Ressourcengruppe innerhalb des aktuellen Abonnements. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden. Erforderlich.

search_service_name
str
Erforderlich

Der Name des Azure Cognitive Search Diensts, der der angegebenen Ressourcengruppe zugeordnet ist. Erforderlich.

search_management_request_options
SearchManagementRequestOptions
Erforderlich

Parametergruppe. Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

AdminKeyResult oder das Ergebnis von cls(response)

Rückgabetyp

AdminKeyResult

Ausnahmen

HttpResponseError
Weitere Informationen

regenerate

Generiert entweder den primären oder sekundären Administrator-API-Schlüssel. Mit einer Operation kann jeweils nur ein Schlüssel neu generiert werden.

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

Parameter

resource_group_name
str
Erforderlich

Der Name der Ressourcengruppe innerhalb des aktuellen Abonnements. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden. Erforderlich.

search_service_name
str
Erforderlich

Der Name des Azure Cognitive Search Diensts, der der angegebenen Ressourcengruppe zugeordnet ist. Erforderlich.

key_kind
str oder AdminKeyKind
Erforderlich

Gibt an, welcher Schlüssel neu generiert werden soll. Gültige Werte sind "primär" und "sekundär". Bekannte Werte sind: "primär" und "sekundär". Erforderlich.

search_management_request_options
SearchManagementRequestOptions
Erforderlich

Parametergruppe. Der Standardwert ist Keine.

cls
callable

Ein benutzerdefinierter Typ oder eine benutzerdefinierte Funktion, die die direkte Antwort übergeben wird

Gibt zurück

AdminKeyResult oder das Ergebnis von cls(response)

Rückgabetyp

AdminKeyResult

Ausnahmen

HttpResponseError
Weitere Informationen

Attribute

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