Partilhar via

KeyVaultAccessControlClient class

  • Referência
Pacote:
@azure/keyvault-admin

O KeyVaultAccessControlClient fornece métodos para gerir atribuições de funções e controlo de acesso em qualquer instância do Azure Key Vault. O cliente suporta a criação, obtenção e eliminação de funções.

Construtores

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Cria uma instância do KeyVaultAccessControlClient.

Utilização de exemplo: 

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

Propriedades

vaultUrl

O URL base para o cofre

Métodos

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

Cria uma atribuição de função num Key Vault do Azure.

Utilização de exemplo: 

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

Cria uma nova atribuição de função.
deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Elimina atribuições de funções criadas anteriormente numa Key Vault do Azure.

Utilização de exemplo: 

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

Elimina uma atribuição de função existente.
deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Elimina uma definição de função personalizada criada anteriormente numa Key Vault do Azure.

Utilização de exemplo: 

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)

Obtém atribuições de funções criadas anteriormente numa Key Vault do Azure.

Utilização de exemplo: 

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

Obtém uma atribuição de função existente.
getRoleDefinition(string, string, GetRoleDefinitionOptions)

Obtém uma definição de função do Azure Key Vault.

Utilização de exemplo: 

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

Itera todas as atribuições de funções disponíveis num Key Vault do Azure.

Utilização de exemplo: 

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

Lista todas as atribuições de funções num determinado âmbito.
listRoleDefinitions(string, ListRoleDefinitionsOptions)

Itera todas as definições de função disponíveis num Key Vault do Azure.

Utilização de exemplo: 

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

Lista toda a definição de função num determinado âmbito.
setRoleDefinition(string, SetRoleDefinitionOptions)

Cria ou atualiza uma definição de função num Key Vault do Azure.

Utilização de exemplo: 

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

Detalhes do Construtor

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Cria uma instância do KeyVaultAccessControlClient.

Utilização de exemplo: 

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)

Parâmetros

vaultUrl

string

o URL do Key Vault. Deve ter esta forma: https://${your-key-vault-name}.vault.azure.net. Deve validar que este URL faz referência a um recurso de Key Vault ou HSM gerido válido. Veja https://aka.ms/azsdk/blog/vault-uri para obter detalhes.

credential
TokenCredential

Um objeto que implementa a TokenCredential interface utilizada para autenticar pedidos no serviço. Utilize o @azure/identity pacote para criar uma credencial que se adeque às suas necessidades.

options
AccessControlClientOptions

Opções utilizadas para configurar pedidos de API Key Vault. Omita este parâmetro para utilizar a configuração predefinida.

Detalhes de Propriedade

vaultUrl

O URL base para o cofre

vaultUrl: string

Valor de Propriedade

string

Detalhes de Método

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

Cria uma atribuição de função num Key Vault do Azure.

Utilização de exemplo: 

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

Cria uma nova atribuição de função.

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

Parâmetros

roleScope

string

O âmbito da atribuição de função.

name

string

O nome da atribuição de função. Tem de ser um UUID.

roleDefinitionId

string

O ID de definição de função utilizado na atribuição de função.

principalId

string

O ID principal atribuído à função. Esta ação mapeia para o ID no Active Directory. Pode apontar para um utilizador, principal de serviço ou grupo de segurança.

options
CreateRoleAssignmentOptions

Os parâmetros opcionais.

Devoluções

Promise<KeyVaultRoleAssignment>

deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Elimina atribuições de funções criadas anteriormente numa Key Vault do Azure.

Utilização de exemplo: 

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

Elimina uma atribuição de função existente.

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

Parâmetros

roleScope

string

O âmbito da atribuição de função.

name

string

O nome da atribuição de função.

options
DeleteRoleAssignmentOptions

Os parâmetros opcionais.

Devoluções

Promise<void>

deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Elimina uma definição de função personalizada criada anteriormente numa Key Vault do Azure.

Utilização de exemplo: 

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>

Parâmetros

roleScope

string

O âmbito da definição de função.

name

string

O nome da definição de função a eliminar.

options
DeleteRoleDefinitionOptions

Os parâmetros opcionais.

Devoluções

Promise<void>

getRoleAssignment(string, string, GetRoleAssignmentOptions)

Obtém atribuições de funções criadas anteriormente numa Key Vault do Azure.

Utilização de exemplo: 

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

Obtém uma atribuição de função existente.

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

Parâmetros

roleScope

string

O âmbito da atribuição de função.

name

string

O nome da atribuição de função.

options
GetRoleAssignmentOptions

Os parâmetros opcionais.

Devoluções

Promise<KeyVaultRoleAssignment>

getRoleDefinition(string, string, GetRoleDefinitionOptions)

Obtém uma definição de função do Azure Key Vault.

Utilização de exemplo: 

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>

Parâmetros

roleScope

string

O âmbito da definição de função.

name

string

O nome da definição de função.

options
GetRoleDefinitionOptions

Os parâmetros opcionais.

Devoluções

Promise<KeyVaultRoleDefinition>

listRoleAssignments(string, ListRoleAssignmentsOptions)

Itera todas as atribuições de funções disponíveis num Key Vault do Azure.

Utilização de exemplo: 

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

Lista todas as atribuições de funções num determinado âmbito.

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

Parâmetros

roleScope

string

O âmbito das atribuições de funções.

options
ListRoleAssignmentsOptions

Os parâmetros opcionais.

Devoluções

PagedAsyncIterableIterator<KeyVaultRoleAssignment, KeyVaultRoleAssignment[], PageSettings>

listRoleDefinitions(string, ListRoleDefinitionsOptions)

Itera todas as definições de função disponíveis num Key Vault do Azure.

Utilização de exemplo: 

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

Lista toda a definição de função num determinado âmbito.

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

Parâmetros

roleScope

string

O âmbito da definição de função.

options
ListRoleDefinitionsOptions

Os parâmetros opcionais.

Devoluções

PagedAsyncIterableIterator<KeyVaultRoleDefinition, KeyVaultRoleDefinition[], PageSettings>

setRoleDefinition(string, SetRoleDefinitionOptions)

Cria ou atualiza uma definição de função num Key Vault do Azure.

Utilização de exemplo: 

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>

Parâmetros

roleScope

string

O âmbito da definição de função.

options
SetRoleDefinitionOptions

Os parâmetros opcionais.

Devoluções

Promise<KeyVaultRoleDefinition>