KeyClient class

Referensi

Paket:: @azure/keyvault-keys

KeyClient menyediakan metode untuk mengelola KeyVaultKey di azure Key Vault. Klien mendukung pembuatan, pengambilan, pembaruan, penghapusan, pembersihan, pencadangan, pemulihan, dan daftar KeyVaultKeys. Klien juga mendukung daftar DeletedKey untuk Key Vault Azure yang diaktifkan penghapusan sementara.

Konstruktor

KeyClient(string, TokenCredential, KeyClientOptions)

Membuat instans KeyClient.

Contoh penggunaan:

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

Properti

vaultUrl

URL dasar ke vault

Metode

backupKey(string, BackupKeyOptions)	Meminta agar cadangan kunci yang ditentukan diunduh ke klien. Semua versi kunci akan diunduh. Operasi ini memerlukan izin kunci/cadangan. Contoh penggunaan: `let client = new KeyClient(url, credentials); let backupContents = await client.backupKey("MyKey");` Mencadangkan kunci yang ditentukan.
beginDeleteKey(string, BeginDeleteKeyOptions)	Operasi penghapusan berlaku untuk kunci apa pun yang disimpan di Azure Key Vault. Versi individual kunci tidak dapat dihapus, hanya semua versi kunci tertentu sekaligus. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga kunci dihapus. Operasi ini memerlukan izin kunci/hapus. Contoh penggunaan: `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);` Menghapus kunci dari brankas kunci tertentu.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)	Memulihkan kunci yang dihapus dalam vault yang ditentukan. Operasi ini hanya dapat dilakukan pada vault yang diaktifkan penghapusan sementara. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga kunci yang dihapus dipulihkan. Operasi ini memerlukan izin kunci/pulihkan. Contoh penggunaan: 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); Memulihkan kunci yang dihapus ke versi terbaru.
createEcKey(string, CreateEcKeyOptions)	Metode createEcKey membuat kunci kurva elips baru di Azure Key Vault. Jika kunci bernama sudah ada, Azure Key Vault membuat versi kunci baru. Ini memerlukan izin kunci/buat. Contoh penggunaan: `let client = new KeyClient(url, credentials); let result = await client.createEcKey("MyKey", { curve: "P-256" });` Membuat kunci baru, menyimpannya, lalu mengembalikan parameter dan properti utama ke klien.
createKey(string, string, CreateKeyOptions)	Operasi buat kunci dapat digunakan untuk membuat jenis kunci apa pun di Azure Key Vault. Jika kunci bernama sudah ada, Azure Key Vault membuat versi kunci baru. Ini memerlukan izin kunci/buat. Contoh penggunaan: `let client = new KeyClient(url, credentials); // Create an elliptic-curve key: let result = await client.createKey("MyKey", "EC");` Membuat kunci baru, menyimpannya, lalu mengembalikan parameter dan properti utama ke klien.
createOctKey(string, CreateOctKeyOptions)	Metode createOctKey membuat kunci OCT baru di Azure Key Vault. Jika kunci bernama sudah ada, Azure Key Vault membuat versi kunci baru. Ini memerlukan izin kunci/buat. Contoh penggunaan: `let client = new KeyClient(url, credentials); let result = await client.createOctKey("MyKey", { hsm: true });` Membuat kunci baru, menyimpannya, lalu mengembalikan parameter dan properti utama ke klien.
createRsaKey(string, CreateRsaKeyOptions)	Metode createRSAKey membuat kunci RSA baru di Azure Key Vault. Jika kunci bernama sudah ada, Azure Key Vault membuat versi kunci baru. Ini memerlukan izin kunci/buat. Contoh penggunaan: `let client = new KeyClient(url, credentials); let result = await client.createRsaKey("MyKey", { keySize: 2048 });` Membuat kunci baru, menyimpannya, lalu mengembalikan parameter dan properti utama ke klien.
getCryptographyClient(string, GetCryptographyClientOptions)	Mendapatkan CryptographyClient untuk kunci yang diberikan. Contoh penggunaan: `let client = new KeyClient(url, credentials); // get a cryptography client for a given key let cryptographyClient = client.getCryptographyClient("MyKey");`
getDeletedKey(string, GetDeletedKeyOptions)	Metode getDeletedKey mengembalikan kunci yang dihapus yang ditentukan bersama dengan propertinya. Operasi ini memerlukan izin kunci/dapatkan. Contoh penggunaan: `let client = new KeyClient(url, credentials); let key = await client.getDeletedKey("MyDeletedKey");` Mendapatkan kunci yang dihapus yang ditentukan.
getKey(string, GetKeyOptions)	Metode getKey mendapatkan kunci tertentu dan berlaku untuk kunci apa pun yang disimpan di Azure Key Vault. Operasi ini memerlukan izin kunci/dapatkan. Contoh penggunaan: `let client = new KeyClient(url, credentials); let key = await client.getKey("MyKey");` Dapatkan kunci tertentu dari brankas kunci tertentu.
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)	Mendapatkan kebijakan rotasi Kunci Key Vault. Secara default, semua kunci memiliki kebijakan yang akan memberi tahu 30 hari sebelum kedaluwarsa. Operasi ini memerlukan izin kunci/dapatkan. Contoh penggunaan: `let client = new KeyClient(vaultUrl, credentials); let result = await client.getKeyRotationPolicy("myKey");`
getRandomBytes(number, GetRandomBytesOptions)	Mendapatkan jumlah byte yang diminta yang berisi nilai acak dari HSM terkelola. Operasi ini memerlukan izin managedHsm/rng. Contoh penggunaan: `let client = new KeyClient(vaultUrl, credentials); let { bytes } = await client.getRandomBytes(10);`
importKey(string, JsonWebKey_2, ImportKeyOptions)	Operasi kunci impor dapat digunakan untuk mengimpor jenis kunci apa pun ke Key Vault Azure. Jika kunci bernama sudah ada, Azure Key Vault membuat versi kunci baru. Operasi ini memerlukan izin kunci/impor. Contoh penggunaan: `let client = new KeyClient(url, credentials); // Key contents in myKeyContents let result = await client.importKey("MyKey", myKeyContents);` Mengimpor kunci yang dibuat secara eksternal, menyimpannya, dan mengembalikan parameter dan properti utama ke klien.
listDeletedKeys(ListDeletedKeysOptions)	Melakukan iterasi kunci yang dihapus di vault. Pengidentifikasi kunci lengkap dan properti disediakan dalam respons. Tidak ada nilai yang dikembalikan untuk kunci. Operasi ini memerlukan izin kunci/daftar. Contoh penggunaan: `let client = new KeyClient(url, credentials); for await (const deletedKey of client.listDeletedKeys()) { console.log("deleted key: ", deletedKey); }` Mencantumkan semua kunci dalam vault
listPropertiesOfKeys(ListPropertiesOfKeysOptions)	Melakukan iterasi versi terbaru dari semua kunci di vault. Pengidentifikasi kunci lengkap dan properti disediakan dalam respons. Tidak ada nilai yang dikembalikan untuk kunci. Operasi ini memerlukan izin kunci/daftar. Contoh penggunaan: `let client = new KeyClient(url, credentials); for await (const keyProperties of client.listPropertiesOfKeys()) { const key = await client.getKey(keyProperties.name); console.log("key: ", key); }` Mencantumkan semua kunci dalam vault
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)	Iterasi semua versi kunci yang diberikan di vault. Pengidentifikasi kunci lengkap, properti, dan tag disediakan dalam respons. Operasi ini memerlukan izin kunci/daftar. Contoh penggunaan: `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)	Operasi hapus menyeluruh kunci yang dihapus menghapus kunci secara permanen, tanpa kemungkinan pemulihan. Operasi ini hanya dapat diaktifkan pada vault yang diaktifkan penghapusan sementara. Operasi ini memerlukan izin kunci/hapus menyeluruh. Contoh penggunaan: `const client = new KeyClient(url, credentials); const deletePoller = await client.beginDeleteKey("MyKey") await deletePoller.pollUntilDone(); await client.purgeDeletedKey("MyKey");` Menghapus kunci yang ditentukan secara permanen.
releaseKey(string, string, ReleaseKeyOptions)	Merilis kunci dari HSM terkelola. Operasi kunci rilis berlaku untuk semua jenis kunci. Operasi ini mengharuskan kunci ditandai dapat diekspor dan izin kunci/rilis. Contoh penggunaan: `let client = new KeyClient(vaultUrl, credentials); let result = await client.releaseKey("myKey", target)`
restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)	Memulihkan kunci yang dicadangkan, dan semua versinya, ke vault. Operasi ini memerlukan izin kunci/pemulihan. Contoh penggunaan: `let client = new KeyClient(url, credentials); let backupContents = await client.backupKey("MyKey"); // ... let key = await client.restoreKeyBackup(backupContents);` Memulihkan kunci yang dicadangkan ke vault.
rotateKey(string, RotateKeyOptions)	Memutar kunci berdasarkan kebijakan kunci dengan menghasilkan versi baru kunci. Operasi ini memerlukan izin kunci/putar. Contoh penggunaan: `let client = new KeyClient(vaultUrl, credentials); let key = await client.rotateKey("MyKey");`
updateKeyProperties(string, string, UpdateKeyPropertiesOptions)	Metode updateKeyProperties mengubah properti tertentu dari kunci yang disimpan yang ada. Properti yang tidak ditentukan dalam permintaan dibiarkan tidak berubah. Nilai kunci itu sendiri tidak dapat diubah. Operasi ini memerlukan izin kunci/set. Contoh penggunaan: `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 });` Updates properti yang terkait dengan kunci tertentu dalam brankas kunci tertentu.
updateKeyProperties(string, UpdateKeyPropertiesOptions)	Metode updateKeyProperties mengubah properti tertentu dari versi terbaru dari kunci tersimpan yang ada. Properti yang tidak ditentukan dalam permintaan dibiarkan tidak berubah. Nilai kunci itu sendiri tidak dapat diubah. Operasi ini memerlukan izin kunci/set. Contoh penggunaan: `let keyName = "MyKey"; let client = new KeyClient(vaultUrl, credentials); let key = await client.getKey(keyName); let result = await client.updateKeyProperties(keyName, { enabled: false });` Updates properti yang terkait dengan kunci tertentu dalam brankas kunci tertentu.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)	Updates kebijakan rotasi Kunci Key Vault. Operasi ini memerlukan izin kunci/pembaruan. Contoh penggunaan: `let client = new KeyClient(vaultUrl, credentials); const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);`

