KeyClient Klasa

Interfejs wysokiego poziomu do zarządzania kluczami magazynu.

Dziedziczenie

azure.keyvault.keys._shared.client_base.KeyVaultClientBase

KeyClient

Konstruktor

KeyClient(vault_url: str, credential: TokenCredential, **kwargs)

Parametry

vault_url

str

Wymagane

Adres URL magazynu, do którym będzie uzyskiwany dostęp klient. Jest to również nazywane "nazwą DNS magazynu". Należy sprawdzić, czy ten adres URL odwołuje się do prawidłowego zasobu Key Vault lub zarządzanego modułu HSM. Aby uzyskać szczegółowe informacje, zobacz opis funkcji https://aka.ms/azsdk/blog/vault-uri.

credential

TokenCredential

Wymagane

Obiekt, który może zapewnić token dostępu dla magazynu, taki jak poświadczenie z identity

api_version

ApiVersion

Wersja interfejsu API usługi do użycia. Wartość domyślna to najnowsze.

verify_challenge_resource

bool

Czy należy sprawdzić, czy zasób wyzwania uwierzytelniania jest zgodny z domeną Key Vault lub zarządzaną domeną modułu HSM. Wartość domyślna to True.

Metody

backup_key	Utwórz kopię zapasową klucza w chronionym formularzu, który jest używany tylko przez usługę Azure Key Vault. Wymaga uprawnień kluczy/kopii zapasowej. Ma to na celu zezwolenie na kopiowanie klucza z jednego magazynu do innego. Oba magazyny muszą być własnością tej samej subskrypcji platformy Azure. Ponadto nie można wykonać tworzenia kopii zapasowej/przywracania w granicach geopolitycznych. Na przykład nie można przywrócić kopii zapasowej z magazynu w regionie USA do magazynu w regionie UE.
begin_delete_key	Usuń wszystkie wersje klucza i jego materiału kryptograficznego. Wymaga uprawnień kluczy/usuwania. Gdy ta metoda zwróci Key Vault zaczęła usuwać klucz. Usunięcie może potrwać kilka sekund w magazynie z włączonym usuwaniem nietrwałym. W związku z tym ta metoda zwraca funkcję poller, która umożliwia oczekiwanie na zakończenie usuwania.
begin_recover_deleted_key	Odzyskaj usunięty klucz do najnowszej wersji. Możliwe tylko w magazynie z włączonym usuwaniem nietrwałym. Wymaga uprawnień kluczy/odzyskiwania. Gdy ta metoda zwróci Key Vault rozpoczęła odzyskiwanie klucza. Odzyskiwanie może potrwać kilka sekund. W związku z tym ta metoda zwraca funkcję poller umożliwiającą oczekiwanie na zakończenie odzyskiwania. Oczekiwanie jest konieczne tylko wtedy, gdy chcesz natychmiast użyć odzyskanego klucza w innej operacji.
close	Zamknij gniazda otwarte przez klienta. Wywoływanie tej metody jest niepotrzebne podczas korzystania z klienta jako menedżera kontekstu.
create_ec_key	Utwórz nowy klucz krzywej wielokroptycznej lub, jeśli name jest już używany, utwórz nową wersję klucza. Wymaga uprawnień kluczy/tworzenia.
create_key	Utwórz klucz lub, jeśli name jest już używany, utwórz nową wersję klucza. Wymaga uprawnień kluczy/tworzenia.
create_oct_key	Utwórz nowy klucz sekwencji oktetów (symetryczny) lub, jeśli name jest używany, utwórz nową wersję klucza. Wymaga uprawnień kluczy/tworzenia.
create_rsa_key	Utwórz nowy klucz RSA lub, jeśli name jest już używany, utwórz nową wersję klucza Wymaga uprawnień kluczy/tworzenia.
get_cryptography_client	Pobiera element CryptographyClient dla danego klucza.
get_deleted_key	Pobierz usunięty klucz. Możliwe tylko w magazynie z włączonym usuwaniem nietrwałym. Wymaga kluczy/uzyskiwania uprawnień.
get_key	Pobierz atrybuty klucza i, jeśli jest to klucz asymetryczny, jego materiał publiczny. Wymaga kluczy/uzyskiwania uprawnień.
get_key_rotation_policy	Pobierz zasady rotacji klucza Key Vault.
get_random_bytes	Pobierz żądaną liczbę bajtów losowych z zarządzanego modułu HSM.
import_key	Zaimportuj klucz utworzony zewnętrznie. Wymaga uprawnień kluczy/importu. Jeśli name jest już używany, klucz zostanie zaimportowany jako nowa wersja.
list_deleted_keys	Wyświetl listę wszystkich usuniętych kluczy, w tym publiczną część każdego z nich. Możliwe tylko w magazynie z włączonym usuwaniem nietrwałym. Wymaga uprawnień kluczy/listy.
list_properties_of_key_versions	Wyświetl listę identyfikatorów i właściwości wersji klucza. Wymaga uprawnień kluczy/listy.
list_properties_of_keys	Wyświetl listę identyfikatorów i właściwości wszystkich kluczy w magazynie. Wymaga uprawnień kluczy/listy.
purge_deleted_key	Trwale usuwa usunięty klucz. Tylko możliwe w magazynie z włączonym usuwaniem nietrwałym. Wykonuje nieodwracalne usunięcie określonego klucza bez możliwości odzyskiwania. Operacja jest niedostępna, jeśli recovery_level parametr nie określa opcji "Przeczyszczalne". Ta metoda jest niezbędna tylko do przeczyszczania klucza przed jego scheduled_purge_date. Wymaga uprawnień kluczy/przeczyszczania.
release_key	Zwalnia klucz. Operacja klucza wydania ma zastosowanie do wszystkich typów kluczy. Klucz docelowy musi być oznaczony jako możliwy do wyeksportowania. Ta operacja wymaga uprawnień kluczy/wydania.
restore_key_backup	Przywracanie kopii zapasowej klucza do magazynu. Wymaga uprawnień kluczy/przywracania. Spowoduje to zaimportowanie wszystkich wersji klucza z jego nazwą, atrybutami i zasadami kontroli dostępu. Jeśli nazwa klucza jest już używana, przywracanie zakończy się niepowodzeniem. Ponadto magazyn docelowy musi należeć do tej samej subskrypcji platformy Microsoft Azure co magazyn źródłowy.
rotate_key	Obracanie klucza na podstawie zasad klucza przez wygenerowanie nowej wersji klucza. Ta operacja wymaga uprawnień kluczy/rotacji.
send_request	Uruchamia żądanie sieciowe przy użyciu istniejącego potoku klienta. Adres URL żądania może być powiązany z adresem URL magazynu. Wersja interfejsu API usługi używana dla żądania jest taka sama jak wersja klienta, chyba że określono inaczej. Ta metoda nie zgłasza się, jeśli odpowiedź jest błędem; aby zgłosić wyjątek, wywołaj metodę raise_for_status() dla zwróconego obiektu odpowiedzi. Aby uzyskać więcej informacji na temat wysyłania żądań niestandardowych za pomocą tej metody, zobacz https://aka.ms/azsdk/dpcodegen/python/send_request.
update_key_properties	Zmień właściwości klucza (a nie jego materiał kryptograficzny). Wymaga uprawnień kluczy/aktualizacji.
update_key_rotation_policy	Aktualizacje zasady rotacji klucza Key Vault. Ta operacja wymaga uprawnień kluczy/aktualizacji.

