Sdílet prostřednictvím

CertificateClient class

  • Reference
Balíček:
@azure/keyvault-certificates

Klient pro interakci s funkcí certifikátů služby KeyVault

Konstruktory

CertificateClient(string, TokenCredential, CertificateClientOptions)

Vytvoří instanci CertificateClient.

Vlastnosti

vaultUrl

Základní adresa URL trezoru

Metody

backupCertificate(string, BackupCertificateOptions)

Požádá o stažení zálohy zadaného certifikátu do klienta. Stáhnou se všechny verze certifikátu. Tato operace vyžaduje oprávnění k certifikátům nebo zálohování. Příklad použití:

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

Vygeneruje zálohu certifikátu.
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Vytvoří nový certifikát. Pokud se jedná o první verzi, prostředek certifikátu se vytvoří. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje nekonečně dlouho čekat na úplné obnovení certifikátu. Poznámka: Odesláním SelfissuerName zásady certifikátu se vytvoří certifikát podepsaný svým držitelem.

Tato operace vyžaduje oprávnění k vytváření certifikátů.

Příklad použití:

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

Vytvoří certifikát.
beginDeleteCertificate(string, BeginDeleteCertificateOptions)

Operace DELETE se vztahuje na všechny certifikáty uložené v Azure Key Vault. Příkaz DELETE nelze použít pro jednotlivé verze certifikátu. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje nekonečně dlouho čekat na úplné obnovení certifikátu. Tato operace vyžaduje oprávnění k odstranění certifikátů.

Příklad použití:

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

Odstraní certifikát ze zadaného trezoru klíčů.
beginRecoverDeletedCertificate(string, BeginRecoverDeletedCertificateOptions)

Obnoví odstraněný certifikát v zadaném trezoru. Tuto operaci je možné provést pouze v trezoru s povoleným obnovitelném odstraněním. Tato operace: Tato funkce vrátí poller dlouhotrvající operace, který umožňuje nekonečně dlouho čekat na úplné obnovení certifikátu. Tato operace vyžaduje oprávnění k obnovení certifikátů nebo obnovení.

Příklad použití:

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

Obnoví odstraněný certifikát.
createIssuer(string, string, CreateIssuerOptions)

Operace createIssuer přidá nebo aktualizuje zadaného vystavitele certifikátu. Tato operace vyžaduje oprávnění certificates/setissuers. Příklad použití:

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

Nastaví zadaného vystavitele certifikátu.
deleteCertificateOperation(string, DeleteCertificateOperationOptions)

Odstraní operaci vytvoření zadaného certifikátu, který se právě vytváří. Certifikát se už nevytvořil. Tato operace vyžaduje oprávnění k aktualizacím nebo certifikátům. Příklad použití:

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"

Odstranění operace certifikátu
deleteContacts(DeleteContactsOptions)

Odstraní všechny kontakty certifikátu. Tato operace vyžaduje oprávnění certifikáty/spravovatkontakty. Příklad použití:

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

Odstraní všechny kontakty certifikátů.
deleteIssuer(string, DeleteIssuerOptions)

Operace deleteIssuer trvale odebere zadaného vystavitele certifikátu z trezoru. Tato operace vyžaduje oprávnění certificates/manageissuers/deleteissuers. Příklad použití:

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

Odstraní zadaného vystavitele certifikátu.
getCertificate(string, GetCertificateOptions)

Získá nejnovější dostupné informace z konkrétního certifikátu, včetně zásad certifikátu. Tato operace vyžaduje oprávnění k získání certifikátů nebo získání. Příklad použití:

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

Načte certifikát z názvu certifikátu (včetně zásad certifikátu).
getCertificateOperation(string, GetCertificateOperationOptions)

Získá operaci vytvoření přidružené k zadanému certifikátu. Tato operace vyžaduje oprávnění k získání certifikátů nebo získání. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje nekonečně dlouho čekat na úplné obnovení certifikátu. Příklad použití:

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

Získá operaci poller certifikátu.
getCertificatePolicy(string, GetCertificatePolicyOptions)

