Share via

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または Managed 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>