Detail Konstruktor

KeyClient(string, TokenCredential, KeyClientOptions)

Membuat instans KeyClient.

Contoh penggunaan:

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)

Parameter

vaultUrl: string

URL Key Vault. Ini harus memiliki bentuk ini: https://${your-key-vault-name}.vault.azure.net. Anda harus memvalidasi bahwa URL ini mereferensikan sumber daya Key Vault atau HSM Terkelola yang valid. Lihat https://aka.ms/azsdk/blog/vault-uri untuk detailnya.

credential: TokenCredential

Objek yang mengimplementasikan antarmuka yang TokenCredential digunakan untuk mengautentikasi permintaan ke layanan. @azure/identity Gunakan paket untuk membuat kredensial yang sesuai dengan kebutuhan Anda.

pipelineOptions: KeyClientOptions

Opsi alur yang digunakan untuk mengonfigurasi permintaan API Key Vault. Hilangkan parameter ini untuk menggunakan konfigurasi alur default.

Detail Properti

vaultUrl

URL dasar ke vault

vaultUrl: string

Nilai Properti

string

Detail Metode

backupKey(string, BackupKeyOptions)

Meminta agar cadangan kunci yang ditentukan diunduh ke klien. Semua versi kunci akan diunduh. Operasi ini memerlukan izin kunci/cadangan.

