Condividi tramite

CertificateClient class

  • Riferimento
Pacchetto:
@azure/keyvault-certificates

Client per interagire con la funzionalità dei certificati KeyVault

Costruttori

CertificateClient(string, TokenCredential, CertificateClientOptions)

Crea un'istanza di CertificateClient.

Proprietà

vaultUrl

URL di base dell'insieme di credenziali

Metodi

backupCertificate(string, OperationOptions)

Richiede il download di un backup del certificato specificato nel client. Tutte le versioni del certificato verranno scaricate. Questa operazione richiede l'autorizzazione certificati/backup.

Esempio di utilizzo:

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

Genera un backup di un certificato
beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Crea un nuovo certificato. Se si tratta della prima versione, viene creata la risorsa del certificato. Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino a quando il certificato non viene recuperato completamente.

Nota: Invio di Self come issuerName dei criteri del certificato creerà un certificato autofirmato.

Questa operazione richiede l'autorizzazione certificates/create.

Esempio di utilizzo:

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

Crea un certificato
beginDeleteCertificate(string, CertificatePollerOptions)

L'operazione DELETE si applica a qualsiasi certificato archiviato in Azure Key Vault. L'istruzione DELETE non può essere applicata a una singola versione di un certificato. Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino a quando il certificato non viene recuperato completamente.

Questa operazione richiede l'autorizzazione certificates/delete.

Esempio di utilizzo:

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

Elimina un certificato da un insieme di credenziali delle chiavi specificato.
beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Recupera il certificato eliminato nell'insieme di credenziali specificato. Questa operazione può essere eseguita solo su un insieme di credenziali abilitato per l'eliminazione temporanea. Questa operazione Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino a quando il certificato non viene ripristinato completamente.

Questa operazione richiede l'autorizzazione certificati/ripristino.

Esempio di utilizzo:

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

Recupera un certificato eliminato
createIssuer(string, string, CreateIssuerOptions)

L'operazione createIssuer aggiunge o aggiorna l'autorità di certificazione specificata. Questa operazione richiede l'autorizzazione certificates/setissuers.

Esempio di utilizzo:

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

Imposta l'autorità di certificazione specificata.
deleteCertificateOperation(string, OperationOptions)

Elimina l'operazione di creazione per un certificato specificato in fase di creazione. Il certificato non viene più creato. Questa operazione richiede l'autorizzazione certificati/aggiornamento.

Esempio di utilizzo:

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"

Eliminare l'operazione di un certificato
deleteContacts(OperationOptions)

Elimina tutti i contatti del certificato. Questa operazione richiede l'autorizzazione certificates/managecontacts.

Esempio di utilizzo:

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

Elimina tutti i contatti del certificato
deleteIssuer(string, OperationOptions)

L'operazione deleteIssuer rimuove definitivamente l'autorità di certificazione specificata dall'insieme di credenziali. Questa operazione richiede l'autorizzazione certificates/manageissuers/deleteissuers.

Esempio di utilizzo:

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

Elimina l'autorità di certificazione specificata.
getCertificate(string, OperationOptions)

Ottiene le informazioni più recenti disponibili da un certificato specifico, inclusi i criteri del certificato. Questa operazione richiede l'autorizzazione certificates/get.

Esempio di utilizzo:

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

Recupera un certificato dal nome del certificato (include i criteri del certificato)
getCertificateOperation(string, CertificatePollerOptions)

Ottiene l'operazione di creazione associata a un certificato specificato. Questa operazione richiede l'autorizzazione certificates/get. Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino a quando il certificato non viene recuperato completamente.

Esempio di utilizzo:

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

Ottiene l'operazione del poller di un certificato
getCertificatePolicy(string, OperationOptions)

L'operazione getCertificatePolicy restituisce le risorse dei criteri di certificato specificate nell'insieme di credenziali delle chiavi specificato. Questa operazione richiede l'autorizzazione certificates/get.

