KeyClient Klass

Säkerhetskopiera en nyckel i ett skyddat formulär som endast kan användas av Azure Key Vault.

Kräver nycklar/säkerhetskopieringsbehörighet.

Detta är avsett att tillåta kopiering av en nyckel från ett valv till ett annat. Båda valv måste ägas av samma Azure-prenumeration. Säkerhetskopiering/återställning kan inte heller utföras över geopolitiska gränser. En säkerhetskopia från ett valv i en region i USA kan till exempel inte återställas till ett valv i en EU-region.

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

Parametrar

Returtyp

Undantag

om nyckeln inte finns,

för andra fel

Ta bort alla versioner av en nyckel och dess kryptografiska material.

Kräver nycklar/borttagningsbehörighet. När den här metoden returnerar Key Vault har börjat ta bort nyckeln. 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_key(name: str, **kwargs) -> LROPoller[DeletedKey]

Parametrar

Returer

En poller för borttagningsnyckelåtgärden. Pollerns resultatmetod returnerar utan att vänta på att borttagningen DeletedKey ska slutföras. Om mjuk borttagning är aktiverat för valvet och du vill ta bort nyckeln permanent med purge_deleted_keyanropar du pollerns väntemetod först. Det blockeras tills borttagningen har slutförts. Wait-metoden kräver nycklar/hämta behörighet.

Returtyp

Undantag

om nyckeln inte finns,

för andra fel

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

Kräver nycklar/återställningsbehörighet.

När den här metoden returnerar Key Vault har börjat återställa nyckeln. Å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. Du behöver bara vänta när du vill använda den återställda nyckeln i en annan åtgärd omedelbart.

begin_recover_deleted_key(name: str, **kwargs) -> LROPoller[KeyVaultKey]

Parametrar

Returer

En poller för återställningsåtgärden. Pollerns resultatmetod returnerar den återställda KeyVaultKey utan att vänta på att återställningen ska slutföras. Om du vill använda den återställda nyckeln omedelbart anropar du pollerns väntemetod , som blockerar tills nyckeln är redo att användas. Wait-metoden kräver nycklar/hämta behörighet.

Returtyp

Undantag

Stäng sockets 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

om nyckeln inte finns,

för andra fel

Skapa en ny elliptisk kurvnyckel eller, om name den redan används, skapa en ny version av nyckeln.

Kräver behörigheten nycklar/skapa.

create_ec_key(name: str, **kwargs) -> KeyVaultKey

Parametrar

Returer

Den skapade nyckeln

Returtyp

Undantag

Skapa en nyckel eller, om name den redan används, skapa en ny version av nyckeln.

Kräver nycklar/skapa-behörighet.

create_key(name: str, key_type: str | KeyType, **kwargs) -> KeyVaultKey

Parametrar

Returer

Den skapade nyckeln

Returtyp

Undantag

Skapa en ny oktettsekvensnyckel (symmetrisk) eller, om name den används, skapa en ny version av nyckeln.

Kräver behörigheten nycklar/skapa.

create_oct_key(name: str, **kwargs) -> KeyVaultKey

Parametrar

Returer

Den skapade nyckeln

Returtyp

Undantag

Skapa en ny RSA-nyckel eller, om name den redan används, skapa en ny version av nyckeln

Kräver behörigheten nycklar/skapa.

create_rsa_key(name: str, **kwargs) -> KeyVaultKey

Parametrar

Returer

Den skapade nyckeln

Returtyp

Undantag

Hämtar en CryptographyClient för den angivna nyckeln.

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

Parametrar

Returer

En CryptographyClient med samma alternativ, autentiseringsuppgifter och HTTP-klient som den här KeyClient.

Returtyp

Undantag

om nyckeln inte finns,

för andra fel

Hämta en borttagen nyckel. Endast möjligt i ett valv med mjuk borttagning aktiverat.

Kräver nycklar/hämta behörighet.

get_deleted_key(name: str, **kwargs) -> DeletedKey

Parametrar

Returer

Den borttagna nyckeln

Returtyp

Undantag

om nyckeln inte finns,

för andra fel

Hämta en nyckels attribut och, om det är en asymmetrisk nyckel, dess offentliga material.

Kräver nycklar/hämta behörighet.

