Condividi tramite

KeyVaultAccessControlClient class

  • Riferimento
Pacchetto:
@azure/keyvault-admin

KeyVaultAccessControlClient fornisce metodi per gestire il controllo di accesso e le assegnazioni di ruolo in una determinata istanza di Azure Key Vault. Il client supporta la creazione, il recupero e l'eliminazione di ruoli.

Costruttori

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Crea un'istanza di KeyVaultAccessControlClient.

Esempio di utilizzo:

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

Proprietà

vaultUrl

URL di base dell'insieme di credenziali

Metodi

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

Crea un'assegnazione di ruolo in un Key Vault di Azure.

Esempio di utilizzo:

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 nuova assegnazione di ruolo.
deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Elimina le assegnazioni di ruolo create in precedenza in un Key Vault di Azure.

Esempio di utilizzo:

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 un'assegnazione di ruolo esistente.
deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Elimina una definizione di ruolo personalizzata creata in precedenza in un'Key Vault di Azure.

Esempio di utilizzo:

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)

Ottiene un'assegnazione di ruolo creata in precedenza in un'Key Vault di Azure.

Esempio di utilizzo:

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

Ottiene un'assegnazione di ruolo esistente.
getRoleDefinition(string, string, GetRoleDefinitionOptions)

Ottiene una definizione di ruolo da Azure Key Vault.

Esempio di utilizzo:

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

Scorre tutte le assegnazioni di ruolo disponibili in un Key Vault di Azure.

Esempio di utilizzo:

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

Elenca tutte le assegnazioni di ruolo in un determinato ambito.
listRoleDefinitions(string, ListRoleDefinitionsOptions)

Scorre tutte le definizioni di ruolo disponibili in un Key Vault di Azure.

Esempio di utilizzo:

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

Elenca tutte le definizioni di ruolo in un determinato ambito.
setRoleDefinition(string, SetRoleDefinitionOptions)

Crea o aggiorna una definizione di ruolo in un Key Vault di Azure.

Esempio di utilizzo:

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

Dettagli costruttore

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Crea un'istanza di KeyVaultAccessControlClient.

Esempio di utilizzo:

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)

Parametri

vaultUrl

string

URL del Key Vault. Deve avere questa forma: https://${your-key-vault-name}.vault.azure.net. È necessario verificare che questo URL faccia riferimento a una risorsa HSM Key Vault o gestita valida. Per informazioni dettagliate, vedere https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Oggetto che implementa l'interfaccia TokenCredential utilizzata per autenticare le richieste al servizio. Usare il @azure/identity pacchetto per creare credenziali adatte alle proprie esigenze.

options
AccessControlClientOptions

Opzioni usate per configurare Key Vault richieste API. Omettere questo parametro per usare la configurazione predefinita.

Dettagli proprietà

vaultUrl

URL di base dell'insieme di credenziali

vaultUrl: string

Valore della proprietà

string

Dettagli metodo

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

Crea un'assegnazione di ruolo in un Key Vault di Azure.

Esempio di utilizzo:

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 nuova assegnazione di ruolo.

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

Parametri

roleScope

string

Ambito dell'assegnazione di ruolo.

name

string

Nome dell'assegnazione di ruolo. Deve essere un UUID.

roleDefinitionId

string

ID definizione del ruolo usato nell'assegnazione di ruolo.

principalId

string

ID entità assegnato al ruolo. Viene eseguito il mapping all'ID all'interno di Active Directory. Può puntare a un utente, a un'entità servizio o a un gruppo di sicurezza.

options
CreateRoleAssignmentOptions

Parametri facoltativi.

Restituisce

Promise<KeyVaultRoleAssignment>

deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Elimina le assegnazioni di ruolo create in precedenza in un Key Vault di Azure.

Esempio di utilizzo:

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 un'assegnazione di ruolo esistente.

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

Parametri

roleScope

string

Ambito dell'assegnazione di ruolo.

name

string

Nome dell'assegnazione di ruolo.

options
DeleteRoleAssignmentOptions

Parametri facoltativi.

Restituisce

Promise<void>

deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Elimina una definizione di ruolo personalizzata creata in precedenza in un'Key Vault di Azure.

Esempio di utilizzo:

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>

Parametri

roleScope

string

Ambito della definizione del ruolo.

name

string

Nome della definizione del ruolo da eliminare.

options
DeleteRoleDefinitionOptions

Parametri facoltativi.

Restituisce

Promise<void>

getRoleAssignment(string, string, GetRoleAssignmentOptions)

Ottiene un'assegnazione di ruolo creata in precedenza in un'Key Vault di Azure.

Esempio di utilizzo:

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

Ottiene un'assegnazione di ruolo esistente.

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

Parametri

roleScope

string

Ambito dell'assegnazione di ruolo.

name

string

Nome dell'assegnazione di ruolo.

options
GetRoleAssignmentOptions

Parametri facoltativi.

Restituisce

Promise<KeyVaultRoleAssignment>

getRoleDefinition(string, string, GetRoleDefinitionOptions)

Ottiene una definizione di ruolo da Azure Key Vault.

Esempio di utilizzo:

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>

Parametri

roleScope

string

Ambito della definizione del ruolo.

name

string

Nome della definizione di ruolo.

options
GetRoleDefinitionOptions

Parametri facoltativi.

Restituisce

Promise<KeyVaultRoleDefinition>

listRoleAssignments(string, ListRoleAssignmentsOptions)

Scorre tutte le assegnazioni di ruolo disponibili in un Key Vault di Azure.

Esempio di utilizzo:

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

Elenca tutte le assegnazioni di ruolo in un determinato ambito.

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

Parametri

roleScope

string

Ambito delle assegnazioni di ruolo.

options
ListRoleAssignmentsOptions

Parametri facoltativi.

Restituisce

PagedAsyncIterableIterator<KeyVaultRoleAssignment, KeyVaultRoleAssignment[], PageSettings>

listRoleDefinitions(string, ListRoleDefinitionsOptions)

Scorre tutte le definizioni di ruolo disponibili in un Key Vault di Azure.

Esempio di utilizzo:

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

Elenca tutte le definizioni di ruolo in un determinato ambito.

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

Parametri

roleScope

string

Ambito della definizione del ruolo.

options
ListRoleDefinitionsOptions

Parametri facoltativi.

Restituisce

PagedAsyncIterableIterator<KeyVaultRoleDefinition, KeyVaultRoleDefinition[], PageSettings>

setRoleDefinition(string, SetRoleDefinitionOptions)

Crea o aggiorna una definizione di ruolo in un Key Vault di Azure.

Esempio di utilizzo:

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>

Parametri

roleScope

string

Ambito della definizione del ruolo.

options
SetRoleDefinitionOptions

Parametri facoltativi.

Restituisce

Promise<KeyVaultRoleDefinition>