Share via

KeyClient class

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

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

생성자

KeyClient(string, TokenCredential, KeyClientOptions)

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

예제 사용법:

import { KeyClient } from "@azure/keyvault-keys";
import { DefaultAzureCredential } from "@azure/identity";

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

let client = new KeyClient(vaultUrl, credentials);

속성

vaultUrl

자격 증명 모음의 기본 URL

메서드

backupKey(string, BackupKeyOptions)

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

사용 예제:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");

지정된 키를 백업합니다.
beginDeleteKey(string, BeginDeleteKeyOptions)

삭제 작업은 Azure Key Vault 저장된 모든 키에 적용됩니다. 키의 개별 버전은 삭제할 수 없습니다. 지정된 키의 모든 버전만 한 번에 삭제할 수 있습니다.

이 함수는 키가 삭제될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

이 작업에는 키/삭제 권한이 필요합니다.

사용 예제:

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const poller = await client.beginDeleteKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginDeleteKey("MyKey", { resumeFrom: serialized });

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

지정된 키 자격 증명 모음에서 키를 삭제합니다.
beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

지정된 자격 증명 모음에서 삭제된 키를 복구합니다. 이 작업은 일시 삭제 사용 자격 증명 모음에서만 수행할 수 있습니다.

이 함수는 삭제된 키가 복구될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

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

사용 예제:

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const deletePoller = await client.beginDeleteKey("MyKey");
await deletePoller.pollUntilDone();
const poller = await client.beginRecoverDeletedKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginRecoverDeletedKey("MyKey", { resumeFrom: serialized });

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

삭제된 키를 최신 버전으로 복구합니다.
createEcKey(string, CreateEcKeyOptions)

createEcKey 메서드는 Azure Key Vault 새 타원 곡선 키를 만듭니다. 명명된 키가 이미 있으면 Azure 키 자격 증명 모음에서 키의 새 버전을 만듭니다. 키/만들기 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
let result = await client.createEcKey("MyKey", { curve: "P-256" });

새 키를 만들고 저장한 다음 키 매개 변수 및 속성을 클라이언트에 반환합니다.
createKey(string, string, CreateKeyOptions)

키 만들기 작업을 사용하여 Azure Key Vault 키 형식을 만들 수 있습니다. 명명된 키가 이미 있으면 Azure 키 자격 증명 모음에서 키의 새 버전을 만듭니다. 키/만들기 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
// Create an elliptic-curve key:
let result = await client.createKey("MyKey", "EC");

새 키를 만들고 저장한 다음 키 매개 변수 및 속성을 클라이언트에 반환합니다.
createOctKey(string, CreateOctKeyOptions)

createOctKey 메서드는 Azure Key Vault 새 OCT 키를 만듭니다. 명명된 키가 이미 있으면 Azure 키 자격 증명 모음에서 키의 새 버전을 만듭니다. 키/만들기 권한이 필요합니다.

사용 예제:

let client = new KeyClient(url, credentials);
let result = await client.createOctKey("MyKey", { hsm: true });

새 키를 만들고 저장한 다음 키 매개 변수 및 속성을 클라이언트에 반환합니다.
createRsaKey(string, CreateRsaKeyOptions)

createRSAKey 메서드는 Azure Key Vault 새 RSA 키를 만듭니다. 명명된 키가 이미 있으면 Azure 키 자격 증명 모음에서 키의 새 버전을 만듭니다. 키/만들기 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
let result = await client.createRsaKey("MyKey", { keySize: 2048 });

새 키를 만들고 저장한 다음 키 매개 변수 및 속성을 클라이언트에 반환합니다.
getCryptographyClient(string, GetCryptographyClientOptions)

지정된 키에 대한 CryptographyClient 를 가져옵니다.

예제 사용법:

let client = new KeyClient(url, credentials);
// get a cryptography client for a given key
let cryptographyClient = client.getCryptographyClient("MyKey");
getDeletedKey(string, GetDeletedKeyOptions)

getDeletedKey 메서드는 지정된 삭제된 키와 해당 속성을 반환합니다. 이 작업을 수행하려면 키/가져오기 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
let key = await client.getDeletedKey("MyDeletedKey");

지정된 삭제된 키를 가져옵니다.
getKey(string, GetKeyOptions)

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

사용 예제:

