Partilhar via


KeyVaultAccessControlClient class

O KeyVaultAccessControlClient fornece métodos para gerenciar o controle de acesso e as atribuições de função em qualquer instância do Azure Key Vault. O cliente suporta a 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

O URL base para o cofre

Métodos

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

Cria uma atribuição de função em um Cofre de Chaves 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 Cofre de Chaves 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 Cofre de Chaves 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 Cofre de Chaves 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 Cofre de Chaves do Azure.

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 Cofre de Chaves 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 sobre todas as definições de função disponíveis em um Cofre de Chaves 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 um Cofre de Chaves 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

o URL do Cofre da Chave. Deve ter esta forma: https://${your-key-vault-name}.vault.azure.net. Você deve validar se essa URL faz referência a um recurso válido do Cofre da Chave ou do HSM gerenciado. Consulte https://aka.ms/azsdk/blog/vault-uri para obter detalhes.

credential
TokenCredential

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

options
AccessControlClientOptions

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

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 em um Cofre de Chaves 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

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

principalId

string

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

options
CreateRoleAssignmentOptions

Os parâmetros opcionais.

Devoluções

deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Exclui atribuições de função criadas anteriormente em um Cofre de Chaves 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.

Devoluções

Promise<void>

deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Exclui uma definição de função personalizada criada anteriormente em um Cofre de Chaves 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 âmbito da definição de funções.

name

string

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

options
DeleteRoleDefinitionOptions

Os parâmetros opcionais.

Devoluções

Promise<void>

getRoleAssignment(string, string, GetRoleAssignmentOptions)

Obtém atribuições de função criadas anteriormente em um Cofre de Chaves 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.

Devoluções

getRoleDefinition(string, string, GetRoleDefinitionOptions)

Obtém uma definição de função do Cofre de Chaves do Azure.

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 âmbito da definição de funções.

name

string

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

options
GetRoleDefinitionOptions

Os parâmetros opcionais.

Devoluções

listRoleAssignments(string, ListRoleAssignmentsOptions)

Itera em todas as atribuições de função disponíveis em um Cofre de Chaves 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.

Devoluções

listRoleDefinitions(string, ListRoleDefinitionsOptions)

Itera sobre todas as definições de função disponíveis em um Cofre de Chaves 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 âmbito da definição de funções.

options
ListRoleDefinitionsOptions

Os parâmetros opcionais.

Devoluções

setRoleDefinition(string, SetRoleDefinitionOptions)

Cria ou atualiza uma definição de função em um Cofre de Chaves 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 âmbito da definição de funções.

options
SetRoleDefinitionOptions

Os parâmetros opcionais.

Devoluções