CertificateClient class

الحزمة:
@azure/keyvault-certificates

العميل للتفاعل مع وظيفة شهادات KeyVault

المنشئون

CertificateClient(string, TokenCredential, CertificateClientOptions)

إنشاء مثيل CertificateClient.

الخصائص

vaultUrl

عنوان URL الأساسي للمخزن

الأساليب

backupCertificate(string, OperationOptions)

يطلب تنزيل نسخة احتياطية من الشهادة المحددة إلى العميل. سيتم تنزيل جميع إصدارات الشهادة. تتطلب هذه العملية إذن الشهادات/النسخ الاحتياطي.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

إنشاء نسخة احتياطية من شهادة
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

إنشاء شهادة جديدة. إذا كان هذا هو الإصدار الأول، يتم إنشاء مورد الشهادة. تقوم هذه الدالة بإرجاع استقصاء عملية طويلة الأمد الذي يسمح لك بالانتظار إلى أجل غير مسمى حتى يتم استرداد الشهادة بالكامل.

ملاحظة : سيؤدي إرسال SelfissuerName نهج الشهادة إلى إنشاء شهادة موقعة ذاتيا.

تتطلب هذه العملية إذن الشهادات/الإنشاء.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert",
};

const poller = await client.beginCreateCertificate(certificateName, certificatePolicy);

// You can use the pending certificate immediately:
const pendingCertificate = poller.getResult();

// Or you can wait until the certificate finishes being signed:
const keyVaultCertificate = await poller.pollUntilDone();
console.log(keyVaultCertificate);

إنشاء شهادة
beginDeleteCertificate(string, CertificatePollerOptions)

تنطبق عملية DELETE على أي شهادة مخزنة في Azure Key Vault. لا يمكن تطبيق DELETE على إصدار فردي من الشهادة. تقوم هذه الدالة بإرجاع استقصاء عملية طويلة الأمد الذي يسمح لك بالانتظار إلى أجل غير مسمى حتى يتم استرداد الشهادة بالكامل.

تتطلب هذه العملية إذن الشهادات/الحذف.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const certificateName = "MyCertificate";

const poller = await client.beginDeleteCertificate(certificateName);

// You can use the deleted certificate immediately:
const deletedCertificate = poller.getResult();

// The certificate is being deleted. Only wait for it if you want to restore it or purge it.
await poller.pollUntilDone();

// You can also get the deleted certificate this way:
await client.getDeletedCertificate(certificateName);

// Deleted certificates can also be recovered or purged.

// recoverDeletedCertificate returns a poller, just like beginDeleteCertificate.
// const recoverPoller = await client.beginRecoverDeletedCertificate(certificateName);
// await recoverPoller.pollUntilDone();

// If a certificate is done and the Key Vault has soft-delete enabled, the certificate can be purged with:
await client.purgeDeletedCertificate(certificateName);

حذف شهادة من مخزن مفاتيح محدد.
beginRecoverDeletedCertificate(string, CertificatePollerOptions)

استرداد الشهادة المحذوفة في المخزن المحدد. يمكن تنفيذ هذه العملية فقط على مخزن ممكن للحذف المبدئي. هذه العملية تقوم هذه الدالة بإرجاع استقصاء عملية طويلة الأمد التي تسمح لك بالانتظار إلى أجل غير مسمى حتى يتم استرداد الشهادة بالكامل.

تتطلب هذه العملية إذن الشهادات/الاسترداد.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

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

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

استرداد شهادة محذوفة
createIssuer(string, string, CreateIssuerOptions)

تضيف عملية createIssuer مصدر الشهادة المحدد أو تحدثه. تتطلب هذه العملية إذن الشهادات/setissuers.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.createIssuer("IssuerName", "Test");

تعيين مصدر الشهادة المحدد.
deleteCertificateOperation(string, OperationOptions)

حذف عملية الإنشاء لشهادة محددة قيد الإنشاء. لم يعد يتم إنشاء الشهادة. تتطلب هذه العملية إذن الشهادات/التحديث.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert",
});
await client.deleteCertificateOperation("MyCertificate");

await client.getCertificateOperation("MyCertificate");

حذف عملية الشهادة
deleteContacts(OperationOptions)

حذف كافة جهات اتصال الشهادة. تتطلب هذه العملية إذن الشهادات/التحكمات.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.deleteContacts();

