Sdílet prostřednictvím

KeyClient class

  • Reference
Balíček:
@azure/keyvault-keys

KeyClient poskytuje metody pro správu klíče KeyVaultKey v azure Key Vault. Klient podporuje vytváření, načítání, aktualizaci, odstraňování, mazání, zálohování, obnovení a výpis klíčů KeyVaultKeys. Klient také podporuje výpis odstraněného klíče pro Key Vault Azure s povoleným obnovitelném odstraněním.

Konstruktory

KeyClient(string, TokenCredential, KeyClientOptions)

Vytvoří instanci KeyClient.

Příklad použití:

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

Vlastnosti

vaultUrl

Základní adresa URL trezoru

Metody

backupKey(string, BackupKeyOptions)

Požádá o stažení zálohy zadaného klíče do klienta. Stáhnou se všechny verze klíče. Tato operace vyžaduje oprávnění ke klíčům nebo zálohování.

Příklad použití:

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

Zálohuje zadaný klíč.
beginDeleteKey(string, BeginDeleteKeyOptions)

Operace odstranění se vztahuje na všechny klíče uložené v Azure Key Vault. Jednotlivé verze klíče nelze odstranit, pouze všechny verze daného klíče najednou.

Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na odstranění klíče neomezeně dlouho.

Tato operace vyžaduje oprávnění ke klíčům nebo odstranění.

Příklad použití:

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

Odstraní klíč ze zadaného trezoru klíčů.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Obnoví odstraněný klíč v zadaném trezoru. Tuto operaci je možné provést pouze v trezoru s povoleným obnovitelném odstraněním.

Tato funkce vrátí poller dlouhotrvající operace, který vám umožní čekat neomezeně dlouho, dokud se odstraněný klíč neobnoví.

Tato operace vyžaduje oprávnění ke klíčům nebo obnovení.

Příklad použití:

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

Obnoví odstraněný klíč na nejnovější verzi.
createEcKey(string, CreateEcKeyOptions)

Metoda createEcKey vytvoří nový klíč eliptické křivky v Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje oprávnění ke klíčům nebo k vytvoření.

Příklad použití:

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

Vytvoří nový klíč, uloží ho a pak vrátí parametry a vlastnosti klíče klientovi.
createKey(string, string, CreateKeyOptions)

Operaci vytvoření klíče je možné použít k vytvoření libovolného typu klíče v Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje oprávnění ke klíčům nebo k vytvoření.

Příklad použití:

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

Vytvoří nový klíč, uloží ho a pak vrátí parametry a vlastnosti klíče klientovi.
createOctKey(string, CreateOctKeyOptions)

Metoda createOctKey vytvoří nový klíč OCT v Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje oprávnění ke klíčům nebo k vytvoření.

Příklad použití:

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

Vytvoří nový klíč, uloží ho a pak vrátí parametry a vlastnosti klíče klientovi.
createRsaKey(string, CreateRsaKeyOptions)

Metoda createRSAKey vytvoří v Azure Key Vault nový klíč RSA. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje oprávnění ke klíčům nebo k vytvoření.

Příklad použití:

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

Vytvoří nový klíč, uloží ho a pak vrátí parametry a vlastnosti klíče klientovi.
getCryptographyClient(string, GetCryptographyClientOptions)

Získá CryptographyClient pro daný klíč.

Příklad použití:

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

Metoda getDeletedKey vrátí zadaný odstraněný klíč spolu s jeho vlastnostmi. Tato operace vyžaduje oprávnění ke klíčům nebo získání.

Příklad použití:

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

Získá zadaný odstraněný klíč.
getKey(string, GetKeyOptions)

Metoda getKey získá zadaný klíč a použije se pro všechny klíče uložené v Azure Key Vault. Tato operace vyžaduje oprávnění ke klíčům nebo získání.

Příklad použití:

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

Získání zadaného klíče z daného trezoru klíčů
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Získá zásady obměně klíče Key Vault. Ve výchozím nastavení mají všechny klíče zásadu, která upozorní 30 dní před vypršením platnosti.

Tato operace vyžaduje oprávnění ke klíčům nebo získání. Příklad použití:

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

Získá požadovaný počet bajtů obsahujících náhodné hodnoty ze spravovaného HSM. Tato operace vyžaduje oprávnění managedHsm/rng.

Příklad použití:

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

Operaci importu klíče je možné použít k importu libovolného typu klíče do Key Vault Azure. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Tato operace vyžaduje oprávnění ke klíčům nebo importu.

Příklad použití:

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

Importuje externě vytvořený klíč, uloží ho a vrátí parametry a vlastnosti klíče klientovi.
listDeletedKeys(ListDeletedKeysOptions)

