Compartilhar via

KeyVaultAccessControlClient class

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

O KeyVaultAccessControlClient fornece métodos para gerenciar atribuições de controle de acesso e função em qualquer instância de Key Vault do Azure. O cliente dá suporte à criação, recuperação e exclusão de funções.

Construtores

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Cria uma instância do KeyVaultAccessControlClient.

Exemplo de uso:

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

A URL base para o cofre

Métodos

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

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

Exemplo de uso:

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)

Exclui atribuições de função criadas anteriormente em um Key Vault do Azure.

Exemplo de uso:

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

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

Exclui uma definição de função personalizada criada anteriormente em um Key Vault do Azure.

Exemplo de uso:

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ção criadas anteriormente em um Key Vault do Azure.

Exemplo de uso:

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.

Exemplo de uso:

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

Itera em todas as atribuições de função disponíveis em um Key Vault do Azure.

Exemplo de uso:

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ção em um determinado escopo.
listRoleDefinitions(string, ListRoleDefinitionsOptions)

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

Exemplo de uso:

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 em um determinado escopo.
setRoleDefinition(string, SetRoleDefinitionOptions)

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

Exemplo de uso:

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.

Exemplo de uso:

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

a URL do Key Vault. Ele deve ter esta forma: https://${your-key-vault-name}.vault.azure.net. Você deve validar se essa URL faz referência a um recurso de Key Vault ou HSM Gerenciado válido. Para obter detalhes, consulte https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Um objeto que implementa a TokenCredential interface usada para autenticar solicitações para o serviço. Use o @azure/identity pacote para criar uma credencial que atenda às suas necessidades.

options
AccessControlClientOptions

Opções usadas para configurar Key Vault solicitações de API. Omita esse parâmetro para usar a configuração padrão.

Detalhes da propriedade

vaultUrl

A URL base para o cofre

vaultUrl: string

Valor da propriedade

string

Detalhes do método

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

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

Exemplo de uso:

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 escopo da atribuição de função.

name

string

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

roleDefinitionId

string

A ID de definição de função usada na atribuição de função.

principalId

string

A ID da entidade de segurança atribuída à função. Isso mapeia para a ID dentro do Active Directory. Ele pode apontar para um usuário, entidade de serviço ou grupo de segurança.

options
CreateRoleAssignmentOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultRoleAssignment>

deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Exclui atribuições de função criadas anteriormente em um Key Vault do Azure.

Exemplo de uso:

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

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

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

Parâmetros

roleScope

string

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

name

string

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

options
DeleteRoleAssignmentOptions

Os parâmetros opcionais.

Retornos

Promise<void>

deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Exclui uma definição de função personalizada criada anteriormente em um Key Vault do Azure.

Exemplo de uso:

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 escopo da definição de função.

name

string

O nome da definição de função a ser excluída.

options
DeleteRoleDefinitionOptions

Os parâmetros opcionais.

Retornos

Promise<void>

getRoleAssignment(string, string, GetRoleAssignmentOptions)

Obtém atribuições de função criadas anteriormente em um Key Vault do Azure.

Exemplo de uso:

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 escopo da atribuição de função.

name

string

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

options
GetRoleAssignmentOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultRoleAssignment>

getRoleDefinition(string, string, GetRoleDefinitionOptions)

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

Exemplo de uso:

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 escopo da definição de função.

name

string

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

options
GetRoleDefinitionOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultRoleDefinition>

listRoleAssignments(string, ListRoleAssignmentsOptions)

Itera em todas as atribuições de função disponíveis em um Key Vault do Azure.

Exemplo de uso:

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ção em um determinado escopo.

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

Parâmetros

roleScope

string

O escopo das atribuições de função.

options
ListRoleAssignmentsOptions

Os parâmetros opcionais.

Retornos

PagedAsyncIterableIterator<KeyVaultRoleAssignment, KeyVaultRoleAssignment[], PageSettings>

listRoleDefinitions(string, ListRoleDefinitionsOptions)

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

Exemplo de uso:

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 em um determinado escopo.

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

Parâmetros

roleScope

string

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

options
ListRoleDefinitionsOptions

Os parâmetros opcionais.

Retornos

PagedAsyncIterableIterator<KeyVaultRoleDefinition, KeyVaultRoleDefinition[], PageSettings>

setRoleDefinition(string, SetRoleDefinitionOptions)

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

Exemplo de uso:

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 escopo da definição de função.

options
SetRoleDefinitionOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultRoleDefinition>