KeyVaultAccessControlClient class

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

KeyVaultAccessControlClient는 지정된 Azure Key Vault 인스턴스에서 액세스 제어 및 역할 할당을 관리하는 메서드를 제공합니다. 클라이언트는 역할 만들기, 검색 및 삭제를 지원합니다.

생성자

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

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

사용 예제:

import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";
import { DefaultAzureCredential } from "@azure/identity";

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

let client = new KeyVaultAccessControlClient(vaultUrl, credentials);

속성

vaultUrl

자격 증명 모음의 기본 URL

메서드

createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)

Azure Key Vault 역할 할당을 만듭니다.

사용 예제:

const client = new KeyVaultAccessControlClient(url, credentials);
const roleDefinition = await client.listRoleDefinitions("/").next();
const principalId = "4871f6a6-374f-4b6b-8b0c-f5d84db823f6";
const result = await client.createRoleAssignment("/", "295c179b-9ad3-4117-99cd-b1aa66cf4517", roleDefinition, principalId);

새 역할 할당을 만듭니다.
deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

이전에 Azure Key Vault 만든 역할 할당을 삭제합니다.

예제 사용법:

const client = new KeyVaultAccessControlClient(url, credentials);
const roleAssignment = await client.createRoleAssignment("/", "295c179b-9ad3-4117-99cd-b1aa66cf4517");
await client.deleteRoleAssignment(roleAssignment.properties.roleScope, roleAssignment.name);

기존 역할 할당을 삭제합니다.
deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Azure Key Vault 이전에 만든 사용자 지정 역할 정의를 삭제합니다.

사용 예제:

const client = new KeyVaultAccessControlClient(url, credentials);
const roleDefinition = await client.setRoleDefinition("/", "23b8bb1a-39c0-4c89-a85b-dd3c99273a8a", []);
await client.deleteRoleDefinition("/", roleDefinition.name);
getRoleAssignment(string, string, GetRoleAssignmentOptions)

Azure Key Vault 이전에 만든 역할 할당을 가져옵니다.

예제 사용법:

const client = new KeyVaultAccessControlClient(url, credentials);
let roleAssignment = await client.createRoleAssignment("/", "295c179b-9ad3-4117-99cd-b1aa66cf4517");
roleAssignment = const await client.getRoleAssignment(roleAssignment.properties.roleScope, roleAssignment.name);
console.log(roleAssignment);

기존 역할 할당을 가져옵니다.
getRoleDefinition(string, string, GetRoleDefinitionOptions)

Azure Key Vault 역할 정의를 가져옵니다.

예제 사용법:

const client = new KeyVaultAccessControlClient(url, credentials);
const roleDefinition = await client.getRoleDefinition("/", "b86a8fe4-44ce-4948-aee5-eccb2c155cd7");
console.log(roleDefinition);
listRoleAssignments(string, ListRoleAssignmentsOptions)

Azure Key Vault 사용 가능한 모든 역할 할당을 반복합니다.

예제 사용법:

let client = new KeyVaultAccessControlClient(url, credentials);
for await (const roleAssignment of client.listRoleAssignments("/")) {
  console.log("Role assignment: ", roleAssignment);
}

지정된 범위의 모든 역할 할당을 나열합니다.
listRoleDefinitions(string, ListRoleDefinitionsOptions)

Azure Key Vault 사용 가능한 모든 역할 정의를 반복합니다.

예제 사용법:

let client = new KeyVaultAccessControlClient(url, credentials);
for await (const roleDefinitions of client.listRoleDefinitions("/")) {
  console.log("Role definition: ", roleDefinitions);
}

지정된 범위의 모든 역할 정의를 나열합니다.
setRoleDefinition(string, SetRoleDefinitionOptions)

Azure Key Vault 역할 정의를 만들거나 업데이트합니다.

예제 사용법:

