SecretClient Třída

Rozhraní vysoké úrovně pro správu tajných kódů trezoru.

Dědičnost

azure.keyvault.secrets._shared.client_base.KeyVaultClientBase

SecretClient

Konstruktor

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

Parametry

vault_url

str

Vyžadováno

Adresa URL trezoru, ke které bude klient přistupovat. Tento název se označuje také jako "název DNS" trezoru. Měli byste ověřit, že tato adresa URL odkazuje na platný prostředek Key Vault. Podrobnosti viz https://aka.ms/azsdk/blog/vault-uri.

credential

TokenCredential

Vyžadováno

Objekt, který může poskytnout přístupový token pro trezor, například přihlašovací údaje z identity

api_version

ApiVersion

Verze rozhraní API služby, která se má použít. Výchozí hodnota je nejnovější.

verify_challenge_resource

bool

Jestli se má ověřit, jestli prostředek výzvy ověřování odpovídá doméně Key Vault. Výchozí hodnota je Pravda.

Metody

backup_secret	Zálohujte tajný kód v chráněné podobě, který lze použít jenom v Azure Key Vault. Vyžaduje oprávnění k tajným kódům nebo zálohování.
begin_delete_secret	Odstraňte všechny verze tajného kódu. Vyžaduje oprávnění k odstranění nebo tajné kódy. Když tato metoda vrátí Key Vault začal odstraňovat tajný klíč. Odstranění může v trezoru s povoleným obnovitelné odstraněním trvat několik sekund. Tato metoda proto vrátí poller, který vám umožní počkat na dokončení odstranění.
begin_recover_deleted_secret	Obnovení odstraněného tajného kódu do nejnovější verze Možné pouze v trezoru s povoleným obnovitelném odstraněním. Vyžaduje oprávnění k obnovení nebo tajné kódy. Pokud trezor nemá povolené obnovitelné odstranění, begin_delete_secret je trvalý a tato metoda vrátí chybu. Při pokusu o obnovení neodstraněný tajný klíč se také vrátí chyba. Když tato metoda vrátí Key Vault začal obnovovat tajný klíč. Obnovení může trvat několik sekund. Tato metoda proto vrátí poller, který vám umožní počkat na dokončení obnovení. Čekání je nutné pouze v případě, že chcete obnovený tajný klíč okamžitě použít v jiné operaci.
close	Zavřete sokety otevřené klientem. Volání této metody není nutné při použití klienta jako správce kontextu.
get_deleted_secret	Získejte odstraněný tajný kód. Možné pouze v trezorech s povoleným obnovitelném odstraněním. Vyžaduje tajné kódy nebo získat oprávnění.
get_secret	Získejte tajný kód. Vyžaduje tajné kódy nebo oprávnění získat.
list_deleted_secrets	Zobrazí seznam všech odstraněných tajných kódů. Možné pouze v trezorech s povoleným obnovitelném odstraněním. Vyžaduje oprávnění k tajným kódům nebo seznamům.
list_properties_of_secret_versions	Vypíše vlastnosti všech verzí tajného kódu s výjimkou jejich hodnot. Vyžaduje oprávnění k tajným kódům nebo seznamům. Položky seznamu neobsahují tajné hodnoty. Slouží get_secret k získání hodnoty tajného kódu.
list_properties_of_secrets	Vypíše identifikátory a atributy všech tajných kódů v trezoru. Vyžaduje oprávnění k tajným kódům nebo seznamům. Položky seznamu neobsahují tajné hodnoty. Slouží get_secret k získání hodnoty tajného kódu.
purge_deleted_secret	Trvale odstraní odstraněný tajný kód. Možné pouze v trezorech s povoleným obnovitelném odstraněním. Provede nevratné odstranění zadaného tajného klíče bez možnosti obnovení. Operace není k dispozici, pokud parametr recovery_level nezadá možnost Vymazat. Tato metoda je nezbytná pouze pro vymazání tajného kódu před jeho scheduled_purge_date. Vyžaduje oprávnění k vyprázdnění nebo tajné kódy.
restore_secret_backup	Obnovení zálohovaného tajného kódu Vyžaduje oprávnění k obnovení nebo tajné kódy.
send_request	Spustí síťový požadavek pomocí existujícího kanálu klienta. Adresa URL požadavku může být relativní vzhledem k adrese URL trezoru. Pokud není uvedeno jinak, verze rozhraní API služby použitá pro požadavek je stejná jako verze rozhraní API klienta. Tato metoda nevyvolá, pokud odpověď je chyba; pokud chcete vyvolat výjimku, zavolejte raise_for_status() u vráceného objektu odpovědi. Další informace o odesílání vlastních požadavků pomocí této metody najdete v tématu https://aka.ms/azsdk/dpcodegen/python/send_request.
set_secret	Nastavte hodnotu tajného kódu. Pokud se název používá, vytvořte novou verzi tajného kódu. Pokud ne, vytvořte nový tajný kód. Vyžaduje oprávnění k tajným kódům nebo nastavením.
update_secret_properties	Aktualizujte vlastnosti tajného kódu jiné než jeho hodnota. Vyžaduje oprávnění k tajným kódům nebo nastavením. Tato metoda aktualizuje vlastnosti tajného kódu, například jestli je povolený, ale nemůže změnit jeho hodnotu. Slouží set_secret ke změně hodnoty tajného kódu.