حذف كافة جهات اتصال الشهادة
deleteIssuer(string, OperationOptions)

تقوم عملية deleteIssuer بإزالة مصدر الشهادة المحدد نهائيا من المخزن. تتطلب هذه العملية إذن الشهادات/manageissuers/deleteissuers.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.deleteIssuer("IssuerName");

حذف مصدر الشهادة المحدد.
getCertificate(string, OperationOptions)

الحصول على أحدث المعلومات المتوفرة من شهادة معينة، بما في ذلك نهج الشهادة. تتطلب هذه العملية الحصول على الشهادات/الحصول على إذن.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const certificateName = "MyCertificate";

const result = await client.getCertificate(certificateName);
console.log(result.name);

استرداد شهادة من اسم الشهادة (بما في ذلك نهج الشهادة)
getCertificateOperation(string, CertificatePollerOptions)

يحصل على عملية الإنشاء المقترنة بشهادة محددة. تتطلب هذه العملية الحصول على الشهادات/الحصول على إذن. تقوم هذه الدالة بإرجاع استقصاء عملية طويلة الأمد الذي يسمح لك بالانتظار إلى أجل غير مسمى حتى يتم استرداد الشهادة بالكامل.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

الحصول على عملية استقصاء الشهادة
getCertificatePolicy(string, OperationOptions)

ترجع عملية getCertificatePolicy موارد نهج الشهادة المحددة في مخزن المفاتيح المحدد. تتطلب هذه العملية الحصول على الشهادات/الحصول على إذن.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const policy = await client.getCertificatePolicy("MyCertificate");
console.log(policy);

الحصول على نهج الشهادة
getCertificateVersion(string, string, OperationOptions)

الحصول على معلومات حول شهادة معينة على إصدار معين. لن يرجع نهج الشهادة. تتطلب هذه العملية الحصول على الشهادات/الحصول على إذن.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";

const latestCertificate = await client.getCertificate(certificateName);
console.log(`Latest version of the certificate ${certificateName}: `, latestCertificate);
const specificCertificate = await client.getCertificateVersion(
  certificateName,
  latestCertificate.properties.version,
);
console.log(
  `The certificate ${certificateName} at the version ${latestCertificate.properties.version}: `,
  specificCertificate,
);

استرداد شهادة من اسم الشهادة وإصدار محدد
getContacts(OperationOptions)

إرجاع مجموعة موارد جهة اتصال الشهادة في مخزن المفاتيح المحدد. تتطلب هذه العملية إذن الشهادات/التحكمات.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const contacts = await client.getContacts();
for (const contact of contacts) {
  console.log(contact);
}

تعيين جهات اتصال الشهادة.
getDeletedCertificate(string, OperationOptions)

يسترد معلومات الشهادة المحذوفة بالإضافة إلى سماتها، مثل الفاصل الزمني للاستبقاء والحذف الدائم المجدول ومستوى استرداد الحذف الحالي. تتطلب هذه العملية الحصول على الشهادات/الحصول على إذن.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

الحصول على شهادة محذوفة
getIssuer(string, OperationOptions)

ترجع عملية getIssuer موارد مصدر الشهادة المحددة في مخزن المفاتيح المحدد. تتطلب هذه العملية إذن الشهادات/manageissuers/getissuers.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const certificateIssuer = await client.getIssuer("IssuerName");
console.log(certificateIssuer);

يحصل على مصدر الشهادة المحدد.
importCertificate(string, Uint8Array, ImportCertificateOptions)

استيراد شهادة صالحة موجودة، تحتوي على مفتاح خاص، إلى Azure Key Vault. يمكن أن تكون الشهادة التي سيتم استيرادها بتنسيق PFX أو PEM. إذا كانت الشهادة بتنسيق PEM، يجب أن يحتوي ملف PEM على المفتاح بالإضافة إلى شهادات x509. تتطلب هذه العملية إذن الشهادات/الاستيراد.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
import { SecretClient } from "@azure/keyvault-secrets";
import { isNodeLike } from "@azure/core-util";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);
const secretClient = new SecretClient(url, credential);

const certificateSecret = await secretClient.getSecret("MyCertificate");
const base64EncodedCertificate = certificateSecret.value!;

