Share via

@azure/keyvault-certificates package

  • Referentie

Klassen

CertificateClient

De client voor interactie met de functionaliteit van KeyVault-certificaten

Interfaces

AdministratorContact

Details van de organisatiebeheerder van de certificaatverlener.
BackupCertificateResult

Het resultaat van het back-upcertificaat, dat de back-up-blob bevat.
BeginCreateCertificateOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)
CertificateClientOptions

De optionele parameters die worden geaccepteerd door de CertificateClient van KeyVault
CertificateContactAll

De vorm van de contactgegevens voor de kluiscertificaten.
CertificateIssuer

Een interface die de eigenschappen van een verlener vertegenwoordigt.
CertificateOperation

Er wordt een certificaatbewerking geretourneerd in het geval van asynchrone aanvragen.
CertificateOperationError

De sleutelkluisserverfout.
CertificateOperationState

Een interface die de openbaar beschikbare eigenschappen van de status van de CertificateOperationPoller vertegenwoordigt.
CertificatePolicyProperties

Een interface die het beleid van een certificaat vertegenwoordigt (zonder de onderwerpeigenschappen).
CertificatePollerOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)en beginDeleteCertificate(string, CertificatePollerOptions)beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CertificateProperties

Een interface die de eigenschappen van een certificaat vertegenwoordigt
CoreSubjectAlternativeNames

De alternatieve onderwerpnamen van een X509-object.
CreateCertificateOptions

Opties voor <xref:createCertificate>.
CreateIssuerOptions

Opties voor createIssuer(string, string, CreateIssuerOptions).
DeletedCertificate

Een interface die een verwijderd certificaat vertegenwoordigt.
ErrorModel

Het foutmodel van de sleutelkluisserver.
ImportCertificateOptions

Opties voor importCertificate(string, Uint8Array, ImportCertificateOptions).
IssuerAttributes

De kenmerken van een verlener die wordt beheerd door de Key Vault-service.
IssuerCredentials

De referenties die moeten worden gebruikt voor de certificaatverlener.
IssuerParameters

Parameters voor de verlener van het X509-onderdeel van een certificaat.
IssuerProperties

Een interface die de eigenschappen van een certificaatverlener vertegenwoordigt
KeyVaultCertificate

Een interface die een certificaat vertegenwoordigt zonder het beleid van het certificaat
KeyVaultCertificateIdentifier

Vertegenwoordigt de segmenten waaruit een Key Vault Certificaat-id bestaat.
KeyVaultCertificatePollOperationState

Een interface die de openbare vorm vertegenwoordigt van de status van een Key Vault de bewerkingen van Certificate Poller.
KeyVaultCertificateWithPolicy

Een interface die een certificaat met het bijbehorende beleid vertegenwoordigt
LifetimeAction

De actie en de trigger die worden uitgevoerd door Key Vault gedurende de levensduur van een certificaat.
ListDeletedCertificatesOptions

Een interface die optionele parameters vertegenwoordigt voor Paged CertificateClient-bewerkingen die worden doorgegeven aan listDeletedCertificates(ListDeletedCertificatesOptions).
ListPropertiesOfCertificatesOptions

Een interface die optionele parameters vertegenwoordigt voor Paged CertificateClient-bewerkingen die worden doorgegeven aan listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).
PolicySubjectProperties

Een interface die de mogelijke onderwerpeigenschappen van het beleid van een certificaat vertegenwoordigt. Voor het uiteindelijke type moet ten minste één van deze eigenschappen bestaan.
PollerLike

Abstracte weergave van een poller, bedoeld om alleen de minimale API beschikbaar te maken waarmee de gebruiker moet werken.
SubjectAlternativeNamesAll

Een interface die de alternatieve namen van het onderwerp van een certificaatbeleid vertegenwoordigt.
UpdateCertificateOptions

Opties voor <xref:updateCertificate>.
UpdateIssuerOptions

Opties voor updateIssuer(string, UpdateIssuerOptions).
X509CertificateProperties

Eigenschappen van het X509-onderdeel van een certificaat.

Type-aliassen

ActionType

Definieert waarden voor ActionType.
ArrayOneOrMore

Een matrix met minimaal één eigenschap.
BackupCertificateOptions

Opties voor backupCertificate(string, OperationOptions).
BeginDeleteCertificateOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginDeleteCertificate(string, CertificatePollerOptions)
BeginRecoverDeletedCertificateOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CancelCertificateOperationOptions