get_key(name: str, version: str | None = None, **kwargs) -> KeyVaultKey

Parametrar

Returtyp

Undantag

om nyckeln inte finns,

för andra fel

Hämta rotationsprincipen för en Key Vault nyckel.

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

Parametrar

Returer

Principen för nyckelrotation.

Returtyp

Undantag

Hämta det begärda antalet slumpmässiga byte från en hanterad HSM.

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

Parametrar

Returer

Slumpmässiga byte.

Returtyp

Undantag

om mindre än en slumpmässig byte begärs,

för andra fel

Importera en nyckel som skapats externt.

Kräver nycklar/importbehörighet. Om name den redan används importeras nyckeln som en ny version.

import_key(name: str, key: JsonWebKey, **kwargs) -> KeyVaultKey

Parametrar

Returer

Den importerade nyckeln

Returtyp

Undantag

Visa en lista över alla borttagna nycklar, inklusive den offentliga delen av varje. Endast möjligt i ett valv med mjuk borttagning aktiverat.

Kräver nycklar/listbehörighet.

list_deleted_keys(**kwargs) -> ItemPaged[DeletedKey]

Returer

En iterator för borttagna nycklar

Returtyp

Undantag

om nyckeln inte finns,

för andra fel

Visa en lista över identifierare och egenskaper för en nyckels versioner.

Kräver nycklar/listbehörighet.

list_properties_of_key_versions(name: str, **kwargs) -> ItemPaged[KeyProperties]

Parametrar

Returer

En iterator av nycklar utan kryptografiskt material

Returtyp

Undantag

om nyckeln inte finns,

för andra fel

Lista identifierare och egenskaper för alla nycklar i valvet.

Kräver nycklar/listbehörighet.

list_properties_of_keys(**kwargs) -> ItemPaged[KeyProperties]

Returer

En iterator av nycklar utan kryptografiskt material eller versionsinformation

Returtyp

Undantag

om nyckeln inte finns,

för andra fel

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

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

Kräver nycklar/rensningsbehörighet.

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

Parametrar

Returer

Ingen

Undantag

Exempel

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

Släpper en nyckel.

Versionsnyckelåtgärden gäller för alla nyckeltyper. Målnyckeln måste vara markerad som exporterbar. Den här åtgärden kräver nycklar/frisläppningsbehörighet.

release_key(name: str, target_attestation_token: str, **kwargs) -> ReleaseKeyResult

Parametrar

Returer

Resultatet av nyckelversionen.

Returtyp

Undantag

Återställ en nyckelsäkerhetskopia till valvet.

Kräver nycklar/återställningsbehörighet.

Detta importerar alla versioner av nyckeln med dess namn, attribut och principer för åtkomstkontroll. Om nyckelns namn redan används misslyckas återställningen. Målvalvet måste också ägas av samma Microsoft Azure-prenumeration som källvalvet.

restore_key_backup(backup: bytes, **kwargs) -> KeyVaultKey

Parametrar

Returer

Den återställde nyckeln

Returtyp

Undantag

om den säkerhetskopierade nyckelns namn redan används,

för andra fel

Rotera nyckeln baserat på nyckelprincipen genom att generera en ny version av nyckeln.

Den här åtgärden kräver behörigheten nycklar/rotera.

rotate_key(name: str, **kwargs) -> KeyVaultKey

Parametrar

Returer

Den nya versionen av den roterade nyckeln.

Returtyp

Undantag

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

Returer

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

Returtyp

Undantag

om nyckeln inte finns,

för andra fel

Ändra en nyckels egenskaper (inte dess kryptografiska material).

Kräver nycklar/uppdateringsbehörighet.

update_key_properties(name: str, version: str | None = None, **kwargs) -> KeyVaultKey

Parametrar

Returer

Den uppdaterade nyckeln

Returtyp

Undantag

om nyckeln inte finns,

för andra fel

Uppdateringar rotationsprincipen för en Key Vault nyckel.

Den här åtgärden kräver behörigheten nycklar/uppdatering.

update_key_rotation_policy(key_name: str, policy: KeyRotationPolicy, **kwargs) -> KeyRotationPolicy

Parametrar

Returer

Den uppdaterade rotationsprincipen.

Returtyp

Undantag