SecretClient Klass

Ett övergripande gränssnitt för att hantera ett valvs hemligheter.

Arv

azure.keyvault.secrets._shared.client_base.KeyVaultClientBase

SecretClient

Konstruktor

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

Parametrar

vault_url

str

Obligatorisk

URL för valvet som klienten kommer åt. Detta kallas även valvets "DNS-namn". Du bör kontrollera att den här URL:en refererar till en giltig Key Vault resurs. Mer information finns under https://aka.ms/azsdk/blog/vault-uri.

credential

TokenCredential

Obligatorisk

Ett objekt som kan tillhandahålla en åtkomsttoken för valvet, till exempel en autentiseringsuppgift från identity

api_version

ApiVersion

Version av tjänst-API:et som ska användas. Standardvärdet är den senaste.

verify_challenge_resource

bool

Om autentiseringsuppgiftsresursen ska verifieras matchar Key Vault domän. Standardvärdet är True.

Metoder

backup_secret	Säkerhetskopiera en hemlighet i ett skyddat formulär som endast kan användas av Azure Key Vault. Kräver hemligheter/säkerhetskopieringsbehörighet.
begin_delete_secret	Ta bort alla versioner av en hemlighet. Kräver behörighet för hemligheter/borttagning. När den här metoden returnerar Key Vault har börjat ta bort hemligheten. Borttagningen kan ta flera sekunder i ett valv med mjuk borttagning aktiverat. Den här metoden returnerar därför en poller som gör att du kan vänta tills borttagningen har slutförts.
begin_recover_deleted_secret	Återställa en borttagen hemlighet till den senaste versionen. Endast möjligt i ett valv med mjuk borttagning aktiverat. Kräver behörigheten hemligheter/återställning. Om valvet inte har mjuk borttagning aktiverat begin_delete_secret är permanent och den här metoden returnerar ett fel. Om du försöker återställa en icke-borttagen hemlighet returneras också ett fel. När den här metoden returnerar Key Vault har börjat återställa hemligheten. Återställningen kan ta flera sekunder. Den här metoden returnerar därför en poller som gör att du kan vänta tills återställningen har slutförts. Det är bara nödvändigt att vänta när du vill använda den återställda hemligheten i en annan åtgärd omedelbart.
close	Stäng socketar som öppnats av klienten. Det är inte nödvändigt att anropa den här metoden när klienten används som kontexthanterare.
get_deleted_secret	Hämta en borttagen hemlighet. Endast möjligt i valv med mjuk borttagning aktiverat. Kräver hemligheter/få behörighet.
get_secret	Hämta en hemlighet. Kräver hemligheterna/få behörighet.
list_deleted_secrets	Visar en lista över alla borttagna hemligheter. Endast möjligt i valv med mjuk borttagning aktiverat. Kräver hemligheter/listbehörighet.
list_properties_of_secret_versions	Lista egenskaper för alla versioner av en hemlighet, exklusive deras värden. Kräver hemligheter/listbehörighet. Listobjekt innehåller inte hemliga värden. Använd get_secret för att hämta en hemlighets värde.
list_properties_of_secrets	Lista identifierare och attribut för alla hemligheter i valvet. Kräver hemligheter/listbehörighet. Listobjekt innehåller inte hemliga värden. Använd get_secret för att hämta en hemlighets värde.
purge_deleted_secret	Tar bort en borttagen hemlighet permanent. Endast möjligt i valv med mjuk borttagning aktiverat. Utför en oåterkallelig borttagning av den angivna hemligheten, utan möjlighet till återställning. Åtgärden är inte tillgänglig om recovery_level inte anger "Rensningsbar". Den här metoden är bara nödvändig för att rensa en hemlighet före dess scheduled_purge_date. Kräver hemligheter/rensningsbehörighet.
restore_secret_backup	Återställ en säkerhetskopierad hemlighet. Kräver behörigheten hemligheter/återställning.
send_request	Kör en nätverksbegäran med klientens befintliga pipeline. Begärande-URL:en kan vara relativ till valvets URL. Den tjänst-API-version som används för begäran är densamma som klientens om inget annat anges. Den här metoden genererar inte om svaret är ett fel. om du vill skapa ett undantag anropar du raise_for_status() på det returnerade svarsobjektet. Mer information om hur du skickar anpassade begäranden med den här metoden finns i https://aka.ms/azsdk/dpcodegen/python/send_request.
set_secret	Ange ett hemligt värde. Om namnet används skapar du en ny version av hemligheten. Om inte skapar du en ny hemlighet. Kräver hemligheter/ange behörighet.
update_secret_properties	Uppdatera egenskaper för en annan hemlighet än dess värde. Kräver hemligheter/ange behörighet. Den här metoden uppdaterar hemlighetens egenskaper, till exempel om den är aktiverad, men kan inte ändra hemlighetens värde. Använd set_secret för att ändra hemlighetens värde.

