KeyClient Třída

Rozhraní vysoké úrovně pro správu klíčů trezoru.

Dědičnost

azure.keyvault.keys._shared.client_base.KeyVaultClientBase

KeyClient

Konstruktor

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

Parametry

vault_url

str

Vyžadováno

Adresa URL trezoru, ke které bude klient přistupovat. Označuje se také jako "název DNS" trezoru. Měli byste ověřit, že tato adresa URL odkazuje na platný prostředek Key Vault nebo spravovaného HSM. Podrobnosti viz https://aka.ms/azsdk/blog/vault-uri.

credential

TokenCredential

Vyžadováno

Objekt, který může poskytnout přístupový token pro trezor, například přihlašovací údaje z identity

api_version

ApiVersion

Verze rozhraní API služby, která se má použít. Výchozí hodnota je nejnovější.

verify_challenge_resource

bool

Jestli chcete ověřit, jestli prostředek výzvy ověřování odpovídá doméně Key Vault nebo spravovaného HSM. Výchozí hodnota je True.

Metody

backup_key	Zálohovat klíč v chráněné podobě, který může používat jenom Azure Key Vault. Vyžaduje oprávnění ke klíčům nebo zálohování. Cílem je umožnit kopírování klíče z jednoho trezoru do jiného. Oba trezory musí být vlastněny stejným předplatným Azure. Zálohování ani obnovení není možné provádět přes geopolitické hranice. Například zálohu z trezoru v oblasti USA není možné obnovit do trezoru v oblasti EU.
begin_delete_key	Odstraňte všechny verze klíče a jeho kryptografický materiál. Vyžaduje oprávnění ke klíčům nebo odstranění. Když tato metoda vrátí Key Vault začal klíč odstraňovat. Odstranění může v trezoru s povoleným obnovitelným odstraněním trvat několik sekund. Tato metoda proto vrátí poller, který vám umožní počkat na dokončení odstranění.
begin_recover_deleted_key	Obnovení odstraněného klíče na nejnovější verzi Možné pouze v trezoru s povoleným obnovitelným odstraněním. Vyžaduje oprávnění ke klíčům nebo obnovení. Když tato metoda vrátí Key Vault začal obnovovat klíč. Obnovení může trvat několik sekund. Tato metoda proto vrátí poller, který vám umožní počkat na dokončení obnovení. Čekání je nutné pouze v případě, že chcete obnovený klíč okamžitě použít v jiné operaci.
close	Zavřete sokety otevřené klientem. Volání této metody není nutné při použití klienta jako správce kontextu.
create_ec_key	Vytvořte nový klíč s eliptickou křivkou, nebo vytvořte novou verzi klíče, pokud name se už používá. Vyžaduje oprávnění ke klíčům nebo k vytvoření.
create_key	Vytvořte klíč nebo vytvořte novou verzi klíče, pokud name se už používá. Vyžaduje oprávnění ke klíčům nebo k vytvoření.
create_oct_key	Vytvořte nový (symetrický) klíč oktetové sekvence nebo, pokud name se používá, vytvořte novou verzi klíče. Vyžaduje oprávnění ke klíčům nebo k vytvoření.
create_rsa_key	Vytvořte nový klíč RSA nebo , pokud name se už používá, vytvořte novou verzi klíče. Vyžaduje oprávnění ke klíčům nebo k vytvoření.
get_cryptography_client	Získá pro CryptographyClient daný klíč .
get_deleted_key	Získejte odstraněný klíč. Možné pouze v trezoru s povoleným obnovitelným odstraněním. Vyžaduje klíče nebo získat oprávnění.
get_key	Získejte atributy klíče, a pokud se jedná o asymetrický klíč, jeho veřejný materiál. Vyžaduje klíče nebo získat oprávnění.
get_key_rotation_policy	Získejte zásady obměně klíče Key Vault.
get_random_bytes	Získejte požadovaný počet náhodných bajtů ze spravovaného HSM.
import_key	Importujte klíč vytvořený externě. Vyžaduje oprávnění ke klíčům nebo importu. Pokud name se už používá, klíč se naimportuje jako nová verze.
list_deleted_keys	Zobrazí seznam všech odstraněných klíčů, včetně veřejné části každého klíče. Možné pouze v trezoru s povoleným obnovitelným odstraněním. Vyžaduje oprávnění ke klíčům nebo seznamům.
list_properties_of_key_versions	Vypíše identifikátory a vlastnosti verzí klíče. Vyžaduje oprávnění ke klíčům nebo seznamům.
list_properties_of_keys	Vypíše identifikátory a vlastnosti všech klíčů v trezoru. Vyžaduje oprávnění ke klíčům nebo seznamům.
purge_deleted_key	Trvale odstraní odstraněný klíč. Možné pouze v trezoru s povoleným obnovitelným odstraněním. Provede nevratné odstranění zadaného klíče bez možnosti obnovení. Operace není k dispozici, pokud parametr neurčí "Vyprázdnit recovery_level ". Tato metoda je nezbytná pouze pro vymazání klíče před jeho scheduled_purge_date. Vyžaduje oprávnění ke klíčům a vyprázdnění.
release_key	Uvolní klíč. Operace vydaného klíče se vztahuje na všechny typy klíčů. Cílový klíč musí být označený jako exportovatelný. Tato operace vyžaduje oprávnění ke klíčům nebo uvolnění.
restore_key_backup	Obnovte zálohu klíče do trezoru. Vyžaduje oprávnění ke klíčům nebo obnovení. Tím se naimportují všechny verze klíče s jeho názvem, atributy a zásadami řízení přístupu. Pokud se název klíče už používá, obnovení se nezdaří. Cílový trezor musí být také vlastněný stejným předplatným Microsoft Azure jako zdrojový trezor.
rotate_key	Obměňte klíč na základě zásad klíče vygenerováním nové verze klíče. Tato operace vyžaduje oprávnění ke klíčům nebo obměně.
send_request	Spustí síťový požadavek pomocí existujícího kanálu klienta. Adresa URL požadavku může být relativní vzhledem k adrese URL trezoru. Verze rozhraní API služby použitá pro požadavek je stejná jako verze klienta, pokud není uvedeno jinak. Tato metoda nevyvolá, pokud odpověď je chyba; Pokud chcete vyvolat výjimku, zavolejte raise_for_status() u vráceného objektu odpovědi. Další informace o odesílání vlastních požadavků pomocí této metody najdete v tématu https://aka.ms/azsdk/dpcodegen/python/send_request.
update_key_properties	Změna vlastností klíče (nikoli jeho kryptografického materiálu) Vyžaduje oprávnění ke klíčům nebo aktualizacím.
update_key_rotation_policy	Aktualizace zásady obměně klíče Key Vault. Tato operace vyžaduje oprávnění ke klíčům nebo aktualizacím.

