GetRoleDefinition

Use this data source to access information about an existing Role Definition.

Example Usage

Coming soon!

Using GetRoleDefinition

function getRoleDefinition(args: GetRoleDefinitionArgs, opts?: InvokeOptions): Promise<GetRoleDefinitionResult>

function  get_role_definition(name=None, role_definition_id=None, scope=None, opts=None)

func LookupRoleDefinition(ctx *Context, args *LookupRoleDefinitionArgs, opts ...InvokeOption) (*LookupRoleDefinitionResult, error)

Note: This function is named LookupRoleDefinition in the Go SDK.

public static class GetRoleDefinition {
    public static Task<GetRoleDefinitionResult> InvokeAsync(GetRoleDefinitionArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: Specifies the Name of either a built-in or custom Role Definition.
RoleDefinitionId string: Specifies the ID of the Role Definition as a UUID/GUID.
Scope string: Specifies the Scope at which the Custom Role Definition exists.

Name string: Specifies the Name of either a built-in or custom Role Definition.
RoleDefinitionId string: Specifies the ID of the Role Definition as a UUID/GUID.
Scope string: Specifies the Scope at which the Custom Role Definition exists.

name string: Specifies the Name of either a built-in or custom Role Definition.
roleDefinitionId string: Specifies the ID of the Role Definition as a UUID/GUID.
scope string: Specifies the Scope at which the Custom Role Definition exists.

name str: Specifies the Name of either a built-in or custom Role Definition.
role_definition_id str: Specifies the ID of the Role Definition as a UUID/GUID.
scope str: Specifies the Scope at which the Custom Role Definition exists.

GetRoleDefinition Result

The following output properties are available:

AssignableScopes List<string>: One or more assignable scopes for this Role Definition, such as /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333, /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup, or /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM.
Description string: the Description of the built-in Role.
Id string: The provider-assigned unique ID for this managed resource.
Name string
Permissions List<GetRoleDefinitionPermission>: a permissions block as documented below.
RoleDefinitionId string
Type string: the Type of the Role.
Scope string

AssignableScopes []string: One or more assignable scopes for this Role Definition, such as /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333, /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup, or /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM.
Description string: the Description of the built-in Role.
Id string: The provider-assigned unique ID for this managed resource.
Name string
Permissions []GetRoleDefinitionPermission: a permissions block as documented below.
RoleDefinitionId string
Type string: the Type of the Role.
Scope string

assignableScopes string[]: One or more assignable scopes for this Role Definition, such as /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333, /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup, or /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM.
description string: the Description of the built-in Role.
id string: The provider-assigned unique ID for this managed resource.
name string
permissions GetRoleDefinitionPermission[]: a permissions block as documented below.
roleDefinitionId string
type string: the Type of the Role.
scope string

assignable_scopes List[str]: One or more assignable scopes for this Role Definition, such as /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333, /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup, or /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM.
description str: the Description of the built-in Role.
id str: The provider-assigned unique ID for this managed resource.
name str
permissions List[GetRoleDefinitionPermission]: a permissions block as documented below.
role_definition_id str
type str: the Type of the Role.
scope str

Supporting Types

GetRoleDefinitionPermission

See the output API doc for this type.

Actions List<string>: a list of actions supported by this role
NotActions List<string>: a list of actions which are denied by this role
DataActions List<string>
NotDataActions List<string>

Actions []string: a list of actions supported by this role
NotActions []string: a list of actions which are denied by this role
DataActions []string
NotDataActions []string

actions string[]: a list of actions supported by this role
notActions string[]: a list of actions which are denied by this role
dataActions string[]
notDataActions string[]

actions List[str]: a list of actions supported by this role
notActions List[str]: a list of actions which are denied by this role
dataActions List[str]
notDataActions List[str]

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetRoleDefinition

Example Usage

Using GetRoleDefinition

GetRoleDefinition Result

Supporting Types

GetRoleDefinitionPermission

Package Details

On This Page