KeyClient Kelas

Referensi

Antarmuka tingkat tinggi untuk mengelola kunci brankas.

Warisan: azure.keyvault.keys._shared.client_base.KeyVaultClientBase

KeyClient

Konstruktor

KeyClient(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 atau HSM Terkelola 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 HSM Key Vault atau Terkelola. Default ke True.

Metode

backup_key	Cadangkan kunci dalam bentuk terproteksi yang hanya dapat digunakan oleh Azure Key Vault. Memerlukan izin kunci/cadangan. Ini dimaksudkan untuk memungkinkan penyalinan kunci 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_delete_key	Hapus semua versi kunci dan materi kriptografinya. Memerlukan izin kunci/hapus. Ketika metode ini mengembalikan Key Vault telah mulai menghapus kunci. 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_key	Pulihkan kunci yang dihapus ke versi terbarunya. Hanya dimungkinkan dalam vault dengan penghapusan sementara diaktifkan. Memerlukan izin kunci/pulihkan. Ketika metode ini mengembalikan Key Vault telah mulai memulihkan kunci. 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 kunci yang dipulihkan dalam operasi lain segera.
close	Soket tutup yang dibuka oleh klien. Memanggil metode ini tidak perlu saat menggunakan klien sebagai manajer konteks.
create_ec_key	Buat kunci kurva elips baru atau, jika `name` sudah digunakan, buat versi baru kunci. Memerlukan izin kunci/buat.
create_key	Buat kunci atau, jika `name` sudah digunakan, buat versi baru kunci. Memerlukan izin kunci/buat.
create_oct_key	Buat kunci urutan oktet baru (simetris) atau, jika `name` sedang digunakan, buat versi baru kunci. Memerlukan izin kunci/buat.
create_rsa_key	Buat kunci RSA baru atau, jika `name` sudah digunakan, buat versi baru kunci Memerlukan izin kunci/buat.
get_cryptography_client	CryptographyClient Mendapatkan untuk kunci yang diberikan.
get_deleted_key	Dapatkan kunci yang dihapus. Hanya dimungkinkan dalam vault dengan penghapusan sementara diaktifkan. Memerlukan izin kunci/dapatkan.
get_key	Dapatkan atribut kunci dan, jika itu adalah kunci asimetris, materi publiknya. Memerlukan izin kunci/dapatkan.
get_key_rotation_policy	Dapatkan kebijakan rotasi kunci Key Vault.
get_random_bytes	Dapatkan jumlah byte acak yang diminta dari HSM terkelola.
import_key	Impor kunci yang dibuat secara eksternal. Memerlukan izin kunci/impor. Jika `name` sudah digunakan, kunci akan diimpor sebagai versi baru.
list_deleted_keys	Cantumkan semua kunci yang dihapus, termasuk bagian publik dari masing-masing kunci. Hanya dimungkinkan dalam vault dengan penghapusan sementara diaktifkan. Memerlukan izin kunci/daftar.
list_properties_of_key_versions	Mencantumkan pengidentifikasi dan properti versi kunci. Memerlukan izin kunci/daftar.
list_properties_of_keys	Mencantumkan pengidentifikasi dan properti semua kunci di vault. Memerlukan izin kunci/daftar.
purge_deleted_key	Menghapus kunci yang dihapus secara permanen. Hanya dimungkinkan dalam vault dengan penghapusan sementara diaktifkan. Melakukan penghapusan kunci yang ditentukan yang tidak dapat diubah, tanpa kemungkinan untuk pemulihan. Operasi tidak tersedia jika recovery_level tidak menentukan 'Dapat Dibersihkan'. Metode ini hanya diperlukan untuk membersihkan kunci sebelum scheduled_purge_date. Memerlukan izin kunci/hapus menyeluruh.
release_key	Merilis kunci. Operasi kunci rilis berlaku untuk semua jenis kunci. Kunci target harus ditandai dapat diekspor. Operasi ini memerlukan izin kunci/rilis.
restore_key_backup	Pulihkan cadangan kunci ke vault. Memerlukan izin kunci/pemulihan. Ini mengimpor semua versi kunci, dengan nama, atribut, dan kebijakan kontrol aksesnya. Jika nama kunci sudah digunakan, memulihkannya akan gagal. Selain itu, vault target harus dimiliki oleh langganan Microsoft Azure yang sama dengan vault sumber.
rotate_key	Putar kunci berdasarkan kebijakan kunci dengan membuat versi kunci baru. Operasi ini memerlukan izin kunci/putar.
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 responsnya 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.
update_key_properties	Ubah properti kunci (bukan materi kriptografinya). Memerlukan izin kunci/pembaruan.
update_key_rotation_policy	Updates kebijakan rotasi kunci Key Vault. Operasi ini memerlukan izin kunci/pembaruan.

backup_key

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

Memerlukan izin kunci/cadangan.

Ini dimaksudkan untuk memungkinkan penyalinan kunci 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_key(name: str, **kwargs) -> bytes

Parameter

name: str

Diperlukan

Nama kunci yang akan dicadangkan

Tipe hasil

bytes

Pengecualian

ResourceNotFoundError

jika kunci tidak ada,

HttpResponseError

untuk kesalahan lain

begin_delete_key

Hapus semua versi kunci dan materi kriptografinya.

Memerlukan izin kunci/hapus. Ketika metode ini mengembalikan Key Vault telah mulai menghapus kunci. 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_key(name: str, **kwargs) -> LROPoller[DeletedKey]

Parameter

name: str

Diperlukan

Nama kunci yang akan dihapus.

Mengembalikan

Poller untuk operasi hapus kunci. Metode hasil poller mengembalikan DeletedKey tanpa menunggu penghapusan selesai. Jika vault mengaktifkan penghapusan sementara dan Anda ingin menghapus kunci secara permanen dengan purge_deleted_key, hubungi metode tunggu poller terlebih dahulu. Ini akan memblokir sampai penghapusan selesai. Metode tunggu memerlukan izin kunci/dapatkan.

Tipe hasil

LROPoller[DeletedKey]

Pengecualian

ResourceNotFoundError

jika kunci tidak ada,

HttpResponseError

untuk kesalahan lain

begin_recover_deleted_key

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

Memerlukan izin kunci/pulihkan.

Ketika metode ini mengembalikan Key Vault telah mulai memulihkan kunci. 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 kunci yang dipulihkan dalam operasi lain segera.

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

Parameter

name: str

Diperlukan

Nama kunci yang dihapus untuk dipulihkan

Mengembalikan

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

Tipe hasil

LROPoller[KeyVaultKey]

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 kunci tidak ada,

HttpResponseError

untuk kesalahan lain

create_ec_key

Buat kunci kurva elips baru atau, jika name sudah digunakan, buat versi baru kunci.

Memerlukan izin kunci/buat.

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

Parameter

name: str

Diperlukan

Nama untuk kunci baru.

curve: KeyCurveName atau str atau None

Nama kurva elips. Default ke kurva elips NIST P-256.

key_operations: list[KeyOperation atau str] atau None

Operasi kunci yang diizinkan

hardware_protected: bool atau None

Apakah kunci harus dibuat dalam modul keamanan perangkat keras. Default ke False.

enabled: bool atau None

Apakah kunci diaktifkan untuk digunakan.

tags: dict[str, str] atau None

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

not_before: datetime atau None

Tidak sebelum tanggal kunci dalam UTC

expires_on: datetime atau None

Tanggal kedaluwarsa kunci dalam UTC

exportable: bool atau None

Apakah kunci privat dapat diekspor.

release_policy: KeyReleasePolicy atau None

Aturan kebijakan tempat kunci dapat diekspor.

Mengembalikan

Kunci yang dibuat

Tipe hasil

KeyVaultKey

Pengecualian

HttpResponseError

create_key

Buat kunci atau, jika name sudah digunakan, buat versi baru kunci.

Memerlukan izin kunci/buat.

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

Parameter

name: str

Diperlukan

Nama kunci baru.

key_type: KeyType atau str

Diperlukan

Jenis kunci yang akan dibuat

size: int atau None

Ukuran kunci dalam bit. Hanya berlaku untuk RSA dan kunci konten. Pertimbangkan untuk menggunakan create_rsa_key atau create_oct_key sebagai gantinya.

curve: KeyCurveName atau str atau None

Nama kurva elips. Hanya berlaku untuk kunci kurva elips. Default ke kurva elips NIST P-256. Untuk membuat kunci kurva elips, pertimbangkan untuk menggunakan create_ec_key sebagai gantinya.

public_exponent: int atau None

Eksponen publik RSA untuk digunakan. Hanya berlaku untuk kunci RSA yang dibuat di HSM Terkelola.

key_operations: list[KeyOperation atau str] atau None

Operasi kunci yang diizinkan

enabled: bool atau None

Apakah kunci diaktifkan untuk digunakan.

tags: dict[str, str] atau None

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

not_before: datetime atau None

Tidak sebelum tanggal kunci dalam UTC

expires_on: datetime atau None

Tanggal kedaluwarsa kunci dalam UTC

exportable: bool atau None

Apakah kunci privat dapat diekspor.

release_policy: KeyReleasePolicy atau None

Aturan kebijakan tempat kunci dapat diekspor.

Mengembalikan

Kunci yang dibuat

Tipe hasil

KeyVaultKey

Pengecualian

HttpResponseError

create_oct_key

Buat kunci urutan oktet baru (simetris) atau, jika name sedang digunakan, buat versi baru kunci.

Memerlukan izin kunci/buat.

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

Parameter

name: str

Diperlukan

Nama untuk kunci baru.

size: int atau None

Ukuran kunci dalam bit, misalnya 128, 192, atau 256.

key_operations: list[KeyOperation atau str] atau None

Operasi kunci yang diizinkan.

hardware_protected: bool atau None

Apakah kunci harus dibuat dalam modul keamanan perangkat keras. Default ke False.

enabled: bool atau None

Apakah kunci diaktifkan untuk digunakan.

tags: dict[str, str] atau None

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

not_before: datetime atau None

Tidak sebelum tanggal kunci dalam UTC

expires_on: datetime atau None

Tanggal kedaluwarsa kunci dalam UTC

exportable: bool atau None

Apakah kunci dapat diekspor.

release_policy: KeyReleasePolicy atau None

Aturan kebijakan tempat kunci dapat diekspor.

Mengembalikan

Kunci yang dibuat

Tipe hasil

KeyVaultKey

Pengecualian

HttpResponseError

create_rsa_key

Buat kunci RSA baru atau, jika name sudah digunakan, buat versi baru kunci

Memerlukan izin kunci/buat.

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

Parameter

name: str

Diperlukan

Nama untuk kunci baru.

size: int atau None

Ukuran kunci dalam bit, misalnya 2048, 3072, atau 4096.

public_exponent: int atau None

Eksponen publik RSA untuk digunakan. Hanya berlaku untuk kunci RSA yang dibuat di HSM Terkelola.

hardware_protected: bool atau None

Apakah kunci harus dibuat dalam modul keamanan perangkat keras. Default ke False.

key_operations: list[KeyOperation atau str] atau None

Operasi kunci yang diizinkan

enabled: bool atau None

Apakah kunci diaktifkan untuk digunakan.

tags: dict[str, str] atau None

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

not_before: datetime atau None

Tidak sebelum tanggal kunci di UTC

expires_on: datetime atau None

Tanggal kedaluwarsa kunci dalam UTC

exportable: bool atau None

Apakah kunci privat dapat diekspor.

release_policy: KeyReleasePolicy atau None

Aturan kebijakan tempat kunci dapat diekspor.

Mengembalikan

Kunci yang dibuat

Tipe hasil

KeyVaultKey

Pengecualian

HttpResponseError

get_cryptography_client

CryptographyClient Mendapatkan untuk kunci yang diberikan.

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

Parameter

key_name: str

Diperlukan

Nama kunci yang digunakan untuk melakukan operasi kriptografi.

key_version: str

Versi opsional kunci yang digunakan untuk melakukan operasi kriptografi.

Mengembalikan

Menggunakan CryptographyClient opsi, kredensial, dan klien HTTP yang sama seperti ini KeyClient.

Tipe hasil

CryptographyClient

Pengecualian

ResourceNotFoundError

jika kunci tidak ada,

HttpResponseError

untuk kesalahan lain

get_deleted_key

Dapatkan kunci yang dihapus. Hanya dimungkinkan dalam vault dengan penghapusan sementara diaktifkan.

Memerlukan izin kunci/dapatkan.

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

Parameter

name: str

Diperlukan

Nama kunci

Mengembalikan

Kunci yang dihapus

Tipe hasil

DeletedKey

Pengecualian

ResourceNotFoundError

jika kunci tidak ada,

HttpResponseError

untuk kesalahan lain

get_key

Dapatkan atribut kunci dan, jika itu adalah kunci asimetris, materi publiknya.

Memerlukan izin kunci/dapatkan.

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

Parameter

name: str

Diperlukan

Nama kunci yang akan didapatkan.

version: str atau None

Diperlukan

(opsional) Versi kunci tertentu untuk didapatkan. Jika tidak ditentukan, mendapatkan versi kunci terbaru.

Tipe hasil

KeyVaultKey

Pengecualian

ResourceNotFoundError

jika kunci tidak ada,

HttpResponseError

untuk kesalahan lain

get_key_rotation_policy

Dapatkan kebijakan rotasi kunci Key Vault.

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

Parameter

key_name: str

Diperlukan

Nama kunci.

Mengembalikan

Kebijakan rotasi kunci.

Tipe hasil

KeyRotationPolicy

Pengecualian

*azure.core.exceptions.HttpResponseError*

get_random_bytes

Dapatkan jumlah byte acak yang diminta dari HSM terkelola.

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

Parameter

count: int

Diperlukan

Jumlah byte acak yang diminta.

Mengembalikan

Byte acak.

Tipe hasil

bytes

Pengecualian

ValueError

jika kurang dari satu byte acak diminta,

HttpResponseError

untuk kesalahan lain

import_key

Impor kunci yang dibuat secara eksternal.

Memerlukan izin kunci/impor. Jika name sudah digunakan, kunci akan diimpor sebagai versi baru.

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

Parameter

name: str

Diperlukan

Nama untuk kunci yang diimpor

key: JsonWebKey

Diperlukan

Kunci web JSON yang akan diimpor

hardware_protected: bool atau None

Apakah kunci harus didukung oleh modul keamanan perangkat keras

enabled: bool atau None

Apakah kunci diaktifkan untuk digunakan.

tags: dict[str, str] atau None

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

not_before: datetime atau None

Tidak sebelum tanggal kunci di UTC

expires_on: datetime atau None

Tanggal kedaluwarsa kunci dalam UTC

exportable: bool atau None

Apakah kunci privat dapat diekspor.

release_policy: KeyReleasePolicy atau None

Aturan kebijakan tempat kunci dapat diekspor.

Mengembalikan

Kunci yang diimpor

Tipe hasil

KeyVaultKey

Pengecualian

HttpResponseError

list_deleted_keys

Cantumkan semua kunci yang dihapus, termasuk bagian publik dari masing-masing kunci. Hanya dimungkinkan dalam vault dengan penghapusan sementara diaktifkan.

Memerlukan izin kunci/daftar.

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

Mengembalikan

Iterator kunci yang dihapus

Tipe hasil

ItemPaged[DeletedKey]

Pengecualian

ResourceNotFoundError

jika kunci tidak ada,

HttpResponseError

untuk kesalahan lain

list_properties_of_key_versions

Mencantumkan pengidentifikasi dan properti versi kunci.

Memerlukan izin kunci/daftar.

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

Parameter

name: str

Diperlukan

Nama kunci

Mengembalikan

Iterator kunci tanpa materi kriptografinya

Tipe hasil

ItemPaged[KeyProperties]

Pengecualian

ResourceNotFoundError

jika kunci tidak ada,

HttpResponseError

untuk kesalahan lain

list_properties_of_keys

Mencantumkan pengidentifikasi dan properti semua kunci di vault.

Memerlukan izin kunci/daftar.

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

Mengembalikan

Iterator kunci tanpa materi kriptografi atau informasi versinya

Tipe hasil

ItemPaged[KeyProperties]

Pengecualian

ResourceNotFoundError

jika kunci tidak ada,

HttpResponseError

untuk kesalahan lain

purge_deleted_key

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

Melakukan penghapusan kunci yang ditentukan yang tidak dapat diubah, tanpa kemungkinan untuk pemulihan. Operasi tidak tersedia jika recovery_level tidak menentukan 'Dapat Dibersihkan'. Metode ini hanya diperlukan untuk membersihkan kunci sebelum scheduled_purge_date.

Memerlukan izin kunci/hapus menyeluruh.

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

Parameter

name: str

Diperlukan

Nama kunci yang dihapus untuk dihapus menyeluruh

Mengembalikan

Tidak ada

Pengecualian

HttpResponseError

Contoh


   # 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

Merilis kunci.

Operasi kunci rilis berlaku untuk semua jenis kunci. Kunci target harus ditandai dapat diekspor. Operasi ini memerlukan izin kunci/rilis.

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

Parameter

name: str

Diperlukan

Nama kunci yang akan didapatkan.

target_attestation_token: str

Diperlukan

Pernyataan pengesahan untuk target rilis kunci.

version: str atau None

Versi tertentu dari kunci yang akan dirilis. Jika tidak ditentukan, versi terbaru akan dirilis.

algorithm: str atau KeyExportEncryptionAlgorithm atau None

Algoritma enkripsi yang digunakan untuk melindungi materi kunci yang dirilis.

nonce: str atau None

Nonce yang disediakan klien untuk kesegaran.

Mengembalikan

Hasil dari rilis kunci.

Tipe hasil

ReleaseKeyResult

Pengecualian

HttpResponseError

restore_key_backup

Pulihkan cadangan kunci ke vault.

Memerlukan izin kunci/pemulihan.

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

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

Parameter

backup: bytes

Diperlukan

Cadangan kunci sebagaimana dikembalikan oleh backup_key

Mengembalikan

Kunci yang dipulihkan

Tipe hasil

KeyVaultKey

Pengecualian

ResourceExistsError

jika nama kunci yang dicadangkan sudah digunakan,

HttpResponseError

untuk kesalahan lain

rotate_key

Putar kunci berdasarkan kebijakan kunci dengan membuat versi kunci baru.

Operasi ini memerlukan izin kunci/putar.

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

Parameter

name: str

Diperlukan

Nama kunci yang akan diputar.

Mengembalikan

Versi baru kunci yang diputar.

Tipe hasil

KeyVaultKey

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 responsnya 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 kunci tidak ada,

HttpResponseError

untuk kesalahan lain

update_key_properties

Ubah properti kunci (bukan materi kriptografinya).

Memerlukan izin kunci/pembaruan.

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

Parameter

name: str

Diperlukan

Nama kunci yang akan diperbarui

version: str atau None

Diperlukan

(opsional) Versi kunci yang akan diperbarui. Jika tidak ditentukan, versi terbaru diperbarui.

key_operations: list[KeyOperation atau str] atau None

Operasi kunci yang diizinkan

enabled: bool atau None

Apakah kunci diaktifkan untuk digunakan.

tags: dict[str, str] atau None

Metadata khusus aplikasi dalam bentuk pasangan kunci-nilai.

not_before: datetime atau None

Tidak sebelum tanggal kunci dalam UTC

expires_on: datetime atau None

Tanggal kedaluwarsa kunci dalam UTC

release_policy: KeyReleasePolicy atau None

Aturan kebijakan tempat kunci dapat diekspor.

Mengembalikan

Kunci yang diperbarui

Tipe hasil

KeyVaultKey

Pengecualian

ResourceNotFoundError

jika kunci tidak ada,

HttpResponseError

untuk kesalahan lain

update_key_rotation_policy

Updates kebijakan rotasi kunci Key Vault.

Operasi ini memerlukan izin kunci/pembaruan.

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

Parameter

key_name: str

Diperlukan

Nama kunci dalam vault yang diberikan.

policy: KeyRotationPolicy

Diperlukan

Kebijakan rotasi baru untuk kunci.

lifetime_actions: list[KeyRotationLifetimeAction]

Tindakan yang akan dilakukan oleh Key Vault selama masa pakai kunci. Ini akan mengambil alih tindakan seumur hidup dari yang disediakan policy.

expires_in: str

Waktu kedaluwarsa kebijakan yang akan diterapkan pada versi kunci baru, didefinisikan sebagai durasi ISO 8601. Misalnya: 90 hari adalah "P90D", 3 bulan adalah "P3M", dan 48 jam adalah "PT48H". Lihat Wikipedia untuk informasi selengkapnya tentang durasi ISO 8601. Ini akan menggantikan waktu kedaluwarsa dari yang disediakan policy.