Delen via

CertificateClient class

  • Referentie
Pakket:
@azure/keyvault-certificates

De client om te communiceren met de functionaliteit van KeyVault-certificaten

Constructors

CertificateClient(string, TokenCredential, CertificateClientOptions)

Hiermee maakt u een exemplaar van CertificateClient.

Eigenschappen

vaultUrl

De basis-URL naar de kluis

Methoden

backupCertificate(string, OperationOptions)

Hiermee wordt aangevraagd dat een back-up van het opgegeven certificaat naar de client wordt gedownload. Alle versies van het certificaat worden gedownload. Voor deze bewerking is de machtiging certificaten/back-up vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");

Hiermee wordt een back-up van een certificaat gegenereerd
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Hiermee maakt u een nieuw certificaat. Als dit de eerste versie is, wordt de certificaatresource gemaakt. Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat het certificaat volledig is hersteld.

Opmerking: verzenden Self als de issuerName van het certificaatbeleid een zelfondertekend certificaat maakt.

Voor deze bewerking is de machtiging certificaten/maken vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert"
};
const createPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy);

// The pending certificate can be obtained by calling the following method:
const pendingCertificate = createPoller.getResult();

// Serializing the poller
const serialized = createPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy, { resumeFrom: serialized });

// Waiting until it's done
const certificate = await createPoller.pollUntilDone();
console.log(certificate);

Een certificaat maken
beginDeleteCertificate(string, CertificatePollerOptions)

De DELETE-bewerking is van toepassing op elk certificaat dat is opgeslagen in Azure Key Vault. DELETE kan niet worden toegepast op een afzonderlijke versie van een certificaat. Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat het certificaat volledig is hersteld.

Voor deze bewerking is de machtiging certificaten/verwijderen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await createPoller.pollUntilDone();

const deletePoller = await client.beginDeleteCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const deletedCertificate = await deletePoller.pollUntilDone();
console.log(deletedCertificate);

Hiermee verwijdert u een certificaat uit een opgegeven sleutelkluis.
beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Hiermee herstelt u het verwijderde certificaat in de opgegeven kluis. Deze bewerking kan alleen worden uitgevoerd op een kluis met voorlopig verwijderen. Deze bewerking Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat het certificaat volledig is hersteld.

Voor deze bewerking is de machtiging certificaten/herstellen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);

const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const certificate = await recoverPoller.pollUntilDone();
console.log(certificate);

Een verwijderd certificaat herstellen
createIssuer(string, string, CreateIssuerOptions)

Met de bewerking createIssuer wordt de opgegeven certificaatverlener toegevoegd of bijgewerkt. Voor deze bewerking is de machtiging certificaten/setissuers vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");

Hiermee stelt u de opgegeven certificaatverlener in.
deleteCertificateOperation(string, OperationOptions)

Hiermee verwijdert u de aanmaakbewerking voor een opgegeven certificaat dat wordt gemaakt. Het certificaat wordt niet meer gemaakt. Voor deze bewerking is de machtiging certificaten/bijwerken vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await client.deleteCertificateOperation("MyCertificate");
await client.getCertificateOperation("MyCertificate"); // Throws error: Pending certificate not found: "MyCertificate"

De bewerking van een certificaat verwijderen
deleteContacts(OperationOptions)

Hiermee verwijdert u alle certificaatcontactpersonen. Voor deze bewerking is de machtiging certificaten/managecontacts vereist.

Voorbeeldgebruik:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
await client.deleteContacts();

Alle certificaatcontactpersonen verwijderen
deleteIssuer(string, OperationOptions)

Met de deleteIssuer-bewerking wordt de opgegeven certificaatverlener definitief uit de kluis verwijderd. Voor deze bewerking is de machtiging certificaten/manageissuers/deleteissuers vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Provider");
await client.deleteIssuer("IssuerName");

Hiermee verwijdert u de opgegeven certificaatverlener.
getCertificate(string, OperationOptions)

Haalt de meest recente informatie op die beschikbaar is op basis van een specifiek certificaat, inclusief het beleid van het certificaat. Voor deze bewerking zijn de certificaten/machtigingen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificate = await client.getCertificate("MyCertificate");
console.log(certificate);

Haalt een certificaat op uit de naam van het certificaat (inclusief het certificaatbeleid)
getCertificateOperation(string, CertificatePollerOptions)

Hiermee haalt u de aanmaakbewerking op die is gekoppeld aan een opgegeven certificaat. Voor deze bewerking zijn de certificaten/machtigingen vereist. Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat het certificaat volledig is hersteld.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

