KeyClient Sınıf

Başvuru

Kasanın anahtarlarını yönetmek için üst düzey arabirim.

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

KeyClient

Oluşturucu

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

Parametreler

vault_url: str

Gerekli

İstemcinin erişeceği kasanın URL'si. Bu, kasanın "DNS Adı" olarak da adlandırılır. Bu URL'nin geçerli bir Key Vault veya Yönetilen HSM kaynağına başvurduğunu doğrulamanız gerekir. Ayrıntılar için bkz. https://aka.ms/azsdk/blog/vault-uri.

credential: TokenCredential

Gerekli

Kasa için erişim belirteci sağlayabilen bir nesne, örneğin identity

api_version: ApiVersion

Kullanılacak hizmet API'sinin sürümü. Varsayılan olarak en son değeri kullanır.

verify_challenge_resource: bool

Kimlik doğrulama sınaması kaynağının Key Vault veya Yönetilen HSM etki alanıyla eşleşip eşleşmediğini doğrulama. Varsayılan değer True'dır.

Yöntemler

backup_key	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.
begin_delete_key	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_recover_deleted_key	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.
close	İstemci tarafından açılan yuvaları kapatın. İstemciyi bağlam yöneticisi olarak kullanırken bu yöntemi çağırmak gereksizdir.
create_ec_key	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_key	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_oct_key	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_rsa_key	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.
get_cryptography_client	Verilen anahtar için bir CryptographyClient alır.
get_deleted_key	Silinen bir anahtarı alın. Yalnızca geçici silmenin etkinleştirildiği bir kasada mümkündür. Anahtarlar/alma izni gerektirir.
get_key	Anahtarın özniteliklerini ve asimetrik anahtarsa ortak malzemesini alın. Anahtarlar/alma izni gerektirir.
get_key_rotation_policy	Key Vault anahtarının döndürme ilkesini alın.
get_random_bytes	Yönetilen bir HSM'den istenen rastgele bayt sayısını alın.
import_key	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.
list_deleted_keys	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_properties_of_key_versions	Bir anahtarın sürümlerinin tanımlayıcılarını ve özelliklerini listeleme. Anahtarlar/liste izni gerektirir.
list_properties_of_keys	Kasadaki tüm anahtarların tanımlayıcılarını ve özelliklerini listeleyin. Anahtarlar/liste izni gerektirir.
purge_deleted_key	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.
release_key	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.
restore_key_backup	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.
rotate_key	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.
send_request	İ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. .
update_key_properties	Anahtarın özelliklerini (şifreleme malzemesini değil) değiştirin. Anahtarlar/güncelleştirme izni gerektirir.
update_key_rotation_policy	Key Vault anahtarının döndürme ilkesini Güncelleştirmeler. Bu işlem için anahtarlar/güncelleştirme izni gerekir.

backup_key

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

name: str

Gerekli

Yedeklene anahtarın adı

Dönüş türü

bytes

Özel durumlar

ResourceNotFoundError

anahtar yoksa,

HttpResponseError

diğer hatalar için

begin_delete_key

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

name: str

Gerekli

Silinecek anahtarın adı.

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ü

LROPoller[DeletedKey]

Özel durumlar

ResourceNotFoundError

anahtar yoksa,

HttpResponseError

diğer hatalar için

begin_recover_deleted_key

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

name: str

Gerekli

Kurtarılması gereken silinen anahtarın adı

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ü

LROPoller[KeyVaultKey]

Özel durumlar

HttpResponseError

close

İ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

ResourceNotFoundError

anahtar yoksa,

HttpResponseError

diğer hatalar için

create_ec_key

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

name: str

Gerekli

Yeni anahtarın adı.

curve: KeyCurveName veya str veya None

Elips eğrisi adı. NiST P-256 üç nokta eğrisi varsayılan olarak ayarlanır.

key_operations: list[KeyOperation veya str] veya None

İzin verilen anahtar işlemleri

hardware_protected: bool veya None

Anahtarın bir donanım güvenlik modülünde oluşturulup oluşturulmayacağı. varsayılan olarak Falseayarlanır.

