SecretClient Klasa
Interfejs wysokiego poziomu do zarządzania wpisami tajnymi magazynu.
- Dziedziczenie
-
azure.keyvault.secrets._shared.client_base.KeyVaultClientBaseSecretClient
Konstruktor
SecretClient(vault_url: str, credential: TokenCredential, **kwargs)
Parametry
- vault_url
- str
Adres URL magazynu, do którym będzie uzyskiwany dostęp klient. Jest to również nazywane "nazwą DNS magazynu". Należy sprawdzić, czy ten adres URL odwołuje się do prawidłowego zasobu Key Vault. Aby uzyskać szczegółowe informacje, zobacz opis funkcji https://aka.ms/azsdk/blog/vault-uri.
- credential
- TokenCredential
Obiekt, który może zapewnić token dostępu dla magazynu, taki jak poświadczenie z identity
- api_version
- ApiVersion
Wersja interfejsu API usługi do użycia. Wartość domyślna to najnowsze.
- verify_challenge_resource
- bool
Czy sprawdzić, czy zasób wyzwania uwierzytelniania jest zgodny z domeną Key Vault. Wartość domyślna to True.
Metody
backup_secret |
Utwórz kopię zapasową wpisu tajnego w chronionym formularzu, który jest używany tylko przez usługę Azure Key Vault. Wymaga uprawnień do tworzenia wpisów tajnych/tworzenia kopii zapasowych. |
begin_delete_secret |
Usuń wszystkie wersje wpisu tajnego. Wymaga uprawnień do wpisów tajnych/usuwania. Gdy ta metoda zwróci Key Vault zaczęła usuwać wpis tajny. Usunięcie może potrwać kilka sekund w magazynie z włączonym usuwaniem nietrwałym. W związku z tym ta metoda zwraca funkcję poller, która umożliwia oczekiwanie na zakończenie usuwania. |
begin_recover_deleted_secret |
Odzyskiwanie usuniętego wpisu tajnego do najnowszej wersji. Możliwe tylko w magazynie z włączonym usuwaniem nietrwałym. Wymaga uprawnień wpisów tajnych/odzyskiwania. Jeśli magazyn nie ma włączonego usuwania nietrwałego, begin_delete_secret jest trwały, a ta metoda zwróci błąd. Próba odzyskania nieskrytego wpisu tajnego spowoduje również zwrócenie błędu. Gdy ta metoda zwróci Key Vault rozpoczęła odzyskiwanie wpisu tajnego. Odzyskiwanie może potrwać kilka sekund. W związku z tym ta metoda zwraca funkcję poller umożliwiającą oczekiwanie na zakończenie odzyskiwania. Oczekiwanie jest konieczne tylko wtedy, gdy chcesz natychmiast użyć odzyskanego wpisu tajnego w innej operacji. |
close |
Zamknij gniazda otwarte przez klienta. Wywoływanie tej metody jest niepotrzebne podczas korzystania z klienta jako menedżera kontekstu. |
get_deleted_secret |
Pobieranie usuniętego wpisu tajnego. Możliwe tylko w magazynach z włączonym usuwaniem nietrwałym. Wymaga wpisów tajnych/uzyskiwania uprawnień. |
get_secret |
Uzyskiwanie wpisu tajnego. Wymaga uprawnień wpisów tajnych/uzyskiwania. |
list_deleted_secrets |
Wyświetla listę wszystkich usuniętych wpisów tajnych. Możliwe tylko w magazynach z włączonym usuwaniem nietrwałym. Wymaga uprawnień do wpisów tajnych/listy. |
list_properties_of_secret_versions |
Wyświetl listę właściwości wszystkich wersji wpisu tajnego, z wyłączeniem ich wartości. Wymaga uprawnień do wpisów tajnych/listy. Elementy listy nie zawierają wartości wpisów tajnych. Użyj get_secret polecenia , aby uzyskać wartość wpisu tajnego. |
list_properties_of_secrets |
Wyświetl listę identyfikatorów i atrybutów wszystkich wpisów tajnych w magazynie. Wymaga uprawnień do wpisów tajnych/listy. Elementy listy nie zawierają wartości wpisów tajnych. Użyj get_secret polecenia , aby uzyskać wartość wpisu tajnego. |
purge_deleted_secret |
Trwale usuwa usunięty wpis tajny. Możliwe tylko w magazynach z włączonym usuwaniem nietrwałym. Wykonuje nieodwracalne usunięcie określonego wpisu tajnego bez możliwości odzyskiwania. Operacja jest niedostępna, jeśli recovery_level parametr nie określa opcji "Przeczyszczalne". Ta metoda jest niezbędna tylko do przeczyszczania wpisu tajnego przed jego scheduled_purge_date. Wymaga uprawnień wpisów tajnych/przeczyszczania. |
restore_secret_backup |
Przywracanie kopii zapasowej wpisu tajnego. Wymaga uprawnień do wpisów tajnych/przywracania. |
send_request |
Uruchamia żądanie sieciowe przy użyciu istniejącego potoku klienta. Adres URL żądania może być powiązany z adresem URL magazynu. Wersja interfejsu API usługi używana dla żądania jest taka sama jak wersja klienta, chyba że określono inaczej. Ta metoda nie zgłasza się, jeśli odpowiedź jest błędem; aby zgłosić wyjątek, wywołaj metodę raise_for_status() dla zwróconego obiektu odpowiedzi. Aby uzyskać więcej informacji na temat wysyłania żądań niestandardowych za pomocą tej metody, zobacz https://aka.ms/azsdk/dpcodegen/python/send_request. |
set_secret |
Ustaw wartość wpisu tajnego. Jeśli nazwa jest używana, utwórz nową wersję wpisu tajnego. Jeśli nie, utwórz nowy wpis tajny. Wymaga uprawnień wpisów tajnych/zestawu. |
update_secret_properties |
Aktualizowanie właściwości wpisu tajnego innego niż jego wartość. Wymaga uprawnień wpisów tajnych/zestawu. Ta metoda aktualizuje właściwości wpisu tajnego, takie jak to, czy jest włączona, ale nie może zmienić wartości wpisu tajnego. Użyj polecenia set_secret , aby zmienić wartość wpisu tajnego. |
backup_secret
Utwórz kopię zapasową wpisu tajnego w chronionym formularzu, który jest używany tylko przez usługę Azure Key Vault. Wymaga uprawnień do tworzenia wpisów tajnych/tworzenia kopii zapasowych.
backup_secret(name: str, **kwargs) -> bytes
Parametry
Typ zwracany
Wyjątki
jeśli wpis tajny nie istnieje,
w przypadku innych błędów
begin_delete_secret
Usuń wszystkie wersje wpisu tajnego. Wymaga uprawnień do wpisów tajnych/usuwania.
Gdy ta metoda zwróci Key Vault zaczęła usuwać wpis tajny. Usunięcie może potrwać kilka sekund w magazynie z włączonym usuwaniem nietrwałym. W związku z tym ta metoda zwraca funkcję poller, która umożliwia oczekiwanie na zakończenie usuwania.
begin_delete_secret(name: str, **kwargs) -> LROPoller[DeletedSecret]
Parametry
Zwraca
Element poller dla operacji usuwania. Metoda wynikowa poller zwraca DeletedSecret wartość bez oczekiwania na zakończenie usuwania. Jeśli magazyn ma włączoną funkcję usuwania nietrwałego i chcesz trwale usunąć wpis tajny za pomocą polecenia purge_deleted_secret, najpierw wywołaj metodę oczekiwania narzędzia poller. Zostanie ona zablokowana do momentu ukończenia usunięcia. Metoda wait wymaga wpisów tajnych/uzyskania uprawnień.
Typ zwracany
Wyjątki
jeśli wpis tajny nie istnieje,
w przypadku innych błędów
begin_recover_deleted_secret
Odzyskiwanie usuniętego wpisu tajnego do najnowszej wersji. Możliwe tylko w magazynie z włączonym usuwaniem nietrwałym.
Wymaga uprawnień wpisów tajnych/odzyskiwania. Jeśli magazyn nie ma włączonego usuwania nietrwałego, begin_delete_secret jest trwały, a ta metoda zwróci błąd. Próba odzyskania nieskrytego wpisu tajnego spowoduje również zwrócenie błędu. Gdy ta metoda zwróci Key Vault rozpoczęła odzyskiwanie wpisu tajnego. Odzyskiwanie może potrwać kilka sekund. W związku z tym ta metoda zwraca funkcję poller umożliwiającą oczekiwanie na zakończenie odzyskiwania. Oczekiwanie jest konieczne tylko wtedy, gdy chcesz natychmiast użyć odzyskanego wpisu tajnego w innej operacji.
begin_recover_deleted_secret(name: str, **kwargs) -> LROPoller[SecretProperties]
Parametry
Zwraca
Poller dla operacji odzyskiwania. Metoda wynikowa narzędzia poller zwraca odzyskane wpisy tajne SecretProperties bez oczekiwania na zakończenie odzyskiwania. Jeśli chcesz natychmiast użyć odzyskanego wpisu tajnego, wywołaj metodę oczekiwania pollera, która blokuje, dopóki wpis tajny nie będzie gotowy do użycia. Metoda wait wymaga wpisów tajnych/uzyskania uprawnień.
Typ zwracany
Wyjątki
close
Zamknij gniazda otwarte przez klienta.
Wywoływanie tej metody jest niepotrzebne podczas korzystania z klienta jako menedżera kontekstu.
close() -> None
Wyjątki
jeśli wpis tajny nie istnieje,
w przypadku innych błędów
get_deleted_secret
Pobieranie usuniętego wpisu tajnego. Możliwe tylko w magazynach z włączonym usuwaniem nietrwałym. Wymaga wpisów tajnych/uzyskiwania uprawnień.
get_deleted_secret(name: str, **kwargs) -> DeletedSecret
Parametry
Typ zwracany
Wyjątki
jeśli usunięty wpis tajny nie istnieje,
w przypadku innych błędów
get_secret
Uzyskiwanie wpisu tajnego. Wymaga uprawnień wpisów tajnych/uzyskiwania.
get_secret(name: str, version: str | None = None, **kwargs) -> KeyVaultSecret
Parametry
- version
- str
(opcjonalnie) Wersja wpisu tajnego do pobrania. Jeśli nie zostanie określona, pobierze najnowszą wersję.
Typ zwracany
Wyjątki
jeśli wpis tajny nie istnieje,
w przypadku innych błędów
list_deleted_secrets
Wyświetla listę wszystkich usuniętych wpisów tajnych. Możliwe tylko w magazynach z włączonym usuwaniem nietrwałym.
Wymaga uprawnień do wpisów tajnych/listy.
list_deleted_secrets(**kwargs) -> ItemPaged[DeletedSecret]
Zwraca
Iterator usuniętych wpisów tajnych z wyłączeniem ich wartości
Typ zwracany
Wyjątki
jeśli wpis tajny nie istnieje,
w przypadku innych błędów
list_properties_of_secret_versions
Wyświetl listę właściwości wszystkich wersji wpisu tajnego, z wyłączeniem ich wartości. Wymaga uprawnień do wpisów tajnych/listy.
Elementy listy nie zawierają wartości wpisów tajnych. Użyj get_secret polecenia , aby uzyskać wartość wpisu tajnego.
list_properties_of_secret_versions(name: str, **kwargs) -> ItemPaged[SecretProperties]
Parametry
Zwraca
Iterator wpisów tajnych z wyłączeniem ich wartości
Typ zwracany
Wyjątki
jeśli wpis tajny nie istnieje,
w przypadku innych błędów
list_properties_of_secrets
Wyświetl listę identyfikatorów i atrybutów wszystkich wpisów tajnych w magazynie. Wymaga uprawnień do wpisów tajnych/listy.
Elementy listy nie zawierają wartości wpisów tajnych. Użyj get_secret polecenia , aby uzyskać wartość wpisu tajnego.
list_properties_of_secrets(**kwargs) -> ItemPaged[SecretProperties]
Zwraca
Iterator wpisów tajnych z wyłączeniem ich wartości
Typ zwracany
Wyjątki
jeśli wpis tajny nie istnieje,
w przypadku innych błędów
purge_deleted_secret
Trwale usuwa usunięty wpis tajny. Możliwe tylko w magazynach z włączonym usuwaniem nietrwałym.
Wykonuje nieodwracalne usunięcie określonego wpisu tajnego bez możliwości odzyskiwania. Operacja jest niedostępna, jeśli recovery_level parametr nie określa opcji "Przeczyszczalne". Ta metoda jest niezbędna tylko do przeczyszczania wpisu tajnego przed jego scheduled_purge_date.
Wymaga uprawnień wpisów tajnych/przeczyszczania.
purge_deleted_secret(name: str, **kwargs) -> None
Parametry
Zwraca
Brak
Wyjątki
Przykłady
# 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
Przywracanie kopii zapasowej wpisu tajnego. Wymaga uprawnień do wpisów tajnych/przywracania.
restore_secret_backup(backup: bytes, **kwargs) -> SecretProperties
Parametry
Zwraca
Przywrócony wpis tajny
Typ zwracany
Wyjątki
jeśli nazwa wpisu tajnego jest już używana,
w przypadku innych błędów
send_request
Uruchamia żądanie sieciowe przy użyciu istniejącego potoku klienta.
Adres URL żądania może być powiązany z adresem URL magazynu. Wersja interfejsu API usługi używana dla żądania jest taka sama jak wersja klienta, chyba że określono inaczej. Ta metoda nie zgłasza się, jeśli odpowiedź jest błędem; aby zgłosić wyjątek, wywołaj metodę raise_for_status() dla zwróconego obiektu odpowiedzi. Aby uzyskać więcej informacji na temat wysyłania żądań niestandardowych za pomocą tej metody, zobacz https://aka.ms/azsdk/dpcodegen/python/send_request.
send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse
Parametry
- stream
- bool
Czy ładunek odpowiedzi zostanie przesyłany strumieniowo. Wartość domyślna to False.
Zwraca
Odpowiedź połączenia sieciowego. Nie obsługuje błędów w odpowiedzi.
Typ zwracany
Wyjątki
jeśli wpis tajny nie istnieje,
w przypadku innych błędów
set_secret
Ustaw wartość wpisu tajnego. Jeśli nazwa jest używana, utwórz nową wersję wpisu tajnego. Jeśli nie, utwórz nowy wpis tajny.
Wymaga uprawnień wpisów tajnych/zestawu.
set_secret(name: str, value: str, **kwargs) -> KeyVaultSecret
Parametry
- enabled
- bool
Określa, czy wpis tajny jest włączony do użycia.
- content_type
- str
Dowolny ciąg wskazujący typ wpisu tajnego, np. "password"
- not_before
- datetime
Nie wcześniej niż data wpisu tajnego w formacie UTC
- expires_on
- datetime
Data wygaśnięcia wpisu tajnego w formacie UTC
Typ zwracany
Wyjątki
update_secret_properties
Aktualizowanie właściwości wpisu tajnego innego niż jego wartość. Wymaga uprawnień wpisów tajnych/zestawu.
Ta metoda aktualizuje właściwości wpisu tajnego, takie jak to, czy jest włączona, ale nie może zmienić wartości wpisu tajnego. Użyj polecenia set_secret , aby zmienić wartość wpisu tajnego.
update_secret_properties(name: str, version: str | None = None, **kwargs) -> SecretProperties
Parametry
- version
- str
(opcjonalnie) Wersja wpisu tajnego do zaktualizowania. Jeśli nie zostanie określona, najnowsza wersja zostanie zaktualizowana.
- enabled
- bool
Określa, czy wpis tajny jest włączony do użycia.
- content_type
- str
Dowolny ciąg wskazujący typ wpisu tajnego, np. "password"
- not_before
- datetime
Nie wcześniej niż data wpisu tajnego w formacie UTC
- expires_on
- datetime
Data wygaśnięcia wpisu tajnego w formacie UTC
Typ zwracany
Wyjątki
jeśli wpis tajny nie istnieje,
w przypadku innych błędów
Atrybuty
vault_url
Azure SDK for Python