Udostępnij za pośrednictwem

KeyClient class

  • Odwołanie
Pakiet:
@azure/keyvault-keys

Obiekt KeyClient udostępnia metody zarządzania KeyVaultKey w usłudze Azure Key Vault. Klient obsługuje tworzenie, pobieranie, aktualizowanie, usuwanie, przeczyszczanie, tworzenie kopii zapasowej, przywracanie i wyświetlanie listy kluczy KeyVaultKeys. Klient obsługuje również wyświetlanie listy DeletedKey dla usługi Azure Key Vault z włączoną obsługą usuwania nietrwałego.

Konstruktory

KeyClient(string, TokenCredential, KeyClientOptions)

Tworzy wystąpienie klasy KeyClient.

Przykładowe użycie:

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

Właściwości

vaultUrl

Podstawowy adres URL magazynu

Metody

backupKey(string, BackupKeyOptions)

Żąda, aby kopia zapasowa określonego klucza została pobrana do klienta. Wszystkie wersje klucza zostaną pobrane. Ta operacja wymaga uprawnień kluczy/kopii zapasowej.

Przykładowe użycie:

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

Wykonuje kopię zapasową określonego klucza.
beginDeleteKey(string, BeginDeleteKeyOptions)

Operacja usuwania ma zastosowanie do dowolnego klucza przechowywanego w usłudze Azure Key Vault. Nie można usunąć poszczególnych wersji klucza, tylko wszystkie wersje danego klucza jednocześnie.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do momentu usunięcia klucza.

Ta operacja wymaga uprawnień kluczy/usuwania.

Przykładowe użycie:

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

Usuwa klucz z określonego magazynu kluczy.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Odzyskuje usunięty klucz w określonym magazynie. Tę operację można wykonać tylko w magazynie z włączoną obsługą usuwania nietrwałego.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do odzyskania usuniętego klucza.

Ta operacja wymaga uprawnień kluczy/odzyskiwania.

Przykładowe użycie:

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

Odzyskuje usunięty klucz do najnowszej wersji.
createEcKey(string, CreateEcKeyOptions)

Metoda createEcKey tworzy nowy klucz krzywej eliptycznej w usłudze Azure Key Vault. Jeśli nazwany klucz już istnieje, usługa Azure Key Vault tworzy nową wersję klucza. Wymaga uprawnień do tworzenia/kluczy.

Przykładowe użycie:

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

Tworzy nowy klucz, przechowuje go, a następnie zwraca kluczowe parametry i właściwości do klienta.
createKey(string, string, CreateKeyOptions)

Operacja tworzenia klucza może służyć do tworzenia dowolnego typu klucza w usłudze Azure Key Vault. Jeśli nazwany klucz już istnieje, usługa Azure Key Vault tworzy nową wersję klucza. Wymaga uprawnień do tworzenia/kluczy.

Przykładowe użycie:

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

Tworzy nowy klucz, przechowuje go, a następnie zwraca kluczowe parametry i właściwości do klienta.
createOctKey(string, CreateOctKeyOptions)

Metoda createOctKey tworzy nowy klucz OCT w usłudze Azure Key Vault. Jeśli nazwany klucz już istnieje, usługa Azure Key Vault tworzy nową wersję klucza. Wymaga uprawnień do tworzenia/kluczy.

Przykładowe użycie:

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

Tworzy nowy klucz, przechowuje go, a następnie zwraca kluczowe parametry i właściwości do klienta.
createRsaKey(string, CreateRsaKeyOptions)

Metoda createRSAKey tworzy nowy klucz RSA w usłudze Azure Key Vault. Jeśli nazwany klucz już istnieje, usługa Azure Key Vault tworzy nową wersję klucza. Wymaga uprawnień do tworzenia/kluczy.

Przykładowe użycie:

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

Tworzy nowy klucz, przechowuje go, a następnie zwraca kluczowe parametry i właściwości do klienta.
getCryptographyClient(string, GetCryptographyClientOptions)

Pobiera CryptographyClient dla danego klucza.

Przykładowe użycie:

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

