CertificateClient Kelas

Antarmuka tingkat tinggi untuk mengelola sertifikat vault.

Warisan

azure.keyvault.certificates._shared.client_base.KeyVaultClientBase

CertificateClient

Konstruktor

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

Parameter

vault_url

str

Diperlukan

URL vault yang akan diakses klien. Ini juga disebut "Nama DNS" vault. Anda harus memvalidasi bahwa URL ini mereferensikan sumber daya Key Vault yang valid. Lihat https://aka.ms/azsdk/blog/vault-uri untuk detailnya.

credential

TokenCredential

Diperlukan

Objek yang dapat menyediakan token akses untuk vault, seperti kredensial dari identity

api_version

ApiVersion

Versi API layanan yang akan digunakan. Default ke yang terbaru.

verify_challenge_resource

bool

Apakah memverifikasi sumber daya tantangan autentikasi cocok dengan domain Key Vault. Default ke True.

Metode

backup_certificate	Cadangkan sertifikat dalam bentuk terproteksi yang hanya dapat digunakan oleh Azure Key Vault. Memerlukan izin sertifikat/cadangan. Ini dimaksudkan untuk memungkinkan penyalinan sertifikat dari satu vault ke vault lainnya. Kedua vault harus dimiliki oleh langganan Azure yang sama. Selain itu, pencadangan/pemulihan tidak dapat dilakukan di seluruh batas geopolitik. Misalnya, cadangan dari vault di wilayah AS tidak dapat dipulihkan ke vault di wilayah UE.
begin_create_certificate	Membuat sertifikat baru. Jika ini adalah versi pertama, sumber daya sertifikat dibuat. Operasi ini memerlukan izin sertifikat/pembuatan. Menunggu poller yang dikembalikan memerlukan sertifikat/mendapatkan izin dan memberi Anda sertifikat jika pembuatan berhasil, atau CertificateOperation jika tidak - jika tidak, sertifikat akan memunculkan HttpResponseError.
begin_delete_certificate	Menghapus semua versi sertifikat. Memerlukan izin sertifikat/hapus. Ketika metode ini mengembalikan Key Vault telah mulai menghapus sertifikat. Penghapusan mungkin memakan waktu beberapa detik dalam vault dengan penghapusan sementara diaktifkan. Oleh karena itu, metode ini mengembalikan poller yang memungkinkan Anda menunggu penghapusan selesai.
begin_recover_deleted_certificate	Pulihkan sertifikat yang dihapus ke versi terbarunya. Hanya dimungkinkan dalam vault dengan penghapusan sementara diaktifkan. Memerlukan sertifikat/memulihkan izin. Ketika metode ini mengembalikan Key Vault telah mulai memulihkan sertifikat. Pemulihan mungkin memakan waktu beberapa detik. Oleh karena itu, metode ini mengembalikan poller yang memungkinkan Anda menunggu pemulihan selesai. Menunggu hanya diperlukan ketika Anda ingin menggunakan sertifikat yang dipulihkan dalam operasi lain segera.
cancel_certificate_operation	Membatalkan operasi sertifikat yang sedang berlangsung. Memerlukan izin sertifikat/pembaruan.
close	Soket tutup yang dibuka oleh klien. Memanggil metode ini tidak perlu saat menggunakan klien sebagai manajer konteks.
create_issuer	Mengatur penerbit sertifikat yang ditentukan. Memerlukan izin sertifikat/setissuers.
delete_certificate_operation	Menghapus dan menghentikan operasi pembuatan untuk sertifikat tertentu. Memerlukan izin sertifikat/pembaruan.
delete_contacts	Menghapus kontak sertifikat untuk brankas kunci. Memerlukan izin sertifikat/managecontacts.
delete_issuer	Menghapus pengeluar sertifikat yang ditentukan. Memerlukan izin sertifikat/manageissuers/deleteissuers.
get_certificate	Mendapatkan sertifikat dengan kebijakan manajemennya yang terlampir. Memerlukan sertifikat/mendapatkan izin. Tidak menerima versi sertifikat sebagai parameter. Untuk mendapatkan versi sertifikat tertentu, panggil get_certificate_version.
get_certificate_operation	Mendapatkan operasi pembuatan sertifikat. Memerlukan izin sertifikat/dapatkan.
get_certificate_policy	Mendapatkan kebijakan untuk sertifikat. Memerlukan sertifikat/mendapatkan izin. Mengembalikan sumber daya kebijakan sertifikat yang ditentukan di brankas kunci.
get_certificate_version	Mendapatkan versi sertifikat tertentu tanpa mengembalikan kebijakan manajemennya. Memerlukan sertifikat/mendapatkan izin. Untuk mendapatkan versi terbaru sertifikat, atau untuk mendapatkan kebijakan sertifikat juga, panggil get_certificate.
get_contacts	Mendapatkan kontak sertifikat untuk brankas kunci. Memerlukan izin sertifikat/managecontacts.
get_deleted_certificate	Mendapatkan sertifikat yang dihapus. Hanya dimungkinkan dalam vault dengan penghapusan sementara diaktifkan. Memerlukan sertifikat/mendapatkan izin. Mengambil informasi sertifikat yang dihapus ditambah atributnya, seperti interval retensi, penghapusan permanen terjadwal, dan tingkat pemulihan penghapusan saat ini.
get_issuer	Mendapatkan pengeluar sertifikat yang ditentukan. Memerlukan izin sertifikat/manageissuers/getissuers.
import_certificate	Impor sertifikat yang dibuat secara eksternal. Memerlukan izin sertifikat/impor. Mengimpor sertifikat valid yang sudah ada, yang berisi kunci privat, ke azure Key Vault. Sertifikat yang akan diimpor dapat berada dalam format PFX atau PEM. Jika sertifikat dalam format PEM, file PEM harus berisi kunci serta sertifikat x509, dan Anda harus memberikan policy dengan content_type .pem
list_deleted_certificates	Mencantumkan sertifikat yang dihapus yang saat ini dapat dipulihkan. Dimungkinkan hanya jika vault diaktifkan penghapusan sementara. Memerlukan izin sertifikat/dapatkan/daftar. Mengambil sertifikat dalam vault saat ini yang dalam status dihapus dan siap untuk pemulihan atau pembersihan. Operasi ini mencakup informasi khusus penghapusan.
list_properties_of_certificate_versions	Mencantumkan pengidentifikasi dan properti versi sertifikat. Memerlukan izin sertifikat/daftar.
list_properties_of_certificates	Mencantumkan pengidentifikasi dan properti semua sertifikat dalam vault. Memerlukan izin sertifikat/daftar.
list_properties_of_issuers	Mencantumkan properti penerbit sertifikat untuk brankas kunci. Memerlukan izin sertifikat/manageissuers/getissuers.
merge_certificate	Menggabungkan sertifikat atau rantai sertifikat dengan pasangan kunci yang ada di server. Memerlukan izin sertifikat/buat. Melakukan penggabungan sertifikat atau rantai sertifikat dengan pasangan kunci yang saat ini tersedia dalam layanan. Pastikan saat membuat sertifikat untuk digabungkan menggunakan begin_create_certificate bahwa Anda mengatur penerbitnya ke 'Tidak Diketahui'. Dengan cara ini Key Vault tahu bahwa sertifikat tidak akan ditandatangani oleh pengeluar sertifikat yang diketahuinya.
purge_deleted_certificate	Menghapus sertifikat yang dihapus secara permanen. Hanya dimungkinkan dalam vault dengan penghapusan sementara diaktifkan. Memerlukan izin sertifikat/hapus menyeluruh. Melakukan penghapusan yang tidak dapat diubah dari sertifikat yang ditentukan, tanpa kemungkinan untuk pemulihan. Operasi tidak tersedia jika recovery_level tidak menentukan 'Dapat Dibersihkan'. Metode ini hanya diperlukan untuk membersihkan sertifikat sebelum scheduled_purge_date.
restore_certificate_backup	Pulihkan cadangan sertifikat ke vault. Memerlukan izin sertifikat/pemulihan. Ini memulihkan semua versi sertifikat, dengan nama, atribut, dan kebijakan kontrol aksesnya. Jika nama sertifikat sudah digunakan, memulihkannya akan gagal. Selain itu, vault target harus dimiliki oleh langganan Microsoft Azure yang sama dengan vault sumber.
send_request	Menjalankan permintaan jaringan menggunakan alur klien yang ada. URL permintaan dapat relatif terhadap URL vault. Versi API layanan yang digunakan untuk permintaan sama dengan klien kecuali ditentukan lain. Metode ini tidak menaikkan jika respons adalah kesalahan; untuk menaikkan pengecualian, panggil raise_for_status() pada objek respons yang dikembalikan. Untuk informasi selengkapnya tentang cara mengirim permintaan kustom dengan metode ini, lihat https://aka.ms/azsdk/dpcodegen/python/send_request.
set_contacts	Mengatur kontak sertifikat untuk brankas kunci. Memerlukan izin sertifikat/kelolakontacts.
update_certificate_policy	Updates kebijakan untuk sertifikat. Memerlukan izin sertifikat/pembaruan. Atur anggota tertentu dalam kebijakan sertifikat. Meninggalkan yang lain sebagai null.
update_certificate_properties	Mengubah properti sertifikat. Memerlukan izin sertifikat/pembaruan.
update_issuer	Updates penerbit sertifikat yang ditentukan. Memerlukan izin sertifikat/setissuers.

