Delen via


KeyVaultSettingsClient class

KeyVaultSettingsClient biedt asynchrone methoden voor het maken, bijwerken, ophalen en weergeven van instellingen voor Azure Key Vault.

Constructors

KeyVaultSettingsClient(string, TokenCredential, SettingsClientOptions)

Hiermee maakt u een exemplaar van de KeyVaultSettingsClient.

Voorbeeldgebruik:

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

Eigenschappen

vaultUrl

De basis-URL naar de kluis.

Methoden

getSetting(string, GetSettingOptions)

De waarde van een specifieke accountinstelling ophalen.

getSettings(ListSettingsOptions)

Geef de instellingen van het account weer.

updateSetting(KeyVaultSetting, UpdateSettingOptions)

Hiermee wordt de benoemde accountinstelling bijgewerkt.

Constructordetails

KeyVaultSettingsClient(string, TokenCredential, SettingsClientOptions)

Hiermee maakt u een exemplaar van de KeyVaultSettingsClient.

Voorbeeldgebruik:

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)

Parameters

vaultUrl

string

de URL van de Sleutelkluis. Deze moet deze vorm hebben: https://${your-key-vault-name}.vault.azure.net. Controleer of deze URL verwijst naar een geldige Key Vault- of beheerde HSM-resource. Zie https://aka.ms/azsdk/blog/vault-uri voor meer informatie.

credential
TokenCredential

Een object dat de TokenCredential-interface implementeert die wordt gebruikt voor het verifiëren van aanvragen voor de service. Gebruik het @azure/identity-pakket om een referentie te maken die aan uw behoeften voldoet.

options
SettingsClientOptions

opties die worden gebruikt voor het configureren van Key Vault API-aanvragen.

Eigenschapdetails

vaultUrl

De basis-URL naar de kluis.

vaultUrl: string

Waarde van eigenschap

string

Methodedetails

getSetting(string, GetSettingOptions)

De waarde van een specifieke accountinstelling ophalen.

function getSetting(settingName: string, options?: GetSettingOptions): Promise<KeyVaultSetting>

Parameters

settingName

string

de naam van de instelling.

options
GetSettingOptions

de optionele parameters.

Retouren

Promise<KeyVaultSetting>

getSettings(ListSettingsOptions)

Geef de instellingen van het account weer.

function getSettings(options?: ListSettingsOptions): Promise<ListSettingsResponse>

Parameters

options
ListSettingsOptions

de optionele parameters.

Retouren

updateSetting(KeyVaultSetting, UpdateSettingOptions)

Hiermee wordt de benoemde accountinstelling bijgewerkt.

function updateSetting(setting: KeyVaultSetting, options?: UpdateSettingOptions): Promise<KeyVaultSetting>

Parameters

setting
KeyVaultSetting

de instelling die moet worden bijgewerkt. De naam van de instelling moet een geldige instellingsoptie zijn.

options
UpdateSettingOptions

de optionele parameters.

Retouren

Promise<KeyVaultSetting>