Operace getCertificatePolicy vrátí zadané prostředky zásad certifikátů v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění k získání certifikátů nebo získání. Příklad použití:

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

Získá zásady certifikátu.
getCertificateVersion(string, string, GetCertificateVersionOptions)

Získá informace o konkrétním certifikátu v konkrétní verzi. Nevrátí zásady certifikátu. Tato operace vyžaduje oprávnění k získání certifikátů nebo získání. Příklad použití:

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

Načte certifikát z názvu certifikátu a zadané verze.
getContacts(GetContactsOptions)

Vrátí sadu prostředků kontaktu certifikátu v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění certifikáty/spravovatkontakty. Příklad použití:

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

Nastaví kontakty certifikátu.
getDeletedCertificate(string, GetDeletedCertificateOptions)

Načte informace o odstraněném certifikátu a jeho atributy, jako je interval uchovávání, naplánované trvalé odstranění a aktuální úroveň obnovení odstranění. Tato operace vyžaduje oprávnění k získání certifikátů nebo získání. Příklad použití:

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

Získá odstraněný certifikát.
getIssuer(string, GetIssuerOptions)

Operace getIssuer vrátí zadané prostředky vystavitele certifikátů v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění certificates/manageissuers/getissuers. Příklad použití:

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

Získá zadaný vystavitel certifikátu.
importCertificate(string, Uint8Array, ImportCertificateOptions)

Importuje existující platný certifikát obsahující privátní klíč do Azure Key Vault. Certifikát, který se má importovat, může být ve formátu PFX nebo PEM. Pokud je certifikát ve formátu PEM, soubor PEM musí obsahovat klíč i certifikáty x509. Tato operace vyžaduje oprávnění k importu certifikátů. Příklad použití:

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

Importuje certifikát z hodnoty tajného klíče certifikátu.
listDeletedCertificates(ListDeletedCertificatesOptions)

Načte certifikáty v aktuálním trezoru, které jsou v odstraněném stavu a připravené k obnovení nebo vymazání. Tato operace zahrnuje informace specifické pro odstranění. Tato operace vyžaduje oprávnění certificates/get/list. Tuto operaci je možné povolit pouze u trezorů s povoleným obnovitelným odstraněním. Příklad použití:

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

Zobrazí seznam odstraněných certifikátů.
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Iteruje nejnovější verzi všech certifikátů v trezoru. V odpovědi jsou uvedeny úplné identifikátory a atributy certifikátu. Pro certifikáty se nevrátí žádné hodnoty. Tato operace vyžaduje oprávnění k certifikátům nebo seznamům. Příklad použití:

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

Vypíše všechny verze zadaného certifikátu.
listPropertiesOfCertificateVersions(string, ListPropertiesOfCertificateVersionsOptions)

Vrátí verze certifikátu v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění k certifikátům nebo seznamu. Příklad použití:

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

Vypíše verze certifikátu.
listPropertiesOfIssuers(ListPropertiesOfIssuersOptions)

Vrátí sadu prostředků vystavitele certifikátů v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění certificates/manageissuers/getissuers. Příklad použití:

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

Vypište vystavitele certifikátů.
mergeCertificate(string, Uint8Array[], MergeCertificateOptions)

Provede sloučení certifikátu nebo řetězu certifikátů s párem klíčů, který je aktuálně k dispozici ve službě. Tato operace vyžaduje oprávnění k vytváření certifikátů. Příklad použití:

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

Sloučí podepsanou žádost o certifikát s čekajícím certifikátem.
purgeDeletedCertificate(string, PurgeDeletedCertificateOptions)

Provede nevratné odstranění zadaného certifikátu bez možnosti obnovení. Operace není k dispozici, pokud úroveň obnovení neurčí "Vyprázdnit". Tato operace vyžaduje oprávnění k vyprázdnění certifikátu. Příklad použití:

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

Získá odstraněný certifikát.
restoreCertificateBackup(Uint8Array, RestoreCertificateBackupOptions)

Obnoví zálohovaný certifikát a všechny jeho verze do trezoru. Tato operace vyžaduje oprávnění k obnovení nebo certifikátů. Příklad použití:

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