const poller = await client.getCertificateOperation("MyCertificate");
const pendingCertificate = poller.getResult();

const certificateOperation = poller.getOperationState().certificateOperation;
console.log(certificateOperation);

Hiermee haalt u de pollerbewerking van een certificaat op
getCertificatePolicy(string, OperationOptions)

De bewerking getCertificatePolicy retourneert de opgegeven certificaatbeleidsbronnen in de opgegeven sleutelkluis. Voor deze bewerking zijn de certificaten/machtigingen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const policy = await client.getCertificatePolicy("MyCertificate");
console.log(policy);

Hiermee haalt u het beleid van een certificaat op
getCertificateVersion(string, string, OperationOptions)

Hiermee wordt informatie opgehaald over een specifiek certificaat voor een specifieke versie. Het certificaatbeleid wordt niet geretourneerd. Voor deze bewerking zijn de certificaten/machtigingen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificateWithPolicy = await client.getCertificate("MyCertificate");
const certificate = await client.getCertificateVersion("MyCertificate", certificateWithPolicy.properties.version!);
console.log(certificate);

Haalt een certificaat op uit de naam van het certificaat en een opgegeven versie
getContacts(OperationOptions)

Retourneert de set resources voor certificaatcontactpersoon in de opgegeven sleutelkluis. Voor deze bewerking is de machtiging certificaten/managecontacts vereist.

Voorbeeldgebruik:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
const contacts = await client.getContacts();
console.log(contacts);

Hiermee stelt u de certificaatcontactpersonen in.
getDeletedCertificate(string, OperationOptions)

haalt de gegevens van het verwijderde certificaat op plus de kenmerken, zoals het bewaarinterval, geplande permanente verwijdering en het huidige herstelniveau voor verwijdering. Voor deze bewerking zijn de certificaten/machtigingen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
const deletedCertificate = await client.getDeletedCertificate("MyDeletedCertificate");
console.log("Deleted certificate:", deletedCertificate);

Hiermee haalt u een verwijderd certificaat op
getIssuer(string, OperationOptions)

De getIssuer-bewerking retourneert de opgegeven bronnen voor certificaatverleners in de opgegeven sleutelkluis. Voor deze bewerking zijn de machtigingen voor certificaten/manageissuers/getissuers vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
const certificateIssuer = await client.getIssuer("IssuerName");
console.log(certificateIssuer);

Hiermee haalt u de opgegeven certificaatverlener op.
importCertificate(string, Uint8Array, ImportCertificateOptions)

Hiermee importeert u een bestaand geldig certificaat met een persoonlijke sleutel in Azure Key Vault. Het certificaat dat moet worden geïmporteerd, kan een PFX- of PEM-indeling hebben. Als het certificaat de PEM-indeling heeft, moet het PEM-bestand de sleutel en x509-certificaten bevatten. Voor deze bewerking is de machtiging certificaten/importeren vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
// See: @azure/keyvault-secrets
const certificateSecret = await secretClient.getSecret("MyCertificate");
const base64EncodedCertificate = certificateSecret.value!;
let buffer: Uint8Array;

if (isNode) {
  buffer = Buffer.from(base64EncodedCertificate, "base64");
} else {
  buffer = Uint8Array.from(atob(base64EncodedCertificate), (c) => c.charCodeAt(0));
}

await client.importCertificate("MyCertificate", buffer);

Een certificaat importeren uit de geheime waarde van een certificaat
listDeletedCertificates(ListDeletedCertificatesOptions)

Haalt de certificaten op in de huidige kluis die zich in een verwijderde status bevinden en klaar zijn voor herstel of opschonen. Deze bewerking bevat verwijderingsspecifieke informatie. Voor deze bewerking is de machtiging certificaten/ophalen/weergeven vereist. Deze bewerking kan alleen worden ingeschakeld voor kluizen met voorlopig verwijderen.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
for await (const deletedCertificate of client.listDeletedCertificates()) {
  console.log(deletedCertificate);
}
for await (const page of client.listDeletedCertificates().byPage()) {
  for (const deletedCertificate of page) {
    console.log(deletedCertificate);
  }
}

Lijsten met verwijderde certificaten
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Hiermee wordt de nieuwste versie van alle certificaten in de kluis herhaald. De volledige certificaat-id en -kenmerken worden opgegeven in het antwoord. Er worden geen waarden geretourneerd voor de certificaten. Voor deze bewerkingen is de machtiging certificaten/lijsten vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
// All in one call
for await (const certificateProperties of client.listPropertiesOfCertificates()) {
  console.log(certificateProperties);
}
// By pages
for await (const page of client.listPropertiesOfCertificates().byPage()) {
  for (const certificateProperties of page) {
    console.log(certificateProperties);
  }
}

