Dela via

KeyVaultAccessControlClient class

  • Referens
Paket:
@azure/keyvault-admin

KeyVaultAccessControlClient innehåller metoder för att hantera åtkomstkontroll- och rolltilldelningar i en viss Azure Key Vault-instans. Klienten har stöd för att skapa, hämta och ta bort roller.

Konstruktorer

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Skapar en instans av KeyVaultAccessControlClient.

Exempel på användning:

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

Egenskaper

vaultUrl

Bas-URL:en till valvet

Metoder

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

Skapar en rolltilldelning i ett Azure Key Vault.

Exempel på användning:

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

Skapar en ny rolltilldelning.
deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Tar bort rolltilldelningar som tidigare skapats i ett Azure Key Vault.

Exempel på användning:

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

Tar bort en befintlig rolltilldelning.
deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Tar bort en anpassad rolldefinition som tidigare skapats i ett Azure Key Vault.

Exempel på användning:

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)

Hämtar rolltilldelningar som tidigare skapats i ett Azure Key Vault.

Exempel på användning:

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

Hämtar en befintlig rolltilldelning.
getRoleDefinition(string, string, GetRoleDefinitionOptions)

Hämtar en rolldefinition från Azure Key Vault.

Exempel på användning:

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

Itererar över alla tillgängliga rolltilldelningar i ett Azure Key Vault.

Exempel på användning:

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

Visar en lista över alla rolltilldelningar i ett visst omfång.
listRoleDefinitions(string, ListRoleDefinitionsOptions)

Itererar över alla tillgängliga rolldefinitioner i ett Azure Key Vault.

Exempel på användning:

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

Visar en lista över alla rolldefinitioner i ett visst omfång.
setRoleDefinition(string, SetRoleDefinitionOptions)

Skapar eller uppdaterar en rolldefinition i ett Azure Key Vault.

Exempel på användning:

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

Konstruktorinformation

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Skapar en instans av KeyVaultAccessControlClient.

Exempel på användning:

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)

Parametrar

vaultUrl

string

URL:en för Key Vault. Den bör ha den här formen: https://${your-key-vault-name}.vault.azure.net. Du bör kontrollera att den här URL:en refererar till en giltig Key Vault- eller Managed HSM-resurs. Mer information finns i https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Ett objekt som implementerar det TokenCredential gränssnitt som används för att autentisera begäranden till tjänsten. Använd @azure/identity-paketet för att skapa en autentiseringsuppgift som passar dina behov.

options
AccessControlClientOptions

Alternativ som används för att konfigurera API-begäranden för Key Vault. Utelämna den här parametern för att använda standardkonfigurationen.

Egenskapsinformation

vaultUrl

Bas-URL:en till valvet

vaultUrl: string

Egenskapsvärde

string

Metodinformation

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

Skapar en rolltilldelning i ett Azure Key Vault.

Exempel på användning:

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

Skapar en ny rolltilldelning.

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

Parametrar

roleScope

string

Omfånget för rolltilldelningen.

name

string

Namnet på rolltilldelningen. Måste vara ett UUID.

roleDefinitionId

string

Rolldefinitions-ID:t som används i rolltilldelningen.

principalId

string

Det huvud-ID som tilldelats rollen. Detta mappar till ID:t i Active Directory. Den kan peka på en användare, tjänstens huvudnamn eller säkerhetsgrupp.

options
CreateRoleAssignmentOptions

De valfria parametrarna.

Returer

Promise<KeyVaultRoleAssignment>

deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Tar bort rolltilldelningar som tidigare skapats i ett Azure Key Vault.

Exempel på användning:

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

Tar bort en befintlig rolltilldelning.

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

Parametrar

roleScope

string

Omfånget för rolltilldelningen.

name

string

Namnet på rolltilldelningen.

options
DeleteRoleAssignmentOptions

De valfria parametrarna.

Returer

Promise<void>

deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Tar bort en anpassad rolldefinition som tidigare skapats i ett Azure Key Vault.

Exempel på användning:

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>

Parametrar

roleScope

string

Rolldefinitionens omfång.

name

string

Namnet på rolldefinitionen som ska tas bort.

options
DeleteRoleDefinitionOptions

De valfria parametrarna.

Returer

Promise<void>

getRoleAssignment(string, string, GetRoleAssignmentOptions)

Hämtar rolltilldelningar som tidigare skapats i ett Azure Key Vault.

Exempel på användning:

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

Hämtar en befintlig rolltilldelning.

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

Parametrar

roleScope

string

Omfånget för rolltilldelningen.

name

string

Namnet på rolltilldelningen.

options
GetRoleAssignmentOptions

De valfria parametrarna.

Returer

Promise<KeyVaultRoleAssignment>

getRoleDefinition(string, string, GetRoleDefinitionOptions)

Hämtar en rolldefinition från Azure Key Vault.

Exempel på användning:

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>

Parametrar

roleScope

string

Rolldefinitionens omfång.

name

string

Namnet på rolldefinitionen.

options
GetRoleDefinitionOptions

De valfria parametrarna.

Returer

Promise<KeyVaultRoleDefinition>

listRoleAssignments(string, ListRoleAssignmentsOptions)

Itererar över alla tillgängliga rolltilldelningar i ett Azure Key Vault.

Exempel på användning:

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

Visar en lista över alla rolltilldelningar i ett visst omfång.

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

Parametrar

roleScope

string

Omfånget för rolltilldelningarna.

options
ListRoleAssignmentsOptions

De valfria parametrarna.

Returer

PagedAsyncIterableIterator<KeyVaultRoleAssignment, KeyVaultRoleAssignment[], PageSettings>

listRoleDefinitions(string, ListRoleDefinitionsOptions)

Itererar över alla tillgängliga rolldefinitioner i ett Azure Key Vault.

Exempel på användning:

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

Visar en lista över alla rolldefinitioner i ett visst omfång.

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

Parametrar

roleScope

string

Rolldefinitionens omfång.

options
ListRoleDefinitionsOptions

De valfria parametrarna.

Returer

PagedAsyncIterableIterator<KeyVaultRoleDefinition, KeyVaultRoleDefinition[], PageSettings>

setRoleDefinition(string, SetRoleDefinitionOptions)

Skapar eller uppdaterar en rolldefinition i ett Azure Key Vault.

Exempel på användning:

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>

Parametrar

roleScope

string

Rolldefinitionens omfång.

options
SetRoleDefinitionOptions

De valfria parametrarna.

Returer

Promise<KeyVaultRoleDefinition>