Megosztás a következőn keresztül:

KeyVaultAccessControlClient class

  • Referencia
Csomag:
@azure/keyvault-admin

A KeyVaultAccessControlClient metódusokat biztosít a hozzáférés-vezérlés és a szerepkör-hozzárendelések kezeléséhez bármely Azure-Key Vault-példányban. Az ügyfél támogatja a szerepkörök létrehozását, lekérését és törlését.

Konstruktorok

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Létrehozza a KeyVaultAccessControlClient egy példányát.

Példahasználat:

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);

Tulajdonságok

vaultUrl

A tároló alap URL-címe

Metódusok

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

Szerepkör-hozzárendelést hoz létre egy Azure-Key Vault.

Példahasználat:

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);

Új szerepkör-hozzárendelést hoz létre.
deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Törli az Azure-Key Vault korábban létrehozott szerepkör-hozzárendeléseket.

Példahasználat:

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

Töröl egy meglévő szerepkör-hozzárendelést.
deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Törli az Azure-Key Vault korábban létrehozott egyéni szerepkördefiníciót.

Példahasználat:

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)

Lekéri az Azure-Key Vault korábban létrehozott szerepkör-hozzárendeléseket.

Példahasználat:

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);

Lekéri a meglévő szerepkör-hozzárendelést.
getRoleDefinition(string, string, GetRoleDefinitionOptions)

Lekéri a szerepkördefiníciót az Azure Key Vault.

Példahasználat:

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

Iterálja az Azure-Key Vault összes rendelkezésre álló szerepkör-hozzárendelését.

Példahasználat:

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

Egy adott hatókör összes szerepkör-hozzárendelését felsorolja.
listRoleDefinitions(string, ListRoleDefinitionsOptions)

Iterálja az Azure-Key Vault összes rendelkezésre álló szerepkördefinícióját.

Példahasználat:

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

Egy adott hatókör összes szerepkördefinícióját felsorolja.
setRoleDefinition(string, SetRoleDefinitionOptions)

Szerepkördefiníciót hoz létre vagy frissít egy Azure-Key Vault.

Példahasználat:

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);

Konstruktor adatai

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Létrehozza a KeyVaultAccessControlClient egy példányát.

Példahasználat:

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)

Paraméterek

vaultUrl

string

a Key Vault URL-címe. Ennek az alakzatnak a következőnek kell lennie: https://${your-key-vault-name}.vault.azure.net. Ellenőrizze, hogy ez az URL érvényes Key Vault vagy felügyelt HSM-erőforrásra hivatkozik-e. További részletek: https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Egy objektum, amely a TokenCredential szolgáltatás kéréseinek hitelesítéséhez használt felületet implementálja. @azure/identity A csomag használatával hozzon létre egy, az igényeinek megfelelő hitelesítő adatot.

options
AccessControlClientOptions

A Key Vault API-kérések konfigurálásához használt beállítások. Kihagyja ezt a paramétert az alapértelmezett konfiguráció használatához.

Tulajdonság adatai

vaultUrl

A tároló alap URL-címe

vaultUrl: string

Tulajdonság értéke

string

Metódus adatai

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

Szerepkör-hozzárendelést hoz létre egy Azure-Key Vault.

Példahasználat:

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);

Új szerepkör-hozzárendelést hoz létre.

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

Paraméterek

roleScope

string

A szerepkör-hozzárendelés hatóköre.

name

string

A szerepkör-hozzárendelés neve. UUID azonosítónak kell lennie.

roleDefinitionId

string

A szerepkör-hozzárendelésben használt szerepkördefiníció-azonosító.

principalId

string

A szerepkörhöz rendelt egyszerű azonosító. Ez megfelel az Active Directoryban található azonosítónak. Egy felhasználóra, szolgáltatásnévre vagy biztonsági csoportra mutathat.

options
CreateRoleAssignmentOptions

A választható paraméterek.

Válaszok

Promise<KeyVaultRoleAssignment>

deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Törli az Azure-Key Vault korábban létrehozott szerepkör-hozzárendeléseket.

Példahasználat:

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

Töröl egy meglévő szerepkör-hozzárendelést.

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

Paraméterek

roleScope

string

A szerepkör-hozzárendelés hatóköre.

name

string

A szerepkör-hozzárendelés neve.

options
DeleteRoleAssignmentOptions

A választható paraméterek.

Válaszok

Promise<void>

deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Törli az Azure-Key Vault korábban létrehozott egyéni szerepkördefiníciót.

Példahasználat:

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>

Paraméterek

roleScope

string

A szerepkör-definíció hatóköre.

name

string

A törölni kívánt szerepkördefiníció neve.

options
DeleteRoleDefinitionOptions

A választható paraméterek.

Válaszok

Promise<void>

getRoleAssignment(string, string, GetRoleAssignmentOptions)

Lekéri az Azure-Key Vault korábban létrehozott szerepkör-hozzárendeléseket.

Példahasználat:

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);

Lekéri a meglévő szerepkör-hozzárendelést.

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

Paraméterek

roleScope

string

A szerepkör-hozzárendelés hatóköre.

name

string

A szerepkör-hozzárendelés neve.

options
GetRoleAssignmentOptions

A választható paraméterek.

Válaszok

Promise<KeyVaultRoleAssignment>

getRoleDefinition(string, string, GetRoleDefinitionOptions)

Lekéri a szerepkördefiníciót az Azure Key Vault.

Példahasználat:

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>

Paraméterek

roleScope

string

A szerepkör-definíció hatóköre.

name

string

A szerepkördefiníció neve.

options
GetRoleDefinitionOptions

A választható paraméterek.

Válaszok

Promise<KeyVaultRoleDefinition>

listRoleAssignments(string, ListRoleAssignmentsOptions)

Iterálja az Azure-Key Vault összes rendelkezésre álló szerepkör-hozzárendelését.

Példahasználat:

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

Egy adott hatókör összes szerepkör-hozzárendelését felsorolja.

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

Paraméterek

roleScope

string

A szerepkör-hozzárendelések hatóköre.

options
ListRoleAssignmentsOptions

A választható paraméterek.

Válaszok

PagedAsyncIterableIterator<KeyVaultRoleAssignment, KeyVaultRoleAssignment[], PageSettings>

listRoleDefinitions(string, ListRoleDefinitionsOptions)

Iterálja az Azure-Key Vault összes rendelkezésre álló szerepkördefinícióját.

Példahasználat:

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

Egy adott hatókör összes szerepkördefinícióját felsorolja.

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

Paraméterek

roleScope

string

A szerepkör-definíció hatóköre.

options
ListRoleDefinitionsOptions

A választható paraméterek.

Válaszok

PagedAsyncIterableIterator<KeyVaultRoleDefinition, KeyVaultRoleDefinition[], PageSettings>

setRoleDefinition(string, SetRoleDefinitionOptions)

Szerepkördefiníciót hoz létre vagy frissít egy Azure-Key Vault.

Példahasználat:

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>

Paraméterek

roleScope

string

A szerepkör-definíció hatóköre.

options
SetRoleDefinitionOptions

A választható paraméterek.

Válaszok

Promise<KeyVaultRoleDefinition>