Esempio di utilizzo:

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

Ottiene i criteri di un certificato
getCertificateVersion(string, string, OperationOptions)

Ottiene informazioni su un certificato specifico in una versione specifica. Non restituirà i criteri del certificato. Questa operazione richiede l'autorizzazione certificates/get.

Esempio di utilizzo:

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

Recupera un certificato dal nome del certificato e da una versione specificata
getContacts(OperationOptions)

Restituisce il set di risorse contatto certificato nell'insieme di credenziali delle chiavi specificato. Questa operazione richiede l'autorizzazione certificates/managecontacts.

Esempio di utilizzo:

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

Imposta i contatti del certificato.
getDeletedCertificate(string, OperationOptions)

recupera le informazioni sul certificato eliminate e i relativi attributi, ad esempio l'intervallo di conservazione, l'eliminazione permanente pianificata e il livello di recupero dell'eliminazione corrente. Questa operazione richiede l'autorizzazione certificates/get.

Esempio di utilizzo:

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

Ottiene un certificato eliminato
getIssuer(string, OperationOptions)

L'operazione getIssuer restituisce le risorse dell'autorità di certificazione specificate nell'insieme di credenziali delle chiavi specificato. Questa operazione richiede l'autorizzazione certificates/manageissuers/getissuers.

Esempio di utilizzo:

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

Ottiene l'autorità di certificazione specificata.
importCertificate(string, Uint8Array, ImportCertificateOptions)

Importa un certificato valido esistente contenente una chiave privata in Azure Key Vault. Il certificato da importare può essere in formato PFX o PEM. Se il certificato è in formato PEM, il file PEM deve contenere la chiave e i certificati x509. Questa operazione richiede l'autorizzazione certificati/importazione.

Esempio di utilizzo:

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

Importa un certificato dal valore segreto di un certificato
listDeletedCertificates(ListDeletedCertificatesOptions)

Recupera i certificati nell'insieme di credenziali corrente che si trovano in uno stato eliminato e pronti per il ripristino o l'eliminazione. Questa operazione include informazioni specifiche per l'eliminazione. Questa operazione richiede l'autorizzazione certificates/get/list. Questa operazione può essere abilitata solo per gli insiemi di credenziali abilitati per l'eliminazione temporanea.

Esempio di utilizzo:

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

Elenca i certificati eliminati
listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Scorre la versione più recente di tutti i certificati nell'insieme di credenziali. Nella risposta vengono forniti gli attributi e l'identificatore completo del certificato. Non vengono restituiti valori per i certificati. Questa operazione richiede l'autorizzazione certificates/list.

Esempio di utilizzo:

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

Elencare tutte le versioni del certificato specificato.
listPropertiesOfCertificateVersions(string, OperationOptions)

Restituisce le versioni di un certificato nell'insieme di credenziali delle chiavi specificato. Questa operazione richiede l'autorizzazione certificates/list.

Esempio di utilizzo:

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

Elencare le versioni di un certificato.
listPropertiesOfIssuers(OperationOptions)

Restituisce il set di risorse dell'autorità di certificazione del certificato nell'insieme di credenziali delle chiavi specificato. Questa operazione richiede l'autorizzazione certificates/manageissuers/getissuers.

Esempio di utilizzo:

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

Elencare le autorità emittenti di certificati.
mergeCertificate(string, Uint8Array[], OperationOptions)

Esegue l'unione di un certificato o di una catena di certificati con una coppia di chiavi attualmente disponibile nel servizio. Questa operazione richiede l'autorizzazione certificates/create.

Esempio di utilizzo:

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

Unisce una richiesta di certificato firmato in un certificato in sospeso
purgeDeletedCertificate(string, OperationOptions)

Esegue un'eliminazione irreversibile del certificato specificato, senza possibilità di ripristino. L'operazione non è disponibile se il livello di ripristino non specifica "Purgeable". Questa operazione richiede l'autorizzazione certificato/eliminazione.