Contoh penggunaan:

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

Mencadangkan kunci yang ditentukan.

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

Parameter

name: string

Nama kunci.

options: BackupKeyOptions

Parameter opsional.

Mengembalikan

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

Operasi penghapusan berlaku untuk kunci apa pun yang disimpan di Azure Key Vault. Versi individual kunci tidak dapat dihapus, hanya semua versi kunci tertentu sekaligus.

Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga kunci dihapus.

Operasi ini memerlukan izin kunci/hapus.

Contoh penggunaan:

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

Menghapus kunci dari brankas kunci tertentu.

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

Parameter

name: string

Nama kunci.

options: BeginDeleteKeyOptions

Parameter opsional.

Mengembalikan

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

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Memulihkan kunci yang dihapus dalam vault yang ditentukan. Operasi ini hanya dapat dilakukan pada vault yang diaktifkan penghapusan sementara.

Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda menunggu tanpa batas waktu hingga kunci yang dihapus dipulihkan.

Operasi ini memerlukan izin kunci/pulihkan.

Contoh penggunaan:

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

Memulihkan kunci yang dihapus ke versi terbaru.

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

Parameter

name: string

Nama kunci yang dihapus.

options: BeginRecoverDeletedKeyOptions

Parameter opsional.

Mengembalikan

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

createEcKey(string, CreateEcKeyOptions)

Metode createEcKey membuat kunci kurva elips baru di Azure Key Vault. Jika kunci bernama sudah ada, Azure Key Vault membuat versi kunci baru. Ini memerlukan izin kunci/buat.

