다음을 통해 공유

SecretClient class

  • 참조
패키지:
@azure/keyvault-secrets

SecretClient는 Azure Key Vault KeyVaultSecret을 관리하는 메서드를 제공합니다. 클라이언트는 KeyVaultSecrets 만들기, 검색, 업데이트, 삭제, 제거, 백업, 복원 및 나열을 지원합니다. 또한 클라이언트는 일시 삭제를 사용하도록 설정된 Azure Key Vault 대해 DeletedSecret 목록을 지원합니다.

생성자

SecretClient(string, TokenCredential, SecretClientOptions)

SecretClient의 인스턴스를 만듭니다.

예제 사용법:

import { SecretClient } from "@azure/keyvault-secrets";
import { DefaultAzureCredential } from "@azure/identity";

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

let client = new SecretClient(vaultUrl, credentials);

속성

vaultUrl

자격 증명 모음의 기본 URL

메서드

backupSecret(string, BackupSecretOptions)

지정된 비밀의 백업을 클라이언트에 다운로드하도록 요청합니다. 비밀의 모든 버전이 다운로드됩니다. 이 작업을 수행하려면 비밀/백업 권한이 필요합니다.

사용 예제:

let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");

지정된 비밀을 백업합니다.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Azure Key Vault 저장된 비밀을 삭제합니다. 이 함수는 비밀이 삭제될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

이 작업을 수행하려면 비밀/삭제 권한이 필요합니다.

예제 사용법:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await deletePoller.pollUntilDone();
console.log(deletedSecret);

지정된 키 자격 증명 모음에서 비밀을 삭제합니다.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

지정된 자격 증명 모음에서 삭제된 비밀을 복구합니다. 이 함수는 비밀이 복구될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

이 작업을 수행하려면 비밀/복구 권한이 필요합니다.

사용 예제:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret("MySecretName");

// Serializing the poller
const serialized = recoverPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

삭제된 비밀을 최신 버전으로 복구합니다.
getDeletedSecret(string, GetDeletedSecretOptions)

getDeletedSecret 메서드는 지정된 삭제된 비밀을 해당 특성과 함께 반환합니다. 이 작업을 수행하려면 비밀/가져오기 권한이 필요합니다.

사용 예제:

let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");

지정된 삭제된 비밀을 가져옵니다.
getSecret(string, GetSecretOptions)

getSecret 메서드는 Azure Key Vault 저장된 모든 비밀에 적용할 수 있습니다. 이 작업을 수행하려면 비밀/가져오기 권한이 필요합니다.

사용 예제:

let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");

지정된 키 자격 증명 모음에서 지정된 비밀을 가져옵니다.
listDeletedSecrets(ListDeletedSecretsOptions)

자격 증명 모음에서 삭제된 비밀을 반복합니다. 응답에서는 전체 암호 식별자 및 특성이 제공됩니다. 비밀에 대한 값이 반환되지 않습니다. 이 작업에는 비밀/목록 권한이 필요합니다.

사용 예제:

let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("deleted secret: ", deletedSecret);
}

자격 증명 모음의 모든 비밀을 나열합니다.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

자격 증명 모음에 있는 모든 비밀의 최신 버전을 반복합니다. 응답에서는 전체 암호 식별자 및 특성이 제공됩니다. 비밀에 대한 값이 반환되지 않습니다. 이 작업에는 비밀/목록 권한이 필요합니다.

예제 사용법:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecrets()) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret: ", secret);
}

자격 증명 모음의 모든 비밀을 나열합니다.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

자격 증명 모음에서 지정된 비밀의 모든 버전을 반복합니다. 응답에서는 전체 암호 식별자 및 특성이 제공됩니다. 비밀에 대한 값이 반환되지 않습니다. 이 작업에는 비밀/목록 권한이 필요합니다.

사용 예제:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecretVersions("MySecretName")) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret version: ", secret);
}
purgeDeletedSecret(string, PurgeDeletedSecretOptions)

삭제된 비밀 제거 작업은 복구 가능성 없이 비밀을 영구적으로 제거합니다. 이 작업은 일시 삭제 사용 자격 증명 모음에서만 사용하도록 설정할 수 있습니다. 이 작업을 수행하려면 비밀/제거 권한이 필요합니다.

예제 사용법:

const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");

지정된 비밀을 영구적으로 삭제합니다.
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

백업된 비밀 및 모든 버전을 자격 증명 모음으로 복원합니다. 이 작업에는 비밀/복원 권한이 필요합니다.

예제 사용법:

let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);

백업된 비밀을 자격 증명 모음에 복원합니다.
setSecret(string, string, SetSecretOptions)

