KeyClient Sınıf

Anahtarı yalnızca Azure Key Vault tarafından kullanılabilen korumalı bir formda yedekleyin.

Anahtarlar/yedekleme izni gerektirir.

Bu, bir anahtarın bir kasadan diğerine kopyalanmasını sağlamak için tasarlanmıştır. Her iki kasa da aynı Azure aboneliğine ait olmalıdır. Ayrıca, jeopolitik sınırlar arasında yedekleme/geri yükleme gerçekleştirilemez. Örneğin, ABD bölgesindeki bir kasadan alınan yedekleme, AB bölgesindeki bir kasaya geri yüklenemez.

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

Parametreler

Dönüş türü

Özel durumlar

anahtar yoksa,

diğer hatalar için

Anahtarın tüm sürümlerini ve şifreleme malzemesini silin.

Anahtarlar/silme izni gerektirir. Bu yöntem döndürdüğünde Key Vault anahtarı silmeye başladı. Geçici silmenin etkinleştirildiği bir kasada silme işlemi birkaç saniye sürebilir. Bu nedenle bu yöntem silme işleminin tamamlanmasını beklemenizi sağlayan bir poller döndürür.

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

Parametreler

Döndürülenler

Anahtar silme işlemi için bir poller. Poller'ın sonuç yöntemi, silme işleminin tamamlanmasını beklemeden öğesini DeletedKey döndürür. Kasada geçici silme etkinleştirildiyse ve anahtarı ile purge_deleted_keykalıcı olarak silmek istiyorsanız, önce poller'ın bekleme yöntemini çağırın. Silme işlemi tamamlanana kadar engeller. Bekleme yöntemi anahtarlar/alma izni gerektirir.

Dönüş türü

Özel durumlar

anahtar yoksa,

diğer hatalar için

Silinen bir anahtarı en son sürümüne kurtarma. Yalnızca geçici silmenin etkinleştirildiği bir kasada mümkündür.

Anahtarlar/kurtarma izni gerektirir.

Bu yöntem döndürdüğünde Key Vault anahtarı kurtarmaya başladı. Kurtarma işlemi birkaç saniye sürebilir. Bu nedenle bu yöntem kurtarmanın tamamlanmasını beklemenizi sağlayan bir poller döndürür. Bekleme yalnızca kurtarılan anahtarı hemen başka bir işlemde kullanmak istediğinizde gereklidir.

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

Parametreler

Döndürülenler

Kurtarma işlemi için bir poller. Poller'ın sonuç yöntemi kurtarmanın tamamlanmasını beklemeden kurtarılanı KeyVaultKey döndürür. Kurtarılan anahtarı hemen kullanmak istiyorsanız, anahtar kullanıma hazır olana kadar engelleyen poller'ın bekleme yöntemini çağırın. Bekleme yöntemi anahtarlar/alma izni gerektirir.

Dönüş türü

Özel durumlar

İstemci tarafından açılan yuvaları kapatın.

İstemciyi bağlam yöneticisi olarak kullanırken bu yöntemi çağırmak gereksizdir.

close() -> None

Özel durumlar

anahtar yoksa,

diğer hatalar için

Yeni bir üç nokta eğrisi anahtarı oluşturun veya zaten kullanılıyorsa name anahtarın yeni bir sürümünü oluşturun.

Anahtarlar/oluşturma izni gerektirir.

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

Parametreler

Döndürülenler

Oluşturulan anahtar

Dönüş türü

Özel durumlar

Bir anahtar oluşturun veya zaten kullanılıyorsa name anahtarın yeni bir sürümünü oluşturun.

Anahtarlar/oluşturma izni gerektirir.

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

Parametreler

Döndürülenler

Oluşturulan anahtar

Dönüş türü

Özel durumlar

Yeni bir sekizli dizi (simetrik) anahtarı oluşturun veya kullanılıyorsa name anahtarın yeni bir sürümünü oluşturun.

Anahtarlar/oluşturma izni gerektirir.

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

Parametreler

Döndürülenler

Oluşturulan anahtar

Dönüş türü

Özel durumlar

Yeni bir RSA anahtarı oluşturun veya zaten kullanılıyorsa name anahtarın yeni bir sürümünü oluşturun

Anahtarlar/oluşturma izni gerektirir.

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

Parametreler

Döndürülenler

Oluşturulan anahtar

Dönüş türü

Özel durumlar

Verilen anahtar için bir CryptographyClient alır.

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

Parametreler

Döndürülenler

CryptographyClient Bu KeyClientile aynı seçenekleri, kimlik bilgilerini ve HTTP istemcisini kullanan bir .

Dönüş türü

Özel durumlar

anahtar yoksa,

diğer hatalar için

Silinen bir anahtarı alın. Yalnızca geçici silmenin etkinleştirildiği bir kasada mümkündür.

Anahtarlar/alma izni gerektirir.

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

Parametreler

Döndürülenler

Silinen anahtar

Dönüş türü

Özel durumlar

anahtar yoksa,

diğer hatalar için

Anahtarın özniteliklerini ve asimetrik anahtarsa ortak malzemesini alın.

Anahtarlar/alma izni gerektirir.

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

Parametreler

Dönüş türü

Özel durumlar

anahtar yoksa,

diğer hatalar için