backup_certificate

Cadangkan sertifikat dalam bentuk terproteksi yang hanya dapat digunakan oleh Azure Key Vault.

Memerlukan izin sertifikat/cadangan. Ini dimaksudkan untuk memungkinkan penyalinan sertifikat dari satu vault ke vault lainnya. Kedua vault harus dimiliki oleh langganan Azure yang sama. Selain itu, pencadangan/pemulihan tidak dapat dilakukan di seluruh batas geopolitik. Misalnya, cadangan dari vault di wilayah AS tidak dapat dipulihkan ke vault di wilayah UE.

backup_certificate(certificate_name: str, **kwargs) -> bytes

Parameter

certificate_name

str

Diperlukan

Nama sertifikat.

Mengembalikan

Blob cadangan yang berisi sertifikat yang dicadangkan.

Tipe hasil

bytes

Pengecualian

ResourceNotFoundError

jika sertifikat tidak ada,

HttpResponseError

untuk kesalahan lain

begin_create_certificate

Membuat sertifikat baru.

Jika ini adalah versi pertama, sumber daya sertifikat dibuat. Operasi ini memerlukan izin sertifikat/pembuatan. Menunggu poller yang dikembalikan memerlukan sertifikat/mendapatkan izin dan memberi Anda sertifikat jika pembuatan berhasil, atau CertificateOperation jika tidak - jika tidak, sertifikat akan memunculkan HttpResponseError.

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat.

