KeyClient class

Crea un'istanza di KeyClient.

Esempio di utilizzo:

import { KeyClient } from "@azure/keyvault-keys";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new KeyClient(vaultUrl, credentials);

new KeyClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: KeyClientOptions)

Parametri

URL di base dell'insieme di credenziali

vaultUrl: string

Valore della proprietà

Richiede il download di un backup della chiave specificata nel client. Tutte le versioni della chiave verranno scaricate. Questa operazione richiede l'autorizzazione chiavi/backup.

Esempio di utilizzo:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");

Esegue il backup della chiave specificata.

function backupKey(name: string, options?: BackupKeyOptions): Promise<undefined | Uint8Array>

Parametri

Restituisce

L'operazione di eliminazione si applica a qualsiasi chiave archiviata in Azure Key Vault. Le singole versioni di una chiave non possono essere eliminate, ma solo tutte le versioni di una determinata chiave contemporaneamente.

Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino a quando la chiave non viene eliminata.

Questa operazione richiede l'autorizzazione chiavi/eliminazione.

Esempio di utilizzo:

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const poller = await client.beginDeleteKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginDeleteKey("MyKey", { resumeFrom: serialized });

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

Elimina una chiave da un insieme di credenziali delle chiavi specificato.

function beginDeleteKey(name: string, options?: BeginDeleteKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

Parametri

Restituisce

Recupera la chiave eliminata nell'insieme di credenziali specificato. Questa operazione può essere eseguita solo su un insieme di credenziali abilitato per l'eliminazione temporanea.

Questa funzione restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino a quando non viene ripristinata la chiave eliminata.

Questa operazione richiede l'autorizzazione chiavi/ripristino.

Esempio di utilizzo:

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const deletePoller = await client.beginDeleteKey("MyKey");
await deletePoller.pollUntilDone();
const poller = await client.beginRecoverDeletedKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginRecoverDeletedKey("MyKey", { resumeFrom: serialized });

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

Recupera la chiave eliminata alla versione più recente.

function beginRecoverDeletedKey(name: string, options?: BeginRecoverDeletedKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

Parametri

Restituisce

Il metodo createEcKey crea una nuova chiave a curva ellittica in Azure Key Vault. Se la chiave denominata esiste già, Azure Key Vault crea una nuova versione della chiave. Richiede l'autorizzazione chiavi/creazione.

Esempio di utilizzo:

let client = new KeyClient(url, credentials);
let result = await client.createEcKey("MyKey", { curve: "P-256" });

Crea una nuova chiave, la archivia, quindi restituisce i parametri chiave e le proprietà al client.

function createEcKey(name: string, options?: CreateEcKeyOptions): Promise<KeyVaultKey>

Parametri

Restituisce

L'operazione di creazione della chiave può essere usata per creare qualsiasi tipo di chiave in Azure Key Vault. Se la chiave denominata esiste già, Azure Key Vault crea una nuova versione della chiave. Richiede l'autorizzazione chiavi/creazione.

Esempio di utilizzo:

let client = new KeyClient(url, credentials);
// Create an elliptic-curve key:
let result = await client.createKey("MyKey", "EC");

Crea una nuova chiave, la archivia, quindi restituisce i parametri chiave e le proprietà al client.

function createKey(name: string, keyType: string, options?: CreateKeyOptions): Promise<KeyVaultKey>

Parametri

Restituisce

Il metodo createOctKey crea una nuova chiave oct in Azure Key Vault. Se la chiave denominata esiste già, Azure Key Vault crea una nuova versione della chiave. Richiede l'autorizzazione chiavi/creazione.

Esempio di utilizzo:

let client = new KeyClient(url, credentials);
let result = await client.createOctKey("MyKey", { hsm: true });

Crea una nuova chiave, la archivia, quindi restituisce i parametri chiave e le proprietà al client.

function createOctKey(name: string, options?: CreateOctKeyOptions): Promise<KeyVaultKey>

Parametri

Restituisce

Il metodo createRSAKey crea una nuova chiave RSA in Azure Key Vault. Se la chiave denominata esiste già, Azure Key Vault crea una nuova versione della chiave. Richiede l'autorizzazione chiavi/creazione.

Esempio di utilizzo:

let client = new KeyClient(url, credentials);
let result = await client.createRsaKey("MyKey", { keySize: 2048 });

Crea una nuova chiave, la archivia, quindi restituisce i parametri chiave e le proprietà al client.

function createRsaKey(name: string, options?: CreateRsaKeyOptions): Promise<KeyVaultKey>

Parametri

Restituisce

Ottiene un CryptographyClient per la chiave specificata.

Esempio di utilizzo:

let client = new KeyClient(url, credentials);
// get a cryptography client for a given key
let cryptographyClient = client.getCryptographyClient("MyKey");

function getCryptographyClient(keyName: string, options?: GetCryptographyClientOptions): CryptographyClient

Parametri

Restituisce

• Un CryptographyClient usando le stesse opzioni, le credenziali e il client HTTP di questo KeyClient

Il metodo getDeletedKey restituisce la chiave eliminata specificata insieme alle relative proprietà. Questa operazione richiede l'autorizzazione keys/get.

Esempio di utilizzo:

let client = new KeyClient(url, credentials);
let key = await client.getDeletedKey("MyDeletedKey");

Ottiene la chiave eliminata specificata.

function getDeletedKey(name: string, options?: GetDeletedKeyOptions): Promise<DeletedKey>

Parametri

Restituisce

Il metodo getKey ottiene una chiave specificata ed è applicabile a qualsiasi chiave archiviata in Azure Key Vault. Questa operazione richiede l'autorizzazione keys/get.

Esempio di utilizzo:

let client = new KeyClient(url, credentials);
let key = await client.getKey("MyKey");

Ottenere una chiave specificata da un determinato insieme di credenziali delle chiavi.

function getKey(name: string, options?: GetKeyOptions): Promise<KeyVaultKey>

Parametri

Restituisce

Ottiene i criteri di rotazione di una chiave di Key Vault. Per impostazione predefinita, tutte le chiavi hanno un criterio che invierà una notifica di 30 giorni prima della scadenza.

Questa operazione richiede l'autorizzazione keys/get. Esempio di utilizzo:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.getKeyRotationPolicy("myKey");

function getKeyRotationPolicy(keyName: string, options?: GetKeyRotationPolicyOptions): Promise<KeyRotationPolicy>

Parametri

Restituisce

Ottiene il numero richiesto di byte contenenti valori casuali da un modulo di protezione hardware gestito. Questa operazione richiede l'autorizzazione managedHsm/rng.

Esempio di utilizzo:

let client = new KeyClient(vaultUrl, credentials);
let { bytes } = await client.getRandomBytes(10);

function getRandomBytes(count: number, options?: GetRandomBytesOptions): Promise<Uint8Array>

Parametri

Restituisce

L'operazione di importazione della chiave può essere usata per importare qualsiasi tipo di chiave in un insieme di credenziali delle chiavi di Azure. Se la chiave denominata esiste già, Azure Key Vault crea una nuova versione della chiave. Questa operazione richiede l'autorizzazione chiavi/importazione.

Esempio di utilizzo:

let client = new KeyClient(url, credentials);
// Key contents in myKeyContents
let result = await client.importKey("MyKey", myKeyContents);

Importa una chiave creata esternamente, la archivia e restituisce parametri e proprietà chiave al client.

function importKey(name: string, key: JsonWebKey, options?: ImportKeyOptions): Promise<KeyVaultKey>

Parametri

Restituisce

Scorre le chiavi eliminate nell'insieme di credenziali. Nella risposta vengono fornite le proprietà e l'identificatore di chiave completi. Non vengono restituiti valori per le chiavi. Questa operazione richiede l'autorizzazione keys/list.

Esempio di utilizzo:

let client = new KeyClient(url, credentials);
for await (const deletedKey of client.listDeletedKeys()) {
  console.log("deleted key: ", deletedKey);
}

Elencare tutte le chiavi nell'insieme di credenziali

function listDeletedKeys(options?: ListDeletedKeysOptions): PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

Parametri

Restituisce

Scorre la versione più recente di tutte le chiavi nell'insieme di credenziali. Nella risposta vengono fornite le proprietà e l'identificatore di chiave completi. Non vengono restituiti valori per le chiavi. Questa operazione richiede l'autorizzazione keys/list.

Esempio di utilizzo:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeys()) {
  const key = await client.getKey(keyProperties.name);
  console.log("key: ", key);
}

Elencare tutte le chiavi nell'insieme di credenziali

function listPropertiesOfKeys(options?: ListPropertiesOfKeysOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

Parametri

Restituisce

Scorre tutte le versioni della chiave specificata nell'insieme di credenziali. Nella risposta vengono forniti l'identificatore di chiave, le proprietà e i tag completi. Questa operazione richiede l'autorizzazione keys/list.

Esempio di utilizzo:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeyVersions("MyKey")) {
  const key = await client.getKey(keyProperties.name);
  console.log("key version: ", key);
}

function listPropertiesOfKeyVersions(name: string, options?: ListPropertiesOfKeyVersionsOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

Parametri

Restituisce

L'operazione di eliminazione della chiave eliminata rimuove definitivamente la chiave, senza la possibilità di ripristino. Questa operazione può essere abilitata solo in un insieme di credenziali abilitato per l'eliminazione temporanea. Questa operazione richiede l'autorizzazione chiavi/ripulitura.

Esempio di utilizzo:

const client = new KeyClient(url, credentials);
const deletePoller = await client.beginDeleteKey("MyKey")
await deletePoller.pollUntilDone();
await client.purgeDeletedKey("MyKey");

Elimina definitivamente la chiave specificata.

function purgeDeletedKey(name: string, options?: PurgeDeletedKeyOptions): Promise<void>

Parametri

Restituisce

Rilascia una chiave da un modulo di protezione hardware gestito.

L'operazione della chiave di rilascio è applicabile a tutti i tipi di chiave. L'operazione richiede che la chiave sia contrassegnata come esportabile e l'autorizzazione chiavi/rilascio.

Esempio di utilizzo:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", target)

function releaseKey(name: string, targetAttestationToken: string, options?: ReleaseKeyOptions): Promise<ReleaseKeyResult>

Parametri

Restituisce

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

Esempio di utilizzo:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
// ...
let key = await client.restoreKeyBackup(backupContents);

Ripristina una chiave di cui è stato eseguito il backup in un insieme di credenziali.

function restoreKeyBackup(backup: Uint8Array, options?: RestoreKeyBackupOptions): Promise<KeyVaultKey>

Parametri

Restituisce

Ruota la chiave in base ai criteri chiave generando una nuova versione della chiave. Questa operazione richiede l'autorizzazione chiavi/rotazione.

Esempio di utilizzo:

let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");

function rotateKey(name: string, options?: RotateKeyOptions): Promise<KeyVaultKey>

Parametri

Restituisce

Il metodo updateKeyProperties modifica le proprietà specificate di una chiave archiviata esistente. Le proprietà non specificate nella richiesta vengono lasciate invariate. Impossibile modificare il valore di una chiave stessa. Questa operazione richiede l'autorizzazione chiavi/set.

Esempio di utilizzo:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, key.properties.version, { enabled: false });

Aggiorna le proprietà associate a una chiave specificata in un determinato insieme di credenziali delle chiavi.

function updateKeyProperties(name: string, keyVersion: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>

Parametri

Restituisce

Il metodo updateKeyProperties modifica le proprietà specificate della versione più recente di una chiave archiviata esistente. Le proprietà non specificate nella richiesta vengono lasciate invariate. Impossibile modificare il valore di una chiave stessa. Questa operazione richiede l'autorizzazione chiavi/set.

Esempio di utilizzo:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, { enabled: false });

Aggiorna le proprietà associate a una chiave specificata in un determinato insieme di credenziali delle chiavi.

function updateKeyProperties(name: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>

Parametri

Restituisce

Aggiorna i criteri di rotazione di una chiave di Key Vault. Questa operazione richiede l'autorizzazione chiavi/aggiornamento.

Esempio di utilizzo:

let client = new KeyClient(vaultUrl, credentials);
const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);

function updateKeyRotationPolicy(keyName: string, policy: KeyRotationPolicyProperties, options?: UpdateKeyRotationPolicyOptions): Promise<KeyRotationPolicy>

Parametri

Restituisce