const buffer = isNodeLike
  ? Buffer.from(base64EncodedCertificate, "base64")
  : Uint8Array.from(atob(base64EncodedCertificate), (c) => c.charCodeAt(0));
await client.importCertificate("MyCertificate", buffer);

استيراد شهادة من قيمة سرية للشهادة
listDeletedCertificates(ListDeletedCertificatesOptions)

استرداد الشهادات الموجودة في المخزن الحالي والتي تكون في حالة حذف وجاهزة للاسترداد أو التطهير. تتضمن هذه العملية معلومات خاصة بالحذف. تتطلب هذه العملية إذن الشهادات/الحصول/القائمة. يمكن تمكين هذه العملية فقط على الخزائن الممكنة للحذف المبدئي.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

سرد الشهادات المحذوفة
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

تكرار أحدث إصدار من جميع الشهادات في المخزن. يتم توفير معرف الشهادة الكامل والسمات في الاستجابة. لا يتم إرجاع أي قيم للشهادات. تتطلب هذه العمليات إذن الشهادات/القائمة.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

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

سرد كافة إصدارات الشهادة المحددة.
listPropertiesOfCertificateVersions(string, OperationOptions)

إرجاع إصدارات الشهادة في مخزن المفاتيح المحدد. تتطلب هذه العملية إذن الشهادات/القائمة.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

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

سرد إصدارات الشهادة.
listPropertiesOfIssuers(OperationOptions)

إرجاع مجموعة موارد مصدر الشهادة في مخزن المفاتيح المحدد. تتطلب هذه العملية إذن الشهادات/manageissuers/getissuers.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

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

سرد مصدري الشهادة.
mergeCertificate(string, Uint8Array[], OperationOptions)

تنفيذ دمج شهادة أو سلسلة شهادات مع زوج مفاتيح متوفر حاليا في الخدمة. تتطلب هذه العملية إذن الشهادات/الإنشاء.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
import { writeFileSync, readFileSync } from "node:fs";
import { execSync } from "node:child_process";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

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

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

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

دمج طلب شهادة موقعة في شهادة معلقة
purgeDeletedCertificate(string, OperationOptions)

تنفيذ حذف لا رجعة فيه من الشهادة المحددة، دون إمكانية الاسترداد. لا تتوفر العملية إذا لم يحدد مستوى الاسترداد "قابلا للتطهير". تتطلب هذه العملية إذن الشهادة/المسح.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

// Deleting a certificate takes time, make sure to wait before purging it
client.purgeDeletedCertificate("MyCertificate");

الحصول على شهادة محذوفة
restoreCertificateBackup(Uint8Array, OperationOptions)

استعادة شهادة تم نسخها احتياطيا، وجميع إصداراتها، إلى مخزن. تتطلب هذه العملية إذن الشهادات/الاستعادة.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

استعادة شهادة من نسخة احتياطية
setContacts(CertificateContact[], OperationOptions)

تعيين جهات اتصال الشهادة لمخزن المفاتيح. تتطلب هذه العملية إذن الشهادات/التحكمات.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.setContacts([
  {
    email: "b@b.com",
    name: "b",
    phone: "222222222222",
  },
]);

تعيين جهات اتصال الشهادة.
updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

تحديث نهج الشهادة للشهادة المحددة. تتطلب هذه العملية إذن الشهادات/التحديث. الحصول على نهج الشهادة
updateCertificateProperties(string, string, UpdateCertificatePropertiesOptions)

تطبيق التحديث المحدد على الشهادة المحددة؛ العناصر الوحيدة المحدثة هي سمات الشهادة. تتطلب هذه العملية إذن الشهادات/التحديث.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

تحديث شهادة
updateIssuer(string, UpdateIssuerOptions)

تقوم عملية updateIssuer بإجراء تحديث على كيان مصدر الشهادة المحدد. تتطلب هذه العملية إذن الشهادات/setissuers.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.updateIssuer("IssuerName", {
  provider: "Provider2",
});

تحديث مصدر الشهادة المحدد.

تفاصيل المنشئ

CertificateClient(string, TokenCredential, CertificateClientOptions)

إنشاء مثيل CertificateClient.

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

المعلمات

vaultUrl

string

عنوان URL الأساسي للمخزن. يجب التحقق من أن عنوان URL هذا يشير إلى مورد Key Vault صالح. راجع https://aka.ms/azsdk/blog/vault-uri للحصول على التفاصيل.

