Skip to content
This repository was archived by the owner on Jan 29, 2022. It is now read-only.

Latest commit

 

History

History
122 lines (90 loc) · 2.53 KB

Set-CrmRolePrincipals.md

File metadata and controls

122 lines (90 loc) · 2.53 KB
external help file Module Name online version schema
AMSoftware.Crm.PowerShell.Commands.dll-Help.xml
AMSoftware.Crm
2.0.0

Set-CrmRolePrincipals

SYNOPSIS

Set the teams or users assigned to a role.

SYNTAX

Set-CrmRolePrincipals [-Role] <Guid[]> [-PrincipalType] <CrmPrincipalType> -Principals <Guid[]> [-Overwrite]
 [-PassThru] [<CommonParameters>]

DESCRIPTION

Set the teams or users assigned to a role.

EXAMPLES

PARAMETERS

-Overwrite

Overwrite the existing users and teams assigned to the role. If omitted the users and teams will be merged.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Returns an object that represents the role. By default, this cmdlet does not generate any output.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Principals

The id of the users or teams to assign to the role.

Type: System.Guid[]
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PrincipalType

The type of principal to assign.

Type: AMSoftware.Crm.PowerShell.Common.CrmPrincipalType
Parameter Sets: (All)
Aliases:
Accepted values: User, Team

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Role

The id of the role to assign the principals to.

Type: System.Guid[]
Parameter Sets: (All)
Aliases: Id

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.Guid[]

OUTPUTS

Microsoft.Xrm.Sdk.Entity

NOTES

RELATED LINKS

Get-CrmPrincipalRoles

Get-CrmRolePrincipals

Set-CrmPrincipalRoles