Esempio di utilizzo:

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

Ottiene un certificato eliminato
restoreCertificateBackup(Uint8Array, OperationOptions)

Ripristina un certificato di cui è stato eseguito il backup e tutte le relative versioni in un insieme di credenziali. Questa operazione richiede l'autorizzazione certificati/ripristino.

Esempio di utilizzo:

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

Ripristina un certificato da un backup
setContacts(CertificateContact[], OperationOptions)

Imposta i contatti del certificato per l'insieme di credenziali delle chiavi. Questa operazione richiede l'autorizzazione certificates/managecontacts.

Esempio di utilizzo:

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

Imposta i contatti del certificato.
updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Aggiorna i criteri del certificato per il certificato specificato. Questa operazione richiede l'autorizzazione certificati/aggiornamento. Ottiene i criteri di un certificato
updateCertificateProperties(string, string, UpdateCertificatePropertiesOptions)

Applica l'aggiornamento specificato nel certificato specificato; gli unici elementi aggiornati sono gli attributi del certificato. Questa operazione richiede l'autorizzazione certificati/aggiornamento.

Esempio di utilizzo:

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

Aggiorna un certificato
updateIssuer(string, UpdateIssuerOptions)

L'operazione updateIssuer esegue un aggiornamento sull'entità emittente del certificato specificata. Questa operazione richiede l'autorizzazione certificates/setissuers.

Esempio di utilizzo:

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

Aggiorna l'autorità di certificazione specificata.

Dettagli costruttore

CertificateClient(string, TokenCredential, CertificateClientOptions)

Crea un'istanza di CertificateClient.

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

Parametri

vaultUrl

string

l'URL di base dell'insieme di credenziali. È necessario verificare che questo URL faccia riferimento a una risorsa key vault valida. Per informazioni dettagliate, vedere https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Oggetto che implementa l'interfaccia TokenCredential utilizzata per autenticare le richieste al servizio. Usare il pacchetto @azure/identity per creare credenziali adatte alle proprie esigenze.

clientOptions
CertificateClientOptions

Opzioni della pipeline usate per configurare le richieste API di Key Vault. Omettere questo parametro per usare la configurazione della pipeline predefinita.

Dettagli proprietà

vaultUrl

URL di base dell'insieme di credenziali

vaultUrl: string

Valore della proprietà

string

Dettagli metodo

backupCertificate(string, OperationOptions)

Richiede il download di un backup del certificato specificato nel client. Tutte le versioni del certificato verranno scaricate. Questa operazione richiede l'autorizzazione certificati/backup.

Esempio di utilizzo:

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

Genera un backup di un certificato

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

Parametri

certificateName

string

Nome del certificato

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<undefined | Uint8Array>

beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Crea un nuovo certificato. Se si tratta della prima versione, viene creata la risorsa del certificato. Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino a quando il certificato non viene recuperato completamente.

Nota: Invio di Self come issuerName dei criteri del certificato creerà un certificato autofirmato.

Questa operazione richiede l'autorizzazione certificates/create.

Esempio di utilizzo:

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

Crea un certificato

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

Parametri

certificateName

string

Nome del certificato

policy
CertificatePolicy
options
BeginCreateCertificateOptions

Parametri facoltativi

Restituisce

Promise<PollerLikeWithCancellation<CreateCertificateState, KeyVaultCertificateWithPolicy>>

beginDeleteCertificate(string, CertificatePollerOptions)

L'operazione DELETE si applica a qualsiasi certificato archiviato in Azure Key Vault. L'istruzione DELETE non può essere applicata a una singola versione di un certificato. Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino a quando il certificato non viene recuperato completamente.

Questa operazione richiede l'autorizzazione certificates/delete.

Esempio di utilizzo:

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

Elimina un certificato da un insieme di credenziali delle chiavi specificato.

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

Parametri

certificateName

string

Nome del certificato.