Iteruje odstraněné klíče v trezoru. Úplný identifikátor klíče a vlastnosti jsou uvedeny v odpovědi. Pro klíče se nevrátí žádné hodnoty. Tato operace vyžaduje oprávnění ke klíčům nebo seznamu.

Příklad použití:

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

Výpis všech klíčů v trezoru
listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Iteruje nejnovější verzi všech klíčů v trezoru. Úplný identifikátor klíče a vlastnosti jsou uvedeny v odpovědi. Pro klíče se nevrátí žádné hodnoty. Tato operace vyžaduje oprávnění ke klíčům nebo seznamu.

Příklad použití:

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

Výpis všech klíčů v trezoru
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Iteruje všechny verze daného klíče v trezoru. V odpovědi jsou uvedeny úplné identifikátory klíče, vlastnosti a značky. Tato operace vyžaduje oprávnění ke klíčům nebo seznamu.

Příklad použití:

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)

Operace vymazání odstraněného klíče klíč trvale odebere, aniž by bylo možné ho obnovit. Tuto operaci je možné povolit pouze v trezoru s povoleným obnovitelném odstraněním. Tato operace vyžaduje oprávnění klíče nebo vyprázdnění.

Příklad použití:

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

Trvale odstraní zadaný klíč.
releaseKey(string, string, ReleaseKeyOptions)

Uvolní klíč ze spravovaného HSM.

Operace vydaného klíče se vztahuje na všechny typy klíčů. Operace vyžaduje, aby byl klíč označený jako exportovatelný a oprávnění ke klíčům nebo uvolnění.

Příklad použití:

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

Obnoví zálohovaný klíč a všechny jeho verze do trezoru. Tato operace vyžaduje oprávnění ke klíčům nebo obnovení.

Příklad použití:

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

Obnoví zálohovaný klíč do trezoru.
rotateKey(string, RotateKeyOptions)

Obměňuje klíč na základě zásad klíče generováním nové verze klíče. Tato operace vyžaduje oprávnění ke klíčům nebo obměně.

Příklad použití:

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

Metoda updateKeyProperties změní zadané vlastnosti existujícího uloženého klíče. Vlastnosti, které nejsou v požadavku zadané, zůstanou beze změny. Samotnou hodnotu klíče nelze změnit. Tato operace vyžaduje oprávnění klíče nebo nastavení.

Příklad použití:

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

Aktualizace vlastnosti přidružené k zadanému klíči v daném trezoru klíčů.
updateKeyProperties(string, UpdateKeyPropertiesOptions)

Metoda updateKeyProperties změní zadané vlastnosti nejnovější verze existujícího uloženého klíče. Vlastnosti, které nejsou v požadavku zadané, zůstanou beze změny. Samotnou hodnotu klíče nelze změnit. Tato operace vyžaduje oprávnění klíče nebo nastavení.

Příklad použití:

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

Aktualizace vlastnosti přidružené k zadanému klíči v daném trezoru klíčů.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Aktualizace zásady obměně klíče Key Vault. Tato operace vyžaduje oprávnění ke klíčům nebo aktualizacím.

Příklad použití:

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

Podrobnosti konstruktoru

KeyClient(string, TokenCredential, KeyClientOptions)

Vytvoří instanci KeyClient.

Příklad použití:

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)

Parametry

vaultUrl

string

adresa URL Key Vault. Měla by mít tento tvar: https://${your-key-vault-name}.vault.azure.net. Měli byste ověřit, že tato adresa URL odkazuje na platný prostředek Key Vault nebo spravovaného HSM. Podrobnosti viz https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Objekt, který implementuje TokenCredential rozhraní používané k ověřování požadavků na službu. @azure/identity Pomocí balíčku vytvořte přihlašovací údaje, které budou vyhovovat vašim potřebám.

pipelineOptions
KeyClientOptions

Možnosti kanálu používané ke konfiguraci požadavků rozhraní API Key Vault Pokud chcete použít výchozí konfiguraci kanálu, tento parametr vynecháte.

Podrobnosti vlastnosti

vaultUrl

Základní adresa URL trezoru

vaultUrl: string

Hodnota vlastnosti

string

Podrobnosti metody

backupKey(string, BackupKeyOptions)

Požádá o stažení zálohy zadaného klíče do klienta. Stáhnou se všechny verze klíče. Tato operace vyžaduje oprávnění ke klíčům nebo zálohování.

Příklad použití:

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

Zálohuje zadaný klíč.

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

Parametry

name

string

Název klíče.

options
BackupKeyOptions

Volitelné parametry.

Návraty

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

Operace odstranění se vztahuje na všechny klíče uložené v Azure Key Vault. Jednotlivé verze klíče nelze odstranit, pouze všechny verze daného klíče najednou.

Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na odstranění klíče neomezeně dlouho.

Tato operace vyžaduje oprávnění ke klíčům nebo odstranění.

Příklad použití:

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