policy

CertificatePolicy

Diperlukan

Kebijakan manajemen untuk sertifikat. Subjek atau salah satu properti nama alternatif subjek diperlukan.

enabled

bool

Apakah sertifikat diaktifkan untuk digunakan.

tags

dict[str, str]

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

Mengembalikan

LROPoller untuk operasi buat sertifikat. Menunggu poller memberi Anda sertifikat jika pembuatan berhasil, atau CertificateOperation jika tidak.

Tipe hasil

LROPoller[KeyVaultCertificate,

CertificateOperation]

Pengecualian

ValueError

jika kebijakan sertifikat tidak valid,

HttpResponseError

untuk kesalahan lainnya.

begin_delete_certificate

Menghapus semua versi sertifikat. Memerlukan izin sertifikat/hapus.

Ketika metode ini mengembalikan Key Vault telah mulai menghapus sertifikat. Penghapusan mungkin memakan waktu beberapa detik dalam vault dengan penghapusan sementara diaktifkan. Oleh karena itu, metode ini mengembalikan poller yang memungkinkan Anda menunggu penghapusan selesai.

begin_delete_certificate(certificate_name: str, **kwargs) -> LROPoller[DeletedCertificate]

Parameter

certificate_name

str

Diperlukan

Nama sertifikat yang akan dihapus.

