CertificateClient class

  • Başvuru
Paket:
@azure/keyvault-certificates

KeyVault sertifikaları işlevselliğiyle etkileşime geçmek için istemci

Oluşturucular

CertificateClient(string, TokenCredential, CertificateClientOptions)

CertificateClient'ın bir örneğini oluşturur.

Özellikler

vaultUrl

Kasanın temel URL'si

Yöntemler

backupCertificate(string, OperationOptions)

Belirtilen sertifikanın bir yedeğinin istemciye indirilmesi için istekte bulunur. Sertifikanın tüm sürümleri indirilir. Bu işlem sertifikalar/yedekleme izni gerektirir.

Örnek kullanım: 

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

Sertifikanın yedeğini oluşturur
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Yeni bir sertifika oluşturur. Bu ilk sürümse sertifika kaynağı oluşturulur. Bu işlev, sertifika tamamen kurtarılana kadar süresiz olarak beklemenizi sağlayan Uzun Süre Çalışan bir İşlem poller döndürür.

Not: Sertifikanın issuerName ilkesi olarak göndermek Self otomatik olarak imzalanan bir sertifika oluşturur.

Bu işlem için sertifikalar/oluşturma izni gerekir.

Örnek kullanım: 

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

Sertifika oluşturur
beginDeleteCertificate(string, CertificatePollerOptions)

DELETE işlemi, Azure Key Vault'de depolanan tüm sertifikalar için geçerlidir. DELETE, sertifikanın tek bir sürümüne uygulanamaz. Bu işlev, sertifika tamamen kurtarılana kadar süresiz olarak beklemenizi sağlayan Uzun Süre Çalışan bir İşlem poller döndürür.

Bu işlem sertifikalar/silme izni gerektirir.

Örnek kullanım: 

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

Belirtilen anahtar kasasından sertifika siler.
beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Belirtilen kasada silinen sertifikayı kurtarır. Bu işlem yalnızca geçici silme özellikli bir kasada gerçekleştirilebilir. Bu işlem Bu işlev, sertifika tamamen kurtarılana kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir İşlem poller döndürür.

Bu işlem sertifikalar/kurtarma izni gerektirir.

Örnek kullanım: 

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

Silinen bir sertifikayı kurtarır
createIssuer(string, string, CreateIssuerOptions)

createIssuer işlemi, belirtilen sertifikayı vereni ekler veya güncelleştirir. Bu işlem sertifikalar/setissuers izni gerektirir.

Örnek kullanım: 

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

Belirtilen sertifikayı vereni ayarlar.
deleteCertificateOperation(string, OperationOptions)

Oluşturulma sürecinde olan belirli bir sertifika için oluşturma işlemini siler. Sertifika artık oluşturulmaz. Bu işlem sertifikalar/güncelleştirme izni gerektirir.

Örnek kullanım: 

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"

Sertifikanın işlemini silme
deleteContacts(OperationOptions)

Tüm sertifika kişilerini siler. Bu işlem sertifikalar/managecontacts izni gerektirir.

Örnek kullanım: 

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

Tüm sertifika kişilerini siler
deleteIssuer(string, OperationOptions)

deleteIssuer işlemi, belirtilen sertifikayı vereni kasadan kalıcı olarak kaldırır. Bu işlem sertifikalar/manageissuers/deleteissuers izni gerektirir.

Örnek kullanım: 

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

Belirtilen sertifikayı vereni siler.
getCertificate(string, OperationOptions)

Sertifikanın ilkesi de dahil olmak üzere belirli bir sertifikadan sağlanan en son bilgileri alır. Bu işlem sertifikalar/alma izni gerektirir.

Örnek kullanım: 

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

Sertifikanın adından bir sertifika alır (sertifika ilkesini içerir)
getCertificateOperation(string, CertificatePollerOptions)

Belirtilen sertifikayla ilişkili oluşturma işlemini alır. Bu işlem sertifikalar/alma izni gerektirir. Bu işlev, sertifika tamamen kurtarılana kadar süresiz olarak beklemenizi sağlayan Uzun Süre Çalışan bir İşlem poller döndürür.