Opties voor <xref:cancelCertificateOperation>.
CertificateContact

De contactgegevens voor de kluiscertificaten. Elke contactpersoon heeft ten minste één van de eigenschappen van CertificateContactAll, namelijk: emailAddress, name of phone.
CertificateContentType

Definieert waarden voor contentType. Mogelijke waarden zijn: 'application/x-pem-file', 'application/x-pkcs12'
CertificateKeyCurveName

Definieert waarden voor JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> kan door elkaar worden gebruikt met JsonWebKeyCurveName, deze opsomming bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

P-256
P-384
P-521
P-256K
CertificateKeyType

Definieert waarden voor JsonWebKeyType.
<xref:KnownJsonWebKeyType> kan door elkaar worden gebruikt met JsonWebKeyType. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

EC
EC-HSM
RSA
RSA-HSM
Oktober
oct-HSM
CertificatePolicy

Een type dat het beleid van een certificaat vertegenwoordigt met ten minste één van de onderwerpeigenschappen.
CertificatePolicyAction

De actie die wordt uitgevoerd.
CertificateTags

Een interface die de vorm van de certificaattags vertegenwoordigt. De tags zijn slechts tekenreekssleutel-waardeparen.
CreateCertificateState

De openbare weergave van de bewerkingsstatus CreateCertificatePoller.
DeleteCertificateOperationOptions

Opties voor deleteCertificateOperation(string, OperationOptions).
DeleteCertificateState

De openbare weergave van de bewerkingsstatus DeleteCertificatePoller.
DeleteContactsOptions

Opties voor deleteContacts(OperationOptions).
DeleteIssuerOptions

Opties voor deleteIssuer(string, OperationOptions).
DeletionRecoveryLevel

