Share via

CertificateClient class

  • Referens
Paket:
@azure/keyvault-certificates

Klienten som ska interagera med KeyVault-certifikatfunktionen

Konstruktorer

CertificateClient(string, TokenCredential, CertificateClientOptions)

Skapar en instans av CertificateClient.

Egenskaper

vaultUrl

Bas-URL:en till valvet

Metoder

backupCertificate(string, OperationOptions)

Begär att en säkerhetskopia av det angivna certifikatet laddas ned till klienten. Alla versioner av certifikatet laddas ned. Den här åtgärden kräver behörighet för certifikat/säkerhetskopiering.

Exempel på användning:

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

Genererar en säkerhetskopia av ett certifikat
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Skapar ett nytt certifikat. Om det här är den första versionen skapas certifikatresursen. Den här funktionen returnerar en poller för långvariga åtgärder som gör att du kan vänta på obestämd tid tills certifikatet har återställts helt.

Observera: Om du skickar Self som issuerName för certifikatets princip skapas ett självsignerat certifikat.

Den här åtgärden kräver certifikat-/skapandebehörighet.

Exempel på användning:

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

Skapar ett certifikat
beginDeleteCertificate(string, CertificatePollerOptions)

DELETE-åtgärden gäller alla certifikat som lagras i Azure Key Vault. DELETE kan inte tillämpas på en enskild version av ett certifikat. Den här funktionen returnerar en poller för långvariga åtgärder som gör att du kan vänta på obestämd tid tills certifikatet har återställts helt.

Den här åtgärden kräver behörigheten certifikat/borttagning.

Exempel på användning:

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

Tar bort ett certifikat från ett angivet nyckelvalv.
beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Återställer det borttagna certifikatet i det angivna valvet. Den här åtgärden kan bara utföras på ett aktiverat valv med mjuk borttagning. Den här åtgärden Den här funktionen returnerar en poller för långvariga åtgärder som gör att du kan vänta på obestämd tid tills certifikatet har återställts helt.

Den här åtgärden kräver behörigheten certifikat/återställning.

Exempel på användning:

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

Återställer ett borttaget certifikat
createIssuer(string, string, CreateIssuerOptions)

Åtgärden createIssuer lägger till eller uppdaterar den angivna certifikatutfärdaren. Den här åtgärden kräver behörigheten certifikat/setissuers.

Exempel på användning:

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

Anger den angivna certifikatutfärdaren.
deleteCertificateOperation(string, OperationOptions)

Tar bort skapandeåtgärden för ett angivet certifikat som håller på att skapas. Certifikatet skapas inte längre. Den här åtgärden kräver certifikat/uppdateringsbehörighet.

Exempel på användning:

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"

Ta bort ett certifikats åtgärd
deleteContacts(OperationOptions)

Tar bort alla certifikatkontakter. Den här åtgärden kräver behörigheten certificates/managecontacts.

Exempel på användning:

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

Tar bort alla certifikatkontakter
deleteIssuer(string, OperationOptions)

Åtgärden deleteIssuer tar permanent bort den angivna certifikatutfärdaren från valvet. Den här åtgärden kräver behörigheten certifikat/manageissuers/deleteissuers.

Exempel på användning:

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

Tar bort den angivna certifikatutfärdaren.
getCertificate(string, OperationOptions)

Hämtar den senaste informationen som är tillgänglig från ett visst certifikat, inklusive certifikatets princip. Den här åtgärden kräver certifikat/hämta behörighet.

Exempel på användning:

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

Hämtar ett certifikat från certifikatets namn (inklusive certifikatprincipen)
getCertificateOperation(string, CertificatePollerOptions)

Hämtar den skapandeåtgärd som är associerad med ett angivet certifikat. Den här åtgärden kräver certifikat/hämta behörighet. Den här funktionen returnerar en pollerare för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills certifikatet har återställts helt.

Exempel på användning:

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

Hämtar ett certifikats polleråtgärd
getCertificatePolicy(string, OperationOptions)

