Freigeben über

CertificateClient class

  • Referenz
Paket:
@azure/keyvault-certificates

Der Client für die Interaktion mit der KeyVault-Zertifikatfunktionalität

Konstruktoren

CertificateClient(string, TokenCredential, CertificateClientOptions)

Erstellt eine Instanz von CertificateClient.

Eigenschaften

vaultUrl

Die Basis-URL zum Tresor

Methoden

backupCertificate(string, OperationOptions)

Fordert an, dass eine Sicherung des angegebenen Zertifikats auf den Client heruntergeladen wird. Alle Versionen des Zertifikats werden heruntergeladen. Für diesen Vorgang sind die Zertifikate/Sicherungsberechtigungen erforderlich.

Beispielverwendung:

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

Generiert eine Sicherung eines Zertifikats.
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Erstellt ein neues Zertifikat. Wenn dies die erste Version ist, wird die Zertifikatressource erstellt. Diese Funktion gibt einen Abruf für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis das Zertifikat vollständig wiederhergestellt wurde.

Hinweis: Senden von Self als issuerName der Zertifikatrichtlinie erstellt ein selbstsigniertes Zertifikat.

Für diesen Vorgang ist die Berechtigung "Zertifikate/Erstellen" erforderlich.

Beispielverwendung:

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);

Erstellt ein Zertifikat
beginDeleteCertificate(string, CertificatePollerOptions)

Der DELETE-Vorgang gilt für jedes zertifikat, das in Azure Key Vault gespeichert ist. DELETE kann nicht auf eine einzelne Version eines Zertifikats angewendet werden. Diese Funktion gibt einen Abruf für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis das Zertifikat vollständig wiederhergestellt wurde.

Für diesen Vorgang sind die Zertifikate/Löschberechtigungen erforderlich.

Beispielverwendung:

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);

Löscht ein Zertifikat aus einem angegebenen Schlüsseltresor.
beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Stellt das gelöschte Zertifikat im angegebenen Tresor wieder her. Dieser Vorgang kann nur für einen soft-delete-aktivierten Tresor ausgeführt werden. Dieser Vorgang Diese Funktion gibt einen Abruf für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis das Zertifikat vollständig wiederhergestellt wurde.

Für diesen Vorgang ist die Berechtigung "Zertifikate/Wiederherstellen" erforderlich.

Beispielverwendung:

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);

Wiederherstellen eines gelöschten Zertifikats
createIssuer(string, string, CreateIssuerOptions)

Mit dem createIssuer-Vorgang wird der angegebene Zertifikataussteller hinzugefügt oder aktualisiert. Für diesen Vorgang ist die Berechtigung "Zertifikate/Setissuers" erforderlich.

Beispielverwendung:

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

Legt den angegebenen Zertifikataussteller fest.
deleteCertificateOperation(string, OperationOptions)

Löscht den Erstellungsvorgang für ein angegebenes Zertifikat, das gerade erstellt wird. Das Zertifikat wird nicht mehr erstellt. Für diesen Vorgang sind die Zertifikate/Aktualisierungsberechtigungen erforderlich.

Beispielverwendung:

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"

Löschen des Vorgangs eines Zertifikats
deleteContacts(OperationOptions)

Löscht alle Zertifikatkontakte. Für diesen Vorgang ist die Berechtigung "Zertifikate/managecontacts" erforderlich.

Beispielverwendung:

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

Löscht alle Zertifikatkontakte.
deleteIssuer(string, OperationOptions)

Der deleteIssuer-Vorgang entfernt den angegebenen Zertifikataussteller dauerhaft aus dem Tresor. Für diesen Vorgang sind die Zertifikate/manageissuers/deleteissuers-Berechtigung erforderlich.

Beispielverwendung:

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

Löscht den angegebenen Zertifikataussteller.
getCertificate(string, OperationOptions)

Ruft die neuesten Informationen aus einem bestimmten Zertifikat ab, einschließlich der Richtlinie des Zertifikats. Für diesen Vorgang ist die Berechtigung "Zertifikate/Abrufen" erforderlich.