credential
TokenCredential

كائن ينفذ واجهة TokenCredential المستخدمة لمصادقة الطلبات إلى الخدمة. استخدم حزمة @azure/identity لإنشاء بيانات اعتماد تناسب احتياجاتك.

clientOptions
CertificateClientOptions

خيارات البنية الأساسية لبرنامج ربط العمليات التجارية المستخدمة لتكوين طلبات واجهة برمجة تطبيقات Key Vault. احذف هذه المعلمة لاستخدام تكوين المسار الافتراضي.

تفاصيل الخاصية

vaultUrl

عنوان URL الأساسي للمخزن

vaultUrl: string

قيمة الخاصية

string

تفاصيل الأسلوب

backupCertificate(string, OperationOptions)

يطلب تنزيل نسخة احتياطية من الشهادة المحددة إلى العميل. سيتم تنزيل جميع إصدارات الشهادة. تتطلب هذه العملية إذن الشهادات/النسخ الاحتياطي.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

إنشاء نسخة احتياطية من شهادة

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

المعلمات

certificateName

string

اسم الشهادة

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<undefined | Uint8Array>

beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

إنشاء شهادة جديدة. إذا كان هذا هو الإصدار الأول، يتم إنشاء مورد الشهادة. تقوم هذه الدالة بإرجاع استقصاء عملية طويلة الأمد الذي يسمح لك بالانتظار إلى أجل غير مسمى حتى يتم استرداد الشهادة بالكامل.

ملاحظة : سيؤدي إرسال SelfissuerName نهج الشهادة إلى إنشاء شهادة موقعة ذاتيا.

تتطلب هذه العملية إذن الشهادات/الإنشاء.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";
const certificatePolicy = {
  issuerName: "Self",
  subject: "cn=MyCert",
};

const poller = await client.beginCreateCertificate(certificateName, certificatePolicy);

// You can use the pending certificate immediately:
const pendingCertificate = poller.getResult();

// Or you can wait until the certificate finishes being signed:
const keyVaultCertificate = await poller.pollUntilDone();
console.log(keyVaultCertificate);

إنشاء شهادة

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

المعلمات

certificateName

string

اسم الشهادة

policy
CertificatePolicy
options
BeginCreateCertificateOptions

المعلمات الاختيارية

المرتجعات

Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

beginDeleteCertificate(string, CertificatePollerOptions)

تنطبق عملية DELETE على أي شهادة مخزنة في Azure Key Vault. لا يمكن تطبيق DELETE على إصدار فردي من الشهادة. تقوم هذه الدالة بإرجاع استقصاء عملية طويلة الأمد الذي يسمح لك بالانتظار إلى أجل غير مسمى حتى يتم استرداد الشهادة بالكامل.

تتطلب هذه العملية إذن الشهادات/الحذف.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const certificateName = "MyCertificate";

const poller = await client.beginDeleteCertificate(certificateName);

// You can use the deleted certificate immediately:
const deletedCertificate = poller.getResult();

// The certificate is being deleted. Only wait for it if you want to restore it or purge it.
await poller.pollUntilDone();

// You can also get the deleted certificate this way:
await client.getDeletedCertificate(certificateName);

// Deleted certificates can also be recovered or purged.

// recoverDeletedCertificate returns a poller, just like beginDeleteCertificate.
// const recoverPoller = await client.beginRecoverDeletedCertificate(certificateName);
// await recoverPoller.pollUntilDone();

// If a certificate is done and the Key Vault has soft-delete enabled, the certificate can be purged with:
await client.purgeDeletedCertificate(certificateName);

حذف شهادة من مخزن مفاتيح محدد.

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

المعلمات

certificateName

string

اسم الشهادة.

options
CertificatePollerOptions

المعلمات الاختيارية

المرتجعات

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, CertificatePollerOptions)

استرداد الشهادة المحذوفة في المخزن المحدد. يمكن تنفيذ هذه العملية فقط على مخزن ممكن للحذف المبدئي. هذه العملية تقوم هذه الدالة بإرجاع استقصاء عملية طويلة الأمد التي تسمح لك بالانتظار إلى أجل غير مسمى حتى يتم استرداد الشهادة بالكامل.

تتطلب هذه العملية إذن الشهادات/الاسترداد.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

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

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