Åtgärden getCertificatePolicy returnerar de angivna certifikatprincipresurserna i det angivna nyckelvalvet. Den här åtgärden kräver certifikat/hämta behörighet.

Exempel på användning:

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

Hämtar ett certifikats princip
getCertificateVersion(string, string, OperationOptions)

Hämtar information om ett specifikt certifikat på en viss version. Det returnerar inte certifikatets princip. Den här åtgärden kräver certifikat/hämta behörighet.

Exempel på användning:

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

Hämtar ett certifikat från certifikatets namn och en angiven version
getContacts(OperationOptions)

Returnerar uppsättningen med certifikatkontaktresurser i det angivna nyckelvalvet. Den här åtgärden kräver behörigheten certificates/managecontacts.

Exempel på användning:

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

Anger certifikatkontakterna.
getDeletedCertificate(string, OperationOptions)

hämtar den borttagna certifikatinformationen plus dess attribut, till exempel kvarhållningsintervall, schemalagd permanent borttagning och den aktuella återställningsnivån för borttagning. Den här åtgärden kräver certifikat/hämta behörighet.

Exempel på användning:

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

Hämtar ett borttaget certifikat
getIssuer(string, OperationOptions)

Åtgärden getIssuer returnerar de angivna certifikatutfärdarresurserna i det angivna nyckelvalvet. Den här åtgärden kräver behörigheten certifikat/manageissuers/getissuers.

Exempel på användning:

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

Hämtar den angivna certifikatutfärdaren.
importCertificate(string, Uint8Array, ImportCertificateOptions)

Importerar ett befintligt giltigt certifikat som innehåller en privat nyckel till Azure Key Vault. Certifikatet som ska importeras kan vara i antingen PFX- eller PEM-format. Om certifikatet är i PEM-format måste PEM-filen innehålla både nyckeln och x509-certifikaten. Den här åtgärden kräver certifikat-/importbehörighet.

Exempel på användning:

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

Importerar ett certifikat från ett certifikats hemliga värde
listDeletedCertificates(ListDeletedCertificatesOptions)

Hämtar certifikaten i det aktuella valvet som är i ett borttaget tillstånd och redo för återställning eller rensning. Den här åtgärden innehåller borttagningsspecifik information. Den här åtgärden kräver behörigheten certificates/get/list. Den här åtgärden kan bara aktiveras för mjuk borttagning av aktiverade valv.

Exempel på användning:

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

Visar borttagna certifikat
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Itererar den senaste versionen av alla certifikat i valvet. Den fullständiga certifikatidentifieraren och attributen finns i svaret. Inga värden returneras för certifikaten. De här åtgärderna kräver behörigheten certifikat/lista.

Exempel på användning:

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

Visa en lista över alla versioner av det angivna certifikatet.
listPropertiesOfCertificateVersions(string, OperationOptions)

Returnerar versionerna av ett certifikat i det angivna nyckelvalvet. Den här åtgärden kräver behörigheten certifikat/lista.

Exempel på användning:

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

Visa en lista över versionerna av ett certifikat.
listPropertiesOfIssuers(OperationOptions)

Returnerar uppsättningen certifikatutfärdarresurser i det angivna nyckelvalvet. Den här åtgärden kräver behörigheten certifikat/manageissuers/getissuers.

Exempel på användning:

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

Lista certifikatutfärdarna.
mergeCertificate(string, Uint8Array[], OperationOptions)

Utför sammanslagning av ett certifikat eller en certifikatkedja med ett nyckelpar som för närvarande är tillgängligt i tjänsten. Den här åtgärden kräver certifikat-/skapandebehörighet.

Exempel på användning:

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

Sammanfogar en signerad certifikatbegäran till ett väntande certifikat
purgeDeletedCertificate(string, OperationOptions)

Utför en oåterkallelig borttagning av det angivna certifikatet, utan möjlighet till återställning. Åtgärden är inte tillgänglig om återställningsnivån inte anger "Rensningsbar". Den här åtgärden kräver certifikat-/rensningsbehörigheten.