backup_key

Utwórz kopię zapasową klucza w chronionym formularzu, który jest używany tylko przez usługę Azure Key Vault.

Wymaga uprawnień kluczy/kopii zapasowej.

Ma to na celu zezwolenie na kopiowanie klucza z jednego magazynu do innego. Oba magazyny muszą być własnością tej samej subskrypcji platformy Azure. Ponadto nie można wykonać tworzenia kopii zapasowej/przywracania w granicach geopolitycznych. Na przykład nie można przywrócić kopii zapasowej z magazynu w regionie USA do magazynu w regionie UE.

backup_key(name: str, **kwargs) -> bytes

Parametry

name

str

Wymagane

Nazwa klucza do utworzenia kopii zapasowej

Typ zwracany

bytes

Wyjątki

ResourceNotFoundError

jeśli klucz nie istnieje,

HttpResponseError

w przypadku innych błędów

begin_delete_key

Usuń wszystkie wersje klucza i jego materiału kryptograficznego.

Wymaga uprawnień kluczy/usuwania. Gdy ta metoda zwróci Key Vault zaczęła usuwać klucz. Usunięcie może potrwać kilka sekund w magazynie z włączonym usuwaniem nietrwałym. W związku z tym ta metoda zwraca funkcję poller, która umożliwia oczekiwanie na zakończenie usuwania.