Beispielverwendung:

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);

Ruft ein Zertifikat aus dem Namen des Zertifikats ab (einschließlich der Zertifikatrichtlinie)
getCertificateOperation(string, CertificatePollerOptions)

Ruft den Erstellungsvorgang ab, der einem angegebenen Zertifikat zugeordnet ist. Für diesen Vorgang ist die Berechtigung "Zertifikate/Abrufen" erforderlich. Diese Funktion gibt einen Abruf für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis das Zertifikat vollständig wiederhergestellt wurde.

Beispielverwendung:

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);

Ruft den Abrufvorgang eines Zertifikats ab.
getCertificatePolicy(string, OperationOptions)

Der getCertificatePolicy-Vorgang gibt die angegebenen Zertifikatrichtlinienressourcen im angegebenen Schlüsseltresor zurück. Für diesen Vorgang ist die Berechtigung "Zertifikate/Abrufen" erforderlich.

Beispielverwendung:

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

Ruft die Richtlinie eines Zertifikats ab
getCertificateVersion(string, string, OperationOptions)

Ruft Informationen zu einem bestimmten Zertifikat für eine bestimmte Version ab. Die Richtlinie des Zertifikats wird nicht zurückgegeben. Für diesen Vorgang ist die Berechtigung "Zertifikate/Abrufen" erforderlich.

Beispielverwendung:

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);

Ruft ein Zertifikat aus dem Namen des Zertifikats und einer angegebenen Version ab.
getContacts(OperationOptions)

Gibt den Satz von Zertifikatkontaktressourcen im angegebenen Schlüsseltresor zurück. Für diesen Vorgang ist die Berechtigung "Zertifikate/managecontacts" erforderlich.

Beispielverwendung:

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);

Legt die Zertifikatkontakte fest.
getDeletedCertificate(string, OperationOptions)

Ruft die gelöschten Zertifikatinformationen sowie seine Attribute ab, z. B. Aufbewahrungsintervall, geplantes dauerhaftes Löschen und die aktuelle Löschwiederherstellungsstufe. Für diesen Vorgang ist die Berechtigung "Zertifikate/Abrufen" erforderlich.

Beispielverwendung:

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

Ruft ein gelöschtes Zertifikat ab.
getIssuer(string, OperationOptions)

Der getIssuer-Vorgang gibt die angegebenen Zertifikatherausgeberressourcen im angegebenen Schlüsseltresor zurück. Für diesen Vorgang sind die Zertifikate/manageissuers/getissuers-Berechtigung erforderlich.

Beispielverwendung:

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

Ruft den angegebenen Zertifikataussteller ab.
importCertificate(string, Uint8Array, ImportCertificateOptions)

Importiert ein vorhandenes gültiges Zertifikat, das einen privaten Schlüssel enthält, in Azure Key Vault. Das zu importierende Zertifikat kann entweder im PFX- oder PEM-Format vorliegen. Wenn sich das Zertifikat im PEM-Format befindet, muss die PEM-Datei den Schlüssel sowie x509-Zertifikate enthalten. Für diesen Vorgang sind die Zertifikate/Importberechtigungen erforderlich.

Beispielverwendung:

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);

Importiert ein Zertifikat aus dem geheimen Wert eines Zertifikats.
listDeletedCertificates(ListDeletedCertificatesOptions)

Ruft die Zertifikate im aktuellen Tresor ab, die sich in einem gelöschten Zustand befinden und bereit für die Wiederherstellung oder Löschung sind. Dieser Vorgang enthält löschspezifische Informationen. Für diesen Vorgang sind die Zertifikate/get/list-Berechtigung erforderlich. Dieser Vorgang kann nur für soft-delete-aktivierte Tresore aktiviert werden.

Beispielverwendung:

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);
  }
}