Odstraní klíč ze zadaného trezoru klíčů.

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

Parametry

name

string

Název klíče.

options
BeginDeleteKeyOptions

Volitelné parametry.

Návraty

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

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Obnoví odstraněný klíč v zadaném trezoru. Tuto operaci je možné provést pouze v trezoru s povoleným obnovitelném odstraněním.

Tato funkce vrátí poller dlouhotrvající operace, který vám umožní čekat neomezeně dlouho, dokud se odstraněný klíč neobnoví.

Tato operace vyžaduje oprávnění ke klíčům nebo obnovení.

Příklad použití:

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

Obnoví odstraněný klíč na nejnovější verzi.

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

Parametry

name

string

Název odstraněného klíče.

options
BeginRecoverDeletedKeyOptions

Volitelné parametry.

Návraty

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

createEcKey(string, CreateEcKeyOptions)

Metoda createEcKey vytvoří nový klíč eliptické křivky v Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje oprávnění ke klíčům nebo k vytvoření.

Příklad použití:

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

Vytvoří nový klíč, uloží ho a pak vrátí parametry a vlastnosti klíče klientovi.

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

Parametry

name

string

Název klíče.

options
CreateEcKeyOptions

Volitelné parametry.

Návraty

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

Operaci vytvoření klíče je možné použít k vytvoření libovolného typu klíče v Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje oprávnění ke klíčům nebo k vytvoření.

Příklad použití:

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

Vytvoří nový klíč, uloží ho a pak vrátí parametry a vlastnosti klíče klientovi.

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

Parametry

name

string

Název klíče.

keyType

string

Typ klíče. Jedna z těchto možností: "EC", "EC-HSM", "RSA", "RSA-HSM", "oct".

options
CreateKeyOptions

Volitelné parametry.

Návraty

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

Metoda createOctKey vytvoří nový klíč OCT v Azure Key Vault. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje oprávnění ke klíčům nebo k vytvoření.

Příklad použití:

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

Vytvoří nový klíč, uloží ho a pak vrátí parametry a vlastnosti klíče klientovi.

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

Parametry

name

string

Název klíče.

options
CreateOctKeyOptions

Volitelné parametry.

Návraty

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

Metoda createRSAKey vytvoří v Azure Key Vault nový klíč RSA. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Vyžaduje oprávnění ke klíčům nebo k vytvoření.

Příklad použití:

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

Vytvoří nový klíč, uloží ho a pak vrátí parametry a vlastnosti klíče klientovi.

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

Parametry

name

string

Název klíče.

options
CreateRsaKeyOptions

Volitelné parametry.

Návraty

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

Získá CryptographyClient pro daný klíč.

Příklad použití:

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

Parametry

keyName

string

options
GetCryptographyClientOptions

Návraty

CryptographyClient

getDeletedKey(string, GetDeletedKeyOptions)

Metoda getDeletedKey vrátí zadaný odstraněný klíč spolu s jeho vlastnostmi. Tato operace vyžaduje oprávnění ke klíčům nebo získání.

Příklad použití:

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

Získá zadaný odstraněný klíč.

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

Parametry

name

string

Název klíče.

options
GetDeletedKeyOptions

Volitelné parametry.

Návraty

Promise<DeletedKey>

getKey(string, GetKeyOptions)

Metoda getKey získá zadaný klíč a použije se pro všechny klíče uložené v Azure Key Vault. Tato operace vyžaduje oprávnění ke klíčům nebo získání.

Příklad použití:

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

Získání zadaného klíče z daného trezoru klíčů

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

Parametry

name

string

Název klíče.

options
GetKeyOptions

Volitelné parametry.

Návraty

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Získá zásady obměně klíče Key Vault. Ve výchozím nastavení mají všechny klíče zásadu, která upozorní 30 dní před vypršením platnosti.

Tato operace vyžaduje oprávnění ke klíčům nebo získání. Příklad použití:

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

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

Parametry

keyName

string

Název klíče.

options
GetKeyRotationPolicyOptions

Volitelné parametry.

Návraty

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

Získá požadovaný počet bajtů obsahujících náhodné hodnoty ze spravovaného HSM. Tato operace vyžaduje oprávnění managedHsm/rng.

Příklad použití:

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

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

Parametry

count

number

Počet bajtů, které se mají vygenerovat mezi 1 a 128 včetně.

options
GetRandomBytesOptions

Volitelné parametry.

Návraty

Promise<Uint8Array>

importKey(string, JsonWebKey_2, ImportKeyOptions)

Operaci importu klíče je možné použít k importu libovolného typu klíče do Key Vault Azure. Pokud pojmenovaný klíč již existuje, Azure Key Vault vytvoří novou verzi klíče. Tato operace vyžaduje oprávnění ke klíčům nebo importu.

Příklad použití:

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

