Identity.UpdateStages.WithAccess Interface

public static interface Identity.UpdateStages.WithAccess

The stage of the identity update allowing to set access role (permission) for it to access a resource or remove an assigned role.

Method Summary

Modifier and Type Method and Description
abstract Update withAccessTo(Resource resource, BuiltInRole role)

Specifies that the identity should have the given access (described by the role) on an ARM resource.

abstract Update withAccessTo(Resource resource, String roleDefinitionId)

Specifies that the identity should have the given access (described by the role definition) on an ARM resource.

abstract Update withAccessTo(String resourceId, BuiltInRole role)

Specifies that the identity should have the given access (described by the role) on an ARM resource identified by the given resource id.

abstract Update withAccessTo(String resourceId, String roleDefinitionId)

Specifies that the identity should have the given access (described by the role definition) on an ARM resource identified by the given resource id.

abstract Update withAccessToCurrentResourceGroup(BuiltInRole role)

Specifies that the identity should have the given access (described by the role) on the resource group that identity resides.

abstract Update withAccessToCurrentResourceGroup(String roleDefinitionId)

Specifies that the identity should have the given access (described by the role definition) on the resource group that identity resides.

abstract Update withoutAccess(RoleAssignment roleAssignment)

Specifies that an access role assigned to the identity should be removed.

abstract Update withoutAccessTo(String resourceId, BuiltInRole role)

Specifies that an access role assigned to the identity should be removed.

Method Details

withAccessTo

public abstract Identity.Update withAccessTo(Resource resource, BuiltInRole role)

Specifies that the identity should have the given access (described by the role) on an ARM resource. An applications running on an Azure service with this identity can use this permission to access the resource.

Parameters:

resource - the resource to access
role - access role to assigned to the identity

Returns:

the next stage of the update

withAccessTo

public abstract Identity.Update withAccessTo(Resource resource, String roleDefinitionId)

Specifies that the identity should have the given access (described by the role definition) on an ARM resource. An applications running on an Azure service with this identity can use this permission to access the resource.

Parameters:

resource - scope of the access represented as ARM resource
roleDefinitionId - access role definition to assigned to the identity

Returns:

the next stage of the update

withAccessTo

public abstract Identity.Update withAccessTo(String resourceId, BuiltInRole role)

Specifies that the identity should have the given access (described by the role) on an ARM resource identified by the given resource id. An applications running on an Azure service with this identity can use this permission to access the resource.

Parameters:

resourceId - id of the resource to access
role - access role to assigned to the identity

Returns:

the next stage of the update

withAccessTo

public abstract Identity.Update withAccessTo(String resourceId, String roleDefinitionId)

Specifies that the identity should have the given access (described by the role definition) on an ARM resource identified by the given resource id. An applications running on an Azure service with this identity can use this permission to access the resource.

Parameters:

resourceId - id of the resource to access
roleDefinitionId - access role definition to assigned to the identity

Returns:

the next stage of the update

withAccessToCurrentResourceGroup

public abstract Identity.Update withAccessToCurrentResourceGroup(BuiltInRole role)

Specifies that the identity should have the given access (described by the role) on the resource group that identity resides. An applications running on an Azure service with this identity can use this permission to access the resource group.

Parameters:

role - access role to assigned to the identity

Returns:

the next stage of the update

withAccessToCurrentResourceGroup

public abstract Identity.Update withAccessToCurrentResourceGroup(String roleDefinitionId)

Specifies that the identity should have the given access (described by the role definition) on the resource group that identity resides. An applications running on an Azure service with this identity can use this permission to access the resource group.

Parameters:

roleDefinitionId - access role definition to assigned to the identity

Returns:

the next stage of the update

withoutAccess

public abstract Identity.Update withoutAccess(RoleAssignment roleAssignment)

Specifies that an access role assigned to the identity should be removed.

Parameters:

roleAssignment - describes an existing role assigned to the identity

Returns:

the next stage of the update

withoutAccessTo

public abstract Identity.Update withoutAccessTo(String resourceId, BuiltInRole role)

Specifies that an access role assigned to the identity should be removed.

Parameters:

resourceId - id of the resource that identity has access
role - the access role assigned to the identity

Returns:

the next stage of the update

Applies to