KeyVaultAccessControlClient.CreateRoleAssignmentAsync Method

Definition

Namespace:

Azure.Security.KeyVault.Administration

Assembly:

Azure.Security.KeyVault.Administration.dll

Package:

Azure.Security.KeyVault.Administration v4.5.0

Source:

KeyVaultAccessControlClient.cs

Creates a role assignment.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Administration.KeyVaultRoleAssignment>> CreateRoleAssignmentAsync (Azure.Security.KeyVault.Administration.KeyVaultRoleScope roleScope, string roleDefinitionId, string principalId, Guid? roleAssignmentName = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateRoleAssignmentAsync : Azure.Security.KeyVault.Administration.KeyVaultRoleScope * string * string * Nullable<Guid> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Administration.KeyVaultRoleAssignment>>
override this.CreateRoleAssignmentAsync : Azure.Security.KeyVault.Administration.KeyVaultRoleScope * string * string * Nullable<Guid> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Administration.KeyVaultRoleAssignment>>

Public Overridable Function CreateRoleAssignmentAsync (roleScope As KeyVaultRoleScope, roleDefinitionId As String, principalId As String, Optional roleAssignmentName As Nullable(Of Guid) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KeyVaultRoleAssignment))

Parameters

roleScope

KeyVaultRoleScope

The scope of the role assignment to create.

roleDefinitionId

String

The role definition ID used in the role assignment.

principalId

String

The principal ID assigned to the role. This maps to the ID inside the Active Directory. It can point to a user, service principal, or security group.

roleAssignmentName

Nullable<Guid>

Optional name used to create the role assignment. A new Guid will be generated if not specified.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<Response<KeyVaultRoleAssignment>>

A Task<TResult> containing the result of the asynchronous operation.

Exceptions

RequestFailedException

The server returned an error. See Message for details returned from the server.

ArgumentNullException

roleDefinitionId or principalId is null.

ArgumentException

roleDefinitionId or principalId is empty.