KeyClient class

套件:

@azure/keyvault-keys

KeyClient 提供在 Azure 金鑰保存庫中管理KeyVaultKey的方法。 用戶端支援建立、擷取、更新、刪除、清除、備份、還原及列出 KeyVaultKeys。 用戶端也支援列出已啟用虛刪除的 Azure 金鑰保存庫DeletedKey。

建構函式

KeyClient(string, TokenCredential, KeyClientOptions)

建立 KeyClient 的實例。 使用方式範例： 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);

屬性

vaultUrl

保存庫的基底 URL

方法

backupKey(string, BackupKeyOptions)	要求將指定金鑰的備份下載至用戶端。 將會下載所有版本的金鑰。 這項作業需要金鑰/備份許可權。 使用方式範例： let client = new KeyClient(url, credentials); let backupContents = await client.backupKey("MyKey"); 備份指定的索引鍵。
beginDeleteKey(string, BeginDeleteKeyOptions)	刪除作業適用于儲存在 Azure 金鑰保存庫 中的任何金鑰。 無法刪除個別版本的金鑰，一次只能刪除指定金鑰的所有版本。 此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候，直到刪除金鑰為止。 此作業需要金鑰/刪除權限。 使用方式範例： 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); 從指定的金鑰保存庫刪除金鑰。
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)	復原指定保存庫中已刪除的金鑰。 此作業只能在已啟用虛刪除的保存庫上執行。 此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候，直到復原已刪除的金鑰為止。 這項作業需要金鑰/復原許可權。 使用方式範例： 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); 將已刪除的金鑰復原至最新版本。
createEcKey(string, CreateEcKeyOptions)	createEcKey 方法會在 Azure 金鑰保存庫中建立新的橢圓曲線索引鍵。 如果指定的金鑰已存在，Azure 金鑰保存庫會建立該金鑰的新版本。 它需要金鑰/建立許可權。 使用方式範例： let client = new KeyClient(url, credentials); let result = await client.createEcKey("MyKey", { curve: "P-256" }); 建立新的金鑰、儲存金鑰，然後將金鑰參數和屬性傳回給用戶端。
createKey(string, string, CreateKeyOptions)	建立金鑰作業可用來在 Azure 金鑰保存庫中建立任何金鑰類型。 如果指定的金鑰已存在，Azure 金鑰保存庫會建立該金鑰的新版本。 它需要金鑰/建立許可權。 使用方式範例： let client = new KeyClient(url, credentials); // Create an elliptic-curve key: let result = await client.createKey("MyKey", "EC"); 建立新的金鑰、儲存金鑰，然後將金鑰參數和屬性傳回給用戶端。
createOctKey(string, CreateOctKeyOptions)	createOctKey 方法會在 Azure 金鑰保存庫中建立新的 OCT 金鑰。 如果指定的金鑰已存在，Azure 金鑰保存庫會建立該金鑰的新版本。 它需要金鑰/建立許可權。 使用方式範例： let client = new KeyClient(url, credentials); let result = await client.createOctKey("MyKey", { hsm: true }); 建立新的金鑰、儲存金鑰，然後將金鑰參數和屬性傳回給用戶端。
createRsaKey(string, CreateRsaKeyOptions)	createRSAKey 方法會在 Azure 金鑰保存庫中建立新的 RSA 金鑰。 如果指定的金鑰已存在，Azure 金鑰保存庫會建立該金鑰的新版本。 它需要金鑰/建立許可權。 使用方式範例： let client = new KeyClient(url, credentials); let result = await client.createRsaKey("MyKey", { keySize: 2048 }); 建立新的金鑰、儲存金鑰，然後將金鑰參數和屬性傳回給用戶端。
getCryptographyClient(string, GetCryptographyClientOptions)	取得指定金鑰的 CryptographyClient 。 使用方式範例： let client = new KeyClient(url, credentials); // get a cryptography client for a given key let cryptographyClient = client.getCryptographyClient("MyKey");
getDeletedKey(string, GetDeletedKeyOptions)	getDeletedKey 方法會傳回指定的已刪除索引鍵及其屬性。 這項作業需要金鑰/取得許可權。 使用方式範例： let client = new KeyClient(url, credentials); let key = await client.getDeletedKey("MyDeletedKey"); 取得指定的已刪除索引鍵。
getKey(string, GetKeyOptions)	getKey 方法會取得指定的金鑰，並適用于儲存在 Azure 金鑰保存庫中的任何金鑰。 這項作業需要金鑰/取得許可權。 使用方式範例： let client = new KeyClient(url, credentials); let key = await client.getKey("MyKey"); 從指定的金鑰保存庫取得指定的金鑰。
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)	取得金鑰保存庫金鑰的輪替原則。 根據預設，所有金鑰都有原則會在到期前 30 天通知。 此作業需要金鑰/取得許可權。 使用方式範例： let client = new KeyClient(vaultUrl, credentials); let result = await client.getKeyRotationPolicy("myKey");
getRandomBytes(number, GetRandomBytesOptions)	取得要求的位元組數目，其中包含來自 Managed HSM 的隨機值。 此作業需要 managedHsm/rng 許可權。 使用方式範例： let client = new KeyClient(vaultUrl, credentials); let { bytes } = await client.getRandomBytes(10);
importKey(string, JsonWebKey_2, ImportKeyOptions)	匯入金鑰作業可用來將任何金鑰類型匯入 Azure 金鑰保存庫。 如果指定的金鑰已存在，Azure 金鑰保存庫會建立該金鑰的新版本。 此作業需要金鑰/匯入許可權。 使用方式範例： let client = new KeyClient(url, credentials); // Key contents in myKeyContents let result = await client.importKey("MyKey", myKeyContents); 匯入外部建立的金鑰、儲存金鑰，並將金鑰參數和屬性傳回給用戶端。
listDeletedKeys(ListDeletedKeysOptions)	逐一查看保存庫中已刪除的金鑰。 回應中會提供完整的金鑰識別碼和屬性。 索引鍵不會傳回任何值。 此作業需要金鑰/清單許可權。 使用方式範例： let client = new KeyClient(url, credentials); for await (const deletedKey of client.listDeletedKeys()) { console.log("deleted key: ", deletedKey); } 列出保存庫中的所有金鑰
listPropertiesOfKeys(ListPropertiesOfKeysOptions)	逐一查看保存庫中所有金鑰的最新版本。 回應中會提供完整的金鑰識別碼和屬性。 索引鍵不會傳回任何值。 此作業需要金鑰/清單許可權。 使用方式範例： let client = new KeyClient(url, credentials); for await (const keyProperties of client.listPropertiesOfKeys()) { const key = await client.getKey(keyProperties.name); console.log("key: ", key); } 列出保存庫中的所有金鑰
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)	逐一查看保存庫中指定金鑰的所有版本。 回應中會提供完整的金鑰識別碼、屬性和標記。 此作業需要金鑰/清單許可權。 使用方式範例： 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)	清除刪除的金鑰作業會永久移除金鑰，而不會有復原的可能性。 此作業只能在已啟用虛刪除的保存庫上啟用。 此作業需要金鑰/清除許可權。 使用方式範例： const client = new KeyClient(url, credentials); const deletePoller = await client.beginDeleteKey("MyKey") await deletePoller.pollUntilDone(); await client.purgeDeletedKey("MyKey"); 永久刪除指定的索引鍵。
releaseKey(string, string, ReleaseKeyOptions)	從受控 HSM 釋放金鑰。 發行金鑰作業適用于所有金鑰類型。 此作業需要將金鑰標示為可匯出，以及金鑰/發行許可權。 使用方式範例： let client = new KeyClient(vaultUrl, credentials); let result = await client.releaseKey("myKey", target)
restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)	將備份的金鑰及其所有版本還原至保存庫。 此作業需要金鑰/還原許可權。 使用方式範例： let client = new KeyClient(url, credentials); let backupContents = await client.backupKey("MyKey"); // ... let key = await client.restoreKeyBackup(backupContents); 將備份的金鑰還原至保存庫。
rotateKey(string, RotateKeyOptions)	藉由產生新版本的金鑰，根據金鑰原則輪替金鑰。 此作業需要金鑰/輪替許可權。 使用方式範例： let client = new KeyClient(vaultUrl, credentials); let key = await client.rotateKey("MyKey");
updateKeyProperties(string, string, UpdateKeyPropertiesOptions)	updateKeyProperties 方法會變更現有預存索引鍵的指定屬性。 要求中未指定的屬性會保持不變。 無法變更索引鍵本身的值。 此作業需要金鑰/設定許可權。 使用方式範例： 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 }); 更新與指定金鑰保存庫中指定金鑰相關聯的屬性。
updateKeyProperties(string, UpdateKeyPropertiesOptions)	updateKeyProperties 方法會變更現有預存金鑰最新版本的指定屬性。 要求中未指定的屬性會保持不變。 無法變更索引鍵本身的值。 此作業需要金鑰/設定許可權。 使用方式範例： let keyName = "MyKey"; let client = new KeyClient(vaultUrl, credentials); let key = await client.getKey(keyName); let result = await client.updateKeyProperties(keyName, { enabled: false }); 更新與指定金鑰保存庫中指定金鑰相關聯的屬性。
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)	更新金鑰保存庫金鑰的輪替原則。 此作業需要金鑰/更新許可權。 使用方式範例： let client = new KeyClient(vaultUrl, credentials); const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);