Geef alle versies van het opgegeven certificaat weer.
listPropertiesOfCertificateVersions(string, OperationOptions)

Retourneert de versies van een certificaat in de opgegeven sleutelkluis. Voor deze bewerking is de machtiging certificaten/lijst vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
for await (const certificateProperties of client.listPropertiesOfCertificateVersions("MyCertificate")) {
  console.log(certificateProperties.version!);
}

Geef de versies van een certificaat weer.
listPropertiesOfIssuers(OperationOptions)

Retourneert de set resources van certificaatverleners in de opgegeven sleutelkluis. Voor deze bewerking zijn de machtigingen voor certificaten/manageissuers/getissuers vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
// All in one call
for await (const issuerProperties of client.listPropertiesOfIssuers()) {
  console.log(issuerProperties);
}
// By pages
for await (const page of client.listPropertiesOfIssuers().byPage()) {
  for (const issuerProperties of page) {
    console.log(issuerProperties);
  }
}

Geef de certificaatverleners weer.
mergeCertificate(string, Uint8Array[], OperationOptions)

Voert het samenvoegen van een certificaat of certificaatketen uit met een sleutelpaar dat momenteel beschikbaar is in de service. Voor deze bewerking is de machtiging certificaten/maken vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Unknown",
  subject: "cn=MyCert"
});
const poller = await client.getCertificateOperation("MyCertificate");
const { csr } = poller.getOperationState().certificateOperation!;
const base64Csr = Buffer.from(csr!).toString("base64");
const wrappedCsr = ["-----BEGIN CERTIFICATE REQUEST-----", base64Csr, "-----END CERTIFICATE REQUEST-----"].join("\n");

const fs = require("fs");
fs.writeFileSync("test.csr", wrappedCsr);

// Certificate available locally made using:
//   openssl genrsa -out ca.key 2048
//   openssl req -new -x509 -key ca.key -out ca.crt
// You can read more about how to create a fake certificate authority here: https://gist.github.com/Soarez/9688998

const childProcess = require("child_process");
childProcess.execSync("openssl x509 -req -in test.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out test.crt");
const base64Crt = fs.readFileSync("test.crt").toString().split("\n").slice(1, -1).join("");

await client.mergeCertificate("MyCertificate", [Buffer.from(base64Crt)]);

Hiermee wordt een ondertekende certificaataanvraag samengevoegd in een in behandeling zijnde certificaat
purgeDeletedCertificate(string, OperationOptions)

Voert een onherstelbare verwijdering van het opgegeven certificaat uit, zonder mogelijkheid voor herstel. De bewerking is niet beschikbaar als het herstelniveau niet 'Leegmaken' opgeeft. Voor deze bewerking is de machtiging voor het certificaat/opschonen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();
// Deleting a certificate takes time, make sure to wait before purging it
client.purgeDeletedCertificate("MyCertificate");

Hiermee haalt u een verwijderd certificaat op
restoreCertificateBackup(Uint8Array, OperationOptions)

Hiermee herstelt u een back-up van een certificaat en alle bijbehorende versies naar een kluis. Voor deze bewerking is de machtiging certificaten/herstellen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");
const poller = await client.beginDeleteCertificate("MyCertificate");
await poller.pollUntilDone();
// Some time is required before we're able to restore the certificate
await client.restoreCertificateBackup(backup!);

Hiermee herstelt u een certificaat vanuit een back-up
setContacts(CertificateContact[], OperationOptions)

Hiermee stelt u de certificaatcontactpersonen voor de sleutelkluis in. Voor deze bewerking is de machtiging certificaten/managecontacts vereist.

Voorbeeldgebruik:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);

Hiermee stelt u de certificaatcontactpersonen in.
updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Werkt het certificaatbeleid voor het opgegeven certificaat bij. Voor deze bewerking is de machtiging certificaten/bijwerken vereist. Hiermee haalt u het beleid van een certificaat op
updateCertificateProperties(string, string, UpdateCertificatePropertiesOptions)

De opgegeven update op het opgegeven certificaat wordt toegepast; de enige elementen die zijn bijgewerkt, zijn de kenmerken van het certificaat. Voor deze bewerking is de machtiging certificaten/bijwerken vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

// You may pass an empty string for version which will update
// the latest version of the certificate
await client.updateCertificateProperties("MyCertificate", "", {
  tags: {
    customTag: "value"
  }
});

Een certificaat bijwerken
updateIssuer(string, UpdateIssuerOptions)