Gelöschte Zertifikate auflisten
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Iterates the latest version of all certificates in the vault. Der vollständige Zertifikatbezeichner und die Attribute werden in der Antwort bereitgestellt. Für die Zertifikate werden keine Werte zurückgegeben. Für diese Vorgänge sind die Zertifikate/Listenberechtigungen erforderlich.

Beispielverwendung:

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);
  }
}

Listet alle Versionen des angegebenen Zertifikats auf.
listPropertiesOfCertificateVersions(string, OperationOptions)

Gibt die Versionen eines Zertifikats im angegebenen Schlüsseltresor zurück. Für diesen Vorgang sind die Zertifikate/Listenberechtigungen erforderlich.

Beispielverwendung:

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

Listet die Versionen eines Zertifikats auf.
listPropertiesOfIssuers(OperationOptions)

Gibt den Satz von Zertifikatherausgeberressourcen im angegebenen Schlüsseltresor zurück. Für diesen Vorgang sind die Zertifikate/manageissuers/getissuers-Berechtigung erforderlich.

Beispielverwendung:

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);
  }
}

Listet die Zertifikataussteller auf.
mergeCertificate(string, Uint8Array[], OperationOptions)

Führt die Zusammenführung eines Zertifikats oder einer Zertifikatkette mit einem Schlüsselpaar aus, das derzeit im Dienst verfügbar ist. Für diesen Vorgang ist die Berechtigung "Zertifikate/Erstellen" erforderlich.

Beispielverwendung:

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)]);

Führt eine signierte Zertifikatanforderung in ein ausstehendes Zertifikat zusammen.
purgeDeletedCertificate(string, OperationOptions)

Führt eine unumkehrbare Löschung des angegebenen Zertifikats ohne Möglichkeit zur Wiederherstellung durch. Der Vorgang ist nicht verfügbar, wenn die Wiederherstellungsstufe nicht 'Löschbar' angibt. Für diesen Vorgang ist die Zertifikat-/Bereinigungsberechtigung erforderlich.

Beispielverwendung:

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");

Ruft ein gelöschtes Zertifikat ab.
restoreCertificateBackup(Uint8Array, OperationOptions)

Stellt ein gesichertes Zertifikat und alle zugehörigen Versionen in einem Tresor wieder her. Für diesen Vorgang ist die Berechtigung "Zertifikate/Wiederherstellung" erforderlich.

Beispielverwendung:

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!);

Stellt ein Zertifikat aus einer Sicherung wieder her
setContacts(CertificateContact[], OperationOptions)

Legt die Zertifikatkontakte für den Schlüsseltresor fest. Für diesen Vorgang ist die Berechtigung "Zertifikate/managecontacts" erforderlich.

Beispielverwendung:

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

Legt die Zertifikatkontakte fest.
updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Aktualisiert die Zertifikatrichtlinie für das angegebene Zertifikat. Für diesen Vorgang sind die Zertifikate/Aktualisierungsberechtigungen erforderlich. Ruft die Richtlinie eines Zertifikats ab
updateCertificateProperties(string, string, UpdateCertificatePropertiesOptions)

Wendet die angegebene Aktualisierung auf das angegebene Zertifikat an; Die einzigen aktualisierten Elemente sind die Attribute des Zertifikats. Für diesen Vorgang sind die Zertifikate/Aktualisierungsberechtigungen erforderlich.

Beispielverwendung:

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"
  }
});

Aktualisiert ein Zertifikat
updateIssuer(string, UpdateIssuerOptions)

Der UpdateIssuer-Vorgang führt eine Aktualisierung der angegebenen Zertifikatherausgeberentität durch. Für diesen Vorgang ist die Berechtigung "Zertifikate/Setissuers" erforderlich.

Beispielverwendung:

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

Aktualisiert den angegebenen Zertifikataussteller.

Details zum Konstruktor

CertificateClient(string, TokenCredential, CertificateClientOptions)

Erstellt eine Instanz von CertificateClient.

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

Parameter

vaultUrl

string