backup_key

Zálohovat klíč v chráněné podobě, který může používat jenom Azure Key Vault.

Vyžaduje oprávnění ke klíčům nebo zálohování.

Cílem je umožnit kopírování klíče z jednoho trezoru do jiného. Oba trezory musí být vlastněny stejným předplatným Azure. Zálohování ani obnovení není možné provádět přes geopolitické hranice. Například zálohu z trezoru v oblasti USA není možné obnovit do trezoru v oblasti EU.

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

Parametry

name

str

Vyžadováno

Název klíče, který se má zálohovat

Návratový typ

bytes

Výjimky

ResourceNotFoundError

pokud klíč neexistuje,

HttpResponseError

pro jiné chyby

begin_delete_key

Odstraňte všechny verze klíče a jeho kryptografický materiál.

Vyžaduje oprávnění ke klíčům nebo odstranění. Když tato metoda vrátí Key Vault začal klíč odstraňovat. Odstranění může v trezoru s povoleným obnovitelným odstraněním trvat několik sekund. Tato metoda proto vrátí poller, který vám umožní počkat na dokončení odstranění.

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

Parametry

name

str

Vyžadováno

Název klíče, který se má odstranit.

Návraty

Poller pro operaci odstranění klíče. Metoda výsledku poller vrátí DeletedKey hodnotu bez čekání na dokončení odstranění. Pokud je v trezoru povolené obnovitelné odstranění a chcete trvale odstranit klíč pomocí purge_deleted_keypříkazu , nejprve volejte metodu čekání na pollera. Až do dokončení odstranění se zablokuje. Metoda wait vyžaduje klíče nebo získat oprávnění.

Návratový typ

LROPoller[DeletedKey]

Výjimky

ResourceNotFoundError

pokud klíč neexistuje,