Örnek kullanım: 

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

Sertifikanın poller işlemini alır
getCertificatePolicy(string, OperationOptions)

getCertificatePolicy işlemi, belirtilen anahtar kasasında belirtilen sertifika ilkesi kaynaklarını döndürür. Bu işlem sertifikalar/alma izni gerektirir.

Örnek kullanım: 

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

Sertifikanın ilkesini alır
getCertificateVersion(string, string, OperationOptions)

Belirli bir sürümdeki belirli bir sertifika hakkında bilgi alır. Sertifikanın ilkesini döndürmez. Bu işlem sertifikalar/alma izni gerektirir.

Örnek kullanım: 

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

Sertifikanın adından ve belirtilen sürümden bir sertifika alır
getContacts(OperationOptions)

Belirtilen anahtar kasasında sertifika iletişim kaynakları kümesini döndürür. Bu işlem sertifikalar/managecontacts izni gerektirir.

Örnek kullanım: 

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

Sertifika kişilerini ayarlar.
getDeletedCertificate(string, OperationOptions)

silinen sertifika bilgilerinin yanı sıra bekletme aralığı, zamanlanmış kalıcı silme ve geçerli silme kurtarma düzeyi gibi özniteliklerini alır. Bu işlem sertifikalar/alma izni gerektirir.

Örnek kullanım: 

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

Silinen sertifikayı alır
getIssuer(string, OperationOptions)

getIssuer işlemi, belirtilen anahtar kasasında belirtilen sertifikayı veren kaynakları döndürür. Bu işlem sertifikalar/manageissuers/getissuers izni gerektirir.

Örnek kullanım: 

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

Belirtilen sertifikayı vereni alır.
importCertificate(string, Uint8Array, ImportCertificateOptions)

Özel anahtar içeren mevcut geçerli bir sertifikayı Azure Key Vault'e aktarır. İçeri aktarılacak sertifika PFX veya PEM biçiminde olabilir. Sertifika PEM biçimindeyse, PEM dosyası hem anahtarı hem de x509 sertifikalarını içermelidir. Bu işlem için sertifikalar/içeri aktarma izni gerekir.

Örnek kullanım: 

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

Sertifikanın gizli dizi değerinden sertifikayı içeri aktarır
listDeletedCertificates(ListDeletedCertificatesOptions)

Geçerli kasada silinmiş durumda olan ve kurtarma veya temizleme için hazır olan sertifikaları alır. Bu işlem silmeye özgü bilgileri içerir. Bu işlem sertifikalar/get/list izni gerektirir. Bu işlem yalnızca geçici silme özellikli kasalarda etkinleştirilebilir.

Örnek kullanım: 

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

Silinen sertifikaları listeler
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Kasadaki tüm sertifikaların en son sürümünü yineler. Tam sertifika tanımlayıcısı ve öznitelikleri yanıtta sağlanır. Sertifikalar için değer döndürülmedi. Bu işlemler sertifikalar/liste izni gerektirir.

Örnek kullanım: 

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

Belirtilen sertifikanın tüm sürümlerini listeleyin.
listPropertiesOfCertificateVersions(string, OperationOptions)

Belirtilen anahtar kasasında bir sertifikanın sürümlerini döndürür. Bu işlem sertifikalar/liste izni gerektirir.

Örnek kullanım: 

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

Bir sertifikanın sürümlerini listeleyin.
listPropertiesOfIssuers(OperationOptions)

Belirtilen anahtar kasasında sertifika veren kaynak kümesini döndürür. Bu işlem sertifikalar/manageissuers/getissuers izni gerektirir.

Örnek kullanım: 

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

Sertifika verenleri listeleyin.
mergeCertificate(string, Uint8Array[], OperationOptions)

Bir sertifikanın veya sertifika zincirinin, hizmette şu anda kullanılabilir durumda olan bir anahtar çifti ile birleştirilmesini gerçekleştirir. Bu işlem için sertifikalar/oluşturma izni gerekir.