enabled: bool veya None

Anahtarın kullanım için etkinleştirilip etkinleştirilmediği.

tags: dict[str, str] veya None

Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler.

not_before: datetime veya None

UTC'de anahtarın tarihinden önce değil

expires_on: datetime veya None

Anahtarın UTC olarak bitiş tarihi

exportable: bool veya None

Özel anahtarın dışarı aktarılıp aktarılamayacağı.

release_policy: KeyReleasePolicy veya None

Anahtarın altında dışarı aktarılabildiği ilke kuralları.

Döndürülenler

Oluşturulan anahtar

Dönüş türü

KeyVaultKey

Özel durumlar

HttpResponseError

create_key

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

name: str

Gerekli

Yeni anahtarın adı.

key_type: KeyType veya str

Gerekli

Oluşturulacak anahtarın türü

size: int veya None

Bit cinsinden anahtar boyutu. Yalnızca RSA ve simetrik anahtarlar için geçerlidir. Bunun yerine veya create_oct_key kullanmayı create_rsa_key göz önünde bulundurun.

curve: KeyCurveName veya str veya None

Elips eğrisi adı. Yalnızca üç nokta eğrisi anahtarları için geçerlidir. NiST P-256 üç nokta eğrisi varsayılan olarak ayarlanır. Üç nokta eğrisi anahtarı oluşturmak için bunun yerine kullanmayı create_ec_key göz önünde bulundurun.

public_exponent: int veya None

Kullanılacak RSA genel üssü. Yalnızca Yönetilen HSM'de oluşturulan RSA anahtarları için geçerlidir.

key_operations: list[KeyOperation veya str] veya None

İzin verilen anahtar işlemleri

enabled: bool veya None

Anahtarın kullanım için etkinleştirilip etkinleştirilmediği.

tags: dict[str, str] veya None

Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler.

not_before: datetime veya None

UTC'de anahtarın tarihinden önce değil

expires_on: datetime veya None

Anahtarın UTC olarak bitiş tarihi

exportable: bool veya None

Özel anahtarın dışarı aktarılıp aktarılamayacağı.

release_policy: KeyReleasePolicy veya None

Anahtarın altında dışarı aktarılabildiği ilke kuralları.

Döndürülenler

Oluşturulan anahtar

Dönüş türü

KeyVaultKey

Özel durumlar

HttpResponseError

create_oct_key

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

name: str

Gerekli

Yeni anahtarın adı.

size: int veya None

Bit cinsinden anahtar boyutu, örneğin 128, 192 veya 256.

key_operations: list[KeyOperation veya str] veya None

İzin verilen anahtar işlemleri.

hardware_protected: bool veya None

Anahtarın bir donanım güvenlik modülünde oluşturulup oluşturulmayacağı. varsayılan olarak Falseayarlanır.

enabled: bool veya None

Anahtarın kullanım için etkinleştirilip etkinleştirilmediği.

tags: dict[str, str] veya None

Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler.

not_before: datetime veya None

UTC'de anahtarın tarihinden önce değil

expires_on: datetime veya None

Anahtarın UTC olarak bitiş tarihi

exportable: bool veya None

Anahtarın dışarı aktarılıp aktarılamayacağı.

release_policy: KeyReleasePolicy veya None

Anahtarın altında dışarı aktarılabildiği ilke kuralları.

Döndürülenler

Oluşturulan anahtar

Dönüş türü

KeyVaultKey

Özel durumlar

HttpResponseError

create_rsa_key

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

name: str

Gerekli

Yeni anahtarın adı.

size: int veya None

Bit cinsinden anahtar boyutu, örneğin 2048, 3072 veya 4096.

public_exponent: int veya None

Kullanılacak RSA genel üssü. Yalnızca Yönetilen HSM'de oluşturulan RSA anahtarları için geçerlidir.

hardware_protected: bool veya None

Anahtarın bir donanım güvenlik modülünde oluşturulup oluşturulmayacağı. varsayılan olarak Falseayarlanır.