begin_delete_key(name: str, **kwargs) -> LROPoller[DeletedKey]

Parametry

name

str

Wymagane

Nazwa klucza do usunięcia.

Zwraca

Poller dla operacji usuwania klucza. Metoda wynikowa poller zwraca DeletedKey wartość bez oczekiwania na zakończenie usuwania. Jeśli magazyn ma włączoną funkcję usuwania nietrwałego i chcesz trwale usunąć klucz za pomocą polecenia purge_deleted_key, najpierw wywołaj metodę oczekiwania narzędzia poller. Zostanie ona zablokowana do momentu ukończenia usunięcia. Metoda wait wymaga kluczy/uzyskania uprawnień.

Typ zwracany

LROPoller[DeletedKey]

Wyjątki

ResourceNotFoundError

jeśli klucz nie istnieje,

HttpResponseError

w przypadku innych błędów

begin_recover_deleted_key

Odzyskaj usunięty klucz do najnowszej wersji. Możliwe tylko w magazynie z włączonym usuwaniem nietrwałym.

Wymaga uprawnień kluczy/odzyskiwania.

Gdy ta metoda zwróci Key Vault rozpoczęła odzyskiwanie klucza. Odzyskiwanie może potrwać kilka sekund. W związku z tym ta metoda zwraca funkcję poller umożliwiającą oczekiwanie na zakończenie odzyskiwania. Oczekiwanie jest konieczne tylko wtedy, gdy chcesz natychmiast użyć odzyskanego klucza w innej operacji.

begin_recover_deleted_key(name: str, **kwargs) -> LROPoller[KeyVaultKey]

Parametry

name

str

Wymagane

Nazwa usuniętego klucza do odzyskania

Zwraca

Poller dla operacji odzyskiwania. Metoda wynikowa poller zwraca odzyskane KeyVaultKey bez oczekiwania na zakończenie odzyskiwania. Jeśli chcesz natychmiast użyć odzyskanego klucza, wywołaj metodę oczekiwania narzędzia poller, która blokuje, dopóki klucz nie będzie gotowy do użycia. Metoda wait wymaga kluczy/uzyskania uprawnień.

Typ zwracany

LROPoller[KeyVaultKey]

Wyjątki

HttpResponseError

close

Zamknij gniazda otwarte przez klienta.

Wywoływanie tej metody jest niepotrzebne podczas korzystania z klienta jako menedżera kontekstu.

close() -> None

Wyjątki

ResourceNotFoundError

jeśli klucz nie istnieje,

HttpResponseError

w przypadku innych błędów

create_ec_key

Utwórz nowy klucz krzywej wielokroptycznej lub, jeśli name jest już używany, utwórz nową wersję klucza.

Wymaga uprawnień kluczy/tworzenia.

create_ec_key(name: str, **kwargs) -> KeyVaultKey

Parametry

name

str

Wymagane

Nazwa nowego klucza.

curve

KeyCurveName lub str lub None

Nazwa krzywej eliptycznej. Domyślnie jest to krzywa wielokropowa NIST P-256.

key_operations

list[KeyOperation lub str] lub None

Dozwolone operacje klucza

hardware_protected

bool lub None

Czy klucz powinien zostać utworzony w sprzętowym module zabezpieczeń. Wartość domyślna to False.

enabled

bool lub None

Czy klucz jest włączony do użycia.

tags

dict[str, str] lub None

Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

not_before

datetime lub None

Nie wcześniej niż data klucza w formacie UTC

expires_on

datetime lub None

Data wygaśnięcia klucza w formacie UTC

exportable

bool lub None

Czy klucz prywatny można wyeksportować.

release_policy

KeyReleasePolicy lub None

Reguły zasad, w ramach których można wyeksportować klucz.

Zwraca

Utworzony klucz

Typ zwracany

KeyVaultKey

Wyjątki

HttpResponseError

create_key