Örnek kullanım: 

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

İmzalı sertifika isteğini bekleyen bir sertifikayla birleştirir
purgeDeletedCertificate(string, OperationOptions)

Kurtarma olasılığı olmadan belirtilen sertifikanın geri alınamaz silme işlemini gerçekleştirir. Kurtarma düzeyi 'Temizlenebilir' belirtmiyorsa işlem kullanılamaz. Bu işlem sertifika/temizleme izni gerektirir.

Örnek kullanım: 

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

Silinen sertifikayı alır
restoreCertificateBackup(Uint8Array, OperationOptions)

Yedeklenen bir sertifikayı ve tüm sürümlerini bir kasaya geri yükler. Bu işlem sertifikalar/geri yükleme izni gerektirir.

Örnek kullanım: 

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

Bir sertifikayı yedekten geri yükler
setContacts(CertificateContact[], OperationOptions)

Anahtar kasası için sertifika kişilerini ayarlar. Bu işlem sertifikalar/managecontacts izni gerektirir.

Örnek kullanım: 

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

Sertifika kişilerini ayarlar.
updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Belirtilen sertifika için sertifika ilkesini Güncelleştirmeler. Bu işlem sertifikalar/güncelleştirme izni gerektirir. Sertifikanın ilkesini alır
updateCertificateProperties(string, string, UpdateCertificateOptions)

Belirtilen güncelleştirmeyi verilen sertifikaya uygular; güncelleştirilen öğeler yalnızca sertifikanın öznitelikleridir. Bu işlem sertifikalar/güncelleştirme izni gerektirir.

Örnek kullanım: 

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

Sertifika Güncelleştirmeler
updateIssuer(string, UpdateIssuerOptions)

updateIssuer işlemi, belirtilen sertifikayı veren varlığı üzerinde bir güncelleştirme gerçekleştirir. Bu işlem sertifikalar/setissuers izni gerektirir.

Örnek kullanım: 

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

Belirtilen sertifikayı vereni Güncelleştirmeler.

Oluşturucu Ayrıntıları

CertificateClient(string, TokenCredential, CertificateClientOptions)

CertificateClient'ın bir örneğini oluşturur.

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

Parametreler

vaultUrl

string

kasanın temel URL'si. Bu URL'nin geçerli bir Key Vault kaynağına başvurduğunu doğrulamanız gerekir. Ayrıntılar için bkz. https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Hizmete yönelik isteklerin TokenCredential kimliğini doğrulamak için kullanılan arabirimi uygulayan nesne. @azure/identity Gereksinimlerinize uygun bir kimlik bilgisi oluşturmak için paketini kullanın.

clientOptions
CertificateClientOptions

Key Vault API isteklerini yapılandırmak için kullanılan işlem hattı seçenekleri. Varsayılan işlem hattı yapılandırmasını kullanmak için bu parametreyi atlayın.

Özellik Ayrıntıları

vaultUrl

Kasanın temel URL'si

vaultUrl: string

Özellik Değeri

string

Yöntem Ayrıntıları

backupCertificate(string, OperationOptions)

Belirtilen sertifikanın bir yedeğinin istemciye indirilmesi için istekte bulunur. Sertifikanın tüm sürümleri indirilir. Bu işlem sertifikalar/yedekleme izni gerektirir.

Örnek kullanım: 

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

Sertifikanın yedeğini oluşturur

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

Parametreler

certificateName

string

Sertifikanın adı

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<undefined | Uint8Array>

beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Yeni bir sertifika oluşturur. Bu ilk sürümse sertifika kaynağı oluşturulur. Bu işlev, sertifika tamamen kurtarılana kadar süresiz olarak beklemenizi sağlayan Uzun Süre Çalışan bir İşlem poller döndürür.

Not: Sertifikanın issuerName ilkesi olarak göndermek Self otomatik olarak imzalanan bir sertifika oluşturur.

Bu işlem için sertifikalar/oluşturma izni gerekir.