Mengembalikan

Poller untuk operasi hapus sertifikat. Metode hasil poller mengembalikan DeletedCertificate tanpa menunggu penghapusan selesai. Jika vault mengaktifkan penghapusan sementara dan Anda ingin segera, hapus sertifikat secara permanen dengan purge_deleted_certificate, panggil metode tunggu poller terlebih dahulu. Ini akan memblokir sampai penghapusan selesai. Metode tunggu memerlukan izin sertifikat/dapatkan.

Tipe hasil

LROPoller[DeletedCertificate]

Pengecualian

ResourceNotFoundError

jika sertifikat tidak ada,

HttpResponseError

untuk kesalahan lain

begin_recover_deleted_certificate

Pulihkan sertifikat yang dihapus ke versi terbarunya. Hanya dimungkinkan dalam vault dengan penghapusan sementara diaktifkan.

Memerlukan sertifikat/memulihkan izin. Ketika metode ini mengembalikan Key Vault telah mulai memulihkan sertifikat. Pemulihan mungkin memakan waktu beberapa detik. Oleh karena itu, metode ini mengembalikan poller yang memungkinkan Anda menunggu pemulihan selesai. Menunggu hanya diperlukan ketika Anda ingin menggunakan sertifikat yang dipulihkan dalam operasi lain segera.

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat yang dihapus untuk dipulihkan

Mengembalikan

Poller untuk operasi pemulihan. Metode hasil poller mengembalikan yang dipulihkan KeyVaultCertificate tanpa menunggu pemulihan selesai. Jika Anda ingin segera menggunakan sertifikat yang dipulihkan, panggil metode tunggu poller, yang memblokir hingga sertifikat siap digunakan. Metode tunggu memerlukan izin sertifikat/dapatkan.

Tipe hasil

LROPoller[KeyVaultCertificate]

Pengecualian

HttpResponseError

cancel_certificate_operation

Membatalkan operasi sertifikat yang sedang berlangsung. Memerlukan izin sertifikat/pembaruan.

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat.

Mengembalikan

Operasi sertifikat yang dibatalkan

Tipe hasil

CertificateOperation

Pengecualian

HttpResponseError

close

Soket tutup yang dibuka oleh klien.

Memanggil metode ini tidak perlu saat menggunakan klien sebagai manajer konteks.

close() -> None

Pengecualian

ResourceNotFoundError

jika sertifikat tidak ada,

HttpResponseError

untuk kesalahan lain

create_issuer

Mengatur penerbit sertifikat yang ditentukan. Memerlukan izin sertifikat/setissuers.

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

Parameter

issuer_name

str

Diperlukan

Nama penerbit.

provider

str

Diperlukan

Penyedia pengeluar sertifikat.

enabled

bool

Apakah pengeluar sertifikat diaktifkan untuk digunakan.

account_id

str

Nama pengguna/nama akun/id akun.

password

str

Kata sandi/rahasia/kunci akun.

organization_id

str

Id organisasi

admin_contacts

list[AdministratorContact]

Detail kontak administrator organisasi penerbit sertifikat.

Mengembalikan

CertificateIssuer yang dibuat

Tipe hasil

CertificateIssuer

Pengecualian

HttpResponseError

delete_certificate_operation

Menghapus dan menghentikan operasi pembuatan untuk sertifikat tertentu.

Memerlukan izin sertifikat/pembaruan.

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat.

Mengembalikan

CertificateOperation yang dihapus

Tipe hasil

CertificateOperation

Pengecualian

HttpResponseError

delete_contacts

Menghapus kontak sertifikat untuk brankas kunci. Memerlukan izin sertifikat/managecontacts.

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

Mengembalikan

Kontak yang dihapus untuk brankas kunci.

Tipe hasil

list[CertificateContact]

Pengecualian

HttpResponseError

delete_issuer

Menghapus pengeluar sertifikat yang ditentukan.

Memerlukan izin sertifikat/manageissuers/deleteissuers.

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

Parameter