Utwórz klucz lub, jeśli name jest już używany, utwórz nową wersję klucza.

Wymaga uprawnień kluczy/tworzenia.

create_key(name: str, key_type: str | KeyType, **kwargs) -> KeyVaultKey

Parametry

name

str

Wymagane

Nazwa nowego klucza.

key_type

KeyType lub str

Wymagane

Typ klucza do utworzenia

size

int lub None

Rozmiar klucza w bitach. Dotyczy tylko kluczy RSA i kluczy symetrycznych. Rozważ użycie create_rsa_key lub create_oct_key zamiast tego.

curve

KeyCurveName lub str lub None

Nazwa krzywej eliptycznej. Dotyczy tylko wielokroptycznych kluczy krzywej. Domyślnie jest to krzywa wielokropowa NIST P-256. Aby utworzyć klucz krzywej eliptycznej, rozważ użycie create_ec_key zamiast tego.

public_exponent

int lub None

Publiczny wykładnik RSA do użycia. Dotyczy tylko kluczy RSA utworzonych w zarządzanym module HSM.

key_operations

list[KeyOperation lub str] lub None

Dozwolone operacje klucza

enabled

bool lub None

Czy klucz jest włączony do użycia.

tags

dict[str, str] lub None

Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

not_before

datetime lub None

Nie wcześniej niż data klucza w formacie UTC

expires_on

datetime lub None

Data wygaśnięcia klucza w formacie UTC

exportable

bool lub None

Czy klucz prywatny można wyeksportować.

release_policy

KeyReleasePolicy lub None

Reguły zasad, w ramach których można wyeksportować klucz.

Zwraca

Utworzony klucz

Typ zwracany

KeyVaultKey

Wyjątki

HttpResponseError

create_oct_key

Utwórz nowy klucz sekwencji oktetów (symetryczny) lub, jeśli name jest używany, utwórz nową wersję klucza.

Wymaga uprawnień kluczy/tworzenia.

create_oct_key(name: str, **kwargs) -> KeyVaultKey

Parametry

name

str

Wymagane

Nazwa nowego klucza.

size

int lub None

Rozmiar klucza w bitach, na przykład 128, 192 lub 256.

key_operations

list[KeyOperation lub str] lub None

Dozwolone operacje klucza.

hardware_protected

bool lub None

Czy klucz powinien zostać utworzony w sprzętowym module zabezpieczeń. Wartość domyślna to False.

enabled

bool lub None

Czy klucz jest włączony do użycia.

tags

dict[str, str] lub None

Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

not_before

datetime lub None

Nie wcześniej niż data klucza w formacie UTC

expires_on

datetime lub None

Data wygaśnięcia klucza w formacie UTC

exportable

bool lub None

Czy klucz można wyeksportować.

release_policy

KeyReleasePolicy lub None

Reguły zasad, w ramach których można wyeksportować klucz.

Zwraca

Utworzony klucz

Typ zwracany

KeyVaultKey

Wyjątki

HttpResponseError

create_rsa_key

Utwórz nowy klucz RSA lub, jeśli name jest już używany, utwórz nową wersję klucza

Wymaga uprawnień kluczy/tworzenia.

create_rsa_key(name: str, **kwargs) -> KeyVaultKey

Parametry

name

str

Wymagane

Nazwa nowego klucza.

size

int lub None

Rozmiar klucza w bitach, na przykład 2048, 3072 lub 4096.

public_exponent

int lub None

Publiczny wykładnik RSA do użycia. Dotyczy tylko kluczy RSA utworzonych w zarządzanym module HSM.

hardware_protected

bool lub None

Czy klucz powinien zostać utworzony w sprzętowym module zabezpieczeń. Wartość domyślna to False.

key_operations

list[KeyOperation lub str] lub None

Dozwolone operacje klucza

enabled

bool lub None

Czy klucz jest włączony do użycia.

tags

dict[str, str] lub None

Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

not_before

datetime lub None

Nie wcześniej niż data klucza w formacie UTC

expires_on

datetime lub None

Data wygaśnięcia klucza w formacie UTC

exportable

bool lub None

Czy klucz prywatny można wyeksportować.

release_policy

KeyReleasePolicy lub None

Reguły zasad, w ramach których można wyeksportować klucz.

