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 或受控 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>