De updateIssuer-bewerking voert een update uit op de opgegeven entiteit voor certificaatverleners. Voor deze bewerking is de machtiging certificaten/setissuers vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
await client.updateIssuer("IssuerName", {
  provider: "Provider2"
});

Hiermee werkt u de opgegeven certificaatverlener bij.

Constructordetails

CertificateClient(string, TokenCredential, CertificateClientOptions)

Hiermee maakt u een exemplaar van CertificateClient.

new CertificateClient(vaultUrl: string, credential: TokenCredential, clientOptions?: CertificateClientOptions)

Parameters

vaultUrl

string

de basis-URL naar de kluis. Controleer of deze URL verwijst naar een geldige Key Vault-resource. Zie https://aka.ms/azsdk/blog/vault-uri voor meer informatie.

credential
TokenCredential

Een object dat de TokenCredential-interface implementeert die wordt gebruikt voor het verifiëren van aanvragen voor de service. Gebruik het @azure/identity-pakket om een referentie te maken die aan uw behoeften voldoet.

clientOptions
CertificateClientOptions

Pijplijnopties die worden gebruikt voor het configureren van Key Vault-API-aanvragen. Laat deze parameter weg om de standaardpijplijnconfiguratie te gebruiken.

Eigenschapdetails

vaultUrl

De basis-URL naar de kluis

vaultUrl: string

Waarde van eigenschap

string

Methodedetails

backupCertificate(string, OperationOptions)

Hiermee wordt aangevraagd dat een back-up van het opgegeven certificaat naar de client wordt gedownload. Alle versies van het certificaat worden gedownload. Voor deze bewerking is de machtiging certificaten/back-up vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");

Hiermee wordt een back-up van een certificaat gegenereerd

function backupCertificate(certificateName: string, options?: OperationOptions): Promise<undefined | Uint8Array>

Parameters

certificateName

string

De naam van het certificaat

options
OperationOptions

De optionele parameters

Retouren

Promise<undefined | Uint8Array>

beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Hiermee maakt u een nieuw certificaat. Als dit de eerste versie is, wordt de certificaatresource gemaakt. Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat het certificaat volledig is hersteld.

Opmerking: verzenden Self als de issuerName van het certificaatbeleid een zelfondertekend certificaat maakt.

Voor deze bewerking is de machtiging certificaten/maken vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert"
};
const createPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy);

// The pending certificate can be obtained by calling the following method:
const pendingCertificate = createPoller.getResult();

// Serializing the poller
const serialized = createPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginCreateCertificate("MyCertificate", certificatePolicy, { resumeFrom: serialized });

// Waiting until it's done
const certificate = await createPoller.pollUntilDone();
console.log(certificate);

Een certificaat maken

function beginCreateCertificate(certificateName: string, policy: CertificatePolicy, options?: BeginCreateCertificateOptions): Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

Parameters

certificateName

string

De naam van het certificaat

policy
CertificatePolicy
options
BeginCreateCertificateOptions

Optionele parameters

Retouren

Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

beginDeleteCertificate(string, CertificatePollerOptions)

De DELETE-bewerking is van toepassing op elk certificaat dat is opgeslagen in Azure Key Vault. DELETE kan niet worden toegepast op een afzonderlijke versie van een certificaat. Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat het certificaat volledig is hersteld.

Voor deze bewerking is de machtiging certificaten/verwijderen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await createPoller.pollUntilDone();

const deletePoller = await client.beginDeleteCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const deletedCertificate = await deletePoller.pollUntilDone();
console.log(deletedCertificate);

Hiermee verwijdert u een certificaat uit een opgegeven sleutelkluis.

function beginDeleteCertificate(certificateName: string, options?: CertificatePollerOptions): Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

Parameters

certificateName

string

De naam van het certificaat.

options
CertificatePollerOptions

De optionele parameters

Retouren

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Hiermee herstelt u het verwijderde certificaat in de opgegeven kluis. Deze bewerking kan alleen worden uitgevoerd op een kluis met voorlopig verwijderen. Deze bewerking Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat het certificaat volledig is hersteld.

Voor deze bewerking is de machtiging certificaten/herstellen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);

const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedCertificate("MyCertificate");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedCertificate("MyCertificate", { resumeFrom: serialized });

// Waiting until it's done
const certificate = await recoverPoller.pollUntilDone();
console.log(certificate);

Een verwijderd certificaat herstellen

function beginRecoverDeletedCertificate(certificateName: string, options?: CertificatePollerOptions): Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

Parameters

certificateName

string

De naam van het verwijderde certificaat

options
CertificatePollerOptions

De optionele parameters

Retouren

Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

