KeyClient class

Paket:

@azure/keyvault-keys

KeyClient innehåller metoder för att hantera KeyVaultKey i Azure Key Vault. Klienten har stöd för att skapa, hämta, uppdatera, ta bort, rensa, säkerhetskopiera, återställa och lista KeyVaultKeys. Klienten stöder också listning av DeletedKey för en aktiverad Azure-Key Vault med mjuk borttagning.

Konstruktorer

KeyClient(string, TokenCredential, KeyClientOptions)

Skapar en instans av KeyClient. Exempel på användning: 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);

Egenskaper

vaultUrl

Bas-URL:en till valvet

Metoder

backupKey(string, BackupKeyOptions)	Begär att en säkerhetskopia av den angivna nyckeln laddas ned till klienten. Alla versioner av nyckeln laddas ned. Den här åtgärden kräver behörigheten nycklar/säkerhetskopiering. Exempel på användning: let client = new KeyClient(url, credentials); let backupContents = await client.backupKey("MyKey"); Säkerhetskopierar den angivna nyckeln.
beginDeleteKey(string, BeginDeleteKeyOptions)	Borttagningsåtgärden gäller alla nycklar som lagras i Azure Key Vault. Enskilda versioner av en nyckel kan inte tas bort, endast alla versioner av en viss nyckel samtidigt. Den här funktionen returnerar en poller för långvariga åtgärder som gör att du kan vänta på obestämd tid tills nyckeln tas bort. Den här åtgärden kräver behörigheten nycklar/borttagning. Exempel på användning: 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); Tar bort en nyckel från ett angivet nyckelvalv.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)	Återställer den borttagna nyckeln i det angivna valvet. Den här åtgärden kan bara utföras på ett aktiverat valv med mjuk borttagning. Den här funktionen returnerar en pollerare för långvariga åtgärder som gör att du kan vänta på obestämd tid tills den borttagna nyckeln återställs. Den här åtgärden kräver behörigheten nycklar/återställning. Exempel på användning: 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); Återställer den borttagna nyckeln till den senaste versionen.
createEcKey(string, CreateEcKeyOptions)	Metoden createEcKey skapar en ny elliptisk kurvnyckel i Azure Key Vault. Om den namngivna nyckeln redan finns skapar Azure Key Vault en ny version av nyckeln. Det kräver behörigheten nycklar/skapa. Exempel på användning: let client = new KeyClient(url, credentials); let result = await client.createEcKey("MyKey", { curve: "P-256" }); Skapar en ny nyckel, lagrar den och returnerar sedan nyckelparametrar och egenskaper till klienten.
createKey(string, string, CreateKeyOptions)	Åtgärden skapa nyckel kan användas för att skapa valfri nyckeltyp i Azure Key Vault. Om den namngivna nyckeln redan finns skapar Azure Key Vault en ny version av nyckeln. Det kräver behörigheten nycklar/skapa. Exempel på användning: let client = new KeyClient(url, credentials); // Create an elliptic-curve key: let result = await client.createKey("MyKey", "EC"); Skapar en ny nyckel, lagrar den och returnerar sedan nyckelparametrar och egenskaper till klienten.
createOctKey(string, CreateOctKeyOptions)	Metoden createOctKey skapar en ny OCT-nyckel i Azure Key Vault. Om den namngivna nyckeln redan finns skapar Azure Key Vault en ny version av nyckeln. Det kräver behörigheten nycklar/skapa. Exempel på användning: let client = new KeyClient(url, credentials); let result = await client.createOctKey("MyKey", { hsm: true }); Skapar en ny nyckel, lagrar den och returnerar sedan nyckelparametrar och egenskaper till klienten.
createRsaKey(string, CreateRsaKeyOptions)	Metoden createRSAKey skapar en ny RSA-nyckel i Azure Key Vault. Om den namngivna nyckeln redan finns skapar Azure Key Vault en ny version av nyckeln. Det kräver behörigheten nycklar/skapa. Exempel på användning: let client = new KeyClient(url, credentials); let result = await client.createRsaKey("MyKey", { keySize: 2048 }); Skapar en ny nyckel, lagrar den och returnerar sedan nyckelparametrar och egenskaper till klienten.
getCryptographyClient(string, GetCryptographyClientOptions)	Hämtar en CryptographyClient för den angivna nyckeln. Exempel på användning: let client = new KeyClient(url, credentials); // get a cryptography client for a given key let cryptographyClient = client.getCryptographyClient("MyKey");
getDeletedKey(string, GetDeletedKeyOptions)	Metoden getDeletedKey returnerar den angivna borttagna nyckeln tillsammans med dess egenskaper. Den här åtgärden kräver behörigheten nycklar/hämta. Exempel på användning: let client = new KeyClient(url, credentials); let key = await client.getDeletedKey("MyDeletedKey"); Hämtar den angivna borttagna nyckeln.
getKey(string, GetKeyOptions)	Metoden getKey hämtar en angiven nyckel och gäller för alla nycklar som lagras i Azure Key Vault. Den här åtgärden kräver behörigheten nycklar/hämta. Exempel på användning: let client = new KeyClient(url, credentials); let key = await client.getKey("MyKey"); Hämta en angiven nyckel från ett visst nyckelvalv.
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)	Hämtar rotationsprincipen för en Key Vault-nyckel. Som standard har alla nycklar en princip som meddelar 30 dagar innan den upphör att gälla. Den här åtgärden kräver behörigheten nycklar/hämta. Exempel på användning: let client = new KeyClient(vaultUrl, credentials); let result = await client.getKeyRotationPolicy("myKey");
getRandomBytes(number, GetRandomBytesOptions)	Hämtar det begärda antalet byte som innehåller slumpmässiga värden från en hanterad HSM. Den här åtgärden kräver managedHsm/rng-behörigheten. Exempel på användning: let client = new KeyClient(vaultUrl, credentials); let { bytes } = await client.getRandomBytes(10);
importKey(string, JsonWebKey_2, ImportKeyOptions)	Importnyckelåtgärden kan användas för att importera valfri nyckeltyp till en Azure-Key Vault. Om den namngivna nyckeln redan finns skapar Azure Key Vault en ny version av nyckeln. Den här åtgärden kräver behörigheten nycklar/import. Exempel på användning: let client = new KeyClient(url, credentials); // Key contents in myKeyContents let result = await client.importKey("MyKey", myKeyContents); Importerar en externt skapad nyckel, lagrar den och returnerar nyckelparametrar och egenskaper till klienten.
listDeletedKeys(ListDeletedKeysOptions)	Itererar de borttagna nycklarna i valvet. Den fullständiga nyckelidentifieraren och egenskaperna finns i svaret. Inga värden returneras för nycklarna. De här åtgärderna kräver behörigheten nycklar/lista. Exempel på användning: let client = new KeyClient(url, credentials); for await (const deletedKey of client.listDeletedKeys()) { console.log("deleted key: ", deletedKey); } Visa en lista över alla nycklar i valvet
listPropertiesOfKeys(ListPropertiesOfKeysOptions)	Itererar den senaste versionen av alla nycklar i valvet. Den fullständiga nyckelidentifieraren och egenskaperna finns i svaret. Inga värden returneras för nycklarna. De här åtgärderna kräver behörigheten nycklar/lista. Exempel på användning: let client = new KeyClient(url, credentials); for await (const keyProperties of client.listPropertiesOfKeys()) { const key = await client.getKey(keyProperties.name); console.log("key: ", key); } Visa en lista över alla nycklar i valvet
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)	Itererar alla versioner av den angivna nyckeln i valvet. Den fullständiga nyckelidentifieraren, egenskaperna och taggarna finns i svaret. Den här åtgärden kräver behörigheten nycklar/lista. Exempel på användning: 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)	Åtgärden rensa borttagen nyckel tar bort nyckeln permanent, utan möjlighet till återställning. Den här åtgärden kan bara aktiveras i ett aktiverat valv med mjuk borttagning. Den här åtgärden kräver behörigheten nycklar/rensning. Exempel på användning: const client = new KeyClient(url, credentials); const deletePoller = await client.beginDeleteKey("MyKey") await deletePoller.pollUntilDone(); await client.purgeDeletedKey("MyKey"); Tar bort den angivna nyckeln permanent.
releaseKey(string, string, ReleaseKeyOptions)	Släpper en nyckel från en hanterad HSM. Versionsnyckelåtgärden gäller för alla nyckeltyper. Åtgärden kräver att nyckeln markeras som exporterbar och nycklar/frisläppningsbehörighet. Exempel på användning: let client = new KeyClient(vaultUrl, credentials); let result = await client.releaseKey("myKey", target)
restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)	Återställer en säkerhetskopierad nyckel och alla dess versioner till ett valv. Den här åtgärden kräver behörigheten nycklar/återställning. Exempel på användning: let client = new KeyClient(url, credentials); let backupContents = await client.backupKey("MyKey"); // ... let key = await client.restoreKeyBackup(backupContents); Återställer en säkerhetskopierad nyckel till ett valv.
rotateKey(string, RotateKeyOptions)	Roterar nyckeln baserat på nyckelprincipen genom att generera en ny version av nyckeln. Den här åtgärden kräver behörigheten nycklar/rotera. Exempel på användning: let client = new KeyClient(vaultUrl, credentials); let key = await client.rotateKey("MyKey");
updateKeyProperties(string, string, UpdateKeyPropertiesOptions)	Metoden updateKeyProperties ändrar angivna egenskaper för en befintlig lagrad nyckel. Egenskaper som inte anges i begäran lämnas oförändrade. Det går inte att ändra värdet för själva nyckeln. Den här åtgärden kräver behörigheten nycklar/uppsättning. Exempel på användning: 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 }); Uppdateringar de egenskaper som är associerade med en angiven nyckel i ett visst nyckelvalv.
updateKeyProperties(string, UpdateKeyPropertiesOptions)	Metoden updateKeyProperties ändrar de angivna egenskaperna för den senaste versionen av en befintlig lagrad nyckel. Egenskaper som inte anges i begäran lämnas oförändrade. Det går inte att ändra värdet för själva nyckeln. Den här åtgärden kräver behörigheten nycklar/uppsättning. Exempel på användning: let keyName = "MyKey"; let client = new KeyClient(vaultUrl, credentials); let key = await client.getKey(keyName); let result = await client.updateKeyProperties(keyName, { enabled: false }); Uppdateringar de egenskaper som är associerade med en angiven nyckel i ett visst nyckelvalv.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)	Uppdateringar rotationsprincipen för en Key Vault-nyckel. Den här åtgärden kräver behörigheten nycklar/uppdatering. Exempel på användning: let client = new KeyClient(vaultUrl, credentials); const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);

