CertificateClient Klass
Ett högnivågränssnitt för att hantera ett valvs certifikat.
- Arv
-
azure.keyvault.certificates._shared.client_base.KeyVaultClientBaseCertificateClient
Konstruktor
CertificateClient(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 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 domän. Standardvärdet är True.
Metoder
| backup_certificate |
Säkerhetskopiera ett certifikat i ett skyddat formulär som endast kan användas av Azure Key Vault. Kräver certifikat/säkerhetskopieringsbehörighet. Detta är avsett att tillåta kopiering av ett certifikat 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_create_certificate |
Skapar ett nytt certifikat. Om det här är den första versionen skapas certifikatresursen. Den här åtgärden kräver certifikat-/skapandebehörighet. Att vänta på den returnerade pollern kräver certifikat/hämta-behörighet och ger dig certifikatet om skapandet lyckas, eller CertificateOperation om inte – annars genererar det en HttpResponseError. |
| begin_delete_certificate |
Ta bort alla versioner av ett certifikat. Kräver certifikat/borttagningsbehörighet. När den här metoden returnerar Key Vault har börjat ta bort certifikatet. 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_certificate |
Återställa ett borttaget certifikat till den senaste versionen. Endast möjligt i ett valv med mjuk borttagning aktiverat. Kräver certifikat/återställningsbehörighet. När den här metoden returnerar Key Vault har börjat återställa certifikatet. Å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 det återställda certifikatet i en annan åtgärd omedelbart. |
| cancel_certificate_operation |
Avbryter en pågående certifikatåtgärd. Kräver certifikat/uppdateringsbehörighet. |
| 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_issuer |
Anger den angivna certifikatutfärdaren. Kräver behörighet för certifikat/setissuers. |
| delete_certificate_operation |
Tar bort och stoppar skapandeåtgärden för ett visst certifikat. Kräver certifikat/uppdateringsbehörighet. |
| delete_contacts |
Tar bort certifikatkontakterna för nyckelvalvet. Kräver behörigheten certificates/managecontacts. |
| delete_issuer |
Tar bort den angivna certifikatutfärdaren. Kräver behörighet för certifikat/manageissuers/deleteissuers. |
| get_certificate |
Hämtar ett certifikat med dess hanteringsprincip kopplad. Kräver certifikat/hämta behörighet. Accepterar inte versionen av certifikatet som en parameter. Om du vill hämta en specifik version av certifikatet anropar get_certificate_versiondu . |
| get_certificate_operation |
Hämtar skapandeåtgärden för ett certifikat. Kräver certifikaten/hämta behörigheten. |
| get_certificate_policy |
Hämtar principen för ett certifikat. Kräver certifikat/hämta behörighet. Returnerar de angivna certifikatprincipresurserna i nyckelvalvet. |
| get_certificate_version |
Hämtar en specifik version av ett certifikat utan att returnera dess hanteringsprincip. Kräver certifikat/hämta behörighet. Om du vill hämta den senaste versionen av certifikatet eller för att hämta certifikatets princip anropar du get_certificate. |
| get_contacts |
Hämtar certifikatkontakterna för nyckelvalvet. Kräver behörigheten certifikat/managecontacts. |
| get_deleted_certificate |
Hämta ett borttaget certifikat. Endast möjligt i ett valv med mjuk borttagning aktiverat. Kräver certifikat/hämta behörighet. Hämtar den borttagna certifikatinformationen plus dess attribut, till exempel kvarhållningsintervall, schemalagd permanent borttagning och den aktuella återställningsnivån för borttagning. |
| get_issuer |
Hämtar den angivna certifikatutfärdaren. Kräver certifikat/manageissuers/getissuers-behörighet. |
| import_certificate |
Importera ett certifikat som skapats externt. Kräver certifikat/importbehörighet. Importerar ett befintligt giltigt certifikat som innehåller en privat nyckel till Azure Key Vault. Certifikatet som ska importeras kan vara i antingen PFX- eller PEM-format. Om certifikatet är i PEM-format måste PEM-filen innehålla nyckeln samt x509-certifikat, och du måste ange ett |
| list_deleted_certificates |
Visar en lista över borttagna certifikat som kan återställas. Endast möjligt om valvet är aktiverat för mjuk borttagning. Kräver certifikat/hämta/listbehörighet. Hämtar certifikaten i det aktuella valvet som är i ett borttaget tillstånd och redo för återställning eller rensning. Den här åtgärden innehåller borttagningsspecifik information. |
| list_properties_of_certificate_versions |
Visa en lista över identifierare och egenskaper för ett certifikats versioner. Kräver certifikat/listbehörighet. |
| list_properties_of_certificates |
Lista identifierare och egenskaper för alla certifikat i valvet. Kräver certifikat/listbehörighet. |
| list_properties_of_issuers |
Visar egenskaper för certifikatutfärdarna för nyckelvalvet. Kräver behörigheten certificates/manageissuers/getissuers. |
| merge_certificate |
Sammanfogar ett certifikat eller en certifikatkedja med ett nyckelpar som finns på servern. Kräver behörigheten certifikat/skapa. Utför sammanslagning av ett certifikat eller en certifikatkedja med ett nyckelpar som för närvarande är tillgängligt i tjänsten. Se till att när du skapar certifikatet för sammanslagning med hjälp av begin_create_certificate att du ställer in utfärdaren på Okänd. På så sätt vet Key Vault att certifikatet inte kommer att signeras av en utfärdare som är känd för det. |
| purge_deleted_certificate |
Tar bort ett borttaget certifikat permanent. Endast möjligt i valv med mjuk borttagning aktiverat. Kräver certifikat/rensningsbehörighet. Utför en oåterkallelig borttagning av det angivna certifikatet, 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 ett certifikat före dess scheduled_purge_date. |
| restore_certificate_backup |
Återställ en säkerhetskopia av certifikatet till valvet. Kräver certifikat/återställningsbehörighet. Detta återställer alla versioner av certifikatet med dess namn, attribut och åtkomstkontrollprinciper. Om certifikatets namn redan används misslyckas återställningen. Dessutom måste målvalvet ägas av samma Microsoft Azure-prenumeration som källvalvet. |
| 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_contacts |
Anger certifikatkontakterna för nyckelvalvet. Kräver behörigheten certifikat/managecontacts. |
| update_certificate_policy |
Uppdateringar principen för ett certifikat. Kräver certifikat/uppdateringsbehörighet. Ange angivna medlemmar i certifikatprincipen. Lämnar andra som null. |
| update_certificate_properties |
Ändra egenskaperna för ett certifikat. Kräver certifikat/uppdateringsbehörighet. |
| update_issuer |
Uppdateringar den angivna certifikatutfärdaren. Kräver behörighet för certifikat/setissuers. |
backup_certificate
Säkerhetskopiera ett certifikat i ett skyddat formulär som endast kan användas av Azure Key Vault.
Kräver certifikat/säkerhetskopieringsbehörighet. Detta är avsett att tillåta kopiering av ett certifikat 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_certificate(certificate_name: str, **kwargs) -> bytesParametrar
Returer
Säkerhetskopieringsbloben som innehåller det säkerhetskopierade certifikatet.
Returtyp
Undantag
om certifikatet inte finns,
för andra fel
begin_create_certificate
Skapar ett nytt certifikat.
Om det här är den första versionen skapas certifikatresursen. Den här åtgärden kräver certifikat-/skapandebehörighet. Att vänta på den returnerade pollern kräver certifikat/hämta-behörighet och ger dig certifikatet om skapandet lyckas, eller CertificateOperation om inte – annars genererar det en HttpResponseError.
begin_create_certificate(certificate_name: str, policy: CertificatePolicy, **kwargs) -> LROPoller[KeyVaultCertificate | CertificateOperation]Parametrar
- policy
- CertificatePolicy
Hanteringsprincipen för certifikatet. Antingen ämne eller en av egenskaperna för alternativt namn på certifikatmottagare krävs.
- enabled
- bool
Om certifikatet är aktiverat för användning.
Returer
En LROPoller för åtgärden skapa certifikat. Om du väntar på polleraren får du certifikatet om det lyckas, eller CertificateOperation om det inte är det.
Returtyp
Undantag
om certifikatprincipen är ogiltig,
för andra fel.
begin_delete_certificate
Ta bort alla versioner av ett certifikat. Kräver certifikat/borttagningsbehörighet.
När den här metoden returnerar Key Vault har börjat ta bort certifikatet. 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_certificate(certificate_name: str, **kwargs) -> LROPoller[DeletedCertificate]Parametrar
Returer
En poller för borttagningscertifikatåtgärden. Pollerns resultatmetod returnerar utan att vänta på att borttagningen DeletedCertificate ska slutföras. Om mjuk borttagning är aktiverat för valvet och du vill ta bort certifikatet permanent med purge_deleted_certificateanropar du först pollerns väntemetod . Det blockeras tills borttagningen har slutförts. Väntemetoden kräver certifikat/hämta behörighet.
Returtyp
Undantag
om certifikatet inte finns,
för andra fel
begin_recover_deleted_certificate
Återställa ett borttaget certifikat till den senaste versionen. Endast möjligt i ett valv med mjuk borttagning aktiverat.
Kräver certifikat/återställningsbehörighet. När den här metoden returnerar Key Vault har börjat återställa certifikatet. Å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 det återställda certifikatet i en annan åtgärd omedelbart.
begin_recover_deleted_certificate(certificate_name: str, **kwargs) -> LROPoller[KeyVaultCertificate]Parametrar
Returer
En poller för återställningsåtgärden. Pollerns resultatmetod returnerar den återställda KeyVaultCertificate utan att vänta på att återställningen ska slutföras. Om du vill använda det återställda certifikatet omedelbart anropar du pollerns väntemetod , som blockerar tills certifikatet är klart att användas. Väntemetoden kräver certifikat/hämta behörighet.
Returtyp
Undantag
cancel_certificate_operation
Avbryter en pågående certifikatåtgärd. Kräver certifikat/uppdateringsbehörighet.
cancel_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperationParametrar
Returer
Den avbrutna certifikatåtgärden
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 certifikatet inte finns,
för andra fel
create_issuer
Anger den angivna certifikatutfärdaren. Kräver behörighet för certifikat/setissuers.
create_issuer(issuer_name: str, provider: str, **kwargs) -> CertificateIssuerParametrar
- enabled
- bool
Om utfärdaren är aktiverad för användning.
- account_id
- str
Användarnamn/kontonamn/konto-ID.
- password
- str
Lösenordet/hemligheten/kontonyckeln.
- organization_id
- str
ID för organisationen
- admin_contacts
- list[AdministratorContact]
Kontaktuppgifter till certifikatutfärdarens organisationsadministratörer.
Returer
Certifikatutfärdaren som skapats
Returtyp
Undantag
delete_certificate_operation
Tar bort och stoppar skapandeåtgärden för ett visst certifikat.
Kräver certifikat/uppdateringsbehörighet.
delete_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperationParametrar
Returer
Borttaget CertificateOperation
Returtyp
Undantag
delete_contacts
Tar bort certifikatkontakterna för nyckelvalvet. Kräver behörigheten certificates/managecontacts.
delete_contacts(**kwargs) -> List[CertificateContact]Returer
De borttagna kontakterna för nyckelvalvet.
Returtyp
Undantag
delete_issuer
Tar bort den angivna certifikatutfärdaren.
Kräver behörighet för certifikat/manageissuers/deleteissuers.
delete_issuer(issuer_name: str, **kwargs) -> CertificateIssuerParametrar
Returer
CertificateIssuer
Returtyp
Undantag
get_certificate
Hämtar ett certifikat med dess hanteringsprincip kopplad. Kräver certifikat/hämta behörighet.
Accepterar inte versionen av certifikatet som en parameter. Om du vill hämta en specifik version av certifikatet anropar get_certificate_versiondu .
get_certificate(certificate_name: str, **kwargs) -> KeyVaultCertificateParametrar
Returer
En instans av KeyVaultCertificate
Returtyp
Undantag
om certifikatet inte finns,
för andra fel
get_certificate_operation
Hämtar skapandeåtgärden för ett certifikat. Kräver certifikaten/hämta behörigheten.
get_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperationParametrar
Returer
Den skapade CertificateOperation
Returtyp
Undantag
om certifikatet inte finns,
för andra fel
get_certificate_policy
Hämtar principen för ett certifikat. Kräver certifikat/hämta behörighet.
Returnerar de angivna certifikatprincipresurserna i nyckelvalvet.
get_certificate_policy(certificate_name: str, **kwargs) -> CertificatePolicyParametrar
Returer
Certifikatprincipen
Returtyp
Undantag
get_certificate_version
Hämtar en specifik version av ett certifikat utan att returnera dess hanteringsprincip.
Kräver certifikat/hämta behörighet. Om du vill hämta den senaste versionen av certifikatet eller för att hämta certifikatets princip anropar du get_certificate.
get_certificate_version(certificate_name: str, version: str, **kwargs) -> KeyVaultCertificateParametrar
Returer
En instans av KeyVaultCertificate
Returtyp
Undantag
om certifikatet inte finns,
för andra fel
get_contacts
Hämtar certifikatkontakterna för nyckelvalvet. Kräver behörigheten certifikat/managecontacts.
get_contacts(**kwargs) -> List[CertificateContact]Returer
Certifikatet kontaktar nyckelvalvet.
Returtyp
Undantag
get_deleted_certificate
Hämta ett borttaget certifikat. Endast möjligt i ett valv med mjuk borttagning aktiverat.
Kräver certifikat/hämta behörighet. Hämtar den borttagna certifikatinformationen plus dess attribut, till exempel kvarhållningsintervall, schemalagd permanent borttagning och den aktuella återställningsnivån för borttagning.
get_deleted_certificate(certificate_name: str, **kwargs) -> DeletedCertificateParametrar
Returer
Det borttagna certifikatet
Returtyp
Undantag
om certifikatet inte finns,
för andra fel
get_issuer
Hämtar den angivna certifikatutfärdaren. Kräver certifikat/manageissuers/getissuers-behörighet.
get_issuer(issuer_name: str, **kwargs) -> CertificateIssuerParametrar
Returer
Den angivna certifikatutfärdaren.
Returtyp
Undantag
om utfärdaren inte finns,
för andra fel
import_certificate
Importera ett certifikat som skapats externt. Kräver certifikat/importbehörighet.
Importerar ett befintligt giltigt certifikat som innehåller en privat nyckel till Azure Key Vault. Certifikatet som ska importeras kan vara i antingen PFX- eller PEM-format. Om certifikatet är i PEM-format måste PEM-filen innehålla nyckeln samt x509-certifikat, och du måste ange ett policy med content_type .pem
import_certificate(certificate_name: str, certificate_bytes: bytes, **kwargs) -> KeyVaultCertificateParametrar
- certificate_bytes
- bytes
Byte av certifikatobjektet som ska importeras. Det här certifikatet måste innehålla den privata nyckeln.
- enabled
- bool
Om certifikatet är aktiverat för användning.
- password
- str
Om den privata nyckeln i det skickade certifikatet är krypterad är det lösenordet som används för kryptering.
- policy
- CertificatePolicy
Hanteringsprincipen för certifikatet. Krävs om du importerar ett PEM-formatcertifikat med content_type värdet pem.
Returer
Importerad KeyVaultCertificate
Returtyp
Undantag
list_deleted_certificates
Visar en lista över borttagna certifikat som kan återställas. Endast möjligt om valvet är aktiverat för mjuk borttagning.
Kräver certifikat/hämta/listbehörighet. Hämtar certifikaten i det aktuella valvet som är i ett borttaget tillstånd och redo för återställning eller rensning. Den här åtgärden innehåller borttagningsspecifik information.
list_deleted_certificates(**kwargs) -> ItemPaged[DeletedCertificate]Parametrar
- include_pending
- bool
Anger om certifikat som inte tas bort ska tas bort helt. Endast tillgängligt för API-versioner v7.0 och senare.
Returer
En iteratorliknande instans av DeletedCertificate
Returtyp
Undantag
list_properties_of_certificate_versions
Visa en lista över identifierare och egenskaper för ett certifikats versioner.
Kräver certifikat/listbehörighet.
list_properties_of_certificate_versions(certificate_name: str, **kwargs) -> ItemPaged[CertificateProperties]Parametrar
Returer
En iteratorliknande instans av CertificateProperties
Returtyp
Undantag
list_properties_of_certificates
Lista identifierare och egenskaper för alla certifikat i valvet.
Kräver certifikat/listbehörighet.
list_properties_of_certificates(**kwargs) -> ItemPaged[CertificateProperties]Parametrar
- include_pending
- bool
Anger om certifikat som inte är helt etablerade ska tas med. Endast tillgängligt för API-versioner v7.0 och senare.
Returer
En iteratorliknande instans av CertificateProperties
Returtyp
Undantag
list_properties_of_issuers
Visar egenskaper för certifikatutfärdarna för nyckelvalvet.
Kräver behörigheten certificates/manageissuers/getissuers.
list_properties_of_issuers(**kwargs) -> ItemPaged[IssuerProperties]Returer
En iteratorliknande instans av utfärdare
Returtyp
Undantag
merge_certificate
Sammanfogar ett certifikat eller en certifikatkedja med ett nyckelpar som finns på servern.
Kräver behörigheten certifikat/skapa. Utför sammanslagning av ett certifikat eller en certifikatkedja med ett nyckelpar som för närvarande är tillgängligt i tjänsten. Se till att när du skapar certifikatet för sammanslagning med hjälp av begin_create_certificate att du ställer in utfärdaren på Okänd. På så sätt vet Key Vault att certifikatet inte kommer att signeras av en utfärdare som är känd för det.
merge_certificate(certificate_name: str, x509_certificates: List[bytes], **kwargs) -> KeyVaultCertificateParametrar
Returer
Det kopplade certifikatet
Returtyp
Undantag
purge_deleted_certificate
Tar bort ett borttaget certifikat permanent. Endast möjligt i valv med mjuk borttagning aktiverat.
Kräver certifikat/rensningsbehörighet. Utför en oåterkallelig borttagning av det angivna certifikatet, 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 ett certifikat före dess scheduled_purge_date.
purge_deleted_certificate(certificate_name: str, **kwargs) -> NoneParametrar
Returer
Ingen
Returtyp
Undantag
restore_certificate_backup
Återställ en säkerhetskopia av certifikatet till valvet. Kräver certifikat/återställningsbehörighet.
Detta återställer alla versioner av certifikatet med dess namn, attribut och åtkomstkontrollprinciper. Om certifikatets namn redan används misslyckas återställningen. Dessutom måste målvalvet ägas av samma Microsoft Azure-prenumeration som källvalvet.
restore_certificate_backup(backup: bytes, **kwargs) -> KeyVaultCertificateParametrar
Returer
Den återställde KeyVaultCertificate
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 certifikatet inte finns,
för andra fel
set_contacts
Anger certifikatkontakterna för nyckelvalvet. Kräver behörigheten certifikat/managecontacts.
set_contacts(contacts: List[CertificateContact], **kwargs) -> List[CertificateContact]Parametrar
Returer
Den skapade listan över kontakter
Returtyp
Undantag
update_certificate_policy
Uppdateringar principen för ett certifikat. Kräver certifikat/uppdateringsbehörighet.
Ange angivna medlemmar i certifikatprincipen. Lämnar andra som null.
update_certificate_policy(certificate_name: str, policy: CertificatePolicy, **kwargs) -> CertificatePolicyParametrar
Returer
Certifikatprincipen
Returtyp
Undantag
update_certificate_properties
Ändra egenskaperna för ett certifikat. Kräver certifikat/uppdateringsbehörighet.
update_certificate_properties(certificate_name: str, version: str | None = None, **kwargs) -> KeyVaultCertificateParametrar
- enabled
- bool
Om certifikatet är aktiverat för användning.
Returer
Den uppdaterade KeyVaultCertificate
Returtyp
Undantag
update_issuer
Uppdateringar den angivna certifikatutfärdaren. Kräver behörighet för certifikat/setissuers.
update_issuer(issuer_name: str, **kwargs) -> CertificateIssuerParametrar
- enabled
- bool
Om utfärdaren är aktiverad för användning.
- provider
- str
Utfärdarprovidern
- account_id
- str
Användarnamn/kontonamn/konto-ID.
- password
- str
Lösenordet/hemligheten/kontonyckeln.
- organization_id
- str
ID för organisationen
- admin_contacts
- list[AdministratorContact]
Kontaktuppgifter till certifikatutfärdarens organisationsadministratörer
Returer
Den uppdaterade utfärdaren
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