次の方法で共有

SecretClient class

  • リファレンス
パッケージ:
@azure/keyvault-secrets

SecretClient には、Azure Key Vault KeyVaultSecret を管理するメソッドが用意されています。 クライアントは、KeyVaultSecrets の作成、取得、更新、削除、消去、バックアップ、復元、一覧表示をサポートしています。 クライアントは、論理的な削除が有効な Azure Key Vault の DeletedSecret 一覧表示もサポートしています。

コンストラクター

SecretClient(string, TokenCredential, SecretClientOptions)

SecretClient のインスタンスを作成します。

使用例:

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

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new SecretClient(vaultUrl, credentials);

プロパティ

vaultUrl

コンテナーへのベース URL

メソッド

backupSecret(string, BackupSecretOptions)

指定したシークレットのバックアップをクライアントにダウンロードするように要求します。 シークレットのすべてのバージョンがダウンロードされます。 この操作には、シークレット/バックアップアクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");

指定したシークレットをバックアップします。
beginDeleteSecret(string, BeginDeleteSecretOptions)

Azure Key Vault に格納されているシークレットを削除します。 この関数は、シークレットが削除されるまで無期限に待機できる実行時間の長い操作ポーリング ツールを返します。

この操作には、シークレット/削除アクセス許可が必要です。

使用例:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await deletePoller.pollUntilDone();
console.log(deletedSecret);

指定したキー コンテナーからシークレットを削除します。
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

指定したコンテナー内の削除されたシークレットを回復します。 この関数は、シークレットが復旧されるまで無期限に待機できる実行時間の長い操作ポーリング ツールを返します。

この操作には、シークレット/回復アクセス許可が必要です。

使用例:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret("MySecretName");

// Serializing the poller
const serialized = recoverPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

削除されたシークレットを最新バージョンに回復します。
getDeletedSecret(string, GetDeletedSecretOptions)

getDeletedSecret メソッドは、指定された削除されたシークレットとその属性を返します。 この操作には、シークレット/取得アクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");

指定した削除されたシークレットを取得します。
getSecret(string, GetSecretOptions)

getSecret メソッドは、Azure Key Vault に格納されているすべてのシークレットに適用されます。 この操作には、シークレット/取得アクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");

特定のキー コンテナーから指定されたシークレットを取得します。
listDeletedSecrets(ListDeletedSecretsOptions)

コンテナー内の削除されたシークレットを反復処理します。 完全なシークレット識別子と属性が応答で提供されます。 シークレットの値は返されません。 この操作には、シークレット/リストのアクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("deleted secret: ", deletedSecret);
}

コンテナー内のすべてのシークレットを一覧表示します。
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

コンテナー内のすべてのシークレットの最新バージョンを反復処理します。 完全なシークレット識別子と属性が応答で提供されます。 シークレットの値は返されません。 この操作には、シークレット/リストのアクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecrets()) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret: ", secret);
}

コンテナー内のすべてのシークレットを一覧表示します。
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

コンテナー内の特定のシークレットのすべてのバージョンを反復処理します。 完全なシークレット識別子と属性が応答で提供されます。 シークレットの値は返されません。 この操作には、シークレット/リストのアクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecretVersions("MySecretName")) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret version: ", secret);
}
purgeDeletedSecret(string, PurgeDeletedSecretOptions)

削除されたシークレットの消去操作では、回復の可能性なしに、シークレットが完全に削除されます。 この操作は、論理的な削除が有効なコンテナーでのみ有効にすることができます。 この操作には、シークレット/消去アクセス許可が必要です。

使用例:

const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");

指定したシークレットを完全に削除します。
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

バックアップされたシークレットとそのすべてのバージョンをコンテナーに復元します。 この操作には、シークレット/復元アクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);

バックアップされたシークレットをコンテナーに復元します。
setSecret(string, string, SetSecretOptions)

setSecret メソッドは、シークレットまたはシークレット バージョンを Azure Key Vault に追加します。 名前付きシークレットが既に存在する場合、Azure Key Vault はそのシークレットの新しいバージョンを作成します。 この操作には、シークレット/設定アクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

指定したキー コンテナーにシークレットを追加します。
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

updateSecret メソッドは、既存の格納されているシークレットの指定された属性を変更します。 要求で指定されていないプロパティは変更されません。 シークレット自体の値は変更できません。 この操作には、シークレット/設定アクセス許可が必要です。

使用例:

let secretName = "MySecretName";
let client = new SecretClient(url, credentials);
let secret = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, secret.properties.version, { enabled: false });

特定のキー コンテナー内の指定されたシークレットに関連付けられている属性を更新します。

コンストラクターの詳細

SecretClient(string, TokenCredential, SecretClientOptions)

SecretClient のインスタンスを作成します。

使用例:

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

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new SecretClient(vaultUrl, credentials);

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

パラメーター

vaultUrl

string

コンテナーへのベース URL。 この URL が有効な Key Vault リソースを参照していることを検証する必要があります。 詳細については、https://aka.ms/azsdk/blog/vault-uri を参照してください。

credential
TokenCredential

サービスへの要求を認証するために使用する TokenCredential インターフェイスを実装するオブジェクト。 @azure/identity パッケージを使用して、ニーズに合った資格情報を作成します。

pipelineOptions
SecretClientOptions

Key Vault API 要求の構成に使用されるパイプライン オプション。 既定のパイプライン構成を使用するには、このパラメーターを省略します。

プロパティの詳細

vaultUrl

コンテナーへのベース URL

