KeyVaultSettingsClient class
Der KeyVaultSettingsClient stellt asynchrone Methoden zum Erstellen, Aktualisieren, Abrufen und Listeneinstellungen für den Azure Key Vault bereit.
Konstruktoren
| Key |
Erstellt eine Instanz des KeyVaultSettingsClient. Beispielverwendung: |
Eigenschaften
| vault |
Die Basis-URL zum Tresor. |
Methoden
| get |
Rufen Sie den Wert einer bestimmten Kontoeinstellung ab. |
| get |
Listet die Einstellungen des Kontos auf. |
| update |
Aktualisiert die Einstellung des benannten Kontos. |
Details zum Konstruktor
KeyVaultSettingsClient(string, TokenCredential, SettingsClientOptions)
Erstellt eine Instanz des KeyVaultSettingsClient.
Beispielverwendung:
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)Parameter
- vaultUrl
-
string
die URL des Key Vault. Es sollte diese Form haben: https://${your-key-vault-name}.vault.azure.net. Sie sollten überprüfen, ob diese URL auf eine gültige Key Vault- oder verwaltete HSM-Ressource verweist. Weitere Informationen finden Sie unter https://aka.ms/azsdk/blog/vault-uri.
- credential
- TokenCredential
Ein Objekt, das die TokenCredential Schnittstelle implementiert, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird. Verwenden Sie das @azure/identity-Paket, um eine Anmeldeinformation zu erstellen, die Ihren Anforderungen entspricht.
- options
- SettingsClientOptions
Optionen zum Konfigurieren von Key Vault-API-Anforderungen.
Details zur Eigenschaft
vaultUrl
Die Basis-URL zum Tresor.
vaultUrl: stringEigenschaftswert
string
Details zur Methode
getSetting(string, GetSettingOptions)
Rufen Sie den Wert einer bestimmten Kontoeinstellung ab.
function getSetting(settingName: string, options?: GetSettingOptions): Promise<KeyVaultSetting>Parameter
- settingName
-
string
der Name der Einstellung.
- options
- GetSettingOptions
die optionalen Parameter.
Gibt zurück
Promise<KeyVaultSetting>
getSettings(ListSettingsOptions)
Listet die Einstellungen des Kontos auf.
function getSettings(options?: ListSettingsOptions): Promise<ListSettingsResponse>Parameter
- options
- ListSettingsOptions
die optionalen Parameter.
Gibt zurück
Promise<ListSettingsResponse>
updateSetting(KeyVaultSetting, UpdateSettingOptions)
Aktualisiert die Einstellung des benannten Kontos.
function updateSetting(setting: KeyVaultSetting, options?: UpdateSettingOptions): Promise<KeyVaultSetting>Parameter
- setting
- KeyVaultSetting
die zu aktualisierende Einstellung. Der Name der Einstellung muss eine gültige Einstellungsoption sein.
- options
- UpdateSettingOptions
die optionalen Parameter.
Gibt zurück
Promise<KeyVaultSetting>