Contoh penggunaan:

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

Membuat kunci baru, menyimpannya, lalu mengembalikan parameter dan properti utama ke klien.

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

Parameter

name: string

Nama kunci.

options: CreateEcKeyOptions

Parameter opsional.

Mengembalikan

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

Operasi buat kunci dapat digunakan untuk membuat jenis kunci apa pun di Azure Key Vault. Jika kunci bernama sudah ada, Azure Key Vault membuat versi kunci baru. Ini memerlukan izin kunci/buat.

Contoh penggunaan:

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

Membuat kunci baru, menyimpannya, lalu mengembalikan parameter dan properti utama ke klien.

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

Parameter

name: string

Nama kunci.

keyType: string

Jenis kunci. Salah satu hal berikut: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'okt'.

options: CreateKeyOptions

Parameter opsional.

Mengembalikan

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

Metode createOctKey membuat kunci OCT baru di Azure Key Vault. Jika kunci bernama sudah ada, Azure Key Vault membuat versi kunci baru. Ini memerlukan izin kunci/buat.

Contoh penggunaan:

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

Membuat kunci baru, menyimpannya, lalu mengembalikan parameter dan properti utama ke klien.

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

Parameter

name: string

Nama kunci.

options: CreateOctKeyOptions

Parameter opsional.

Mengembalikan

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

Metode createRSAKey membuat kunci RSA baru di Azure Key Vault. Jika kunci bernama sudah ada, Azure Key Vault membuat versi kunci baru. Ini memerlukan izin kunci/buat.

Contoh penggunaan:

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

Membuat kunci baru, menyimpannya, lalu mengembalikan parameter dan properti utama ke klien.

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

Parameter

name: string

Nama kunci.

options: CreateRsaKeyOptions

Parameter opsional.

Mengembalikan

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

Mendapatkan CryptographyClient untuk kunci yang diberikan.

Contoh penggunaan:

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

Parameter

keyName: string

options: GetCryptographyClientOptions

Mengembalikan

CryptographyClient

CryptographyClient menggunakan opsi, kredensial, dan klien http yang sama dengan KeyClient ini

getDeletedKey(string, GetDeletedKeyOptions)

Metode getDeletedKey mengembalikan kunci yang dihapus yang ditentukan bersama dengan propertinya. Operasi ini memerlukan izin kunci/dapatkan.

Contoh penggunaan:

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

Mendapatkan kunci yang dihapus yang ditentukan.

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

Parameter

name: string

Nama kunci.

options: GetDeletedKeyOptions

Parameter opsional.

Mengembalikan

Promise<DeletedKey>

getKey(string, GetKeyOptions)

Metode getKey mendapatkan kunci tertentu dan berlaku untuk kunci apa pun yang disimpan di Azure Key Vault. Operasi ini memerlukan izin kunci/dapatkan.

Contoh penggunaan:

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

Dapatkan kunci tertentu dari brankas kunci tertentu.

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

Parameter

name: string

Nama kunci.

options: GetKeyOptions

Parameter opsional.

Mengembalikan

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Mendapatkan kebijakan rotasi Kunci Key Vault. Secara default, semua kunci memiliki kebijakan yang akan memberi tahu 30 hari sebelum kedaluwarsa.

Operasi ini memerlukan izin kunci/dapatkan. Contoh penggunaan:

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

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

Parameter

keyName: string

Nama kunci.

options: GetKeyRotationPolicyOptions

Parameter opsional.

Mengembalikan

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

Mendapatkan jumlah byte yang diminta yang berisi nilai acak dari HSM terkelola. Operasi ini memerlukan izin managedHsm/rng.

Contoh penggunaan:

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

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

Parameter

count: number

Jumlah byte yang dihasilkan antara 1 dan 128 inklusif.

options: GetRandomBytesOptions

Parameter opsional.

Mengembalikan

Promise<Uint8Array>

importKey(string, JsonWebKey_2, ImportKeyOptions)

Operasi kunci impor dapat digunakan untuk mengimpor jenis kunci apa pun ke Key Vault Azure. Jika kunci bernama sudah ada, Azure Key Vault membuat versi kunci baru. Operasi ini memerlukan izin kunci/impor.

Contoh penggunaan:

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

Mengimpor kunci yang dibuat secara eksternal, menyimpannya, dan mengembalikan parameter dan properti utama ke klien.

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

Parameter

name: string

Nama untuk kunci yang diimpor.

key: JsonWebKey

Kunci web JSON.

options: ImportKeyOptions

Parameter opsional.

Mengembalikan

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

