Megosztás a következőn keresztül:

CertificateClient class

  • Referencia
Csomag:
@azure/keyvault-certificates

A KeyVault-tanúsítványok funkcióval kommunikáló ügyfél

Konstruktorok

CertificateClient(string, TokenCredential, CertificateClientOptions)

Létrehozza a CertificateClient egy példányát.

Tulajdonságok

vaultUrl

A tároló alap URL-címe

Metódusok

backupCertificate(string, BackupCertificateOptions)

Kéri, hogy a megadott tanúsítvány biztonsági másolatát letöltse az ügyfélre. A rendszer letölti a tanúsítvány összes verzióját. Ehhez a művelethez tanúsítványokra/biztonsági mentési engedélyre van szükség. Példahasználat:

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

Tanúsítvány biztonsági másolatának létrehozása
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Új tanúsítványt hoz létre. Ha ez az első verzió, létrejön a tanúsítványerőforrás. Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a tanúsítvány teljesen helyreáll. Megjegyzés: A tanúsítvány házirendjének issuerName küldő Self önaláírt tanúsítványt hoz létre.

Ehhez a művelethez tanúsítványokra/létrehozási engedélyre van szükség.

Példahasználat:

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

Tanúsítvány létrehozása
beginDeleteCertificate(string, BeginDeleteCertificateOptions)

A DELETE művelet az Azure Key Vaultban tárolt összes tanúsítványra vonatkozik. A DELETE nem alkalmazható a tanúsítvány egyes verziójára. Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a tanúsítvány teljesen helyreáll. Ehhez a művelethez tanúsítványokra/törlési engedélyekre van szükség.

Példahasználat:

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

Egy tanúsítvány törlése egy megadott kulcstartóból.
beginRecoverDeletedCertificate(string, BeginRecoverDeletedCertificateOptions)

Helyreállítja a törölt tanúsítványt a megadott tárolóban. Ez a művelet csak helyreállítható törlést engedélyező tárolón hajtható végre. Ez a művelet Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a tanúsítvány teljesen helyre nem áll. Ehhez a művelethez tanúsítványokra/helyreállításra vonatkozó engedély szükséges.

Példahasználat:

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

Törölt tanúsítvány helyreállítása
createIssuer(string, string, CreateIssuerOptions)

A createIssuer művelet hozzáadja vagy frissíti a megadott tanúsítványkibocsátót. Ehhez a művelethez tanúsítvány-/setissuers-engedély szükséges. Példahasználat:

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

Beállítja a megadott tanúsítványkibocsátót.
deleteCertificateOperation(string, DeleteCertificateOperationOptions)

Törli a létrehozás folyamatban lévő adott tanúsítvány létrehozási műveletét. A tanúsítvány már nem jön létre. Ehhez a művelethez tanúsítványokra/frissítési engedélyekre van szükség. Példahasználat:

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"

Tanúsítvány műveletének törlése
deleteContacts(DeleteContactsOptions)

Törli az összes tanúsítványpartnert. Ehhez a művelethez tanúsítvány/managecontacts engedély szükséges. Példahasználat:

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

Az összes tanúsítványpartner törlése
deleteIssuer(string, DeleteIssuerOptions)

A deleteIssuer művelet véglegesen eltávolítja a megadott tanúsítványkibocsátót a tárolóból. Ehhez a művelethez a tanúsítványok/manageissuers/deleteissuers engedély szükséges. Példahasználat:

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

Törli a megadott tanúsítványkibocsátót.
getCertificate(string, GetCertificateOptions)

Lekéri a legújabb információkat egy adott tanúsítványból, beleértve a tanúsítvány szabályzatát is. Ehhez a művelethez tanúsítványokra/engedélyek beszerzésére van szükség. Példahasználat:

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

Tanúsítvány lekérése a tanúsítvány nevéből (a tanúsítványházirendet is beleértve)
getCertificateOperation(string, GetCertificateOperationOptions)

Lekéri a megadott tanúsítványhoz társított létrehozási műveletet. Ehhez a művelethez tanúsítványokra/engedélyek beszerzésére van szükség. Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a tanúsítvány teljesen helyreáll. Példahasználat:

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

Lekéri a tanúsítvány lekérdezési műveletét
getCertificatePolicy(string, GetCertificatePolicyOptions)

