CertificateClient class

  • Referensi
Paket:
@azure/keyvault-certificates

Klien untuk berinteraksi dengan fungsionalitas sertifikat KeyVault

Konstruktor

CertificateClient(string, TokenCredential, CertificateClientOptions)

Membuat instans CertificateClient.

Properti

vaultUrl

URL dasar ke vault

Metode

backupCertificate(string, OperationOptions)

Meminta agar cadangan sertifikat yang ditentukan diunduh ke klien. Semua versi sertifikat akan diunduh. Operasi ini memerlukan izin sertifikat/pencadangan.

Contoh penggunaan:

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

Menghasilkan cadangan sertifikat
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Membuat sertifikat baru. Jika ini adalah versi pertama, sumber daya sertifikat dibuat. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga sertifikat sepenuhnya pulih.

Catatan:Self Mengirim sebagai issuerName kebijakan sertifikat akan membuat sertifikat yang ditandatangani sendiri.

Operasi ini memerlukan izin sertifikat/pembuatan.

Contoh penggunaan:

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

Membuat sertifikat
beginDeleteCertificate(string, CertificatePollerOptions)

Operasi DELETE berlaku untuk sertifikat apa pun yang disimpan di Azure Key Vault. DELETE tidak dapat diterapkan ke versi individual sertifikat. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga sertifikat sepenuhnya pulih.

Operasi ini memerlukan izin sertifikat/hapus.

Contoh penggunaan:

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

Menghapus sertifikat dari brankas kunci tertentu.
beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Memulihkan sertifikat yang dihapus dalam vault yang ditentukan. Operasi ini hanya dapat dilakukan pada vault yang diaktifkan penghapusan sementara. Operasi ini Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda untuk menunggu tanpa batas waktu hingga sertifikat sepenuhnya pulih.

Operasi ini memerlukan izin sertifikat/pemulihan.

Contoh penggunaan:

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

Memulihkan sertifikat yang dihapus
createIssuer(string, string, CreateIssuerOptions)

Operasi createIssuer menambahkan atau memperbarui penerbit sertifikat yang ditentukan. Operasi ini memerlukan izin sertifikat/setissuers.

Contoh penggunaan:

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

Mengatur penerbit sertifikat yang ditentukan.
deleteCertificateOperation(string, OperationOptions)

Menghapus operasi pembuatan untuk sertifikat tertentu yang sedang dalam proses dibuat. Sertifikat tidak lagi dibuat. Operasi ini memerlukan izin sertifikat/pembaruan.

Contoh penggunaan:

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"

Menghapus operasi sertifikat
deleteContacts(OperationOptions)

Menghapus semua kontak sertifikat. Operasi ini memerlukan izin sertifikat/managecontacts.

Contoh penggunaan:

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

Menghapus semua kontak sertifikat
deleteIssuer(string, OperationOptions)

Operasi deleteIssuer menghapus pengeluar sertifikat yang ditentukan secara permanen dari vault. Operasi ini memerlukan izin sertifikat/manageissuers/deleteissuers.

Contoh penggunaan:

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

Menghapus pengeluar sertifikat yang ditentukan.
getCertificate(string, OperationOptions)

Mendapatkan informasi terbaru yang tersedia dari sertifikat tertentu, termasuk kebijakan sertifikat. Operasi ini memerlukan izin sertifikat/dapatkan.

Contoh penggunaan:

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

Mengambil sertifikat dari nama sertifikat (termasuk kebijakan sertifikat)
getCertificateOperation(string, CertificatePollerOptions)

Mendapatkan operasi pembuatan yang terkait dengan sertifikat tertentu. Operasi ini memerlukan izin sertifikat/dapatkan. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga sertifikat sepenuhnya pulih.

Contoh penggunaan:

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

Mendapatkan operasi poller sertifikat
getCertificatePolicy(string, OperationOptions)

