KeyClient Klass
Ett högnivågränssnitt för att hantera ett valvs nycklar.
- Arv
-
azure.keyvault.keys._shared.client_base.KeyVaultClientBaseKeyClient
Konstruktor
KeyClient(vault_url: str, credential: TokenCredential, **kwargs)Parametrar
- vault_url
- str
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- eller Managed HSM-resurs. Mer information finns under https://aka.ms/azsdk/blog/vault-uri.
- credential
- TokenCredential
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 du vill verifiera att resursen för autentiseringsutmaningen matchar Key Vault- eller Managed HSM-domänen. Standardvärdet är True.
Metoder
| backup_key |
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. |
| begin_delete_key |
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_recover_deleted_key |
Å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. |
| close |
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. |
| create_ec_key |
Skapa en ny elliptisk kurvnyckel eller, om Kräver behörigheten nycklar/skapa. |
| create_key |
Skapa en nyckel eller, om Kräver nycklar/skapa-behörighet. |
| create_oct_key |
Skapa en ny oktettsekvensnyckel (symmetrisk) eller, om Kräver behörigheten nycklar/skapa. |
| create_rsa_key |
Skapa en ny RSA-nyckel eller, om Kräver behörigheten nycklar/skapa. |
| get_cryptography_client |
Hämtar en CryptographyClient för den angivna nyckeln. |
| get_deleted_key |
Hämta en borttagen nyckel. Endast möjligt i ett valv med mjuk borttagning aktiverat. Kräver nycklar/hämta behörighet. |
| get_key |
Hämta en nyckels attribut och, om det är en asymmetrisk nyckel, dess offentliga material. Kräver nycklar/hämta behörighet. |
| get_key_rotation_policy |
Hämta rotationsprincipen för en Key Vault nyckel. |
| get_random_bytes |
Hämta det begärda antalet slumpmässiga byte från en hanterad HSM. |
| import_key |
Importera en nyckel som skapats externt. Kräver nycklar/importbehörighet. Om |
| list_deleted_keys |
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_properties_of_key_versions |
Visa en lista över identifierare och egenskaper för en nyckels versioner. Kräver nycklar/listbehörighet. |
| list_properties_of_keys |
Lista identifierare och egenskaper för alla nycklar i valvet. Kräver nycklar/listbehörighet. |
| purge_deleted_key |
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. |
| release_key |
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. |
| restore_key_backup |
Å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. |
| rotate_key |
Rotera nyckeln baserat på nyckelprincipen genom att generera en ny version av nyckeln. Den här åtgärden kräver behörigheten nycklar/rotera. |
| 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. |
| update_key_properties |
Ändra en nyckels egenskaper (inte dess kryptografiska material). Kräver nycklar/uppdateringsbehörighet. |
| update_key_rotation_policy |
Uppdateringar rotationsprincipen för en Key Vault nyckel. Den här åtgärden kräver behörigheten nycklar/uppdatering. |
backup_key
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) -> bytesParametrar
Returtyp
Undantag
om nyckeln inte finns,
för andra fel
begin_delete_key
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
begin_recover_deleted_key
Å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
close
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() -> NoneUndantag
om nyckeln inte finns,
för andra fel
create_ec_key
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) -> KeyVaultKeyParametrar
- curve
- KeyCurveName eller str eller None
Namn på elliptisk kurva. Standardvärdet är NIST P-256-elliptisk kurva.
- key_operations
- list[KeyOperation eller str] eller None
Tillåtna nyckelåtgärder
Om nyckeln ska skapas i en maskinvarusäkerhetsmodul.
Standardvärdet är False.
- release_policy
- KeyReleasePolicy eller None
De principregler enligt vilka nyckeln kan exporteras.
Returer
Den skapade nyckeln
Returtyp
Undantag
create_key
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) -> KeyVaultKeyParametrar
Nyckelstorlek i bitar. Gäller endast för RSA och symmetriska nycklar. Överväg att använda create_rsa_key eller create_oct_key i stället.
- curve
- KeyCurveName eller str eller None
Namn på elliptisk kurva. Gäller endast för elliptiska kurvnycklar. Standardvärdet är NIST P-256-elliptisk kurva. Om du vill skapa en elliptisk kurvnyckel bör du överväga att använda create_ec_key i stället.
Den offentliga RSA-exponenten som ska användas. Gäller endast för RSA-nycklar som skapats i en hanterad HSM.
- key_operations
- list[KeyOperation eller str] eller None
Tillåtna nyckelåtgärder
- release_policy
- KeyReleasePolicy eller None
De principregler enligt vilka nyckeln kan exporteras.
Returer
Den skapade nyckeln
Returtyp
Undantag
create_oct_key
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) -> KeyVaultKeyParametrar
- key_operations
- list[KeyOperation eller str] eller None
Tillåtna nyckelåtgärder.
Om nyckeln ska skapas i en maskinvarusäkerhetsmodul.
Standardvärdet är False.
- release_policy
- KeyReleasePolicy eller None
De principregler enligt vilka nyckeln kan exporteras.
Returer
Den skapade nyckeln
Returtyp
Undantag
create_rsa_key
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) -> KeyVaultKeyParametrar
Den offentliga RSA-exponenten som ska användas. Gäller endast för RSA-nycklar som skapats i en hanterad HSM.
Om nyckeln ska skapas i en maskinvarusäkerhetsmodul.
Standardvärdet är False.
- key_operations
- list[KeyOperation eller str] eller None
Tillåtna nyckelåtgärder
- release_policy
- KeyReleasePolicy eller None
De principregler enligt vilka nyckeln kan exporteras.
Returer
Den skapade nyckeln
Returtyp
Undantag
get_cryptography_client
Hämtar en CryptographyClient för den angivna nyckeln.
get_cryptography_client(key_name: str, **kwargs) -> CryptographyClientParametrar
- key_version
- str
Valfri version av nyckeln som används för att utföra kryptografiska åtgärder.
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
get_deleted_key
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) -> DeletedKeyParametrar
Returer
Den borttagna nyckeln
Returtyp
Undantag
om nyckeln inte finns,
för andra fel
get_key
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) -> KeyVaultKeyParametrar
(valfritt) En specifik version av nyckeln som ska hämtas. Om det inte anges hämtar den senaste versionen av nyckeln.
Returtyp
Undantag
om nyckeln inte finns,
för andra fel
get_key_rotation_policy
Hämta rotationsprincipen för en Key Vault nyckel.
get_key_rotation_policy(key_name: str, **kwargs) -> KeyRotationPolicyParametrar
Returer
Principen för nyckelrotation.
Returtyp
Undantag
get_random_bytes
Hämta det begärda antalet slumpmässiga byte från en hanterad HSM.
get_random_bytes(count: int, **kwargs) -> bytesParametrar
Returer
Slumpmässiga byte.
Returtyp
Undantag
om mindre än en slumpmässig byte begärs,
för andra fel
import_key
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) -> KeyVaultKeyParametrar
- release_policy
- KeyReleasePolicy eller None
De principregler enligt vilka nyckeln kan exporteras.
Returer
Den importerade nyckeln
Returtyp
Undantag
list_deleted_keys
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
list_properties_of_key_versions
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
list_properties_of_keys
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
purge_deleted_key
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) -> NoneParametrar
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")
release_key
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) -> ReleaseKeyResultParametrar
En specifik version av nyckeln som ska släppas. Om den senaste versionen är ospecificerad släpps den.
- algorithm
- str eller KeyExportEncryptionAlgorithm eller None
Krypteringsalgoritmen som ska användas för att skydda det utgivna nyckelmaterialet.
Returer
Resultatet av nyckelversionen.
Returtyp
Undantag
restore_key_backup
Å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) -> KeyVaultKeyParametrar
Returer
Den återställde nyckeln
Returtyp
Undantag
om den säkerhetskopierade nyckelns namn redan används,
för andra fel
rotate_key
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) -> KeyVaultKeyParametrar
Returer
Den nya versionen av den roterade nyckeln.
Returtyp
Undantag
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) -> HttpResponseParametrar
- 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
Undantag
om nyckeln inte finns,
för andra fel
update_key_properties
Ändra en nyckels egenskaper (inte dess kryptografiska material).
Kräver nycklar/uppdateringsbehörighet.
update_key_properties(name: str, version: str | None = None, **kwargs) -> KeyVaultKeyParametrar
(valfritt) Den version av nyckeln som ska uppdateras. Om den är ospecificerad uppdateras den senaste versionen.
- key_operations
- list[KeyOperation eller str] eller None
Tillåtna nyckelåtgärder
- release_policy
- KeyReleasePolicy eller None
De principregler som nyckeln kan exporteras under.
Returer
Den uppdaterade nyckeln
Returtyp
Undantag
om nyckeln inte finns,
för andra fel
update_key_rotation_policy
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) -> KeyRotationPolicyParametrar
- lifetime_actions
- list[KeyRotationLifetimeAction]
Åtgärder som ska utföras av Key Vault under en nyckels livslängd. Detta åsidosätter livslängdsåtgärderna för den angivna policy.
- expires_in
- str
Utgångstiden för principen som ska tillämpas på nya nyckelversioner, definierad som en ISO 8601-varaktighet. Till exempel: 90 dagar är "P90D", 3 månader är "P3M" och 48 timmar är "PT48H". Mer information om ISO 8601-varaktigheter finns i Wikipedia .
Detta åsidosätter förfallotiden för den angivna policy.
Returer
Den uppdaterade rotationsprincipen.
Returtyp
Undantag
Attribut
vault_url
Azure SDK for Python
Feedback
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i: https://aka.ms/ContentUserFeedback.
Skicka och visa feedback för