A getCertificatePolicy művelet a megadott kulcstartóban megadott tanúsítványházirend-erőforrásokat adja vissza. Ehhez a művelethez tanúsítványokra/engedélyek beszerzésére van szükség. Példahasználat:

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

Tanúsítvány szabályzatának lekéréséről
getCertificateVersion(string, string, GetCertificateVersionOptions)

Információt kap egy adott verziójú tanúsítványról. Nem adja vissza a tanúsítvány szabályzatát. Ehhez a művelethez tanúsítványokra/engedélyek beszerzésére van szükség. Példahasználat:

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

Tanúsítvány lekérése a tanúsítvány nevéből és egy megadott verzióból
getContacts(GetContactsOptions)

A megadott kulcstartóban lévő tanúsítvány-kapcsolati erőforrások készletét adja vissza. Ehhez a művelethez tanúsítvány/managecontacts engedély szükséges. Példahasználat:

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

Beállítja a tanúsítvány névjegyeit.
getDeletedCertificate(string, GetDeletedCertificateOptions)

lekéri a törölt tanúsítvány adatait és attribútumait, például a megőrzési időközt, az ütemezett végleges törlést és az aktuális törlés helyreállítási szintjét. Ehhez a művelethez tanúsítványokra/engedélyek beszerzésére van szükség. Példahasználat:

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

Törölt tanúsítvány lekéri
getIssuer(string, GetIssuerOptions)

A getIssuer művelet a megadott kulcstartóban lévő tanúsítványkibocsátó erőforrásokat adja vissza. Ehhez a művelethez tanúsítvány/manageissuers/getissuers engedély szükséges. Példahasználat:

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

Lekéri a megadott tanúsítványkibocsátót.
importCertificate(string, Uint8Array, ImportCertificateOptions)

Importál egy meglévő, titkos kulcsot tartalmazó érvényes tanúsítványt az Azure Key Vaultba. Az importálandó tanúsítvány LEHET PFX vagy PEM formátumban. Ha a tanúsítvány PEM formátumban van, a PEM-fájlnak tartalmaznia kell a kulcsot és az x509-tanúsítványokat. Ehhez a művelethez tanúsítványokra/importálási engedélyekre van szükség. Példahasználat:

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

Tanúsítvány importálása a tanúsítvány titkos értékéből
listDeletedCertificates(ListDeletedCertificatesOptions)

Lekéri az aktuális tárolóban lévő, törölt állapotban lévő és helyreállításra vagy törlésre kész tanúsítványokat. Ez a művelet törléssel kapcsolatos információkat tartalmaz. Ehhez a művelethez tanúsítvány-/lekérési/listaengedély szükséges. Ez a művelet csak helyreállítható törléssel engedélyezett tárolókon engedélyezhető. Példahasználat:

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

Törölt tanúsítványok listája
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Iterálja a tároló összes tanúsítványának legújabb verzióját. A teljes tanúsítványazonosítót és attribútumokat a válaszban adja meg. A rendszer nem ad vissza értékeket a tanúsítványokhoz. Ehhez a művelethez tanúsítványokra/listaengedélyekre van szükség. Példahasználat:

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

A megadott tanúsítvány összes verziójának listázása.
listPropertiesOfCertificateVersions(string, ListPropertiesOfCertificateVersionsOptions)

A megadott kulcstartóban lévő tanúsítvány verzióit adja vissza. Ehhez a művelethez tanúsítványok/listaengedélyek szükségesek. Példahasználat:

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

A tanúsítványok verzióinak listázása.
listPropertiesOfIssuers(ListPropertiesOfIssuersOptions)

A tanúsítványkibocsátó erőforrások készletét adja vissza a megadott kulcstartóban. Ehhez a művelethez tanúsítvány/manageissuers/getissuers engedély szükséges. Példahasználat:

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

Sorolja fel a tanúsítványkibocsátók listáját.
mergeCertificate(string, Uint8Array[], MergeCertificateOptions)

Egy tanúsítvány vagy tanúsítványlánc egyesítését hajtja végre a szolgáltatásban jelenleg elérhető kulcspárral. Ehhez a művelethez tanúsítványokra/létrehozási engedélyre van szükség. Példahasználat:

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