Metoda getDeletedKey zwraca określony usunięty klucz wraz z jego właściwościami. Ta operacja wymaga uprawnień kluczy/uzyskiwania.

Przykładowe użycie:

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

Pobiera określony usunięty klucz.
getKey(string, GetKeyOptions)

Metoda getKey pobiera określony klucz i ma zastosowanie do dowolnego klucza przechowywanego w usłudze Azure Key Vault. Ta operacja wymaga uprawnień kluczy/uzyskiwania.

Przykładowe użycie:

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

Pobierz określony klucz z danego magazynu kluczy.
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Pobiera zasady rotacji klucza usługi Key Vault. Domyślnie wszystkie klucze mają zasady, które będą powiadamiać 30 dni przed wygaśnięciem.

Ta operacja wymaga uprawnień kluczy/uzyskiwania. Przykładowe użycie:

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

Pobiera żądaną liczbę bajtów zawierających wartości losowe z zarządzanego modułu HSM. Ta operacja wymaga uprawnienia managedHsm/rng.

Przykładowe użycie:

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

Operacja importowania klucza może służyć do importowania dowolnego typu klucza do usługi Azure Key Vault. Jeśli nazwany klucz już istnieje, usługa Azure Key Vault tworzy nową wersję klucza. Ta operacja wymaga uprawnień kluczy/importu.

Przykładowe użycie:

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

Importuje zewnętrznie utworzony klucz, przechowuje go i zwraca kluczowe parametry i właściwości do klienta.
listDeletedKeys(ListDeletedKeysOptions)

Iteruje usunięte klucze w magazynie. Pełny identyfikator klucza i właściwości są podane w odpowiedzi. Nie są zwracane żadne wartości dla kluczy. Te operacje wymagają uprawnień kluczy/listy.

Przykładowe użycie:

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

Wyświetlanie listy wszystkich kluczy w magazynie
listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Iteruje najnowszą wersję wszystkich kluczy w magazynie. Pełny identyfikator klucza i właściwości są podane w odpowiedzi. Nie są zwracane żadne wartości dla kluczy. Te operacje wymagają uprawnień kluczy/listy.

Przykładowe użycie:

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

Wyświetlanie listy wszystkich kluczy w magazynie
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Iteruje wszystkie wersje danego klucza w magazynie. Pełny identyfikator klucza, właściwości i tagi są podane w odpowiedzi. Ta operacja wymaga uprawnień kluczy/listy.

Przykładowe użycie:

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)

Operacja przeczyszczania usuniętego klucza powoduje trwałe usunięcie klucza bez możliwości odzyskiwania. Tę operację można włączyć tylko w magazynie z włączoną obsługą usuwania nietrwałego. Ta operacja wymaga uprawnień kluczy/przeczyszczania.

Przykładowe użycie:

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

Trwale usuwa określony klucz.
releaseKey(string, string, ReleaseKeyOptions)

Zwalnia klucz z zarządzanego modułu HSM.

Operacja klucza wydania ma zastosowanie do wszystkich typów kluczy. Operacja wymaga, aby klucz został oznaczony jako możliwy do wyeksportowania oraz uprawnienia kluczy/wydania.

Przykładowe użycie:

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

Przywraca klucz kopii zapasowej i wszystkie jego wersje do magazynu. Ta operacja wymaga uprawnień kluczy/przywracania.

Przykładowe użycie:

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

Przywraca kopię zapasową klucza do magazynu.
rotateKey(string, RotateKeyOptions)

Obraca klucz na podstawie zasad klucza, generując nową wersję klucza. Ta operacja wymaga uprawnień kluczy/rotacji.

Przykładowe użycie:

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

Metoda updateKeyProperties zmienia określone właściwości istniejącego klucza przechowywanego. Właściwości, które nie zostały określone w żądaniu, pozostają niezmienione. Nie można zmienić wartości samego klucza. Ta operacja wymaga uprawnień kluczy/zestawu.

Przykładowe użycie:

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

Aktualizuje właściwości skojarzone z określonym kluczem w danym magazynie kluczy.
updateKeyProperties(string, UpdateKeyPropertiesOptions)