const client = new KeyVaultAccessControlClient(url, credentials);
const permissions = [{ dataActions: [KnownKeyVaultDataAction.BackupHsmKeys] }];
const roleDefinitionName = "23b8bb1a-39c0-4c89-a85b-dd3c99273a8a";
const roleDefinition = await client.setRoleDefinition(KnownKeyVaultRoleScope.Global, { permissions, roleDefinitionName });
console.log(roleDefinition);

생성자 세부 정보

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

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

사용 예제:

import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";
import { DefaultAzureCredential } from "@azure/identity";

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

let client = new KeyVaultAccessControlClient(vaultUrl, credentials);

new KeyVaultAccessControlClient(vaultUrl: string, credential: TokenCredential, options?: AccessControlClientOptions)

매개 변수

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
AccessControlClientOptions

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

속성 세부 정보

vaultUrl

자격 증명 모음의 기본 URL

vaultUrl: string

속성 값

string

메서드 세부 정보

createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)

Azure Key Vault 역할 할당을 만듭니다.

사용 예제:

const client = new KeyVaultAccessControlClient(url, credentials);
const roleDefinition = await client.listRoleDefinitions("/").next();
const principalId = "4871f6a6-374f-4b6b-8b0c-f5d84db823f6";
const result = await client.createRoleAssignment("/", "295c179b-9ad3-4117-99cd-b1aa66cf4517", roleDefinition, principalId);

새 역할 할당을 만듭니다.

function createRoleAssignment(roleScope: string, name: string, roleDefinitionId: string, principalId: string, options?: CreateRoleAssignmentOptions): Promise<KeyVaultRoleAssignment>

매개 변수

roleScope

string

역할 할당의 범위입니다.

name

string

역할 할당의 이름입니다. UUID여야 합니다.

roleDefinitionId

string

역할 할당에 사용되는 역할 정의 ID입니다.

principalId

string

역할에 할당된 보안 주체 ID입니다. Active Directory 내의 ID에 매핑됩니다. 사용자, 서비스 주체 또는 보안 그룹을 가리킬 수 있습니다.

options
CreateRoleAssignmentOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultRoleAssignment>

deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

이전에 Azure Key Vault 만든 역할 할당을 삭제합니다.

예제 사용법:

const client = new KeyVaultAccessControlClient(url, credentials);
const roleAssignment = await client.createRoleAssignment("/", "295c179b-9ad3-4117-99cd-b1aa66cf4517");
await client.deleteRoleAssignment(roleAssignment.properties.roleScope, roleAssignment.name);

기존 역할 할당을 삭제합니다.

function deleteRoleAssignment(roleScope: string, name: string, options?: DeleteRoleAssignmentOptions): Promise<void>

매개 변수

roleScope

string

역할 할당의 범위입니다.

name

string

역할 할당의 이름입니다.

options
DeleteRoleAssignmentOptions

선택적 매개 변수입니다.

반환

Promise<void>

deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Azure Key Vault 이전에 만든 사용자 지정 역할 정의를 삭제합니다.

사용 예제:

const client = new KeyVaultAccessControlClient(url, credentials);
const roleDefinition = await client.setRoleDefinition("/", "23b8bb1a-39c0-4c89-a85b-dd3c99273a8a", []);
await client.deleteRoleDefinition("/", roleDefinition.name);

function deleteRoleDefinition(roleScope: string, name: string, options?: DeleteRoleDefinitionOptions): Promise<void>

매개 변수

roleScope

string

역할 정의의 범위입니다.

name

string

삭제할 역할 정의의 이름입니다.

options
DeleteRoleDefinitionOptions

선택적 매개 변수입니다.

반환

Promise<void>

getRoleAssignment(string, string, GetRoleAssignmentOptions)

Azure Key Vault 이전에 만든 역할 할당을 가져옵니다.

예제 사용법:

const client = new KeyVaultAccessControlClient(url, credentials);
let roleAssignment = await client.createRoleAssignment("/", "295c179b-9ad3-4117-99cd-b1aa66cf4517");
roleAssignment = const await client.getRoleAssignment(roleAssignment.properties.roleScope, roleAssignment.name);
console.log(roleAssignment);