die Basis-URL zum Tresor. Sie sollten überprüfen, ob diese URL auf eine gültige Key Vault-Ressource verweist. Weitere Informationen finden Sie unter https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Ein Objekt, das die TokenCredential Schnittstelle implementiert, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird. Verwenden Sie das @azure/identity-Paket, um eine Anmeldeinformation zu erstellen, die Ihren Anforderungen entspricht.

clientOptions
CertificateClientOptions

Pipelineoptionen zum Konfigurieren von Key Vault-API-Anforderungen. Lassen Sie diesen Parameter aus, um die Standardpipelinekonfiguration zu verwenden.

Details zur Eigenschaft

vaultUrl

Die Basis-URL zum Tresor

vaultUrl: string

Eigenschaftswert

string

Details zur Methode

backupCertificate(string, OperationOptions)

Fordert an, dass eine Sicherung des angegebenen Zertifikats auf den Client heruntergeladen wird. Alle Versionen des Zertifikats werden heruntergeladen. Für diesen Vorgang sind die Zertifikate/Sicherungsberechtigungen erforderlich.

Beispielverwendung:

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

Generiert eine Sicherung eines Zertifikats.

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

Parameter

certificateName

string

Der Name des Zertifikats

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<undefined | Uint8Array>

beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Erstellt ein neues Zertifikat. Wenn dies die erste Version ist, wird die Zertifikatressource erstellt. Diese Funktion gibt einen Abruf für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis das Zertifikat vollständig wiederhergestellt wurde.

Hinweis: Senden von Self als issuerName der Zertifikatrichtlinie erstellt ein selbstsigniertes Zertifikat.

Für diesen Vorgang ist die Berechtigung "Zertifikate/Erstellen" erforderlich.

Beispielverwendung:

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);

Erstellt ein Zertifikat

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

Parameter

certificateName

string

Der Name des Zertifikats

policy
CertificatePolicy
options
BeginCreateCertificateOptions

Optionale Parameter

Gibt zurück

Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

beginDeleteCertificate(string, CertificatePollerOptions)

Der DELETE-Vorgang gilt für jedes zertifikat, das in Azure Key Vault gespeichert ist. DELETE kann nicht auf eine einzelne Version eines Zertifikats angewendet werden. Diese Funktion gibt einen Abruf für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis das Zertifikat vollständig wiederhergestellt wurde.

Für diesen Vorgang sind die Zertifikate/Löschberechtigungen erforderlich.

Beispielverwendung:

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);

Löscht ein Zertifikat aus einem angegebenen Schlüsseltresor.

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

Parameter

certificateName

string

Der Name des Zertifikats.

options
CertificatePollerOptions

Die optionalen Parameter

Gibt zurück

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Stellt das gelöschte Zertifikat im angegebenen Tresor wieder her. Dieser Vorgang kann nur für einen soft-delete-aktivierten Tresor ausgeführt werden. Dieser Vorgang Diese Funktion gibt einen Abruf für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis das Zertifikat vollständig wiederhergestellt wurde.

Für diesen Vorgang ist die Berechtigung "Zertifikate/Wiederherstellen" erforderlich.

Beispielverwendung:

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);

Wiederherstellen eines gelöschten Zertifikats

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

Parameter

certificateName

string

Der Name des gelöschten Zertifikats

options
CertificatePollerOptions

Die optionalen Parameter

Gibt zurück

Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

createIssuer(string, string, CreateIssuerOptions)

Mit dem createIssuer-Vorgang wird der angegebene Zertifikataussteller hinzugefügt oder aktualisiert. Für diesen Vorgang ist die Berechtigung "Zertifikate/Setissuers" erforderlich.

Beispielverwendung:

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

Legt den angegebenen Zertifikataussteller fest.

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

Parameter

issuerName

string

Der Name des Ausstellers.

provider

string

Der Ausstelleranbieter.

options
CreateIssuerOptions

Die optionalen Parameter

Gibt zurück

Promise<CertificateIssuer>

deleteCertificateOperation(string, OperationOptions)