Obnoví certifikát ze zálohy.
setContacts(CertificateContact[], SetContactsOptions)

Nastaví kontakty certifikátu pro trezor klíčů. Tato operace vyžaduje oprávnění certifikáty/spravovatkontakty. Příklad použití:

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

Nastaví kontakty certifikátu.
updateCertificatePolicy(string, CertificatePolicy, UpdateCertificatePolicyOptions)

Aktualizace zásady certifikátu pro zadaný certifikát. Tato operace vyžaduje oprávnění k aktualizacím nebo certifikátům. Získá zásady certifikátu.
updateCertificateProperties(string, string, UpdateCertificateOptions)

Použije zadanou aktualizaci na daný certifikát. Jediné aktualizované prvky jsou atributy certifikátu. Tato operace vyžaduje oprávnění k aktualizacím nebo certifikátům. Příklad použití:

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

Aktualizace certifikátu
updateIssuer(string, UpdateIssuerOptions)

Operace updateIssuer provede aktualizaci zadané entity vystavitele certifikátu. Tato operace vyžaduje oprávnění certificates/setissuers. Příklad použití:

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

Aktualizace zadaného vystavitele certifikátu.

Podrobnosti konstruktoru

CertificateClient(string, TokenCredential, CertificateClientOptions)

Vytvoří instanci CertificateClient.

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

Parametry

vaultUrl

string

základní adresu URL trezoru.

credential

TokenCredential

Objekt, který implementuje TokenCredential rozhraní používané k ověřování požadavků na službu. Pomocí balíčku @azure/identity vytvořte přihlašovací údaje, které vyhovují vašim potřebám.

pipelineOptions
CertificateClientOptions

Možnosti kanálu používané ke konfiguraci požadavků rozhraní API Key Vault Pokud chcete použít výchozí konfiguraci kanálu, tento parametr vynecháte.

Podrobnosti vlastnosti

vaultUrl

Základní adresa URL trezoru

vaultUrl: string

Hodnota vlastnosti

string

Podrobnosti metody

backupCertificate(string, BackupCertificateOptions)

Požádá o stažení zálohy zadaného certifikátu do klienta. Stáhnou se všechny verze certifikátu. Tato operace vyžaduje oprávnění k certifikátům nebo zálohování. Příklad použití:

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

Vygeneruje zálohu certifikátu.

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

Parametry

certificateName

string

Název certifikátu

options
BackupCertificateOptions

Volitelné parametry

Návraty

Promise<Uint8Array | undefined>

beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Vytvoří nový certifikát. Pokud se jedná o první verzi, prostředek certifikátu se vytvoří. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje nekonečně dlouho čekat na úplné obnovení certifikátu. Poznámka: Odesláním SelfissuerName zásady certifikátu se vytvoří certifikát podepsaný svým držitelem.

Tato operace vyžaduje oprávnění k vytváření certifikátů.

Příklad použití:

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

Vytvoří certifikát.

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

Parametry

certificateName

string

Název certifikátu

policy
CertificatePolicy
options
BeginCreateCertificateOptions

Volitelné parametry

Návraty

Promise<PollerLike<CreateCertificateState, KeyVaultCertificateWithPolicy>>

beginDeleteCertificate(string, BeginDeleteCertificateOptions)

Operace DELETE se vztahuje na všechny certifikáty uložené v Azure Key Vault. Příkaz DELETE nelze použít pro jednotlivé verze certifikátu. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje nekonečně dlouho čekat na úplné obnovení certifikátu. Tato operace vyžaduje oprávnění k odstranění certifikátů.

Příklad použití:

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

Odstraní certifikát ze zadaného trezoru klíčů.

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

Parametry

certificateName

string

Název certifikátu.

options
BeginDeleteCertificateOptions

Volitelné parametry

Návraty

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, BeginRecoverDeletedCertificateOptions)

Obnoví odstraněný certifikát v zadaném trezoru. Tuto operaci je možné provést pouze v trezoru s povoleným obnovitelném odstraněním. Tato operace: Tato funkce vrátí poller dlouhotrvající operace, který umožňuje nekonečně dlouho čekat na úplné obnovení certifikátu. Tato operace vyžaduje oprávnění k obnovení certifikátů nebo obnovení.