기존 역할 할당을 가져옵니다.

function getRoleAssignment(roleScope: string, name: string, options?: GetRoleAssignmentOptions): Promise<KeyVaultRoleAssignment>

매개 변수

roleScope

string

역할 할당의 범위입니다.

name

string

역할 할당의 이름입니다.

options
GetRoleAssignmentOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultRoleAssignment>

getRoleDefinition(string, string, GetRoleDefinitionOptions)

Azure Key Vault 역할 정의를 가져옵니다.

예제 사용법:

const client = new KeyVaultAccessControlClient(url, credentials);
const roleDefinition = await client.getRoleDefinition("/", "b86a8fe4-44ce-4948-aee5-eccb2c155cd7");
console.log(roleDefinition);

function getRoleDefinition(roleScope: string, name: string, options?: GetRoleDefinitionOptions): Promise<KeyVaultRoleDefinition>

매개 변수

roleScope

string

역할 정의의 범위입니다.

name

string

역할 정의의 이름.

options
GetRoleDefinitionOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultRoleDefinition>

listRoleAssignments(string, ListRoleAssignmentsOptions)

Azure Key Vault 사용 가능한 모든 역할 할당을 반복합니다.

예제 사용법:

let client = new KeyVaultAccessControlClient(url, credentials);
for await (const roleAssignment of client.listRoleAssignments("/")) {
  console.log("Role assignment: ", roleAssignment);
}

지정된 범위의 모든 역할 할당을 나열합니다.

function listRoleAssignments(roleScope: string, options?: ListRoleAssignmentsOptions): PagedAsyncIterableIterator<KeyVaultRoleAssignment, KeyVaultRoleAssignment[], PageSettings>

매개 변수

roleScope

string

역할 할당의 범위입니다.

options
ListRoleAssignmentsOptions

선택적 매개 변수입니다.

반환

PagedAsyncIterableIterator<KeyVaultRoleAssignment, KeyVaultRoleAssignment[], PageSettings>

listRoleDefinitions(string, ListRoleDefinitionsOptions)

Azure Key Vault 사용 가능한 모든 역할 정의를 반복합니다.

예제 사용법:

let client = new KeyVaultAccessControlClient(url, credentials);
for await (const roleDefinitions of client.listRoleDefinitions("/")) {
  console.log("Role definition: ", roleDefinitions);
}

지정된 범위의 모든 역할 정의를 나열합니다.

function listRoleDefinitions(roleScope: string, options?: ListRoleDefinitionsOptions): PagedAsyncIterableIterator<KeyVaultRoleDefinition, KeyVaultRoleDefinition[], PageSettings>

매개 변수

roleScope

string

역할 정의의 범위입니다.

options
ListRoleDefinitionsOptions

선택적 매개 변수입니다.

반환

PagedAsyncIterableIterator<KeyVaultRoleDefinition, KeyVaultRoleDefinition[], PageSettings>

setRoleDefinition(string, SetRoleDefinitionOptions)

Azure Key Vault 역할 정의를 만들거나 업데이트합니다.

예제 사용법:

const client = new KeyVaultAccessControlClient(url, credentials);
const permissions = [{ dataActions: [KnownKeyVaultDataAction.BackupHsmKeys] }];
const roleDefinitionName = "23b8bb1a-39c0-4c89-a85b-dd3c99273a8a";
const roleDefinition = await client.setRoleDefinition(KnownKeyVaultRoleScope.Global, { permissions, roleDefinitionName });
console.log(roleDefinition);

function setRoleDefinition(roleScope: string, options?: SetRoleDefinitionOptions): Promise<KeyVaultRoleDefinition>

매개 변수

roleScope

string

역할 정의의 범위입니다.

options
SetRoleDefinitionOptions

선택적 매개 변수입니다.

반환

Promise<KeyVaultRoleDefinition>