Exempel på användning:

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

Hämtar ett borttaget certifikat
restoreCertificateBackup(Uint8Array, OperationOptions)

Återställer ett säkerhetskopierat certifikat och alla dess versioner till ett valv. Den här åtgärden kräver behörigheten certifikat/återställning.

Exempel på användning:

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

Återställer ett certifikat från en säkerhetskopia
setContacts(CertificateContact[], OperationOptions)

Anger certifikatkontakterna för nyckelvalvet. Den här åtgärden kräver behörigheten certificates/managecontacts.

Exempel på användning:

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

Anger certifikatkontakterna.
updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Uppdateringar certifikatprincipen för det angivna certifikatet. Den här åtgärden kräver certifikat/uppdateringsbehörighet. Hämtar ett certifikats princip
updateCertificateProperties(string, string, UpdateCertificateOptions)

Tillämpar den angivna uppdateringen på det angivna certifikatet. de enda element som uppdateras är certifikatets attribut. Den här åtgärden kräver certifikat/uppdateringsbehörighet.

Exempel på användning:

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

Uppdateringar ett certifikat
updateIssuer(string, UpdateIssuerOptions)

UpdateIssuer-åtgärden utför en uppdatering på den angivna certifikatutfärdarentiteten. Den här åtgärden kräver behörigheten certifikat/setissuers.

Exempel på användning:

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

Uppdateringar den angivna certifikatutfärdaren.

Konstruktorinformation

CertificateClient(string, TokenCredential, CertificateClientOptions)

Skapar en instans av CertificateClient.

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

Parametrar

vaultUrl

string

bas-URL:en till valvet. Du bör kontrollera att den här URL:en refererar till en giltig Key Vault resurs. Mer information finns under https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Ett objekt som implementerar gränssnittet som används för att autentisera TokenCredential begäranden till tjänsten. @azure/identity Använd paketet för att skapa en autentiseringsuppgift som passar dina behov.

clientOptions
CertificateClientOptions

Pipelinealternativ som används för att konfigurera Key Vault API-begäranden. Utelämna den här parametern för att använda standardkonfigurationen för pipelinen.

Egenskapsinformation

vaultUrl

Bas-URL:en till valvet

vaultUrl: string

Egenskapsvärde

string

Metodinformation

backupCertificate(string, OperationOptions)

Begär att en säkerhetskopia av det angivna certifikatet laddas ned till klienten. Alla versioner av certifikatet laddas ned. Den här åtgärden kräver behörighet för certifikat/säkerhetskopiering.

Exempel på användning:

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

Genererar en säkerhetskopia av ett certifikat

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

Parametrar

certificateName

string

Namnet på certifikatet

options
OperationOptions

De valfria parametrarna

Returer

Promise<undefined | Uint8Array>

beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Skapar ett nytt certifikat. Om det här är den första versionen skapas certifikatresursen. Den här funktionen returnerar en poller för långvariga åtgärder som gör att du kan vänta på obestämd tid tills certifikatet har återställts helt.

Observera: Om du skickar Self som issuerName för certifikatets princip skapas ett självsignerat certifikat.

Den här åtgärden kräver certifikat-/skapandebehörighet.

Exempel på användning:

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

Skapar ett certifikat

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

Parametrar

certificateName

string

Namnet på certifikatet

policy
CertificatePolicy
options
BeginCreateCertificateOptions

Valfria parametrar

Returer

Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

beginDeleteCertificate(string, CertificatePollerOptions)

DELETE-åtgärden gäller alla certifikat som lagras i Azure Key Vault. DELETE kan inte tillämpas på en enskild version av ett certifikat. Den här funktionen returnerar en poller för långvariga åtgärder som gör att du kan vänta på obestämd tid tills certifikatet har återställts helt.

Den här åtgärden kräver behörigheten certifikat/borttagning.

Exempel på användning:

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

Tar bort ett certifikat från ett angivet nyckelvalv.

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

