KeyVaultAccessControlClient class
De KeyVaultAccessControlClient biedt methoden voor het beheren van toegangsbeheer en roltoewijzingen in een bepaald Azure Key Vault-exemplaar. De client ondersteunt het maken, ophalen en verwijderen van rollen.
Constructors
| Key |
Hiermee maakt u een exemplaar van de KeyVaultAccessControlClient. Gebruiksvoorbeeld: |
Eigenschappen
| vault |
De basis-URL naar de kluis |
Methoden
| create |
Hiermee maakt u een roltoewijzing in een Azure-Key Vault. Gebruiksvoorbeeld: Hiermee maakt u een nieuwe roltoewijzing. |
| delete |
Hiermee verwijdert u roltoewijzingen die eerder zijn gemaakt in een Azure-Key Vault. Gebruiksvoorbeeld: Hiermee verwijdert u een bestaande roltoewijzing. |
| delete |
Hiermee verwijdert u een aangepaste roldefinitie die eerder is gemaakt in een Azure-Key Vault. Gebruiksvoorbeeld: |
| get |
Hiermee haalt u roltoewijzingen op die eerder zijn gemaakt in een Azure-Key Vault. Gebruiksvoorbeeld: Hiermee haalt u een bestaande roltoewijzing op. |
| get |
Hiermee haalt u een roldefinitie op van Azure Key Vault. Gebruiksvoorbeeld: |
| list |
Itereert alle beschikbare roltoewijzingen in een Azure-Key Vault. Gebruiksvoorbeeld: Een lijst met alle roltoewijzingen in een bepaald bereik. |
| list |
Itereert alle beschikbare roldefinities in een Azure-Key Vault. Gebruiksvoorbeeld: Geeft alle roldefinities in een bepaald bereik weer. |
| set |
Hiermee maakt of werkt u een roldefinitie bij in een Azure Key Vault. Gebruiksvoorbeeld: |
Constructordetails
KeyVaultAccessControlClient(string, TokenCredential, AccessControlClientOptions)
Hiermee maakt u een exemplaar van de KeyVaultAccessControlClient.
Gebruiksvoorbeeld:
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)Parameters
- vaultUrl
-
string
de URL van de Key Vault. Deze moet deze vorm hebben: https://${your-key-vault-name}.vault.azure.net. Controleer of deze URL verwijst naar een geldige Key Vault of beheerde HSM-resource. Zie https://aka.ms/azsdk/blog/vault-uri voor meer informatie.
- credential
- TokenCredential
Een object dat de TokenCredential interface implementeert die wordt gebruikt om aanvragen voor de service te verifiëren. Gebruik het @azure/identity pakket om een referentie te maken die aan uw behoeften voldoet.
- options
- AccessControlClientOptions
Opties die worden gebruikt voor het configureren van Key Vault API-aanvragen. Laat deze parameter weg om de standaardconfiguratie te gebruiken.
Eigenschapdetails
vaultUrl
De basis-URL naar de kluis
vaultUrl: stringWaarde van eigenschap
string
Methodedetails
createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)
Hiermee maakt u een roltoewijzing in een Azure-Key Vault.
Gebruiksvoorbeeld:
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);
Hiermee maakt u een nieuwe roltoewijzing.
function createRoleAssignment(roleScope: string, name: string, roleDefinitionId: string, principalId: string, options?: CreateRoleAssignmentOptions): Promise<KeyVaultRoleAssignment>Parameters
- roleScope
-
string
Het bereik van de roltoewijzing.
- name
-
string
De naam van de roltoewijzing. Moet een UUID zijn.
- roleDefinitionId
-
string
De roldefinitie-id die wordt gebruikt in de roltoewijzing.
- principalId
-
string
De principal-id die is toegewezen aan de rol. Dit wordt toegewezen aan de id in De Active Directory. Het kan verwijzen naar een gebruiker, service-principal of beveiligingsgroep.
- options
- CreateRoleAssignmentOptions
De optionele parameters.
Retouren
Promise<KeyVaultRoleAssignment>
deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)
Hiermee verwijdert u roltoewijzingen die eerder zijn gemaakt in een Azure-Key Vault.
Gebruiksvoorbeeld:
const client = new KeyVaultAccessControlClient(url, credentials);
const roleAssignment = await client.createRoleAssignment("/", "295c179b-9ad3-4117-99cd-b1aa66cf4517");
await client.deleteRoleAssignment(roleAssignment.properties.roleScope, roleAssignment.name);
Hiermee verwijdert u een bestaande roltoewijzing.
function deleteRoleAssignment(roleScope: string, name: string, options?: DeleteRoleAssignmentOptions): Promise<void>Parameters
- roleScope
-
string
Het bereik van de roltoewijzing.
- name
-
string
De naam van de roltoewijzing.
- options
- DeleteRoleAssignmentOptions
De optionele parameters.
Retouren
Promise<void>
deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)
Hiermee verwijdert u een aangepaste roldefinitie die eerder is gemaakt in een Azure-Key Vault.
Gebruiksvoorbeeld:
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>Parameters
- roleScope
-
string
Het bereik van de roldefinitie.
- name
-
string
De naam van de roldefinitie die u wilt verwijderen.
- options
- DeleteRoleDefinitionOptions
De optionele parameters.
Retouren
Promise<void>
getRoleAssignment(string, string, GetRoleAssignmentOptions)
Hiermee haalt u roltoewijzingen op die eerder zijn gemaakt in een Azure-Key Vault.
Gebruiksvoorbeeld:
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);
Hiermee haalt u een bestaande roltoewijzing op.
function getRoleAssignment(roleScope: string, name: string, options?: GetRoleAssignmentOptions): Promise<KeyVaultRoleAssignment>Parameters
- roleScope
-
string
Het bereik van de roltoewijzing.
- name
-
string
De naam van de roltoewijzing.
- options
- GetRoleAssignmentOptions
De optionele parameters.
Retouren
Promise<KeyVaultRoleAssignment>
getRoleDefinition(string, string, GetRoleDefinitionOptions)
Hiermee haalt u een roldefinitie op van Azure Key Vault.
Gebruiksvoorbeeld:
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>Parameters
- roleScope
-
string
Het bereik van de roldefinitie.
- name
-
string
De naam van de roldefinitie.
- options
- GetRoleDefinitionOptions
De optionele parameters.
Retouren
Promise<KeyVaultRoleDefinition>
listRoleAssignments(string, ListRoleAssignmentsOptions)
Itereert alle beschikbare roltoewijzingen in een Azure-Key Vault.
Gebruiksvoorbeeld:
let client = new KeyVaultAccessControlClient(url, credentials);
for await (const roleAssignment of client.listRoleAssignments("/")) {
console.log("Role assignment: ", roleAssignment);
}
Een lijst met alle roltoewijzingen in een bepaald bereik.
function listRoleAssignments(roleScope: string, options?: ListRoleAssignmentsOptions): PagedAsyncIterableIterator<KeyVaultRoleAssignment, KeyVaultRoleAssignment[], PageSettings>Parameters
- roleScope
-
string
Het bereik van de roltoewijzingen.
- options
- ListRoleAssignmentsOptions
De optionele parameters.
Retouren
listRoleDefinitions(string, ListRoleDefinitionsOptions)
Itereert alle beschikbare roldefinities in een Azure-Key Vault.
Gebruiksvoorbeeld:
let client = new KeyVaultAccessControlClient(url, credentials);
for await (const roleDefinitions of client.listRoleDefinitions("/")) {
console.log("Role definition: ", roleDefinitions);
}
Geeft alle roldefinities in een bepaald bereik weer.
function listRoleDefinitions(roleScope: string, options?: ListRoleDefinitionsOptions): PagedAsyncIterableIterator<KeyVaultRoleDefinition, KeyVaultRoleDefinition[], PageSettings>Parameters
- roleScope
-
string
Het bereik van de roldefinitie.
- options
- ListRoleDefinitionsOptions
De optionele parameters.
Retouren
setRoleDefinition(string, SetRoleDefinitionOptions)
Hiermee maakt of werkt u een roldefinitie bij in een Azure Key Vault.
Gebruiksvoorbeeld:
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>Parameters
- roleScope
-
string
Het bereik van de roldefinitie.
- options
- SetRoleDefinitionOptions
De optionele parameters.
Retouren
Promise<KeyVaultRoleDefinition>