let client = new KeyClient(url, credentials);
let key = await client.getKey("MyKey");

지정된 키 자격 증명 모음에서 지정된 키를 가져옵니다.
getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Key Vault 키의 회전 정책을 가져옵니다. 기본적으로 모든 키에는 만료 30일 전에 알리는 정책이 있습니다.

이 작업을 수행하려면 키/가져오기 권한이 필요합니다. 예제 사용법:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.getKeyRotationPolicy("myKey");
getRandomBytes(number, GetRandomBytesOptions)

관리되는 HSM에서 임의 값을 포함하는 요청된 바이트 수를 가져옵니다. 이 작업을 수행하려면 managedHsm/rng 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(vaultUrl, credentials);
let { bytes } = await client.getRandomBytes(10);
importKey(string, JsonWebKey_2, ImportKeyOptions)

키 가져오기 작업은 모든 키 형식을 Azure Key Vault 가져오는 데 사용할 수 있습니다. 명명된 키가 이미 있으면 Azure 키 자격 증명 모음에서 키의 새 버전을 만듭니다. 이 작업을 수행하려면 키/가져오기 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
// Key contents in myKeyContents
let result = await client.importKey("MyKey", myKeyContents);

외부에서 만든 키를 가져오고 저장한 다음 키 매개 변수 및 속성을 클라이언트에 반환합니다.
listDeletedKeys(ListDeletedKeysOptions)

자격 증명 모음에서 삭제된 키를 반복합니다. 전체 키 식별자 및 속성은 응답에 제공됩니다. 키에 대한 값이 반환되지 않습니다. 이 작업을 수행하려면 키/목록 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
for await (const deletedKey of client.listDeletedKeys()) {
  console.log("deleted key: ", deletedKey);
}

자격 증명 모음의 모든 키 나열
listPropertiesOfKeys(ListPropertiesOfKeysOptions)

자격 증명 모음에 있는 모든 키의 최신 버전을 반복합니다. 전체 키 식별자 및 속성은 응답에 제공됩니다. 키에 대한 값이 반환되지 않습니다. 이 작업을 수행하려면 키/목록 권한이 필요합니다.

사용 예제:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeys()) {
  const key = await client.getKey(keyProperties.name);
  console.log("key: ", key);
}

자격 증명 모음의 모든 키 나열
listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

자격 증명 모음에서 지정된 키의 모든 버전을 반복합니다. 전체 키 식별자, 속성 및 태그는 응답에 제공됩니다. 이 작업을 수행하려면 키/목록 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeyVersions("MyKey")) {
  const key = await client.getKey(keyProperties.name);
  console.log("key version: ", key);
}
purgeDeletedKey(string, PurgeDeletedKeyOptions)

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

예제 사용법:

const client = new KeyClient(url, credentials);
const deletePoller = await client.beginDeleteKey("MyKey")
await deletePoller.pollUntilDone();
await client.purgeDeletedKey("MyKey");

지정된 키를 영구적으로 삭제합니다.
releaseKey(string, string, ReleaseKeyOptions)

관리되는 HSM에서 키를 해제합니다.

릴리스 키 작업은 모든 키 형식에 적용할 수 있습니다. 작업을 수행하려면 키를 내보낼 수 있는 것으로 표시하고 키/해제 권한을 부여해야 합니다.

사용 예제:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", target)
restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

백업된 키와 모든 버전을 자격 증명 모음으로 복원합니다. 이 작업을 수행하려면 키/복원 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
// ...
let key = await client.restoreKeyBackup(backupContents);

백업된 키를 자격 증명 모음에 복원합니다.
rotateKey(string, RotateKeyOptions)

키의 새 버전을 생성하여 키 정책에 따라 키를 회전합니다. 이 작업을 수행하려면 키/회전 권한이 필요합니다.

사용 예제:

let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");
updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

updateKeyProperties 메서드는 기존 저장된 키의 지정된 속성을 변경합니다. 요청에 지정되지 않은 속성은 변경되지 않은 상태로 유지됩니다. 키 자체의 값을 변경할 수 없습니다. 이 작업을 수행하려면 키/설정 권한이 필요합니다.

예제 사용법:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, key.properties.version, { enabled: false });

지정된 키 자격 증명 모음에서 지정된 키와 연결된 속성을 업데이트.
updateKeyProperties(string, UpdateKeyPropertiesOptions)

