SecretClient Sınıf
Kasanın gizli dizilerini yönetmek için üst düzey arabirim.
- Devralma
-
azure.keyvault.secrets._shared.client_base.KeyVaultClientBaseSecretClient
Oluşturucu
SecretClient(vault_url: str, credential: TokenCredential, **kwargs)
Parametreler
- vault_url
- str
İ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 kaynağına başvurduğunu doğrulamanız gerekir. Ayrıntılar için bkz. https://aka.ms/azsdk/blog/vault-uri.
- credential
- TokenCredential
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 etki alanıyla eşleşip eşleşmediğini doğrulama. Varsayılan değer True'dır.
Yöntemler
backup_secret |
Gizli diziyi yalnızca Azure Key Vault tarafından kullanılabilen korumalı bir biçimde yedekleyin. Gizli diziler/yedekleme izni gerektirir. |
begin_delete_secret |
Gizli dizinin tüm sürümlerini silin. Gizli diziler/silme izni gerektirir. Bu yöntem döndürdüğünde Key Vault gizli diziyi 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_secret |
Silinen gizli diziyi en son sürümüne kurtarma. Yalnızca geçici silmenin etkinleştirildiği bir kasada mümkündür. Gizli diziler/kurtarma izni gerektirir. Kasada geçici silme etkin değilse kalıcıdır begin_delete_secret ve bu yöntem hata döndürür. Silinmemiş bir gizli diziyi kurtarma girişimi de hata döndürür. Bu yöntem döndürdüğünde Key Vault gizli diziyi 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 gizli diziyi 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. |
get_deleted_secret |
Silinen gizli diziyi alın. Yalnızca geçici silme etkin kasalarda mümkündür. Gizli diziler/alma izni gerektirir. |
get_secret |
Bir sır alın. Gizli diziler/alma izni gerektirir. |
list_deleted_secrets |
Silinen tüm gizli dizileri listeler. Yalnızca geçici silme etkin kasalarda mümkündür. Gizli diziler/liste izni gerektirir. |
list_properties_of_secret_versions |
Değerlerini hariç tutarak bir gizli dizinin tüm sürümlerinin özelliklerini listeleyin. Gizli diziler/liste izni gerektirir. Liste öğeleri gizli dizi değerleri içermez. Gizli dizi değerini almak için kullanın get_secret . |
list_properties_of_secrets |
Kasadaki tüm gizli dizilerin tanımlayıcılarını ve özniteliklerini listeleyin. Gizli diziler/liste izni gerektirir. Liste öğeleri gizli dizi değerleri içermez. Gizli dizi değerini almak için kullanın get_secret . |
purge_deleted_secret |
Silinen gizli diziyi kalıcı olarak siler. Yalnızca geçici silme etkin kasalarda mümkündür. Kurtarma olasılığı olmadan belirtilen gizli diziyi geri alınamaz bir şekilde silme işlemi gerçekleştirir. 'Temizlenebilir' belirtmiyorsa işlem kullanılamaz recovery_level . Bu yöntem yalnızca önce bir gizli dizi scheduled_purge_datetemizlemek için gereklidir. Gizli diziler/temizleme izni gerektirir. |
restore_secret_backup |
Yedeklenen gizli diziyi geri yükleyin. Gizli diziler/geri yükleme 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. . |
set_secret |
Gizli dizi değeri ayarlayın. Ad kullanılıyorsa gizli dizinin yeni bir sürümünü oluşturun. Aksi takdirde yeni bir gizli dizi oluşturun. Gizli diziler/ayarlama izni gerektirir. |
update_secret_properties |
Bir gizli dizinin değeri dışındaki özelliklerini güncelleştirin. Gizli diziler/ayarlama izni gerektirir. Bu yöntem, gizli dizinin özelliklerini güncelleştirir, örneğin etkin olup olmadığı, ancak gizli dizinin değerini değiştiremeyeceği. Gizli dizinin değerini değiştirmek için kullanın set_secret . |
backup_secret
Gizli diziyi yalnızca Azure Key Vault tarafından kullanılabilen korumalı bir biçimde yedekleyin. Gizli diziler/yedekleme izni gerektirir.
backup_secret(name: str, **kwargs) -> bytes
Parametreler
Dönüş türü
Özel durumlar
gizli dizi yoksa,
diğer hatalar için
begin_delete_secret
Gizli dizinin tüm sürümlerini silin. Gizli diziler/silme izni gerektirir.
Bu yöntem döndürdüğünde Key Vault gizli diziyi 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_secret(name: str, **kwargs) -> LROPoller[DeletedSecret]
Parametreler
Döndürülenler
Silme işlemi için bir poller. Poller'ın sonuç yöntemi, silme işleminin tamamlanmasını beklemeden öğesini DeletedSecret döndürür. Kasada geçici silme etkinleştirildiyse ve ile purge_deleted_secretgizli diziyi kalıcı olarak silmek istiyorsanız, önce poller'ın bekleme yöntemini çağırın. Silme işlemi tamamlanana kadar engeller. Bekleme yöntemi gizli diziler/alma izni gerektirir.
Dönüş türü
Özel durumlar
gizli dizi yoksa,
diğer hatalar için
begin_recover_deleted_secret
Silinen gizli diziyi en son sürümüne kurtarma. Yalnızca geçici silmenin etkinleştirildiği bir kasada mümkündür.
Gizli diziler/kurtarma izni gerektirir. Kasada geçici silme etkin değilse kalıcıdır begin_delete_secret ve bu yöntem hata döndürür. Silinmemiş bir gizli diziyi kurtarma girişimi de hata döndürür. Bu yöntem döndürdüğünde Key Vault gizli diziyi 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 gizli diziyi hemen başka bir işlemde kullanmak istediğinizde gereklidir.
begin_recover_deleted_secret(name: str, **kwargs) -> LROPoller[SecretProperties]
Parametreler
Döndürülenler
Kurtarma işlemi için bir poller. Poller'ın sonuç yöntemi kurtarmanın tamamlanmasını beklemeden kurtarılan gizli dizileri SecretProperties döndürür. Kurtarılan gizli diziyi hemen kullanmak istiyorsanız, gizli dizi kullanıma hazır olana kadar engelleyen poller'ın bekleme yöntemini çağırın. Bekleme yöntemi gizli diziler/alma izni gerektirir.
Dönüş türü
Özel durumlar
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
gizli dizi yoksa,
diğer hatalar için
get_deleted_secret
Silinen gizli diziyi alın. Yalnızca geçici silme etkin kasalarda mümkündür. Gizli diziler/alma izni gerektirir.
get_deleted_secret(name: str, **kwargs) -> DeletedSecret
Parametreler
Dönüş türü
Özel durumlar
silinen gizli dizi yoksa,
diğer hatalar için
get_secret
Bir sır alın. Gizli diziler/alma izni gerektirir.
get_secret(name: str, version: str | None = None, **kwargs) -> KeyVaultSecret
Parametreler
- version
- str
(isteğe bağlı) Elde etmek için gizli dizi sürümü. Belirtilmemişse en son sürümü alır.
Dönüş türü
Özel durumlar
gizli dizi yoksa,
diğer hatalar için
list_deleted_secrets
Silinen tüm gizli dizileri listeler. Yalnızca geçici silme etkin kasalarda mümkündür.
Gizli diziler/liste izni gerektirir.
list_deleted_secrets(**kwargs) -> ItemPaged[DeletedSecret]
Döndürülenler
Silinen gizli dizilerin değerlerini hariç tutarak yineleyicisi
Dönüş türü
Özel durumlar
gizli dizi yoksa,
diğer hatalar için
list_properties_of_secret_versions
Değerlerini hariç tutarak bir gizli dizinin tüm sürümlerinin özelliklerini listeleyin. Gizli diziler/liste izni gerektirir.
Liste öğeleri gizli dizi değerleri içermez. Gizli dizi değerini almak için kullanın get_secret .
list_properties_of_secret_versions(name: str, **kwargs) -> ItemPaged[SecretProperties]
Parametreler
Döndürülenler
Gizli dizilerin değerlerini dışlayan bir yineleyici
Dönüş türü
Özel durumlar
gizli dizi yoksa,
diğer hatalar için
list_properties_of_secrets
Kasadaki tüm gizli dizilerin tanımlayıcılarını ve özniteliklerini listeleyin. Gizli diziler/liste izni gerektirir.
Liste öğeleri gizli dizi değerleri içermez. Gizli dizi değerini almak için kullanın get_secret .
list_properties_of_secrets(**kwargs) -> ItemPaged[SecretProperties]
Döndürülenler
Gizli dizilerin değerlerini dışlayan bir yineleyici
Dönüş türü
Özel durumlar
gizli dizi yoksa,
diğer hatalar için
purge_deleted_secret
Silinen gizli diziyi kalıcı olarak siler. Yalnızca geçici silme etkin kasalarda mümkündür.
Kurtarma olasılığı olmadan belirtilen gizli diziyi geri alınamaz bir şekilde silme işlemi gerçekleştirir. 'Temizlenebilir' belirtmiyorsa işlem kullanılamaz recovery_level . Bu yöntem yalnızca önce bir gizli dizi scheduled_purge_datetemizlemek için gereklidir.
Gizli diziler/temizleme izni gerektirir.
purge_deleted_secret(name: str, **kwargs) -> None
Parametreler
Döndürülenler
Hiçbiri
Özel durumlar
Örnekler
# if the vault has soft-delete enabled, purge permanently deletes the secret
# (with soft-delete disabled, begin_delete_secret is permanent)
secret_client.purge_deleted_secret("secret-name")
restore_secret_backup
Yedeklenen gizli diziyi geri yükleyin. Gizli diziler/geri yükleme izni gerektirir.
restore_secret_backup(backup: bytes, **kwargs) -> SecretProperties
Parametreler
Döndürülenler
Geri yüklenen gizli dizi
Dönüş türü
Özel durumlar
gizli dizinin adı zaten kullanılıyorsa,
diğer hatalar için
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
- 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ü
Özel durumlar
gizli dizi yoksa,
diğer hatalar için
set_secret
Gizli dizi değeri ayarlayın. Ad kullanılıyorsa gizli dizinin yeni bir sürümünü oluşturun. Aksi takdirde yeni bir gizli dizi oluşturun.
Gizli diziler/ayarlama izni gerektirir.
set_secret(name: str, value: str, **kwargs) -> KeyVaultSecret
Parametreler
- enabled
- bool
Gizli dizinin kullanım için etkinleştirilip etkinleştirilmediği.
- content_type
- str
Gizli dizinin türünü belirten rastgele bir dize, örneğin 'parola'
- not_before
- datetime
UTC'de gizli dizi tarihinden önce değil
- expires_on
- datetime
Utc olarak gizli anahtarın bitiş tarihi
Dönüş türü
Özel durumlar
update_secret_properties
Bir gizli dizinin değeri dışındaki özelliklerini güncelleştirin. Gizli diziler/ayarlama izni gerektirir.
Bu yöntem, gizli dizinin özelliklerini güncelleştirir, örneğin etkin olup olmadığı, ancak gizli dizinin değerini değiştiremeyeceği. Gizli dizinin değerini değiştirmek için kullanın set_secret .
update_secret_properties(name: str, version: str | None = None, **kwargs) -> SecretProperties
Parametreler
- version
- str
(isteğe bağlı) Güncelleştirilecek gizli dizi sürümü. Belirtilmemişse en son sürüm güncelleştirilir.
- enabled
- bool
Gizli dizinin kullanım için etkinleştirilip etkinleştirilmediği.
- content_type
- str
Gizli dizinin türünü belirten rastgele bir dize, örneğin 'parola'
- not_before
- datetime
UTC'de gizli dizi tarihinden önce değil
- expires_on
- datetime
Utc olarak gizli anahtarın bitiş tarihi
Dönüş türü
Özel durumlar
gizli dizi yoksa,
diğer hatalar için
Öznitelikler
vault_url
Azure SDK for Python