SetRoleDefinitionOptions interface

  • Reference
Package:
@azure/keyvault-admin

An interface representing optional parameters passed to setRoleDefinition(string, SetRoleDefinitionOptions).

Extends
OperationOptions

Properties

assignableScopes

List of assignable Key Vault role scopes
description

Long-form description of the role definition.
permissions

List of Key Vault permissions
roleDefinitionName

UUID used as the name of the role definition to create. If it's not provided, a new UUID will be generated.
roleName

Friendly display name for the role definition.

Inherited Properties

abortSignal

The signal which can be used to abort requests.
onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions

Options used when creating and sending HTTP requests for this operation.
serializerOptions

Options to override serialization/de-serialization behavior.
tracingOptions

Options used when tracing is enabled.

Property Details

assignableScopes

List of assignable Key Vault role scopes

assignableScopes?: string[]

Property Value

string[]

description

Long-form description of the role definition.

description?: string

Property Value

string

permissions

List of Key Vault permissions

permissions?: KeyVaultPermission[]

Property Value

KeyVaultPermission[]

roleDefinitionName

UUID used as the name of the role definition to create. If it's not provided, a new UUID will be generated.

roleDefinitionName?: string

Property Value

string

roleName

Friendly display name for the role definition.

roleName?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions