CertificateClient Třída

Rozhraní vysoké úrovně pro správu certifikátů trezoru.

Dědičnost

azure.keyvault.certificates._shared.client_base.KeyVaultClientBase

CertificateClient

Konstruktor

CertificateClient(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. 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 se má ověřit, jestli prostředek výzvy ověřování odpovídá doméně Key Vault. Výchozí hodnota je True.

Metody

backup_certificate	Zazálohujte certifikát v chráněné podobě, který může používat jenom Azure Key Vault. Vyžaduje oprávnění k certifikátům nebo zálohování. Cílem je umožnit kopírování certifikátu 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_create_certificate	Vytvoří nový certifikát. Pokud se jedná o první verzi, prostředek certifikátu se vytvoří. Tato operace vyžaduje oprávnění k vytváření certifikátů. Čekání na vrácený poller vyžaduje certifikáty / získat oprávnění a poskytne vám certifikát, pokud je vytvoření úspěšné, nebo CertificateOperation, pokud ne. V opačném případě vyvolá HttpResponseError.
begin_delete_certificate	Odstraňte všechny verze certifikátu. Vyžaduje oprávnění k odstranění nebo certifikáty. Když tato metoda vrátí Key Vault začal odstraňovat certifikát. 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_certificate	Obnovení odstraněného certifikátu na nejnovější verzi Možné pouze v trezoru s povoleným obnovitelným odstraněním. Vyžaduje certifikáty nebo oprávnění k obnovení. Když tato metoda vrátí Key Vault začal obnovovat certifikát. 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ý certifikát okamžitě použít v jiné operaci.
cancel_certificate_operation	Zruší probíhající operaci certifikátu. Vyžaduje oprávnění k aktualizacím nebo certifikátům.
close	Zavřete sokety otevřené klientem. Volání této metody není nutné při použití klienta jako správce kontextu.
create_issuer	Nastaví zadaného vystavitele certifikátu. Vyžaduje oprávnění certifikátů nebo setissuers.
delete_certificate_operation	Odstraní a zastaví operaci vytvoření konkrétního certifikátu. Vyžaduje oprávnění k aktualizacím nebo certifikátům.
delete_contacts	Odstraní kontakty certifikátu pro trezor klíčů. Vyžaduje oprávnění k certifikátům nebo správěkontaktů.
delete_issuer	Odstraní zadaného vystavitele certifikátu. Vyžaduje oprávnění certificates/manageisuers/deleteissuers.
get_certificate	Získá certifikát s připojenými zásadami správy. Vyžaduje certifikáty nebo získat oprávnění. Nepřijímá verzi certifikátu jako parametr. Pokud chcete získat konkrétní verzi certifikátu, zavolejte .get_certificate_version
get_certificate_operation	Získá operaci vytvoření certifikátu. Vyžaduje certifikáty nebo oprávnění získat.
get_certificate_policy	Získá zásadu pro certifikát. Vyžaduje certifikáty nebo získat oprávnění. Vrátí zadané prostředky zásad certifikátů v trezoru klíčů.
get_certificate_version	Získá konkrétní verzi certifikátu bez vrácení jeho zásad správy. Vyžaduje certifikáty nebo získat oprávnění. Pokud chcete získat nejnovější verzi certifikátu nebo také zásady certifikátu, zavolejte get_certificate.
get_contacts	Získá kontakty certifikátu pro trezor klíčů. Vyžaduje oprávnění certifikátů nebo spravovatkontakty.
get_deleted_certificate	Získejte odstraněný certifikát. Možné pouze v trezoru s povoleným obnovitelném odstraněním. Vyžaduje certifikáty nebo získat oprávnění. Načte informace o odstraněném certifikátu a jeho atributy, jako je interval uchovávání, plánované trvalé odstranění a aktuální úroveň obnovení odstranění.
get_issuer	Získá zadaného vystavitele certifikátu. Vyžaduje oprávnění certifikáty, správaisuers nebo getissuers.
import_certificate	Importujte certifikát vytvořený externě. Vyžaduje certifikáty nebo oprávnění k importu. Importuje existující platný certifikát obsahující privátní klíč do Azure Key Vault. Certifikát, který se má importovat, může být ve formátu PFX nebo PEM. Pokud je certifikát ve formátu PEM, soubor PEM musí obsahovat klíč i certifikáty x509 a musíte zadat policycontent_type s .pem
list_deleted_certificates	Zobrazí seznam aktuálně obnovitelných odstraněných certifikátů. Možné pouze v případě, že je povolené obnovitelné odstranění trezoru. Vyžaduje oprávnění k certifikátům, získání nebo výpisu. Načte certifikáty v aktuálním trezoru, které jsou v odstraněném stavu a připravené k obnovení nebo vymazání. Tato operace zahrnuje informace specifické pro odstranění.
list_properties_of_certificate_versions	Vypíše identifikátory a vlastnosti verzí certifikátu. Vyžaduje oprávnění k certifikátům nebo seznamům.
list_properties_of_certificates	Vypíše identifikátory a vlastnosti všech certifikátů v trezoru. Vyžaduje oprávnění k certifikátům nebo seznamům.
list_properties_of_issuers	Vypíše vlastnosti vystavitelů certifikátů pro trezor klíčů. Vyžaduje oprávnění certificates/manageisuers/getissuers.
merge_certificate	Sloučí certifikát nebo řetěz certifikátů s párem klíčů, který existuje na serveru. Vyžaduje oprávnění k vytvoření nebo certifikáty. Provede sloučení certifikátu nebo řetězu certifikátů s párem klíčů, který je aktuálně k dispozici ve službě. Ujistěte se, že při vytváření certifikátu ke sloučení pomocí begin_create_certificate jeho vystavitele nastavíte hodnotu Neznámý. Tímto způsobem Key Vault ví, že certifikát nebude podepsán vystavitelem, který je mu znám.
purge_deleted_certificate	Trvale odstraní odstraněný certifikát. Možné pouze v trezorech s povoleným obnovitelném odstraněním. Vyžaduje certifikáty nebo oprávnění k vymazání. Provede nevratné odstranění zadaného certifikátu bez možnosti obnovení. Operace není k dispozici, pokud parametr recovery_level nezadá možnost Vymazat. Tato metoda je nezbytná pouze pro vymazání certifikátu před jeho scheduled_purge_date.
restore_certificate_backup	Obnovte zálohu certifikátu do trezoru. Vyžaduje certifikáty nebo oprávnění k obnovení. Tím se obnoví všechny verze certifikátu s jeho názvem, atributy a zásadami řízení přístupu. Pokud se název certifikátu 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.
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. Pokud není uvedeno jinak, verze rozhraní API služby použitá pro požadavek je stejná jako verze rozhraní API klienta. 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.
set_contacts	Nastaví kontakty certifikátu pro trezor klíčů. Vyžaduje oprávnění k certifikátům nebo správěkontaktů.
update_certificate_policy	Aktualizace zásady pro certifikát. Vyžaduje certifikáty nebo oprávnění k aktualizaci. Nastavte zadané členy v zásadách certifikátů. Ostatní ponechá hodnotu null.
update_certificate_properties	Změna vlastností certifikátu Vyžaduje certifikáty nebo oprávnění k aktualizaci.
update_issuer	Aktualizace zadaného vystavitele certifikátu. Vyžaduje oprávnění certifikátů nebo setissuers.

backup_certificate

Zazálohujte certifikát v chráněné podobě, který může používat jenom Azure Key Vault.

Vyžaduje oprávnění k certifikátům nebo zálohování. Cílem je umožnit kopírování certifikátu 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_certificate(certificate_name: str, **kwargs) -> bytes

Parametry

certificate_name

str

Vyžadováno

Název certifikátu.

Návraty

Záložní objekt blob obsahující zálohovaný certifikát.

Návratový typ

bytes

Výjimky

ResourceNotFoundError

pokud certifikát neexistuje,

HttpResponseError

pro jiné chyby

begin_create_certificate

Vytvoří nový certifikát.

Pokud se jedná o první verzi, prostředek certifikátu se vytvoří. Tato operace vyžaduje oprávnění k vytváření certifikátů. Čekání na vrácený poller vyžaduje certifikáty / získat oprávnění a poskytne vám certifikát, pokud je vytvoření úspěšné, nebo CertificateOperation, pokud ne. V opačném případě vyvolá HttpResponseError.

begin_create_certificate(certificate_name: str, policy: CertificatePolicy, **kwargs) -> LROPoller[KeyVaultCertificate | CertificateOperation]

Parametry

certificate_name

str

Vyžadováno

Název certifikátu.

policy

CertificatePolicy

Vyžadováno

Zásady správy pro certifikát. Vyžaduje se buď subjekt, nebo jedna z alternativních vlastností názvu subjektu.

enabled

bool

Určuje, jestli je povolené použití certifikátu.

tags

dict[str, str]

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

Návraty

LROPoller pro operaci vytvoření certifikátu. Čekání na poller vám poskytne certifikát, pokud je vytvoření úspěšné, nebo CertificateOperation, pokud ne.

Návratový typ

LROPoller[KeyVaultCertificate,

CertificateOperation]

Výjimky

ValueError

pokud je zásada certifikátu neplatná,

HttpResponseError

pro jiné chyby.

begin_delete_certificate

Odstraňte všechny verze certifikátu. Vyžaduje oprávnění k odstranění nebo certifikáty.

Když tato metoda vrátí Key Vault začal odstraňovat certifikát. 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_certificate(certificate_name: str, **kwargs) -> LROPoller[DeletedCertificate]

Parametry

certificate_name

str

Vyžadováno

Název certifikátu, který se má odstranit.

Návraty

Poller pro operaci odstranění certifikátu. Metoda výsledku poller vrátí DeletedCertificate hodnotu bez čekání na dokončení odstranění. Pokud je v trezoru povolené obnovitelné odstranění a chcete ho okamžitě odstranit, trvale odstraňte certifikát pomocí purge_deleted_certificatepříkazu , nejprve zavolejte metodu čekání pollera. Až do dokončení odstranění se zablokuje. Metoda wait vyžaduje certifikáty nebo získat oprávnění.

Návratový typ

LROPoller[DeletedCertificate]

Výjimky

ResourceNotFoundError

pokud certifikát neexistuje,

HttpResponseError

pro jiné chyby

begin_recover_deleted_certificate

Obnovení odstraněného certifikátu na nejnovější verzi Možné pouze v trezoru s povoleným obnovitelným odstraněním.

Vyžaduje certifikáty nebo oprávnění k obnovení. Když tato metoda vrátí Key Vault začal obnovovat certifikát. 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ý certifikát okamžitě použít v jiné operaci.

begin_recover_deleted_certificate(certificate_name: str, **kwargs) -> LROPoller[KeyVaultCertificate]

Parametry

certificate_name

str

Vyžadováno

Název odstraněného certifikátu, který se má obnovit

Návraty

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

Návratový typ

LROPoller[KeyVaultCertificate]

Výjimky

HttpResponseError

cancel_certificate_operation

Zruší probíhající operaci certifikátu. Vyžaduje oprávnění k aktualizacím nebo certifikátům.

cancel_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperation

Parametry

certificate_name

str

Vyžadováno

Název certifikátu.

Návraty

Operace zrušeného certifikátu

Návratový typ

CertificateOperation

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 certifikát neexistuje,

HttpResponseError

pro jiné chyby

create_issuer

Nastaví zadaného vystavitele certifikátu. Vyžaduje oprávnění certifikátů nebo setissuers.

create_issuer(issuer_name: str, provider: str, **kwargs) -> CertificateIssuer

Parametry

issuer_name

str

Vyžadováno

Název vystavitele.

provider

str

Vyžadováno

Poskytovatel vystavitele.

enabled

bool

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

account_id

str

Uživatelské jméno, název účtu nebo ID účtu.

password

str

Heslo, tajný klíč nebo klíč účtu.

organization_id

str

ID organizace

admin_contacts

list[AdministratorContact]

Kontaktní údaje správců vystavitele certifikátů v organizaci.

Návraty

Vytvořený certifikát CertificateIssuer

Návratový typ

CertificateIssuer

Výjimky

HttpResponseError

delete_certificate_operation

Odstraní a zastaví operaci vytvoření konkrétního certifikátu.

Vyžaduje oprávnění k aktualizacím nebo certifikátům.

delete_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperation

Parametry

certificate_name

str

Vyžadováno

Název certifikátu.

Návraty

Odstraněný CertificateOperation

Návratový typ

CertificateOperation

Výjimky

HttpResponseError

delete_contacts

Odstraní kontakty certifikátu pro trezor klíčů. Vyžaduje oprávnění k certifikátům nebo správěkontaktů.

delete_contacts(**kwargs) -> List[CertificateContact]

Návraty

Odstraněné kontakty pro trezor klíčů

Návratový typ

list[CertificateContact]

Výjimky

HttpResponseError

delete_issuer

Odstraní zadaného vystavitele certifikátu.

Vyžaduje oprávnění certificates/manageisuers/deleteissuers.

delete_issuer(issuer_name: str, **kwargs) -> CertificateIssuer

Parametry

issuer_name

str

Vyžadováno

Název vystavitele.

Návraty

Certifikát Issuer

Návratový typ

CertificateIssuer

Výjimky

HttpResponseError

get_certificate

Získá certifikát s připojenými zásadami správy. Vyžaduje certifikáty nebo získat oprávnění.

Nepřijímá verzi certifikátu jako parametr. Pokud chcete získat konkrétní verzi certifikátu, zavolejte .get_certificate_version

get_certificate(certificate_name: str, **kwargs) -> KeyVaultCertificate

Parametry

certificate_name

str

Vyžadováno

Název certifikátu v daném trezoru.

Návraty

An instance of KeyVaultCertificate

Návratový typ

KeyVaultCertificate

Výjimky

ResourceNotFoundError

pokud certifikát neexistuje,

HttpResponseError

pro jiné chyby

get_certificate_operation

Získá operaci vytvoření certifikátu. Vyžaduje certifikáty nebo oprávnění získat.

get_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperation

Parametry

certificate_name

str

Vyžadováno

Název certifikátu.

Návraty

Vytvořený CertificateOperation

Návratový typ

CertificateOperation

Výjimky

ResourceNotFoundError

pokud certifikát neexistuje,

HttpResponseError

pro jiné chyby

get_certificate_policy

Získá zásadu pro certifikát. Vyžaduje certifikáty nebo získat oprávnění.

Vrátí zadané prostředky zásad certifikátů v trezoru klíčů.

get_certificate_policy(certificate_name: str, **kwargs) -> CertificatePolicy

Parametry

certificate_name

str

Vyžadováno

Název certifikátu v daném trezoru klíčů.

Návraty

Zásady certifikátů

Návratový typ

CertificatePolicy

Výjimky

HttpResponseError

get_certificate_version

Získá konkrétní verzi certifikátu bez vrácení jeho zásad správy.

Vyžaduje certifikáty nebo získat oprávnění. Pokud chcete získat nejnovější verzi certifikátu nebo také zásady certifikátu, zavolejte get_certificate.

get_certificate_version(certificate_name: str, version: str, **kwargs) -> KeyVaultCertificate

Parametry

certificate_name

str

Vyžadováno

Název certifikátu v daném trezoru.

version

str

Vyžadováno

Verze certifikátu.

Návraty

An instance of KeyVaultCertificate

Návratový typ

KeyVaultCertificate

Výjimky

ResourceNotFoundError

pokud certifikát neexistuje,

HttpResponseError

pro jiné chyby

get_contacts

Získá kontakty certifikátu pro trezor klíčů. Vyžaduje oprávnění certifikátů nebo spravovatkontakty.

get_contacts(**kwargs) -> List[CertificateContact]

Návraty

Kontakty certifikátu pro trezor klíčů.

Návratový typ

list[CertificateContact]

Výjimky

HttpResponseError

get_deleted_certificate

Získejte odstraněný certifikát. Možné pouze v trezoru s povoleným obnovitelném odstraněním.

Vyžaduje certifikáty nebo získat oprávnění. Načte informace o odstraněném certifikátu a jeho atributy, jako je interval uchovávání, plánované trvalé odstranění a aktuální úroveň obnovení odstranění.

get_deleted_certificate(certificate_name: str, **kwargs) -> DeletedCertificate

Parametry

certificate_name

str

Vyžadováno

Název certifikátu.

Návraty

Odstraněný certifikát

Návratový typ

DeletedCertificate

Výjimky

ResourceNotFoundError

pokud certifikát neexistuje,

HttpResponseError

pro jiné chyby

get_issuer

Získá zadaného vystavitele certifikátu. Vyžaduje oprávnění certifikáty, správaisuers nebo getissuers.

get_issuer(issuer_name: str, **kwargs) -> CertificateIssuer

Parametry

issuer_name

str

Vyžadováno

Název vystavitele.

Návraty

Zadaný vystavitel certifikátu.

Návratový typ

CertificateIssuer

Výjimky

ResourceNotFoundError

pokud vystavitel neexistuje,

HttpResponseError

pro jiné chyby

import_certificate

Importujte certifikát vytvořený externě. Vyžaduje certifikáty nebo oprávnění k importu.

Importuje existující platný certifikát obsahující privátní klíč do Azure Key Vault. Certifikát, který se má importovat, může být ve formátu PFX nebo PEM. Pokud je certifikát ve formátu PEM, soubor PEM musí obsahovat klíč i certifikáty x509 a musíte zadat policycontent_type s .pem

import_certificate(certificate_name: str, certificate_bytes: bytes, **kwargs) -> KeyVaultCertificate

Parametry

certificate_name

str

Vyžadováno

Název certifikátu.

certificate_bytes

bytes

Vyžadováno

Bajty objektu certifikátu, který se má importovat. Tento certifikát musí obsahovat privátní klíč.

enabled

bool

Určuje, jestli je certifikát povolený pro použití.

tags

dict[str, str]

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

password

str

Pokud je privátní klíč v předaném certifikátu zašifrovaný, jedná se o heslo použité k šifrování.

policy

CertificatePolicy

Zásady správy pro certifikát. Povinné při importu certifikátu ve formátu PEM s content_type nastavenou na pemhodnotu .

Návraty

Importovaný certifikát KeyVaultCertificate

Návratový typ

KeyVaultCertificate

Výjimky

HttpResponseError

list_deleted_certificates

Zobrazí seznam aktuálně obnovitelných odstraněných certifikátů. Možné pouze v případě, že je povolené obnovitelné odstranění trezoru.

Vyžaduje oprávnění k certifikátům, získání nebo výpisu. Načte certifikáty v aktuálním trezoru, které jsou v odstraněném stavu a připravené k obnovení nebo vymazání. Tato operace zahrnuje informace specifické pro odstranění.

list_deleted_certificates(**kwargs) -> ItemPaged[DeletedCertificate]

Parametry

include_pending

bool

Určuje, zda mají být zahrnuty certifikáty, které nejsou zcela odstraněny. K dispozici pouze pro rozhraní API verze 7.0 a novější.

Návraty

Instance DeletedCertificate podobná iterátoru

Návratový typ

ItemPaged[DeletedCertificate]

Výjimky

HttpResponseError

list_properties_of_certificate_versions

Vypíše identifikátory a vlastnosti verzí certifikátu.

Vyžaduje oprávnění k certifikátům nebo seznamům.

list_properties_of_certificate_versions(certificate_name: str, **kwargs) -> ItemPaged[CertificateProperties]

Parametry

certificate_name

str

Vyžadováno

Název certifikátu.

Návraty

Instance CertificateProperties podobná iterátoru

Návratový typ

ItemPaged[CertificateProperties]

Výjimky

HttpResponseError

list_properties_of_certificates

Vypíše identifikátory a vlastnosti všech certifikátů v trezoru.

Vyžaduje oprávnění k certifikátům nebo seznamům.

list_properties_of_certificates(**kwargs) -> ItemPaged[CertificateProperties]

Parametry

include_pending

bool

Určuje, zda se mají zahrnout certifikáty, které nejsou zcela zřízené. K dispozici pouze pro rozhraní API verze 7.0 a novější.

Návraty

Instance CertificateProperties podobná iterátoru

Návratový typ

ItemPaged[CertificateProperties]

Výjimky

HttpResponseError

list_properties_of_issuers

Vypíše vlastnosti vystavitelů certifikátů pro trezor klíčů.

Vyžaduje oprávnění certificates/manageisuers/getissuers.

list_properties_of_issuers(**kwargs) -> ItemPaged[IssuerProperties]

Návraty

Instance vystavitelů podobná iterátoru

Návratový typ

ItemPaged[CertificateIssuer]

Výjimky

HttpResponseError

merge_certificate

Sloučí certifikát nebo řetěz certifikátů s párem klíčů, který existuje na serveru.

Vyžaduje oprávnění k vytvoření nebo certifikáty. Provede sloučení certifikátu nebo řetězu certifikátů s párem klíčů, který je aktuálně k dispozici ve službě. Ujistěte se, že při vytváření certifikátu ke sloučení pomocí begin_create_certificate jeho vystavitele nastavíte hodnotu Neznámý. Tímto způsobem Key Vault ví, že certifikát nebude podepsán vystavitelem, který je mu znám.

merge_certificate(certificate_name: str, x509_certificates: List[bytes], **kwargs) -> KeyVaultCertificate

Parametry

certificate_name

str

Vyžadováno

Název certifikátu

x509_certificates

list[bytes]

Vyžadováno

Certifikát nebo řetěz certifikátů, které se mají sloučit.

enabled

bool nebo None

Určuje, jestli je certifikát povolený pro použití.

tags

dict[str, str] nebo None

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

Návraty

Sloučený certifikát

Návratový typ

KeyVaultCertificate

Výjimky

HttpResponseError

purge_deleted_certificate

Trvale odstraní odstraněný certifikát. Možné pouze v trezorech s povoleným obnovitelném odstraněním.

Vyžaduje certifikáty nebo oprávnění k vymazání. Provede nevratné odstranění zadaného certifikátu bez možnosti obnovení. Operace není k dispozici, pokud parametr recovery_level nezadá možnost Vymazat. Tato metoda je nezbytná pouze pro vymazání certifikátu před jeho scheduled_purge_date.

purge_deleted_certificate(certificate_name: str, **kwargs) -> None

Parametry

certificate_name

str

Vyžadováno

Název certifikátu

Návraty

Žádné

Návratový typ

None

Výjimky

HttpResponseError

restore_certificate_backup

Obnovte zálohu certifikátu do trezoru. Vyžaduje certifikáty nebo oprávnění k obnovení.

Tím se obnoví všechny verze certifikátu s jeho názvem, atributy a zásadami řízení přístupu. Pokud se název certifikátu 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_certificate_backup(backup: bytes, **kwargs) -> KeyVaultCertificate

Parametry

backup

bytes

Vyžadováno

Záložní objekt blob přidružený k sadě certifikátů.

Návraty

Obnovený certifikát KeyVaultCertificate

Návratový typ

KeyVaultCertificate

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. Pokud není uvedeno jinak, verze rozhraní API služby použitá pro požadavek je stejná jako verze rozhraní API klienta. 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

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 u vaší odpovědi.

Návratový typ

HttpResponse

Výjimky

ResourceNotFoundError

pokud certifikát neexistuje,

HttpResponseError

pro jiné chyby

set_contacts

Nastaví kontakty certifikátu pro trezor klíčů. Vyžaduje oprávnění k certifikátům nebo správěkontaktů.

set_contacts(contacts: List[CertificateContact], **kwargs) -> List[CertificateContact]

Parametry

contacts

list[CertificateContact]

Vyžadováno

Seznam kontaktů pro certifikáty trezoru.

Návraty

Vytvořený seznam kontaktů

Návratový typ

list[CertificateContact]

Výjimky

HttpResponseError

update_certificate_policy

Aktualizace zásady pro certifikát. Vyžaduje certifikáty nebo oprávnění k aktualizaci.

Nastavte zadané členy v zásadách certifikátů. Ostatní ponechá hodnotu null.

update_certificate_policy(certificate_name: str, policy: CertificatePolicy, **kwargs) -> CertificatePolicy

Parametry

certificate_name

str

Vyžadováno

Název certifikátu v daném trezoru.

policy

CertificatePolicy

Vyžadováno

Zásady pro certifikát.

Návraty

Zásady certifikátů

Návratový typ

CertificatePolicy

Výjimky

HttpResponseError

update_certificate_properties

Změna vlastností certifikátu Vyžaduje certifikáty nebo oprávnění k aktualizaci.

update_certificate_properties(certificate_name: str, version: str | None = None, **kwargs) -> KeyVaultCertificate

Parametry

certificate_name

str

Vyžadováno

Název certifikátu v daném trezoru klíčů.

version

str

Vyžadováno

Verze certifikátu.

enabled

bool

Určuje, jestli je certifikát povolený pro použití.

tags

dict[str, str]

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

Návraty

Aktualizovaný KeyVaultCertificate

Návratový typ

KeyVaultCertificate

Výjimky

HttpResponseError

update_issuer

Aktualizace zadaného vystavitele certifikátu. Vyžaduje oprávnění certifikátů nebo setissuers.

update_issuer(issuer_name: str, **kwargs) -> CertificateIssuer

Parametry

issuer_name

str

Vyžadováno

Název vystavitele.

enabled

bool

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

provider

str

Poskytovatel vystavitele

account_id

str

Uživatelské jméno, název účtu nebo ID účtu.

password

str

Heslo, tajný klíč nebo klíč účtu.

organization_id

str

ID organizace

admin_contacts

list[AdministratorContact]

Kontaktní údaje správců vystavitele certifikátu v organizaci

Návraty

Aktualizovaný vystavitel

Návratový typ

CertificateIssuer

Výjimky

HttpResponseError

Atributy

vault_url