Operasi getCertificatePolicy mengembalikan sumber daya kebijakan sertifikat yang ditentukan dalam brankas kunci yang ditentukan. Operasi ini memerlukan izin sertifikat/dapatkan.

Contoh penggunaan:

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

Mendapatkan kebijakan sertifikat
getCertificateVersion(string, string, OperationOptions)

Mendapatkan informasi tentang sertifikat tertentu pada versi tertentu. Ini tidak akan mengembalikan kebijakan sertifikat. Operasi ini memerlukan izin sertifikat/dapatkan.

Contoh penggunaan:

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

Mengambil sertifikat dari nama sertifikat dan versi tertentu
getContacts(OperationOptions)

Mengembalikan sekumpulan sumber daya kontak sertifikat dalam brankas kunci yang ditentukan. Operasi ini memerlukan izin sertifikat/managecontacts.

Contoh penggunaan:

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

Mengatur kontak sertifikat.
getDeletedCertificate(string, OperationOptions)

mengambil informasi sertifikat yang dihapus ditambah atributnya, seperti interval retensi, penghapusan permanen terjadwal, dan tingkat pemulihan penghapusan saat ini. Operasi ini memerlukan izin sertifikat/dapatkan.

Contoh penggunaan:

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

Mendapatkan sertifikat yang dihapus
getIssuer(string, OperationOptions)

Operasi getIssuer mengembalikan sumber daya penerbit sertifikat yang ditentukan dalam brankas kunci yang ditentukan. Operasi ini memerlukan izin sertifikat/manageissuers/getissuers.

Contoh penggunaan:

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

Membuat dia menentukan pengeluar sertifikat.
importCertificate(string, Uint8Array, ImportCertificateOptions)

Mengimpor sertifikat valid yang sudah ada, yang berisi kunci privat, ke azure Key Vault. Sertifikat yang akan diimpor dapat berada dalam format PFX atau PEM. Jika sertifikat dalam format PEM, file PEM harus berisi kunci serta sertifikat x509. Operasi ini memerlukan izin sertifikat/impor.

Contoh penggunaan:

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

Mengimpor sertifikat dari nilai rahasia sertifikat
listDeletedCertificates(ListDeletedCertificatesOptions)

Mengambil sertifikat dalam vault saat ini yang dalam status dihapus dan siap untuk pemulihan atau pembersihan. Operasi ini mencakup informasi khusus penghapusan. Operasi ini memerlukan izin sertifikat/dapatkan/daftar. Operasi ini hanya dapat diaktifkan pada vault yang diaktifkan penghapusan sementara.

Contoh penggunaan:

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

Mencantumkan sertifikat yang dihapus
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Melakukan iterasi versi terbaru dari semua sertifikat di vault. Pengidentifikasi dan atribut sertifikat lengkap disediakan dalam respons. Tidak ada nilai yang dikembalikan untuk sertifikat. Operasi ini memerlukan izin sertifikat/daftar.

Contoh penggunaan:

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

Mencantumkan semua versi sertifikat yang ditentukan.
listPropertiesOfCertificateVersions(string, OperationOptions)

Mengembalikan versi sertifikat dalam brankas kunci yang ditentukan. Operasi ini memerlukan izin sertifikat/daftar.

Contoh penggunaan:

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

Mencantumkan versi sertifikat.
listPropertiesOfIssuers(OperationOptions)

Mengembalikan sekumpulan sumber daya penerbit sertifikat dalam brankas kunci yang ditentukan. Operasi ini memerlukan izin sertifikat/manageissuers/getissuers.

Contoh penggunaan:

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

Mencantumkan penerbit sertifikat.
mergeCertificate(string, Uint8Array[], OperationOptions)

Melakukan penggabungan sertifikat atau rantai sertifikat dengan pasangan kunci yang saat ini tersedia dalam layanan. Operasi ini memerlukan izin sertifikat/pembuatan.

Contoh penggunaan:

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

Menggabungkan permintaan sertifikat yang ditandatangani ke dalam sertifikat yang tertunda
purgeDeletedCertificate(string, OperationOptions)