Aláírt tanúsítványkérelmet egyesít függőben lévő tanúsítványsá
purgeDeletedCertificate(string, PurgeDeletedCertificateOptions)

A megadott tanúsítvány visszavonhatatlan törlését hajtja végre a helyreállítás lehetősége nélkül. A művelet nem érhető el, ha a helyreállítási szint nem adja meg a "Kiüríthető" értéket. Ehhez a művelethez tanúsítvány-/törlési engedély szükséges. Példahasználat:

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

Törölt tanúsítvány lekéri
restoreCertificateBackup(Uint8Array, RestoreCertificateBackupOptions)

Egy biztonsági másolattal rendelkező tanúsítványt és annak összes verzióját visszaállítja egy tárolóba. Ehhez a művelethez tanúsítványokra/visszaállítási engedélyre van szükség. Példahasználat:

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

Tanúsítvány visszaállítása biztonsági másolatból
setContacts(CertificateContact[], SetContactsOptions)

Beállítja a kulcstartó tanúsítványpartnereit. Ehhez a művelethez tanúsítvány/managecontacts engedély szükséges. Példahasználat:

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

Beállítja a tanúsítvány névjegyeit.
updateCertificatePolicy(string, CertificatePolicy, UpdateCertificatePolicyOptions)

Frissíti a megadott tanúsítvány tanúsítványszabályzatát. Ehhez a művelethez tanúsítványokra/frissítési engedélyekre van szükség. Tanúsítvány szabályzatának lekéréséről
updateCertificateProperties(string, string, UpdateCertificateOptions)

Alkalmazza a megadott frissítést az adott tanúsítványra; az egyetlen frissített elem a tanúsítvány attribútuma. Ehhez a művelethez tanúsítványokra/frissítési engedélyekre van szükség. Példahasználat:

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

Tanúsítvány frissítése
updateIssuer(string, UpdateIssuerOptions)

Az updateIssuer művelet egy frissítést hajt végre a megadott tanúsítványkibocsátó entitáson. Ehhez a művelethez tanúsítvány-/setissuers-engedély szükséges. Példahasználat:

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

Frissíti a megadott tanúsítványkibocsátót.

Konstruktor adatai

CertificateClient(string, TokenCredential, CertificateClientOptions)

Létrehozza a CertificateClient egy példányát.

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

Paraméterek

vaultUrl

string

a tároló alap URL-címe.

credential

TokenCredential

Egy objektum, amely implementálja a szolgáltatáshoz érkező kérések hitelesítéséhez használt TokenCredential felületet. Az @azure/identitáscsomag használatával hozzon létre egy, az igényeinek megfelelő hitelesítő adatot.

pipelineOptions
CertificateClientOptions

A Key Vault API-kérések konfigurálásához használt folyamatbeállítások. Hagyja ki ezt a paramétert az alapértelmezett folyamatkonfiguráció használatához.

Tulajdonság adatai

vaultUrl

A tároló alap URL-címe

vaultUrl: string

Tulajdonság értéke

string

Metódus adatai

backupCertificate(string, BackupCertificateOptions)

Kéri, hogy a megadott tanúsítvány biztonsági másolatát letöltse az ügyfélre. A rendszer letölti a tanúsítvány összes verzióját. Ehhez a művelethez tanúsítványokra/biztonsági mentési engedélyre van szükség. Példahasználat:

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

Tanúsítvány biztonsági másolatának létrehozása

function backupCertificate(certificateName: string, options?: BackupCertificateOptions)

Paraméterek

certificateName

string

A tanúsítvány neve

options
BackupCertificateOptions

Az opcionális paraméterek

Válaszok

Promise<Uint8Array | undefined>

beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Új tanúsítványt hoz létre. Ha ez az első verzió, létrejön a tanúsítványerőforrás. Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a tanúsítvány teljesen helyreáll. Megjegyzés: A tanúsítvány házirendjének issuerName küldő Self önaláírt tanúsítványt hoz létre.

Ehhez a művelethez tanúsítványokra/létrehozási engedélyre van szükség.

Példahasználat:

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

Tanúsítvány létrehozása

function beginCreateCertificate(certificateName: string, policy: CertificatePolicy, options?: BeginCreateCertificateOptions)

