Package com.azure.security.keyvault.administration.models

Class SetRoleDefinitionOptions

java.lang.Object

com.azure.security.keyvault.administration.models.SetRoleDefinitionOptions

public final class SetRoleDefinitionOptions
extends Object

Represents the configurable options to create or update a role definition.

Constructor Summary

Constructors

Constructor	Description
SetRoleDefinitionOptions(KeyVaultRoleScope roleScope)	Creates an instance of SetRoleDefinitionOptions with an automatically generated name.
SetRoleDefinitionOptions(KeyVaultRoleScope roleScope, String roleDefinitionName)	Creates an instance of SetRoleDefinitionOptions.

Method Summary

Modifier and Type	Method	Description
List<KeyVaultRoleScope>	getAssignableScopes()	Get the role definition's assignable scopes.
String	getDescription()	Get the role description.
List<KeyVaultPermission>	getPermissions()	Get the role definition's permissions.
String	getRoleDefinitionName()	Get the name of the KeyVaultRoleDefinition to create or update.
String	getRoleName()	Get the role name.
KeyVaultRoleScope	getRoleScope()	Get the role scope of the KeyVaultRoleDefinition to create or update.
SetRoleDefinitionOptions	setAssignableScopes(List<KeyVaultRoleScope> assignableScopes)	Set the role definition's assignable scopes.
SetRoleDefinitionOptions	setDescription(String description)	Set the role description.
SetRoleDefinitionOptions	setPermissions(List<KeyVaultPermission> permissions)	Set the role definition's permissions.
SetRoleDefinitionOptions	setRoleName(String roleName)	Set the role name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SetRoleDefinitionOptions

public SetRoleDefinitionOptions(KeyVaultRoleScope roleScope)

Creates an instance of SetRoleDefinitionOptions with an automatically generated name.

Parameters:

roleScope - The role scope of the KeyVaultRoleDefinition to create. Managed HSM only supports '/'.

SetRoleDefinitionOptions

public SetRoleDefinitionOptions(KeyVaultRoleScope roleScope,
                                String roleDefinitionName)

Creates an instance of SetRoleDefinitionOptions.

Parameters:

roleScope - The role scope of the KeyVaultRoleDefinition to create. Managed HSM only supports '/'.

roleDefinitionName - The name of the KeyVaultRoleDefinition. It can be any valid UUID.

Method Detail

getRoleScope

public KeyVaultRoleScope getRoleScope()

Get the role scope of the KeyVaultRoleDefinition to create or update.

Returns:

The role scope of the KeyVaultRoleDefinition.

getRoleDefinitionName

public String getRoleDefinitionName()

Get the name of the KeyVaultRoleDefinition to create or update.

Returns:

The name of the KeyVaultRoleDefinition.

getRoleName

public String getRoleName()

Get the role name.

Returns:

The role name.

setRoleName

public SetRoleDefinitionOptions setRoleName(String roleName)

Set the role name.

Parameters:

roleName - The role name to set.

Returns:

The updated SetRoleDefinitionOptions object.

getDescription

public String getDescription()

Get the role description.

Returns:

The role description.

setDescription

public SetRoleDefinitionOptions setDescription(String description)

Set the role description.

Parameters:

description - The role description to set.

Returns:

The updated SetRoleDefinitionOptions object.

getPermissions

public List<KeyVaultPermission> getPermissions()

Get the role definition's permissions.

Returns:

The role definition's permissions.

setPermissions

public SetRoleDefinitionOptions setPermissions(List<KeyVaultPermission> permissions)

Set the role definition's permissions.

Parameters:

permissions - The role definition's permissions to set.

Returns:

The updated SetRoleDefinitionOptions object.

getAssignableScopes

public List<KeyVaultRoleScope> getAssignableScopes()

Get the role definition's assignable scopes.

Returns:

The role definition's assignable scopes.

setAssignableScopes

public SetRoleDefinitionOptions setAssignableScopes(List<KeyVaultRoleScope> assignableScopes)

Set the role definition's assignable scopes.

Parameters:

assignableScopes - The role definition's assignable scopes to set.

Returns:

The updated SetRoleDefinitionOptions object.