HttpResponseError

pro jiné chyby

begin_recover_deleted_key

Obnovení odstraněného klíče na nejnovější verzi Možné pouze v trezoru s povoleným obnovitelným odstraněním.

Vyžaduje oprávnění ke klíčům nebo obnovení.

Když tato metoda vrátí Key Vault začal obnovovat klíč. Obnovení může trvat několik sekund. Tato metoda proto vrátí poller, který vám umožní počkat na dokončení obnovení. Čekání je nutné pouze v případě, že chcete obnovený klíč okamžitě použít v jiné operaci.

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

Parametry

name

str

Vyžadováno

Název odstraněného klíče, který se má obnovit

Návraty

Poller pro operaci obnovení. Metoda výsledku poller vrátí obnovenou KeyVaultKey hodnotu bez čekání na dokončení obnovení. Pokud chcete obnovený klíč použít okamžitě, zavolejte metodu čekání pollera, která blokuje, dokud nebude klíč připravený k použití. Metoda wait vyžaduje klíče nebo získat oprávnění.

Návratový typ

LROPoller[KeyVaultKey]

Výjimky

HttpResponseError

close

Zavřete sokety otevřené klientem.

Volání této metody není nutné při použití klienta jako správce kontextu.

close() -> None

Výjimky

ResourceNotFoundError

pokud klíč neexistuje,

HttpResponseError

pro jiné chyby

create_ec_key

Vytvořte nový klíč s eliptickou křivkou, nebo vytvořte novou verzi klíče, pokud name se už používá.

Vyžaduje oprávnění ke klíčům nebo k vytvoření.

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

Parametry

name

str

Vyžadováno

Název nového klíče.

curve

KeyCurveName nebo str nebo None

Název elliptické křivky. Výchozí hodnota je eliptická křivka NIST P-256.

key_operations

list[KeyOperation nebo str] nebo None

Povolené operace s klíči

hardware_protected

bool nebo None

Určuje, jestli má být klíč vytvořen v modulu hardwarového zabezpečení. Výchozí hodnota je False.

enabled

bool nebo None

Určuje, jestli je klíč povolený pro použití.

tags

dict[str, str] nebo None

Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

not_before

datetime nebo None

Není před datem klíče v UTC

expires_on

datetime nebo None

Datum vypršení platnosti klíče v UTC

exportable

bool nebo None

Určuje, jestli je možné privátní klíč exportovat.

release_policy

KeyReleasePolicy nebo None

Pravidla zásad, podle kterých je možné klíč exportovat.

Návraty

Vytvořený klíč

Návratový typ

KeyVaultKey

Výjimky

HttpResponseError

create_key

Vytvořte klíč nebo vytvořte novou verzi klíče, pokud name se už používá.

Vyžaduje oprávnění ke klíčům nebo k vytvoření.

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

Parametry

name

str

Vyžadováno

Název nového klíče.

key_type

KeyType nebo str

Vyžadováno

Typ klíče, který se má vytvořit

size

int nebo None

Velikost klíče v bitech. Platí jenom pro RSA a symetrické klíče. Zvažte použití create_rsa_key nebo create_oct_key místo toho.

curve

KeyCurveName nebo str nebo None

Název elliptické křivky. Platí pouze pro klávesy s eliptickými křivkami. Výchozí hodnota je eliptická křivka NIST P-256. Pokud chcete vytvořit klíč eliptické křivky, zvažte místo toho použití create_ec_key .

public_exponent

int nebo None

Veřejný exponent RSA, který se má použít. Platí jenom pro klíče RSA vytvořené ve spravovaném HSM.

key_operations

list[KeyOperation nebo str] nebo None

Povolené operace s klíči

enabled

bool nebo None

Určuje, jestli je klíč povolený pro použití.

tags

dict[str, str] nebo None

Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

not_before

datetime nebo None

Není před datem klíče v UTC

expires_on

datetime nebo None

Datum vypršení platnosti klíče v UTC

exportable

bool nebo None

Určuje, jestli je možné privátní klíč exportovat.

release_policy

KeyReleasePolicy nebo None

Pravidla zásad, podle kterých je možné klíč exportovat.

Návraty

Vytvořený klíč

Návratový typ

KeyVaultKey

Výjimky

HttpResponseError

create_oct_key