Örnek kullanım: 

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

Sertifika oluşturur

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

Parametreler

certificateName

string

Sertifikanın adı

policy
CertificatePolicy
options
BeginCreateCertificateOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

beginDeleteCertificate(string, CertificatePollerOptions)

DELETE işlemi, Azure Key Vault'de depolanan tüm sertifikalar için geçerlidir. DELETE, sertifikanın tek bir sürümüne uygulanamaz. Bu işlev, sertifika tamamen kurtarılana kadar süresiz olarak beklemenizi sağlayan Uzun Süre Çalışan bir İşlem poller döndürür.

Bu işlem sertifikalar/silme izni gerektirir.

Örnek kullanım: 

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

Belirtilen anahtar kasasından sertifika siler.

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

Parametreler

certificateName

string

Sertifikanın adı.

options
CertificatePollerOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Belirtilen kasada silinen sertifikayı kurtarır. Bu işlem yalnızca geçici silme özellikli bir kasada gerçekleştirilebilir. Bu işlem Bu işlev, sertifika tamamen kurtarılana kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir İşlem poller döndürür.

Bu işlem sertifikalar/kurtarma izni gerektirir.

Örnek kullanım: 

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

Silinen bir sertifikayı kurtarır

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

Parametreler

certificateName

string

Silinen sertifikanın adı

options
CertificatePollerOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

createIssuer(string, string, CreateIssuerOptions)

createIssuer işlemi, belirtilen sertifikayı vereni ekler veya güncelleştirir. Bu işlem sertifikalar/setissuers izni gerektirir.

Örnek kullanım: 

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

Belirtilen sertifikayı vereni ayarlar.

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

Parametreler

issuerName

string

Verenin adı.

provider

string

Veren sağlayıcı.

options
CreateIssuerOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<CertificateIssuer>

deleteCertificateOperation(string, OperationOptions)

Oluşturulma sürecinde olan belirli bir sertifika için oluşturma işlemini siler. Sertifika artık oluşturulmaz. Bu işlem sertifikalar/güncelleştirme izni gerektirir.

Örnek kullanım: 

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"

Sertifikanın işlemini silme

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

Parametreler

certificateName

string

Sertifikanın adı

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<CertificateOperation>

deleteContacts(OperationOptions)

Tüm sertifika kişilerini siler. Bu işlem sertifikalar/managecontacts izni gerektirir.

Örnek kullanım: 

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

Tüm sertifika kişilerini siler

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

Parametreler

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<undefined | CertificateContact[]>

deleteIssuer(string, OperationOptions)

deleteIssuer işlemi, belirtilen sertifikayı vereni kasadan kalıcı olarak kaldırır. Bu işlem sertifikalar/manageissuers/deleteissuers izni gerektirir.

Örnek kullanım: 

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

Belirtilen sertifikayı vereni siler.

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

Parametreler

issuerName

string

Verenin adı.

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<CertificateIssuer>

getCertificate(string, OperationOptions)

Sertifikanın ilkesi de dahil olmak üzere belirli bir sertifikadan sağlanan en son bilgileri alır. Bu işlem sertifikalar/alma izni gerektirir.

Örnek kullanım: 

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

Sertifikanın adından bir sertifika alır (sertifika ilkesini içerir)

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

Parametreler

certificateName

string

Sertifikanın adı

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, CertificatePollerOptions)

Belirtilen sertifikayla ilişkili oluşturma işlemini alır. Bu işlem sertifikalar/alma izni gerektirir. Bu işlev, sertifika tamamen kurtarılana kadar süresiz olarak beklemenizi sağlayan Uzun Süre Çalışan bir İşlem poller döndürür.

Örnek kullanım: 

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

Sertifikanın poller işlemini alır

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

Parametreler

certificateName

string

Sertifikanın adı

options
CertificatePollerOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

getCertificatePolicy(string, OperationOptions)

getCertificatePolicy işlemi, belirtilen anahtar kasasında belirtilen sertifika ilkesi kaynaklarını döndürür. Bu işlem sertifikalar/alma izni gerektirir.

