@azure/keyvault-certificates package

Referens

Klasser

Klienten som ska interagera med KeyVault-certifikatfunktionen

Gränssnitt

AdministratorContact	Information om certifikatutfärdarens organisationsadministratör.
BackupCertificateResult	Resultatet av säkerhetskopieringscertifikatet som innehåller säkerhetskopieringsbloben.
BeginCreateCertificateOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)
CertificateClientOptions	De valfria parametrarna som accepteras av KeyVaults CertificateClient
CertificateContactAll	Formen på kontaktinformationen för valvcertifikaten.
CertificateIssuer	Ett gränssnitt som representerar egenskaperna för en utfärdare.
CertificateOperation	En certifikatåtgärd returneras vid asynkrona begäranden.
CertificateOperationError	Nyckelvalvsserverfelet.
CertificateOperationState	Ett gränssnitt som representerar de offentligt tillgängliga egenskaperna för tillståndet för CertificateOperationPoller.
CertificatePolicyProperties	Ett gränssnitt som representerar ett certifikats princip (utan ämnesegenskaper).
CertificatePollerOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) och beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CertificateProperties	Ett gränssnitt som representerar egenskaperna för ett certifikat
CoreSubjectAlternativeNames	Alternativt namn på ett X509-objekt.
CreateCertificateOptions	Alternativ för <xref:createCertificate>.
CreateIssuerOptions	Alternativ för createIssuer(string, string, CreateIssuerOptions).
DeletedCertificate	Ett gränssnitt som representerar ett borttaget certifikat.
ErrorModel	Felmodellen för nyckelvalvets server.
ImportCertificateOptions	Alternativ för importCertificate(string, Uint8Array, ImportCertificateOptions).
IssuerAttributes	Attributen för en utfärdare som hanteras av Key Vault-tjänsten.
IssuerCredentials	De autentiseringsuppgifter som ska användas för certifikatutfärdaren.
IssuerParameters	Parametrar för utfärdaren av X509-komponenten för ett certifikat.
IssuerProperties	Ett gränssnitt som representerar egenskaperna för en certifikatutfärdare
KeyVaultCertificate	Ett gränssnitt som representerar ett certifikat utan certifikatets princip
KeyVaultCertificateIdentifier	Representerar de segment som utgör ett Key Vault certifikat-ID.
KeyVaultCertificatePollOperationState	Ett gränssnitt som representerar den offentliga formen av tillståndet för en Key Vault Certifikat poller åtgärder.
KeyVaultCertificateWithPolicy	Ett gränssnitt som representerar ett certifikat med dess princip
LifetimeAction	Åtgärd och dess utlösare som ska utföras av Key Vault under ett certifikats livslängd.
ListDeletedCertificatesOptions	Ett gränssnitt som representerar valfria parametrar för CertificateClient-sidåtgärder som skickas till listDeletedCertificates(ListDeletedCertificatesOptions).
ListPropertiesOfCertificatesOptions	Ett gränssnitt som representerar valfria parametrar för CertificateClient-sidåtgärder som skickas till listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).
PolicySubjectProperties	Ett gränssnitt som representerar de möjliga ämnesegenskaperna för ett certifikats princip. Den slutliga typen kräver att minst en av dessa egenskaper finns.
PollerLike	Abstrakt representation av en poller, avsedd att exponera bara det minimala API som användaren behöver arbeta med.
SubjectAlternativeNamesAll	Ett gränssnitt som representerar de alternativa namnen på ämnet för en certifikatprincip.
UpdateCertificateOptions	Alternativ för <xref:updateCertificate>.
UpdateIssuerOptions	Alternativ för updateIssuer(string, UpdateIssuerOptions).
X509CertificateProperties	Egenskaper för X509-komponenten för ett certifikat.

Typalias