Zwraca

Utworzony klucz

Typ zwracany

KeyVaultKey

Wyjątki

HttpResponseError

get_cryptography_client

Pobiera element CryptographyClient dla danego klucza.

get_cryptography_client(key_name: str, **kwargs) -> CryptographyClient

Parametry

key_name

str

Wymagane

Nazwa klucza używanego do wykonywania operacji kryptograficznych.

key_version

str

Opcjonalna wersja klucza używanego do wykonywania operacji kryptograficznych.

Zwraca

Przy CryptographyClient użyciu tych samych opcji, poświadczeń i klienta HTTP co ten KeyClientelement .

Typ zwracany

CryptographyClient

Wyjątki

ResourceNotFoundError

jeśli klucz nie istnieje,

HttpResponseError

w przypadku innych błędów

get_deleted_key

Pobierz usunięty klucz. Możliwe tylko w magazynie z włączonym usuwaniem nietrwałym.

Wymaga kluczy/uzyskiwania uprawnień.

get_deleted_key(name: str, **kwargs) -> DeletedKey

Parametry

name

str

Wymagane

Nazwa klucza

Zwraca

Usunięty klucz

Typ zwracany

DeletedKey

Wyjątki

ResourceNotFoundError

jeśli klucz nie istnieje,

HttpResponseError

w przypadku innych błędów

get_key

Pobierz atrybuty klucza i, jeśli jest to klucz asymetryczny, jego materiał publiczny.

Wymaga kluczy/uzyskiwania uprawnień.

get_key(name: str, version: str | None = None, **kwargs) -> KeyVaultKey

Parametry

name

str

Wymagane

Nazwa klucza do pobrania.

version

str lub None

Wymagane

(opcjonalnie) Określona wersja klucza do pobrania. Jeśli nie zostanie określony, pobierze najnowszą wersję klucza.

Typ zwracany

KeyVaultKey

Wyjątki

ResourceNotFoundError

jeśli klucz nie istnieje,

HttpResponseError

w przypadku innych błędów

get_key_rotation_policy

Pobierz zasady rotacji klucza Key Vault.

get_key_rotation_policy(key_name: str, **kwargs) -> KeyRotationPolicy

Parametry

key_name

str

Wymagane

Nazwa klucza.

Zwraca

Zasady rotacji kluczy.

Typ zwracany

KeyRotationPolicy

Wyjątki

*azure.core.exceptions.HttpResponseError*

get_random_bytes

Pobierz żądaną liczbę bajtów losowych z zarządzanego modułu HSM.

get_random_bytes(count: int, **kwargs) -> bytes

Parametry

count

int

Wymagane

Żądana liczba bajtów losowych.

Zwraca

Losowe bajty.

Typ zwracany

bytes

Wyjątki

ValueError

jeśli zażądano mniejszej niż jeden bajt losowy,

HttpResponseError

w przypadku innych błędów

import_key

Zaimportuj klucz utworzony zewnętrznie.

Wymaga uprawnień kluczy/importu. Jeśli name jest już używany, klucz zostanie zaimportowany jako nowa wersja.

import_key(name: str, key: JsonWebKey, **kwargs) -> KeyVaultKey

Parametry

name

str

Wymagane

Nazwa zaimportowanych kluczy

key

JsonWebKey

Wymagane

Klucz internetowy JSON do zaimportowania

hardware_protected

bool lub None

Czy klucz powinien być wspierany przez sprzętowy moduł zabezpieczeń

enabled

bool lub None

Czy klucz jest włączony do użycia.

tags

dict[str, str] lub None

Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

not_before

datetime lub None

Nie wcześniej niż data klucza w formacie UTC

expires_on

datetime lub None

Data wygaśnięcia klucza w formacie UTC

exportable

bool lub None

Czy klucz prywatny można wyeksportować.

release_policy

KeyReleasePolicy lub None

Reguły zasad, w ramach których można wyeksportować klucz.

Zwraca

Zaimportowany klucz

Typ zwracany

KeyVaultKey

Wyjątki

HttpResponseError

list_deleted_keys

Wyświetl listę wszystkich usuniętych kluczy, w tym publiczną część każdego z nich. Możliwe tylko w magazynie z włączonym usuwaniem nietrwałym.