createIssuer(string, string, CreateIssuerOptions)

Met de bewerking createIssuer wordt de opgegeven certificaatverlener toegevoegd of bijgewerkt. Voor deze bewerking is de machtiging certificaten/setissuers vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");

Hiermee stelt u de opgegeven certificaatverlener in.

function createIssuer(issuerName: string, provider: string, options?: CreateIssuerOptions): Promise<CertificateIssuer>

Parameters

issuerName

string

De naam van de uitgever.

provider

string

De provider van de uitgever.

options
CreateIssuerOptions

De optionele parameters

Retouren

Promise<CertificateIssuer>

deleteCertificateOperation(string, OperationOptions)

Hiermee verwijdert u de aanmaakbewerking voor een opgegeven certificaat dat wordt gemaakt. Het certificaat wordt niet meer gemaakt. Voor deze bewerking is de machtiging certificaten/bijwerken vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await client.deleteCertificateOperation("MyCertificate");
await client.getCertificateOperation("MyCertificate"); // Throws error: Pending certificate not found: "MyCertificate"

De bewerking van een certificaat verwijderen

function deleteCertificateOperation(certificateName: string, options?: OperationOptions): Promise<CertificateOperation>

Parameters

certificateName

string

De naam van het certificaat

options
OperationOptions

De optionele parameters

Retouren

Promise<CertificateOperation>

deleteContacts(OperationOptions)

Hiermee verwijdert u alle certificaatcontactpersonen. Voor deze bewerking is de machtiging certificaten/managecontacts vereist.

Voorbeeldgebruik:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
await client.deleteContacts();

Alle certificaatcontactpersonen verwijderen

function deleteContacts(options?: OperationOptions): Promise<undefined | CertificateContact[]>

Parameters

options
OperationOptions

De optionele parameters

Retouren

Promise<undefined | CertificateContact[]>

deleteIssuer(string, OperationOptions)

Met de deleteIssuer-bewerking wordt de opgegeven certificaatverlener definitief uit de kluis verwijderd. Voor deze bewerking is de machtiging certificaten/manageissuers/deleteissuers vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Provider");
await client.deleteIssuer("IssuerName");

Hiermee verwijdert u de opgegeven certificaatverlener.

function deleteIssuer(issuerName: string, options?: OperationOptions): Promise<CertificateIssuer>

Parameters

issuerName

string

De naam van de uitgever.

options
OperationOptions

De optionele parameters

Retouren

Promise<CertificateIssuer>

getCertificate(string, OperationOptions)

Haalt de meest recente informatie op die beschikbaar is op basis van een specifiek certificaat, inclusief het beleid van het certificaat. Voor deze bewerking zijn de certificaten/machtigingen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificate = await client.getCertificate("MyCertificate");
console.log(certificate);

Haalt een certificaat op uit de naam van het certificaat (inclusief het certificaatbeleid)

function getCertificate(certificateName: string, options?: OperationOptions): Promise<KeyVaultCertificateWithPolicy>

Parameters

certificateName

string

De naam van het certificaat

options
OperationOptions

De optionele parameters

Retouren

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, CertificatePollerOptions)

Hiermee haalt u de aanmaakbewerking op die is gekoppeld aan een opgegeven certificaat. Voor deze bewerking zijn de certificaten/machtigingen vereist. Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat het certificaat volledig is hersteld.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
const createPoller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

const poller = await client.getCertificateOperation("MyCertificate");
const pendingCertificate = poller.getResult();

const certificateOperation = poller.getOperationState().certificateOperation;
console.log(certificateOperation);

Hiermee haalt u de pollerbewerking van een certificaat op

function getCertificateOperation(certificateName: string, options?: CertificatePollerOptions): Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

Parameters

certificateName

string

De naam van het certificaat

options
CertificatePollerOptions

De optionele parameters

Retouren

Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

getCertificatePolicy(string, OperationOptions)

De bewerking getCertificatePolicy retourneert de opgegeven certificaatbeleidsbronnen in de opgegeven sleutelkluis. Voor deze bewerking zijn de certificaten/machtigingen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const policy = await client.getCertificatePolicy("MyCertificate");
console.log(policy);

Hiermee haalt u het beleid van een certificaat op

function getCertificatePolicy(certificateName: string, options?: OperationOptions): Promise<CertificatePolicy>

Parameters

certificateName

string

De naam van het certificaat

options
OperationOptions

De optionele parameters

Retouren

Promise<CertificatePolicy>

getCertificateVersion(string, string, OperationOptions)