Metoda updateKeyProperties zmienia określone właściwości najnowszej wersji istniejącego klucza przechowywanego. Właściwości, które nie zostały określone w żądaniu, pozostają niezmienione. Nie można zmienić wartości samego klucza. Ta operacja wymaga uprawnień kluczy/zestawu.

Przykładowe użycie:

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

Aktualizuje właściwości skojarzone z określonym kluczem w danym magazynie kluczy.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Aktualizuje zasady rotacji klucza usługi Key Vault. Ta operacja wymaga uprawnień kluczy/aktualizacji.

Przykładowe użycie:

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

Szczegóły konstruktora

KeyClient(string, TokenCredential, KeyClientOptions)

Tworzy wystąpienie klasy KeyClient.

Przykładowe użycie:

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

adres URL usługi Key Vault. Powinien mieć ten kształt: https://${your-key-vault-name}.vault.azure.net. Należy sprawdzić, czy ten adres URL odwołuje się do prawidłowego zasobu usługi Key Vault lub zarządzanego modułu HSM. Aby uzyskać szczegółowe informacje, zobacz https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Obiekt, który implementuje interfejs TokenCredential używany do uwierzytelniania żądań w usłudze. Użyj pakietu @azure/identity, aby utworzyć poświadczenia odpowiadające Twoim potrzebom.

pipelineOptions
KeyClientOptions

Opcje potoku używane do konfigurowania żądań interfejsu API usługi Key Vault. Pomiń ten parametr, aby użyć domyślnej konfiguracji potoku.

Szczegóły właściwości

vaultUrl

Podstawowy adres URL magazynu

vaultUrl: string

Wartość właściwości

string

Szczegóły metody

backupKey(string, BackupKeyOptions)

Żąda, aby kopia zapasowa określonego klucza została pobrana do klienta. Wszystkie wersje klucza zostaną pobrane. Ta operacja wymaga uprawnień kluczy/kopii zapasowej.

Przykładowe użycie:

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

Wykonuje kopię zapasową określonego klucza.

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

Parametry

name

string

Nazwa klucza.

options
BackupKeyOptions

Parametry opcjonalne.

Zwraca

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

Operacja usuwania ma zastosowanie do dowolnego klucza przechowywanego w usłudze Azure Key Vault. Nie można usunąć poszczególnych wersji klucza, tylko wszystkie wersje danego klucza jednocześnie.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do momentu usunięcia klucza.

Ta operacja wymaga uprawnień kluczy/usuwania.

Przykładowe użycie:

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

Usuwa klucz z określonego magazynu kluczy.

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

Parametry

name

string

Nazwa klucza.

options
BeginDeleteKeyOptions

Parametry opcjonalne.

Zwraca

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

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Odzyskuje usunięty klucz w określonym magazynie. Tę operację można wykonać tylko w magazynie z włączoną obsługą usuwania nietrwałego.

Ta funkcja zwraca operację długotrwałą, która umożliwia oczekiwanie na czas nieokreślony do odzyskania usuniętego klucza.

Ta operacja wymaga uprawnień kluczy/odzyskiwania.

Przykładowe użycie:

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

Odzyskuje usunięty klucz do najnowszej wersji.

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

Parametry

name

string

Nazwa usuniętego klucza.

options
BeginRecoverDeletedKeyOptions

Parametry opcjonalne.

Zwraca

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

createEcKey(string, CreateEcKeyOptions)

Metoda createEcKey tworzy nowy klucz krzywej eliptycznej w usłudze Azure Key Vault. Jeśli nazwany klucz już istnieje, usługa Azure Key Vault tworzy nową wersję klucza. Wymaga uprawnień do tworzenia/kluczy.

Przykładowe użycie:

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

Tworzy nowy klucz, przechowuje go, a następnie zwraca kluczowe parametry i właściwości do klienta.

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

Parametry

name

string

Nazwa klucza.

options
CreateEcKeyOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

Operacja tworzenia klucza może służyć do tworzenia dowolnego typu klucza w usłudze Azure Key Vault. Jeśli nazwany klucz już istnieje, usługa Azure Key Vault tworzy nową wersję klucza. Wymaga uprawnień do tworzenia/kluczy.