Paraméterek

certificateName

string

A tanúsítvány neve

policy
CertificatePolicy
options
BeginCreateCertificateOptions

Választható paraméterek

Válaszok

Promise<PollerLike<CreateCertificateState, KeyVaultCertificateWithPolicy>>

beginDeleteCertificate(string, BeginDeleteCertificateOptions)

A DELETE művelet az Azure Key Vaultban tárolt összes tanúsítványra vonatkozik. A DELETE nem alkalmazható a tanúsítvány egyes verziójára. Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a tanúsítvány teljesen helyreáll. Ehhez a művelethez tanúsítványokra/törlési engedélyekre van szükség.

Példahasználat:

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

Egy tanúsítvány törlése egy megadott kulcstartóból.

function beginDeleteCertificate(certificateName: string, options?: BeginDeleteCertificateOptions)

Paraméterek

certificateName

string

A tanúsítvány neve.

options
BeginDeleteCertificateOptions

Az opcionális paraméterek

Válaszok

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, BeginRecoverDeletedCertificateOptions)

Helyreállítja a törölt tanúsítványt a megadott tárolóban. Ez a művelet csak helyreállítható törlést engedélyező tárolón hajtható végre. Ez a művelet Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a tanúsítvány teljesen helyre nem áll. Ehhez a művelethez tanúsítványokra/helyreállításra vonatkozó engedély szükséges.

Példahasználat:

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

Törölt tanúsítvány helyreállítása

function beginRecoverDeletedCertificate(certificateName: string, options?: BeginRecoverDeletedCertificateOptions)

Paraméterek

certificateName

string

A törölt tanúsítvány neve

options
BeginRecoverDeletedCertificateOptions

Az opcionális paraméterek

Válaszok

Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

createIssuer(string, string, CreateIssuerOptions)

A createIssuer művelet hozzáadja vagy frissíti a megadott tanúsítványkibocsátót. Ehhez a művelethez tanúsítvány-/setissuers-engedély szükséges. Példahasználat:

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

Beállítja a megadott tanúsítványkibocsátót.

function createIssuer(issuerName: string, provider: string, options?: CreateIssuerOptions)

Paraméterek

issuerName

string

A kiállító neve.

provider

string

A kiállító szolgáltatója.

options
CreateIssuerOptions

Az opcionális paraméterek

Válaszok

Promise<CertificateIssuer>

deleteCertificateOperation(string, DeleteCertificateOperationOptions)

Törli a létrehozás folyamatban lévő adott tanúsítvány létrehozási műveletét. A tanúsítvány már nem jön létre. Ehhez a művelethez tanúsítványokra/frissítési engedélyekre van szükség. Példahasználat:

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"

Tanúsítvány műveletének törlése

function deleteCertificateOperation(certificateName: string, options?: DeleteCertificateOperationOptions)

Paraméterek

certificateName

string

A tanúsítvány neve

options
DeleteCertificateOperationOptions

Az opcionális paraméterek

Válaszok

Promise<CertificateOperation>

deleteContacts(DeleteContactsOptions)

Törli az összes tanúsítványpartnert. Ehhez a művelethez tanúsítvány/managecontacts engedély szükséges. Példahasználat:

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

Az összes tanúsítványpartner törlése

function deleteContacts(options?: DeleteContactsOptions)

Paraméterek

options
DeleteContactsOptions

Az opcionális paraméterek

Válaszok

Promise<CertificateContact[] | undefined>

deleteIssuer(string, DeleteIssuerOptions)

A deleteIssuer művelet véglegesen eltávolítja a megadott tanúsítványkibocsátót a tárolóból. Ehhez a művelethez a tanúsítványok/manageissuers/deleteissuers engedély szükséges. Példahasználat:

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

Törli a megadott tanúsítványkibocsátót.

function deleteIssuer(issuerName: string, options?: DeleteIssuerOptions)

Paraméterek

issuerName

string

A kiállító neve.

options
DeleteIssuerOptions

Az opcionális paraméterek

Válaszok

Promise<CertificateIssuer>

getCertificate(string, GetCertificateOptions)

Lekéri a legújabb információkat egy adott tanúsítványból, beleértve a tanúsítvány szabályzatát is. Ehhez a művelethez tanúsítványokra/engedélyek beszerzésére van szükség. Példahasználat:

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

