Get-PnPPlannerRosterPlan
SYNOPSIS
Required Permissions
- Microsoft Graph API: One of Tasks.Read or Tasks.ReadWrite (delegated), or one of Tasks.Read.All or Tasks.ReadWrite.All (application)
Returns Microsoft Planner roster plans for a specific Microsoft Planner Roster or a specific user
SYNTAX
Get-PnPPlannerRosterPlan [-Identity <PlannerRosterPipeBind>] [-User <string>]
DESCRIPTION
This cmdlet returns Microsoft Planner roster plans for a specific Microsoft Planner Roster or a specific user
The Microsoft Planner Roster APIs this cmdlet uses are only available through the beta endpoint of Microsoft Graph. Microsoft can change the permissions they require without notice, so verify the permissions above against Microsoft Learn if a call is unexpectedly denied.
EXAMPLES
Example 1
Get-PnPPlannerRosterPlan -Identity "abcdefgh"
Returns all plans inside the roster with the provided identifier
Example 2
Get-PnPPlannerRosterPlan -User "johndoe@contoso.onmicrosoft.com"
Returns all roster plans for the provided user
PARAMETERS
-Identity
A Microsoft Planner Roster Id or instance. Documentation: https://learn.microsoft.com/graph/api/plannerroster-list-plans?view=graph-rest-beta&tabs=http
Type: PlannerGroupPipeBind
Parameter Sets: BYROSTER
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-User
The user principal name to query for. Documentation: https://learn.microsoft.com/graph/api/planneruser-list-rosterplans?view=graph-rest-beta&tabs=http
Type: String
Parameter Sets: BYUSER
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
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.