Definieert waarden voor DeletionRecoveryLevel.
<xref:KnownDeletionRecoveryLevel> kan door elkaar worden gebruikt met DeletionRecoveryLevel, deze opsomming bevat de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Opschonen: geeft een kluisstatus aan waarin het verwijderen een onomkeerbare bewerking is, zonder de mogelijkheid voor herstel. Dit niveau komt overeen met het feit dat er geen bescherming beschikbaar is tegen een Delete-bewerking; de gegevens gaan onherroepelijk verloren bij het accepteren van een Verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement, enzovoort)
Herstelbaar+opschonen: geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (d.w.w. opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval (90 dagen), tenzij een opschoonbewerking wordt aangevraagd of het abonnement wordt geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
Herstelbaar: geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (d.w.w. opschonen). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het bewaarinterval (90 dagen) en zolang het abonnement nog beschikbaar is. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
Recoverable+ProtectedSubscription: geeft een kluis- en abonnementsstatus aan waarin verwijdering kan worden hersteld binnen een bewaarperiode (90 dagen), directe en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd. Het systeem zal het na 90 dagen permanent verwijderen, indien niet hersteld
CustomizedRecoverable+Purgeable: geeft een kluisstatus aan waarin verwijdering kan worden hersteld en die ook onmiddellijke en permanente verwijdering toestaat (d.w.w. opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval, tenzij een opschoonbewerking wordt aangevraagd of het abonnement wordt geannuleerd.
CustomizedRecoverable: geeft een kluisstatus aan waarin verwijdering kan worden hersteld zonder de mogelijkheid tot onmiddellijke en permanente verwijdering (d.w.w. opschonen wanneer 7<= SoftDeleteRetentionInDays < 90). Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en zolang het abonnement nog steeds beschikbaar is.
CustomizedRecoverable+ProtectedSubscription: geeft een kluis- en abonnementsstatus aan waarin verwijdering herstelbaar is, directe en permanente verwijdering (dat wil zeggen opschonen) niet is toegestaan en waarin het abonnement zelf niet permanent kan worden geannuleerd wanneer 7<= SoftDeleteRetentionInDays < 90. Dit niveau garandeert de herstelbaarheid van de verwijderde entiteit tijdens het retentie-interval en weerspiegelt ook het feit dat het abonnement zelf niet kan worden geannuleerd.
GetCertificateOperationOptions

Opties voor getCertificateOperation(string, CertificatePollerOptions).
GetCertificateOptions

Opties voor getCertificate(string, OperationOptions).
GetCertificatePolicyOptions

Opties voor getCertificatePolicy(string, OperationOptions).
GetCertificateVersionOptions

Opties voor getCertificateVersion(string, string, OperationOptions).
GetContactsOptions

Opties voor getContacts(OperationOptions).
GetDeletedCertificateOptions

Opties voor getDeletedCertificate(string, OperationOptions).
GetIssuerOptions

Opties voor getIssuer(string, OperationOptions).
GetPlainCertificateOperationOptions

Opties voor <xref:getPlainCertificateOperation>.
ImportCertificatePolicy

Een type dat het beleid van een certificaat vertegenwoordigt voor importeren waarvoor geen SAN of een onderwerp is vereist
KVPollerLike

KeyVault-kopie van PollerLike van core-lro is afgeschaft.
KeyUsageType

Definieert waarden voor KeyUsageType.
<xref:KnownKeyUsageType> kan door elkaar worden gebruikt met KeyUsageType. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

digitalSignature
nonRepudiation
keyEncipherment
dataEncipherment
keyAgreement
keyCertSign
cRLSign
encipherOnly
decipherOnly
ListPropertiesOfCertificateVersionsOptions

Een interface die optionele parameters vertegenwoordigt voor Paged CertificateClient-bewerkingen die worden doorgegeven aan listPropertiesOfCertificateVersions(string, OperationOptions).
ListPropertiesOfIssuersOptions

Een interface die optionele parameters vertegenwoordigt voor Paged CertificateClient-bewerkingen die worden doorgegeven aan listPropertiesOfIssuers(OperationOptions).
MergeCertificateOptions

Een interface die optionele parameters voor vertegenwoordigt.mergeCertificate(string, Uint8Array[], OperationOptions)
PurgeDeletedCertificateOptions

Opties voor purgeDeletedCertificate(string, OperationOptions).
RecoverDeletedCertificateState

Afgeschaft: openbare weergave van het herstel van een verwijderde certificaat-pollbewerking
RequireAtLeastOne

Met RequireAtLeastOne kunt u een type maken waarbij ten minste één van de eigenschappen van een interface (kan een willekeurige eigenschap zijn) moet bestaan.

Dit werkt vanwege de typen hulpprogramma's van TypeScript: https://www.typescriptlang.org/docs/handbook/utility-types.html Laten we het eens bekijken:

  • [K in keyof T]-? deze eigenschap (K) is alleen geldig als deze dezelfde naam heeft als een eigenschap van T.
  • Required<Pick<T, K>> maakt een nieuw type van T met alleen de huidige eigenschap in de iteratie en markeert deze als vereist
  • Partial<Pick<T, Exclude<keyof T, K>>> maakt een nieuw type met alle eigenschappen van T, met uitzondering van de eigenschap K.
  • & is wat het type combineert met slechts één vereiste eigenschap van Required<...> met alle optionele eigenschappen van Partial<...>.
  • [keyof T] zorgt ervoor dat alleen eigenschappen van T zijn toegestaan.
RestoreCertificateBackupOptions

Een interface die optionele parameters voor vertegenwoordigt.restoreCertificateBackup(Uint8Array, OperationOptions)
SetContactsOptions

Opties voor setContacts(CertificateContact[], OperationOptions).
SubjectAlternativeNames

Alternatieven voor de onderwerpeigenschap. Indien aanwezig, moet deze ten minste een van de eigenschappen van SubjectAlternativeNamesAll hebben.
UpdateCertificatePolicyOptions

Opties voor updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

Enums

KnownCertificateKeyCurveNames

Bekende waarden van CertificateKeyCurveName die de service accepteert.
KnownCertificateKeyTypes

Bekende waarden van CertificateKeyType die de service accepteert.
KnownDeletionRecoveryLevels

Bekende waarden van DeletionRecoveryLevel die de service accepteert.
KnownKeyUsageTypes

Bekende waarden van KeyUsageType die de service accepteert.
WellKnownIssuer

Bekende verleners voor het kiezen van een standaardinstelling

Functies

parseKeyVaultCertificateIdentifier(string)

Parseert de opgegeven Key Vault certificaat-id. Een voorbeeld is:

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

Bij het parseren van de bovenstaande id retourneert deze functie:

  {
     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>"
  }

Functiedetails

parseKeyVaultCertificateIdentifier(string)

Parseert de opgegeven Key Vault certificaat-id. Een voorbeeld is:

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

Bij het parseren van de bovenstaande id retourneert deze functie:

  {
     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

Parameters

id

string

De id van het Key Vault-certificaat.

Retouren

KeyVaultCertificateIdentifier