建構函式詳細資料

KeyClient(string, TokenCredential, KeyClientOptions)

建立 KeyClient 的實例。

使用方式範例：

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)

參數

vaultUrl

string

金鑰保存庫的 URL。 它應該有這個圖形： https://${your-key-vault-name}.vault.azure.net 。 您應該驗證此 URL 是否參考有效的金鑰保存庫或受控 HSM 資源。 如需詳細資訊，請參閱＜https://aka.ms/azsdk/blog/vault-uri＞。

credential

TokenCredential

物件，實作 TokenCredential 介面，用來驗證對服務的要求。 @azure/identity使用套件來建立符合您需求的認證。

pipelineOptions

KeyClientOptions

用來設定金鑰保存庫 API 要求的管線選項。 省略此參數以使用預設管線組態。

屬性詳細資料

vaultUrl

保存庫的基底 URL

vaultUrl: string

屬性值

string

方法詳細資料

backupKey(string, BackupKeyOptions)

要求將指定金鑰的備份下載至用戶端。 將會下載所有版本的金鑰。 這項作業需要金鑰/備份許可權。

使用方式範例：

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

備份指定的索引鍵。

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

參數

name

string

索引鍵名稱。

options

BackupKeyOptions

選擇性參數。

傳回

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

刪除作業適用于儲存在 Azure 金鑰保存庫 中的任何金鑰。 無法刪除個別版本的金鑰，一次只能刪除指定金鑰的所有版本。