backup_secret

Säkerhetskopiera en hemlighet i ett skyddat formulär som endast kan användas av Azure Key Vault. Kräver hemligheter/säkerhetskopieringsbehörighet.

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

Parametrar

name

str

Obligatorisk

Namnet på hemligheten som ska säkerhetskopieras

Returtyp

bytes

Undantag

ResourceNotFoundError

om hemligheten inte finns,

HttpResponseError

för andra fel

begin_delete_secret

Ta bort alla versioner av en hemlighet. Kräver behörighet för hemligheter/borttagning.

När den här metoden returnerar Key Vault har börjat ta bort hemligheten. Borttagningen kan ta flera sekunder i ett valv med mjuk borttagning aktiverat. Den här metoden returnerar därför en poller som gör att du kan vänta tills borttagningen har slutförts.

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

Parametrar

name

str

Obligatorisk

Namnet på hemligheten som ska tas bort.

Returer

En poller för borttagningsåtgärden. Pollerns resultatmetod returnerar DeletedSecret utan att vänta på att borttagningen ska slutföras. Om valvet har mjuk borttagning aktiverat och du vill ta bort hemligheten permanent med purge_deleted_secretanropar du pollerns väntemetod först. Det blockeras tills borttagningen är klar. Väntemetoden kräver hemligheter/få behörighet.

Returtyp

LROPoller[DeletedSecret]

Undantag

ResourceNotFoundError

om hemligheten inte finns,

HttpResponseError

för andra fel

begin_recover_deleted_secret

Återställa en borttagen hemlighet till den senaste versionen. Endast möjligt i ett valv med mjuk borttagning aktiverat.

Kräver behörigheten hemligheter/återställning. Om valvet inte har mjuk borttagning aktiverat begin_delete_secret är permanent och den här metoden returnerar ett fel. Om du försöker återställa en icke-borttagen hemlighet returneras också ett fel. När den här metoden returnerar Key Vault har börjat återställa hemligheten. Återställningen kan ta flera sekunder. Den här metoden returnerar därför en poller som gör att du kan vänta tills återställningen har slutförts. Det är bara nödvändigt att vänta när du vill använda den återställda hemligheten i en annan åtgärd omedelbart.

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

Parametrar

name

str

Obligatorisk

Namnet på den borttagna hemligheten som ska återställas

Returer

En poller för återställningsåtgärden. Pollerns resultatmetod returnerar den återställda hemligheten utan SecretProperties att vänta på att återställningen ska slutföras. Om du vill använda den återställda hemligheten omedelbart anropar du pollerns väntemetod , som blockerar tills hemligheten är klar att användas. Väntemetoden kräver hemligheter/få behörighet.

Returtyp

LROPoller[SecretProperties]

Undantag

HttpResponseError

close

Stäng socketar som öppnats av klienten.

Det är inte nödvändigt att anropa den här metoden när klienten används som kontexthanterare.

close() -> None

Undantag

ResourceNotFoundError

om hemligheten inte finns,

HttpResponseError

för andra fel

get_deleted_secret

Hämta en borttagen hemlighet. Endast möjligt i valv med mjuk borttagning aktiverat. Kräver hemligheter/få behörighet.

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

Parametrar

name

str

Obligatorisk

Namnet på den borttagna hemligheten

Returtyp

DeletedSecret

Undantag

ResourceNotFoundError

om den borttagna hemligheten inte finns,

HttpResponseError

för andra fel

get_secret

Hämta en hemlighet. Kräver hemligheterna/få behörighet.

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

Parametrar

name

str

Obligatorisk

Namnet på hemligheten

version

str

Obligatorisk

(valfritt) Version av hemligheten att hämta. Om den är ospecificerad får du den senaste versionen.

Returtyp

KeyVaultSecret

Undantag

ResourceNotFoundError

om hemligheten inte finns,

HttpResponseError

för andra fel

list_deleted_secrets

Visar en lista över alla borttagna hemligheter. Endast möjligt i valv med mjuk borttagning aktiverat.

Kräver hemligheter/listbehörighet.

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

Returer

En iterator för borttagna hemligheter, exklusive deras värden

Returtyp

ItemPaged[DeletedSecret]

Undantag

ResourceNotFoundError

om hemligheten inte finns,

HttpResponseError

för andra fel

list_properties_of_secret_versions

Lista egenskaper för alla versioner av en hemlighet, exklusive deras värden. Kräver hemligheter/listbehörighet.