استرداد شهادة محذوفة

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

المعلمات

certificateName

string

اسم الشهادة المحذوفة

options
CertificatePollerOptions

المعلمات الاختيارية

المرتجعات

Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

createIssuer(string, string, CreateIssuerOptions)

تضيف عملية createIssuer مصدر الشهادة المحدد أو تحدثه. تتطلب هذه العملية إذن الشهادات/setissuers.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.createIssuer("IssuerName", "Test");

تعيين مصدر الشهادة المحدد.

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

المعلمات

issuerName

string

اسم المصدر.

provider

string

موفر المصدر.

options
CreateIssuerOptions

المعلمات الاختيارية

المرتجعات

Promise<CertificateIssuer>

deleteCertificateOperation(string, OperationOptions)

حذف عملية الإنشاء لشهادة محددة قيد الإنشاء. لم يعد يتم إنشاء الشهادة. تتطلب هذه العملية إذن الشهادات/التحديث.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

await client.beginCreateCertificate("MyCertificate", {
  issuerName: "Self",
  subject: "cn=MyCert",
});
await client.deleteCertificateOperation("MyCertificate");

await client.getCertificateOperation("MyCertificate");

حذف عملية الشهادة

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

المعلمات

certificateName

string

اسم الشهادة

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<CertificateOperation>

deleteContacts(OperationOptions)

حذف كافة جهات اتصال الشهادة. تتطلب هذه العملية إذن الشهادات/التحكمات.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.deleteContacts();

حذف كافة جهات اتصال الشهادة

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

المعلمات

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<undefined | CertificateContact[]>

deleteIssuer(string, OperationOptions)

تقوم عملية deleteIssuer بإزالة مصدر الشهادة المحدد نهائيا من المخزن. تتطلب هذه العملية إذن الشهادات/manageissuers/deleteissuers.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.deleteIssuer("IssuerName");

حذف مصدر الشهادة المحدد.

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

المعلمات

issuerName

string

اسم المصدر.

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<CertificateIssuer>

getCertificate(string, OperationOptions)

الحصول على أحدث المعلومات المتوفرة من شهادة معينة، بما في ذلك نهج الشهادة. تتطلب هذه العملية الحصول على الشهادات/الحصول على إذن.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const certificateName = "MyCertificate";

const result = await client.getCertificate(certificateName);
console.log(result.name);

استرداد شهادة من اسم الشهادة (بما في ذلك نهج الشهادة)

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

المعلمات

certificateName

string

اسم الشهادة

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, CertificatePollerOptions)

يحصل على عملية الإنشاء المقترنة بشهادة محددة. تتطلب هذه العملية الحصول على الشهادات/الحصول على إذن. تقوم هذه الدالة بإرجاع استقصاء عملية طويلة الأمد الذي يسمح لك بالانتظار إلى أجل غير مسمى حتى يتم استرداد الشهادة بالكامل.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

الحصول على عملية استقصاء الشهادة

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

المعلمات

certificateName

string

اسم الشهادة

options
CertificatePollerOptions

المعلمات الاختيارية

المرتجعات

Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

getCertificatePolicy(string, OperationOptions)

ترجع عملية getCertificatePolicy موارد نهج الشهادة المحددة في مخزن المفاتيح المحدد. تتطلب هذه العملية الحصول على الشهادات/الحصول على إذن.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const policy = await client.getCertificatePolicy("MyCertificate");
console.log(policy);

الحصول على نهج الشهادة

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

المعلمات

certificateName

string

اسم الشهادة

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<CertificatePolicy>

getCertificateVersion(string, string, OperationOptions)

الحصول على معلومات حول شهادة معينة على إصدار معين. لن يرجع نهج الشهادة. تتطلب هذه العملية الحصول على الشهادات/الحصول على إذن.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

const certificateName = "MyCertificateName";

const latestCertificate = await client.getCertificate(certificateName);
console.log(`Latest version of the certificate ${certificateName}: `, latestCertificate);
const specificCertificate = await client.getCertificateVersion(
  certificateName,
  latestCertificate.properties.version,
);
console.log(
  `The certificate ${certificateName} at the version ${latestCertificate.properties.version}: `,
  specificCertificate,
);

استرداد شهادة من اسم الشهادة وإصدار محدد

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

المعلمات

certificateName

string

اسم الشهادة