Melakukan penghapusan sertifikat yang ditentukan yang tidak dapat diubah, tanpa kemungkinan untuk pemulihan. Operasi tidak tersedia jika tingkat pemulihan tidak menentukan 'Dapat Dibersihkan'. Operasi ini memerlukan izin sertifikat/hapus menyeluruh.

Contoh penggunaan:

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

Mendapatkan sertifikat yang dihapus
restoreCertificateBackup(Uint8Array, OperationOptions)

Memulihkan sertifikat yang dicadangkan, dan semua versinya, ke vault. Operasi ini memerlukan izin sertifikat/pemulihan.

Contoh penggunaan:

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

Memulihkan sertifikat dari cadangan
setContacts(CertificateContact[], OperationOptions)

Mengatur kontak sertifikat untuk brankas kunci. Operasi ini memerlukan izin sertifikat/managecontacts.

Contoh penggunaan:

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

Mengatur kontak sertifikat.
updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Updates kebijakan sertifikat untuk sertifikat yang ditentukan. Operasi ini memerlukan izin sertifikat/pembaruan. Mendapatkan kebijakan sertifikat
updateCertificateProperties(string, string, UpdateCertificateOptions)

Menerapkan pembaruan yang ditentukan pada sertifikat yang diberikan; satu-satunya elemen yang diperbarui adalah atribut sertifikat. Operasi ini memerlukan izin sertifikat/pembaruan.

Contoh penggunaan:

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

Updates sertifikat
updateIssuer(string, UpdateIssuerOptions)

Operasi updateIssuer melakukan pembaruan pada entitas penerbit sertifikat yang ditentukan. Operasi ini memerlukan izin sertifikat/setissuers.

Contoh penggunaan:

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

Updates penerbit sertifikat yang ditentukan.

Detail Konstruktor

CertificateClient(string, TokenCredential, CertificateClientOptions)

Membuat instans CertificateClient.

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

Parameter

vaultUrl

string

URL dasar ke vault. Anda harus memvalidasi bahwa URL ini mereferensikan sumber daya Key Vault yang valid. Lihat https://aka.ms/azsdk/blog/vault-uri untuk detailnya.

credential
TokenCredential

Objek yang mengimplementasikan antarmuka yang TokenCredential digunakan untuk mengautentikasi permintaan ke layanan. @azure/identity Gunakan paket untuk membuat kredensial yang sesuai dengan kebutuhan Anda.

clientOptions
CertificateClientOptions

Opsi alur yang digunakan untuk mengonfigurasi permintaan API Key Vault. Hilangkan parameter ini untuk menggunakan konfigurasi alur default.

Detail Properti

vaultUrl

URL dasar ke vault

vaultUrl: string

Nilai Properti

string

Detail Metode

backupCertificate(string, OperationOptions)

Meminta agar cadangan sertifikat yang ditentukan diunduh ke klien. Semua versi sertifikat akan diunduh. Operasi ini memerlukan izin sertifikat/pencadangan.

Contoh penggunaan:

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

Menghasilkan cadangan sertifikat

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

Parameter

certificateName

string

Nama sertifikat

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<undefined | Uint8Array>

beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Membuat sertifikat baru. Jika ini adalah versi pertama, sumber daya sertifikat dibuat. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga sertifikat sepenuhnya pulih.

Catatan:Self Mengirim sebagai issuerName kebijakan sertifikat akan membuat sertifikat yang ditandatangani sendiri.

Operasi ini memerlukan izin sertifikat/pembuatan.

Contoh penggunaan:

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

Membuat sertifikat

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

Parameter

certificateName

string

Nama sertifikat

policy
CertificatePolicy
options
BeginCreateCertificateOptions

Parameter opsional

Mengembalikan

Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

beginDeleteCertificate(string, CertificatePollerOptions)