Wymaga uprawnień kluczy/listy.

list_deleted_keys(**kwargs) -> ItemPaged[DeletedKey]

Zwraca

Iterator usuniętych kluczy

Typ zwracany

ItemPaged[DeletedKey]

Wyjątki

ResourceNotFoundError

jeśli klucz nie istnieje,

HttpResponseError

w przypadku innych błędów

list_properties_of_key_versions

Wyświetl listę identyfikatorów i właściwości wersji klucza.

Wymaga uprawnień kluczy/listy.

list_properties_of_key_versions(name: str, **kwargs) -> ItemPaged[KeyProperties]

Parametry

name

str

Wymagane

Nazwa klucza

Zwraca

Iterator kluczy bez ich materiału kryptograficznego

Typ zwracany

ItemPaged[KeyProperties]

Wyjątki

ResourceNotFoundError

jeśli klucz nie istnieje,

HttpResponseError

w przypadku innych błędów

list_properties_of_keys

Wyświetl listę identyfikatorów i właściwości wszystkich kluczy w magazynie.

Wymaga uprawnień kluczy/listy.

list_properties_of_keys(**kwargs) -> ItemPaged[KeyProperties]

Zwraca

Iterator kluczy bez informacji o materiałach kryptograficznych lub informacjach o wersji

Typ zwracany

ItemPaged[KeyProperties]

Wyjątki

ResourceNotFoundError

jeśli klucz nie istnieje,

HttpResponseError

w przypadku innych błędów

purge_deleted_key

Trwale usuwa usunięty klucz. Tylko możliwe w magazynie z włączonym usuwaniem nietrwałym.

Wykonuje nieodwracalne usunięcie określonego klucza bez możliwości odzyskiwania. Operacja jest niedostępna, jeśli recovery_level parametr nie określa opcji "Przeczyszczalne". Ta metoda jest niezbędna tylko do przeczyszczania klucza przed jego scheduled_purge_date.

Wymaga uprawnień kluczy/przeczyszczania.

purge_deleted_key(name: str, **kwargs) -> None

Parametry

name

str

Wymagane

Nazwa usuniętego klucza do przeczyszczenia

Zwraca

Brak

Wyjątki

HttpResponseError

Przykłady

   # if the vault has soft-delete enabled, purge permanently deletes a deleted key
   # (with soft-delete disabled, begin_delete_key is permanent)
   key_client.purge_deleted_key("key-name")

release_key

Zwalnia klucz.

Operacja klucza wydania ma zastosowanie do wszystkich typów kluczy. Klucz docelowy musi być oznaczony jako możliwy do wyeksportowania. Ta operacja wymaga uprawnień kluczy/wydania.

release_key(name: str, target_attestation_token: str, **kwargs) -> ReleaseKeyResult

Parametry

name

str

Wymagane

Nazwa klucza do pobrania.

target_attestation_token

str

Wymagane

Asercji zaświadczania dla celu wydania klucza.

version

str lub None

Określona wersja klucza do wydania. Jeśli nie zostanie określona, zostanie wydana najnowsza wersja.

algorithm

str lub KeyExportEncryptionAlgorithm lub None

Algorytm szyfrowania używany do ochrony zwolnionego materiału klucza.

nonce

str lub None

Dostarczany przez klienta nonce na potrzeby świeżości.

Zwraca

Wynik wydania klucza.

Typ zwracany

ReleaseKeyResult

Wyjątki

HttpResponseError

restore_key_backup

Przywracanie kopii zapasowej klucza do magazynu.

Wymaga uprawnień kluczy/przywracania.

Spowoduje to zaimportowanie wszystkich wersji klucza z jego nazwą, atrybutami i zasadami kontroli dostępu. Jeśli nazwa klucza jest już używana, przywracanie zakończy się niepowodzeniem. Ponadto magazyn docelowy musi należeć do tej samej subskrypcji platformy Microsoft Azure co magazyn źródłowy.

restore_key_backup(backup: bytes, **kwargs) -> KeyVaultKey

Parametry

backup

bytes

Wymagane

Kopia zapasowa klucza zwrócona przez backup_key

Zwraca

Przywrócony klucz

Typ zwracany

KeyVaultKey

Wyjątki

ResourceExistsError