Vytvořte nový (symetrický) klíč oktetové sekvence nebo, pokud name se používá, vytvořte novou verzi klíče.

Vyžaduje oprávnění ke klíčům nebo k vytvoření.

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

Parametry

name

str

Vyžadováno

Název nového klíče.

size

int nebo None

Velikost klíče v bitech, například 128, 192 nebo 256.

key_operations

list[KeyOperation nebo str] nebo None

Povolené operace s klíči.

hardware_protected

bool nebo None

Určuje, jestli má být klíč vytvořen v modulu hardwarového zabezpečení. Výchozí hodnota je False.

enabled

bool nebo None

Určuje, jestli je klíč povolený pro použití.

tags

dict[str, str] nebo None

Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

not_before

datetime nebo None

Není před datem klíče v UTC

expires_on

datetime nebo None

Datum vypršení platnosti klíče v UTC

exportable

bool nebo None

Určuje, jestli je možné klíč exportovat.

release_policy

KeyReleasePolicy nebo None

Pravidla zásad, podle kterých je možné klíč exportovat.

Návraty

Vytvořený klíč

Návratový typ

KeyVaultKey

Výjimky

HttpResponseError

create_rsa_key

Vytvořte nový klíč RSA nebo , pokud name se už používá, vytvořte novou verzi klíče.

Vyžaduje oprávnění ke klíčům nebo k vytvoření.

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

Parametry

name

str

Vyžadováno

Název nového klíče.

size

int nebo None

Velikost klíče v bitech, například 2048, 3072 nebo 4096.

public_exponent

int nebo None

Veřejný exponent RSA, který se má použít. Platí jenom pro klíče RSA vytvořené ve spravovaném HSM.

hardware_protected

bool nebo None

Určuje, jestli má být klíč vytvořen v modulu hardwarového zabezpečení. Výchozí hodnota je False.

key_operations

list[KeyOperation nebo str] nebo None

Povolené operace s klíči

enabled

bool nebo None

Určuje, jestli je klíč povolený pro použití.

tags

dict[str, str] nebo None

Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

not_before

datetime nebo None

Není před datem klíče v UTC

expires_on

datetime nebo None

Datum vypršení platnosti klíče v UTC

exportable

bool nebo None

Určuje, jestli je možné privátní klíč exportovat.

release_policy

KeyReleasePolicy nebo None

Pravidla zásad, podle kterých je možné klíč exportovat.

Návraty

Vytvořený klíč

Návratový typ

KeyVaultKey

Výjimky

HttpResponseError

get_cryptography_client

Získá pro CryptographyClient daný klíč .

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

Parametry

key_name

str

Vyžadováno

Název klíče, který se používá k provádění kryptografických operací.

key_version

str

Volitelná verze klíče, která se používá k provádění kryptografických operací.

Návraty

A CryptographyClient s použitím stejných možností, přihlašovacích údajů a klienta HTTP jako tento KeyClient.

Návratový typ

CryptographyClient

Výjimky

ResourceNotFoundError

pokud klíč neexistuje,

HttpResponseError

pro jiné chyby

get_deleted_key

Získejte odstraněný klíč. Možné pouze v trezoru s povoleným obnovitelným odstraněním.

Vyžaduje klíče nebo získat oprávnění.

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

Parametry

name

str

Vyžadováno

Název klíče

Návraty

Odstraněný klíč

Návratový typ

DeletedKey

Výjimky

ResourceNotFoundError

pokud klíč neexistuje,

HttpResponseError

pro jiné chyby

get_key

Získejte atributy klíče, a pokud se jedná o asymetrický klíč, jeho veřejný materiál.

Vyžaduje klíče nebo získat oprávnění.

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

Parametry

name

str

Vyžadováno

Název klíče, který chcete získat.

version

str nebo None

Vyžadováno

(volitelné) Konkrétní verze klíče, který chcete získat. Pokud není zadaný, získá nejnovější verzi klíče.

Návratový typ

KeyVaultKey

Výjimky

ResourceNotFoundError

pokud klíč neexistuje,

HttpResponseError

pro jiné chyby

get_key_rotation_policy

Získejte zásady obměně klíče Key Vault.

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

Parametry

key_name

str

Vyžadováno

Název klíče.

Návraty

Zásady obměně klíčů.

Návratový typ

KeyRotationPolicy

Výjimky

*azure.core.exceptions.HttpResponseError*