Listobjekt innehåller inte hemliga värden. Använd get_secret för att hämta en hemlighets värde.

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

Parametrar

name

str

Obligatorisk

Namnet på hemligheten

Returer

En iterator av hemligheter, exklusive deras värden

Returtyp

ItemPaged[SecretProperties]

Undantag

ResourceNotFoundError

om hemligheten inte finns,

HttpResponseError

för andra fel

list_properties_of_secrets

Lista identifierare och attribut för alla hemligheter i valvet. Kräver hemligheter/listbehörighet.

Listobjekt innehåller inte hemliga värden. Använd get_secret för att hämta en hemlighets värde.

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

Returer

En iterator av hemligheter, exklusive deras värden

Returtyp

ItemPaged[SecretProperties]

Undantag

ResourceNotFoundError

om hemligheten inte finns,

HttpResponseError

för andra fel

purge_deleted_secret

Tar bort en borttagen hemlighet permanent. Endast möjligt i valv med mjuk borttagning aktiverat.

Utför en oåterkallelig borttagning av den angivna hemligheten, utan möjlighet till återställning. Åtgärden är inte tillgänglig om recovery_level inte anger "Rensningsbar". Den här metoden är bara nödvändig för att rensa en hemlighet före dess scheduled_purge_date.

Kräver hemligheter/rensningsbehörighet.

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

Parametrar

name

str

Obligatorisk

Namnet på den borttagna hemligheten som ska rensas

Returer

Ingen

Undantag

HttpResponseError

Exempel

   # 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

Återställ en säkerhetskopierad hemlighet. Kräver behörigheten hemligheter/återställning.

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

Parametrar

backup

bytes

Obligatorisk

En hemlig säkerhetskopia som returneras av backup_secret

Returer

Den återställde hemligheten

Returtyp

SecretProperties

Undantag

ResourceExistsError

om hemlighetens namn redan används,

HttpResponseError

för andra fel

send_request

Kör en nätverksbegäran med klientens befintliga pipeline.

Begärande-URL:en kan vara relativ till valvets URL. Den tjänst-API-version som används för begäran är densamma som klientens om inget annat anges. Den här metoden genererar inte om svaret är ett fel. om du vill skapa ett undantag anropar du raise_for_status() på det returnerade svarsobjektet. Mer information om hur du skickar anpassade begäranden med den här metoden finns i https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parametrar

request

HttpRequest

Obligatorisk

Den nätverksbegäran som du vill göra.

stream

bool

Om svarsnyttolasten kommer att strömmas. Standardvärdet är Falskt.

Returer

Svaret på ditt nätverksanrop. Felhantering av ditt svar sker inte.

Returtyp

HttpResponse

Undantag

ResourceNotFoundError

om hemligheten inte finns,

HttpResponseError

för andra fel

set_secret

Ange ett hemligt värde. Om namnet används skapar du en ny version av hemligheten. Om inte skapar du en ny hemlighet.

Kräver hemligheter/ange behörighet.

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

Parametrar

name

str

Obligatorisk

Namnet på hemligheten

value

str

Obligatorisk

Värdet för hemligheten

enabled

bool

Om hemligheten är aktiverad för användning.

tags

Dict[str, str] eller None

Programspecifika metadata i form av nyckel/värde-par.

content_type

str

En godtycklig sträng som anger typen av hemlighet, t.ex. "lösenord"

not_before

datetime

Inte före datumet för hemligheten i UTC

expires_on

datetime

Utgångsdatum för hemligheten i UTC

Returtyp

KeyVaultSecret

Undantag

HttpResponseError

update_secret_properties

Uppdatera egenskaper för en annan hemlighet än dess värde. Kräver hemligheter/ange behörighet.

Den här metoden uppdaterar hemlighetens egenskaper, till exempel om den är aktiverad, men kan inte ändra hemlighetens värde. Använd set_secret för att ändra hemlighetens värde.

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

Parametrar

name

str

Obligatorisk

Namnet på hemligheten

version

str

Obligatorisk

(valfritt) Version av hemligheten som ska uppdateras. Om den senaste versionen är ospecificerad uppdateras den.

enabled

bool

Om hemligheten är aktiverad för användning.

tags

Dict[str, str] eller None

Programspecifika metadata i form av nyckel/värde-par.

content_type

str

En godtycklig sträng som anger typen av hemlighet, t.ex. "lösenord"

not_before

datetime

Inte före datumet för hemligheten i UTC

expires_on

datetime

Utgångsdatum för hemligheten i UTC

Returtyp

SecretProperties

Undantag

ResourceNotFoundError

om hemligheten inte finns,

HttpResponseError

för andra fel

Attribut

vault_url