jeśli nazwa klucza kopii zapasowej jest już używana,

HttpResponseError

w przypadku innych błędów

rotate_key

Obracanie klucza na podstawie zasad klucza przez wygenerowanie nowej wersji klucza.

Ta operacja wymaga uprawnień kluczy/rotacji.

rotate_key(name: str, **kwargs) -> KeyVaultKey

Parametry

name

str

Wymagane

Nazwa klucza do rotacji.

Zwraca

Nowa wersja obróconego klucza.

Typ zwracany

KeyVaultKey

Wyjątki

HttpResponseError

send_request

Uruchamia żądanie sieciowe przy użyciu istniejącego potoku klienta.

Adres URL żądania może być powiązany z adresem URL magazynu. Wersja interfejsu API usługi używana dla żądania jest taka sama jak wersja klienta, chyba że określono inaczej. Ta metoda nie zgłasza się, jeśli odpowiedź jest błędem; aby zgłosić wyjątek, wywołaj metodę raise_for_status() dla zwróconego obiektu odpowiedzi. Aby uzyskać więcej informacji na temat wysyłania żądań niestandardowych za pomocą tej metody, zobacz https://aka.ms/azsdk/dpcodegen/python/send_request.

send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse

Parametry

request

HttpRequest

Wymagane

Żądanie sieciowe, które chcesz utworzyć.

stream

bool

Czy ładunek odpowiedzi zostanie przesyłany strumieniowo. Wartość domyślna to False.

Zwraca

Odpowiedź połączenia sieciowego. Nie obsługuje błędów w odpowiedzi.

Typ zwracany

HttpResponse

Wyjątki

ResourceNotFoundError

jeśli klucz nie istnieje,

HttpResponseError

w przypadku innych błędów

update_key_properties

Zmień właściwości klucza (a nie jego materiał kryptograficzny).

Wymaga uprawnień kluczy/aktualizacji.

update_key_properties(name: str, version: str | None = None, **kwargs) -> KeyVaultKey

Parametry

name

str

Wymagane

Nazwa klucza do zaktualizowania

version

str lub None

Wymagane

(opcjonalnie) Wersja klucza do zaktualizowania. Jeśli nie zostanie określona, najnowsza wersja zostanie zaktualizowana.

key_operations

list[KeyOperation lub str] lub None

Dozwolone operacje klucza

enabled

bool lub None

Czy klucz jest włączony do użycia.

tags

dict[str, str] lub None

Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

not_before

datetime lub None

Nie wcześniej niż data klucza w formacie UTC

expires_on

datetime lub None

Data wygaśnięcia klucza w formacie UTC

release_policy

KeyReleasePolicy lub None

Reguły zasad, w ramach których można wyeksportować klucz.

Zwraca

Zaktualizowany klucz

Typ zwracany

KeyVaultKey

Wyjątki

ResourceNotFoundError

jeśli klucz nie istnieje,

HttpResponseError

w przypadku innych błędów

update_key_rotation_policy

Aktualizacje zasady rotacji klucza Key Vault.

Ta operacja wymaga uprawnień kluczy/aktualizacji.

update_key_rotation_policy(key_name: str, policy: KeyRotationPolicy, **kwargs) -> KeyRotationPolicy

Parametry

key_name

str

Wymagane

Nazwa klucza w danym magazynie.

policy

KeyRotationPolicy

Wymagane

Nowe zasady rotacji klucza.

lifetime_actions

list[KeyRotationLifetimeAction]

Akcje, które będą wykonywane przez Key Vault przez cały okres istnienia klucza. Spowoduje to zastąpienie akcji okresu istnienia podanego policyelementu .

expires_in

str

Czas wygaśnięcia zasad, które zostaną zastosowane w nowych wersjach kluczy, zdefiniowany jako czas trwania ISO 8601. Na przykład: 90 dni to "P90D", 3 miesiące to "P3M", a 48 godzin to "PT48H". Zobacz Wikipedię , aby uzyskać więcej informacji na temat czasu trwania ISO 8601. Spowoduje to zastąpienie czasu wygaśnięcia podanego policyobiektu .

Zwraca

Zaktualizowane zasady rotacji.

Typ zwracany

KeyRotationPolicy

Wyjątki

HttpResponseError

Atrybuty

vault_url