ActionType	Definierar värden för ActionType.
ArrayOneOrMore	En matris med minst en egenskap.
BackupCertificateOptions	Alternativ för backupCertificate(string, OperationOptions).
BeginDeleteCertificateOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginDeleteCertificate(string, CertificatePollerOptions)
BeginRecoverDeletedCertificateOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CancelCertificateOperationOptions	Alternativ för <xref:cancelCertificateOperation>.
CertificateContact	Kontaktuppgifter för valvcertifikaten. Varje kontakt har minst en av egenskaperna för CertificateContactAll, som är: emailAddress, namn eller telefon.
CertificateContentType	Definierar värden för contentType. Möjliga värden är: "application/x-pem-file", "application/x-pkcs12"
CertificateKeyCurveName	Definierar värden för JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> kan användas utbytbart med JsonWebKeyCurveName, innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten P-256 P-384 P-521 P-256K
CertificateKeyType	Definierar värden för JsonWebKeyType. <xref:KnownJsonWebKeyType> kan användas utbytbart med JsonWebKeyType, innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten EC EC-HSM RSA RSA-HSM Oktober oct-HSM
CertificatePolicy	En typ som representerar ett certifikats princip med minst en av ämnesegenskaperna.
CertificatePolicyAction	Den åtgärd som ska utföras.
CertificateTags	Ett gränssnitt som representerar formen på certifikattaggar. Taggarna är bara strängnyckel/värde-par.
CreateCertificateState	Den offentliga representationen av åtgärdstillståndet CreateCertificatePoller.
DeleteCertificateOperationOptions	Alternativ för deleteCertificateOperation(string, OperationOptions).
DeleteCertificateState	Den offentliga representationen av åtgärdstillståndet DeleteCertificatePoller.
DeleteContactsOptions	Alternativ för deleteContacts(OperationOptions).
DeleteIssuerOptions	Alternativ för deleteIssuer(string, OperationOptions).
DeletionRecoveryLevel	Definierar värden för DeletionRecoveryLevel. <xref:KnownDeletionRecoveryLevel> kan användas utbytbart med DeletionRecoveryLevel innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Rensningsbar: Anger ett valvtillstånd där borttagning är en oåterkallelig åtgärd, utan möjlighet till återställning. Den här nivån motsvarar att inget skydd är tillgängligt mot en borttagningsåtgärd. data går oåterkalleligen förlorade när en borttagningsåtgärd accepteras på entitetsnivå eller högre (valv, resursgrupp, prenumeration osv.) Återställningsbar+rensningsbar: Anger ett valvtillstånd där borttagning kan återställas och som också tillåter omedelbar och permanent borttagning (t.ex. rensning). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet (90 dagar), såvida inte en rensningsåtgärd begärs eller prenumerationen avbryts. Systemet tar bort det permanent efter 90 dagar, om det inte återställs Återställningsbar: Anger ett valvtillstånd där borttagning kan återställas utan möjlighet till omedelbar och permanent borttagning (dvs. rensning). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet (90 dagar) och medan prenumerationen fortfarande är tillgänglig. Systemet tar bort det permanent efter 90 dagar, om det inte återställs Recoverable+ProtectedSubscription: Anger ett valv- och prenumerationstillstånd där borttagning kan återställas inom kvarhållningsintervallet (90 dagar), omedelbar och permanent borttagning (d.v.s. rensning) tillåts inte och där själva prenumerationen inte kan avbrytas permanent. Systemet tar bort det permanent efter 90 dagar, om det inte återställs CustomizedRecoverable+Purgeable: Anger ett valvtillstånd där borttagning kan återställas och som också tillåter omedelbar och permanent borttagning (dvs. rensa när 7<= SoftDeleteRetentionInDays < 90). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet, såvida inte en rensningsåtgärd begärs eller prenumerationen avbryts. CustomizedRecoverable: Anger ett valvtillstånd där borttagning kan återställas utan möjlighet till omedelbar och permanent borttagning (dvs. rensa när 7<= SoftDeleteRetentionInDays < 90). Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet och medan prenumerationen fortfarande är tillgänglig. CustomizedRecoverable+ProtectedSubscription: Anger ett valv- och prenumerationstillstånd där borttagningen kan återställas, omedelbar och permanent borttagning (dvs. rensning) tillåts inte och där själva prenumerationen inte kan avbrytas permanent när 7<= SoftDeleteRetentionInDays < 90. Den här nivån garanterar återställningen av den borttagna entiteten under kvarhållningsintervallet och återspeglar även det faktum att själva prenumerationen inte kan avbrytas.
GetCertificateOperationOptions	Alternativ för getCertificateOperation(string, CertificatePollerOptions).
GetCertificateOptions	Alternativ för getCertificate(string, OperationOptions).
GetCertificatePolicyOptions	Alternativ för getCertificatePolicy(string, OperationOptions).
GetCertificateVersionOptions	Alternativ för getCertificateVersion(string, string, OperationOptions).
GetContactsOptions	Alternativ för getContacts(OperationOptions).
GetDeletedCertificateOptions	Alternativ för getDeletedCertificate(string, OperationOptions).
GetIssuerOptions	Alternativ för getIssuer(string, OperationOptions).
GetPlainCertificateOperationOptions	Alternativ för <xref:getPlainCertificateOperation>.
ImportCertificatePolicy	En typ som representerar ett certifikats princip för import som inte kräver ett SAN eller ett ämne
KVPollerLike	Inaktuell KeyVault-kopia av Core-lros PollerLike.
KeyUsageType	Definierar värden för KeyUsageType. <xref:KnownKeyUsageType> kan användas utbytbart med KeyUsageType, innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten digitalSignature Oavvislighet keyEncipherment dataEncipherment keyAgreement keyCertSign cRLSign encipherOnly decipherOnly
ListPropertiesOfCertificateVersionsOptions	Ett gränssnitt som representerar valfria parametrar för CertificateClient-sidåtgärder som skickas till listPropertiesOfCertificateVersions(string, OperationOptions).
ListPropertiesOfIssuersOptions	Ett gränssnitt som representerar valfria parametrar för CertificateClient-sidåtgärder som skickas till listPropertiesOfIssuers(OperationOptions).
MergeCertificateOptions	Ett gränssnitt som representerar valfria parametrar för mergeCertificate(string, Uint8Array[], OperationOptions).
PurgeDeletedCertificateOptions	Alternativ för purgeDeletedCertificate(string, OperationOptions).
RecoverDeletedCertificateState	Inaktuell: Offentlig representation av återställningen av en borttagen certifikatavsökningsåtgärd
RequireAtLeastOne	RequireAtLeastOne hjälper dig att skapa en typ där minst en av egenskaperna för ett gränssnitt (kan vara vilken egenskap som helst) måste finnas. Detta fungerar på grund av TypeScripts verktygstyper: https://www.typescriptlang.org/docs/handbook/utility-types.html Nu ska vi undersöka det: `[K in keyof T]-?` den här egenskapen (K) är endast giltig om den har samma namn som någon egenskap för T. `Required<Pick<T, K>>` gör en ny typ från T med bara den aktuella egenskapen i iterationen och markerar den efter behov `Partial<Pick<T, Exclude<keyof T, K>>>` gör en ny typ med alla egenskaper för T, förutom från egenskapen K. `&` är det som förenar typen med endast en obligatorisk egenskap från `Required<...>` med alla valfria egenskaper från `Partial<...>`. `[keyof T]` säkerställer att endast egenskaper för T tillåts.
RestoreCertificateBackupOptions	Ett gränssnitt som representerar valfria parametrar för restoreCertificateBackup(Uint8Array, OperationOptions).
SetContactsOptions	Alternativ för setContacts(CertificateContact[], OperationOptions).
SubjectAlternativeNames	Alternativ till ämnesegenskapen. Om den finns bör den minst ha en av egenskaperna för SubjectAlternativeNamesAll.
UpdateCertificatePolicyOptions	Alternativ för updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