Przykładowe użycie:

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

Tworzy nowy klucz, przechowuje go, a następnie zwraca kluczowe parametry i właściwości do klienta.

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

Parametry

name

string

Nazwa klucza.

keyType

string

Typ klucza. Jeden z następujących elementów: "EC", "EC-HSM", "RSA", "RSA-HSM", "oct".

options
CreateKeyOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

Metoda createOctKey tworzy nowy klucz OCT w usłudze Azure Key Vault. Jeśli nazwany klucz już istnieje, usługa Azure Key Vault tworzy nową wersję klucza. Wymaga uprawnień do tworzenia/kluczy.

Przykładowe użycie:

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

Tworzy nowy klucz, przechowuje go, a następnie zwraca kluczowe parametry i właściwości do klienta.

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

Parametry

name

string

Nazwa klucza.

options
CreateOctKeyOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

Metoda createRSAKey tworzy nowy klucz RSA w usłudze Azure Key Vault. Jeśli nazwany klucz już istnieje, usługa Azure Key Vault tworzy nową wersję klucza. Wymaga uprawnień do tworzenia/kluczy.

Przykładowe użycie:

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

Tworzy nowy klucz, przechowuje go, a następnie zwraca kluczowe parametry i właściwości do klienta.

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

Parametry

name

string

Nazwa klucza.

options
CreateRsaKeyOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

Pobiera CryptographyClient dla danego klucza.

Przykładowe użycie:

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

Zwraca

CryptographyClient

getDeletedKey(string, GetDeletedKeyOptions)

Metoda getDeletedKey zwraca określony usunięty klucz wraz z jego właściwościami. Ta operacja wymaga uprawnień kluczy/uzyskiwania.

Przykładowe użycie:

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

Pobiera określony usunięty klucz.

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

Parametry

name

string

Nazwa klucza.

options
GetDeletedKeyOptions

Parametry opcjonalne.

Zwraca

Promise<DeletedKey>

getKey(string, GetKeyOptions)

Metoda getKey pobiera określony klucz i ma zastosowanie do dowolnego klucza przechowywanego w usłudze Azure Key Vault. Ta operacja wymaga uprawnień kluczy/uzyskiwania.

Przykładowe użycie:

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

Pobierz określony klucz z danego magazynu kluczy.

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

Parametry

name

string

Nazwa klucza.

options
GetKeyOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Pobiera zasady rotacji klucza usługi Key Vault. Domyślnie wszystkie klucze mają zasady, które będą powiadamiać 30 dni przed wygaśnięciem.

Ta operacja wymaga uprawnień kluczy/uzyskiwania. Przykładowe użycie:

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

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

Parametry

keyName

string

Nazwa klucza.

options
GetKeyRotationPolicyOptions

Parametry opcjonalne.

Zwraca

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

Pobiera żądaną liczbę bajtów zawierających wartości losowe z zarządzanego modułu HSM. Ta operacja wymaga uprawnienia managedHsm/rng.

Przykładowe użycie:

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

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

Parametry

count

number

Liczba bajtów do wygenerowania z przedziału od 1 do 128 włącznie.

options
GetRandomBytesOptions

Parametry opcjonalne.

Zwraca

Promise<Uint8Array>

importKey(string, JsonWebKey, ImportKeyOptions)

Operacja importowania klucza może służyć do importowania dowolnego typu klucza do usługi Azure Key Vault. Jeśli nazwany klucz już istnieje, usługa Azure Key Vault tworzy nową wersję klucza. Ta operacja wymaga uprawnień kluczy/importu.

Przykładowe użycie:

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

Importuje zewnętrznie utworzony klucz, przechowuje go i zwraca kluczowe parametry i właściwości do klienta.

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

Parametry

name

string

Nazwa zaimportowanych kluczy.

key
JsonWebKey

Klucz internetowy JSON.

options
ImportKeyOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

Iteruje usunięte klucze w magazynie. Pełny identyfikator klucza i właściwości są podane w odpowiedzi. Nie są zwracane żadne wartości dla kluczy. Te operacje wymagają uprawnień kluczy/listy.

Przykładowe użycie:

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

