Udostępnij za pośrednictwem

KeyVaultAccessControlClient class

Pakiet:
@azure/keyvault-admin

Obiekt KeyVaultAccessControlClient udostępnia metody zarządzania kontrolą dostępu i przypisaniami ról w dowolnym wystąpieniu usługi Azure Key Vault. Klient obsługuje tworzenie, pobieranie i usuwanie ról.

Konstruktory

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Tworzy wystąpienie klasy KeyVaultAccessControlClient.

Przykładowe użycie:

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

Właściwości

vaultUrl

Podstawowy adres URL magazynu

Metody

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

Tworzy przypisanie roli w usłudze Azure Key Vault.

Przykładowe użycie:

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

Tworzy nowe przypisanie roli.
deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Usuwa przypisania ról utworzone wcześniej w usłudze Azure Key Vault.

Przykładowe użycie:

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

Usuwa istniejące przypisanie roli.
deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Usuwa definicję roli niestandardowej utworzonej wcześniej w usłudze Azure Key Vault.

Przykładowe użycie:

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)

Pobiera przypisania ról utworzone wcześniej w usłudze Azure Key Vault.

Przykładowe użycie:

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

Pobiera istniejące przypisanie roli.
getRoleDefinition(string, string, GetRoleDefinitionOptions)

Pobiera definicję roli z usługi Azure Key Vault.

Przykładowe użycie:

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)

Iteruje wszystkie dostępne przypisania ról w usłudze Azure Key Vault.

Przykładowe użycie:

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

Wyświetla listę wszystkich przypisań ról w danym zakresie.
listRoleDefinitions(string, ListRoleDefinitionsOptions)

Iteruje wszystkie dostępne definicje ról w usłudze Azure Key Vault.

Przykładowe użycie:

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

Wyświetla listę wszystkich definicji roli w danym zakresie.
setRoleDefinition(string, SetRoleDefinitionOptions)

Tworzy lub aktualizuje definicję roli w usłudze Azure Key Vault.

Przykładowe użycie:

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

Szczegóły konstruktora

KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)

Tworzy wystąpienie klasy KeyVaultAccessControlClient.

Przykładowe użycie:

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)

Parametry

vaultUrl

string

adres URL usługi Key Vault. Powinien mieć ten kształt: https://${your-key-vault-name}.vault.azure.net. Należy sprawdzić, czy ten adres URL odwołuje się do prawidłowego zasobu usługi Key Vault lub zarządzanego modułu HSM. Aby uzyskać szczegółowe informacje, zobacz https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Obiekt, który implementuje interfejs TokenCredential używany do uwierzytelniania żądań w usłudze. Użyj pakietu @azure/identity, aby utworzyć poświadczenia odpowiadające Twoim potrzebom.

options
AccessControlClientOptions

Opcje używane do konfigurowania żądań interfejsu API usługi Key Vault. Pomiń ten parametr, aby użyć konfiguracji domyślnej.

Szczegóły właściwości

vaultUrl

Podstawowy adres URL magazynu

vaultUrl: string

Wartość właściwości

string

Szczegóły metody

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

Tworzy przypisanie roli w usłudze Azure Key Vault.

Przykładowe użycie:

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

Tworzy nowe przypisanie roli.

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

Parametry

roleScope

string

Zakres przypisania roli.

name

string

Nazwa przypisania roli. Musi być identyfikatorem UUID.

roleDefinitionId

string

Identyfikator definicji roli używany w przypisaniu roli.

principalId

string

Identyfikator podmiotu zabezpieczeń przypisany do roli. Spowoduje to mapowania na identyfikator wewnątrz usługi Active Directory. Może wskazywać użytkownika, jednostkę usługi lub grupę zabezpieczeń.

options
CreateRoleAssignmentOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultRoleAssignment>

deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

Usuwa przypisania ról utworzone wcześniej w usłudze Azure Key Vault.

Przykładowe użycie:

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

Usuwa istniejące przypisanie roli.

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

Parametry

roleScope

string

Zakres przypisania roli.

name

string

Nazwa przypisania roli.

options
DeleteRoleAssignmentOptions

Parametry opcjonalne.

Zwraca

Promise<void>

deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)

Usuwa definicję roli niestandardowej utworzonej wcześniej w usłudze Azure Key Vault.

Przykładowe użycie:

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>

Parametry

roleScope

string

Zakres definicji roli.

name

string

Nazwa definicji roli do usunięcia.

options
DeleteRoleDefinitionOptions

Parametry opcjonalne.

Zwraca

Promise<void>

getRoleAssignment(string, string, GetRoleAssignmentOptions)

Pobiera przypisania ról utworzone wcześniej w usłudze Azure Key Vault.

Przykładowe użycie:

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

Pobiera istniejące przypisanie roli.

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

Parametry

roleScope

string

Zakres przypisania roli.

name

string

Nazwa przypisania roli.

options
GetRoleAssignmentOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultRoleAssignment>

getRoleDefinition(string, string, GetRoleDefinitionOptions)

Pobiera definicję roli z usługi Azure Key Vault.

Przykładowe użycie:

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>

Parametry

roleScope

string

Zakres definicji roli.

name

string

Nazwa definicji roli.

options
GetRoleDefinitionOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultRoleDefinition>

listRoleAssignments(string, ListRoleAssignmentsOptions)

Iteruje wszystkie dostępne przypisania ról w usłudze Azure Key Vault.

Przykładowe użycie:

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

Wyświetla listę wszystkich przypisań ról w danym zakresie.

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

Parametry

roleScope

string

Zakres przypisań ról.

options
ListRoleAssignmentsOptions

Parametry opcjonalne.

Zwraca

PagedAsyncIterableIterator<KeyVaultRoleAssignment, KeyVaultRoleAssignment[], PageSettings>

listRoleDefinitions(string, ListRoleDefinitionsOptions)

Iteruje wszystkie dostępne definicje ról w usłudze Azure Key Vault.

Przykładowe użycie:

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

Wyświetla listę wszystkich definicji roli w danym zakresie.

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

Parametry

roleScope

string

Zakres definicji roli.

options
ListRoleDefinitionsOptions

Parametry opcjonalne.

Zwraca

PagedAsyncIterableIterator<KeyVaultRoleDefinition, KeyVaultRoleDefinition[], PageSettings>

setRoleDefinition(string, SetRoleDefinitionOptions)

Tworzy lub aktualizuje definicję roli w usłudze Azure Key Vault.

Przykładowe użycie:

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>

Parametry

roleScope

string

Zakres definicji roli.

options
SetRoleDefinitionOptions

Parametry opcjonalne.

Zwraca

Promise<KeyVaultRoleDefinition>