此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候，直到刪除金鑰為止。

此作業需要金鑰/刪除權限。

使用方式範例：

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

從指定的金鑰保存庫刪除金鑰。

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

參數

name

string

索引鍵名稱。

options

BeginDeleteKeyOptions

選擇性參數。

傳回

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

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

復原指定保存庫中已刪除的金鑰。 此作業只能在已啟用虛刪除的保存庫上執行。

此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候，直到復原已刪除的金鑰為止。

這項作業需要金鑰/復原許可權。

使用方式範例：

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

將已刪除的金鑰復原至最新版本。

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

參數

name

string

已刪除金鑰的名稱。

options

BeginRecoverDeletedKeyOptions

選擇性參數。

傳回

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

createEcKey(string, CreateEcKeyOptions)

createEcKey 方法會在 Azure 金鑰保存庫中建立新的橢圓曲線索引鍵。 如果指定的金鑰已存在，Azure 金鑰保存庫會建立該金鑰的新版本。 它需要金鑰/建立許可權。

使用方式範例：

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

建立新的金鑰、儲存金鑰，然後將金鑰參數和屬性傳回給用戶端。

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

參數

name

string

索引鍵名稱。

options

CreateEcKeyOptions

選擇性參數。

傳回

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

建立金鑰作業可用來在 Azure 金鑰保存庫中建立任何金鑰類型。 如果指定的金鑰已存在，Azure 金鑰保存庫會建立該金鑰的新版本。 它需要金鑰/建立許可權。