issuer_name

str

Diperlukan

Nama penerbit.

Mengembalikan

CertificateIssuer

Tipe hasil

CertificateIssuer

Pengecualian

HttpResponseError

get_certificate

Mendapatkan sertifikat dengan kebijakan manajemennya yang terlampir. Memerlukan sertifikat/mendapatkan izin.

Tidak menerima versi sertifikat sebagai parameter. Untuk mendapatkan versi sertifikat tertentu, panggil get_certificate_version.

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat dalam vault yang diberikan.

Mengembalikan

Instans KeyVaultCertificate

Tipe hasil

KeyVaultCertificate

Pengecualian

ResourceNotFoundError

jika sertifikat tidak ada,

HttpResponseError

untuk kesalahan lain

get_certificate_operation

Mendapatkan operasi pembuatan sertifikat. Memerlukan izin sertifikat/dapatkan.

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat.

Mengembalikan

CertificateOperation yang dibuat

Tipe hasil

CertificateOperation

Pengecualian

ResourceNotFoundError

jika sertifikat tidak ada,

HttpResponseError

untuk kesalahan lain

get_certificate_policy

Mendapatkan kebijakan untuk sertifikat. Memerlukan sertifikat/mendapatkan izin.

Mengembalikan sumber daya kebijakan sertifikat yang ditentukan di brankas kunci.

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat dalam brankas kunci tertentu.

Mengembalikan

Kebijakan sertifikat

Tipe hasil

CertificatePolicy

Pengecualian

HttpResponseError

get_certificate_version

Mendapatkan versi sertifikat tertentu tanpa mengembalikan kebijakan manajemennya.

Memerlukan sertifikat/mendapatkan izin. Untuk mendapatkan versi terbaru sertifikat, atau untuk mendapatkan kebijakan sertifikat juga, panggil get_certificate.

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat dalam vault yang diberikan.

version

str

Diperlukan

Versi sertifikat.

Mengembalikan

Instans KeyVaultCertificate

Tipe hasil

KeyVaultCertificate

Pengecualian

ResourceNotFoundError

jika sertifikat tidak ada,

HttpResponseError

untuk kesalahan lain

get_contacts

Mendapatkan kontak sertifikat untuk brankas kunci. Memerlukan izin sertifikat/managecontacts.

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

Mengembalikan

Kontak sertifikat untuk brankas kunci.

Tipe hasil

list[CertificateContact]

Pengecualian

HttpResponseError

get_deleted_certificate

Mendapatkan sertifikat yang dihapus. Hanya dimungkinkan dalam vault dengan penghapusan sementara diaktifkan.

Memerlukan sertifikat/mendapatkan izin. Mengambil informasi sertifikat yang dihapus ditambah atributnya, seperti interval retensi, penghapusan permanen terjadwal, dan tingkat pemulihan penghapusan saat ini.

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat.

Mengembalikan

Sertifikat yang dihapus

Tipe hasil

DeletedCertificate

Pengecualian

ResourceNotFoundError

jika sertifikat tidak ada,

HttpResponseError

untuk kesalahan lain

get_issuer

Mendapatkan pengeluar sertifikat yang ditentukan. Memerlukan izin sertifikat/manageissuers/getissuers.

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

Parameter

issuer_name

str

Diperlukan

Nama penerbit.

Mengembalikan

Penerbit sertifikat yang ditentukan.

Tipe hasil

CertificateIssuer

Pengecualian

ResourceNotFoundError

jika penerbit tidak ada,

HttpResponseError

untuk kesalahan lain

import_certificate

Impor sertifikat yang dibuat secara eksternal. Memerlukan izin sertifikat/impor.

Mengimpor sertifikat valid yang sudah ada, yang berisi kunci privat, ke azure Key Vault. Sertifikat yang akan diimpor dapat berada dalam format PFX atau PEM. Jika sertifikat dalam format PEM, file PEM harus berisi kunci serta sertifikat x509, dan Anda harus memberikan policy dengan content_type .pem

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat.

certificate_bytes

bytes

Diperlukan