updateKeyProperties 메서드는 기존 저장된 키의 최신 버전의 지정된 속성을 변경합니다. 요청에 지정되지 않은 속성은 변경되지 않은 상태로 유지됩니다. 키 자체의 값을 변경할 수 없습니다. 이 작업을 수행하려면 키/설정 권한이 필요합니다.

예제 사용법:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, { enabled: false });

지정된 키 자격 증명 모음에서 지정된 키와 연결된 속성을 업데이트.
updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Key Vault 키의 회전 정책을 업데이트. 이 작업을 수행하려면 키/업데이트 권한이 필요합니다.

사용 예제:

let client = new KeyClient(vaultUrl, credentials);
const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);

생성자 세부 정보

KeyClient(string, TokenCredential, KeyClientOptions)

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

예제 사용법:

import { KeyClient } from "@azure/keyvault-keys";
import { DefaultAzureCredential } from "@azure/identity";

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

let client = new KeyClient(vaultUrl, credentials);

new KeyClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: KeyClientOptions)

매개 변수

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 패키지를 사용하여 요구 사항에 맞는 자격 증명을 만듭니다.

pipelineOptions
KeyClientOptions

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

속성 세부 정보

vaultUrl

자격 증명 모음의 기본 URL

vaultUrl: string

속성 값

string

메서드 세부 정보

backupKey(string, BackupKeyOptions)

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

사용 예제:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");

지정된 키를 백업합니다.

function backupKey(name: string, options?: BackupKeyOptions): Promise<undefined | Uint8Array>

매개 변수

name

string

키의 이름입니다.

options
BackupKeyOptions

선택적 매개 변수입니다.

반환

Promise<undefined | Uint8Array>

beginDeleteKey(string, BeginDeleteKeyOptions)

삭제 작업은 Azure Key Vault 저장된 모든 키에 적용됩니다. 키의 개별 버전은 삭제할 수 없습니다. 지정된 키의 모든 버전만 한 번에 삭제할 수 있습니다.

이 함수는 키가 삭제될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

이 작업에는 키/삭제 권한이 필요합니다.

사용 예제:

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const poller = await client.beginDeleteKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginDeleteKey("MyKey", { resumeFrom: serialized });

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

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