Parametrar

certificateName

string

Namnet på certifikatet.

options
CertificatePollerOptions

De valfria parametrarna

Returer

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Återställer det borttagna certifikatet i det angivna valvet. Den här åtgärden kan bara utföras på ett aktiverat valv med mjuk borttagning. Den här åtgärden Den här funktionen returnerar en poller för långvariga åtgärder som gör att du kan vänta på obestämd tid tills certifikatet har återställts helt.

Den här åtgärden kräver behörigheten certifikat/återställning.

Exempel på användning:

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

Återställer ett borttaget certifikat

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

Parametrar

certificateName

string

Namnet på det borttagna certifikatet

options
CertificatePollerOptions

De valfria parametrarna

Returer

Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

createIssuer(string, string, CreateIssuerOptions)

Åtgärden createIssuer lägger till eller uppdaterar den angivna certifikatutfärdaren. Den här åtgärden kräver behörigheten certifikat/setissuers.

Exempel på användning:

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

Anger den angivna certifikatutfärdaren.

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

Parametrar

issuerName

string

Namnet på utfärdaren.

provider

string

Utfärdarprovidern.

options
CreateIssuerOptions

De valfria parametrarna

Returer

Promise<CertificateIssuer>

deleteCertificateOperation(string, OperationOptions)

Tar bort skapandeåtgärden för ett angivet certifikat som håller på att skapas. Certifikatet skapas inte längre. Den här åtgärden kräver certifikat/uppdateringsbehörighet.

Exempel på användning:

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"

Ta bort ett certifikats åtgärd

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

Parametrar

certificateName

string

Namnet på certifikatet

options
OperationOptions

De valfria parametrarna

Returer

Promise<CertificateOperation>

deleteContacts(OperationOptions)

Tar bort alla certifikatkontakter. Den här åtgärden kräver behörigheten certificates/managecontacts.

Exempel på användning:

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

Tar bort alla certifikatkontakter

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

Parametrar

options
OperationOptions

De valfria parametrarna

Returer

Promise<undefined | CertificateContact[]>

deleteIssuer(string, OperationOptions)

Åtgärden deleteIssuer tar permanent bort den angivna certifikatutfärdaren från valvet. Den här åtgärden kräver behörigheten certifikat/manageissuers/deleteissuers.

Exempel på användning:

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

Tar bort den angivna certifikatutfärdaren.

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

Parametrar

issuerName

string

Namnet på utfärdaren.

options
OperationOptions

De valfria parametrarna

Returer

Promise<CertificateIssuer>

getCertificate(string, OperationOptions)

Hämtar den senaste informationen som är tillgänglig från ett visst certifikat, inklusive certifikatets princip. Den här åtgärden kräver certifikat/hämta behörighet.

Exempel på användning:

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

Hämtar ett certifikat från certifikatets namn (inklusive certifikatprincipen)

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

Parametrar

certificateName

string

Namnet på certifikatet

options
OperationOptions

De valfria parametrarna

Returer

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, CertificatePollerOptions)

Hämtar den skapandeåtgärd som är associerad med ett angivet certifikat. Den här åtgärden kräver certifikat/hämta behörighet. Den här funktionen returnerar en pollerare för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills certifikatet har återställts helt.

Exempel på användning:

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

Hämtar ett certifikats polleråtgärd

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

Parametrar

certificateName

string

Namnet på certifikatet

options
CertificatePollerOptions

De valfria parametrarna

Returer

Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

getCertificatePolicy(string, OperationOptions)

Åtgärden getCertificatePolicy returnerar de angivna certifikatprincipresurserna i det angivna nyckelvalvet. Den här åtgärden kräver certifikat/hämta behörighet.

Exempel på användning:

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

Hämtar ett certifikats princip

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

Parametrar

certificateName

string

Namnet på certifikatet

options
OperationOptions

De valfria parametrarna

Returer

Promise<CertificatePolicy>

getCertificateVersion(string, string, OperationOptions)