Příklad použití:

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

Obnoví odstraněný certifikát.

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

Parametry

certificateName

string

Název odstraněného certifikátu

options
BeginRecoverDeletedCertificateOptions

Volitelné parametry

Návraty

Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

createIssuer(string, string, CreateIssuerOptions)

Operace createIssuer přidá nebo aktualizuje zadaného vystavitele certifikátu. Tato operace vyžaduje oprávnění certificates/setissuers. Příklad použití:

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

Nastaví zadaného vystavitele certifikátu.

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

Parametry

issuerName

string

Název vystavitele.

provider

string

Poskytovatel vystavitele.

options
CreateIssuerOptions

Volitelné parametry

Návraty

Promise<CertificateIssuer>

deleteCertificateOperation(string, DeleteCertificateOperationOptions)

Odstraní operaci vytvoření zadaného certifikátu, který se právě vytváří. Certifikát se už nevytvořil. Tato operace vyžaduje oprávnění k aktualizacím nebo certifikátům. Příklad použití:

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"

Odstranění operace certifikátu

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

Parametry

certificateName

string

Název certifikátu

options
DeleteCertificateOperationOptions

Volitelné parametry

Návraty

Promise<CertificateOperation>

deleteContacts(DeleteContactsOptions)

Odstraní všechny kontakty certifikátu. Tato operace vyžaduje oprávnění certifikáty/spravovatkontakty. Příklad použití:

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

Odstraní všechny kontakty certifikátů.

function deleteContacts(options?: DeleteContactsOptions)

Parametry

options
DeleteContactsOptions

Volitelné parametry

Návraty

Promise<CertificateContact[] | undefined>

deleteIssuer(string, DeleteIssuerOptions)

Operace deleteIssuer trvale odebere zadaného vystavitele certifikátu z trezoru. Tato operace vyžaduje oprávnění certificates/manageissuers/deleteissuers. Příklad použití:

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

Odstraní zadaného vystavitele certifikátu.

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

Parametry

issuerName

string

Název vystavitele.

options
DeleteIssuerOptions

Volitelné parametry

Návraty

Promise<CertificateIssuer>

getCertificate(string, GetCertificateOptions)

Získá nejnovější dostupné informace z konkrétního certifikátu, včetně zásad certifikátu. Tato operace vyžaduje oprávnění k získání certifikátů nebo získání. Příklad použití:

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

Načte certifikát z názvu certifikátu (včetně zásad certifikátu).

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

Parametry

certificateName

string

Název certifikátu

options
GetCertificateOptions

Volitelné parametry

Návraty

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, GetCertificateOperationOptions)

Získá operaci vytvoření přidružené k zadanému certifikátu. Tato operace vyžaduje oprávnění k získání certifikátů nebo získání. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje nekonečně dlouho čekat na úplné obnovení certifikátu. Příklad použití:

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

Získá operaci poller certifikátu.

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

Parametry

certificateName

string

Název certifikátu

options
GetCertificateOperationOptions

Volitelné parametry

Návraty

Promise<PollerLike<CertificateOperationState, KeyVaultCertificateWithPolicy>>

getCertificatePolicy(string, GetCertificatePolicyOptions)

Operace getCertificatePolicy vrátí zadané prostředky zásad certifikátů v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění k získání certifikátů nebo získání. Příklad použití:

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

Získá zásady certifikátu.

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

Parametry

certificateName

string

Název certifikátu

options
GetCertificatePolicyOptions

Volitelné parametry

Návraty

Promise<CertificatePolicy>

getCertificateVersion(string, string, GetCertificateVersionOptions)

Získá informace o konkrétním certifikátu v konkrétní verzi. Nevrátí zásady certifikátu. Tato operace vyžaduje oprávnění k získání certifikátů nebo získání. Příklad použití:

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

Načte certifikát z názvu certifikátu a zadané verze.

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

Parametry

certificateName

string

Název certifikátu