backup_secret

Zálohujte tajný kód v chráněné podobě, který lze použít jenom v Azure Key Vault. Vyžaduje oprávnění k tajným kódům nebo zálohování.

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

Parametry

name

str

Vyžadováno

Název tajného klíče, který se má zálohovat

Návratový typ

bytes

Výjimky

ResourceNotFoundError

pokud tajný kód neexistuje,

HttpResponseError

pro jiné chyby

begin_delete_secret

Odstraňte všechny verze tajného kódu. Vyžaduje oprávnění k odstranění nebo tajné kódy.

Když tato metoda vrátí Key Vault začal odstraňovat tajný klíč. Odstranění může v trezoru s povoleným obnovitelné odstraněním trvat několik sekund. Tato metoda proto vrátí poller, který vám umožní počkat na dokončení odstranění.

begin_delete_secret(name: str, **kwargs) -> LROPoller[DeletedSecret]

Parametry

name

str

Vyžadováno

Název tajného kódu, který chcete odstranit.

Návraty

Poller pro operaci odstranění. Metoda DeletedSecretvýsledku poller vrátí hodnotu bez čekání na dokončení odstranění. Pokud je v trezoru povolené obnovitelné odstranění a chcete trvale odstranit tajný kód pomocí purge_deleted_secretpříkazu , nejprve zavolejte metodu čekání pollera. Bude se blokovat, dokud se odstranění dokončí. Metoda wait vyžaduje tajné kódy nebo získat oprávnění.

Návratový typ

LROPoller[DeletedSecret]

Výjimky

ResourceNotFoundError

pokud tajný kód neexistuje,

HttpResponseError

pro jiné chyby

begin_recover_deleted_secret

Obnovení odstraněného tajného kódu do nejnovější verze Možné pouze v trezoru s povoleným obnovitelném odstraněním.

Vyžaduje oprávnění k obnovení nebo tajné kódy. Pokud trezor nemá povolené obnovitelné odstranění, begin_delete_secret je trvalý a tato metoda vrátí chybu. Při pokusu o obnovení neodstraněný tajný klíč se také vrátí chyba. Když tato metoda vrátí Key Vault začal obnovovat tajný klíč. Obnovení může trvat několik sekund. Tato metoda proto vrátí poller, který vám umožní počkat na dokončení obnovení. Čekání je nutné pouze v případě, že chcete obnovený tajný klíč okamžitě použít v jiné operaci.

begin_recover_deleted_secret(name: str, **kwargs) -> LROPoller[SecretProperties]

Parametry

name

str

Vyžadováno

Název odstraněného tajného kódu, který se má obnovit

Návraty