setSecret 메서드는 Azure Key Vault 비밀 또는 비밀 버전을 추가합니다. 명명된 암호가 이미 있으면 Azure 키 자격 증명 모음에서는 해당 암호의 새 버전을 만듭니다. 이 작업에는 비밀/설정 권한이 필요합니다.

예제 사용법:

let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

지정된 키 자격 증명 모음에 비밀을 추가합니다.
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

updateSecret 메서드는 기존 저장된 비밀의 지정된 특성을 변경합니다. 요청에 지정되지 않은 속성은 변경되지 않은 상태로 유지됩니다. 암호 자체의 값은 변경할 수 없습니다. 이 작업에는 비밀/설정 권한이 필요합니다.

예제 사용법:

let secretName = "MySecretName";
let client = new SecretClient(url, credentials);
let secret = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, secret.properties.version, { enabled: false });

지정된 키 자격 증명 모음에서 지정된 비밀과 연결된 특성을 업데이트.

생성자 세부 정보

SecretClient(string, TokenCredential, SecretClientOptions)

SecretClient의 인스턴스를 만듭니다.

예제 사용법:

import { SecretClient } from "@azure/keyvault-secrets";
import { DefaultAzureCredential } from "@azure/identity";

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

let client = new SecretClient(vaultUrl, credentials);

new SecretClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: SecretClientOptions)

매개 변수

vaultUrl

string

자격 증명 모음의 기본 URL입니다. 이 URL이 유효한 Key Vault 리소스를 참조하는지 확인해야 합니다. 자세한 내용은 https://aka.ms/azsdk/blog/vault-uri를 참조하세요.

credential
TokenCredential

서비스에 대한 TokenCredential 요청을 인증하는 데 사용되는 인터페이스를 구현하는 개체입니다. @azure/identity 패키지를 사용하여 요구 사항에 맞는 자격 증명을 만듭니다.

pipelineOptions
SecretClientOptions

Key Vault API 요청을 구성하는 데 사용되는 파이프라인 옵션입니다. 기본 파이프라인 구성을 사용하려면 이 매개 변수를 생략합니다.

속성 세부 정보

vaultUrl

자격 증명 모음의 기본 URL

vaultUrl: string

속성 값

string

메서드 세부 정보

backupSecret(string, BackupSecretOptions)

지정된 비밀의 백업을 클라이언트에 다운로드하도록 요청합니다. 비밀의 모든 버전이 다운로드됩니다. 이 작업을 수행하려면 비밀/백업 권한이 필요합니다.

사용 예제:

let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");

지정된 비밀을 백업합니다.

function backupSecret(secretName: string, options?: BackupSecretOptions): Promise<undefined | Uint8Array>

매개 변수

secretName

string

비밀의 이름입니다.

options
BackupSecretOptions

선택적 매개 변수입니다.

반환

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Azure Key Vault 저장된 비밀을 삭제합니다. 이 함수는 비밀이 삭제될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

이 작업을 수행하려면 비밀/삭제 권한이 필요합니다.

예제 사용법:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await deletePoller.pollUntilDone();
console.log(deletedSecret);

지정된 키 자격 증명 모음에서 비밀을 삭제합니다.

function beginDeleteSecret(name: string, options?: BeginDeleteSecretOptions): Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>

매개 변수

name

string

options
BeginDeleteSecretOptions

선택적 매개 변수입니다.

반환

Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

지정된 자격 증명 모음에서 삭제된 비밀을 복구합니다. 이 함수는 비밀이 복구될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

이 작업을 수행하려면 비밀/복구 권한이 필요합니다.

사용 예제:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret("MySecretName");

// Serializing the poller
const serialized = recoverPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

삭제된 비밀을 최신 버전으로 복구합니다.

function beginRecoverDeletedSecret(name: string, options?: BeginRecoverDeletedSecretOptions): Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>

매개 변수

name

string

options
BeginRecoverDeletedSecretOptions

선택적 매개 변수입니다.

반환

Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>

getDeletedSecret(string, GetDeletedSecretOptions)

getDeletedSecret 메서드는 지정된 삭제된 비밀을 해당 특성과 함께 반환합니다. 이 작업을 수행하려면 비밀/가져오기 권한이 필요합니다.

사용 예제:

let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");

지정된 삭제된 비밀을 가져옵니다.

function getDeletedSecret(secretName: string, options?: GetDeletedSecretOptions): Promise<DeletedSecret>

매개 변수

secretName

string

비밀의 이름입니다.

options
GetDeletedSecretOptions

선택적 매개 변수입니다.

반환

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

getSecret 메서드는 Azure Key Vault 저장된 모든 비밀에 적용할 수 있습니다. 이 작업을 수행하려면 비밀/가져오기 권한이 필요합니다.

사용 예제:

let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");

지정된 키 자격 증명 모음에서 지정된 비밀을 가져옵니다.