Byte objek sertifikat yang akan diimpor. Sertifikat ini perlu berisi kunci privat.

enabled

bool

Apakah sertifikat diaktifkan untuk digunakan.

tags

dict[str, str]

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

password

str

Jika kunci privat dalam sertifikat yang diteruskan dienkripsi, itu adalah kata sandi yang digunakan untuk enkripsi.

policy

CertificatePolicy

Kebijakan manajemen untuk sertifikat. Diperlukan jika mengimpor sertifikat format PEM, dengan content_type diatur ke pem.

Mengembalikan

KeyVaultCertificate yang diimpor

Tipe hasil

KeyVaultCertificate

Pengecualian

HttpResponseError

list_deleted_certificates

Mencantumkan sertifikat yang dihapus yang saat ini dapat dipulihkan. Dimungkinkan hanya jika vault diaktifkan penghapusan sementara.

Memerlukan izin sertifikat/dapatkan/daftar. Mengambil sertifikat dalam vault saat ini yang dalam status dihapus dan siap untuk pemulihan atau pembersihan. Operasi ini mencakup informasi khusus penghapusan.

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

Parameter

include_pending

bool

Menentukan apakah akan menyertakan sertifikat yang tidak sepenuhnya dihapus. Hanya tersedia untuk versi API v7.0 ke atas.

Mengembalikan

Instans seperti iterator dari DeletedCertificate

Tipe hasil

ItemPaged[DeletedCertificate]

Pengecualian

HttpResponseError

list_properties_of_certificate_versions

Mencantumkan pengidentifikasi dan properti versi sertifikat.

Memerlukan izin sertifikat/daftar.

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat.

Mengembalikan

Instans certificateProperties seperti iterator

Tipe hasil

ItemPaged[CertificateProperties]

Pengecualian

HttpResponseError

list_properties_of_certificates

Mencantumkan pengidentifikasi dan properti semua sertifikat dalam vault.

Memerlukan izin sertifikat/daftar.

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

Parameter

include_pending

bool

Menentukan apakah akan menyertakan sertifikat yang tidak sepenuhnya disediakan. Hanya tersedia untuk versi API v7.0 ke atas.

Mengembalikan

Instans certificateProperties seperti iterator

Tipe hasil

ItemPaged[CertificateProperties]

Pengecualian

HttpResponseError

list_properties_of_issuers

Mencantumkan properti penerbit sertifikat untuk brankas kunci.

Memerlukan izin sertifikat/manageissuers/getissuers.

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

Mengembalikan

Contoh Penerbit seperti iterator

Tipe hasil

ItemPaged[CertificateIssuer]

Pengecualian

HttpResponseError

merge_certificate

Menggabungkan sertifikat atau rantai sertifikat dengan pasangan kunci yang ada di server.

Memerlukan izin sertifikat/buat. Melakukan penggabungan sertifikat atau rantai sertifikat dengan pasangan kunci yang saat ini tersedia dalam layanan. Pastikan saat membuat sertifikat untuk digabungkan menggunakan begin_create_certificate bahwa Anda mengatur penerbitnya ke 'Tidak Diketahui'. Dengan cara ini Key Vault tahu bahwa sertifikat tidak akan ditandatangani oleh pengeluar sertifikat yang diketahuinya.

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat

x509_certificates

list[bytes]

Diperlukan

Sertifikat atau rantai sertifikat yang akan digabungkan.

enabled

bool atau None

Apakah sertifikat diaktifkan untuk digunakan.

tags

dict[str, str] atau None

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

Mengembalikan

Sertifikat gabungan

Tipe hasil

KeyVaultCertificate

Pengecualian

HttpResponseError

purge_deleted_certificate

Menghapus sertifikat yang dihapus secara permanen. Hanya dimungkinkan dalam vault dengan penghapusan sementara diaktifkan.

Memerlukan izin sertifikat/hapus menyeluruh. Melakukan penghapusan yang tidak dapat diubah dari sertifikat yang ditentukan, tanpa kemungkinan untuk pemulihan. Operasi tidak tersedia jika recovery_level tidak menentukan 'Dapat Dibersihkan'. Metode ini hanya diperlukan untuk membersihkan sertifikat sebelum scheduled_purge_date.

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat

Mengembalikan

Tidak ada

Tipe hasil

None

Pengecualian

HttpResponseError

restore_certificate_backup

Pulihkan cadangan sertifikat ke vault. Memerlukan izin sertifikat/pemulihan.

Ini memulihkan semua versi sertifikat, dengan nama, atribut, dan kebijakan kontrol aksesnya. Jika nama sertifikat sudah digunakan, memulihkannya akan gagal. Selain itu, vault target harus dimiliki oleh langganan Microsoft Azure yang sama dengan vault sumber.

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

Parameter

backup

bytes

Diperlukan

Blob cadangan yang terkait dengan bundel sertifikat.

Mengembalikan

KeyVaultCertificate yang dipulihkan

Tipe hasil

KeyVaultCertificate

Pengecualian

HttpResponseError

send_request

Menjalankan permintaan jaringan menggunakan alur klien yang ada.

URL permintaan dapat relatif terhadap URL vault. Versi API layanan yang digunakan untuk permintaan sama dengan klien kecuali ditentukan lain. Metode ini tidak menaikkan jika respons adalah kesalahan; untuk menaikkan pengecualian, panggil raise_for_status() pada objek respons yang dikembalikan. Untuk informasi selengkapnya tentang cara mengirim permintaan kustom dengan metode ini, lihat https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parameter

request

HttpRequest

Diperlukan

Permintaan jaringan yang ingin Anda buat.

stream

bool

Apakah payload respons akan dialirkan. Default ke False.

Mengembalikan

Respons panggilan jaringan Anda. Tidak melakukan penanganan kesalahan pada respons Anda.

Tipe hasil

HttpResponse

Pengecualian

ResourceNotFoundError

jika sertifikat tidak ada,

HttpResponseError

untuk kesalahan lain

set_contacts

Mengatur kontak sertifikat untuk brankas kunci. Memerlukan izin sertifikat/kelolakontacts.

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

Parameter

contacts

list[CertificateContact]

Diperlukan

Daftar kontak untuk sertifikat vault.

Mengembalikan

Daftar kontak yang dibuat

Tipe hasil

list[CertificateContact]

Pengecualian

HttpResponseError

update_certificate_policy

Updates kebijakan untuk sertifikat. Memerlukan izin sertifikat/pembaruan.

Atur anggota tertentu dalam kebijakan sertifikat. Meninggalkan yang lain sebagai null.

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat dalam vault yang diberikan.

policy

CertificatePolicy

Diperlukan

Kebijakan untuk sertifikat.

Mengembalikan

Kebijakan sertifikat

Tipe hasil

CertificatePolicy

Pengecualian

HttpResponseError

update_certificate_properties

Mengubah properti sertifikat. Memerlukan izin sertifikat/pembaruan.

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

Parameter

certificate_name

str

Diperlukan

Nama sertifikat dalam brankas kunci yang diberikan.

version

str

Diperlukan

Versi sertifikat.

enabled

bool

Apakah sertifikat diaktifkan untuk digunakan.

tags

dict[str, str]

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

Mengembalikan

KeyVaultCertificate yang diperbarui

Tipe hasil

KeyVaultCertificate

Pengecualian

HttpResponseError

update_issuer

Updates penerbit sertifikat yang ditentukan. Memerlukan izin sertifikat/setissuers.

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

Parameter

issuer_name

str

Diperlukan

Nama penerbit.

enabled

bool

Apakah pengeluar sertifikat diaktifkan untuk digunakan.

provider

str

Penyedia pengeluar sertifikat

account_id

str

Nama pengguna/nama akun/id akun.

password

str

Kata sandi/rahasia/kunci akun.

organization_id

str

Id organisasi

admin_contacts

list[AdministratorContact]

Detail kontak administrator organisasi penerbit sertifikat

Mengembalikan

Pengeluar sertifikat yang diperbarui

Tipe hasil

CertificateIssuer

Pengecualian

HttpResponseError

Atribut

vault_url