Uppräkningar

KnownCertificateKeyCurveNames	Kända värden för CertificateKeyCurveName som tjänsten accepterar.
KnownCertificateKeyTypes	Kända värden för CertificateKeyType som tjänsten accepterar.
KnownDeletionRecoveryLevels	Kända värden för DeletionRecoveryLevel som tjänsten accepterar.
KnownKeyUsageTypes	Kända värden för KeyUsageType som tjänsten accepterar.
WellKnownIssuer	Välkända utfärdare för att välja en standard

Funktioner

parseKeyVaultCertificateIdentifier(string)

Parsar angivet Key Vault certifikat-ID. Ett exempel är:

https://.vault.azure.net/certificates//

När du parsar ovanstående ID returnerar den här funktionen:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/certificates/<certificate-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<certificate-name>"
  }

Funktionsinformation

parseKeyVaultCertificateIdentifier(string)

Parsar angivet Key Vault certifikat-ID. Ett exempel är:

https://.vault.azure.net/certificates//

När du parsar ovanstående ID returnerar den här funktionen:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/certificates/<certificate-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<certificate-name>"
  }

function parseKeyVaultCertificateIdentifier(id: string): KeyVaultCertificateIdentifier

Parametrar

id: string

ID:t för Key Vault-certifikatet.

Returer

KeyVaultCertificateIdentifier

Dela via

@azure/keyvault-certificates package

Klasser

Gränssnitt

Typalias

Kända värden som stöds av tjänsten

Kända värden som stöds av tjänsten

Kända värden som stöds av tjänsten

Kända värden som stöds av tjänsten

Uppräkningar

Funktioner

Funktionsinformation

parseKeyVaultCertificateIdentifier(string)

Parametrar

Returer

Ytterligare resurser