vaultUrl: string

プロパティ値

string

メソッドの詳細

backupSecret(string, BackupSecretOptions)

指定したシークレットのバックアップをクライアントにダウンロードするように要求します。 シークレットのすべてのバージョンがダウンロードされます。 この操作には、シークレット/バックアップアクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");

指定したシークレットをバックアップします。

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

パラメーター

secretName

string

シークレットの名前。

options
BackupSecretOptions

省略可能なパラメーター。

戻り値

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Azure Key Vault に格納されているシークレットを削除します。 この関数は、シークレットが削除されるまで無期限に待機できる実行時間の長い操作ポーリング ツールを返します。

この操作には、シークレット/削除アクセス許可が必要です。

使用例:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await deletePoller.pollUntilDone();
console.log(deletedSecret);

指定したキー コンテナーからシークレットを削除します。

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

パラメーター

name

string

options
BeginDeleteSecretOptions

省略可能なパラメーター。

戻り値

Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

指定したコンテナー内の削除されたシークレットを回復します。 この関数は、シークレットが復旧されるまで無期限に待機できる実行時間の長い操作ポーリング ツールを返します。

この操作には、シークレット/回復アクセス許可が必要です。

使用例:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret("MySecretName");

// Serializing the poller
const serialized = recoverPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

削除されたシークレットを最新バージョンに回復します。

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

パラメーター

name

string

options
BeginRecoverDeletedSecretOptions

省略可能なパラメーター。

戻り値

Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>

getDeletedSecret(string, GetDeletedSecretOptions)

getDeletedSecret メソッドは、指定された削除されたシークレットとその属性を返します。 この操作には、シークレット/取得アクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");

指定した削除されたシークレットを取得します。

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

パラメーター

secretName

string

シークレットの名前。

options
GetDeletedSecretOptions

省略可能なパラメーター。

戻り値

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

getSecret メソッドは、Azure Key Vault に格納されているすべてのシークレットに適用されます。 この操作には、シークレット/取得アクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");

特定のキー コンテナーから指定されたシークレットを取得します。

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

パラメーター

secretName

string

シークレットの名前。

options
GetSecretOptions

省略可能なパラメーター。

戻り値

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

コンテナー内の削除されたシークレットを反復処理します。 完全なシークレット識別子と属性が応答で提供されます。 シークレットの値は返されません。 この操作には、シークレット/リストのアクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("deleted secret: ", deletedSecret);
}

コンテナー内のすべてのシークレットを一覧表示します。

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

パラメーター

options
ListDeletedSecretsOptions

省略可能なパラメーター。

戻り値

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

コンテナー内のすべてのシークレットの最新バージョンを反復処理します。 完全なシークレット識別子と属性が応答で提供されます。 シークレットの値は返されません。 この操作には、シークレット/リストのアクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecrets()) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret: ", secret);
}

コンテナー内のすべてのシークレットを一覧表示します。

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

パラメーター

options
ListPropertiesOfSecretsOptions

省略可能なパラメーター。

戻り値

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

コンテナー内の特定のシークレットのすべてのバージョンを反復処理します。 完全なシークレット識別子と属性が応答で提供されます。 シークレットの値は返されません。 この操作には、シークレット/リストのアクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecretVersions("MySecretName")) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret version: ", secret);
}

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

パラメーター

secretName

string

バージョンをフェッチするシークレットの名前。

options
ListPropertiesOfSecretVersionsOptions

省略可能なパラメーター。

戻り値

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

削除されたシークレットの消去操作では、回復の可能性なしに、シークレットが完全に削除されます。 この操作は、論理的な削除が有効なコンテナーでのみ有効にすることができます。 この操作には、シークレット/消去アクセス許可が必要です。

使用例:

const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");

指定したシークレットを完全に削除します。

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

パラメーター

secretName

string

シークレットの名前。

options
PurgeDeletedSecretOptions

省略可能なパラメーター。

戻り値

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

バックアップされたシークレットとそのすべてのバージョンをコンテナーに復元します。 この操作には、シークレット/復元アクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);

バックアップされたシークレットをコンテナーに復元します。

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

パラメーター

secretBundleBackup

Uint8Array

シークレット バンドルに関連付けられているバックアップ BLOB。

options
RestoreSecretBackupOptions

省略可能なパラメーター。

戻り値

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

setSecret メソッドは、シークレットまたはシークレット バージョンを Azure Key Vault に追加します。 名前付きシークレットが既に存在する場合、Azure Key Vault はそのシークレットの新しいバージョンを作成します。 この操作には、シークレット/設定アクセス許可が必要です。

使用例:

let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

指定したキー コンテナーにシークレットを追加します。

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

パラメーター

secretName

string

シークレットの名前。

value

string

シークレットの値。

options
SetSecretOptions

省略可能なパラメーター。

戻り値

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

updateSecret メソッドは、既存の格納されているシークレットの指定された属性を変更します。 要求で指定されていないプロパティは変更されません。 シークレット自体の値は変更できません。 この操作には、シークレット/設定アクセス許可が必要です。

使用例:

let secretName = "MySecretName";
let client = new SecretClient(url, credentials);
let secret = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, secret.properties.version, { enabled: false });

特定のキー コンテナー内の指定されたシークレットに関連付けられている属性を更新します。

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

パラメーター

secretName

string

シークレットの名前。

secretVersion

string

シークレットのバージョン。

options
UpdateSecretPropertiesOptions

省略可能なパラメーター。

戻り値

Promise<SecretProperties>