Poller pro operaci obnovení. Metoda výsledku poller vrátí obnovený tajný klíč SecretProperties bez čekání na dokončení obnovení. Pokud chcete obnovit tajný kód okamžitě, zavolejte metodu čekání pollera, která blokuje, dokud nebude tajný klíč připravený k použití. Metoda wait vyžaduje tajné kódy nebo získat oprávnění.

Návratový typ

LROPoller[SecretProperties]

Výjimky

HttpResponseError

close

Zavřete sokety otevřené klientem.

Volání této metody není nutné při použití klienta jako správce kontextu.

close() -> None

Výjimky

ResourceNotFoundError

pokud tajný kód neexistuje,

HttpResponseError

pro jiné chyby

get_deleted_secret

Získejte odstraněný tajný kód. Možné pouze v trezorech s povoleným obnovitelném odstraněním. Vyžaduje tajné kódy nebo získat oprávnění.

get_deleted_secret(name: str, **kwargs) -> DeletedSecret

Parametry

name

str

Vyžadováno

Název odstraněného tajného kódu

Návratový typ

DeletedSecret

Výjimky

ResourceNotFoundError

pokud odstraněný tajný kód neexistuje,

HttpResponseError

pro jiné chyby

get_secret

Získejte tajný kód. Vyžaduje tajné kódy nebo oprávnění získat.

get_secret(name: str, version: str | None = None, **kwargs) -> KeyVaultSecret

Parametry

name

str

Vyžadováno

Název tajného kódu

version

str

Vyžadováno

(volitelné) Verze tajného kódu, který chcete získat. Pokud není zadáno, získá nejnovější verzi.

Návratový typ

KeyVaultSecret

Výjimky

ResourceNotFoundError

pokud tajný kód neexistuje,

HttpResponseError

pro jiné chyby

list_deleted_secrets

Zobrazí seznam všech odstraněných tajných kódů. Možné pouze v trezorech s povoleným obnovitelném odstraněním.

Vyžaduje oprávnění k tajným kódům nebo seznamům.

list_deleted_secrets(**kwargs) -> ItemPaged[DeletedSecret]

Návraty

Iterátor odstraněných tajných kódů s výjimkou jejich hodnot

Návratový typ

ItemPaged[DeletedSecret]

Výjimky

ResourceNotFoundError

pokud tajný kód neexistuje,

HttpResponseError

pro jiné chyby

list_properties_of_secret_versions

Vypíše vlastnosti všech verzí tajného kódu s výjimkou jejich hodnot. Vyžaduje oprávnění k tajným kódům nebo seznamům.

Položky seznamu neobsahují tajné hodnoty. Slouží get_secret k získání hodnoty tajného kódu.

list_properties_of_secret_versions(name: str, **kwargs) -> ItemPaged[SecretProperties]

Parametry

name

str

Vyžadováno

Název tajného kódu

Návraty

Iterátor tajných kódů s výjimkou jejich hodnot

Návratový typ

ItemPaged[SecretProperties]

Výjimky

ResourceNotFoundError

pokud tajný kód neexistuje,

HttpResponseError

pro jiné chyby

list_properties_of_secrets

Vypíše identifikátory a atributy všech tajných kódů v trezoru. Vyžaduje oprávnění k tajným kódům nebo seznamům.

Položky seznamu neobsahují tajné hodnoty. Slouží get_secret k získání hodnoty tajného kódu.

list_properties_of_secrets(**kwargs) -> ItemPaged[SecretProperties]

Návraty

Iterátor tajných kódů s výjimkou jejich hodnot

Návratový typ

ItemPaged[SecretProperties]

Výjimky

ResourceNotFoundError

pokud tajný kód neexistuje,

HttpResponseError

pro jiné chyby

purge_deleted_secret

Trvale odstraní odstraněný tajný kód. Možné pouze v trezorech s povoleným obnovitelném odstraněním.