get_random_bytes

Získejte požadovaný počet náhodných bajtů ze spravovaného HSM.

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

Parametry

count

int

Vyžadováno

Požadovaný počet náhodných bajtů

Návraty

Náhodné bajty.

Návratový typ

bytes

Výjimky

ValueError

pokud se požaduje méně než jeden náhodný bajt,

HttpResponseError

pro jiné chyby

import_key

Importujte klíč vytvořený externě.

Vyžaduje oprávnění ke klíčům nebo importu. Pokud name se už používá, klíč se naimportuje jako nová verze.

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

Parametry

name

str

Vyžadováno

Název importovaného klíče

key

JsonWebKey

Vyžadováno

Webový klíč JSON, který se má importovat

hardware_protected

bool nebo None

Jestli má být klíč zálohovaný modulem hardwarového zabezpečení

enabled

bool nebo None

Určuje, jestli je klíč povolený pro použití.

tags

dict[str, str] nebo None

Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

not_before

datetime nebo None

Není před datem klíče v UTC

expires_on

datetime nebo None

Datum vypršení platnosti klíče v UTC

exportable

bool nebo None

Určuje, jestli je možné privátní klíč exportovat.

release_policy

KeyReleasePolicy nebo None

Pravidla zásad, podle kterých je možné klíč exportovat.

Návraty

Importovaný klíč

Návratový typ

KeyVaultKey

Výjimky

HttpResponseError

list_deleted_keys

Zobrazí seznam všech odstraněných klíčů, včetně veřejné části každého klíče. Možné pouze v trezoru s povoleným obnovitelným odstraněním.

Vyžaduje oprávnění ke klíčům nebo seznamům.

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

Návraty

Iterátor odstraněných klíčů

Návratový typ

ItemPaged[DeletedKey]

Výjimky

ResourceNotFoundError

pokud klíč neexistuje,

HttpResponseError

pro jiné chyby

list_properties_of_key_versions

Vypíše identifikátory a vlastnosti verzí klíče.

Vyžaduje oprávnění ke klíčům nebo seznamům.

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

Parametry

name

str

Vyžadováno

Název klíče

Návraty

Iterátor klíčů bez kryptografického materiálu

Návratový typ

ItemPaged[KeyProperties]

Výjimky

ResourceNotFoundError

pokud klíč neexistuje,

HttpResponseError

pro jiné chyby

list_properties_of_keys

Vypíše identifikátory a vlastnosti všech klíčů v trezoru.

Vyžaduje oprávnění ke klíčům nebo seznamům.

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

Návraty

Iterátor klíčů bez kryptografického materiálu nebo informací o verzi

Návratový typ

ItemPaged[KeyProperties]

Výjimky

ResourceNotFoundError

pokud klíč neexistuje,

HttpResponseError

pro jiné chyby

purge_deleted_key

Trvale odstraní odstraněný klíč. Možné pouze v trezoru s povoleným obnovitelným odstraněním.

Provede nevratné odstranění zadaného klíče bez možnosti obnovení. Operace není k dispozici, pokud parametr neurčí "Vyprázdnit recovery_level ". Tato metoda je nezbytná pouze pro vymazání klíče před jeho scheduled_purge_date.

Vyžaduje oprávnění ke klíčům a vyprázdnění.

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

Parametry

name

str

Vyžadováno

Název odstraněného klíče, který se má vyprázdnit

Návraty

Žádné

Výjimky

HttpResponseError

Příklady

   # 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

Uvolní klíč.

Operace vydaného klíče se vztahuje na všechny typy klíčů. Cílový klíč musí být označený jako exportovatelný. Tato operace vyžaduje oprávnění ke klíčům nebo uvolnění.

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

Parametry

name

str

Vyžadováno

Název klíče, který chcete získat.

target_attestation_token

str

Vyžadováno

Kontrolní výraz ověření identity pro cíl verze klíče.

version

str nebo None

Konkrétní verze klíče, který se má vydat. Pokud není zadáno, bude vydána nejnovější verze.

algorithm

str nebo KeyExportEncryptionAlgorithm nebo None

Šifrovací algoritmus, který se má použít k ochraně uvolněného klíče.

nonce

str nebo None

Klientem poskytovaný nonce pro aktuálnost.

Návraty

Výsledek uvolnění klíče.

Návratový typ

