KeyClient class

建立 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)

參數

保存庫的基底 URL

vaultUrl: string

屬性值

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

範例用法：

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

備份指定的索引鍵。

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

參數

傳回

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

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

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

範例用法：

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

參數

傳回

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

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

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

範例用法：

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

參數

傳回

createEcKey 方法會在 Azure Key Vault 中建立新的橢圓曲線密鑰。 如果具名密鑰已經存在，Azure Key Vault 會建立新版本的密鑰。 它需要金鑰/建立許可權。

範例用法：

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

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

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

參數

傳回

建立金鑰作業可用來在 Azure Key Vault 中建立任何密鑰類型。 如果具名密鑰已經存在，Azure Key Vault 會建立新版本的密鑰。 它需要金鑰/建立許可權。

範例用法：

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>

參數

傳回

createOctKey 方法會在 Azure Key Vault 中建立新的 OCT 密鑰。 如果具名密鑰已經存在，Azure Key Vault 會建立新版本的密鑰。 它需要金鑰/建立許可權。

範例用法：

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

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

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

參數

傳回

createRSAKey 方法會在 Azure Key Vault 中建立新的 RSA 密鑰。 如果具名密鑰已經存在，Azure Key Vault 會建立新版本的密鑰。 它需要金鑰/建立許可權。

範例用法：

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

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

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

參數

傳回

取得指定金鑰的 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

參數

傳回

• CryptographyClient 使用與這個 KeyClient 相同的選項、認證和 HTTP 用戶端

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

範例用法：

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

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

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

參數

傳回

getKey 方法會取得指定的密鑰，並適用於儲存在 Azure Key Vault 中的任何密鑰。 此作業需要金鑰/取得許可權。

範例用法：

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

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

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

參數

傳回

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

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

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

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

參數

傳回

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

範例用法：

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

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

參數

傳回

匯入金鑰作業可用來將任何金鑰類型匯入 Azure Key Vault。 如果具名密鑰已經存在，Azure Key Vault 會建立新版本的密鑰。 此作業需要金鑰/匯入許可權。

範例用法：

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

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

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

參數

傳回

反覆運算保存庫中已刪除的金鑰。 回應中會提供完整的金鑰標識碼和屬性。 索引鍵不會傳回任何值。 此作業需要金鑰/列表許可權。

範例用法：

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>

參數

傳回

反覆運算保存庫中所有金鑰的最新版本。 回應中會提供完整的金鑰標識碼和屬性。 索引鍵不會傳回任何值。 此作業需要金鑰/列表許可權。

範例用法：

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>

參數

傳回

在保存庫中反覆運算指定金鑰的所有版本。 回應中會提供完整的金鑰標識碼、屬性和標籤。 此作業需要金鑰/列表許可權。

範例用法：

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>

參數

傳回

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

範例用法：

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>

參數

傳回

從受控 HSM 釋放金鑰。

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

範例用法：

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

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

參數

傳回

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

範例用法：

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>

參數

傳回

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

範例用法：

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

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

參數

傳回

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>

參數

傳回

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>

參數

傳回

更新 Key Vault 金鑰的輪替原則。 此作業需要金鑰/更新許可權。

範例用法：

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

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

參數

傳回