Hämtar information om ett specifikt certifikat på en viss version. Det returnerar inte certifikatets princip. Den här åtgärden kräver certifikat/hämta behörighet.

Exempel på användning:

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

Hämtar ett certifikat från certifikatets namn och en angiven version

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

Parametrar

certificateName

string

Namnet på certifikatet

version

string

Den specifika versionen av certifikatet

options
OperationOptions

De valfria parametrarna

Returer

Promise<KeyVaultCertificate>

getContacts(OperationOptions)

Returnerar uppsättningen med certifikatkontaktresurser i det angivna nyckelvalvet. Den här åtgärden kräver behörigheten certificates/managecontacts.

Exempel på användning:

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

Anger certifikatkontakterna.

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

Parametrar

options
OperationOptions

De valfria parametrarna

Returer

Promise<undefined | CertificateContact[]>

getDeletedCertificate(string, OperationOptions)

hämtar den borttagna certifikatinformationen plus dess attribut, till exempel kvarhållningsintervall, schemalagd permanent borttagning och den aktuella återställningsnivån för borttagning. Den här åtgärden kräver certifikat/hämta behörighet.

Exempel på användning:

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

Hämtar ett borttaget certifikat

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

Parametrar

certificateName

string

Namnet på certifikatet

options
OperationOptions

De valfria parametrarna

Returer

Promise<DeletedCertificate>

getIssuer(string, OperationOptions)

Åtgärden getIssuer returnerar de angivna certifikatutfärdarresurserna i det angivna nyckelvalvet. Den här åtgärden kräver behörigheten certifikat/manageissuers/getissuers.

Exempel på användning:

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

Hämtar den angivna certifikatutfärdaren.

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

Parametrar

issuerName

string

Namnet på utfärdaren.

options
OperationOptions

De valfria parametrarna

Returer

Promise<CertificateIssuer>

importCertificate(string, Uint8Array, ImportCertificateOptions)

Importerar ett befintligt giltigt certifikat som innehåller en privat nyckel till Azure Key Vault. Certifikatet som ska importeras kan vara i antingen PFX- eller PEM-format. Om certifikatet är i PEM-format måste PEM-filen innehålla både nyckeln och x509-certifikaten. Den här åtgärden kräver certifikat-/importbehörighet.

Exempel på användning:

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

Importerar ett certifikat från ett certifikats hemliga värde

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

Parametrar

certificateName

string

Namnet på certifikatet

certificateBytes

Uint8Array

DET PFX- eller ASCII PEM-formaterade värdet för certifikatet som innehåller både X.509-certifikaten och den privata nyckeln

options
ImportCertificateOptions

De valfria parametrarna

Returer

Promise<KeyVaultCertificateWithPolicy>

listDeletedCertificates(ListDeletedCertificatesOptions)

Hämtar certifikaten i det aktuella valvet som är i ett borttaget tillstånd och redo för återställning eller rensning. Den här åtgärden innehåller borttagningsspecifik information. Den här åtgärden kräver behörigheten certificates/get/list. Den här åtgärden kan bara aktiveras för mjuk borttagning av aktiverade valv.

Exempel på användning:

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

Visar borttagna certifikat

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

Parametrar

options
ListDeletedCertificatesOptions

De valfria parametrarna

Returer

PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Itererar den senaste versionen av alla certifikat i valvet. Den fullständiga certifikatidentifieraren och attributen finns i svaret. Inga värden returneras för certifikaten. De här åtgärderna kräver behörigheten certifikat/lista.

Exempel på användning:

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

Visa en lista över alla versioner av det angivna certifikatet.

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

Parametrar

options
ListPropertiesOfCertificatesOptions

De valfria parametrarna

Returer

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfCertificateVersions(string, OperationOptions)

Returnerar versionerna av ett certifikat i det angivna nyckelvalvet. Den här åtgärden kräver behörigheten certifikat/lista.

Exempel på användning:

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

Visa en lista över versionerna av ett certifikat.

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

Parametrar

certificateName

string

Namnet på certifikatet.