function getSecret(secretName: string, options?: GetSecretOptions): Promise<KeyVaultSecret>

매개 변수

secretName

string

비밀의 이름입니다.

options
GetSecretOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

자격 증명 모음에서 삭제된 비밀을 반복합니다. 응답에서는 전체 암호 식별자 및 특성이 제공됩니다. 비밀에 대한 값이 반환되지 않습니다. 이 작업에는 비밀/목록 권한이 필요합니다.

사용 예제:

let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("deleted secret: ", deletedSecret);
}

자격 증명 모음의 모든 비밀을 나열합니다.

function listDeletedSecrets(options?: ListDeletedSecretsOptions): PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

매개 변수

options
ListDeletedSecretsOptions

선택적 매개 변수입니다.

반환

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

자격 증명 모음에 있는 모든 비밀의 최신 버전을 반복합니다. 응답에서는 전체 암호 식별자 및 특성이 제공됩니다. 비밀에 대한 값이 반환되지 않습니다. 이 작업에는 비밀/목록 권한이 필요합니다.

예제 사용법:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecrets()) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret: ", secret);
}

자격 증명 모음의 모든 비밀을 나열합니다.

function listPropertiesOfSecrets(options?: ListPropertiesOfSecretsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

매개 변수

options
ListPropertiesOfSecretsOptions

선택적 매개 변수입니다.

반환

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

자격 증명 모음에서 지정된 비밀의 모든 버전을 반복합니다. 응답에서는 전체 암호 식별자 및 특성이 제공됩니다. 비밀에 대한 값이 반환되지 않습니다. 이 작업에는 비밀/목록 권한이 필요합니다.

사용 예제:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecretVersions("MySecretName")) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret version: ", secret);
}

function listPropertiesOfSecretVersions(secretName: string, options?: ListPropertiesOfSecretVersionsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

매개 변수

secretName

string

버전을 가져올 비밀의 이름입니다.

options
ListPropertiesOfSecretVersionsOptions

선택적 매개 변수입니다.

반환

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

삭제된 비밀 제거 작업은 복구 가능성 없이 비밀을 영구적으로 제거합니다. 이 작업은 일시 삭제 사용 자격 증명 모음에서만 사용하도록 설정할 수 있습니다. 이 작업을 수행하려면 비밀/제거 권한이 필요합니다.

예제 사용법:

const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");

지정된 비밀을 영구적으로 삭제합니다.

function purgeDeletedSecret(secretName: string, options?: PurgeDeletedSecretOptions): Promise<void>

매개 변수

secretName

string

비밀의 이름입니다.

options
PurgeDeletedSecretOptions

선택적 매개 변수입니다.

반환

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

백업된 비밀 및 모든 버전을 자격 증명 모음으로 복원합니다. 이 작업에는 비밀/복원 권한이 필요합니다.

예제 사용법:

let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);

백업된 비밀을 자격 증명 모음에 복원합니다.

function restoreSecretBackup(secretBundleBackup: Uint8Array, options?: RestoreSecretBackupOptions): Promise<SecretProperties>

매개 변수

secretBundleBackup

Uint8Array

비밀 번들과 연결된 백업 Blob입니다.

options
RestoreSecretBackupOptions

선택적 매개 변수입니다.

반환

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

setSecret 메서드는 Azure Key Vault 비밀 또는 비밀 버전을 추가합니다. 명명된 암호가 이미 있으면 Azure 키 자격 증명 모음에서는 해당 암호의 새 버전을 만듭니다. 이 작업에는 비밀/설정 권한이 필요합니다.

예제 사용법:

let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

지정된 키 자격 증명 모음에 비밀을 추가합니다.

function setSecret(secretName: string, value: string, options?: SetSecretOptions): Promise<KeyVaultSecret>

매개 변수

secretName

string

비밀의 이름입니다.

value

string

암호의 값입니다.

options
SetSecretOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

updateSecret 메서드는 기존 저장된 비밀의 지정된 특성을 변경합니다. 요청에 지정되지 않은 속성은 변경되지 않은 상태로 유지됩니다. 암호 자체의 값은 변경할 수 없습니다. 이 작업에는 비밀/설정 권한이 필요합니다.

예제 사용법:

let secretName = "MySecretName";
let client = new SecretClient(url, credentials);
let secret = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, secret.properties.version, { enabled: false });

지정된 키 자격 증명 모음에서 지정된 비밀과 연결된 특성을 업데이트.

function updateSecretProperties(secretName: string, secretVersion: string, options?: UpdateSecretPropertiesOptions): Promise<SecretProperties>

매개 변수

secretName

string

비밀의 이름입니다.

secretVersion

string

비밀의 버전입니다.

options
UpdateSecretPropertiesOptions

선택적 매개 변수입니다.

반환

Promise<SecretProperties>