Add-MsolScopedRoleMember

  • Article

Note



  • The cmdlets were previously known as the Microsoft Online Services Module for Windows PowerShell cmdlets.

The Add-MsolScopedRoleMember cmdlet is used to add a member to an administrative unit-scoped role.

Syntax

Add-MsolScopedRoleMember -RoleObjectId <Guid> -AdministrativeUnitObjectId <Guid> -RoleMemberObjectId <Guid> [-RoleMemberUserPrincipalName <String>] [-TenantId <Guid>][<CommonParameters>]

Add-MsolScopedRoleMember -RoleObjectId <Guid> -AdministrativeUnitObjectId <Guid> -RoleMemberUserPrincipalName <String> [-RoleMemberUserPrincipalName <String>] [-TenantId <Guid>][<CommonParameters>]

Parameters

   -RoleObjectId <Guid>
        The role to add members to. Only users can be added to a role (adding 
        a security group is not supported). 
        
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-AdministrativeUnitObjectId <Guid> 
The object ID of the administrative unit.
Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-RoleMemberType <string>
        The type of role of the member to add. Only users can be added to a 
        role (adding a security group is not supported).
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       true (ByPropertyName)
        Accept wildcard characters?  false

 -RoleMemberObjectId <Guid>
The object ID of the member to add to the role scoped to the administrative unit. For users, this should be the user ID. Only users can be added to a role (adding a security group is not 
supported). 
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       true (ByPropertyName)
        Accept wildcard characters?  false
        
    -RoleMemberUserPrincipalName <String>
        The user principal name of the member to add. Only users can be added to a role (adding a security group is not supported). 
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       true (ByPropertyName)
        Accept wildcard characters?  false
          
    -TenantId <Guid>
        The unique ID of the tenant to perform the operation on. If this is 
        not provided, then the value will default to the tenant of the current user. This parameter is only applicable to partner users.
        
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       true (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer and OutVariable. For more information, type,
        "get-help about_commonparameters".

Examples

In the following example, user@contoso.com is added as a member to the “User Account Administrator” role scoped for administrative unit “West Coast”.

$westcoastau = Get-MsolAdministrativeUnit -searchstring “West Coast” 
$uaadmin = Get-MsolRole -RoleName "User Account Administrator"
$admin1 = Get-MsolUser -UserPrincipalName user@contoso.com
Add-MsolScopedRoleMember -RoleObjectId $uaadmin.ObjectId - AdministrativeUnitObjectId $westcoastau.ObjectId -RoleMemberObjectId $admin1.ObjectId

Additional Resources

There are several other places you can get more information and help. These include:

See Also

Other Resources

Using Administrative Units - Public Preview
Manage Azure Active Directory by using Windows PowerShell