function beginDeleteKey(name: string, options?: BeginDeleteKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

매개 변수

name

string

키의 이름입니다.

options
BeginDeleteKeyOptions

선택적 매개 변수입니다.

반환

Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

지정된 자격 증명 모음에서 삭제된 키를 복구합니다. 이 작업은 일시 삭제 사용 자격 증명 모음에서만 수행할 수 있습니다.

이 함수는 삭제된 키가 복구될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

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

사용 예제:

const client = new KeyClient(url, credentials);
await client.createKey("MyKey", "EC");
const deletePoller = await client.beginDeleteKey("MyKey");
await deletePoller.pollUntilDone();
const poller = await client.beginRecoverDeletedKey("MyKey");

// Serializing the poller
const serialized = poller.toString();
// A new poller can be created with:
// await client.beginRecoverDeletedKey("MyKey", { resumeFrom: serialized });

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

삭제된 키를 최신 버전으로 복구합니다.

function beginRecoverDeletedKey(name: string, options?: BeginRecoverDeletedKeyOptions): Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

매개 변수

name

string

삭제된 키의 이름입니다.

options
BeginRecoverDeletedKeyOptions

선택적 매개 변수입니다.

반환

Promise<PollerLike<PollOperationState<DeletedKey>, DeletedKey>>

createEcKey(string, CreateEcKeyOptions)

createEcKey 메서드는 Azure Key Vault 새 타원 곡선 키를 만듭니다. 명명된 키가 이미 있으면 Azure 키 자격 증명 모음에서 키의 새 버전을 만듭니다. 키/만들기 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
let result = await client.createEcKey("MyKey", { curve: "P-256" });

새 키를 만들고 저장한 다음 키 매개 변수 및 속성을 클라이언트에 반환합니다.

function createEcKey(name: string, options?: CreateEcKeyOptions): Promise<KeyVaultKey>

매개 변수

name

string

키의 이름입니다.

options
CreateEcKeyOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultKey>

createKey(string, string, CreateKeyOptions)

키 만들기 작업을 사용하여 Azure Key Vault 키 형식을 만들 수 있습니다. 명명된 키가 이미 있으면 Azure 키 자격 증명 모음에서 키의 새 버전을 만듭니다. 키/만들기 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
// Create an elliptic-curve key:
let result = await client.createKey("MyKey", "EC");

새 키를 만들고 저장한 다음 키 매개 변수 및 속성을 클라이언트에 반환합니다.

function createKey(name: string, keyType: string, options?: CreateKeyOptions): Promise<KeyVaultKey>

매개 변수

name

string

키의 이름입니다.

keyType

string

키의 형식입니다. 다음 중 하나: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'.

options
CreateKeyOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultKey>

createOctKey(string, CreateOctKeyOptions)

createOctKey 메서드는 Azure Key Vault 새 OCT 키를 만듭니다. 명명된 키가 이미 있으면 Azure 키 자격 증명 모음에서 키의 새 버전을 만듭니다. 키/만들기 권한이 필요합니다.

사용 예제:

let client = new KeyClient(url, credentials);
let result = await client.createOctKey("MyKey", { hsm: true });

새 키를 만들고 저장한 다음 키 매개 변수 및 속성을 클라이언트에 반환합니다.

function createOctKey(name: string, options?: CreateOctKeyOptions): Promise<KeyVaultKey>

매개 변수

name

string

키의 이름입니다.

options
CreateOctKeyOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultKey>

createRsaKey(string, CreateRsaKeyOptions)

createRSAKey 메서드는 Azure Key Vault 새 RSA 키를 만듭니다. 명명된 키가 이미 있으면 Azure 키 자격 증명 모음에서 키의 새 버전을 만듭니다. 키/만들기 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
let result = await client.createRsaKey("MyKey", { keySize: 2048 });

새 키를 만들고 저장한 다음 키 매개 변수 및 속성을 클라이언트에 반환합니다.

function createRsaKey(name: string, options?: CreateRsaKeyOptions): Promise<KeyVaultKey>

매개 변수

name

string

키의 이름입니다.

options
CreateRsaKeyOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultKey>

getCryptographyClient(string, GetCryptographyClientOptions)

지정된 키에 대한 CryptographyClient 를 가져옵니다.

예제 사용법:

let client = new KeyClient(url, credentials);
// get a cryptography client for a given key
let cryptographyClient = client.getCryptographyClient("MyKey");

function getCryptographyClient(keyName: string, options?: GetCryptographyClientOptions): CryptographyClient

매개 변수

keyName

string

options
GetCryptographyClientOptions

반환

CryptographyClient

getDeletedKey(string, GetDeletedKeyOptions)

getDeletedKey 메서드는 지정된 삭제된 키와 해당 속성을 반환합니다. 이 작업을 수행하려면 키/가져오기 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
let key = await client.getDeletedKey("MyDeletedKey");

지정된 삭제된 키를 가져옵니다.

function getDeletedKey(name: string, options?: GetDeletedKeyOptions): Promise<DeletedKey>

매개 변수

name

string

키의 이름입니다.

options
GetDeletedKeyOptions

선택적 매개 변수입니다.

반환

Promise<DeletedKey>

getKey(string, GetKeyOptions)

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

사용 예제:

let client = new KeyClient(url, credentials);
let key = await client.getKey("MyKey");

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

function getKey(name: string, options?: GetKeyOptions): Promise<KeyVaultKey>

매개 변수

name

string

키의 이름입니다.

options
GetKeyOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultKey>

getKeyRotationPolicy(string, GetKeyRotationPolicyOptions)

Key Vault 키의 회전 정책을 가져옵니다. 기본적으로 모든 키에는 만료 30일 전에 알리는 정책이 있습니다.

이 작업을 수행하려면 키/가져오기 권한이 필요합니다. 예제 사용법:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.getKeyRotationPolicy("myKey");

function getKeyRotationPolicy(keyName: string, options?: GetKeyRotationPolicyOptions): Promise<KeyRotationPolicy>

매개 변수

keyName

string

키의 이름입니다.

options
GetKeyRotationPolicyOptions

선택적 매개 변수입니다.

반환

Promise<KeyRotationPolicy>

getRandomBytes(number, GetRandomBytesOptions)

관리되는 HSM에서 임의 값을 포함하는 요청된 바이트 수를 가져옵니다. 이 작업을 수행하려면 managedHsm/rng 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(vaultUrl, credentials);
let { bytes } = await client.getRandomBytes(10);

function getRandomBytes(count: number, options?: GetRandomBytesOptions): Promise<Uint8Array>

매개 변수

count

number

1에서 128 사이를 생성할 바이트 수입니다.

options
GetRandomBytesOptions

선택적 매개 변수입니다.

반환

Promise<Uint8Array>

importKey(string, JsonWebKey_2, ImportKeyOptions)

키 가져오기 작업은 모든 키 형식을 Azure Key Vault 가져오는 데 사용할 수 있습니다. 명명된 키가 이미 있으면 Azure 키 자격 증명 모음에서 키의 새 버전을 만듭니다. 이 작업을 수행하려면 키/가져오기 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
// Key contents in myKeyContents
let result = await client.importKey("MyKey", myKeyContents);

외부에서 만든 키를 가져오고 저장한 다음 키 매개 변수 및 속성을 클라이언트에 반환합니다.

function importKey(name: string, key: JsonWebKey_2, options?: ImportKeyOptions): Promise<KeyVaultKey>

매개 변수

name

string

가져온 키의 이름입니다.

key
JsonWebKey

JSON 웹 키입니다.

options
ImportKeyOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultKey>

listDeletedKeys(ListDeletedKeysOptions)

자격 증명 모음에서 삭제된 키를 반복합니다. 전체 키 식별자 및 속성은 응답에 제공됩니다. 키에 대한 값이 반환되지 않습니다. 이 작업을 수행하려면 키/목록 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
for await (const deletedKey of client.listDeletedKeys()) {
  console.log("deleted key: ", deletedKey);
}

자격 증명 모음의 모든 키 나열

function listDeletedKeys(options?: ListDeletedKeysOptions): PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

매개 변수

options
ListDeletedKeysOptions

선택적 매개 변수입니다.

반환

PagedAsyncIterableIterator<DeletedKey, DeletedKey[], PageSettings>

listPropertiesOfKeys(ListPropertiesOfKeysOptions)

자격 증명 모음에 있는 모든 키의 최신 버전을 반복합니다. 전체 키 식별자 및 속성은 응답에 제공됩니다. 키에 대한 값이 반환되지 않습니다. 이 작업을 수행하려면 키/목록 권한이 필요합니다.

사용 예제:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeys()) {
  const key = await client.getKey(keyProperties.name);
  console.log("key: ", key);
}