key_operations: list[KeyOperation veya str] veya None

İzin verilen anahtar işlemleri

enabled: bool veya None

Anahtarın kullanım için etkinleştirilip etkinleştirilmediği.

tags: dict[str, str] veya None

Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler.

not_before: datetime veya None

UTC'de anahtarın tarihinden önce değil

expires_on: datetime veya None

Anahtarın UTC olarak bitiş tarihi

exportable: bool veya None

Özel anahtarın dışarı aktarılıp aktarılamayacağı.

release_policy: KeyReleasePolicy veya None

Anahtarın altında dışarı aktarılabildiği ilke kuralları.

Döndürülenler

Oluşturulan anahtar

Dönüş türü

KeyVaultKey

Özel durumlar

HttpResponseError

get_cryptography_client

Verilen anahtar için bir CryptographyClient alır.

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

Parametreler

key_name: str

Gerekli

Şifreleme işlemlerini gerçekleştirmek için kullanılan anahtarın adı.

key_version: str

Şifreleme işlemlerini gerçekleştirmek için kullanılan anahtarın isteğe bağlı sürümü.

Döndürülenler

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

Dönüş türü

CryptographyClient

Özel durumlar

ResourceNotFoundError

anahtar yoksa,

HttpResponseError

diğer hatalar için

get_deleted_key

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

name: str

Gerekli

Anahtarın adı

Döndürülenler

Silinen anahtar

Dönüş türü

DeletedKey

Özel durumlar

ResourceNotFoundError

anahtar yoksa,

HttpResponseError

diğer hatalar için

get_key

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

name: str

Gerekli

Alınacak anahtarın adı.

version: str veya None

Gerekli

(isteğe bağlı) Alınacak anahtarın belirli bir sürümü. Belirtilmezse anahtarın en son sürümünü alır.

Dönüş türü

KeyVaultKey

Özel durumlar

ResourceNotFoundError

anahtar yoksa,

HttpResponseError

diğer hatalar için

get_key_rotation_policy

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

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

Parametreler

key_name: str

Gerekli

Anahtarın adı.

Döndürülenler

Anahtar döndürme ilkesi.

Dönüş türü

KeyRotationPolicy

Özel durumlar

*azure.core.exceptions.HttpResponseError*

get_random_bytes

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

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

Parametreler

count: int

Gerekli

İstenen rastgele bayt sayısı.

Döndürülenler

Rastgele bayt.

Dönüş türü

bytes

Özel durumlar

ValueError

birden az rastgele bayt istenirse,

HttpResponseError

diğer hatalar için

import_key

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

name: str

Gerekli

İçeri aktarılan anahtarın adı

key: JsonWebKey

Gerekli

İçeri aktaracak JSON web anahtarı

hardware_protected: bool veya None

Anahtarın bir donanım güvenlik modülü tarafından yedeklenip yedeklenmeyeceği

enabled: bool veya None

Anahtarın kullanım için etkinleştirilip etkinleştirilmediği.

tags: dict[str, str] veya None

Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler.

not_before: datetime veya None

UTC'de anahtarın tarihinden önce değil

expires_on: datetime veya None

Anahtarın UTC olarak bitiş tarihi

exportable: bool veya None

Özel anahtarın dışarı aktarılıp aktarılamayacağı.

release_policy: KeyReleasePolicy veya None

Anahtarın altında dışarı aktarılabildiği ilke kuralları.

Döndürülenler

İçeri aktarılan anahtar

Dönüş türü

KeyVaultKey

Özel durumlar

HttpResponseError

list_deleted_keys

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ü

ItemPaged[DeletedKey]

Özel durumlar

ResourceNotFoundError

anahtar yoksa,

HttpResponseError

diğer hatalar için

list_properties_of_key_versions

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

name: str

Gerekli

Anahtarın adı

Döndürülenler

Şifreleme malzemeleri olmayan anahtarların yineleyicisi

Dönüş türü

ItemPaged[KeyProperties]

Özel durumlar

ResourceNotFoundError