Tanúsítvány lekérése a tanúsítvány nevéből (a tanúsítványházirendet is beleértve)

function getCertificate(certificateName: string, options?: GetCertificateOptions)

Paraméterek

certificateName

string

A tanúsítvány neve

options
GetCertificateOptions

Az opcionális paraméterek

Válaszok

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, GetCertificateOperationOptions)

Lekéri a megadott tanúsítványhoz társított létrehozási műveletet. Ehhez a művelethez tanúsítványokra/engedélyek beszerzésére van szükség. Ez a függvény egy hosszú ideig futó művelet lekérdezését adja vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a tanúsítvány teljesen helyreáll. Példahasználat:

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

Lekéri a tanúsítvány lekérdezési műveletét

function getCertificateOperation(certificateName: string, options?: GetCertificateOperationOptions)

Paraméterek

certificateName

string

A tanúsítvány neve

options
GetCertificateOperationOptions

Az opcionális paraméterek

Válaszok

Promise<PollerLike<CertificateOperationState, KeyVaultCertificateWithPolicy>>

getCertificatePolicy(string, GetCertificatePolicyOptions)

A getCertificatePolicy művelet a megadott kulcstartóban megadott tanúsítványházirend-erőforrásokat adja vissza. Ehhez a művelethez tanúsítványokra/engedélyek beszerzésére van szükség. Példahasználat:

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

Tanúsítvány szabályzatának lekéréséről

function getCertificatePolicy(certificateName: string, options?: GetCertificatePolicyOptions)

Paraméterek

certificateName

string

A tanúsítvány neve

options
GetCertificatePolicyOptions

Az opcionális paraméterek

Válaszok

Promise<CertificatePolicy>

getCertificateVersion(string, string, GetCertificateVersionOptions)

Információt kap egy adott verziójú tanúsítványról. Nem adja vissza a tanúsítvány szabályzatát. Ehhez a művelethez tanúsítványokra/engedélyek beszerzésére van szükség. Példahasználat:

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

Tanúsítvány lekérése a tanúsítvány nevéből és egy megadott verzióból

function getCertificateVersion(certificateName: string, version: string, options?: GetCertificateVersionOptions)

Paraméterek

certificateName

string

A tanúsítvány neve

version

string

A tanúsítvány adott verziója

options
GetCertificateVersionOptions

Az opcionális paraméterek

Válaszok

Promise<KeyVaultCertificate>

getContacts(GetContactsOptions)

A megadott kulcstartóban lévő tanúsítvány-kapcsolati erőforrások készletét adja vissza. Ehhez a művelethez tanúsítvány/managecontacts engedély szükséges. Példahasználat:

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

Beállítja a tanúsítvány névjegyeit.

function getContacts(options?: GetContactsOptions)

Paraméterek

options
GetContactsOptions

Az opcionális paraméterek

Válaszok

Promise<CertificateContact[] | undefined>

getDeletedCertificate(string, GetDeletedCertificateOptions)

lekéri a törölt tanúsítvány adatait és attribútumait, például a megőrzési időközt, az ütemezett végleges törlést és az aktuális törlés helyreállítási szintjét. Ehhez a művelethez tanúsítványokra/engedélyek beszerzésére van szükség. Példahasználat:

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

Törölt tanúsítvány lekéri

function getDeletedCertificate(certificateName: string, options?: GetDeletedCertificateOptions)

Paraméterek

certificateName

string

A tanúsítvány neve

options
GetDeletedCertificateOptions

Az opcionális paraméterek

Válaszok

Promise<DeletedCertificate>

getIssuer(string, GetIssuerOptions)

A getIssuer művelet a megadott kulcstartóban lévő tanúsítványkibocsátó erőforrásokat adja vissza. Ehhez a művelethez tanúsítvány/manageissuers/getissuers engedély szükséges. Példahasználat:

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

Lekéri a megadott tanúsítványkibocsátót.

function getIssuer(issuerName: string, options?: GetIssuerOptions)

Paraméterek

issuerName

string

A kiállító neve.

options
GetIssuerOptions

Az opcionális paraméterek

Válaszok

Promise<CertificateIssuer>

