Condividi tramite

KeyClient class

  • Riferimento
Pacchetto:
@azure/keyvault-keys

KeyClient fornisce metodi per gestire KeyVaultKey nell'Key Vault di Azure. Il client supporta la creazione, il recupero, l'aggiornamento, l'eliminazione, l'eliminazione, il backup, il ripristino e l'elenco di KeyVaultKey. Il client supporta anche l'elenco di DeletedKey per un Key Vault di Azure abilitato per l'eliminazione temporanea.

Costruttori

KeyClient(string, TokenCredential, KeyClientOptions)

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

Proprietà

vaultUrl

URL di base dell'insieme di credenziali

Metodi

backupKey(string, BackupKeyOptions)

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.
beginDeleteKey(string, BeginDeleteKeyOptions)

L'operazione di eliminazione si applica a qualsiasi chiave archiviata in Azure Key Vault. Non è possibile eliminare singole versioni di una chiave, 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.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Recupera la chiave eliminata nell'insieme di credenziali specificato. Questa operazione può essere eseguita solo in 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.
createEcKey(string, CreateEcKeyOptions)

Il metodo createEcKey crea una nuova chiave curva ellittica in Azure Key Vault. Se la chiave denominata esiste già, l'insieme di credenziali chiave di Azure 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.
createKey(string, string, CreateKeyOptions)

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à, l'insieme di credenziali chiave di Azure 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.
createOctKey(string, CreateOctKeyOptions)

Il metodo createOctKey crea una nuova chiave di Office in Azure Key Vault. Se la chiave denominata esiste già, l'insieme di credenziali chiave di Azure 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.
createRsaKey(string, CreateRsaKeyOptions)

Il metodo createRSAKey crea una nuova chiave RSA in Azure Key Vault. Se la chiave denominata esiste già, l'insieme di credenziali chiave di Azure 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.
getCryptographyClient(string, GetCryptographyClientOptions)

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");
getDeletedKey(string, GetDeletedKeyOptions)

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.
getKey(string, GetKeyOptions)

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.
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

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

Questa operazione richiede le chiavi/ottenere l'autorizzazione. Esempio di utilizzo:

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

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);
importKey(string, JsonWebKey_2, ImportKeyOptions)

L'operazione di importazione della chiave può essere usata per importare qualsiasi tipo di chiave in un Key Vault di Azure. Se la chiave denominata esiste già, l'insieme di credenziali chiave di Azure 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.
listDeletedKeys(ListDeletedKeysOptions)

Scorre le chiavi eliminate nell'insieme di credenziali. L'identificatore e le proprietà della chiave completa vengono forniti nella risposta. Non vengono restituiti valori per le chiavi. Queste operazioni richiedono l'autorizzazione chiavi/elenco.

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
listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Scorre la versione più recente di tutte le chiavi nell'insieme di credenziali. L'identificatore e le proprietà della chiave completa vengono forniti nella risposta. Non vengono restituiti valori per le chiavi. Queste operazioni richiedono l'autorizzazione chiavi/elenco.

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
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

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

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);
}
purgeDeletedKey(string, PurgeDeletedKeyOptions)

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/eliminazione.

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.
releaseKey(string, string, ReleaseKeyOptions)

Rilascia una chiave da un modulo di protezione hardware gestito.

L'operazione della chiave di rilascio è applicabile a tutti i tipi di chiavi. 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)
restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Ripristina una chiave di 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 backup in un insieme di credenziali.
rotateKey(string, RotateKeyOptions)

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");
updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

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

Aggiornamenti le proprietà associate a una chiave specificata in un insieme di credenziali delle chiavi specificato.
updateKeyProperties(string, UpdateKeyPropertiesOptions)

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

Aggiornamenti le proprietà associate a una chiave specificata in un insieme di credenziali delle chiavi specificato.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Aggiornamenti i criteri di rotazione di una chiave 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);

Dettagli costruttore

KeyClient(string, TokenCredential, KeyClientOptions)

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

vaultUrl

string

URL del Key Vault. Deve avere questa forma: https://${your-key-vault-name}.vault.azure.net. È necessario verificare che questo URL faccia riferimento a una risorsa HSM Key Vault o gestita 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 @azure/identity pacchetto per creare credenziali adatte alle proprie esigenze.

pipelineOptions
KeyClientOptions

Opzioni della pipeline usate per configurare Key Vault richieste API. 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

backupKey(string, BackupKeyOptions)

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

name

string

Nome della chiave.

options
BackupKeyOptions

Parametri facoltativi.

Restituisce

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

L'operazione di eliminazione si applica a qualsiasi chiave archiviata in Azure Key Vault. Non è possibile eliminare singole versioni di una chiave, 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

name

string

Nome della chiave.

options
BeginDeleteKeyOptions

Parametri facoltativi.

Restituisce

Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Recupera la chiave eliminata nell'insieme di credenziali specificato. Questa operazione può essere eseguita solo in 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

name

string

Nome della chiave eliminata.

options
BeginRecoverDeletedKeyOptions