Löscht den Erstellungsvorgang für ein angegebenes Zertifikat, das gerade erstellt wird. Das Zertifikat wird nicht mehr erstellt. Für diesen Vorgang sind die Zertifikate/Aktualisierungsberechtigungen erforderlich.

Beispielverwendung:

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"

Löschen des Vorgangs eines Zertifikats

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

Parameter

certificateName

string

Der Name des Zertifikats

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<CertificateOperation>

deleteContacts(OperationOptions)

Löscht alle Zertifikatkontakte. Für diesen Vorgang ist die Berechtigung "Zertifikate/managecontacts" erforderlich.

Beispielverwendung:

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

Löscht alle Zertifikatkontakte.

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

Parameter

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<undefined | CertificateContact[]>

deleteIssuer(string, OperationOptions)

Der deleteIssuer-Vorgang entfernt den angegebenen Zertifikataussteller dauerhaft aus dem Tresor. Für diesen Vorgang sind die Zertifikate/manageissuers/deleteissuers-Berechtigung erforderlich.

Beispielverwendung:

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

Löscht den angegebenen Zertifikataussteller.

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

Parameter

issuerName

string

Der Name des Ausstellers.

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<CertificateIssuer>

getCertificate(string, OperationOptions)

Ruft die neuesten Informationen aus einem bestimmten Zertifikat ab, einschließlich der Richtlinie des Zertifikats. Für diesen Vorgang ist die Berechtigung "Zertifikate/Abrufen" erforderlich.

Beispielverwendung:

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);

Ruft ein Zertifikat aus dem Namen des Zertifikats ab (einschließlich der Zertifikatrichtlinie)

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

Parameter

certificateName

string

Der Name des Zertifikats

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, CertificatePollerOptions)

Ruft den Erstellungsvorgang ab, der einem angegebenen Zertifikat zugeordnet ist. Für diesen Vorgang ist die Berechtigung "Zertifikate/Abrufen" erforderlich. Diese Funktion gibt einen Abruf für lange Ausgeführte Vorgänge zurück, mit dem Sie auf unbestimmte Zeit warten können, bis das Zertifikat vollständig wiederhergestellt wurde.

Beispielverwendung:

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);

Ruft den Abrufvorgang eines Zertifikats ab.

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

Parameter

certificateName

string

Der Name des Zertifikats

options
CertificatePollerOptions

Die optionalen Parameter

Gibt zurück

Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

getCertificatePolicy(string, OperationOptions)

Der getCertificatePolicy-Vorgang gibt die angegebenen Zertifikatrichtlinienressourcen im angegebenen Schlüsseltresor zurück. Für diesen Vorgang ist die Berechtigung "Zertifikate/Abrufen" erforderlich.

Beispielverwendung:

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

Ruft die Richtlinie eines Zertifikats ab

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

Parameter

certificateName

string

Der Name des Zertifikats

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<CertificatePolicy>

getCertificateVersion(string, string, OperationOptions)

Ruft Informationen zu einem bestimmten Zertifikat für eine bestimmte Version ab. Die Richtlinie des Zertifikats wird nicht zurückgegeben. Für diesen Vorgang ist die Berechtigung "Zertifikate/Abrufen" erforderlich.

Beispielverwendung:

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);

Ruft ein Zertifikat aus dem Namen des Zertifikats und einer angegebenen Version ab.

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

Parameter

certificateName

string

Der Name des Zertifikats

version

string

Die spezifische Version des Zertifikats

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<KeyVaultCertificate>

getContacts(OperationOptions)

Gibt den Satz von Zertifikatkontaktressourcen im angegebenen Schlüsseltresor zurück. Für diesen Vorgang ist die Berechtigung "Zertifikate/managecontacts" erforderlich.

Beispielverwendung:

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);

Legt die Zertifikatkontakte fest.

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

Parameter

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<undefined | CertificateContact[]>

getDeletedCertificate(string, OperationOptions)