Operasi DELETE berlaku untuk sertifikat apa pun yang disimpan di Azure Key Vault. DELETE tidak dapat diterapkan ke versi individual sertifikat. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga sertifikat sepenuhnya pulih.

Operasi ini memerlukan izin sertifikat/hapus.

Contoh penggunaan:

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

Menghapus sertifikat dari brankas kunci tertentu.

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

Parameter

certificateName

string

Nama sertifikat.

options
CertificatePollerOptions

Parameter opsional

Mengembalikan

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Memulihkan sertifikat yang dihapus dalam vault yang ditentukan. Operasi ini hanya dapat dilakukan pada vault yang diaktifkan penghapusan sementara. Operasi ini Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda untuk menunggu tanpa batas waktu hingga sertifikat sepenuhnya pulih.

Operasi ini memerlukan izin sertifikat/pemulihan.

Contoh penggunaan:

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

Memulihkan sertifikat yang dihapus

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

Parameter

certificateName

string

Nama sertifikat yang dihapus

options
CertificatePollerOptions

Parameter opsional

Mengembalikan

Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

createIssuer(string, string, CreateIssuerOptions)

Operasi createIssuer menambahkan atau memperbarui penerbit sertifikat yang ditentukan. Operasi ini memerlukan izin sertifikat/setissuers.

Contoh penggunaan:

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

Mengatur penerbit sertifikat yang ditentukan.

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

Parameter

issuerName

string

Nama penerbit.

provider

string

Penyedia pengeluar sertifikat.

options
CreateIssuerOptions

Parameter opsional

Mengembalikan

Promise<CertificateIssuer>

deleteCertificateOperation(string, OperationOptions)

Menghapus operasi pembuatan untuk sertifikat tertentu yang sedang dalam proses dibuat. Sertifikat tidak lagi dibuat. Operasi ini memerlukan izin sertifikat/pembaruan.

Contoh penggunaan:

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"

Menghapus operasi sertifikat

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

Parameter

certificateName

string

Nama sertifikat

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<CertificateOperation>

deleteContacts(OperationOptions)

Menghapus semua kontak sertifikat. Operasi ini memerlukan izin sertifikat/managecontacts.

Contoh penggunaan:

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

Menghapus semua kontak sertifikat

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

Parameter

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<undefined | CertificateContact[]>

deleteIssuer(string, OperationOptions)

Operasi deleteIssuer menghapus pengeluar sertifikat yang ditentukan secara permanen dari vault. Operasi ini memerlukan izin sertifikat/manageissuers/deleteissuers.

Contoh penggunaan:

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

Menghapus pengeluar sertifikat yang ditentukan.

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

Parameter

issuerName

string

Nama penerbit.

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<CertificateIssuer>

getCertificate(string, OperationOptions)

Mendapatkan informasi terbaru yang tersedia dari sertifikat tertentu, termasuk kebijakan sertifikat. Operasi ini memerlukan izin sertifikat/dapatkan.

Contoh penggunaan:

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

Mengambil sertifikat dari nama sertifikat (termasuk kebijakan sertifikat)

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

Parameter

certificateName

string

Nama sertifikat

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, CertificatePollerOptions)

Mendapatkan operasi pembuatan yang terkait dengan sertifikat tertentu. Operasi ini memerlukan izin sertifikat/dapatkan. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga sertifikat sepenuhnya pulih.

Contoh penggunaan:

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

Mendapatkan operasi poller sertifikat

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

Parameter

certificateName

string

Nama sertifikat

options
CertificatePollerOptions

Parameter opsional

Mengembalikan

Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

getCertificatePolicy(string, OperationOptions)

Operasi getCertificatePolicy mengembalikan sumber daya kebijakan sertifikat yang ditentukan dalam brankas kunci yang ditentukan. Operasi ini memerlukan izin sertifikat/dapatkan.

Contoh penggunaan:

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

Mendapatkan kebijakan sertifikat

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

Parameter

certificateName

string

Nama sertifikat

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<CertificatePolicy>