importCertificate(string, Uint8Array, ImportCertificateOptions)

Importál egy meglévő, titkos kulcsot tartalmazó érvényes tanúsítványt az Azure Key Vaultba. Az importálandó tanúsítvány LEHET PFX vagy PEM formátumban. Ha a tanúsítvány PEM formátumban van, a PEM-fájlnak tartalmaznia kell a kulcsot és az x509-tanúsítványokat. Ehhez a művelethez tanúsítványokra/importálási engedélyekre van szükség. Példahasználat:

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

Tanúsítvány importálása a tanúsítvány titkos értékéből

function importCertificate(certificateName: string, certificateBytes: Uint8Array, options?: ImportCertificateOptions)

Paraméterek

certificateName

string

A tanúsítvány neve

certificateBytes

Uint8Array

Az X.509 tanúsítványt és a titkos kulcsot tartalmazó tanúsítvány PFX vagy ASCII PEM formátumú értéke

options
ImportCertificateOptions

Az opcionális paraméterek

Válaszok

Promise<KeyVaultCertificateWithPolicy>

listDeletedCertificates(ListDeletedCertificatesOptions)

Lekéri az aktuális tárolóban lévő, törölt állapotban lévő és helyreállításra vagy törlésre kész tanúsítványokat. Ez a művelet törléssel kapcsolatos információkat tartalmaz. Ehhez a művelethez tanúsítvány-/lekérési/listaengedély szükséges. Ez a művelet csak helyreállítható törléssel engedélyezett tárolókon engedélyezhető. Példahasználat:

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

Törölt tanúsítványok listája

function listDeletedCertificates(options?: ListDeletedCertificatesOptions)

Paraméterek

options
ListDeletedCertificatesOptions

Az opcionális paraméterek

Válaszok

PagedAsyncIterableIterator<DeletedCertificate>

listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Iterálja a tároló összes tanúsítványának legújabb verzióját. A teljes tanúsítványazonosítót és attribútumokat a válaszban adja meg. A rendszer nem ad vissza értékeket a tanúsítványokhoz. Ehhez a művelethez tanúsítványokra/listaengedélyekre van szükség. Példahasználat:

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

A megadott tanúsítvány összes verziójának listázása.

function listPropertiesOfCertificates(options?: ListPropertiesOfCertificatesOptions)

Paraméterek

options
ListPropertiesOfCertificatesOptions

Az opcionális paraméterek

Válaszok

PagedAsyncIterableIterator<CertificateProperties>

listPropertiesOfCertificateVersions(string, ListPropertiesOfCertificateVersionsOptions)

A megadott kulcstartóban lévő tanúsítvány verzióit adja vissza. Ehhez a művelethez tanúsítványok/listaengedélyek szükségesek. Példahasználat:

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

A tanúsítványok verzióinak listázása.

function listPropertiesOfCertificateVersions(certificateName: string, options?: ListPropertiesOfCertificateVersionsOptions)

Paraméterek

certificateName

string

A tanúsítvány neve.

options
ListPropertiesOfCertificateVersionsOptions

Az opcionális paraméterek

Válaszok

PagedAsyncIterableIterator<CertificateProperties>

listPropertiesOfIssuers(ListPropertiesOfIssuersOptions)

A tanúsítványkibocsátó erőforrások készletét adja vissza a megadott kulcstartóban. Ehhez a művelethez tanúsítvány/manageissuers/getissuers engedély szükséges. Példahasználat:

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

Sorolja fel a tanúsítványkibocsátók listáját.

function listPropertiesOfIssuers(options?: ListPropertiesOfIssuersOptions)

Paraméterek

options
ListPropertiesOfIssuersOptions

Az opcionális paraméterek

Válaszok

PagedAsyncIterableIterator<IssuerProperties>

mergeCertificate(string, Uint8Array[], MergeCertificateOptions)

Egy tanúsítvány vagy tanúsítványlánc egyesítését hajtja végre a szolgáltatásban jelenleg elérhető kulcspárral. Ehhez a művelethez tanúsítványokra/létrehozási engedélyre van szükség. Példahasználat:

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

Aláírt tanúsítványkérelmet egyesít függőben lévő tanúsítványsá

function mergeCertificate(certificateName: string, x509Certificates: Uint8Array[], options?: MergeCertificateOptions)