version

string

الإصدار المحدد من الشهادة

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<KeyVaultCertificate>

getContacts(OperationOptions)

إرجاع مجموعة موارد جهة اتصال الشهادة في مخزن المفاتيح المحدد. تتطلب هذه العملية إذن الشهادات/التحكمات.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const contacts = await client.getContacts();
for (const contact of contacts) {
  console.log(contact);
}

تعيين جهات اتصال الشهادة.

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

المعلمات

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<undefined | CertificateContact[]>

getDeletedCertificate(string, OperationOptions)

يسترد معلومات الشهادة المحذوفة بالإضافة إلى سماتها، مثل الفاصل الزمني للاستبقاء والحذف الدائم المجدول ومستوى استرداد الحذف الحالي. تتطلب هذه العملية الحصول على الشهادات/الحصول على إذن.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

الحصول على شهادة محذوفة

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

المعلمات

certificateName

string

اسم الشهادة

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<DeletedCertificate>

getIssuer(string, OperationOptions)

ترجع عملية getIssuer موارد مصدر الشهادة المحددة في مخزن المفاتيح المحدد. تتطلب هذه العملية إذن الشهادات/manageissuers/getissuers.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

const certificateIssuer = await client.getIssuer("IssuerName");
console.log(certificateIssuer);

يحصل على مصدر الشهادة المحدد.

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

المعلمات

issuerName

string

اسم المصدر.

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<CertificateIssuer>

importCertificate(string, Uint8Array, ImportCertificateOptions)

استيراد شهادة صالحة موجودة، تحتوي على مفتاح خاص، إلى Azure Key Vault. يمكن أن تكون الشهادة التي سيتم استيرادها بتنسيق PFX أو PEM. إذا كانت الشهادة بتنسيق PEM، يجب أن يحتوي ملف PEM على المفتاح بالإضافة إلى شهادات x509. تتطلب هذه العملية إذن الشهادات/الاستيراد.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
import { SecretClient } from "@azure/keyvault-secrets";
import { isNodeLike } from "@azure/core-util";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);
const secretClient = new SecretClient(url, credential);

const certificateSecret = await secretClient.getSecret("MyCertificate");
const base64EncodedCertificate = certificateSecret.value!;

const buffer = isNodeLike
  ? Buffer.from(base64EncodedCertificate, "base64")
  : Uint8Array.from(atob(base64EncodedCertificate), (c) => c.charCodeAt(0));
await client.importCertificate("MyCertificate", buffer);

استيراد شهادة من قيمة سرية للشهادة

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

المعلمات

certificateName

string

اسم الشهادة

certificateBytes

Uint8Array

القيمة المنسقة PFX أو ASCII PEM للشهادة التي تحتوي على كل من شهادات X.509 والمفتاح الخاص

options
ImportCertificateOptions

المعلمات الاختيارية

المرتجعات

Promise<KeyVaultCertificateWithPolicy>

listDeletedCertificates(ListDeletedCertificatesOptions)

استرداد الشهادات الموجودة في المخزن الحالي والتي تكون في حالة حذف وجاهزة للاسترداد أو التطهير. تتضمن هذه العملية معلومات خاصة بالحذف. تتطلب هذه العملية إذن الشهادات/الحصول/القائمة. يمكن تمكين هذه العملية فقط على الخزائن الممكنة للحذف المبدئي.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

سرد الشهادات المحذوفة

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

المعلمات

options
ListDeletedCertificatesOptions

المعلمات الاختيارية

المرتجعات

PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

تكرار أحدث إصدار من جميع الشهادات في المخزن. يتم توفير معرف الشهادة الكامل والسمات في الاستجابة. لا يتم إرجاع أي قيم للشهادات. تتطلب هذه العمليات إذن الشهادات/القائمة.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

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

سرد كافة إصدارات الشهادة المحددة.

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

المعلمات

options
ListPropertiesOfCertificatesOptions

المعلمات الاختيارية

المرتجعات

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfCertificateVersions(string, OperationOptions)

إرجاع إصدارات الشهادة في مخزن المفاتيح المحدد. تتطلب هذه العملية إذن الشهادات/القائمة.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

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

سرد إصدارات الشهادة.

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

المعلمات

certificateName

string

اسم الشهادة.

options
OperationOptions

المعلمات الاختيارية