使用方式範例：

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

建立新的金鑰、儲存金鑰，然後將金鑰參數和屬性傳回給用戶端。

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

參數

name

string

索引鍵名稱。

keyType

string

索引鍵的類型。 下列其中一項：'EC'、'EC-HSM'、'RSA'、'RSA-HSM'、'oct'。

options

CreateKeyOptions

選擇性參數。

傳回

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

createOctKey 方法會在 Azure 金鑰保存庫中建立新的 OCT 金鑰。 如果指定的金鑰已存在，Azure 金鑰保存庫會建立該金鑰的新版本。 它需要金鑰/建立許可權。

使用方式範例：

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

建立新的金鑰、儲存金鑰，然後將金鑰參數和屬性傳回給用戶端。

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

參數

name

string

索引鍵名稱。

options

CreateOctKeyOptions

選擇性參數。

傳回

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

createRSAKey 方法會在 Azure 金鑰保存庫中建立新的 RSA 金鑰。 如果指定的金鑰已存在，Azure 金鑰保存庫會建立該金鑰的新版本。 它需要金鑰/建立許可權。

使用方式範例：

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

建立新的金鑰、儲存金鑰，然後將金鑰參數和屬性傳回給用戶端。

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

參數

name

string

索引鍵名稱。

options

CreateRsaKeyOptions

選擇性參數。

傳回

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

取得指定金鑰的 CryptographyClient 。

使用方式範例：

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

參數

keyName

string

options

GetCryptographyClientOptions

傳回

CryptographyClient

• 使用與這個KeyClient相同的選項、認證和 HTTP 用戶端的密碼編譯Client

getDeletedKey(string, GetDeletedKeyOptions)

getDeletedKey 方法會傳回指定的已刪除索引鍵及其屬性。 這項作業需要金鑰/取得許可權。

使用方式範例：

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

取得指定的已刪除索引鍵。

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

參數

name

string

索引鍵名稱。

options

GetDeletedKeyOptions

選擇性參數。

傳回

Promise<DeletedKey>

getKey(string, GetKeyOptions)

getKey 方法會取得指定的金鑰，並適用于儲存在 Azure 金鑰保存庫中的任何金鑰。 這項作業需要金鑰/取得許可權。

使用方式範例：

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

從指定的金鑰保存庫取得指定的金鑰。

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

參數

name

string

索引鍵名稱。

options

GetKeyOptions

選擇性參數。

傳回

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

取得金鑰保存庫金鑰的輪替原則。 根據預設，所有金鑰都有原則會在到期前 30 天通知。

此作業需要金鑰/取得許可權。 使用方式範例：

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

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

參數

keyName

string

索引鍵名稱。

options

GetKeyRotationPolicyOptions

選擇性參數。

傳回

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

取得要求的位元組數目，其中包含來自 Managed HSM 的隨機值。 此作業需要 managedHsm/rng 許可權。

使用方式範例：

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

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

參數

count

number

要包含 1 到 128 之間的位元組數目。

options

GetRandomBytesOptions

選擇性參數。

傳回

Promise<Uint8Array>

importKey(string, JsonWebKey_2, ImportKeyOptions)

匯入金鑰作業可用來將任何金鑰類型匯入 Azure 金鑰保存庫。 如果指定的金鑰已存在，Azure 金鑰保存庫會建立該金鑰的新版本。 此作業需要金鑰/匯入許可權。

