@azure/keyvault-certificates package
Klassen
CertificateClient |
De client om te communiceren met de functionaliteit van KeyVault-certificaten |
Interfaces
AdministratorContact |
Details van de organisatiebeheerder van de certificaatverlener. |
BackupCertificateResult |
Het resultaat van het back-upcertificaat met de back-upblob. |
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 weergeeft. |
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 CertificateOperationPoller vertegenwoordigt. |
CertificatePolicyProperties |
Een interface die het beleid van een certificaat weergeeft (zonder de onderwerpeigenschappen). |
CertificatePollerOptions |
Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) en 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 key vault-server. |
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 weergeeft |
KeyVaultCertificate |
Een interface die een certificaat vertegenwoordigt zonder het beleid van het certificaat |
KeyVaultCertificateIdentifier |
Vertegenwoordigt de segmenten die een Key Vault-certificaat-id opstellen. |
KeyVaultCertificatePollOperationState |
Een interface die de openbare vorm van de status van de bewerkingen van een Key Vault-certificaatpeiling vertegenwoordigt. |
KeyVaultCertificateWithPolicy |
Een interface die een certificaat vertegenwoordigt met het bijbehorende beleid |
LifetimeAction |
Actie en de trigger die door Key Vault worden uitgevoerd gedurende de levensduur van een certificaat. |
ListDeletedCertificatesOptions |
Een interface die optionele parameters vertegenwoordigt voor paginabewerkingen van CertificateClient die worden doorgegeven aan listDeletedCertificates(ListDeletedCertificatesOptions). |
ListPropertiesOfCertificatesOptions |
Een interface die optionele parameters vertegenwoordigt voor paginabewerkingen van CertificateClient die worden doorgegeven aan listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions). |
PolicySubjectProperties |
Een interface die de mogelijke onderwerpeigenschappen van het beleid van een certificaat weergeeft. Voor het laatste type moet ten minste één van deze eigenschappen bestaan. |
PollerLike |
Abstracte weergave van een poller, bedoeld om alleen de minimale API weer te geven waarmee de gebruiker moet werken. |
PollerLikeWithCancellation |
Abstracte weergave van een poller, bedoeld om alleen de minimale API weer te geven 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 e-mailadres, naam of telefoon. |
CertificateContentType |
Definieert waarden voor contentType. Mogelijke waarden zijn: 'application/x-pem-file', 'application/x-pkcs12' |
CertificateKeyCurveName |
Definieert waarden voor JsonWebKeyCurveName. Bekende waarden die door de service worden ondersteund
P-256- |
CertificateKeyType |
Definieert waarden voor JsonWebKeyType. Bekende waarden die door de service worden ondersteund
EG- |
CertificatePolicy |
Een type dat het beleid van een certificaat weergeeft 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 alleen sleutel-waardeparen voor tekenreeksen. |
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. Bekende waarden die door de service worden ondersteund
verwijderbare: geeft een kluisstatus aan waarin verwijdering een ongedaanbare bewerking is, zonder de mogelijkheid voor herstel. Dit niveau komt overeen met geen beveiliging die beschikbaar is tegen een verwijderbewerking; de gegevens verloren gaan bij het accepteren van een verwijderbewerking op entiteitsniveau of hoger (kluis, resourcegroep, abonnement, enzovoort) |
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 onderwerp is vereist |
KVPollerLike |
Afgeschafte KeyVault-kopie van core-lro's PollerLike. |
KeyUsageType |
Definieert waarden voor KeyUsageType. Bekende waarden die door de service worden ondersteund
digitalSignature- |
ListPropertiesOfCertificateVersionsOptions |
Een interface die optionele parameters vertegenwoordigt voor paginabewerkingen van CertificateClient die worden doorgegeven aan listPropertiesOfCertificateVersions(string, OperationOptions). |
ListPropertiesOfIssuersOptions |
Een interface die optionele parameters vertegenwoordigt voor paginabewerkingen van CertificateClient die worden doorgegeven aan listPropertiesOfIssuers(OperationOptions). |
MergeCertificateOptions |
Een interface die optionele parameters voor mergeCertificate(string, Uint8Array[], OperationOptions)vertegenwoordigt. |
PurgeDeletedCertificateOptions |
Opties voor purgeDeletedCertificate(string, OperationOptions). |
RecoverDeletedCertificateState |
Afgeschaft: Openbare weergave van het herstel van een verwijderde certificaatpolingsbewerking |
RequireAtLeastOne |
RequireAtLeastOne helpt bij het maken van een type waarbij ten minste één van de eigenschappen van een interface (kan elke eigenschap zijn) moet bestaan. Dit werkt vanwege de hulpprogrammatypen van TypeScript: https://www.typescriptlang.org/docs/handbook/utility-types.html Laten we dit onderzoeken:
|
RestoreCertificateBackupOptions |
Een interface die optionele parameters voor restoreCertificateBackup(Uint8Array, OperationOptions)vertegenwoordigt. |
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
parse |
Parseert de opgegeven Key Vault-certificaat-id. Een voorbeeld hiervan is: https://.vault.azure.net/certificates// Bij het parseren van de bovenstaande id retourneert deze functie:
|
Functiedetails
parseKeyVaultCertificateIdentifier(string)
Parseert de opgegeven Key Vault-certificaat-id. Een voorbeeld hiervan 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.