Sdílet prostřednictvím

KeyVaultAccessControlClient class

  • Reference
Balíček:
@azure/keyvault-admin

KeyVaultAccessControlClient poskytuje metody pro správu řízení přístupu a přiřazení rolí v libovolné instanci Azure Key Vault. Klient podporuje vytváření, načítání a odstraňování rolí.

Konstruktory

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Vytvoří instanci KeyVaultAccessControlClient.

Příklad použití:

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

Vlastnosti

vaultUrl

Základní adresa URL trezoru

Metody

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

Vytvoří přiřazení role v Key Vault Azure.

Příklad použití:

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

Vytvoří nové přiřazení role.
deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Odstraní přiřazení rolí dříve vytvořená v azure Key Vault.

Příklad použití:

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

Odstraní existující přiřazení role.
deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Odstraní definici vlastní role dříve vytvořenou v azure Key Vault.

Příklad použití:

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)

Získá přiřazení role, která byla dříve vytvořena v azure Key Vault.

Příklad použití:

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

Získá existující přiřazení role.
getRoleDefinition(string, string, GetRoleDefinitionOptions)

Získá definici role z Azure Key Vault.

Příklad použití:

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

Iteruje všechna dostupná přiřazení rolí v azure Key Vault.

Příklad použití:

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

Zobrazí seznam všech přiřazení rolí v daném oboru.
listRoleDefinitions(string, ListRoleDefinitionsOptions)

Iteruje všechny dostupné definice rolí v Azure Key Vault.

Příklad použití:

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

Zobrazí seznam všech definic rolí v daném oboru.
setRoleDefinition(string, SetRoleDefinitionOptions)

Vytvoří nebo aktualizuje definici role v azure Key Vault.

Příklad použití:

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

Podrobnosti konstruktoru

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Vytvoří instanci KeyVaultAccessControlClient.

Příklad použití:

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)

Parametry

vaultUrl

string

adresa URL Key Vault. Měla by mít tento tvar: https://${your-key-vault-name}.vault.azure.net. Měli byste ověřit, že tato adresa URL odkazuje na platný prostředek Key Vault nebo spravovaného HSM. Podrobnosti viz https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Objekt, který implementuje TokenCredential rozhraní používané k ověřování požadavků na službu. @azure/identity Pomocí balíčku vytvořte přihlašovací údaje, které budou vyhovovat vašim potřebám.

options
AccessControlClientOptions

Možnosti používané ke konfiguraci požadavků rozhraní API Key Vault. Pokud chcete použít výchozí konfiguraci, tento parametr vynecháte.

Podrobnosti vlastnosti

vaultUrl

Základní adresa URL trezoru

vaultUrl: string

Hodnota vlastnosti

string

Podrobnosti metody

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

Vytvoří přiřazení role v Key Vault Azure.

Příklad použití:

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

Vytvoří nové přiřazení role.

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

Parametry

roleScope

string

Obor přiřazení role.

name

string

Název přiřazení role. Musí to být UUID.

roleDefinitionId

string

ID definice role použité v přiřazení role.

principalId

string

ID objektu zabezpečení přiřazené roli. To se mapuje na ID ve službě Active Directory. Může odkazovat na uživatele, instanční objekt nebo skupinu zabezpečení.

options
CreateRoleAssignmentOptions

Volitelné parametry.

Návraty

Promise<KeyVaultRoleAssignment>

deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Odstraní přiřazení rolí dříve vytvořená v azure Key Vault.

Příklad použití:

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

Odstraní existující přiřazení role.

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

Parametry

roleScope

string

Obor přiřazení role.

name

string

Název přiřazení role.

options
DeleteRoleAssignmentOptions

Volitelné parametry.

Návraty

Promise<void>

deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Odstraní definici vlastní role dříve vytvořenou v azure Key Vault.

Příklad použití:

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>

Parametry

roleScope

string

Obor definice role.

name

string

Název definice role, která se má odstranit.

options
DeleteRoleDefinitionOptions

Volitelné parametry.

Návraty

Promise<void>

getRoleAssignment(string, string, GetRoleAssignmentOptions)

Získá přiřazení role, která byla dříve vytvořena v azure Key Vault.

Příklad použití:

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

Získá existující přiřazení role.

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

Parametry

roleScope

string

Obor přiřazení role.

name

string

Název přiřazení role.

options
GetRoleAssignmentOptions

Volitelné parametry.

Návraty

Promise<KeyVaultRoleAssignment>

getRoleDefinition(string, string, GetRoleDefinitionOptions)

Získá definici role z Azure Key Vault.

Příklad použití:

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>

Parametry

roleScope

string

Obor definice role.

name

string

Název definice role.

options
GetRoleDefinitionOptions

Volitelné parametry.

Návraty

Promise<KeyVaultRoleDefinition>

listRoleAssignments(string, ListRoleAssignmentsOptions)

Iteruje všechna dostupná přiřazení rolí v azure Key Vault.

Příklad použití:

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

Zobrazí seznam všech přiřazení rolí v daném oboru.

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

Parametry

roleScope

string

Rozsah přiřazení rolí.

options
ListRoleAssignmentsOptions

Volitelné parametry.

Návraty

PagedAsyncIterableIterator<KeyVaultRoleAssignment, KeyVaultRoleAssignment[], PageSettings>

listRoleDefinitions(string, ListRoleDefinitionsOptions)

Iteruje všechny dostupné definice rolí v Azure Key Vault.

Příklad použití:

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

Zobrazí seznam všech definic rolí v daném oboru.

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

Parametry

roleScope

string

Obor definice role.

options
ListRoleDefinitionsOptions

Volitelné parametry.

Návraty

PagedAsyncIterableIterator<KeyVaultRoleDefinition, KeyVaultRoleDefinition[], PageSettings>

setRoleDefinition(string, SetRoleDefinitionOptions)

Vytvoří nebo aktualizuje definici role v azure Key Vault.

Příklad použití:

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>

Parametry

roleScope

string

Obor definice role.

options
SetRoleDefinitionOptions

Volitelné parametry.

Návraty

Promise<KeyVaultRoleDefinition>