Hiermee wordt informatie opgehaald over een specifiek certificaat voor een specifieke versie. Het certificaatbeleid wordt niet geretourneerd. Voor deze bewerking zijn de certificaten/machtigingen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
const poller = await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
await poller.pollUntilDone();
const certificateWithPolicy = await client.getCertificate("MyCertificate");
const certificate = await client.getCertificateVersion("MyCertificate", certificateWithPolicy.properties.version!);
console.log(certificate);

Haalt een certificaat op uit de naam van het certificaat en een opgegeven versie

function getCertificateVersion(certificateName: string, version: string, options?: OperationOptions): Promise<KeyVaultCertificate>

Parameters

certificateName

string

De naam van het certificaat

version

string

De specifieke versie van het certificaat

options
OperationOptions

De optionele parameters

Retouren

Promise<KeyVaultCertificate>

getContacts(OperationOptions)

Retourneert de set resources voor certificaatcontactpersoon in de opgegeven sleutelkluis. Voor deze bewerking is de machtiging certificaten/managecontacts vereist.

Voorbeeldgebruik:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);
const contacts = await client.getContacts();
console.log(contacts);

Hiermee stelt u de certificaatcontactpersonen in.

function getContacts(options?: OperationOptions): Promise<undefined | CertificateContact[]>

Parameters

options
OperationOptions

De optionele parameters

Retouren

Promise<undefined | CertificateContact[]>

getDeletedCertificate(string, OperationOptions)

haalt de gegevens van het verwijderde certificaat op plus de kenmerken, zoals het bewaarinterval, geplande permanente verwijdering en het huidige herstelniveau voor verwijdering. Voor deze bewerking zijn de certificaten/machtigingen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
const deletedCertificate = await client.getDeletedCertificate("MyDeletedCertificate");
console.log("Deleted certificate:", deletedCertificate);

Hiermee haalt u een verwijderd certificaat op

function getDeletedCertificate(certificateName: string, options?: OperationOptions): Promise<DeletedCertificate>

Parameters

certificateName

string

De naam van het certificaat

options
OperationOptions

De optionele parameters

Retouren

Promise<DeletedCertificate>

getIssuer(string, OperationOptions)

De getIssuer-bewerking retourneert de opgegeven bronnen voor certificaatverleners in de opgegeven sleutelkluis. Voor deze bewerking zijn de machtigingen voor certificaten/manageissuers/getissuers vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
const certificateIssuer = await client.getIssuer("IssuerName");
console.log(certificateIssuer);

Hiermee haalt u de opgegeven certificaatverlener op.

function getIssuer(issuerName: string, options?: OperationOptions): Promise<CertificateIssuer>

Parameters

issuerName

string

De naam van de uitgever.

options
OperationOptions

De optionele parameters

Retouren

Promise<CertificateIssuer>

importCertificate(string, Uint8Array, ImportCertificateOptions)

Hiermee importeert u een bestaand geldig certificaat met een persoonlijke sleutel in Azure Key Vault. Het certificaat dat moet worden geïmporteerd, kan een PFX- of PEM-indeling hebben. Als het certificaat de PEM-indeling heeft, moet het PEM-bestand de sleutel en x509-certificaten bevatten. Voor deze bewerking is de machtiging certificaten/importeren vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
// See: @azure/keyvault-secrets
const certificateSecret = await secretClient.getSecret("MyCertificate");
const base64EncodedCertificate = certificateSecret.value!;
let buffer: Uint8Array;

if (isNode) {
  buffer = Buffer.from(base64EncodedCertificate, "base64");
} else {
  buffer = Uint8Array.from(atob(base64EncodedCertificate), (c) => c.charCodeAt(0));
}

await client.importCertificate("MyCertificate", buffer);

Een certificaat importeren uit de geheime waarde van een certificaat

function importCertificate(certificateName: string, certificateBytes: Uint8Array, options?: ImportCertificateOptions): Promise<KeyVaultCertificateWithPolicy>

Parameters

certificateName

string

De naam van het certificaat

certificateBytes

Uint8Array

De pfx- of ASCII PEM-indelingswaarde van het certificaat met zowel de X.509-certificaten als de persoonlijke sleutel

options
ImportCertificateOptions

De optionele parameters

Retouren

Promise<KeyVaultCertificateWithPolicy>

listDeletedCertificates(ListDeletedCertificatesOptions)

Haalt de certificaten op in de huidige kluis die zich in een verwijderde status bevinden en klaar zijn voor herstel of opschonen. Deze bewerking bevat verwijderingsspecifieke informatie. Voor deze bewerking is de machtiging certificaten/ophalen/weergeven vereist. Deze bewerking kan alleen worden ingeschakeld voor kluizen met voorlopig verwijderen.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
for await (const deletedCertificate of client.listDeletedCertificates()) {
  console.log(deletedCertificate);
}
for await (const page of client.listDeletedCertificates().byPage()) {
  for (const deletedCertificate of page) {
    console.log(deletedCertificate);
  }
}