Provede nevratné odstranění zadaného tajného klíče bez možnosti obnovení. Operace není k dispozici, pokud parametr recovery_level nezadá možnost Vymazat. Tato metoda je nezbytná pouze pro vymazání tajného kódu před jeho scheduled_purge_date.

Vyžaduje oprávnění k vyprázdnění nebo tajné kódy.

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

Parametry

name

str

Vyžadováno

Název odstraněného tajného kódu, který se má vyprázdnit

Návraty

Žádné

Výjimky

HttpResponseError

Příklady

   # 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

Obnovení zálohovaného tajného kódu Vyžaduje oprávnění k obnovení nebo tajné kódy.

restore_secret_backup(backup: bytes, **kwargs) -> SecretProperties

Parametry

backup

bytes

Vyžadováno

Záloha tajného kódu vrácená uživatelem backup_secret

Návraty

Obnovený tajný kód

Návratový typ

SecretProperties

Výjimky

ResourceExistsError

pokud se název tajného klíče už používá,

HttpResponseError

pro jiné chyby

send_request

Spustí síťový požadavek pomocí existujícího kanálu klienta.

Adresa URL požadavku může být relativní vzhledem k adrese URL trezoru. Pokud není uvedeno jinak, verze rozhraní API služby použitá pro požadavek je stejná jako verze rozhraní API klienta. Tato metoda nevyvolá, pokud odpověď je chyba; pokud chcete vyvolat výjimku, zavolejte raise_for_status() u vráceného objektu odpovědi. Další informace o odesílání vlastních požadavků pomocí této metody najdete v tématu https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parametry

request

HttpRequest

Vyžadováno

Síťový požadavek, který chcete vytvořit.

stream

bool

Jestli se datová část odpovědi bude streamovat. Výchozí hodnota je False.

Návraty

Odpověď síťového volání. Nezvládá zpracování chyb u vaší odpovědi.

Návratový typ

HttpResponse

Výjimky

ResourceNotFoundError

pokud tajný kód neexistuje,

HttpResponseError

pro jiné chyby

set_secret

Nastavte hodnotu tajného kódu. Pokud se název používá, vytvořte novou verzi tajného kódu. Pokud ne, vytvořte nový tajný kód.

Vyžaduje oprávnění k tajným kódům nebo nastavením.

set_secret(name: str, value: str, **kwargs) -> KeyVaultSecret

Parametry

name

str

Vyžadováno

Název tajného kódu

value

str

Vyžadováno

Hodnota tajného kódu

enabled

bool

Určuje, jestli je tajný kód povolený pro použití.

tags

Dict[str, str] nebo None

Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

content_type

str

Libovolný řetězec označující typ tajného kódu, například "heslo"

not_before

datetime

Ne před datem tajného kódu v UTC

expires_on

datetime

Datum vypršení platnosti tajného kódu v UTC

Návratový typ

KeyVaultSecret

Výjimky

HttpResponseError

update_secret_properties

Aktualizujte vlastnosti tajného kódu jiné než jeho hodnota. Vyžaduje oprávnění k tajným kódům nebo nastavením.

Tato metoda aktualizuje vlastnosti tajného kódu, například jestli je povolený, ale nemůže změnit jeho hodnotu. Slouží set_secret ke změně hodnoty tajného kódu.

update_secret_properties(name: str, version: str | None = None, **kwargs) -> SecretProperties

Parametry

name

str

Vyžadováno

Název tajného kódu

version

str

Vyžadováno

(volitelné) Verze tajného kódu, který se má aktualizovat. Pokud není zadáno, aktualizuje se nejnovější verze.

enabled

bool

Určuje, jestli je tajný kód povolený pro použití.

tags

Dict[str, str] nebo None

Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

content_type

str

Libovolný řetězec označující typ tajného kódu, například "heslo"

not_before

datetime

Ne před datem tajného kódu v UTC

expires_on

datetime

Datum vypršení platnosti tajného kódu v UTC

Návratový typ

SecretProperties

Výjimky

ResourceNotFoundError

pokud tajný kód neexistuje,

HttpResponseError

pro jiné chyby

Atributy

vault_url