Wyświetlanie listy wszystkich kluczy w magazynie

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

Parametry

options
ListDeletedKeysOptions

Parametry opcjonalne.

Zwraca

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Iteruje najnowszą wersję wszystkich kluczy w magazynie. Pełny identyfikator klucza i właściwości są podane w odpowiedzi. Nie są zwracane żadne wartości dla kluczy. Te operacje wymagają uprawnień kluczy/listy.

Przykładowe użycie:

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

Wyświetlanie listy wszystkich kluczy w magazynie

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

Parametry

options
ListPropertiesOfKeysOptions

Parametry opcjonalne.

Zwraca

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Iteruje wszystkie wersje danego klucza w magazynie. Pełny identyfikator klucza, właściwości i tagi są podane w odpowiedzi. Ta operacja wymaga uprawnień kluczy/listy.

Przykładowe użycie:

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

Nazwa klucza do pobierania wersji dla

options
ListPropertiesOfKeyVersionsOptions

Parametry opcjonalne.

Zwraca

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

Operacja przeczyszczania usuniętego klucza powoduje trwałe usunięcie klucza bez możliwości odzyskiwania. Tę operację można włączyć tylko w magazynie z włączoną obsługą usuwania nietrwałego. Ta operacja wymaga uprawnień kluczy/przeczyszczania.

Przykładowe użycie:

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

Trwale usuwa określony klucz.

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

Parametry

name

string

Nazwa klucza.

options
PurgeDeletedKeyOptions

Parametry opcjonalne.

Zwraca

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

Zwalnia klucz z zarządzanego modułu HSM.

Operacja klucza wydania ma zastosowanie do wszystkich typów kluczy. Operacja wymaga, aby klucz został oznaczony jako możliwy do wyeksportowania oraz uprawnienia kluczy/wydania.

Przykładowe użycie:

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

Nazwa klucza.

targetAttestationToken

string

Asercji zaświadczania dla celu wydania klucza.

options
ReleaseKeyOptions

Parametry opcjonalne.

Zwraca

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Przywraca klucz kopii zapasowej i wszystkie jego wersje do magazynu. Ta operacja wymaga uprawnień kluczy/przywracania.

Przykładowe użycie:

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

Przywraca kopię zapasową klucza do magazynu.

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

Parametry

backup

Uint8Array

Obiekt blob kopii zapasowej skojarzony z pakietem kluczy.

options
RestoreKeyBackupOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

Obraca klucz na podstawie zasad klucza, generując nową wersję klucza. Ta operacja wymaga uprawnień kluczy/rotacji.

Przykładowe użycie:

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

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

Parametry

name

string

Nazwa klucza do rotacji.

options
RotateKeyOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

Metoda updateKeyProperties zmienia określone właściwości istniejącego klucza przechowywanego. Właściwości, które nie zostały określone w żądaniu, pozostają niezmienione. Nie można zmienić wartości samego klucza. Ta operacja wymaga uprawnień kluczy/zestawu.

Przykładowe użycie:

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

Aktualizuje właściwości skojarzone z określonym kluczem w danym magazynie kluczy.

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

Parametry

name

string

Nazwa klucza.

keyVersion

string

Wersja klucza.

options
UpdateKeyPropertiesOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

Metoda updateKeyProperties zmienia określone właściwości najnowszej wersji istniejącego klucza przechowywanego. Właściwości, które nie zostały określone w żądaniu, pozostają niezmienione. Nie można zmienić wartości samego klucza. Ta operacja wymaga uprawnień kluczy/zestawu.

Przykładowe użycie:

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

Aktualizuje właściwości skojarzone z określonym kluczem w danym magazynie kluczy.

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

Parametry

name

string

Nazwa klucza.

options
UpdateKeyPropertiesOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Aktualizuje zasady rotacji klucza usługi Key Vault. Ta operacja wymaga uprawnień kluczy/aktualizacji.

Przykładowe użycie:

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

Nazwa klucza.

policy
KeyRotationPolicyProperties
options
UpdateKeyRotationPolicyOptions

Parametry opcjonalne.

Zwraca

Promise<KeyRotationPolicy>