Lijsten met verwijderde certificaten

function listDeletedCertificates(options?: ListDeletedCertificatesOptions): PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

Parameters

options
ListDeletedCertificatesOptions

De optionele parameters

Retouren

PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Hiermee wordt de nieuwste versie van alle certificaten in de kluis herhaald. De volledige certificaat-id en -kenmerken worden opgegeven in het antwoord. Er worden geen waarden geretourneerd voor de certificaten. Voor deze bewerkingen is de machtiging certificaten/lijsten vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
// All in one call
for await (const certificateProperties of client.listPropertiesOfCertificates()) {
  console.log(certificateProperties);
}
// By pages
for await (const page of client.listPropertiesOfCertificates().byPage()) {
  for (const certificateProperties of page) {
    console.log(certificateProperties);
  }
}

Geef alle versies van het opgegeven certificaat weer.

function listPropertiesOfCertificates(options?: ListPropertiesOfCertificatesOptions): PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

Parameters

options
ListPropertiesOfCertificatesOptions

De optionele parameters

Retouren

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfCertificateVersions(string, OperationOptions)

Retourneert de versies van een certificaat in de opgegeven sleutelkluis. Voor deze bewerking is de machtiging certificaten/lijst vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
for await (const certificateProperties of client.listPropertiesOfCertificateVersions("MyCertificate")) {
  console.log(certificateProperties.version!);
}

Geef de versies van een certificaat weer.

function listPropertiesOfCertificateVersions(certificateName: string, options?: OperationOptions): PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

Parameters

certificateName

string

De naam van het certificaat.

options
OperationOptions

De optionele parameters

Retouren

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfIssuers(OperationOptions)

Retourneert de set resources van certificaatverleners in de opgegeven sleutelkluis. Voor deze bewerking zijn de machtigingen voor certificaten/manageissuers/getissuers vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
// All in one call
for await (const issuerProperties of client.listPropertiesOfIssuers()) {
  console.log(issuerProperties);
}
// By pages
for await (const page of client.listPropertiesOfIssuers().byPage()) {
  for (const issuerProperties of page) {
    console.log(issuerProperties);
  }
}

Geef de certificaatverleners weer.

function listPropertiesOfIssuers(options?: OperationOptions): PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

Parameters

options
OperationOptions

De optionele parameters

Retouren

PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

mergeCertificate(string, Uint8Array[], OperationOptions)

Voert het samenvoegen van een certificaat of certificaatketen uit met een sleutelpaar dat momenteel beschikbaar is in de service. Voor deze bewerking is de machtiging certificaten/maken vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Unknown",
  subject: "cn=MyCert"
});
const poller = await client.getCertificateOperation("MyCertificate");
const { csr } = poller.getOperationState().certificateOperation!;
const base64Csr = Buffer.from(csr!).toString("base64");
const wrappedCsr = ["-----BEGIN CERTIFICATE REQUEST-----", base64Csr, "-----END CERTIFICATE REQUEST-----"].join("\n");

const fs = require("fs");
fs.writeFileSync("test.csr", wrappedCsr);

// Certificate available locally made using:
//   openssl genrsa -out ca.key 2048
//   openssl req -new -x509 -key ca.key -out ca.crt
// You can read more about how to create a fake certificate authority here: https://gist.github.com/Soarez/9688998

const childProcess = require("child_process");
childProcess.execSync("openssl x509 -req -in test.csr -CA ca.crt -CAkey ca.key -CAcreateserial -out test.crt");
const base64Crt = fs.readFileSync("test.crt").toString().split("\n").slice(1, -1).join("");

await client.mergeCertificate("MyCertificate", [Buffer.from(base64Crt)]);

Hiermee wordt een ondertekende certificaataanvraag samengevoegd in een in behandeling zijnde certificaat

function mergeCertificate(certificateName: string, x509Certificates: Uint8Array[], options?: OperationOptions): Promise<KeyVaultCertificateWithPolicy>

Parameters

certificateName

string

De naam van het certificaat

x509Certificates

Uint8Array[]

De certificaten die moeten worden samengevoegd

options
OperationOptions

De optionele parameters

Retouren

Promise<KeyVaultCertificateWithPolicy>

purgeDeletedCertificate(string, OperationOptions)

