Table of Contents

Get-PnPPlannerPlan

SYNOPSIS

Required Permissions

  • Microsoft Graph API: Group.ReadWrite.All
  • Microsoft Graph API: Group.Read.All

Returns all or a specific Planner plan for a Microsoft 365 Group.

SYNTAX

By Group

Get-PnPPlannerPlan -Group <PlannerGroupPipeBind> [-Identity <PlannerPlanPipeBind>] [-ResolveIdentities]
  

By Plan Id

Get-PnPPlannerPlan -Id <String> [-ResolveIdentities]
  

DESCRIPTION

This cmdlet returns all or a specific Planner plan for a Microsoft 365 Group.

EXAMPLES

Example 1

Get-PnPPlannerPlan -Group "Marketing"

Returns all plans for the Marketing group.

Example 2

Get-PnPPlannerPlan -Group "Marketing" -Identity "Conference Plan"

Returns the specified plan for the Marketing group.

Example 3

Get-PnPPlannerPlan -Id "gndWOTSK60GfPQfiDDj43JgACDCb" -ResolveIdentities

Returns the plan with specified ID with resolved identities.

PARAMETERS

-Group

Specify the group containing the plans

Type: PlannerGroupPipeBind
Parameter Sets: By Group
Aliases:

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

-Identity

If specified the plan with this ID or Name will be returned.

Type: PlannerPlanPipeBind
Parameter Sets: By Group
Aliases:

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

-Id

If specified the plan with this ID will be returned.

Type: String
Parameter Sets: By Plan Id
Aliases:

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

-ResolveIdentities

Show user display names instead of user IDs.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
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.

Microsoft 365 Patterns and Practices