options
CertificatePollerOptions

Parametri facoltativi

Restituisce

Promise<PollerLike<DeleteCertificateState, DeletedCertificate>>

beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Recupera il certificato eliminato nell'insieme di credenziali specificato. Questa operazione può essere eseguita solo su un insieme di credenziali abilitato per l'eliminazione temporanea. Questa operazione Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino a quando il certificato non viene ripristinato completamente.

Questa operazione richiede l'autorizzazione certificati/ripristino.

Esempio di utilizzo:

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

Recupera un certificato eliminato

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

Parametri

certificateName

string

Nome del certificato eliminato

options
CertificatePollerOptions

Parametri facoltativi

Restituisce

Promise<PollerLike<RecoverDeletedCertificateState, KeyVaultCertificateWithPolicy>>

createIssuer(string, string, CreateIssuerOptions)

L'operazione createIssuer aggiunge o aggiorna l'autorità di certificazione specificata. Questa operazione richiede l'autorizzazione certificates/setissuers.

Esempio di utilizzo:

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

Imposta l'autorità di certificazione specificata.

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

Parametri

issuerName

string

Nome dell'emittente.

provider

string

Provider dell'autorità di certificazione.

options
CreateIssuerOptions

Parametri facoltativi

Restituisce

Promise<CertificateIssuer>

deleteCertificateOperation(string, OperationOptions)

Elimina l'operazione di creazione per un certificato specificato in fase di creazione. Il certificato non viene più creato. Questa operazione richiede l'autorizzazione certificati/aggiornamento.

Esempio di utilizzo:

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"

Eliminare l'operazione di un certificato

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

Parametri

certificateName

string

Nome del certificato

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<CertificateOperation>

deleteContacts(OperationOptions)

Elimina tutti i contatti del certificato. Questa operazione richiede l'autorizzazione certificates/managecontacts.

Esempio di utilizzo:

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

Elimina tutti i contatti del certificato

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

Parametri

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<undefined | CertificateContact[]>

deleteIssuer(string, OperationOptions)

L'operazione deleteIssuer rimuove definitivamente l'autorità di certificazione specificata dall'insieme di credenziali. Questa operazione richiede l'autorizzazione certificates/manageissuers/deleteissuers.

Esempio di utilizzo:

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

Elimina l'autorità di certificazione specificata.

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

Parametri

issuerName

string

Nome dell'emittente.

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<CertificateIssuer>

getCertificate(string, OperationOptions)

Ottiene le informazioni più recenti disponibili da un certificato specifico, inclusi i criteri del certificato. Questa operazione richiede l'autorizzazione certificates/get.

Esempio di utilizzo:

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

Recupera un certificato dal nome del certificato (include i criteri del certificato)

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

Parametri

certificateName

string

Nome del certificato

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<KeyVaultCertificateWithPolicy>

getCertificateOperation(string, CertificatePollerOptions)

Ottiene l'operazione di creazione associata a un certificato specificato. Questa operazione richiede l'autorizzazione certificates/get. Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino a quando il certificato non viene recuperato completamente.

Esempio di utilizzo:

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

Ottiene l'operazione del poller di un certificato

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

Parametri

certificateName

string

Nome del certificato

options
CertificatePollerOptions

Parametri facoltativi

Restituisce

Promise<PollerLikeWithCancellation<CertificateOperationState, KeyVaultCertificateWithPolicy>>

getCertificatePolicy(string, OperationOptions)

L'operazione getCertificatePolicy restituisce le risorse dei criteri di certificato specificate nell'insieme di credenziali delle chiavi specificato. Questa operazione richiede l'autorizzazione certificates/get.

Esempio di utilizzo:

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

Ottiene i criteri di un certificato

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

Parametri

certificateName

string

Nome del certificato

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<CertificatePolicy>

getCertificateVersion(string, string, OperationOptions)

Ottiene informazioni su un certificato specifico in una versione specifica. Non restituirà i criteri del certificato. Questa operazione richiede l'autorizzazione certificates/get.

Esempio di utilizzo:

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

Recupera un certificato dal nome del certificato e da una versione specificata

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

Parametri

certificateName

string

Nome del certificato

version

string

Versione specifica del certificato

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<KeyVaultCertificate>

getContacts(OperationOptions)

Restituisce il set di risorse contatto certificato nell'insieme di credenziali delle chiavi specificato. Questa operazione richiede l'autorizzazione certificates/managecontacts.

Esempio di utilizzo:

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

Imposta i contatti del certificato.

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

Parametri

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<undefined | CertificateContact[]>

getDeletedCertificate(string, OperationOptions)

recupera le informazioni sul certificato eliminate e i relativi attributi, ad esempio l'intervallo di conservazione, l'eliminazione permanente pianificata e il livello di recupero dell'eliminazione corrente. Questa operazione richiede l'autorizzazione certificates/get.

Esempio di utilizzo:

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

Ottiene un certificato eliminato

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

Parametri

certificateName

string

Nome del certificato

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<DeletedCertificate>

getIssuer(string, OperationOptions)

L'operazione getIssuer restituisce le risorse dell'autorità di certificazione specificate nell'insieme di credenziali delle chiavi specificato. Questa operazione richiede l'autorizzazione certificates/manageissuers/getissuers.

Esempio di utilizzo:

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

Ottiene l'autorità di certificazione specificata.

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

Parametri

issuerName

string

Nome dell'emittente.

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<CertificateIssuer>

importCertificate(string, Uint8Array, ImportCertificateOptions)

Importa un certificato valido esistente contenente una chiave privata in Azure Key Vault. Il certificato da importare può essere in formato PFX o PEM. Se il certificato è in formato PEM, il file PEM deve contenere la chiave e i certificati x509. Questa operazione richiede l'autorizzazione certificati/importazione.

Esempio di utilizzo:

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

Importa un certificato dal valore segreto di un certificato

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

Parametri

certificateName

string

Nome del certificato

certificateBytes

Uint8Array

Valore con formattazione PFX o ASCII PEM del certificato contenente sia i certificati X.509 che la chiave privata

options
ImportCertificateOptions

Parametri facoltativi

Restituisce

Promise<KeyVaultCertificateWithPolicy>

listDeletedCertificates(ListDeletedCertificatesOptions)

Recupera i certificati nell'insieme di credenziali corrente che si trovano in uno stato eliminato e pronti per il ripristino o l'eliminazione. Questa operazione include informazioni specifiche per l'eliminazione. Questa operazione richiede l'autorizzazione certificates/get/list. Questa operazione può essere abilitata solo per gli insiemi di credenziali abilitati per l'eliminazione temporanea.

Esempio di utilizzo:

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

Elenca i certificati eliminati

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

Parametri

options
ListDeletedCertificatesOptions

Parametri facoltativi

Restituisce

PagedAsyncIterableIterator<DeletedCertificate, DeletedCertificate[], PageSettings>

listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)

Scorre la versione più recente di tutti i certificati nell'insieme di credenziali. Nella risposta vengono forniti gli attributi e l'identificatore completo del certificato. Non vengono restituiti valori per i certificati. Questa operazione richiede l'autorizzazione certificates/list.

Esempio di utilizzo:

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

Elencare tutte le versioni del certificato specificato.

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

Parametri

options
ListPropertiesOfCertificatesOptions

Parametri facoltativi

Restituisce

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfCertificateVersions(string, OperationOptions)

Restituisce le versioni di un certificato nell'insieme di credenziali delle chiavi specificato. Questa operazione richiede l'autorizzazione certificates/list.

Esempio di utilizzo:

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

Elencare le versioni di un certificato.

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

Parametri

certificateName

string

Nome del certificato.

options
OperationOptions

Parametri facoltativi

Restituisce

PagedAsyncIterableIterator<CertificateProperties, CertificateProperties[], PageSettings>

listPropertiesOfIssuers(OperationOptions)

Restituisce il set di risorse dell'autorità di certificazione del certificato nell'insieme di credenziali delle chiavi specificato. Questa operazione richiede l'autorizzazione certificates/manageissuers/getissuers.

Esempio di utilizzo:

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

Elencare le autorità emittenti di certificati.

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

Parametri

options
OperationOptions

Parametri facoltativi

Restituisce

PagedAsyncIterableIterator<IssuerProperties, IssuerProperties[], PageSettings>

mergeCertificate(string, Uint8Array[], OperationOptions)

Esegue l'unione di un certificato o di una catena di certificati con una coppia di chiavi attualmente disponibile nel servizio. Questa operazione richiede l'autorizzazione certificates/create.

Esempio di utilizzo:

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

Unisce una richiesta di certificato firmato in un certificato in sospeso

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

Parametri

certificateName

string

Nome del certificato

x509Certificates

Uint8Array[]

Certificati da unire

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<KeyVaultCertificateWithPolicy>

purgeDeletedCertificate(string, OperationOptions)

Esegue un'eliminazione irreversibile del certificato specificato, senza possibilità di ripristino. L'operazione non è disponibile se il livello di ripristino non specifica "Purgeable". Questa operazione richiede l'autorizzazione certificato/eliminazione.

Esempio di utilizzo:

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

Ottiene un certificato eliminato

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

Parametri

certificateName

string

Nome del certificato eliminato da eliminare

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<null>

restoreCertificateBackup(Uint8Array, OperationOptions)

Ripristina un certificato di cui è stato eseguito il backup e tutte le relative versioni in un insieme di credenziali. Questa operazione richiede l'autorizzazione certificati/ripristino.

Esempio di utilizzo:

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

Ripristina un certificato da un backup

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

Parametri

backup

Uint8Array

Certificato di backup da cui eseguire il ripristino

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<KeyVaultCertificateWithPolicy>

setContacts(CertificateContact[], OperationOptions)

Imposta i contatti del certificato per l'insieme di credenziali delle chiavi. Questa operazione richiede l'autorizzazione certificates/managecontacts.

Esempio di utilizzo:

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

Imposta i contatti del certificato.

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

Parametri

contacts

CertificateContact[]

Contatti da utilizzare

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<undefined | CertificateContact[]>

updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Aggiorna i criteri del certificato per il certificato specificato. Questa operazione richiede l'autorizzazione certificati/aggiornamento. Ottiene i criteri di un certificato

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

Parametri

certificateName

string

Nome del certificato

policy
CertificatePolicy

Criteri del certificato

options
OperationOptions

Parametri facoltativi

Restituisce

Promise<CertificatePolicy>

updateCertificateProperties(string, string, UpdateCertificatePropertiesOptions)

Applica l'aggiornamento specificato nel certificato specificato; gli unici elementi aggiornati sono gli attributi del certificato. Questa operazione richiede l'autorizzazione certificati/aggiornamento.

Esempio di utilizzo:

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

Aggiorna un certificato

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

Parametri

certificateName

string

Nome del certificato

version

string

Versione del certificato da aggiornare (una stringa vuota aggiornerà la versione più recente)

options
UpdateCertificateOptions

Opzioni, inclusi gli elementi da aggiornare

Restituisce

Promise<KeyVaultCertificate>

updateIssuer(string, UpdateIssuerOptions)

L'operazione updateIssuer esegue un aggiornamento sull'entità emittente del certificato specificata. Questa operazione richiede l'autorizzazione certificates/setissuers.

Esempio di utilizzo:

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

Aggiorna l'autorità di certificazione specificata.

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

Parametri

issuerName

string

Nome dell'emittente.

options
UpdateIssuerOptions

Parametri facoltativi

Restituisce

Promise<CertificateIssuer>