Partager via

KeyVaultAccessControlClient class

  • Référence
Paquet:
@azure/keyvault-admin

KeyVaultAccessControlClient fournit des méthodes pour gérer le contrôle d’accès et les attributions de rôles dans une instance Azure Key Vault donnée. Le client prend en charge la création, la récupération et la suppression de rôles.

Constructeurs

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Crée une instance de KeyVaultAccessControlClient.

Exemple d’utilisation :

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

Propriétés

vaultUrl

URL de base du coffre

Méthodes

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

Crée une attribution de rôle dans un Key Vault Azure.

Exemple d’utilisation :

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

Crée une attribution de rôle.
deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Supprime les attributions de rôles précédemment créées dans un Key Vault Azure.

Exemple d’utilisation :

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

Supprime une attribution de rôle existante.
deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Supprime une définition de rôle personnalisée précédemment créée dans un Key Vault Azure.

Exemple d’utilisation :

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)

Obtient une attribution de rôle précédemment créée dans un Key Vault Azure.

Exemple d’utilisation :

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

Obtient une attribution de rôle existante.
getRoleDefinition(string, string, GetRoleDefinitionOptions)

Obtient une définition de rôle à partir d’Azure Key Vault.

Exemple d’utilisation :

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

Itère sur toutes les attributions de rôles disponibles dans un Key Vault Azure.

Exemple d’utilisation :

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

Répertorie toutes les attributions de rôles dans une étendue donnée.
listRoleDefinitions(string, ListRoleDefinitionsOptions)

Itère sur toutes les définitions de rôle disponibles dans un Key Vault Azure.

Exemple d’utilisation :

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

Répertorie toutes les définitions de rôle dans une étendue donnée.
setRoleDefinition(string, SetRoleDefinitionOptions)

Crée ou met à jour une définition de rôle dans un Key Vault Azure.

Exemple d’utilisation :

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

Détails du constructeur

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Crée une instance de KeyVaultAccessControlClient.

Exemple d’utilisation :

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)

Paramètres

vaultUrl

string

URL du Key Vault. Il doit avoir la forme suivante : https://${your-key-vault-name}.vault.azure.net. Vous devez vérifier que cette URL fait référence à une ressource Key Vault ou HSM managée valide. Pour plus d'informations, consultez https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Objet qui implémente l’interface TokenCredential utilisée pour authentifier les demandes adressées au service. Utilisez le @azure/identity package pour créer des informations d’identification qui correspondent à vos besoins.

options
AccessControlClientOptions

Options utilisées pour configurer Key Vault demandes d’API. Omettez ce paramètre pour utiliser la configuration par défaut.

Détails de la propriété

vaultUrl

URL de base du coffre

vaultUrl: string

Valeur de propriété

string

Détails de la méthode

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

Crée une attribution de rôle dans un Key Vault Azure.

Exemple d’utilisation :

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

Crée une attribution de rôle.

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

Paramètres

roleScope

string

Étendue de l’attribution de rôle.

name

string

Nom de l’attribution de rôle. Doit être un UUID.

roleDefinitionId

string

ID de définition de rôle utilisé dans l’attribution de rôle.

principalId

string

ID principal attribué au rôle. Cela correspond à l’ID à l’intérieur d’Active Directory. Il peut pointer vers un utilisateur, un principal de service ou un groupe de sécurité.

options
CreateRoleAssignmentOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultRoleAssignment>

deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Supprime les attributions de rôles précédemment créées dans un Key Vault Azure.

Exemple d’utilisation :

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

Supprime une attribution de rôle existante.

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

Paramètres

roleScope

string

Étendue de l’attribution de rôle.

name

string

Nom de l’attribution de rôle.

options
DeleteRoleAssignmentOptions

Paramètres facultatifs.

Retours

Promise<void>

deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Supprime une définition de rôle personnalisée précédemment créée dans un Key Vault Azure.

Exemple d’utilisation :

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>

Paramètres

roleScope

string

Étendue de la définition de rôle.

name

string

Nom de la définition de rôle à supprimer.

options
DeleteRoleDefinitionOptions

Paramètres facultatifs.

Retours

Promise<void>

getRoleAssignment(string, string, GetRoleAssignmentOptions)

Obtient une attribution de rôle précédemment créée dans un Key Vault Azure.

Exemple d’utilisation :

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

Obtient une attribution de rôle existante.

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

Paramètres

roleScope

string

Étendue de l’attribution de rôle.

name

string

Nom de l’attribution de rôle.

options
GetRoleAssignmentOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultRoleAssignment>

getRoleDefinition(string, string, GetRoleDefinitionOptions)

Obtient une définition de rôle à partir d’Azure Key Vault.

Exemple d’utilisation :

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>

Paramètres

roleScope

string

Étendue de la définition de rôle.

name

string

Le nom de la définition de rôle.

options
GetRoleDefinitionOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultRoleDefinition>

listRoleAssignments(string, ListRoleAssignmentsOptions)

Itère sur toutes les attributions de rôles disponibles dans un Key Vault Azure.

Exemple d’utilisation :

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

Répertorie toutes les attributions de rôles dans une étendue donnée.

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

Paramètres

roleScope

string

Étendue des attributions de rôles.

options
ListRoleAssignmentsOptions

Paramètres facultatifs.

Retours

PagedAsyncIterableIterator<KeyVaultRoleAssignment, KeyVaultRoleAssignment[], PageSettings>

listRoleDefinitions(string, ListRoleDefinitionsOptions)

Itère sur toutes les définitions de rôle disponibles dans un Key Vault Azure.

Exemple d’utilisation :

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

Répertorie toutes les définitions de rôle dans une étendue donnée.

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

Paramètres

roleScope

string

Étendue de la définition de rôle.

options
ListRoleDefinitionsOptions

Paramètres facultatifs.

Retours

PagedAsyncIterableIterator<KeyVaultRoleDefinition, KeyVaultRoleDefinition[], PageSettings>

setRoleDefinition(string, SetRoleDefinitionOptions)

Crée ou met à jour une définition de rôle dans un Key Vault Azure.

Exemple d’utilisation :

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>

Paramètres

roleScope

string

Étendue de la définition de rôle.

options
SetRoleDefinitionOptions

Paramètres facultatifs.

Retours

Promise<KeyVaultRoleDefinition>