ReleaseKeyResult

Výjimky

HttpResponseError

restore_key_backup

Obnovte zálohu klíče do trezoru.

Vyžaduje oprávnění ke klíčům nebo obnovení.

Tím se naimportují všechny verze klíče s jeho názvem, atributy a zásadami řízení přístupu. Pokud se název klíče už používá, obnovení se nezdaří. Cílový trezor musí být také vlastněný stejným předplatným Microsoft Azure jako zdrojový trezor.

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

Parametry

backup

bytes

Vyžadováno

Záloha klíče vrácená uživatelem backup_key

Návraty

Obnovený klíč

Návratový typ

KeyVaultKey

Výjimky

ResourceExistsError

pokud se název zálohovaného klíče už používá,

HttpResponseError

pro jiné chyby

rotate_key

Obměňte klíč na základě zásad klíče vygenerováním nové verze klíče.

Tato operace vyžaduje oprávnění ke klíčům nebo obměně.

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

Parametry

name

str

Vyžadováno

Název klíče, který chcete obměňovat.

Návraty

Nová verze obměněného klíče.

Návratový typ

KeyVaultKey

Výjimky

HttpResponseError

send_request

Spustí síťový požadavek pomocí existujícího kanálu klienta.

Adresa URL požadavku může být relativní vzhledem k adrese URL trezoru. Verze rozhraní API služby použitá pro požadavek je stejná jako verze klienta, pokud není uvedeno jinak. Tato metoda nevyvolá, pokud odpověď je chyba; Pokud chcete vyvolat výjimku, zavolejte raise_for_status() u vráceného objektu odpovědi. Další informace o odesílání vlastních požadavků pomocí této metody najdete v tématu https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parametry

request

HttpRequest

Vyžadováno

Síťový požadavek, který chcete vytvořit.

stream

bool

Určuje, jestli se datová část odpovědi bude streamovat. Výchozí hodnota je False.

Návraty

Odpověď síťového volání. Nezvládá zpracování chyb ve vaší odpovědi.

Návratový typ

HttpResponse

Výjimky

ResourceNotFoundError

pokud klíč neexistuje,

HttpResponseError

pro jiné chyby

update_key_properties

Změna vlastností klíče (nikoli jeho kryptografického materiálu)

Vyžaduje oprávnění ke klíčům nebo aktualizacím.

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

Parametry

name

str

Vyžadováno

Název klíče, který se má aktualizovat

version

str nebo None

Vyžadováno

(volitelné) Verze klíče, která se má aktualizovat. Pokud není zadáno, aktualizuje se nejnovější verze.

key_operations

list[KeyOperation nebo str] nebo None

Povolené operace s klíči

enabled

bool nebo None

Určuje, jestli je klíč povolený pro použití.

tags

dict[str, str] nebo None

Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

not_before

datetime nebo None

Není před datem klíče v UTC

expires_on

datetime nebo None

Datum vypršení platnosti klíče v UTC

release_policy

KeyReleasePolicy nebo None

Pravidla zásad, podle kterých je možné klíč exportovat.

Návraty

Aktualizovaný klíč

Návratový typ

KeyVaultKey

Výjimky

ResourceNotFoundError

pokud klíč neexistuje,

HttpResponseError

pro jiné chyby

update_key_rotation_policy

Aktualizace zásady obměně klíče Key Vault.

Tato operace vyžaduje oprávnění ke klíčům nebo aktualizacím.

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

Parametry

key_name

str

Vyžadováno

Název klíče v daném trezoru.

policy

KeyRotationPolicy

Vyžadováno

Nové zásady obměně pro klíč.

lifetime_actions

list[KeyRotationLifetimeAction]

Akce, které budou provádět Key Vault po celou dobu životnosti klíče. Tím se přepíší akce životnosti poskytnutého policyobjektu .

expires_in

str

Doba vypršení platnosti zásad, které se použijí na nové verze klíčů definované jako doba trvání ISO 8601. Například: 90 dní je P90D, 3 měsíce jsou P3M a 48 hodin je PT48H. Další informace o době trvání iso 8601 najdete na Wikipedii . Tím se přepíše doba vypršení platnosti zadaného policyobjektu .

Návraty

Aktualizované zásady rotace.

Návratový typ

KeyRotationPolicy

Výjimky

HttpResponseError

Atributy

vault_url