KeyVaultSettingsClient class
Obiekt KeyVaultSettingsClient udostępnia metody asynchroniczne służące do tworzenia, aktualizowania, pobierania i wyświetlania listy ustawień usługi Azure Key Vault.
Konstruktory
| Key |
Tworzy wystąpienie klasy KeyVaultSettingsClient. Przykładowe użycie: |
Właściwości
| vault |
Podstawowy adres URL magazynu. |
Metody
| get |
Pobierz wartość określonego ustawienia konta. |
| get |
Wyświetl listę ustawień konta. |
| update |
Aktualizuje nazwane ustawienie konta. |
Szczegóły konstruktora
KeyVaultSettingsClient(string, TokenCredential, SettingsClientOptions)
Tworzy wystąpienie klasy KeyVaultSettingsClient.
Przykładowe użycie:
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)Parametry
- vaultUrl
-
string
adres URL usługi Key Vault. Powinien mieć ten kształt: https://${your-key-vault-name}.vault.azure.net. Należy sprawdzić, czy ten adres URL odwołuje się do prawidłowego zasobu usługi Key Vault lub zarządzanego modułu HSM. Aby uzyskać szczegółowe informacje, zobacz https://aka.ms/azsdk/blog/vault-uri.
- credential
- TokenCredential
Obiekt, który implementuje interfejs TokenCredential używany do uwierzytelniania żądań w usłudze. Użyj pakietu @azure/identity, aby utworzyć poświadczenia odpowiadające Twoim potrzebom.
- options
- SettingsClientOptions
opcje używane do konfigurowania żądań interfejsu API usługi Key Vault.
Szczegóły właściwości
vaultUrl
Podstawowy adres URL magazynu.
vaultUrl: stringWartość właściwości
string
Szczegóły metody
getSetting(string, GetSettingOptions)
Pobierz wartość określonego ustawienia konta.
function getSetting(settingName: string, options?: GetSettingOptions): Promise<KeyVaultSetting>Parametry
- settingName
-
string
nazwa ustawienia.
- options
- GetSettingOptions
parametry opcjonalne.
Zwraca
Promise<KeyVaultSetting>
getSettings(ListSettingsOptions)
Wyświetl listę ustawień konta.
function getSettings(options?: ListSettingsOptions): Promise<ListSettingsResponse>Parametry
- options
- ListSettingsOptions
parametry opcjonalne.
Zwraca
Promise<ListSettingsResponse>
updateSetting(KeyVaultSetting, UpdateSettingOptions)
Aktualizuje nazwane ustawienie konta.
function updateSetting(setting: KeyVaultSetting, options?: UpdateSettingOptions): Promise<KeyVaultSetting>Parametry
- setting
- KeyVaultSetting
ustawienie do zaktualizowania. Nazwa ustawienia musi być prawidłową opcją ustawień.
- options
- UpdateSettingOptions
parametry opcjonalne.
Zwraca
Promise<KeyVaultSetting>