Freigeben über

KeyVaultAccessControlClient class

Paket:
@azure/keyvault-admin

Der KeyVaultAccessControlClient stellt Methoden zum Verwalten von Zugriffssteuerungs- und Rollenzuweisungen in einer beliebigen Azure Key Vault-Instanz bereit. Der Client unterstützt das Erstellen, Abrufen und Löschen von Rollen.

Konstruktoren

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Erstellt eine Instanz des KeyVaultAccessControlClient.

Beispielverwendung:

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

Eigenschaften

vaultUrl

Die Basis-URL zum Tresor

Methoden

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

Erstellt eine Rollenzuweisung in einem Azure Key Vault.

Beispielverwendung:

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

Erstellt eine neue Rollenzuweisung.
deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Löscht Rollenzuweisungen, die zuvor in einem Azure Key Vault erstellt wurden.

Beispielverwendung:

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

Löscht eine vorhandene Rollenzuweisung.
deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Löscht eine benutzerdefinierte Rollendefinition, die zuvor in einem Azure Key Vault erstellt wurde.

Beispielverwendung:

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)

Ruft eine Rollenzuweisungen ab, die zuvor in einem Azure Key Vault erstellt wurden.

Beispielverwendung:

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

Ruft eine vorhandene Rollenzuweisung ab.
getRoleDefinition(string, string, GetRoleDefinitionOptions)

Ruft eine Rollendefinition aus Azure Key Vault ab.

Beispielverwendung:

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)

Durchläuft alle verfügbaren Rollenzuweisungen in einem Azure Key Vault.

Beispielverwendung:

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

Listet alle Rollenzuweisungen in einem bestimmten Bereich auf.
listRoleDefinitions(string, ListRoleDefinitionsOptions)

Durchläuft alle verfügbaren Rollendefinitionen in einem Azure Key Vault.

Beispielverwendung:

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

Listet alle Rollendefinitionen in einem bestimmten Bereich auf.
setRoleDefinition(string, SetRoleDefinitionOptions)

Erstellt oder aktualisiert eine Rollendefinition in einem Azure Key Vault.

Beispielverwendung:

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

Details zum Konstruktor

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Erstellt eine Instanz des KeyVaultAccessControlClient.

Beispielverwendung:

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)

Parameter

vaultUrl

string

die URL des Key Vault. Es sollte diese Form haben: https://${your-key-vault-name}.vault.azure.net. Sie sollten überprüfen, ob diese URL auf eine gültige Key Vault- oder verwaltete HSM-Ressource verweist. Weitere Informationen finden Sie unter https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Ein Objekt, das die TokenCredential Schnittstelle implementiert, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird. Verwenden Sie das @azure/identity-Paket, um eine Anmeldeinformation zu erstellen, die Ihren Anforderungen entspricht.

options
AccessControlClientOptions

Optionen zum Konfigurieren von Key Vault-API-Anforderungen. Lassen Sie diesen Parameter aus, um die Standardkonfiguration zu verwenden.

Details zur Eigenschaft

vaultUrl

Die Basis-URL zum Tresor

vaultUrl: string

Eigenschaftswert

string

Details zur Methode

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

Erstellt eine Rollenzuweisung in einem Azure Key Vault.

Beispielverwendung:

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

Erstellt eine neue Rollenzuweisung.

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

Parameter

roleScope

string

Der Bereich der Rollenzuweisung.

name

string

Der Name der Rollenzuweisung. Muss eine UUID sein.

roleDefinitionId

string

Die rollendefinitions-ID, die in der Rollenzuweisung verwendet wird.

principalId

string

Die Prinzipal-ID, die der Rolle zugewiesen ist. Dies ist der ID innerhalb von Active Directory zugeordnet. Er kann auf einen Benutzer, dienstprinzipal oder eine Sicherheitsgruppe verweisen.

options
CreateRoleAssignmentOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultRoleAssignment>

deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Löscht Rollenzuweisungen, die zuvor in einem Azure Key Vault erstellt wurden.

Beispielverwendung:

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

Löscht eine vorhandene Rollenzuweisung.

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

Parameter

roleScope

string

Der Bereich der Rollenzuweisung.

name

string

Der Name der Rollenzuweisung.

options
DeleteRoleAssignmentOptions

Die optionalen Parameter.

Gibt zurück

Promise<void>

deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Löscht eine benutzerdefinierte Rollendefinition, die zuvor in einem Azure Key Vault erstellt wurde.

Beispielverwendung:

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>

Parameter

roleScope

string

Der Bereich der Rollendefinition.

name

string

Der Name der zu löschenden Rollendefinition.

options
DeleteRoleDefinitionOptions

Die optionalen Parameter.

Gibt zurück

Promise<void>

getRoleAssignment(string, string, GetRoleAssignmentOptions)

Ruft eine Rollenzuweisungen ab, die zuvor in einem Azure Key Vault erstellt wurden.

Beispielverwendung:

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

Ruft eine vorhandene Rollenzuweisung ab.

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

Parameter

roleScope

string

Der Bereich der Rollenzuweisung.

name

string

Der Name der Rollenzuweisung.

options
GetRoleAssignmentOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultRoleAssignment>

getRoleDefinition(string, string, GetRoleDefinitionOptions)

Ruft eine Rollendefinition aus Azure Key Vault ab.

Beispielverwendung:

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>

Parameter

roleScope

string

Der Bereich der Rollendefinition.

name

string

Der Name der Rollendefinition.

options
GetRoleDefinitionOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultRoleDefinition>

listRoleAssignments(string, ListRoleAssignmentsOptions)

Durchläuft alle verfügbaren Rollenzuweisungen in einem Azure Key Vault.

Beispielverwendung:

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

Listet alle Rollenzuweisungen in einem bestimmten Bereich auf.

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

Parameter

roleScope

string

Der Umfang der Rollenzuweisungen.

options
ListRoleAssignmentsOptions

Die optionalen Parameter.

Gibt zurück

PagedAsyncIterableIterator<KeyVaultRoleAssignment, KeyVaultRoleAssignment[], PageSettings>

listRoleDefinitions(string, ListRoleDefinitionsOptions)

Durchläuft alle verfügbaren Rollendefinitionen in einem Azure Key Vault.

Beispielverwendung:

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

Listet alle Rollendefinitionen in einem bestimmten Bereich auf.

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

Parameter

roleScope

string

Der Bereich der Rollendefinition.

options
ListRoleDefinitionsOptions

Die optionalen Parameter.

Gibt zurück

PagedAsyncIterableIterator<KeyVaultRoleDefinition, KeyVaultRoleDefinition[], PageSettings>

setRoleDefinition(string, SetRoleDefinitionOptions)

Erstellt oder aktualisiert eine Rollendefinition in einem Azure Key Vault.

Beispielverwendung:

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>

Parameter

roleScope

string

Der Bereich der Rollendefinition.

options
SetRoleDefinitionOptions

Die optionalen Parameter.

Gibt zurück

Promise<KeyVaultRoleDefinition>