Konstruktorinformation

KeyClient(string, TokenCredential, KeyClientOptions)

Skapar en instans av KeyClient.

Exempel på användning:

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)

Parametrar

vaultUrl

string

URL:en för Key Vault. Den bör ha den här formen: https://${your-key-vault-name}.vault.azure.net. Du bör kontrollera att den här URL:en refererar till en giltig Key Vault- eller Managed HSM-resurs. Mer information finns under https://aka.ms/azsdk/blog/vault-uri.

credential

TokenCredential

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

pipelineOptions

KeyClientOptions

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

Egenskapsinformation

vaultUrl

Bas-URL:en till valvet

vaultUrl: string

Egenskapsvärde

string

Metodinformation

backupKey(string, BackupKeyOptions)

Begär att en säkerhetskopia av den angivna nyckeln laddas ned till klienten. Alla versioner av nyckeln laddas ned. Den här åtgärden kräver behörigheten nycklar/säkerhetskopiering.

Exempel på användning:

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

Säkerhetskopierar den angivna nyckeln.

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

Parametrar

name

string

Namnet på nyckeln.

options

BackupKeyOptions

De valfria parametrarna.

Returer

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

Borttagningsåtgärden gäller alla nycklar som lagras i Azure Key Vault. Enskilda versioner av en nyckel kan inte tas bort, endast alla versioner av en viss nyckel samtidigt.

Den här funktionen returnerar en poller för långvariga åtgärder som gör att du kan vänta på obestämd tid tills nyckeln tas bort.

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

Exempel på användning:

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

Tar bort en nyckel från ett angivet nyckelvalv.

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

Parametrar

name

string

Namnet på nyckeln.

options

BeginDeleteKeyOptions

De valfria parametrarna.

Returer

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

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Återställer den borttagna nyckeln i det angivna valvet. Den här åtgärden kan bara utföras på ett aktiverat valv med mjuk borttagning.

Den här funktionen returnerar en pollerare för långvariga åtgärder som gör att du kan vänta på obestämd tid tills den borttagna nyckeln återställs.

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

Exempel på användning:

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

Återställer den borttagna nyckeln till den senaste versionen.

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

Parametrar

name

string

Namnet på den borttagna nyckeln.

options

BeginRecoverDeletedKeyOptions

De valfria parametrarna.

Returer

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

createEcKey(string, CreateEcKeyOptions)

Metoden createEcKey skapar en ny elliptisk kurvnyckel i Azure Key Vault. Om den namngivna nyckeln redan finns skapar Azure Key Vault en ny version av nyckeln. Det kräver behörigheten nycklar/skapa.

Exempel på användning:

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

Skapar en ny nyckel, lagrar den och returnerar sedan nyckelparametrar och egenskaper till klienten.

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