Key Vault anahtarının döndürme ilkesini alın.

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

Parametreler

Döndürülenler

Anahtar döndürme ilkesi.

Dönüş türü

Özel durumlar

Yönetilen bir HSM'den istenen rastgele bayt sayısını alın.

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

Parametreler

Döndürülenler

Rastgele bayt.

Dönüş türü

Özel durumlar

birden az rastgele bayt istenirse,

diğer hatalar için

Harici olarak oluşturulan bir anahtarı içeri aktar.

Anahtarlar/içeri aktarma izni gerektirir. Zaten kullanılıyorsa name anahtar yeni bir sürüm olarak içeri aktarılır.

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

Parametreler

Döndürülenler

İçeri aktarılan anahtar

Dönüş türü

Özel durumlar

Her birinin ortak bölümü de dahil olmak üzere tüm silinen anahtarları listeleyin. Yalnızca geçici silmenin etkinleştirildiği bir kasada mümkündür.

Anahtarlar/liste izni gerektirir.

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

Döndürülenler

Silinen anahtarların yineleyicisi

Dönüş türü

Özel durumlar

anahtar yoksa,

diğer hatalar için

Bir anahtarın sürümlerinin tanımlayıcılarını ve özelliklerini listeleme.

Anahtarlar/liste izni gerektirir.

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

Parametreler

Döndürülenler

Şifreleme malzemeleri olmayan anahtarların yineleyicisi

Dönüş türü

Özel durumlar

anahtar yoksa,

diğer hatalar için

Kasadaki tüm anahtarların tanımlayıcılarını ve özelliklerini listeleyin.

Anahtarlar/liste izni gerektirir.

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

Döndürülenler

Şifreleme malzemeleri veya sürüm bilgileri olmayan anahtarların yineleyicisi

Dönüş türü

Özel durumlar

anahtar yoksa,

diğer hatalar için

Silinen bir anahtarı kalıcı olarak siler. Yalnızca geçici silmenin etkinleştirildiği bir kasada mümkündür.

Kurtarma olanağı olmadan belirtilen anahtarın geri alınamaz bir şekilde silinmesini gerçekleştirir. 'Temizlenebilir' belirtmiyorsa işlem kullanılamaz recovery_level . Bu yöntem yalnızca anahtarından scheduled_purge_dateönce temizlemek için gereklidir.

Anahtarlar/temizleme izni gerektirir.

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

Parametreler

Döndürülenler

Hiçbiri

Özel durumlar

Örnekler

   # 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")

Bir anahtar serbest bırakır.

Yayın anahtarı işlemi tüm anahtar türleri için geçerlidir. Hedef anahtar dışarı aktarılabilir olarak işaretlenmelidir. Bu işlem anahtarlar/sürüm izni gerektirir.

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

Parametreler

Döndürülenler

Anahtar sürümünün sonucu.

Dönüş türü

Özel durumlar

Anahtar yedeğini kasaya geri yükleyin.

Anahtarlar/geri yükleme izni gerektirir.

Bu, anahtarın adı, öznitelikleri ve erişim denetimi ilkeleriyle tüm sürümlerini içeri aktarır. Anahtarın adı zaten kullanılıyorsa, geri yükleme başarısız olur. Ayrıca hedef kasa, kaynak kasayla aynı Microsoft Azure aboneliğine ait olmalıdır.

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

Parametreler

Döndürülenler

Geri yüklenen anahtar

Dönüş türü

Özel durumlar

yedeklenen anahtarın adı zaten kullanılıyorsa,

diğer hatalar için

Anahtarın yeni bir sürümünü oluşturarak anahtarı anahtar ilkesine göre döndürün.

Bu işlem anahtarlar/döndürme izni gerektirir.

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

Parametreler

Döndürülenler

Döndürülen anahtarın yeni sürümü.

Dönüş türü

Özel durumlar

İstemcinin mevcut işlem hattını kullanarak bir ağ isteği çalıştırır.

İstek URL'si kasa URL'sine göre olabilir. İstek için kullanılan hizmet API'sinin sürümü, aksi belirtilmedikçe istemcinin sürümüyle aynıdır. Yanıt bir hataysa bu yöntem tetiklenmez; özel durum tetiklemek için döndürülen yanıt nesnesinde raise_for_status() öğesini çağırın. Bu yöntemle özel istek gönderme hakkında daha fazla bilgi için bkz https://aka.ms/azsdk/dpcodegen/python/send_request. .

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

Parametreler

Döndürülenler

Ağ çağrınızın yanıtı. Yanıtınızda hata işleme yapmaz.

Dönüş türü

Özel durumlar

anahtar yoksa,

diğer hatalar için

Anahtarın özelliklerini (şifreleme malzemesini değil) değiştirin.

Anahtarlar/güncelleştirme izni gerektirir.

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

Parametreler

Döndürülenler

Güncelleştirilmiş anahtar

Dönüş türü

Özel durumlar

anahtar yoksa,

diğer hatalar için

Key Vault anahtarının döndürme ilkesini Güncelleştirmeler.

Bu işlem için anahtarlar/güncelleştirme izni gerekir.

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

Parametreler

Döndürülenler

Güncelleştirilmiş döndürme ilkesi.

Dönüş türü

Özel durumlar