getCertificateVersion(string, string, OperationOptions)

Mendapatkan informasi tentang sertifikat tertentu pada versi tertentu. Ini tidak akan mengembalikan kebijakan sertifikat. Operasi ini memerlukan izin sertifikat/dapatkan.

Contoh penggunaan:

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

Mengambil sertifikat dari nama sertifikat dan versi tertentu

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

Parameter

certificateName

string

Nama sertifikat

version

string

Versi sertifikat tertentu

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<KeyVaultCertificate>

getContacts(OperationOptions)

Mengembalikan sekumpulan sumber daya kontak sertifikat dalam brankas kunci yang ditentukan. Operasi ini memerlukan izin sertifikat/managecontacts.

Contoh penggunaan:

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

Mengatur kontak sertifikat.

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

Parameter

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<undefined | CertificateContact[]>

getDeletedCertificate(string, OperationOptions)

mengambil informasi sertifikat yang dihapus ditambah atributnya, seperti interval retensi, penghapusan permanen terjadwal, dan tingkat pemulihan penghapusan saat ini. Operasi ini memerlukan izin sertifikat/dapatkan.

Contoh penggunaan:

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

Mendapatkan sertifikat yang dihapus

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

Parameter

certificateName

string

Nama sertifikat

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<DeletedCertificate>

getIssuer(string, OperationOptions)

Operasi getIssuer mengembalikan sumber daya penerbit sertifikat yang ditentukan dalam brankas kunci yang ditentukan. Operasi ini memerlukan izin sertifikat/manageissuers/getissuers.

Contoh penggunaan:

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

Membuat dia menentukan pengeluar sertifikat.

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

Parameter

issuerName

string

Nama penerbit.

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<CertificateIssuer>

importCertificate(string, Uint8Array, ImportCertificateOptions)

Mengimpor sertifikat valid yang sudah ada, yang berisi kunci privat, ke azure Key Vault. Sertifikat yang akan diimpor dapat berada dalam format PFX atau PEM. Jika sertifikat dalam format PEM, file PEM harus berisi kunci serta sertifikat x509. Operasi ini memerlukan izin sertifikat/impor.

Contoh penggunaan:

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

Mengimpor sertifikat dari nilai rahasia sertifikat

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

Parameter

certificateName

string

Nama sertifikat

certificateBytes

Uint8Array

Nilai PFX atau ASCII PEM yang diformat dari sertifikat yang berisi sertifikat X.509 dan kunci privat

options
ImportCertificateOptions

Parameter opsional

Mengembalikan

Promise<KeyVaultCertificateWithPolicy>

listDeletedCertificates(ListDeletedCertificatesOptions)

Mengambil sertifikat dalam vault saat ini yang dalam status dihapus dan siap untuk pemulihan atau pembersihan. Operasi ini mencakup informasi khusus penghapusan. Operasi ini memerlukan izin sertifikat/dapatkan/daftar. Operasi ini hanya dapat diaktifkan pada vault yang diaktifkan penghapusan sementara.

Contoh penggunaan:

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

Mencantumkan sertifikat yang dihapus

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

Parameter

options
ListDeletedCertificatesOptions

Parameter opsional

Mengembalikan

PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Melakukan iterasi versi terbaru dari semua sertifikat di vault. Pengidentifikasi dan atribut sertifikat lengkap disediakan dalam respons. Tidak ada nilai yang dikembalikan untuk sertifikat. Operasi ini memerlukan izin sertifikat/daftar.

Contoh penggunaan:

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

Mencantumkan semua versi sertifikat yang ditentukan.

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

Parameter

options
ListPropertiesOfCertificatesOptions

Parameter opsional

Mengembalikan

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfCertificateVersions(string, OperationOptions)

Mengembalikan versi sertifikat dalam brankas kunci yang ditentukan. Operasi ini memerlukan izin sertifikat/daftar.

Contoh penggunaan:

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

Mencantumkan versi sertifikat.

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

