141 строка
13 KiB
YAML
141 строка
13 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper"
|
|
fullName: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper"
|
|
name: "RoleAssignmentHelper"
|
|
nameWithType: "RoleAssignmentHelper"
|
|
summary: "A utility class to operate on role assignments for a resource with service principal (object id)."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **RoleAssignmentHelper**"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.RoleAssignmentHelper(com.azure.resourcemanager.authorization.AuthorizationManager,com.azure.resourcemanager.resources.fluentcore.dag.TaskGroup,com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.IdProvider)"
|
|
fullName: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.RoleAssignmentHelper(AuthorizationManager authorizationManager, TaskGroup taskGroup, RoleAssignmentHelper.IdProvider idProvider)"
|
|
name: "RoleAssignmentHelper(AuthorizationManager authorizationManager, TaskGroup taskGroup, RoleAssignmentHelper.IdProvider idProvider)"
|
|
nameWithType: "RoleAssignmentHelper.RoleAssignmentHelper(AuthorizationManager authorizationManager, TaskGroup taskGroup, RoleAssignmentHelper.IdProvider idProvider)"
|
|
summary: "Creates Role<wbr>Assignment<wbr>Helper."
|
|
parameters:
|
|
- description: "the graph rbac manager"
|
|
name: "authorizationManager"
|
|
type: "<xref href=\"com.azure.resourcemanager.authorization.AuthorizationManager?alt=com.azure.resourcemanager.authorization.AuthorizationManager&text=AuthorizationManager\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the pre-run task group after which role assignments create/remove tasks should run"
|
|
name: "taskGroup"
|
|
type: "<xref href=\"com.azure.resourcemanager.resources.fluentcore.dag.TaskGroup?alt=com.azure.resourcemanager.resources.fluentcore.dag.TaskGroup&text=TaskGroup\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the provider that provides service principal id and resource id"
|
|
name: "idProvider"
|
|
type: "<xref href=\"com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.IdProvider?alt=com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.IdProvider&text=IdProvider\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public RoleAssignmentHelper(AuthorizationManager authorizationManager, TaskGroup taskGroup, RoleAssignmentHelper.IdProvider idProvider)"
|
|
desc: "Creates RoleAssignmentHelper."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.withAccessTo(java.lang.String,com.azure.resourcemanager.authorization.models.BuiltInRole)"
|
|
fullName: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.withAccessTo(String scope, BuiltInRole asRole)"
|
|
name: "withAccessTo(String scope, BuiltInRole asRole)"
|
|
nameWithType: "RoleAssignmentHelper.withAccessTo(String scope, BuiltInRole asRole)"
|
|
summary: "Specifies that applications running on an Azure service with this identity requires the given access role with scope of access limited to the ARM resource identified by the resource ID specified in the scope parameter."
|
|
parameters:
|
|
- description: "scope of the access represented in ARM resource ID format"
|
|
name: "scope"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "access role to assigned to the identity"
|
|
name: "asRole"
|
|
type: "<xref href=\"com.azure.resourcemanager.authorization.models.BuiltInRole?alt=com.azure.resourcemanager.authorization.models.BuiltInRole&text=BuiltInRole\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public RoleAssignmentHelper withAccessTo(String scope, BuiltInRole asRole)"
|
|
desc: "Specifies that applications running on an Azure service with this identity requires the given access role with scope of access limited to the ARM resource identified by the resource ID specified in the scope parameter."
|
|
returns:
|
|
description: "RoleAssignmentHelper"
|
|
type: "<xref href=\"com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper?alt=com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper&text=RoleAssignmentHelper\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.withAccessTo(java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.withAccessTo(String scope, String roleDefinitionId)"
|
|
name: "withAccessTo(String scope, String roleDefinitionId)"
|
|
nameWithType: "RoleAssignmentHelper.withAccessTo(String scope, String roleDefinitionId)"
|
|
summary: "Specifies that applications running on an Azure service with this identity requires the access described in the given role definition with scope of access limited to an ARM resource."
|
|
parameters:
|
|
- description: "scope of the access represented in ARM resource ID format"
|
|
name: "scope"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "access role definition to assigned to the identity"
|
|
name: "roleDefinitionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public RoleAssignmentHelper withAccessTo(String scope, String roleDefinitionId)"
|
|
desc: "Specifies that applications running on an Azure service with this identity requires the access described in the given role definition with scope of access limited to an ARM resource."
|
|
returns:
|
|
description: "RoleAssignmentHelper"
|
|
type: "<xref href=\"com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper?alt=com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper&text=RoleAssignmentHelper\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.withAccessToCurrentResourceGroup(com.azure.resourcemanager.authorization.models.BuiltInRole)"
|
|
fullName: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.withAccessToCurrentResourceGroup(BuiltInRole asRole)"
|
|
name: "withAccessToCurrentResourceGroup(BuiltInRole asRole)"
|
|
nameWithType: "RoleAssignmentHelper.withAccessToCurrentResourceGroup(BuiltInRole asRole)"
|
|
summary: "Specifies that applications running on an Azure service with this identity requires the given access role with scope of access limited to the current resource group that the identity resides."
|
|
parameters:
|
|
- description: "access role to assigned to the identity"
|
|
name: "asRole"
|
|
type: "<xref href=\"com.azure.resourcemanager.authorization.models.BuiltInRole?alt=com.azure.resourcemanager.authorization.models.BuiltInRole&text=BuiltInRole\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public RoleAssignmentHelper withAccessToCurrentResourceGroup(BuiltInRole asRole)"
|
|
desc: "Specifies that applications running on an Azure service with this identity requires the given access role with scope of access limited to the current resource group that the identity resides."
|
|
returns:
|
|
description: "RoleAssignmentHelper"
|
|
type: "<xref href=\"com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper?alt=com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper&text=RoleAssignmentHelper\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.withAccessToCurrentResourceGroup(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.withAccessToCurrentResourceGroup(String roleDefinitionId)"
|
|
name: "withAccessToCurrentResourceGroup(String roleDefinitionId)"
|
|
nameWithType: "RoleAssignmentHelper.withAccessToCurrentResourceGroup(String roleDefinitionId)"
|
|
summary: "Specifies that applications running on an Azure service with this identity requires the given access role with scope of access limited to the current resource group that the identity resides."
|
|
parameters:
|
|
- description: "access role definition to assigned to the identity"
|
|
name: "roleDefinitionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public RoleAssignmentHelper withAccessToCurrentResourceGroup(String roleDefinitionId)"
|
|
desc: "Specifies that applications running on an Azure service with this identity requires the given access role with scope of access limited to the current resource group that the identity resides."
|
|
returns:
|
|
description: "RoleAssignmentHelper"
|
|
type: "<xref href=\"com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper?alt=com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper&text=RoleAssignmentHelper\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.withoutAccessTo(com.azure.resourcemanager.authorization.models.RoleAssignment)"
|
|
fullName: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.withoutAccessTo(RoleAssignment roleAssignment)"
|
|
name: "withoutAccessTo(RoleAssignment roleAssignment)"
|
|
nameWithType: "RoleAssignmentHelper.withoutAccessTo(RoleAssignment roleAssignment)"
|
|
summary: "Specifies that an access role assigned to the identity should be removed."
|
|
parameters:
|
|
- description: "a role assigned to the identity"
|
|
name: "roleAssignment"
|
|
type: "<xref href=\"com.azure.resourcemanager.authorization.models.RoleAssignment?alt=com.azure.resourcemanager.authorization.models.RoleAssignment&text=RoleAssignment\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public RoleAssignmentHelper withoutAccessTo(RoleAssignment roleAssignment)"
|
|
desc: "Specifies that an access role assigned to the identity should be removed."
|
|
returns:
|
|
description: "RoleAssignmentHelper"
|
|
type: "<xref href=\"com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper?alt=com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper&text=RoleAssignmentHelper\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.withoutAccessTo(java.lang.String,com.azure.resourcemanager.authorization.models.BuiltInRole)"
|
|
fullName: "com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper.withoutAccessTo(String scope, BuiltInRole asRole)"
|
|
name: "withoutAccessTo(String scope, BuiltInRole asRole)"
|
|
nameWithType: "RoleAssignmentHelper.withoutAccessTo(String scope, BuiltInRole asRole)"
|
|
summary: "Specifies that an access role assigned to the identity should be removed."
|
|
parameters:
|
|
- description: "the scope of the role assignment"
|
|
name: "scope"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "the role of the role assignment"
|
|
name: "asRole"
|
|
type: "<xref href=\"com.azure.resourcemanager.authorization.models.BuiltInRole?alt=com.azure.resourcemanager.authorization.models.BuiltInRole&text=BuiltInRole\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public RoleAssignmentHelper withoutAccessTo(String scope, BuiltInRole asRole)"
|
|
desc: "Specifies that an access role assigned to the identity should be removed."
|
|
returns:
|
|
description: "RoleAssignmentHelper"
|
|
type: "<xref href=\"com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper?alt=com.azure.resourcemanager.authorization.utils.RoleAssignmentHelper&text=RoleAssignmentHelper\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A utility class to operate on role assignments for a resource with service principal (object id). This type is used for internal implementations, client should not take dependency on this as the method signature and behaviour can change in future releases."
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.authorization.utils"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-authorization:2.44.0
|