Ruft die gelöschten Zertifikatinformationen sowie seine Attribute ab, z. B. Aufbewahrungsintervall, geplantes dauerhaftes Löschen und die aktuelle Löschwiederherstellungsstufe. Für diesen Vorgang ist die Berechtigung "Zertifikate/Abrufen" erforderlich.

Beispielverwendung:

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

Ruft ein gelöschtes Zertifikat ab.

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

Parameter

certificateName

string

Der Name des Zertifikats

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<DeletedCertificate>

getIssuer(string, OperationOptions)

Der getIssuer-Vorgang gibt die angegebenen Zertifikatherausgeberressourcen im angegebenen Schlüsseltresor zurück. Für diesen Vorgang sind die Zertifikate/manageissuers/getissuers-Berechtigung erforderlich.

Beispielverwendung:

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

Ruft den angegebenen Zertifikataussteller ab.

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

Parameter

issuerName

string

Der Name des Ausstellers.

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<CertificateIssuer>

importCertificate(string, Uint8Array, ImportCertificateOptions)

Importiert ein vorhandenes gültiges Zertifikat, das einen privaten Schlüssel enthält, in Azure Key Vault. Das zu importierende Zertifikat kann entweder im PFX- oder PEM-Format vorliegen. Wenn sich das Zertifikat im PEM-Format befindet, muss die PEM-Datei den Schlüssel sowie x509-Zertifikate enthalten. Für diesen Vorgang sind die Zertifikate/Importberechtigungen erforderlich.

Beispielverwendung:

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);

Importiert ein Zertifikat aus dem geheimen Wert eines Zertifikats.

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

Parameter

certificateName

string

Der Name des Zertifikats

certificateBytes

Uint8Array

Der formatierte PFX- oder ASCII-PEM-Wert des Zertifikats, das sowohl die X.509-Zertifikate als auch den privaten Schlüssel enthält

options
ImportCertificateOptions

Die optionalen Parameter

Gibt zurück

Promise<KeyVaultCertificateWithPolicy>

listDeletedCertificates(ListDeletedCertificatesOptions)

Ruft die Zertifikate im aktuellen Tresor ab, die sich in einem gelöschten Zustand befinden und bereit für die Wiederherstellung oder Löschung sind. Dieser Vorgang enthält löschspezifische Informationen. Für diesen Vorgang sind die Zertifikate/get/list-Berechtigung erforderlich. Dieser Vorgang kann nur für soft-delete-aktivierte Tresore aktiviert werden.

Beispielverwendung:

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);
  }
}

Gelöschte Zertifikate auflisten

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

Parameter

options
ListDeletedCertificatesOptions

Die optionalen Parameter

Gibt zurück

PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Iterates the latest version of all certificates in the vault. Der vollständige Zertifikatbezeichner und die Attribute werden in der Antwort bereitgestellt. Für die Zertifikate werden keine Werte zurückgegeben. Für diese Vorgänge sind die Zertifikate/Listenberechtigungen erforderlich.

Beispielverwendung:

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);
  }
}

Listet alle Versionen des angegebenen Zertifikats auf.

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

Parameter

options
ListPropertiesOfCertificatesOptions

Die optionalen Parameter

Gibt zurück

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfCertificateVersions(string, OperationOptions)

Gibt die Versionen eines Zertifikats im angegebenen Schlüsseltresor zurück. Für diesen Vorgang sind die Zertifikate/Listenberechtigungen erforderlich.

Beispielverwendung:

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

Listet die Versionen eines Zertifikats auf.

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

Parameter

certificateName

string

Der Name des Zertifikats.

options
OperationOptions

Die optionalen Parameter

Gibt zurück

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfIssuers(OperationOptions)

Gibt den Satz von Zertifikatherausgeberressourcen im angegebenen Schlüsseltresor zurück. Für diesen Vorgang sind die Zertifikate/manageissuers/getissuers-Berechtigung erforderlich.

Beispielverwendung:

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);
  }
}

Listet die Zertifikataussteller auf.

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

Parameter

options
OperationOptions

Die optionalen Parameter

Gibt zurück

PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

mergeCertificate(string, Uint8Array[], OperationOptions)

Führt die Zusammenführung eines Zertifikats oder einer Zertifikatkette mit einem Schlüsselpaar aus, das derzeit im Dienst verfügbar ist. Für diesen Vorgang ist die Berechtigung "Zertifikate/Erstellen" erforderlich.

Beispielverwendung:

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)]);

Führt eine signierte Zertifikatanforderung in ein ausstehendes Zertifikat zusammen.

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

Parameter

certificateName

string

Der Name des Zertifikats

x509Certificates

Uint8Array[]

Die zusammenzuführenden Zertifikate

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<KeyVaultCertificateWithPolicy>

purgeDeletedCertificate(string, OperationOptions)

Führt eine unumkehrbare Löschung des angegebenen Zertifikats ohne Möglichkeit zur Wiederherstellung durch. Der Vorgang ist nicht verfügbar, wenn die Wiederherstellungsstufe nicht 'Löschbar' angibt. Für diesen Vorgang ist die Zertifikat-/Bereinigungsberechtigung erforderlich.

Beispielverwendung:

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");

Ruft ein gelöschtes Zertifikat ab.

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

Parameter

certificateName

string

Der Name des gelöschten Zertifikats zum Löschen

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<null>

restoreCertificateBackup(Uint8Array, OperationOptions)

Stellt ein gesichertes Zertifikat und alle zugehörigen Versionen in einem Tresor wieder her. Für diesen Vorgang ist die Berechtigung "Zertifikate/Wiederherstellung" erforderlich.

Beispielverwendung:

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!);

Stellt ein Zertifikat aus einer Sicherung wieder her

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

Parameter

backup

Uint8Array

Das Sicherungszertifikat zum Wiederherstellen von

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<KeyVaultCertificateWithPolicy>

setContacts(CertificateContact[], OperationOptions)

Legt die Zertifikatkontakte für den Schlüsseltresor fest. Für diesen Vorgang ist die Berechtigung "Zertifikate/managecontacts" erforderlich.

Beispielverwendung:

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

Legt die Zertifikatkontakte fest.

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

Parameter

contacts

CertificateContact[]

Die zu verwendenden Kontakte

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<undefined | CertificateContact[]>

updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Aktualisiert die Zertifikatrichtlinie für das angegebene Zertifikat. Für diesen Vorgang sind die Zertifikate/Aktualisierungsberechtigungen erforderlich. Ruft die Richtlinie eines Zertifikats ab

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

Parameter

certificateName

string

Der Name des Zertifikats

policy
CertificatePolicy

Die Zertifikatrichtlinie

options
OperationOptions

Die optionalen Parameter

Gibt zurück

Promise<CertificatePolicy>

updateCertificateProperties(string, string, UpdateCertificatePropertiesOptions)

Wendet die angegebene Aktualisierung auf das angegebene Zertifikat an; Die einzigen aktualisierten Elemente sind die Attribute des Zertifikats. Für diesen Vorgang sind die Zertifikate/Aktualisierungsberechtigungen erforderlich.

Beispielverwendung:

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"
  }
});

Aktualisiert ein Zertifikat

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

Parameter

certificateName

string

Der Name des Zertifikats

version

string

Die Version des zu aktualisierenden Zertifikats (eine leere Zeichenfolge aktualisiert die neueste Version)

options
UpdateCertificateOptions

Die Optionen, einschließlich der Zu aktualisierenden Optionen

Gibt zurück

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

Der UpdateIssuer-Vorgang führt eine Aktualisierung der angegebenen Zertifikatherausgeberentität durch. Für diesen Vorgang ist die Berechtigung "Zertifikate/Setissuers" erforderlich.

Beispielverwendung:

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

Aktualisiert den angegebenen Zertifikataussteller.

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

Parameter

issuerName

string

Der Name des Ausstellers.

options
UpdateIssuerOptions

Die optionalen Parameter

Gibt zurück

Promise<CertificateIssuer>