자격 증명 모음의 모든 키 나열

function listPropertiesOfKeys(options?: ListPropertiesOfKeysOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

매개 변수

options
ListPropertiesOfKeysOptions

선택적 매개 변수입니다.

반환

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)

자격 증명 모음에서 지정된 키의 모든 버전을 반복합니다. 전체 키 식별자, 속성 및 태그는 응답에 제공됩니다. 이 작업을 수행하려면 키/목록 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
for await (const keyProperties of client.listPropertiesOfKeyVersions("MyKey")) {
  const key = await client.getKey(keyProperties.name);
  console.log("key version: ", key);
}

function listPropertiesOfKeyVersions(name: string, options?: ListPropertiesOfKeyVersionsOptions): PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

매개 변수

name

string

버전을 가져올 키의 이름

options
ListPropertiesOfKeyVersionsOptions

선택적 매개 변수입니다.

반환

PagedAsyncIterableIterator<KeyProperties, KeyProperties[], PageSettings>

purgeDeletedKey(string, PurgeDeletedKeyOptions)

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

예제 사용법:

const client = new KeyClient(url, credentials);
const deletePoller = await client.beginDeleteKey("MyKey")
await deletePoller.pollUntilDone();
await client.purgeDeletedKey("MyKey");

지정된 키를 영구적으로 삭제합니다.

function purgeDeletedKey(name: string, options?: PurgeDeletedKeyOptions): Promise<void>

매개 변수

name

string

키의 이름입니다.

options
PurgeDeletedKeyOptions

선택적 매개 변수입니다.

반환

Promise<void>

releaseKey(string, string, ReleaseKeyOptions)

관리되는 HSM에서 키를 해제합니다.