Parametrar

name

string

Namnet på nyckeln.

options

CreateEcKeyOptions

De valfria parametrarna.

Returer

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

Åtgärden skapa nyckel kan användas för att skapa valfri nyckeltyp i Azure Key Vault. Om den namngivna nyckeln redan finns skapar Azure Key Vault en ny version av nyckeln. Det kräver behörigheten nycklar/skapa.

Exempel på användning:

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

Skapar en ny nyckel, lagrar den och returnerar sedan nyckelparametrar och egenskaper till klienten.

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

Parametrar

name

string

Namnet på nyckeln.

keyType

string

Typ av nyckel. Något av följande: "EC", "EC-HSM", "RSA", "RSA-HSM", "oct".

options

CreateKeyOptions

De valfria parametrarna.

Returer

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

Metoden createOctKey skapar en ny OCT-nyckel i Azure Key Vault. Om den namngivna nyckeln redan finns skapar Azure Key Vault en ny version av nyckeln. Det kräver behörigheten nycklar/skapa.

Exempel på användning:

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

Skapar en ny nyckel, lagrar den och returnerar sedan nyckelparametrar och egenskaper till klienten.

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

Parametrar

name

string

Namnet på nyckeln.

options

CreateOctKeyOptions

De valfria parametrarna.

Returer

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

Metoden createRSAKey skapar en ny RSA-nyckel i Azure Key Vault. Om den namngivna nyckeln redan finns skapar Azure Key Vault en ny version av nyckeln. Det kräver behörigheten nycklar/skapa.

Exempel på användning:

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

Skapar en ny nyckel, lagrar den och returnerar sedan nyckelparametrar och egenskaper till klienten.

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

Parametrar

name

string

Namnet på nyckeln.

options

CreateRsaKeyOptions

De valfria parametrarna.

Returer

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

Hämtar en CryptographyClient för den angivna nyckeln.

Exempel på användning:

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

Parametrar

keyName

string

options

GetCryptographyClientOptions

Returer

CryptographyClient

• En CryptographyClient med samma alternativ, autentiseringsuppgifter och HTTP-klient som denna KeyClient

getDeletedKey(string, GetDeletedKeyOptions)

Metoden getDeletedKey returnerar den angivna borttagna nyckeln tillsammans med dess egenskaper. Den här åtgärden kräver behörigheten nycklar/hämta.

Exempel på användning:

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

Hämtar den angivna borttagna nyckeln.

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

Parametrar

name

string

Namnet på nyckeln.

options

GetDeletedKeyOptions

De valfria parametrarna.

Returer

Promise<DeletedKey>

getKey(string, GetKeyOptions)

Metoden getKey hämtar en angiven nyckel och gäller för alla nycklar som lagras i Azure Key Vault. Den här åtgärden kräver behörigheten nycklar/hämta.

Exempel på användning:

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

Hämta en angiven nyckel från ett visst nyckelvalv.

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

Parametrar

name

string

Namnet på nyckeln.

options

GetKeyOptions

De valfria parametrarna.

Returer

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Hämtar rotationsprincipen för en Key Vault-nyckel. Som standard har alla nycklar en princip som meddelar 30 dagar innan den upphör att gälla.

Den här åtgärden kräver behörigheten nycklar/hämta. Exempel på användning:

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

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

Parametrar

keyName

string

Namnet på nyckeln.

options

GetKeyRotationPolicyOptions

De valfria parametrarna.

Returer

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

Hämtar det begärda antalet byte som innehåller slumpmässiga värden från en hanterad HSM. Den här åtgärden kräver managedHsm/rng-behörigheten.

Exempel på användning:

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

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

Parametrar

count

number

Antalet byte som ska genereras mellan 1 och 128.

options

GetRandomBytesOptions

De valfria parametrarna.

Returer

Promise<Uint8Array>

importKey(string, JsonWebKey_2, ImportKeyOptions)

Importnyckelåtgärden kan användas för att importera valfri nyckeltyp till en Azure-Key Vault. Om den namngivna nyckeln redan finns skapar Azure Key Vault en ny version av nyckeln. Den här åtgärden kräver behörigheten nycklar/import.

Exempel på användning:

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

Importerar en externt skapad nyckel, lagrar den och returnerar nyckelparametrar och egenskaper till klienten.

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