Örnek kullanım: 

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

Sertifikanın ilkesini alır

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

Parametreler

certificateName

string

Sertifikanın adı

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<CertificatePolicy>

getCertificateVersion(string, string, OperationOptions)

Belirli bir sürümdeki belirli bir sertifika hakkında bilgi alır. Sertifikanın ilkesini döndürmez. Bu işlem sertifikalar/alma izni gerektirir.

Örnek kullanım: 

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

Sertifikanın adından ve belirtilen sürümden bir sertifika alır

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

Parametreler

certificateName

string

Sertifikanın adı

version

string

Sertifikanın belirli sürümü

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<KeyVaultCertificate>

getContacts(OperationOptions)

Belirtilen anahtar kasasında sertifika iletişim kaynakları kümesini döndürür. Bu işlem sertifikalar/managecontacts izni gerektirir.

Örnek kullanım: 

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

Sertifika kişilerini ayarlar.

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

Parametreler

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<undefined | CertificateContact[]>

getDeletedCertificate(string, OperationOptions)

silinen sertifika bilgilerinin yanı sıra bekletme aralığı, zamanlanmış kalıcı silme ve geçerli silme kurtarma düzeyi gibi özniteliklerini alır. Bu işlem sertifikalar/alma izni gerektirir.

Örnek kullanım: 

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

Silinen sertifikayı alır

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

Parametreler

certificateName

string

Sertifikanın adı

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<DeletedCertificate>

getIssuer(string, OperationOptions)

getIssuer işlemi, belirtilen anahtar kasasında belirtilen sertifikayı veren kaynakları döndürür. Bu işlem sertifikalar/manageissuers/getissuers izni gerektirir.

Örnek kullanım: 

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

Belirtilen sertifikayı vereni alır.

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

Parametreler

issuerName

string

Verenin adı.

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<CertificateIssuer>

importCertificate(string, Uint8Array, ImportCertificateOptions)

Özel anahtar içeren mevcut geçerli bir sertifikayı Azure Key Vault'e aktarır. İçeri aktarılacak sertifika PFX veya PEM biçiminde olabilir. Sertifika PEM biçimindeyse, PEM dosyası hem anahtarı hem de x509 sertifikalarını içermelidir. Bu işlem için sertifikalar/içeri aktarma izni gerekir.

Örnek kullanım: 

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

Sertifikanın gizli dizi değerinden sertifikayı içeri aktarır

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

Parametreler

certificateName

string

Sertifikanın adı

certificateBytes

Uint8Array

Hem X.509 sertifikalarını hem de özel anahtarı içeren sertifikanın PFX veya ASCII PEM biçimli değeri

options
ImportCertificateOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<KeyVaultCertificateWithPolicy>

listDeletedCertificates(ListDeletedCertificatesOptions)

Geçerli kasada silinmiş durumda olan ve kurtarma veya temizleme için hazır olan sertifikaları alır. Bu işlem silmeye özgü bilgileri içerir. Bu işlem sertifikalar/get/list izni gerektirir. Bu işlem yalnızca geçici silme özellikli kasalarda etkinleştirilebilir.

Örnek kullanım: 

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

Silinen sertifikaları listeler

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

Parametreler

options
ListDeletedCertificatesOptions

İsteğe bağlı parametreler

Döndürülenler

PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Kasadaki tüm sertifikaların en son sürümünü yineler. Tam sertifika tanımlayıcısı ve öznitelikleri yanıtta sağlanır. Sertifikalar için değer döndürülmedi. Bu işlemler sertifikalar/liste izni gerektirir.

Örnek kullanım: 

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

Belirtilen sertifikanın tüm sürümlerini listeleyin.

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

Parametreler

options
ListPropertiesOfCertificatesOptions

İsteğe bağlı parametreler

Döndürülenler

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfCertificateVersions(string, OperationOptions)