Parametri facoltativi.

Restituisce

Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

createEcKey(string, CreateEcKeyOptions)

Il metodo createEcKey crea una nuova chiave curva ellittica in Azure Key Vault. Se la chiave denominata esiste già, l'insieme di credenziali chiave di Azure 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

name

string

Nome della chiave.

options
CreateEcKeyOptions

Parametri facoltativi.

Restituisce

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

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à, l'insieme di credenziali chiave di Azure 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

name

string

Nome della chiave.

keyType

string

Tipo di chiave. Uno dei seguenti: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'.

options
CreateKeyOptions

Parametri facoltativi.

Restituisce

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

Il metodo createOctKey crea una nuova chiave di Office in Azure Key Vault. Se la chiave denominata esiste già, l'insieme di credenziali chiave di Azure 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

name

string

Nome della chiave.

options
CreateOctKeyOptions

Parametri facoltativi.

Restituisce

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

Il metodo createRSAKey crea una nuova chiave RSA in Azure Key Vault. Se la chiave denominata esiste già, l'insieme di credenziali chiave di Azure 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

name

string

Nome della chiave.

options
CreateRsaKeyOptions

Parametri facoltativi.

Restituisce

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

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

keyName

string

options
GetCryptographyClientOptions

Restituisce

CryptographyClient

getDeletedKey(string, GetDeletedKeyOptions)

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

name

string

Nome della chiave.

options
GetDeletedKeyOptions

Parametri facoltativi.

Restituisce

Promise<DeletedKey>

getKey(string, GetKeyOptions)

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

name

string

Nome della chiave.

options
GetKeyOptions

Parametri facoltativi.

Restituisce

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

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

Questa operazione richiede le chiavi/ottenere l'autorizzazione. Esempio di utilizzo:

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

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

Parametri

keyName

string

Nome della chiave.

options
GetKeyRotationPolicyOptions

Parametri facoltativi.

Restituisce

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

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

count

number

Numero di byte da generare tra 1 e 128 inclusi.

options
GetRandomBytesOptions

Parametri facoltativi.

Restituisce

Promise<Uint8Array>

importKey(string, JsonWebKey_2, ImportKeyOptions)

L'operazione di importazione della chiave può essere usata per importare qualsiasi tipo di chiave in un Key Vault di Azure. Se la chiave denominata esiste già, l'insieme di credenziali chiave di Azure 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_2, options?: ImportKeyOptions): Promise<KeyVaultKey>

Parametri

name

string

Nome della chiave importata.

key
JsonWebKey

Chiave Web JSON.

options
ImportKeyOptions

Parametri facoltativi.

Restituisce

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

Scorre le chiavi eliminate nell'insieme di credenziali. L'identificatore e le proprietà della chiave completa vengono forniti nella risposta. Non vengono restituiti valori per le chiavi. Queste operazioni richiedono l'autorizzazione chiavi/elenco.

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

options
ListDeletedKeysOptions

Parametri facoltativi.

Restituisce

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Scorre la versione più recente di tutte le chiavi nell'insieme di credenziali. L'identificatore e le proprietà della chiave completa vengono forniti nella risposta. Non vengono restituiti valori per le chiavi. Queste operazioni richiedono l'autorizzazione chiavi/elenco.

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

options
ListPropertiesOfKeysOptions

Parametri facoltativi.

Restituisce

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

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

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

name

string

Nome della chiave per recuperare le versioni per

options
ListPropertiesOfKeyVersionsOptions

Parametri facoltativi.

Restituisce

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

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/eliminazione.

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

name

string

Nome della chiave.

options
PurgeDeletedKeyOptions

Parametri facoltativi.

Restituisce

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

Rilascia una chiave da un modulo di protezione hardware gestito.

L'operazione della chiave di rilascio è applicabile a tutti i tipi di chiavi. 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

name

string

Nome della chiave.

targetAttestationToken

string

Asserzione di attestazione per la destinazione della versione della chiave.

options
ReleaseKeyOptions

Parametri facoltativi.

Restituisce

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Ripristina una chiave di 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 backup in un insieme di credenziali.

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

Parametri

backup

Uint8Array

BLOB di backup associato a un bundle di chiavi.

options
RestoreKeyBackupOptions

Parametri facoltativi.

Restituisce

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

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

name

string

Nome della chiave da ruotare.

options
RotateKeyOptions

Parametri facoltativi.

Restituisce

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

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

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

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

Parametri

name

string

Nome della chiave.

keyVersion

string

Versione della chiave.

options
UpdateKeyPropertiesOptions

Parametri facoltativi.

Restituisce

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

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

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

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

Parametri

name

string

Nome della chiave.

options
UpdateKeyPropertiesOptions

Parametri facoltativi.

Restituisce

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Aggiornamenti i criteri di rotazione di una chiave 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

keyName

string

Nome della chiave.

policy
KeyRotationPolicyProperties
options
UpdateKeyRotationPolicyOptions

Parametri facoltativi.

Restituisce

Promise<KeyRotationPolicy>