anahtar yoksa,

HttpResponseError

diğer hatalar için

list_properties_of_keys

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ü

ItemPaged[KeyProperties]

Özel durumlar

ResourceNotFoundError

anahtar yoksa,

HttpResponseError

diğer hatalar için

purge_deleted_key

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

name: str

Gerekli

Temizlenirken silinen anahtarın adı

Döndürülenler

Hiçbiri

Özel durumlar

HttpResponseError

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

release_key

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

name: str

Gerekli

Alınacak anahtarın adı.

target_attestation_token: str

Gerekli

Anahtar sürümünün hedefi için kanıtlama onayı.

version: str veya None

Yayınlanması gereken anahtarın belirli bir sürümü. Belirtilmemişse en son sürüm yayınlanır.

algorithm: str veya KeyExportEncryptionAlgorithm veya None

Yayımlanan anahtar malzemeyi korumak için kullanılacak şifreleme algoritması.

nonce: str veya None

Tazelik için istemci tarafından sağlanan bir nonce.

Döndürülenler

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

Dönüş türü

ReleaseKeyResult

Özel durumlar

HttpResponseError

restore_key_backup

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

backup: bytes

Gerekli

Tarafından döndürülen anahtar yedeklemesi backup_key

Döndürülenler

Geri yüklenen anahtar

Dönüş türü

KeyVaultKey

Özel durumlar

ResourceExistsError

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

HttpResponseError

diğer hatalar için

rotate_key

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

name: str

Gerekli

Döndürülecek anahtarın adı.

Döndürülenler

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

Dönüş türü

KeyVaultKey

Özel durumlar

HttpResponseError

send_request

İ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

request: HttpRequest

Gerekli

Yapmak istediğiniz ağ isteği.

stream: bool

Yanıt yükünün akışla aktarılıp aktarılmayacağı. Varsayılan değer False'tur.

Döndürülenler

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

Dönüş türü

HttpResponse

Özel durumlar

ResourceNotFoundError

anahtar yoksa,

HttpResponseError

diğer hatalar için

update_key_properties

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

name: str

Gerekli

Güncelleştirilecek anahtarın adı

version: str veya None

Gerekli

(isteğe bağlı) Güncelleştirilecek anahtarın sürümü. Belirtilmemişse en son sürüm güncelleştirilir.

key_operations: list[KeyOperation veya str] veya None

İzin verilen anahtar işlemleri

enabled: bool veya None

Anahtarın kullanım için etkinleştirilip etkinleştirilmediği.

tags: dict[str, str] veya None

Anahtar-değer çiftleri biçiminde uygulamaya özgü meta veriler.

not_before: datetime veya None

UTC'de anahtarın tarihinden önce değil

expires_on: datetime veya None

Anahtarın UTC olarak bitiş tarihi

release_policy: KeyReleasePolicy veya None

Anahtarın altında dışarı aktarılabildiği ilke kuralları.

Döndürülenler

Güncelleştirilmiş anahtar

Dönüş türü

KeyVaultKey

Özel durumlar

ResourceNotFoundError

anahtar yoksa,

HttpResponseError

diğer hatalar için

update_key_rotation_policy

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

key_name: str

Gerekli

Verilen kasadaki anahtarın adı.

policy: KeyRotationPolicy

Gerekli

Anahtarın yeni döndürme ilkesi.

lifetime_actions: list[KeyRotationLifetimeAction]

Bir anahtarın ömrü boyunca Key Vault tarafından gerçekleştirilecek eylemler. Bu, sağlanan policyöğesinin yaşam süresi eylemlerini geçersiz kılar.

expires_in: str

İlkenin iso 8601 süresi olarak tanımlanan yeni anahtar sürümlerine uygulanacak süre sonu süresi. Örneğin: 90 gün "P90D", 3 ay "P3M" ve 48 saat "PT48H" olur. ISO 8601 süreleri hakkında daha fazla bilgi için Wikipedia'ya bakın. Bu, sağlanan policyöğesinin süre sonu süresini geçersiz kılar.