Belirtilen anahtar kasasında bir sertifikanın sürümlerini döndürür. Bu işlem sertifikalar/liste izni gerektirir.

Örnek kullanım: 

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

Bir sertifikanın sürümlerini listeleyin.

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

Parametreler

certificateName

string

Sertifikanın adı.

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfIssuers(OperationOptions)

Belirtilen anahtar kasasında sertifika veren kaynak kümesini döndürür. Bu işlem sertifikalar/manageissuers/getissuers izni gerektirir.

Örnek kullanım: 

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

Sertifika verenleri listeleyin.

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

Parametreler

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

mergeCertificate(string, Uint8Array[], OperationOptions)

Bir sertifikanın veya sertifika zincirinin, hizmette şu anda kullanılabilir durumda olan bir anahtar çifti ile birleştirilmesini gerçekleştirir. Bu işlem için sertifikalar/oluşturma izni gerekir.

Örnek kullanım: 

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

İmzalı sertifika isteğini bekleyen bir sertifikayla birleştirir

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

Parametreler

certificateName

string

Sertifikanın adı

x509Certificates

Uint8Array[]

Birleştirilecek sertifikalar

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<KeyVaultCertificateWithPolicy>

purgeDeletedCertificate(string, OperationOptions)

Kurtarma olasılığı olmadan belirtilen sertifikanın geri alınamaz silme işlemini gerçekleştirir. Kurtarma düzeyi 'Temizlenebilir' belirtmiyorsa işlem kullanılamaz. Bu işlem sertifika/temizleme izni gerektirir.

Örnek kullanım: 

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

Silinen sertifikayı alır

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

Parametreler

certificateName

string

Silinecek sertifikanın adı

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<null>

restoreCertificateBackup(Uint8Array, OperationOptions)

Yedeklenen bir sertifikayı ve tüm sürümlerini bir kasaya geri yükler. Bu işlem sertifikalar/geri yükleme izni gerektirir.

Örnek kullanım: 

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

Bir sertifikayı yedekten geri yükler

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

Parametreler

backup

Uint8Array

Geri yükleneceği yedekleme sertifikası

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<KeyVaultCertificateWithPolicy>

setContacts(CertificateContact[], OperationOptions)

Anahtar kasası için sertifika kişilerini ayarlar. Bu işlem sertifikalar/managecontacts izni gerektirir.

Örnek kullanım: 

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

Sertifika kişilerini ayarlar.

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

Parametreler

contacts

CertificateContact[]

Kullanılacak kişiler

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<undefined | CertificateContact[]>

updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Belirtilen sertifika için sertifika ilkesini Güncelleştirmeler. Bu işlem sertifikalar/güncelleştirme izni gerektirir. Sertifikanın ilkesini alır

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

Parametreler

certificateName

string

Sertifikanın adı

policy
CertificatePolicy

Sertifika ilkesi

options
OperationOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<CertificatePolicy>

updateCertificateProperties(string, string, UpdateCertificateOptions)

Belirtilen güncelleştirmeyi verilen sertifikaya uygular; güncelleştirilen öğeler yalnızca sertifikanın öznitelikleridir. Bu işlem sertifikalar/güncelleştirme izni gerektirir.

Örnek kullanım: 

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

Sertifika Güncelleştirmeler

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

Parametreler

certificateName

string

Sertifikanın adı

version

string

Güncelleştirilecek sertifikanın sürümü (boş bir dize en son sürümü güncelleştirir)

options
UpdateCertificateOptions

Güncelleştirilecek özellikler de dahil olmak üzere seçenekler

Döndürülenler

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

updateIssuer işlemi, belirtilen sertifikayı veren varlığı üzerinde bir güncelleştirme gerçekleştirir. Bu işlem sertifikalar/setissuers izni gerektirir.

Örnek kullanım: 

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

Belirtilen sertifikayı vereni Güncelleştirmeler.

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

Parametreler

issuerName

string

Verenin adı.

options
UpdateIssuerOptions

İsteğe bağlı parametreler

Döndürülenler

Promise<CertificateIssuer>