使用方式範例：

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

匯入外部建立的金鑰、儲存金鑰，並將金鑰參數和屬性傳回給用戶端。

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

參數

name

string

匯入金鑰的名稱。

key

JsonWebKey

JSON Web 金鑰。

options

ImportKeyOptions

選擇性參數。

傳回

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

逐一查看保存庫中已刪除的金鑰。 回應中會提供完整的金鑰識別碼和屬性。 索引鍵不會傳回任何值。 此作業需要金鑰/清單許可權。

使用方式範例：

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

列出保存庫中的所有金鑰

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

參數

options

ListDeletedKeysOptions

選擇性參數。

傳回

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

逐一查看保存庫中所有金鑰的最新版本。 回應中會提供完整的金鑰識別碼和屬性。 索引鍵不會傳回任何值。 此作業需要金鑰/清單許可權。

使用方式範例：

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

列出保存庫中的所有金鑰

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

參數

options

ListPropertiesOfKeysOptions

選擇性參數。

傳回

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

逐一查看保存庫中指定金鑰的所有版本。 回應中會提供完整的金鑰識別碼、屬性和標記。 此作業需要金鑰/清單許可權。

使用方式範例：

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>

參數

name

string

要擷取版本之金鑰的名稱

options

ListPropertiesOfKeyVersionsOptions

選擇性參數。

傳回

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

清除刪除的金鑰作業會永久移除金鑰，而不會有復原的可能性。 此作業只能在已啟用虛刪除的保存庫上啟用。 此作業需要金鑰/清除許可權。

使用方式範例：

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

永久刪除指定的索引鍵。

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

參數

name

string

索引鍵名稱。

options

PurgeDeletedKeyOptions

選擇性參數。

傳回

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

從受控 HSM 釋放金鑰。

發行金鑰作業適用于所有金鑰類型。 此作業需要將金鑰標示為可匯出，以及金鑰/發行許可權。

使用方式範例：

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

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

參數

name

string

索引鍵名稱。

targetAttestationToken

string

金鑰發行目標的證明判斷提示。

options

ReleaseKeyOptions

選擇性參數。

傳回

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

將備份的金鑰及其所有版本還原至保存庫。 此作業需要金鑰/還原許可權。

使用方式範例：

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

將備份的金鑰還原至保存庫。

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

參數

backup

Uint8Array

與金鑰組合相關聯的備份 Blob。

options

RestoreKeyBackupOptions

選擇性參數。

傳回

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

藉由產生新版本的金鑰，根據金鑰原則輪替金鑰。 此作業需要金鑰/輪替許可權。

使用方式範例：

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

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

參數

name

string

要輪替的金鑰名稱。

options

RotateKeyOptions

選擇性參數。

傳回

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

updateKeyProperties 方法會變更現有預存索引鍵的指定屬性。 要求中未指定的屬性會保持不變。 無法變更索引鍵本身的值。 此作業需要金鑰/設定許可權。

使用方式範例：

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

更新與指定金鑰保存庫中指定金鑰相關聯的屬性。

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

參數

name

string

索引鍵名稱。

keyVersion

string

機碼的版本。

options

UpdateKeyPropertiesOptions

選擇性參數。

傳回

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

updateKeyProperties 方法會變更現有預存金鑰最新版本的指定屬性。 要求中未指定的屬性會保持不變。 無法變更索引鍵本身的值。 此作業需要金鑰/設定許可權。

使用方式範例：

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

更新與指定金鑰保存庫中指定金鑰相關聯的屬性。

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

參數

name

string

索引鍵名稱。

options

UpdateKeyPropertiesOptions

選擇性參數。

傳回

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

更新金鑰保存庫金鑰的輪替原則。 此作業需要金鑰/更新許可權。

使用方式範例：

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

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

參數

keyName

string

索引鍵名稱。

policy

KeyRotationPolicyProperties

options

UpdateKeyRotationPolicyOptions

選擇性參數。

傳回

Promise<KeyRotationPolicy>