KeysOperations Klasa

Ostrzeżenie

NIE należy bezpośrednio utworzyć wystąpienia tej klasy.

Zamiast tego należy uzyskać dostęp do następujących operacji za pośrednictwem

KeyVaultManagementClient's'

<xref:keys> Atrybut.

Dziedziczenie

builtins.object

KeysOperations

Konstruktor

KeysOperations(*args, **kwargs)

Metody

create_if_not_exist	Tworzy pierwszą wersję nowego klucza, jeśli nie istnieje. Jeśli już istnieje, istniejący klucz jest zwracany bez wykonywania żadnych operacji zapisu. Ten interfejs API nie tworzy kolejnych wersji i nie aktualizuje istniejących kluczy.
get	Pobiera bieżącą wersję określonego klucza z określonego magazynu kluczy.
get_version	Pobiera określoną wersję określonego klucza w określonym magazynie kluczy.
list	Wyświetla listę kluczy w określonym magazynie kluczy.
list_versions	Wyświetla listę wersji określonego klucza w określonym magazynie kluczy.

create_if_not_exist

Tworzy pierwszą wersję nowego klucza, jeśli nie istnieje. Jeśli już istnieje, istniejący klucz jest zwracany bez wykonywania żadnych operacji zapisu. Ten interfejs API nie tworzy kolejnych wersji i nie aktualizuje istniejących kluczy.

create_if_not_exist(resource_group_name: str, vault_name: str, key_name: str, parameters: _models.KeyCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Key

Parametry

resource_group_name

str

Wymagane

Nazwa grupy zasobów zawierającej określony magazyn kluczy. Wymagane.

vault_name

str

Wymagane

Nazwa magazynu kluczy, który zawiera klucz do utworzenia. Wymagane.

key_name

str

Wymagane

Nazwa klucza do utworzenia. Wymagane.

parameters

KeyCreateParameters lub IO

Wymagane

Parametry użyte do utworzenia określonego klucza. Jest typem KeyCreateParameters lub typem we/wy. Wymagane.

content_type

str

Typ zawartości parametru treści. Znane wartości to: "application/json". Wartość domyślna to Brak.

cls

callable

Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź

Zwraca

Klucz lub wynik cls(response)

Typ zwracany

Key

Wyjątki

HttpResponseError

get

Pobiera bieżącą wersję określonego klucza z określonego magazynu kluczy.

get(resource_group_name: str, vault_name: str, key_name: str, **kwargs: Any) -> Key

Parametry

resource_group_name

str

Wymagane

Nazwa grupy zasobów zawierającej określony magazyn kluczy. Wymagane.

vault_name

str

Wymagane

Nazwa magazynu zawierającego klucz do pobrania. Wymagane.

key_name

str

Wymagane

Nazwa klucza do pobrania. Wymagane.

cls

callable

Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź

Zwraca

Klucz lub wynik cls(response)

Typ zwracany

Key

Wyjątki

HttpResponseError

get_version

Pobiera określoną wersję określonego klucza w określonym magazynie kluczy.

get_version(resource_group_name: str, vault_name: str, key_name: str, key_version: str, **kwargs: Any) -> Key

Parametry

resource_group_name

str

Wymagane

Nazwa grupy zasobów zawierającej określony magazyn kluczy. Wymagane.

vault_name

str

Wymagane

Nazwa magazynu zawierającego wersję klucza do pobrania. Wymagane.

key_name

str

Wymagane

Nazwa wersji klucza do pobrania. Wymagane.

key_version

str

Wymagane

Wersja klucza do pobrania. Wymagane.

cls

callable

Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź

Zwraca

Klucz lub wynik cls(response)

Typ zwracany

Key

Wyjątki

HttpResponseError

list

Wyświetla listę kluczy w określonym magazynie kluczy.

list(resource_group_name: str, vault_name: str, **kwargs: Any) -> Iterable[Key]

Parametry

resource_group_name

str

Wymagane

Nazwa grupy zasobów zawierającej określony magazyn kluczy. Wymagane.

vault_name

str

Wymagane

Nazwa magazynu zawierającego klucze do pobrania. Wymagane.

cls

callable

Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź

Zwraca

Iterator, taki jak wystąpienie klucza lub wynik cls(response)

Typ zwracany

ItemPaged[Key]

Wyjątki

HttpResponseError

list_versions

Wyświetla listę wersji określonego klucza w określonym magazynie kluczy.

list_versions(resource_group_name: str, vault_name: str, key_name: str, **kwargs: Any) -> Iterable[Key]

Parametry

resource_group_name

str

Wymagane

Nazwa grupy zasobów zawierającej określony magazyn kluczy. Wymagane.

vault_name

str

Wymagane

Nazwa magazynu zawierającego wersje kluczy do pobrania. Wymagane.

key_name

str

Wymagane

Nazwa wersji kluczy do pobrania. Wymagane.

cls

callable

Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź

Zwraca

Iterator, taki jak wystąpienie klucza lub wynik cls(response)

Typ zwracany

ItemPaged[Key]

Wyjątki

HttpResponseError

Atrybuty

models

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