CertificateClient Klasa

Interfejs wysokiego poziomu do zarządzania certyfikatami magazynu.

Dziedziczenie
azure.keyvault.certificates._shared.client_base.KeyVaultClientBase
CertificateClient

Konstruktor

CertificateClient(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. 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 sprawdzić, czy zasób wyzwania uwierzytelniania jest zgodny z domeną Key Vault. Wartość domyślna to True.

Metody

backup_certificate

Tworzenie kopii zapasowej certyfikatu w formularzu chronionym można używać tylko przez usługę Azure Key Vault.

Wymaga uprawnień certyfikatów/kopii zapasowej. Ma to na celu zezwolenie na kopiowanie certyfikatu 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_create_certificate

Tworzy nowy certyfikat.

Jeśli jest to pierwsza wersja, zostanie utworzony zasób certyfikatu. Ta operacja wymaga uprawnień do certyfikatów/tworzenia. Oczekiwanie na zwrócony element poller wymaga certyfikatów/uzyskania uprawnień i daje certyfikat, jeśli utworzenie zakończyło się pomyślnie, lub CertyfikatOperation, jeśli nie — w przeciwnym razie zgłasza HttpResponseErrorwartość .

begin_delete_certificate

Usuń wszystkie wersje certyfikatu. Wymaga uprawnień certyfikatów/usuwania.

Gdy ta metoda zwróci Key Vault zaczęła usuwać certyfikat. 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_certificate

Odzyskiwanie usuniętego certyfikatu do najnowszej wersji. Możliwe tylko w magazynie z włączonym usuwaniem nietrwałym.

Wymaga uprawnień certyfikatów/odzyskiwania. Gdy ta metoda zwróci Key Vault rozpoczęła odzyskiwanie certyfikatu. 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 certyfikatu w innej operacji.

cancel_certificate_operation

Anuluje operację certyfikatu w toku. Wymaga uprawnień certyfikatów/aktualizacji.

close

Zamknij gniazda otwarte przez klienta.

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

create_issuer

Ustawia określonego wystawcę certyfikatu. Wymaga uprawnień certyfikatów/setisuers.

delete_certificate_operation

Usuwa i zatrzymuje operację tworzenia dla określonego certyfikatu.

Wymaga uprawnień certyfikatów/aktualizacji.

delete_contacts

Usuwa kontakty certyfikatów dla magazynu kluczy. Wymaga uprawnień certyfikatów/zarządzaniakontaktów.

delete_issuer

Usuwa określonego wystawcę certyfikatu.

Wymaga uprawnień certyfikatów/manageissuers/deleteissuers.

get_certificate

Pobiera certyfikat z dołączonymi zasadami zarządzania. Wymaga certyfikatów/uzyskania uprawnień.

Nie akceptuje wersji certyfikatu jako parametru. Aby uzyskać określoną wersję certyfikatu, wywołaj metodę get_certificate_version.

get_certificate_operation

Pobiera operację tworzenia certyfikatu. Wymaga uprawnień do certyfikatów/pobierania.

get_certificate_policy

Pobiera zasady dla certyfikatu. Wymaga certyfikatów/uzyskania uprawnień.

Zwraca określone zasoby zasad certyfikatu w magazynie kluczy.

get_certificate_version

Pobiera określoną wersję certyfikatu bez zwracania zasad zarządzania.

Wymaga certyfikatów/uzyskania uprawnień. Aby uzyskać najnowszą wersję certyfikatu lub pobrać zasady certyfikatu, wywołaj metodę get_certificate.

get_contacts

Pobiera kontakty certyfikatów dla magazynu kluczy. Wymaga uprawnień do certyfikatów/zarządzaniakontaktów.

get_deleted_certificate

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

Wymaga certyfikatów/uzyskania uprawnień. Pobiera usunięte informacje o certyfikacie oraz jego atrybuty, takie jak interwał przechowywania, zaplanowane trwałe usunięcie i bieżący poziom odzyskiwania usuwania.

get_issuer

Pobiera określonego wystawcę certyfikatu. Wymaga uprawnień certificates/manageissuers/getissuers.

import_certificate

Zaimportuj certyfikat utworzony zewnętrznie. Wymaga uprawnień do certyfikatów/importu.

Importuje istniejący prawidłowy certyfikat zawierający klucz prywatny do usługi Azure Key Vault. Certyfikat do zaimportowania może być w formacie PFX lub PEM. Jeśli certyfikat jest w formacie PEM, plik PEM musi zawierać klucz, a także certyfikaty x509 i należy podać policy element z content_type .pem

list_deleted_certificates

Wyświetla listę obecnie możliwych do odzyskania usuniętych certyfikatów. Możliwe tylko wtedy, gdy magazyn jest włączony usuwanie nietrwałe.

Wymaga uprawnień certyfikatów/get/list. Pobiera certyfikaty w bieżącym magazynie, które są w stanie usuniętym i są gotowe do odzyskiwania lub przeczyszczania. Ta operacja obejmuje informacje specyficzne dla usuwania.

list_properties_of_certificate_versions

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

Wymaga uprawnień certyfikatów/listy.

list_properties_of_certificates

Wyświetlanie listy identyfikatorów i właściwości wszystkich certyfikatów w magazynie.

Wymaga uprawnień certyfikatów/listy.

list_properties_of_issuers

Wyświetla właściwości wystawców certyfikatów dla magazynu kluczy.

Wymaga uprawnień certificates/manageissuers/getissuers.

merge_certificate

Scala certyfikat lub łańcuch certyfikatów z parą kluczy istniejącą na serwerze.

Wymaga uprawnień do tworzenia/certyfikatów. Wykonuje scalanie certyfikatu lub łańcucha certyfikatów z parą kluczy obecnie dostępną w usłudze. Upewnij się, że podczas tworzenia certyfikatu do scalenia przy użyciu begin_create_certificate tego wystawcy ustawiono wartość "Nieznany". W ten sposób Key Vault wiadomo, że certyfikat nie zostanie podpisany przez wystawcę znanego mu.

purge_deleted_certificate

Trwale usuwa usunięty certyfikat. Możliwe tylko w magazynach z włączonym usuwaniem nietrwałym.

Wymaga uprawnień do certyfikatów/przeczyszczania. Wykonuje nieodwracalne usunięcie określonego certyfikatu bez możliwości odzyskania. Operacja nie jest dostępna, jeśli recovery_level parametr nie określa opcji "Przeczyszczanie". Ta metoda jest niezbędna tylko do przeczyszczania certyfikatu przed jego scheduled_purge_date.

restore_certificate_backup

Przywracanie kopii zapasowej certyfikatu do magazynu. Wymaga uprawnień do certyfikatów/przywracania.

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

send_request

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

Adres URL żądania może być względny względem adresu 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.

set_contacts

Ustawia kontakty certyfikatów dla magazynu kluczy. Wymaga uprawnień certyfikatów/zarządzaniakontaktów.

update_certificate_policy

Aktualizacje zasady certyfikatu. Wymaga uprawnień certyfikatów/aktualizacji.

Ustaw określone elementy członkowskie w zasadach certyfikatu. Pozostawia inne osoby jako null.

update_certificate_properties

Zmień właściwości certyfikatu. Wymaga uprawnień certyfikatów/aktualizacji.

update_issuer

Aktualizacje określonego wystawcy certyfikatu. Wymaga uprawnień certyfikatów/setisuers.

backup_certificate

Tworzenie kopii zapasowej certyfikatu w formularzu chronionym można używać tylko przez usługę Azure Key Vault.

Wymaga uprawnień certyfikatów/kopii zapasowej. Ma to na celu zezwolenie na kopiowanie certyfikatu 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_certificate(certificate_name: str, **kwargs) -> bytes

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu.

Zwraca

Obiekt blob kopii zapasowej zawierający certyfikat kopii zapasowej.

Typ zwracany

Wyjątki

jeśli certyfikat nie istnieje,

w przypadku innych błędów

begin_create_certificate

Tworzy nowy certyfikat.

Jeśli jest to pierwsza wersja, zostanie utworzony zasób certyfikatu. Ta operacja wymaga uprawnień do certyfikatów/tworzenia. Oczekiwanie na zwrócony element poller wymaga certyfikatów/uzyskania uprawnień i daje certyfikat, jeśli utworzenie zakończyło się pomyślnie, lub CertyfikatOperation, jeśli nie — w przeciwnym razie zgłasza HttpResponseErrorwartość .

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

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu.

policy
CertificatePolicy
Wymagane

Zasady zarządzania certyfikatu. Wymagany jest podmiot lub jedna z alternatywnych właściwości nazwy podmiotu.

enabled
bool

Określa, czy certyfikat jest włączony do użycia.

tags
dict[str, str]

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

Zwraca

LROPoller dla operacji tworzenia certyfikatu. Oczekiwanie na poller daje certyfikat, jeśli tworzenie zakończy się pomyślnie, lub CertificateOperation, jeśli nie.

Typ zwracany

Wyjątki

jeśli zasady certyfikatu są nieprawidłowe,

w przypadku innych błędów.

begin_delete_certificate

Usuń wszystkie wersje certyfikatu. Wymaga uprawnień certyfikatów/usuwania.

Gdy ta metoda zwróci Key Vault zaczęła usuwać certyfikat. 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_certificate(certificate_name: str, **kwargs) -> LROPoller[DeletedCertificate]

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu do usunięcia.

Zwraca

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

Typ zwracany

Wyjątki

jeśli certyfikat nie istnieje,

w przypadku innych błędów

begin_recover_deleted_certificate

Odzyskiwanie usuniętego certyfikatu do najnowszej wersji. Możliwe tylko w magazynie z włączonym usuwaniem nietrwałym.

Wymaga uprawnień certyfikatów/odzyskiwania. Gdy ta metoda zwróci Key Vault rozpoczęła odzyskiwanie certyfikatu. 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 certyfikatu w innej operacji.

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

Parametry

certificate_name
str
Wymagane

Nazwa usuniętego certyfikatu do odzyskania

Zwraca

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

Typ zwracany

Wyjątki

cancel_certificate_operation

Anuluje operację certyfikatu w toku. Wymaga uprawnień certyfikatów/aktualizacji.

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

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu.

Zwraca

Anulowana operacja certyfikatu

Typ zwracany

Wyjątki

close

Zamknij gniazda otwarte przez klienta.

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

close() -> None

Wyjątki

jeśli certyfikat nie istnieje,

w przypadku innych błędów

create_issuer

Ustawia określonego wystawcę certyfikatu. Wymaga uprawnień certyfikatów/setisuers.

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

Parametry

issuer_name
str
Wymagane

Nazwa wystawcy.

provider
str
Wymagane

Dostawca wystawcy.

enabled
bool

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

account_id
str

Nazwa użytkownika/nazwa konta/identyfikator konta.

password
str

Hasło/wpis tajny/klucz konta.

organization_id
str

Identyfikator organizacji

admin_contacts
list[AdministratorContact]

Dane kontaktowe administratorów organizacji wystawcy certyfikatu.

Zwraca

Utworzony certificateIssuer

Typ zwracany

Wyjątki

delete_certificate_operation

Usuwa i zatrzymuje operację tworzenia dla określonego certyfikatu.

Wymaga uprawnień certyfikatów/aktualizacji.

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

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu.

Zwraca

Usunięta funkcja CertificateOperation

Typ zwracany

Wyjątki

delete_contacts

Usuwa kontakty certyfikatów dla magazynu kluczy. Wymaga uprawnień certyfikatów/zarządzaniakontaktów.

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

Zwraca

Usunięte kontakty dla magazynu kluczy.

Typ zwracany

Wyjątki

delete_issuer

Usuwa określonego wystawcę certyfikatu.

Wymaga uprawnień certyfikatów/manageissuers/deleteissuers.

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

Parametry

issuer_name
str
Wymagane

Nazwa wystawcy.

Zwraca

CertificateIssuer

Typ zwracany

Wyjątki

get_certificate

Pobiera certyfikat z dołączonymi zasadami zarządzania. Wymaga certyfikatów/uzyskania uprawnień.

Nie akceptuje wersji certyfikatu jako parametru. Aby uzyskać określoną wersję certyfikatu, wywołaj metodę get_certificate_version.

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

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu w danym magazynie.

Zwraca

Wystąpienie klasy KeyVaultCertificate

Typ zwracany

Wyjątki

jeśli certyfikat nie istnieje,

w przypadku innych błędów

get_certificate_operation

Pobiera operację tworzenia certyfikatu. Wymaga uprawnień do certyfikatów/pobierania.

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

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu.

Zwraca

Utworzona funkcja CertificateOperation

Typ zwracany

Wyjątki

jeśli certyfikat nie istnieje,

w przypadku innych błędów

get_certificate_policy

Pobiera zasady dla certyfikatu. Wymaga certyfikatów/uzyskania uprawnień.

Zwraca określone zasoby zasad certyfikatu w magazynie kluczy.

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

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu w danym magazynie kluczy.

Zwraca

Zasady certyfikatów

Typ zwracany

Wyjątki

get_certificate_version

Pobiera określoną wersję certyfikatu bez zwracania zasad zarządzania.

Wymaga certyfikatów/uzyskania uprawnień. Aby uzyskać najnowszą wersję certyfikatu lub pobrać zasady certyfikatu, wywołaj metodę get_certificate.

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

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu w danym magazynie.

version
str
Wymagane

Wersja certyfikatu.

Zwraca

Wystąpienie klasy KeyVaultCertificate

Typ zwracany

Wyjątki

jeśli certyfikat nie istnieje,

w przypadku innych błędów

get_contacts

Pobiera kontakty certyfikatów dla magazynu kluczy. Wymaga uprawnień do certyfikatów/zarządzaniakontaktów.

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

Zwraca

Kontakty certyfikatów dla magazynu kluczy.

Typ zwracany

Wyjątki

get_deleted_certificate

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

Wymaga certyfikatów/uzyskania uprawnień. Pobiera usunięte informacje o certyfikacie oraz jego atrybuty, takie jak interwał przechowywania, zaplanowane trwałe usunięcie i bieżący poziom odzyskiwania usuwania.

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

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu.

Zwraca

Usunięty certyfikat

Typ zwracany

Wyjątki

jeśli certyfikat nie istnieje,

w przypadku innych błędów

get_issuer

Pobiera określonego wystawcę certyfikatu. Wymaga uprawnień certificates/manageissuers/getissuers.

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

Parametry

issuer_name
str
Wymagane

Nazwa wystawcy.

Zwraca

Określony wystawca certyfikatu.

Typ zwracany

Wyjątki

jeśli wystawca nie istnieje,

w przypadku innych błędów

import_certificate

Zaimportuj certyfikat utworzony zewnętrznie. Wymaga uprawnień do certyfikatów/importu.

Importuje istniejący prawidłowy certyfikat zawierający klucz prywatny do usługi Azure Key Vault. Certyfikat do zaimportowania może być w formacie PFX lub PEM. Jeśli certyfikat jest w formacie PEM, plik PEM musi zawierać klucz, a także certyfikaty x509 i należy podać policy element z content_type .pem

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

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu.

certificate_bytes
bytes
Wymagane

Bajty obiektu certyfikatu do zaimportowania. Ten certyfikat musi zawierać klucz prywatny.

enabled
bool

Określa, czy certyfikat jest włączony do użycia.

tags
dict[str, str]

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

password
str

Jeśli klucz prywatny w przekazanym certyfikacie jest zaszyfrowany, jest to hasło używane do szyfrowania.

policy
CertificatePolicy

Zasady zarządzania certyfikatu. Wymagane w przypadku importowania certyfikatu formatu PEM z ustawioną wartością content_typepem.

Zwraca

Zaimportowany certyfikat KeyVaultCertificate

Typ zwracany

Wyjątki

list_deleted_certificates

Wyświetla listę obecnie możliwych do odzyskania usuniętych certyfikatów. Możliwe tylko wtedy, gdy magazyn jest włączony usuwanie nietrwałe.

Wymaga uprawnień certyfikatów/get/list. Pobiera certyfikaty w bieżącym magazynie, które są w stanie usuniętym i są gotowe do odzyskiwania lub przeczyszczania. Ta operacja obejmuje informacje specyficzne dla usuwania.

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

Parametry

include_pending
bool

Określa, czy należy uwzględnić certyfikaty, które nie zostały całkowicie usunięte. Dostępne tylko dla wersji 7.0 i nowszych interfejsu API.

Zwraca

Wystąpienie podobne do iteratora elementu DeletedCertificate

Typ zwracany

Wyjątki

list_properties_of_certificate_versions

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

Wymaga uprawnień certyfikatów/listy.

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

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu.

Zwraca

Wystąpienie podobne do iteratora właściwości CertificateProperties

Typ zwracany

Wyjątki

list_properties_of_certificates

Wyświetlanie listy identyfikatorów i właściwości wszystkich certyfikatów w magazynie.

Wymaga uprawnień certyfikatów/listy.

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

Parametry

include_pending
bool

Określa, czy mają być uwzględniane certyfikaty, które nie są w pełni aprowidowane. Dostępne tylko dla wersji 7.0 i nowszych interfejsu API.

Zwraca

Wystąpienie podobne do iteratora właściwości CertificateProperties

Typ zwracany

Wyjątki

list_properties_of_issuers

Wyświetla właściwości wystawców certyfikatów dla magazynu kluczy.

Wymaga uprawnień certificates/manageissuers/getissuers.

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

Zwraca

Wystąpienie wystawców podobne do iteratora

Typ zwracany

Wyjątki

merge_certificate

Scala certyfikat lub łańcuch certyfikatów z parą kluczy istniejącą na serwerze.

Wymaga uprawnień do tworzenia/certyfikatów. Wykonuje scalanie certyfikatu lub łańcucha certyfikatów z parą kluczy obecnie dostępną w usłudze. Upewnij się, że podczas tworzenia certyfikatu do scalenia przy użyciu begin_create_certificate tego wystawcy ustawiono wartość "Nieznany". W ten sposób Key Vault wiadomo, że certyfikat nie zostanie podpisany przez wystawcę znanego mu.

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

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu

x509_certificates
list[bytes]
Wymagane

Certyfikat lub łańcuch certyfikatów do scalenia.

enabled
bool lub None

Określa, czy certyfikat jest włączony do użycia.

tags
dict[str, str] lub None

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

Zwraca

Scalony certyfikat

Typ zwracany

Wyjątki

purge_deleted_certificate

Trwale usuwa usunięty certyfikat. Możliwe tylko w magazynach z włączonym usuwaniem nietrwałym.

Wymaga uprawnień do certyfikatów/przeczyszczania. Wykonuje nieodwracalne usunięcie określonego certyfikatu bez możliwości odzyskania. Operacja nie jest dostępna, jeśli recovery_level parametr nie określa opcji "Przeczyszczanie". Ta metoda jest niezbędna tylko do przeczyszczania certyfikatu przed jego scheduled_purge_date.

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

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu

Zwraca

Brak

Typ zwracany

Wyjątki

restore_certificate_backup

Przywracanie kopii zapasowej certyfikatu do magazynu. Wymaga uprawnień do certyfikatów/przywracania.

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

restore_certificate_backup(backup: bytes, **kwargs) -> KeyVaultCertificate

Parametry

backup
bytes
Wymagane

Obiekt blob kopii zapasowej skojarzony z pakietem certyfikatów.

Zwraca

Przywrócony element KeyVaultCertificate

Typ zwracany

Wyjątki

send_request

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

Adres URL żądania może być względny względem adresu 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

Określa, czy ładunek odpowiedzi będzie przesyłany strumieniowo. Wartość domyślna to False.

Zwraca

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

Typ zwracany

Wyjątki

jeśli certyfikat nie istnieje,

w przypadku innych błędów

set_contacts

Ustawia kontakty certyfikatów dla magazynu kluczy. Wymaga uprawnień certyfikatów/zarządzaniakontaktów.

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

Parametry

contacts
list[CertificateContact]
Wymagane

Lista kontaktów dla certyfikatów magazynu.

Zwraca

Utworzona lista kontaktów

Typ zwracany

Wyjątki

update_certificate_policy

Aktualizacje zasady certyfikatu. Wymaga uprawnień certyfikatów/aktualizacji.

Ustaw określone elementy członkowskie w zasadach certyfikatu. Pozostawia inne osoby jako null.

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

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu w danym magazynie.

policy
CertificatePolicy
Wymagane

Zasady dotyczące certyfikatu.

Zwraca

Zasady certyfikatu

Typ zwracany

Wyjątki

update_certificate_properties

Zmień właściwości certyfikatu. Wymaga uprawnień certyfikatów/aktualizacji.

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

Parametry

certificate_name
str
Wymagane

Nazwa certyfikatu w danym magazynie kluczy.

version
str
Wymagane

Wersja certyfikatu.

enabled
bool

Określa, czy certyfikat jest włączony do użycia.

tags
dict[str, str]

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

Zwraca

Zaktualizowany element KeyVaultCertificate

Typ zwracany

Wyjątki

update_issuer

Aktualizacje określonego wystawcy certyfikatu. Wymaga uprawnień certyfikatów/setisuers.

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

Parametry

issuer_name
str
Wymagane

Nazwa wystawcy.

enabled
bool

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

provider
str

Dostawca wystawcy

account_id
str

Nazwa użytkownika/nazwa konta/identyfikator konta.

password
str

Hasło/wpis tajny/klucz konta.

organization_id
str

Identyfikator organizacji

admin_contacts
list[AdministratorContact]

Dane kontaktowe administratorów organizacji wystawcy certyfikatu

Zwraca

Zaktualizowany wystawca

Typ zwracany

Wyjątki

Atrybuty

vault_url