KeyVaultSettingsClient class
KeyVaultSettingsClient는 Azure Key Vault에 대한 설정을 만들고, 업데이트하고, 가져와서 나열하는 비동기 메서드를 제공합니다.
생성자
| Key |
KeyVaultSettingsClient의 인스턴스를 만듭니다. 사용 예: |
속성
| vault |
자격 증명 모음의 기본 URL입니다. |
메서드
| get |
특정 계정 설정의 값을 가져옵니다. |
| get |
계정의 설정을 나열합니다. |
| update |
명명된 계정 설정을 업데이트합니다. |
생성자 세부 정보
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>