Paraméterek

certificateName

string

A tanúsítvány neve

x509Certificates

Uint8Array[]

Az egyesítendő tanúsítvány(ok)

options
MergeCertificateOptions

Az opcionális paraméterek

Válaszok

Promise<KeyVaultCertificateWithPolicy>

purgeDeletedCertificate(string, PurgeDeletedCertificateOptions)

A megadott tanúsítvány visszavonhatatlan törlését hajtja végre a helyreállítás lehetősége nélkül. A művelet nem érhető el, ha a helyreállítási szint nem adja meg a "Kiüríthető" értéket. Ehhez a művelethez tanúsítvány-/törlési engedély szükséges. Példahasználat:

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

Törölt tanúsítvány lekéri

function purgeDeletedCertificate(certificateName: string, options?: PurgeDeletedCertificateOptions)

Paraméterek

certificateName

string

A törölni kívánt törölt tanúsítvány neve

options
PurgeDeletedCertificateOptions

Az opcionális paraméterek

Válaszok

Promise<null>

restoreCertificateBackup(Uint8Array, RestoreCertificateBackupOptions)

Egy biztonsági másolattal rendelkező tanúsítványt és annak összes verzióját visszaállítja egy tárolóba. Ehhez a művelethez tanúsítványokra/visszaállítási engedélyre van szükség. Példahasználat:

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

Tanúsítvány visszaállítása biztonsági másolatból

function restoreCertificateBackup(backup: Uint8Array, options?: RestoreCertificateBackupOptions)

Paraméterek

backup

Uint8Array

A visszaállításhoz szükséges biztonsági mentési tanúsítvány

options
RestoreCertificateBackupOptions

Az opcionális paraméterek

Válaszok

Promise<KeyVaultCertificateWithPolicy>

setContacts(CertificateContact[], SetContactsOptions)

Beállítja a kulcstartó tanúsítványpartnereit. Ehhez a művelethez tanúsítvány/managecontacts engedély szükséges. Példahasználat:

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

Beállítja a tanúsítvány névjegyeit.

function setContacts(contacts: CertificateContact[], options?: SetContactsOptions)

Paraméterek

contacts

CertificateContact[]

A használni kívánt névjegyek

options
SetContactsOptions

Az opcionális paraméterek

Válaszok

Promise<CertificateContact[] | undefined>

updateCertificatePolicy(string, CertificatePolicy, UpdateCertificatePolicyOptions)

Frissíti a megadott tanúsítvány tanúsítványszabályzatát. Ehhez a művelethez tanúsítványokra/frissítési engedélyekre van szükség. Tanúsítvány szabályzatának lekéréséről

function updateCertificatePolicy(certificateName: string, policy: CertificatePolicy, options?: UpdateCertificatePolicyOptions)

Paraméterek

certificateName

string

A tanúsítvány neve

policy
CertificatePolicy

A tanúsítványházirend

options
UpdateCertificatePolicyOptions

Az opcionális paraméterek

Válaszok

Promise<CertificatePolicy>

updateCertificateProperties(string, string, UpdateCertificateOptions)

Alkalmazza a megadott frissítést az adott tanúsítványra; az egyetlen frissített elem a tanúsítvány attribútuma. Ehhez a művelethez tanúsítványokra/frissítési engedélyekre van szükség. Példahasználat:

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

Tanúsítvány frissítése

function updateCertificateProperties(certificateName: string, version: string, options?: UpdateCertificateOptions)

Paraméterek

certificateName

string

A tanúsítvány neve

version

string

A frissíteni kívánt tanúsítvány verziója

options
UpdateCertificateOptions

A beállítások, beleértve a frissítendő lehetőségeket

Válaszok

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

Az updateIssuer művelet egy frissítést hajt végre a megadott tanúsítványkibocsátó entitáson. Ehhez a művelethez tanúsítvány-/setissuers-engedély szükséges. Példahasználat:

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

Frissíti a megadott tanúsítványkibocsátót.

function updateIssuer(issuerName: string, options?: UpdateIssuerOptions)

Paraméterek

issuerName

string

A kiállító neve.

options
UpdateIssuerOptions

Az opcionális paraméterek

Válaszok

Promise<CertificateIssuer>