options
OperationOptions

De valfria parametrarna

Returer

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfIssuers(OperationOptions)

Returnerar uppsättningen certifikatutfärdarresurser i det angivna nyckelvalvet. Den här åtgärden kräver behörigheten certifikat/manageissuers/getissuers.

Exempel på användning:

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

Lista certifikatutfärdarna.

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

Parametrar

options
OperationOptions

De valfria parametrarna

Returer

PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

mergeCertificate(string, Uint8Array[], OperationOptions)

Utför sammanslagning av ett certifikat eller en certifikatkedja med ett nyckelpar som för närvarande är tillgängligt i tjänsten. Den här åtgärden kräver certifikat-/skapandebehörighet.

Exempel på användning:

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

Sammanfogar en signerad certifikatbegäran till ett väntande certifikat

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

Parametrar

certificateName

string

Namnet på certifikatet

x509Certificates

Uint8Array[]

Certifikaten som ska sammanfogas

options
OperationOptions

De valfria parametrarna

Returer

Promise<KeyVaultCertificateWithPolicy>

purgeDeletedCertificate(string, OperationOptions)

Utför en oåterkallelig borttagning av det angivna certifikatet, utan möjlighet till återställning. Åtgärden är inte tillgänglig om återställningsnivån inte anger "Rensningsbar". Den här åtgärden kräver certifikat-/rensningsbehörigheten.

Exempel på användning:

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

Hämtar ett borttaget certifikat

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

Parametrar

certificateName

string

Namnet på det borttagna certifikat som ska rensas

options
OperationOptions

De valfria parametrarna

Returer

Promise<null>

restoreCertificateBackup(Uint8Array, OperationOptions)

Återställer ett säkerhetskopierat certifikat och alla dess versioner till ett valv. Den här åtgärden kräver behörigheten certifikat/återställning.

Exempel på användning:

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

Återställer ett certifikat från en säkerhetskopia

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

Parametrar

backup

Uint8Array

Säkerhetskopieringscertifikatet som ska återställas från

options
OperationOptions

De valfria parametrarna

Returer

Promise<KeyVaultCertificateWithPolicy>

setContacts(CertificateContact[], OperationOptions)

Anger certifikatkontakterna för nyckelvalvet. Den här åtgärden kräver behörigheten certificates/managecontacts.

Exempel på användning:

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

Anger certifikatkontakterna.

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

Parametrar

contacts

CertificateContact[]

De kontakter som ska användas

options
OperationOptions

De valfria parametrarna

Returer

Promise<undefined | CertificateContact[]>

updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Uppdateringar certifikatprincipen för det angivna certifikatet. Den här åtgärden kräver certifikat/uppdateringsbehörighet. Hämtar ett certifikats princip

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

Parametrar

certificateName

string

Namnet på certifikatet

policy
CertificatePolicy

Certifikatprincipen

options
OperationOptions

De valfria parametrarna

Returer

Promise<CertificatePolicy>

updateCertificateProperties(string, string, UpdateCertificateOptions)

Tillämpar den angivna uppdateringen på det angivna certifikatet. de enda element som uppdateras är certifikatets attribut. Den här åtgärden kräver certifikat/uppdateringsbehörighet.

Exempel på användning:

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

Uppdateringar ett certifikat

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

Parametrar

certificateName

string

Namnet på certifikatet

version

string

Den version av certifikatet som ska uppdateras (en tom sträng uppdaterar den senaste versionen)

options
UpdateCertificateOptions

Alternativen, inklusive vad som ska uppdateras

Returer

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

UpdateIssuer-åtgärden utför en uppdatering på den angivna certifikatutfärdarentiteten. Den här åtgärden kräver behörigheten certifikat/setissuers.

Exempel på användning:

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

Uppdateringar den angivna certifikatutfärdaren.

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

Parametrar

issuerName

string

Namnet på utfärdaren.

options
UpdateIssuerOptions

De valfria parametrarna

Returer

Promise<CertificateIssuer>