릴리스 키 작업은 모든 키 형식에 적용할 수 있습니다. 작업을 수행하려면 키를 내보낼 수 있는 것으로 표시하고 키/해제 권한을 부여해야 합니다.

사용 예제:

let client = new KeyClient(vaultUrl, credentials);
let result = await client.releaseKey("myKey", target)

function releaseKey(name: string, targetAttestationToken: string, options?: ReleaseKeyOptions): Promise<ReleaseKeyResult>

매개 변수

name

string

키의 이름입니다.

targetAttestationToken

string

키 릴리스의 대상에 대한 증명 어설션입니다.

options
ReleaseKeyOptions

선택적 매개 변수입니다.

반환

Promise<ReleaseKeyResult>

restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)

백업된 키와 모든 버전을 자격 증명 모음으로 복원합니다. 이 작업을 수행하려면 키/복원 권한이 필요합니다.

예제 사용법:

let client = new KeyClient(url, credentials);
let backupContents = await client.backupKey("MyKey");
// ...
let key = await client.restoreKeyBackup(backupContents);

백업된 키를 자격 증명 모음에 복원합니다.

function restoreKeyBackup(backup: Uint8Array, options?: RestoreKeyBackupOptions): Promise<KeyVaultKey>

매개 변수

backup

Uint8Array

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

options
RestoreKeyBackupOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultKey>

rotateKey(string, RotateKeyOptions)

키의 새 버전을 생성하여 키 정책에 따라 키를 회전합니다. 이 작업을 수행하려면 키/회전 권한이 필요합니다.

사용 예제:

let client = new KeyClient(vaultUrl, credentials);
let key = await client.rotateKey("MyKey");

function rotateKey(name: string, options?: RotateKeyOptions): Promise<KeyVaultKey>

매개 변수

name

string

회전할 키의 이름입니다.

options
RotateKeyOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultKey>

updateKeyProperties(string, string, UpdateKeyPropertiesOptions)

updateKeyProperties 메서드는 기존 저장된 키의 지정된 속성을 변경합니다. 요청에 지정되지 않은 속성은 변경되지 않은 상태로 유지됩니다. 키 자체의 값을 변경할 수 없습니다. 이 작업을 수행하려면 키/설정 권한이 필요합니다.

예제 사용법:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, key.properties.version, { enabled: false });

지정된 키 자격 증명 모음에서 지정된 키와 연결된 속성을 업데이트.

function updateKeyProperties(name: string, keyVersion: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>

매개 변수

name

string

키의 이름입니다.

keyVersion

string

키의 버전입니다.

options
UpdateKeyPropertiesOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultKey>

updateKeyProperties(string, UpdateKeyPropertiesOptions)

updateKeyProperties 메서드는 기존 저장된 키의 최신 버전의 지정된 속성을 변경합니다. 요청에 지정되지 않은 속성은 변경되지 않은 상태로 유지됩니다. 키 자체의 값을 변경할 수 없습니다. 이 작업을 수행하려면 키/설정 권한이 필요합니다.

예제 사용법:

let keyName = "MyKey";
let client = new KeyClient(vaultUrl, credentials);
let key = await client.getKey(keyName);
let result = await client.updateKeyProperties(keyName, { enabled: false });

지정된 키 자격 증명 모음에서 지정된 키와 연결된 속성을 업데이트.

function updateKeyProperties(name: string, options?: UpdateKeyPropertiesOptions): Promise<KeyVaultKey>

매개 변수

name

string

키의 이름입니다.

options
UpdateKeyPropertiesOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultKey>

updateKeyRotationPolicy(string, KeyRotationPolicyProperties, UpdateKeyRotationPolicyOptions)

Key Vault 키의 회전 정책을 업데이트. 이 작업을 수행하려면 키/업데이트 권한이 필요합니다.

사용 예제:

let client = new KeyClient(vaultUrl, credentials);
const setPolicy = await client.updateKeyRotationPolicy("MyKey", myPolicy);

function updateKeyRotationPolicy(keyName: string, policy: KeyRotationPolicyProperties, options?: UpdateKeyRotationPolicyOptions): Promise<KeyRotationPolicy>

매개 변수

keyName

string

키의 이름입니다.

policy
KeyRotationPolicyProperties
options
UpdateKeyRotationPolicyOptions

선택적 매개 변수입니다.

반환

Promise<KeyRotationPolicy>