Compartir a través de

KeyVaultAccessControlClient class

  • Referencia
Paquete:
@azure/keyvault-admin

KeyVaultAccessControlClient proporciona métodos para administrar el control de acceso y las asignaciones de roles en cualquier instancia de Azure Key Vault determinada. El cliente admite la creación, recuperación y eliminación de roles.

Constructores

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Crea una instancia de KeyVaultAccessControlClient.

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

Propiedades

vaultUrl

Dirección URL base del almacén

Métodos

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

Crea una asignación de roles en una Key Vault de Azure.

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

Crea una nueva asignación de roles.
deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Elimina las asignaciones de roles creadas anteriormente en una instancia de Azure Key Vault.

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

Elimina una asignación de roles existente.
deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Elimina una definición de roles personalizada creada anteriormente en una instancia de Azure Key Vault.

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

Obtiene una asignación de roles creada anteriormente en una instancia de Azure Key Vault.

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

Obtiene una asignación de roles existente.
getRoleDefinition(string, string, GetRoleDefinitionOptions)

Obtiene una definición de roles de Azure Key Vault.

Ejemplo de uso:

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

Recorre en iteración todas las asignaciones de roles disponibles en una Key Vault de Azure.

Ejemplo de uso:

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

Enumera todas las asignaciones de roles en un ámbito determinado.
listRoleDefinitions(string, ListRoleDefinitionsOptions)

Recorre en iteración todas las definiciones de roles disponibles en una instancia de Azure Key Vault.

Ejemplo de uso:

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

Enumera toda la definición de rol en un ámbito determinado.
setRoleDefinition(string, SetRoleDefinitionOptions)

Crea o actualiza una definición de rol en una instancia de Azure Key Vault.

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

Detalles del constructor

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Crea una instancia de KeyVaultAccessControlClient.

Ejemplo 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

la dirección URL del Key Vault. Debe tener esta forma: https://${your-key-vault-name}.vault.azure.net. Debe validar que esta dirección URL hace referencia a un recurso de Key Vault o HSM administrado válido. Para obtener información detallada, vea https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Objeto que implementa la TokenCredential interfaz utilizada para autenticar las solicitudes en el servicio. Use el @azure/identity paquete para crear una credencial que se adapte a sus necesidades.

options
AccessControlClientOptions

Opciones usadas para configurar solicitudes de API de Key Vault. Omita este parámetro para usar la configuración predeterminada.

Detalles de las propiedades

vaultUrl

Dirección URL base del almacén

vaultUrl: string

Valor de propiedad

string

Detalles del método

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

Crea una asignación de roles en una Key Vault de Azure.

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

Crea una nueva asignación de roles.

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

Parámetros

roleScope

string

Ámbito de la asignación de roles.

name

string

Nombre de la asignación de roles. Debe ser un UUID.

roleDefinitionId

string

Identificador de definición de roles usado en la asignación de roles.

principalId

string

Identificador de entidad de seguridad asignado al rol. Esto se asigna al identificador dentro de Active Directory. Puede apuntar a un usuario, una entidad de servicio o un grupo de seguridad.

options
CreateRoleAssignmentOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultRoleAssignment>

deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Elimina las asignaciones de roles creadas anteriormente en una instancia de Azure Key Vault.

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

Elimina una asignación de roles existente.

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

Parámetros

roleScope

string

Ámbito de la asignación de roles.

name

string

Nombre de la asignación de roles.

options
DeleteRoleAssignmentOptions

Parámetros opcionales.

Devoluciones

Promise<void>

deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Elimina una definición de roles personalizada creada anteriormente en una instancia de Azure Key Vault.

Ejemplo 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

Ámbito de la definición de roles.

name

string

Nombre de la definición de roles que se va a eliminar.

options
DeleteRoleDefinitionOptions

Parámetros opcionales.

Devoluciones

Promise<void>

getRoleAssignment(string, string, GetRoleAssignmentOptions)

Obtiene una asignación de roles creada anteriormente en una instancia de Azure Key Vault.

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

Obtiene una asignación de roles existente.

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

Parámetros

roleScope

string

Ámbito de la asignación de roles.

name

string

Nombre de la asignación de roles.

options
GetRoleAssignmentOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultRoleAssignment>

getRoleDefinition(string, string, GetRoleDefinitionOptions)

Obtiene una definición de roles de Azure Key Vault.

Ejemplo 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

Ámbito de la definición de roles.

name

string

El nombre de la definición de roles.

options
GetRoleDefinitionOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultRoleDefinition>

listRoleAssignments(string, ListRoleAssignmentsOptions)

Recorre en iteración todas las asignaciones de roles disponibles en una Key Vault de Azure.

Ejemplo de uso:

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

Enumera todas las asignaciones de roles en un ámbito determinado.

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

Parámetros

roleScope

string

Ámbito de las asignaciones de roles.

options
ListRoleAssignmentsOptions

Parámetros opcionales.

Devoluciones

PagedAsyncIterableIterator<KeyVaultRoleAssignment, KeyVaultRoleAssignment[], PageSettings>

listRoleDefinitions(string, ListRoleDefinitionsOptions)

Recorre en iteración todas las definiciones de roles disponibles en una instancia de Azure Key Vault.

Ejemplo de uso:

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

Enumera toda la definición de rol en un ámbito determinado.

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

Parámetros

roleScope

string

Ámbito de la definición de rol.

options
ListRoleDefinitionsOptions

Parámetros opcionales.

Devoluciones

PagedAsyncIterableIterator<KeyVaultRoleDefinition, KeyVaultRoleDefinition[], PageSettings>

setRoleDefinition(string, SetRoleDefinitionOptions)

Crea o actualiza una definición de rol en una instancia de Azure Key Vault.

Ejemplo 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

Ámbito de la definición de rol.

options
SetRoleDefinitionOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultRoleDefinition>