IntuneRoleAssignment

Parameters

Parameter Attribute DataType Description Allowed Values
Id Write String The unique idenfier for an entity. Read-only.
Description Write String Description of the Role Assignment.
DisplayName Key String The display or friendly name of the role Assignment.
ResourceScopes Write StringArray[] List of ids of role scope member security groups. These are IDs from Azure Active Directory. Ignored if ScopeType is not 'ResourceScope'
ResourceScopesDisplayNames Write StringArray[] List of DisplayName of role scope member security groups. These are Displayname from Azure Active Directory. Ignored if ScopeType is not 'ResourceScope'
ScopeType Write String Specifies the type of scope for a Role Assignment. Default type 'ResourceScope' allows assignment of ResourceScopes. Possible values are: resourceScope, allDevices, allLicensedUsers, allDevicesAndLicensedUsers.
Members Write StringArray[] The list of ids of role member security groups. These are IDs from Azure Active Directory.
MembersDisplayNames Write StringArray[] The list of Displaynames of role member security groups. These are Displaynamnes from Azure Active Directory.
RoleDefinition Write String The Role Definition Id.
RoleDefinitionDisplayName Write String The Role Definition Displayname.
Ensure Write String Present ensures the Role exists, absent ensures it is removed. Present, Absent
Credential Write PSCredential Credentials of the Intune Admin
ApplicationId Write String Id of the Azure Active Directory application to authenticate with.
TenantId Write String Id of the Azure Active Directory tenant used for authentication.
ApplicationSecret Write PSCredential Secret of the Azure Active Directory tenant used for authentication.
CertificateThumbprint Write String Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication.
ManagedIdentity Write Boolean Managed ID being used for authentication.

Description

This resource configures an Intune Role Assignment.

Permissions

Microsoft Graph

To authenticate with the Microsoft Graph API, this resource required the following permissions:

Delegated permissions

  • Read

    • DeviceManagementRBAC.Read.All
  • Update

    • DeviceManagementRBAC.ReadWrite.All

Application permissions

  • Read

    • DeviceManagementRBAC.Read.All
  • Update

    • DeviceManagementRBAC.ReadWrite.All

Examples

Example 1

This example creates a new Intune Role Assigment.

Configuration Example
{
    param(
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $Credscredential
    )
    Import-DscResource -ModuleName Microsoft365DSC

    Node localhost
    {
        IntuneRoleAssignment 'IntuneRoleAssignment'
        {
            DisplayName                = 'test2'
            Description                = 'test2'
            Members                    = @('')
            MembersDisplayNames        = @('SecGroup2')
            ResourceScopes             = @('6eb76881-f56f-470f-be0d-672145d3dcb1')
            ResourceScopesDisplayNames = @('')
            ScopeType                  = 'resourceScope'
            RoleDefinition             = '2d00d0fd-45e9-4166-904f-b76ac5eed2c7'
            RoleDefinitionDisplayName  = 'This is my role'
            Ensure                     = 'Present'
            Credential                 = $Credscredential
        }
    }
}

Example 2

This example creates a new Intune Role Assigment.

Configuration Example
{
    param(
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $Credscredential
    )
    Import-DscResource -ModuleName Microsoft365DSC

    Node localhost
    {
        IntuneRoleAssignment 'IntuneRoleAssignment'
        {
            DisplayName                = 'test2'
            Description                = 'test Updated' # Updated Property
            Members                    = @('')
            MembersDisplayNames        = @('SecGroup2')
            ResourceScopes             = @('6eb76881-f56f-470f-be0d-672145d3dcb1')
            ResourceScopesDisplayNames = @('')
            ScopeType                  = 'resourceScope'
            RoleDefinition             = '2d00d0fd-45e9-4166-904f-b76ac5eed2c7'
            RoleDefinitionDisplayName  = 'This is my role'
            Ensure                     = 'Present'
            Credential                 = $Credscredential
        }
    }
}

Example 3

This example creates a new Intune Role Assigment.

Configuration Example
{
    param(
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $Credscredential
    )
    Import-DscResource -ModuleName Microsoft365DSC

    Node localhost
    {
        IntuneRoleAssignment 'IntuneRoleAssignment'
        {
            DisplayName                = 'test2'
            Ensure                     = 'Absent'
            Credential                 = $Credscredential
        }
    }
}