Melakukan iterasi kunci yang dihapus di vault. Pengidentifikasi kunci lengkap dan properti disediakan dalam respons. Tidak ada nilai yang dikembalikan untuk kunci. Operasi ini memerlukan izin kunci/daftar.

Contoh penggunaan:

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

Mencantumkan semua kunci dalam vault

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

Parameter

options: ListDeletedKeysOptions

Parameter opsional.

Mengembalikan

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

Melakukan iterasi versi terbaru dari semua kunci di vault. Pengidentifikasi kunci lengkap dan properti disediakan dalam respons. Tidak ada nilai yang dikembalikan untuk kunci. Operasi ini memerlukan izin kunci/daftar.

Contoh penggunaan:

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

Mencantumkan semua kunci dalam vault

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

Parameter

options: ListPropertiesOfKeysOptions

Parameter opsional.

Mengembalikan

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

Iterasi semua versi kunci yang diberikan di vault. Pengidentifikasi kunci lengkap, properti, dan tag disediakan dalam respons. Operasi ini memerlukan izin kunci/daftar.

Contoh penggunaan:

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>

Parameter

name: string

Nama kunci untuk mengambil versi untuk

options: ListPropertiesOfKeyVersionsOptions

Parameter opsional.

Mengembalikan

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

Operasi hapus menyeluruh kunci yang dihapus menghapus kunci secara permanen, tanpa kemungkinan pemulihan. Operasi ini hanya dapat diaktifkan pada vault yang diaktifkan penghapusan sementara. Operasi ini memerlukan izin kunci/hapus menyeluruh.

Contoh penggunaan:

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

Menghapus kunci yang ditentukan secara permanen.

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

Parameter

name: string

Nama kunci.

options: PurgeDeletedKeyOptions

Parameter opsional.

Mengembalikan

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

Merilis kunci dari HSM terkelola.

Operasi kunci rilis berlaku untuk semua jenis kunci. Operasi ini mengharuskan kunci ditandai dapat diekspor dan izin kunci/rilis.

Contoh penggunaan:

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

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

Parameter

name: string

Nama kunci.

targetAttestationToken: string

Pernyataan pengesahan untuk target rilis kunci.

options: ReleaseKeyOptions

Parameter opsional.

Mengembalikan

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

Memulihkan kunci yang dicadangkan, dan semua versinya, ke vault. Operasi ini memerlukan izin kunci/pemulihan.

Contoh penggunaan:

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

Memulihkan kunci yang dicadangkan ke vault.

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

Parameter

backup: Uint8Array

Blob cadangan yang terkait dengan bundel kunci.

options: RestoreKeyBackupOptions

Parameter opsional.

Mengembalikan

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

Memutar kunci berdasarkan kebijakan kunci dengan menghasilkan versi baru kunci. Operasi ini memerlukan izin kunci/putar.

Contoh penggunaan:

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

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

Parameter

name: string

Nama kunci yang akan diputar.

options: RotateKeyOptions

Parameter opsional.

Mengembalikan

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

Metode updateKeyProperties mengubah properti tertentu dari kunci yang disimpan yang ada. Properti yang tidak ditentukan dalam permintaan dibiarkan tidak berubah. Nilai kunci itu sendiri tidak dapat diubah. Operasi ini memerlukan izin kunci/set.

Contoh penggunaan:

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

Updates properti yang terkait dengan kunci tertentu dalam brankas kunci tertentu.

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

Parameter

name: string

Nama kunci.

keyVersion: string

Versi kunci.

options: UpdateKeyPropertiesOptions

Parameter opsional.

Mengembalikan

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

Metode updateKeyProperties mengubah properti tertentu dari versi terbaru dari kunci tersimpan yang ada. Properti yang tidak ditentukan dalam permintaan dibiarkan tidak berubah. Nilai kunci itu sendiri tidak dapat diubah. Operasi ini memerlukan izin kunci/set.

Contoh penggunaan:

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

Updates properti yang terkait dengan kunci tertentu dalam brankas kunci tertentu.

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

Parameter

name: string

Nama kunci.

options: UpdateKeyPropertiesOptions

Parameter opsional.

Mengembalikan

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Updates kebijakan rotasi Kunci Key Vault. Operasi ini memerlukan izin kunci/pembaruan.

Contoh penggunaan:

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

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

Parameter

keyName: string

Nama kunci.

policy: KeyRotationPolicyProperties

options: UpdateKeyRotationPolicyOptions

Parameter opsional.

Mengembalikan

Promise<KeyRotationPolicy>