المرتجعات

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfIssuers(OperationOptions)

إرجاع مجموعة موارد مصدر الشهادة في مخزن المفاتيح المحدد. تتطلب هذه العملية إذن الشهادات/manageissuers/getissuers.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

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

سرد مصدري الشهادة.

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

المعلمات

options
OperationOptions

المعلمات الاختيارية

المرتجعات

PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

mergeCertificate(string, Uint8Array[], OperationOptions)

تنفيذ دمج شهادة أو سلسلة شهادات مع زوج مفاتيح متوفر حاليا في الخدمة. تتطلب هذه العملية إذن الشهادات/الإنشاء.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";
import { writeFileSync, readFileSync } from "node:fs";
import { execSync } from "node:child_process";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

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

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

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

دمج طلب شهادة موقعة في شهادة معلقة

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

المعلمات

certificateName

string

اسم الشهادة

x509Certificates

Uint8Array[]

الشهادة (الشهادات) المراد دمجها

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<KeyVaultCertificateWithPolicy>

purgeDeletedCertificate(string, OperationOptions)

تنفيذ حذف لا رجعة فيه من الشهادة المحددة، دون إمكانية الاسترداد. لا تتوفر العملية إذا لم يحدد مستوى الاسترداد "قابلا للتطهير". تتطلب هذه العملية إذن الشهادة/المسح.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

// Deleting a certificate takes time, make sure to wait before purging it
client.purgeDeletedCertificate("MyCertificate");

الحصول على شهادة محذوفة

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

المعلمات

certificateName

string

اسم الشهادة المحذوفة لإزالتها

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<null>

restoreCertificateBackup(Uint8Array, OperationOptions)

استعادة شهادة تم نسخها احتياطيا، وجميع إصداراتها، إلى مخزن. تتطلب هذه العملية إذن الشهادات/الاستعادة.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

استعادة شهادة من نسخة احتياطية

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

المعلمات

backup

Uint8Array

شهادة النسخ الاحتياطي للاستعادة منها

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<KeyVaultCertificateWithPolicy>

setContacts(CertificateContact[], OperationOptions)

تعيين جهات اتصال الشهادة لمخزن المفاتيح. تتطلب هذه العملية إذن الشهادات/التحكمات.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.setContacts([
  {
    email: "b@b.com",
    name: "b",
    phone: "222222222222",
  },
]);

تعيين جهات اتصال الشهادة.

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

المعلمات

contacts

CertificateContact[]

جهات الاتصال التي يجب استخدامها

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<undefined | CertificateContact[]>

updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

تحديث نهج الشهادة للشهادة المحددة. تتطلب هذه العملية إذن الشهادات/التحديث. الحصول على نهج الشهادة

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

المعلمات

certificateName

string

اسم الشهادة

policy
CertificatePolicy

نهج الشهادة

options
OperationOptions

المعلمات الاختيارية

المرتجعات

Promise<CertificatePolicy>

updateCertificateProperties(string, string, UpdateCertificatePropertiesOptions)

تطبيق التحديث المحدد على الشهادة المحددة؛ العناصر الوحيدة المحدثة هي سمات الشهادة. تتطلب هذه العملية إذن الشهادات/التحديث.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(url, credential);

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

تحديث شهادة

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

المعلمات

certificateName

string

اسم الشهادة

version

string

إصدار الشهادة المراد تحديثها (ستقوم سلسلة فارغة بتحديث أحدث إصدار)

options
UpdateCertificateOptions

الخيارات، بما في ذلك ما يجب تحديثه

المرتجعات

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

تقوم عملية updateIssuer بإجراء تحديث على كيان مصدر الشهادة المحدد. تتطلب هذه العملية إذن الشهادات/setissuers.

مثال على الاستخدام:

import { DefaultAzureCredential } from "@azure/identity";
import { CertificateClient } from "@azure/keyvault-certificates";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const keyVaultUrl = `https://${vaultName}.vault.azure.net`;

const client = new CertificateClient(keyVaultUrl, credential);

await client.updateIssuer("IssuerName", {
  provider: "Provider2",
});

تحديث مصدر الشهادة المحدد.

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

المعلمات

issuerName

string

اسم المصدر.

options
UpdateIssuerOptions

المعلمات الاختيارية

المرتجعات

Promise<CertificateIssuer>