Parameter

certificateName

string

Nama sertifikat.

options
OperationOptions

Parameter opsional

Mengembalikan

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfIssuers(OperationOptions)

Mengembalikan sekumpulan sumber daya penerbit sertifikat dalam brankas kunci yang ditentukan. Operasi ini memerlukan izin sertifikat/manageissuers/getissuers.

Contoh penggunaan:

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

Mencantumkan penerbit sertifikat.

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

Parameter

options
OperationOptions

Parameter opsional

Mengembalikan

PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

mergeCertificate(string, Uint8Array[], OperationOptions)

Melakukan penggabungan sertifikat atau rantai sertifikat dengan pasangan kunci yang saat ini tersedia dalam layanan. Operasi ini memerlukan izin sertifikat/pembuatan.

Contoh penggunaan:

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

Menggabungkan permintaan sertifikat yang ditandatangani ke dalam sertifikat yang tertunda

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

Parameter

certificateName

string

Nama sertifikat

x509Certificates

Uint8Array[]

Sertifikat yang akan digabungkan

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<KeyVaultCertificateWithPolicy>

purgeDeletedCertificate(string, OperationOptions)

Melakukan penghapusan sertifikat yang ditentukan yang tidak dapat diubah, tanpa kemungkinan untuk pemulihan. Operasi tidak tersedia jika tingkat pemulihan tidak menentukan 'Dapat Dibersihkan'. Operasi ini memerlukan izin sertifikat/hapus menyeluruh.

Contoh penggunaan:

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

Mendapatkan sertifikat yang dihapus

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

Parameter

certificateName

string

Nama sertifikat yang dihapus untuk dihapus menyeluruh

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<null>

restoreCertificateBackup(Uint8Array, OperationOptions)

Memulihkan sertifikat yang dicadangkan, dan semua versinya, ke vault. Operasi ini memerlukan izin sertifikat/pemulihan.

Contoh penggunaan:

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

Memulihkan sertifikat dari cadangan

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

Parameter

backup

Uint8Array

Sertifikat cadangan untuk dipulihkan

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<KeyVaultCertificateWithPolicy>

setContacts(CertificateContact[], OperationOptions)

Mengatur kontak sertifikat untuk brankas kunci. Operasi ini memerlukan izin sertifikat/managecontacts.

Contoh penggunaan:

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

Mengatur kontak sertifikat.

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

Parameter

contacts

CertificateContact[]

Kontak yang akan digunakan

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<undefined | CertificateContact[]>

updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Updates kebijakan sertifikat untuk sertifikat yang ditentukan. Operasi ini memerlukan izin sertifikat/pembaruan. Mendapatkan kebijakan sertifikat

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

Parameter

certificateName

string

Nama sertifikat

policy
CertificatePolicy

Kebijakan sertifikat

options
OperationOptions

Parameter opsional

Mengembalikan

Promise<CertificatePolicy>

updateCertificateProperties(string, string, UpdateCertificateOptions)

Menerapkan pembaruan yang ditentukan pada sertifikat yang diberikan; satu-satunya elemen yang diperbarui adalah atribut sertifikat. Operasi ini memerlukan izin sertifikat/pembaruan.

Contoh penggunaan:

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

Updates sertifikat

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

Parameter

certificateName

string

Nama sertifikat

version

string

Versi sertifikat yang akan diperbarui (string kosong akan memperbarui versi terbaru)

options
UpdateCertificateOptions

Opsi, termasuk apa yang harus diperbarui

Mengembalikan

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

Operasi updateIssuer melakukan pembaruan pada entitas penerbit sertifikat yang ditentukan. Operasi ini memerlukan izin sertifikat/setissuers.

Contoh penggunaan:

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

Updates penerbit sertifikat yang ditentukan.

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

Parameter

issuerName

string

Nama penerbit.

options
UpdateIssuerOptions

Parameter opsional

Mengembalikan

Promise<CertificateIssuer>