Importuje externě vytvořený klíč, uloží ho a vrátí parametry a vlastnosti klíče klientovi.

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

Parametry

name

string

Název importovaného klíče.

key
JsonWebKey

Webový klíč JSON.

options
ImportKeyOptions

Volitelné parametry.

Návraty

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

Iteruje odstraněné klíče v trezoru. Úplný identifikátor klíče a vlastnosti jsou uvedeny v odpovědi. Pro klíče se nevrátí žádné hodnoty. Tato operace vyžaduje oprávnění ke klíčům nebo seznamu.

Příklad použití:

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

Výpis všech klíčů v trezoru

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

Parametry

options
ListDeletedKeysOptions

Volitelné parametry.

Návraty

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Iteruje nejnovější verzi všech klíčů v trezoru. Úplný identifikátor klíče a vlastnosti jsou uvedeny v odpovědi. Pro klíče se nevrátí žádné hodnoty. Tato operace vyžaduje oprávnění ke klíčům nebo seznamu.

Příklad použití:

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

Výpis všech klíčů v trezoru

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

Parametry

options
ListPropertiesOfKeysOptions

Volitelné parametry.

Návraty

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Iteruje všechny verze daného klíče v trezoru. V odpovědi jsou uvedeny úplné identifikátory klíče, vlastnosti a značky. Tato operace vyžaduje oprávnění ke klíčům nebo seznamu.

Příklad použití:

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>

Parametry

name

string

Název klíče pro načtení verzí pro

options
ListPropertiesOfKeyVersionsOptions

Volitelné parametry.

Návraty

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

Operace vymazání odstraněného klíče klíč trvale odebere, aniž by bylo možné ho obnovit. Tuto operaci je možné povolit pouze v trezoru s povoleným obnovitelném odstraněním. Tato operace vyžaduje oprávnění klíče nebo vyprázdnění.

Příklad použití:

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

Trvale odstraní zadaný klíč.

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

Parametry

name

string

Název klíče.

options
PurgeDeletedKeyOptions

Volitelné parametry.

Návraty

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

Uvolní klíč ze spravovaného HSM.

Operace vydaného klíče se vztahuje na všechny typy klíčů. Operace vyžaduje, aby byl klíč označený jako exportovatelný a oprávnění ke klíčům nebo uvolnění.

Příklad použití:

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

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

Parametry

name

string

Název klíče.

targetAttestationToken

string

Kontrolní výraz ověření identity pro cíl verze klíče.

options
ReleaseKeyOptions

Volitelné parametry.

Návraty

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Obnoví zálohovaný klíč a všechny jeho verze do trezoru. Tato operace vyžaduje oprávnění ke klíčům nebo obnovení.

Příklad použití:

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

Obnoví zálohovaný klíč do trezoru.

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

Parametry

backup

Uint8Array

Záložní objekt blob přidružený k sadě klíčů.

options
RestoreKeyBackupOptions

Volitelné parametry.

Návraty

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

Obměňuje klíč na základě zásad klíče generováním nové verze klíče. Tato operace vyžaduje oprávnění ke klíčům nebo obměně.

Příklad použití:

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

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

Parametry

name

string

Název klíče, který chcete obměňovat.

options
RotateKeyOptions

Volitelné parametry.

Návraty

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

Metoda updateKeyProperties změní zadané vlastnosti existujícího uloženého klíče. Vlastnosti, které nejsou v požadavku zadané, zůstanou beze změny. Samotnou hodnotu klíče nelze změnit. Tato operace vyžaduje oprávnění klíče nebo nastavení.

Příklad použití:

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

Aktualizace vlastnosti přidružené k zadanému klíči v daném trezoru klíčů.

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

Parametry

name

string

Název klíče.

keyVersion

string

Verze klíče.

options
UpdateKeyPropertiesOptions

Volitelné parametry.

Návraty

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

Metoda updateKeyProperties změní zadané vlastnosti nejnovější verze existujícího uloženého klíče. Vlastnosti, které nejsou v požadavku zadané, zůstanou beze změny. Samotnou hodnotu klíče nelze změnit. Tato operace vyžaduje oprávnění klíče nebo nastavení.

Příklad použití:

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

Aktualizace vlastnosti přidružené k zadanému klíči v daném trezoru klíčů.

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

Parametry

name

string

Název klíče.

options
UpdateKeyPropertiesOptions

Volitelné parametry.

Návraty

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Aktualizace zásady obměně klíče Key Vault. Tato operace vyžaduje oprávnění ke klíčům nebo aktualizacím.

Příklad použití:

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

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

Parametry

keyName

string

Název klíče.

policy
KeyRotationPolicyProperties
options
UpdateKeyRotationPolicyOptions

Volitelné parametry.

Návraty

Promise<KeyRotationPolicy>