version

string

Konkrétní verze certifikátu

options
GetCertificateVersionOptions

Volitelné parametry

Návraty

Promise<KeyVaultCertificate>

getContacts(GetContactsOptions)

Vrátí sadu prostředků kontaktu certifikátu v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění certifikáty/spravovatkontakty. Příklad použití:

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

Nastaví kontakty certifikátu.

function getContacts(options?: GetContactsOptions)

Parametry

options
GetContactsOptions

Volitelné parametry

Návraty

Promise<CertificateContact[] | undefined>

getDeletedCertificate(string, GetDeletedCertificateOptions)

Načte informace o odstraněném certifikátu a jeho atributy, jako je interval uchovávání, naplánované trvalé odstranění a aktuální úroveň obnovení odstranění. Tato operace vyžaduje oprávnění k získání certifikátů nebo získání. Příklad použití:

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

Získá odstraněný certifikát.

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

Parametry

certificateName

string

Název certifikátu

options
GetDeletedCertificateOptions

Volitelné parametry

Návraty

Promise<DeletedCertificate>

getIssuer(string, GetIssuerOptions)

Operace getIssuer vrátí zadané prostředky vystavitele certifikátů v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění certificates/manageissuers/getissuers. Příklad použití:

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

Získá zadaný vystavitel certifikátu.

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

Parametry

issuerName

string

Název vystavitele.

options
GetIssuerOptions

Volitelné parametry

Návraty

Promise<CertificateIssuer>

importCertificate(string, Uint8Array, ImportCertificateOptions)

Importuje existující platný certifikát obsahující privátní klíč do Azure Key Vault. Certifikát, který se má importovat, může být ve formátu PFX nebo PEM. Pokud je certifikát ve formátu PEM, soubor PEM musí obsahovat klíč i certifikáty x509. Tato operace vyžaduje oprávnění k importu certifikátů. Příklad použití:

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

Importuje certifikát z hodnoty tajného klíče certifikátu.

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

Parametry

certificateName

string

Název certifikátu

certificateBytes

Uint8Array

Hodnota certifikátu ve formátu PFX nebo ASCII PEM, který obsahuje certifikáty X.509 i privátní klíč

options
ImportCertificateOptions

Volitelné parametry

Návraty

Promise<KeyVaultCertificateWithPolicy>

listDeletedCertificates(ListDeletedCertificatesOptions)

Načte certifikáty v aktuálním trezoru, které jsou v odstraněném stavu a připravené k obnovení nebo vymazání. Tato operace zahrnuje informace specifické pro odstranění. Tato operace vyžaduje oprávnění certificates/get/list. Tuto operaci je možné povolit pouze u trezorů s povoleným obnovitelným odstraněním. Příklad použití:

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

Zobrazí seznam odstraněných certifikátů.

function listDeletedCertificates(options?: ListDeletedCertificatesOptions)

Parametry

options
ListDeletedCertificatesOptions

Volitelné parametry

Návraty

PagedAsyncIterableIterator<DeletedCertificate>

listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Iteruje nejnovější verzi všech certifikátů v trezoru. V odpovědi jsou uvedeny úplné identifikátory a atributy certifikátu. Pro certifikáty se nevrátí žádné hodnoty. Tato operace vyžaduje oprávnění k certifikátům nebo seznamům. Příklad použití:

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

Vypíše všechny verze zadaného certifikátu.

function listPropertiesOfCertificates(options?: ListPropertiesOfCertificatesOptions)

Parametry

options
ListPropertiesOfCertificatesOptions

Volitelné parametry

Návraty

PagedAsyncIterableIterator<CertificateProperties>

listPropertiesOfCertificateVersions(string, ListPropertiesOfCertificateVersionsOptions)

Vrátí verze certifikátu v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění k certifikátům nebo seznamu. Příklad použití:

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

Vypíše verze certifikátu.

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

Parametry

certificateName

string

Název certifikátu.

options
ListPropertiesOfCertificateVersionsOptions

Volitelné parametry

Návraty

PagedAsyncIterableIterator<CertificateProperties>

