通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

KeyVaultSettingsClient class

包:
@azure/keyvault-admin

KeyVaultSettingsClient 提供了用于创建、更新、获取和列出 Azure Key Vault 设置的异步方法。

构造函数

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

属性

vaultUrl

保管库的基 URL。

方法

getSetting(string, GetSettingOptions)

获取特定帐户设置的值。
getSettings(ListSettingsOptions)

列出帐户的设置。
updateSetting(KeyVaultSetting, UpdateSettingOptions)

更新命名帐户设置。

构造函数详细信息

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>