Voert een onherstelbare verwijdering van het opgegeven certificaat uit, zonder mogelijkheid voor herstel. De bewerking is niet beschikbaar als het herstelniveau niet 'Leegmaken' opgeeft. Voor deze bewerking is de machtiging voor het certificaat/opschonen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
const deletePoller = await client.beginDeleteCertificate("MyCertificate");
await deletePoller.pollUntilDone();
// Deleting a certificate takes time, make sure to wait before purging it
client.purgeDeletedCertificate("MyCertificate");

Hiermee haalt u een verwijderd certificaat op

function purgeDeletedCertificate(certificateName: string, options?: OperationOptions): Promise<null>

Parameters

certificateName

string

De naam van het verwijderde certificaat dat moet worden verwijderd

options
OperationOptions

De optionele parameters

Retouren

Promise<null>

restoreCertificateBackup(Uint8Array, OperationOptions)

Hiermee herstelt u een back-up van een certificaat en alle bijbehorende versies naar een kluis. Voor deze bewerking is de machtiging certificaten/herstellen vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});
const backup = await client.backupCertificate("MyCertificate");
const poller = await client.beginDeleteCertificate("MyCertificate");
await poller.pollUntilDone();
// Some time is required before we're able to restore the certificate
await client.restoreCertificateBackup(backup!);

Hiermee herstelt u een certificaat vanuit een back-up

function restoreCertificateBackup(backup: Uint8Array, options?: OperationOptions): Promise<KeyVaultCertificateWithPolicy>

Parameters

backup

Uint8Array

Het back-upcertificaat waaruit moet worden hersteld

options
OperationOptions

De optionele parameters

Retouren

Promise<KeyVaultCertificateWithPolicy>

setContacts(CertificateContact[], OperationOptions)

Hiermee stelt u de certificaatcontactpersonen voor de sleutelkluis in. Voor deze bewerking is de machtiging certificaten/managecontacts vereist.

Voorbeeldgebruik:

let client = new CertificateClient(url, credentials);
await client.setContacts([{
  email: "b@b.com",
  name: "b",
  phone: "222222222222"
}]);

Hiermee stelt u de certificaatcontactpersonen in.

function setContacts(contacts: CertificateContact[], options?: OperationOptions): Promise<undefined | CertificateContact[]>

Parameters

contacts

CertificateContact[]

De contactpersonen die moeten worden gebruikt

options
OperationOptions

De optionele parameters

Retouren

Promise<undefined | CertificateContact[]>

updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Werkt het certificaatbeleid voor het opgegeven certificaat bij. Voor deze bewerking is de machtiging certificaten/bijwerken vereist. Hiermee haalt u het beleid van een certificaat op

function updateCertificatePolicy(certificateName: string, policy: CertificatePolicy, options?: OperationOptions): Promise<CertificatePolicy>

Parameters

certificateName

string

De naam van het certificaat

policy
CertificatePolicy

Het certificaatbeleid

options
OperationOptions

De optionele parameters

Retouren

Promise<CertificatePolicy>

updateCertificateProperties(string, string, UpdateCertificatePropertiesOptions)

De opgegeven update op het opgegeven certificaat wordt toegepast; de enige elementen die zijn bijgewerkt, zijn de kenmerken van het certificaat. Voor deze bewerking is de machtiging certificaten/bijwerken vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert"
});

// You may pass an empty string for version which will update
// the latest version of the certificate
await client.updateCertificateProperties("MyCertificate", "", {
  tags: {
    customTag: "value"
  }
});

Een certificaat bijwerken

function updateCertificateProperties(certificateName: string, version: string, options?: UpdateCertificatePropertiesOptions): Promise<KeyVaultCertificate>

Parameters

certificateName

string

De naam van het certificaat

version

string

De versie van het certificaat die moet worden bijgewerkt (een lege tekenreeks werkt de nieuwste versie bij)

options
UpdateCertificateOptions

De opties, waaronder wat u moet bijwerken

Retouren

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

De updateIssuer-bewerking voert een update uit op de opgegeven entiteit voor certificaatverleners. Voor deze bewerking is de machtiging certificaten/setissuers vereist.

Voorbeeldgebruik:

const client = new CertificateClient(url, credentials);
await client.createIssuer("IssuerName", "Test");
await client.updateIssuer("IssuerName", {
  provider: "Provider2"
});

Hiermee werkt u de opgegeven certificaatverlener bij.

function updateIssuer(issuerName: string, options?: UpdateIssuerOptions): Promise<CertificateIssuer>

Parameters

issuerName

string

De naam van de uitgever.

options
UpdateIssuerOptions

De optionele parameters

Retouren

Promise<CertificateIssuer>