listPropertiesOfIssuers(ListPropertiesOfIssuersOptions)

Vrátí sadu prostředků vystavitele certifikátů v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění certificates/manageissuers/getissuers. Příklad použití:

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

Vypište vystavitele certifikátů.

function listPropertiesOfIssuers(options?: ListPropertiesOfIssuersOptions)

Parametry

options
ListPropertiesOfIssuersOptions

Volitelné parametry

Návraty

PagedAsyncIterableIterator<IssuerProperties>

mergeCertificate(string, Uint8Array[], MergeCertificateOptions)

Provede sloučení certifikátu nebo řetězu certifikátů s párem klíčů, který je aktuálně k dispozici ve službě. Tato operace vyžaduje oprávnění k vytváření certifikátů. Příklad použití:

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

Sloučí podepsanou žádost o certifikát s čekajícím certifikátem.

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

Parametry

certificateName

string

Název certifikátu

x509Certificates

Uint8Array[]

Certifikáty, které se mají sloučit

options
MergeCertificateOptions

Volitelné parametry

Návraty

Promise<KeyVaultCertificateWithPolicy>

purgeDeletedCertificate(string, PurgeDeletedCertificateOptions)

Provede nevratné odstranění zadaného certifikátu bez možnosti obnovení. Operace není k dispozici, pokud úroveň obnovení neurčí "Vyprázdnit". Tato operace vyžaduje oprávnění k vyprázdnění certifikátu. Příklad použití:

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

Získá odstraněný certifikát.

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

Parametry

certificateName

string

Název odstraněného certifikátu, který se má vyprázdnit

options
PurgeDeletedCertificateOptions

Volitelné parametry

Návraty

Promise<null>

restoreCertificateBackup(Uint8Array, RestoreCertificateBackupOptions)

Obnoví zálohovaný certifikát a všechny jeho verze do trezoru. Tato operace vyžaduje oprávnění k obnovení nebo certifikátů. Příklad použití:

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

Obnoví certifikát ze zálohy.

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

Parametry

backup

Uint8Array

Certifikát zálohování, ze které se má provést obnovení

options
RestoreCertificateBackupOptions

Volitelné parametry

Návraty

Promise<KeyVaultCertificateWithPolicy>

setContacts(CertificateContact[], SetContactsOptions)

Nastaví kontakty certifikátu pro trezor klíčů. Tato operace vyžaduje oprávnění certifikáty/spravovatkontakty. Příklad použití:

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

Nastaví kontakty certifikátu.

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

Parametry

contacts

CertificateContact[]

Kontakty, které se mají použít

options
SetContactsOptions

Volitelné parametry

Návraty

Promise<CertificateContact[] | undefined>

updateCertificatePolicy(string, CertificatePolicy, UpdateCertificatePolicyOptions)

Aktualizace zásady certifikátu pro zadaný certifikát. Tato operace vyžaduje oprávnění k aktualizacím nebo certifikátům. Získá zásady certifikátu.

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

Parametry

certificateName

string

Název certifikátu

policy
CertificatePolicy

Zásady certifikátů

options
UpdateCertificatePolicyOptions

Volitelné parametry

Návraty

Promise<CertificatePolicy>

updateCertificateProperties(string, string, UpdateCertificateOptions)

Použije zadanou aktualizaci na daný certifikát. Jediné aktualizované prvky jsou atributy certifikátu. Tato operace vyžaduje oprávnění k aktualizacím nebo certifikátům. Příklad použití:

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

Aktualizace certifikátu

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

Parametry

certificateName

string

Název certifikátu

version

string

Verze certifikátu, který se má aktualizovat

options
UpdateCertificateOptions

Možnosti, včetně toho, co aktualizovat

Návraty

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

Operace updateIssuer provede aktualizaci zadané entity vystavitele certifikátu. Tato operace vyžaduje oprávnění certificates/setissuers. Příklad použití:

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

Aktualizace zadaného vystavitele certifikátu.

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

Parametry

issuerName

string

Název vystavitele.

options
UpdateIssuerOptions

Volitelné parametry

Návraty

Promise<CertificateIssuer>