Compartir a través de

KeyVaultAccessControlClient class

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.

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const 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 instancia de Azure Key Vault.

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, credentials);

const { value: roleDefinition } = await client.listRoleDefinitions("/").next();

const principalId = "4871f6a6-374f-4b6b-8b0c-f5d84db823f6";
const result = await client.createRoleAssignment(
  "/",
  "295c179b-9ad3-4117-99cd-b1aa66cf4517",
  roleDefinition.id,
  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.

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, credentials);

const { value: roleDefinition } = await client.listRoleDefinitions("/").next();
const principalId = "4871f6a6-374f-4b6b-8b0c-f5d84db823f6";

const roleAssignment = await client.createRoleAssignment(
  "/",
  "295c179b-9ad3-4117-99cd-b1aa66cf4517",
  roleDefinition.id,
  principalId,
);

await client.deleteRoleAssignment(roleAssignment.properties.scope, roleAssignment.name);

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

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

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import {
  KeyVaultAccessControlClient,
  KnownKeyVaultDataAction,
  KnownKeyVaultRoleScope,
} from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, credentials);

const permissions = [{ dataActions: [KnownKeyVaultDataAction.BackupHsmKeys] }];
const roleDefinitionName = "23b8bb1a-39c0-4c89-a85b-dd3c99273a8a";
const roleDefinition = await client.setRoleDefinition(KnownKeyVaultRoleScope.Global, {
  permissions,
  roleDefinitionName,
});

await client.deleteRoleDefinition("/", roleDefinition.name);
getRoleAssignment(string, string, GetRoleAssignmentOptions)

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

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, credentials);

const { value: roleDefinition } = await client.listRoleDefinitions("/").next();
const principalId = "4871f6a6-374f-4b6b-8b0c-f5d84db823f6";

let roleAssignment = await client.createRoleAssignment(
  "/",
  "295c179b-9ad3-4117-99cd-b1aa66cf4517",
  roleDefinition.id,
  principalId,
);

roleAssignment = await client.getRoleAssignment(
  roleAssignment.properties.scope,
  roleAssignment.name,
);
console.log(roleAssignment);

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

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

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, 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 instancia de Azure Key Vault.

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, 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.

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, credentials);

for await (const roleDefinitions of client.listRoleDefinitions("/")) {
  console.log("Role definition: ", roleDefinitions);
}

Enumera todas las definiciones de roles en un ámbito determinado.
setRoleDefinition(string, SetRoleDefinitionOptions)

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

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import {
  KeyVaultAccessControlClient,
  KnownKeyVaultDataAction,
  KnownKeyVaultRoleScope,
} from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, 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.

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, credentials);

new KeyVaultAccessControlClient(vaultUrl: string, credential: TokenCredential, options?: AccessControlClientOptions)

Parámetros

vaultUrl

string

la dirección URL de 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. Consulte https://aka.ms/azsdk/blog/vault-uri para obtener más información.

credential
TokenCredential

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

options
AccessControlClientOptions

Opciones que se usan 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 instancia de Azure Key Vault.

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, credentials);

const { value: roleDefinition } = await client.listRoleDefinitions("/").next();

const principalId = "4871f6a6-374f-4b6b-8b0c-f5d84db823f6";
const result = await client.createRoleAssignment(
  "/",
  "295c179b-9ad3-4117-99cd-b1aa66cf4517",
  roleDefinition.id,
  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.

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, credentials);

const { value: roleDefinition } = await client.listRoleDefinitions("/").next();
const principalId = "4871f6a6-374f-4b6b-8b0c-f5d84db823f6";

const roleAssignment = await client.createRoleAssignment(
  "/",
  "295c179b-9ad3-4117-99cd-b1aa66cf4517",
  roleDefinition.id,
  principalId,
);

await client.deleteRoleAssignment(roleAssignment.properties.scope, 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 rol personalizada creada anteriormente en una instancia de Azure Key Vault.

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import {
  KeyVaultAccessControlClient,
  KnownKeyVaultDataAction,
  KnownKeyVaultRoleScope,
} from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, credentials);

const permissions = [{ dataActions: [KnownKeyVaultDataAction.BackupHsmKeys] }];
const roleDefinitionName = "23b8bb1a-39c0-4c89-a85b-dd3c99273a8a";
const roleDefinition = await client.setRoleDefinition(KnownKeyVaultRoleScope.Global, {
  permissions,
  roleDefinitionName,
});

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 rol 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.

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, credentials);

const { value: roleDefinition } = await client.listRoleDefinitions("/").next();
const principalId = "4871f6a6-374f-4b6b-8b0c-f5d84db823f6";

let roleAssignment = await client.createRoleAssignment(
  "/",
  "295c179b-9ad3-4117-99cd-b1aa66cf4517",
  roleDefinition.id,
  principalId,
);

roleAssignment = await client.getRoleAssignment(
  roleAssignment.properties.scope,
  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 rol de Azure Key Vault.

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, 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

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 instancia de Azure Key Vault.

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, 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.

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, credentials);

for await (const roleDefinitions of client.listRoleDefinitions("/")) {
  console.log("Role definition: ", roleDefinitions);
}

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

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

Parámetros

roleScope

string

Ámbito de la definición de roles.

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.

Uso de ejemplo:

import { DefaultAzureCredential } from "@azure/identity";
import {
  KeyVaultAccessControlClient,
  KnownKeyVaultDataAction,
  KnownKeyVaultRoleScope,
} from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, 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 roles.

options
SetRoleDefinitionOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultRoleDefinition>