SecretClient class

建立 SecretClient 的實例。

範例用法：

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

// Build the URL to reach your key vault
const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

// Lastly, create our keys client and connect to the service
const client = new SecretClient(url, credential);

new SecretClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: SecretClientOptions)

參數

保存庫的基底 URL

vaultUrl: string

屬性值

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

範例用法：

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const backupResult = await client.backupSecret(secretName);

備份指定的秘密。

function backupSecret(secretName: string, options?: BackupSecretOptions): Promise<undefined | Uint8Array>

參數

傳回

刪除儲存在 Azure Key Vault 中的秘密。 此函式會傳回長時間執行的作業輪詢器，可讓您無限期等候，直到刪除秘密為止。

此作業需要秘密/刪除許可權。

範例用法：

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

await client.beginDeleteSecret(secretName);

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

function beginDeleteSecret(name: string, options?: BeginDeleteSecretOptions): Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>

參數

傳回

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

此作業需要秘密/復原許可權。

範例用法：

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const deletePoller = await client.beginDeleteSecret(secretName);
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret(secretName);
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

將已刪除的秘密復原到最新版本。

function beginRecoverDeletedSecret(name: string, options?: BeginRecoverDeletedSecretOptions): Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>

參數

傳回

getDeletedSecret 方法會傳回指定的已刪除秘密及其屬性。 此作業需要秘密/取得許可權。

範例用法：

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = await client.getDeletedSecret("MyDeletedSecret");

取得指定的已刪除秘密。

function getDeletedSecret(secretName: string, options?: GetDeletedSecretOptions): Promise<DeletedSecret>

參數

傳回

getSecret 方法適用於儲存在 Azure Key Vault 中的任何秘密。 此作業需要秘密/取得許可權。

範例用法：

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const latestSecret = await client.getSecret(secretName);
console.log(`Latest version of the secret ${secretName}: `, latestSecret);

const specificSecret = await client.getSecret(secretName, {
  version: latestSecret.properties.version!,
});
console.log(
  `The secret ${secretName} at the version ${latestSecret.properties.version!}: `,
  specificSecret,
);

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

function getSecret(secretName: string, options?: GetSecretOptions): Promise<KeyVaultSecret>

參數

傳回

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

範例用法：

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

for await (const versionProperties of client.listPropertiesOfSecretVersions(secretName)) {
  console.log("Version properties: ", versionProperties);
}

列出保存庫中的所有秘密。

function listDeletedSecrets(options?: ListDeletedSecretsOptions): PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

參數

傳回

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

範例用法：

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

for await (const versionProperties of client.listPropertiesOfSecretVersions(secretName)) {
  console.log("Version properties: ", versionProperties);
}

列出保存庫中的所有秘密。

function listPropertiesOfSecrets(options?: ListPropertiesOfSecretsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

參數

傳回

在保存庫中反覆運算指定密碼的所有版本。 回應中會提供完整的秘密標識碼和屬性。 秘密不會傳回任何值。 此作業需要秘密/列表許可權。

範例用法：

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

for await (const secretProperties of client.listPropertiesOfSecrets()) {
  console.log("Secret properties: ", secretProperties);
}

for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("Deleted secret: ", deletedSecret);
}

for await (const versionProperties of client.listPropertiesOfSecretVersions(secretName)) {
  console.log("Version properties: ", versionProperties);
}

function listPropertiesOfSecretVersions(secretName: string, options?: ListPropertiesOfSecretVersionsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

參數

傳回

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

範例用法：

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const deletePoller = await client.beginDeleteSecret(secretName);
await deletePoller.pollUntilDone();

await client.purgeDeletedSecret(secretName);

永久刪除指定的秘密。

function purgeDeletedSecret(secretName: string, options?: PurgeDeletedSecretOptions): Promise<void>

參數

傳回

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

範例用法：

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const backupResult = await client.backupSecret(secretName);

await client.restoreSecretBackup(backupResult);

將備份的秘密還原至保存庫。

function restoreSecretBackup(secretBundleBackup: Uint8Array, options?: RestoreSecretBackupOptions): Promise<SecretProperties>

參數

傳回

setSecret 方法會將秘密或秘密版本新增至 Azure Key Vault。 如果具名密碼已經存在，Azure Key Vault 會建立該秘密的新版本。 此作業需要秘密/設定許可權。

範例用法：

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = await client.setSecret(secretName, "MySecretValue");
console.log("result: ", result);

在指定的金鑰保存庫中新增秘密。

function setSecret(secretName: string, value: string, options?: SetSecretOptions): Promise<KeyVaultSecret>

參數

傳回

updateSecret 方法會變更現有預存秘密的指定屬性。 要求中未指定的屬性會保持不變。 無法變更秘密本身的值。 此作業需要秘密/設定許可權。

範例用法：

import { DefaultAzureCredential } from "@azure/identity";
import { SecretClient } from "@azure/keyvault-secrets";

const credential = new DefaultAzureCredential();

const vaultName = "<YOUR KEYVAULT NAME>";
const url = `https://${vaultName}.vault.azure.net`;

const client = new SecretClient(url, credential);

const secretName = "MySecretName";

const result = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, result.properties.version, { enabled: false });

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

function updateSecretProperties(secretName: string, secretVersion: string, options?: UpdateSecretPropertiesOptions): Promise<SecretProperties>

參數

傳回