Parametrar

name

string

Namn på den importerade nyckeln.

key

JsonWebKey

JSON-webbnyckeln.

options

ImportKeyOptions

De valfria parametrarna.

Returer

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

Itererar de borttagna nycklarna i valvet. Den fullständiga nyckelidentifieraren och egenskaperna finns i svaret. Inga värden returneras för nycklarna. De här åtgärderna kräver behörigheten nycklar/lista.

Exempel på användning:

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

Visa en lista över alla nycklar i valvet

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

Parametrar

options

ListDeletedKeysOptions

De valfria parametrarna.

Returer

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

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

Exempel på användning:

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

Visa en lista över alla nycklar i valvet

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

Parametrar

options

ListPropertiesOfKeysOptions

De valfria parametrarna.

Returer

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Itererar alla versioner av den angivna nyckeln i valvet. Den fullständiga nyckelidentifieraren, egenskaperna och taggarna finns i svaret. Den här åtgärden kräver behörigheten nycklar/lista.

Exempel på användning:

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>

Parametrar

name

string

Namnet på nyckeln som ska hämtas versioner för

options

ListPropertiesOfKeyVersionsOptions

De valfria parametrarna.

Returer

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

Åtgärden rensa borttagen nyckel tar bort nyckeln permanent, utan möjlighet till återställning. Den här åtgärden kan bara aktiveras i ett aktiverat valv med mjuk borttagning. Den här åtgärden kräver behörigheten nycklar/rensning.

Exempel på användning:

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

Tar bort den angivna nyckeln permanent.

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

Parametrar

name

string

Namnet på nyckeln.

options

PurgeDeletedKeyOptions

De valfria parametrarna.

Returer

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

Släpper en nyckel från en hanterad HSM.

Versionsnyckelåtgärden gäller för alla nyckeltyper. Åtgärden kräver att nyckeln markeras som exporterbar och nycklar/frisläppningsbehörighet.

Exempel på användning:

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

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

Parametrar

name

string

Namnet på nyckeln.

targetAttestationToken

string

Attesteringskontrollen för målet för nyckelversionen.

options

ReleaseKeyOptions

De valfria parametrarna.

Returer

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

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

Exempel på användning:

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

Återställer en säkerhetskopierad nyckel till ett valv.

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

Parametrar

backup

Uint8Array

Säkerhetskopieringsbloben som är associerad med ett nyckelpaket.

options

RestoreKeyBackupOptions

De valfria parametrarna.

Returer

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

Roterar nyckeln baserat på nyckelprincipen genom att generera en ny version av nyckeln. Den här åtgärden kräver behörigheten nycklar/rotera.

Exempel på användning:

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

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

Parametrar

name

string

Namnet på nyckeln som ska roteras.

options

RotateKeyOptions

De valfria parametrarna.

Returer

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

Metoden updateKeyProperties ändrar angivna egenskaper för en befintlig lagrad nyckel. Egenskaper som inte anges i begäran lämnas oförändrade. Det går inte att ändra värdet för själva nyckeln. Den här åtgärden kräver behörigheten nycklar/uppsättning.

Exempel på användning:

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

Uppdateringar de egenskaper som är associerade med en angiven nyckel i ett visst nyckelvalv.

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

Parametrar

name

string

Namnet på nyckeln.

keyVersion

string

Versionen av nyckeln.

options

UpdateKeyPropertiesOptions

De valfria parametrarna.

Returer

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

Metoden updateKeyProperties ändrar de angivna egenskaperna för den senaste versionen av en befintlig lagrad nyckel. Egenskaper som inte anges i begäran lämnas oförändrade. Det går inte att ändra värdet för själva nyckeln. Den här åtgärden kräver behörigheten nycklar/uppsättning.

Exempel på användning:

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

Uppdateringar de egenskaper som är associerade med en angiven nyckel i ett visst nyckelvalv.

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

Parametrar

name

string

Namnet på nyckeln.

options

UpdateKeyPropertiesOptions

De valfria parametrarna.

Returer

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Uppdateringar rotationsprincipen för en Key Vault-nyckel. Den här åtgärden kräver behörigheten nycklar/uppdatering.

Exempel på användning:

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

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

Parametrar

keyName

string

Namnet på nyckeln.

policy

KeyRotationPolicyProperties

options

UpdateKeyRotationPolicyOptions

De valfria parametrarna.

Returer

Promise<KeyRotationPolicy>