KeyVaultSettingsClient class
KeyVaultSettingsClient には、Azure Key Vault の設定を作成、更新、取得、および一覧表示するための非同期メソッドが用意されています。
コンストラクター
| Key |
KeyVaultSettingsClient のインスタンスを作成します。 使用例: |
プロパティ
| vault |
コンテナーへのベース URL。 |
メソッド
| get |
特定のアカウント設定の値を取得します。 |
| get |
アカウントの設定を一覧表示します。 |
| update |
名前付きアカウント設定を更新します。 |
コンストラクターの詳細
KeyVaultSettingsClient(string, TokenCredential, SettingsClientOptions)
KeyVaultSettingsClient のインスタンスを作成します。
使用例:
import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultSettingsClient } from "@azure/keyvault-admin";
const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultSettingsClient(vaultUrl, credentials);
new KeyVaultSettingsClient(vaultUrl: string, credential: TokenCredential, options?: SettingsClientOptions)パラメーター
- vaultUrl
-
string
Key Vault の URL。 次の図形が必要です: https://${your-key-vault-name}.vault.azure.net。 この URL が有効な Key Vault または Managed HSM リソースを参照していることを検証する必要があります。 詳細については、https://aka.ms/azsdk/blog/vault-uri を参照してください。
- credential
- TokenCredential
サービスへの要求を認証するために使用する TokenCredential インターフェイスを実装するオブジェクト。
@azure/identity パッケージを使用して、ニーズに合った資格情報を作成します。
- options
- SettingsClientOptions
Key Vault API 要求を構成するために使用されるオプション。
プロパティの詳細
vaultUrl
コンテナーへのベース URL。
vaultUrl: stringプロパティ値
string
メソッドの詳細
getSetting(string, GetSettingOptions)
特定のアカウント設定の値を取得します。
function getSetting(settingName: string, options?: GetSettingOptions): Promise<KeyVaultSetting>パラメーター
- settingName
-
string
設定の名前。
- options
- GetSettingOptions
省略可能なパラメーター。
戻り値
Promise<KeyVaultSetting>
getSettings(ListSettingsOptions)
アカウントの設定を一覧表示します。
function getSettings(options?: ListSettingsOptions): Promise<ListSettingsResponse>パラメーター
- options
- ListSettingsOptions
省略可能なパラメーター。
戻り値
Promise<ListSettingsResponse>
updateSetting(KeyVaultSetting, UpdateSettingOptions)
名前付きアカウント設定を更新します。
function updateSetting(setting: KeyVaultSetting, options?: UpdateSettingOptions): Promise<KeyVaultSetting>パラメーター
- setting
- KeyVaultSetting
更新する設定。 設定の名前は有効な設定オプションである必要があります。
- options
- UpdateSettingOptions
省略可能なパラメーター。
戻り値
Promise<KeyVaultSetting>