Dela via

KeyVaultSettingsClient class

  • Referens
Paket:
@azure/keyvault-admin

KeyVaultSettingsClient innehåller asynkrona metoder för att skapa, uppdatera, hämta och lista inställningar för Azure Key Vault.

Konstruktorer

KeyVaultSettingsClient(string, TokenCredential, SettingsClientOptions)

Skapar en instans av KeyVaultSettingsClient.

Exempel på användning:

import { KeyVaultSettingsClient } from "@azure/keyvault-admin";
import { DefaultAzureCredential } from "@azure/identity";

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

let client = new KeyVaultSettingsClient(vaultUrl, credentials);

Egenskaper

vaultUrl

Bas-URL:en till valvet.

Metoder

getSetting(string, GetSettingOptions)

Hämta värdet för en specifik kontoinställning.
getSettings(ListSettingsOptions)

Visa en lista över kontots inställningar.
updateSetting(KeyVaultSetting, UpdateSettingOptions)

Uppdaterar den namngivna kontoinställningen.

Konstruktorinformation

KeyVaultSettingsClient(string, TokenCredential, SettingsClientOptions)

Skapar en instans av KeyVaultSettingsClient.

Exempel på användning:

import { KeyVaultSettingsClient } from "@azure/keyvault-admin";
import { DefaultAzureCredential } from "@azure/identity";

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

let client = new KeyVaultSettingsClient(vaultUrl, credentials);

new KeyVaultSettingsClient(vaultUrl: string, credential: TokenCredential, options?: SettingsClientOptions)

Parametrar

vaultUrl

string

URL:en för Key Vault. Den bör ha den här formen: https://${your-key-vault-name}.vault.azure.net. Du bör kontrollera att den här URL:en refererar till en giltig Key Vault- eller Managed HSM-resurs. Mer information finns i https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Ett objekt som implementerar det TokenCredential gränssnitt som används för att autentisera begäranden till tjänsten. Använd @azure/identity-paketet för att skapa en autentiseringsuppgift som passar dina behov.

options
SettingsClientOptions

alternativ som används för att konfigurera Key Vault API-begäranden.

Egenskapsinformation

vaultUrl

Bas-URL:en till valvet.

vaultUrl: string

Egenskapsvärde

string

Metodinformation

getSetting(string, GetSettingOptions)

Hämta värdet för en specifik kontoinställning.

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

Parametrar

settingName

string

namnet på inställningen.

options
GetSettingOptions

de valfria parametrarna.

Returer

Promise<KeyVaultSetting>

getSettings(ListSettingsOptions)

Visa en lista över kontots inställningar.

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

Parametrar

options
ListSettingsOptions

de valfria parametrarna.

Returer

Promise<ListSettingsResponse>

updateSetting(KeyVaultSetting, UpdateSettingOptions)

Uppdaterar den namngivna kontoinställningen.

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

Parametrar

setting
KeyVaultSetting

inställningen som ska uppdateras. Namnet på inställningen måste vara ett giltigt inställningsalternativ.

options
UpdateSettingOptions

de valfria parametrarna.

Returer

Promise<KeyVaultSetting>