Docs
PackagesWe recommend using Azure Native.
azure.role.getRoleDefinition
Explore with Pulumi AI
Deprecated:
azure.role.getRoleDefinition has been deprecated in favor of azure.authorization.getRoleDefinition
Use this data source to access information about an existing Role Definition.
Using getRoleDefinition
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getRoleDefinition(args: GetRoleDefinitionArgs, opts?: InvokeOptions): Promise<GetRoleDefinitionResult>
function getRoleDefinitionOutput(args: GetRoleDefinitionOutputArgs, opts?: InvokeOptions): Output<GetRoleDefinitionResult>def get_role_definition(name: Optional[str] = None,
role_definition_id: Optional[str] = None,
scope: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetRoleDefinitionResult
def get_role_definition_output(name: Optional[pulumi.Input[str]] = None,
role_definition_id: Optional[pulumi.Input[str]] = None,
scope: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetRoleDefinitionResult]func GetRoleDefinition(ctx *Context, args *GetRoleDefinitionArgs, opts ...InvokeOption) (*GetRoleDefinitionResult, error)
func GetRoleDefinitionOutput(ctx *Context, args *GetRoleDefinitionOutputArgs, opts ...InvokeOption) GetRoleDefinitionResultOutput> Note: This function is named GetRoleDefinition in the Go SDK.
public static class GetRoleDefinition
{
public static Task<GetRoleDefinitionResult> InvokeAsync(GetRoleDefinitionArgs args, InvokeOptions? opts = null)
public static Output<GetRoleDefinitionResult> Invoke(GetRoleDefinitionInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetRoleDefinitionResult> getRoleDefinition(GetRoleDefinitionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure:role/getRoleDefinition:getRoleDefinition
arguments:
# arguments dictionaryThe following arguments are supported:
- Name string
Specifies the Name of either a built-in or custom Role Definition.
You can also use this for built-in roles such as
Contributor,Owner,ReaderandVirtual Machine Contributor- Role
Definition stringId Specifies the ID of the Role Definition as a UUID/GUID.
- Scope string
Specifies the Scope at which the Custom Role Definition exists.
Note: One of
nameorrole_definition_idmust be specified.
- Name string
Specifies the Name of either a built-in or custom Role Definition.
You can also use this for built-in roles such as
Contributor,Owner,ReaderandVirtual Machine Contributor- Role
Definition stringId Specifies the ID of the Role Definition as a UUID/GUID.
- Scope string
Specifies the Scope at which the Custom Role Definition exists.
Note: One of
nameorrole_definition_idmust be specified.
- name String
Specifies the Name of either a built-in or custom Role Definition.
You can also use this for built-in roles such as
Contributor,Owner,ReaderandVirtual Machine Contributor- role
Definition StringId Specifies the ID of the Role Definition as a UUID/GUID.
- scope String
Specifies the Scope at which the Custom Role Definition exists.
Note: One of
nameorrole_definition_idmust be specified.
- name string
Specifies the Name of either a built-in or custom Role Definition.
You can also use this for built-in roles such as
Contributor,Owner,ReaderandVirtual Machine Contributor- role
Definition stringId Specifies the ID of the Role Definition as a UUID/GUID.
- scope string
Specifies the Scope at which the Custom Role Definition exists.
Note: One of
nameorrole_definition_idmust be specified.
- name str
Specifies the Name of either a built-in or custom Role Definition.
You can also use this for built-in roles such as
Contributor,Owner,ReaderandVirtual Machine Contributor- role_
definition_ strid Specifies the ID of the Role Definition as a UUID/GUID.
- scope str
Specifies the Scope at which the Custom Role Definition exists.
Note: One of
nameorrole_definition_idmust be specified.
- name String
Specifies the Name of either a built-in or custom Role Definition.
You can also use this for built-in roles such as
Contributor,Owner,ReaderandVirtual Machine Contributor- role
Definition StringId Specifies the ID of the Role Definition as a UUID/GUID.
- scope String
Specifies the Scope at which the Custom Role Definition exists.
Note: One of
nameorrole_definition_idmust be specified.
getRoleDefinition Result
The following output properties are available:
- Assignable
Scopes 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<Get
Role Definition Permission> a
permissionsblock as documented below.- Role
Definition stringId - Type string
the Type of the Role.
- Scope string
- Assignable
Scopes []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
[]Get
Role Definition Permission a
permissionsblock as documented below.- Role
Definition stringId - Type string
the Type of the Role.
- Scope string
- assignable
Scopes 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<Get
Role Definition Permission> a
permissionsblock as documented below.- role
Definition StringId - type String
the Type of the Role.
- scope String
- assignable
Scopes 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
Get
Role Definition Permission[] a
permissionsblock as documented below.- role
Definition stringId - type string
the Type of the Role.
- scope string
- assignable_
scopes Sequence[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
Sequence[Get
Role Definition Permission] a
permissionsblock as documented below.- role_
definition_ strid - type str
the Type of the Role.
- scope str
- assignable
Scopes 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<Property Map>
a
permissionsblock as documented below.- role
Definition StringId - type String
the Type of the Role.
- scope String
Supporting Types
GetRoleDefinitionPermission
- Actions List<string>
a list of actions supported by this role
- Not
Actions List<string> a list of actions which are denied by this role
- Data
Actions List<string> - Not
Data List<string>Actions
- Actions []string
a list of actions supported by this role
- Not
Actions []string a list of actions which are denied by this role
- Data
Actions []string - Not
Data []stringActions
- actions List<String>
a list of actions supported by this role
- not
Actions List<String> a list of actions which are denied by this role
- data
Actions List<String> - not
Data List<String>Actions
- actions string[]
a list of actions supported by this role
- not
Actions string[] a list of actions which are denied by this role
- data
Actions string[] - not
Data string[]Actions
- actions Sequence[str]
a list of actions supported by this role
- not_
actions Sequence[str] a list of actions which are denied by this role
- data_
actions Sequence[str] - not_
data_ Sequence[str]actions
- actions List<String>
a list of actions supported by this role
- not
Actions List<String> a list of actions which are denied by this role
- data
Actions List<String> - not
Data List<String>Actions
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurermTerraform Provider.