M365 PowerShell

Using New-MgPlannerBucket in Graph PowerShell

Creating and managing buckets within Microsoft Planner is essential for organizing tasks and projects. The New-MgPlannerBucket cmdlet in Microsoft Graph PowerShell enables administrators to automate the creation of Planner buckets efficiently. This article covers the syntax, usage examples, cmdlet parameters, tips, use cases, and possible errors along with their solutions.

Note: You need planner IDs to work with this cmdlet. Use Get-MgGroupPlannerPlan to get the planner IDs.

Syntax

New-MgPlannerBucket -Name <String> -PlanId <String> [-OrderHint <String>]

Cmdlet Parameters

-Name: Specifies the name of the new bucket.
-PlanId: The ID of the plan where the bucket will be created. You can retrieve this using the Get-MgGroupPlannerPlan cmdlet.
-OrderHint: (Optional) Used to specify the order of the bucket in the plan. It helps in positioning the bucket among other buckets.

Usage Examples

Example 1: Create a Single Bucket

You need to pass the planner ID and the bucket name.

# Retrieve the Planner ID
$plannerId = "ZuDbBVe-D06hmZmgiyWyb8kAEk66"
# Create a new bucket
New-MgPlannerBucket -Name "New Bucket" -PlanId $plannerId

Example 2: Create Multiple Buckets

Bucket names can also be passed as an array.

# Retrieve the Planner ID
$plannerId = "ZuDbBVe-D06hmZmgiyWyb8kAEk66"
# Create multiple buckets
$buckets = @("Bucket 1", "Bucket 2", "Bucket 3")

foreach ($bucket in $buckets) {
    New-MgPlannerBucket -Name $bucket -PlanId $plannerId
}

Example 3: Import Buckets from CSV

Planner IDs and the Bucket names can also be imported from CSV file.

# CSV Format
# Name,PlanId
# Bucket A,
# Bucket B,

# Import CSV data
$csvPath = "C:\path\to\buckets.csv"
$buckets = Import-Csv -Path $csvPath

# Create buckets from CSV data
foreach ($bucket in $buckets) {
    New-MgPlannerBucket -Name $bucket.Name -PlanId $bucket.PlanId
}

Cmdlet Tips

Retrieving Plan IDs: Use the Get-MgGroupPlannerPlan cmdlet to retrieve the Planner IDs required for creating buckets.
Ordering Buckets: Use the -OrderHint parameter to specify the order of the buckets if necessary.
Batch Processing: Automate the creation of multiple buckets by looping through an array or importing from a CSV.

Use Cases

Project Management: Automate the setup of Planner buckets for new projects.
Task Organization: Create predefined buckets for recurring tasks and workflows.
Bulk Operations: Efficiently manage large-scale bucket creation using CSV import.

Possible Errors and Solutions

Error: Invalid Plan ID

Cause: The PlanId provided does not exist or is incorrect.

Solution: Ensure the PlanId is correct by retrieving it using Get-MgGroupPlannerPlan.

Error: Duplicate Bucket Name

Cause: A bucket with the same name already exists in the specified plan.

Solution: Provide unique names for each bucket or check for existing buckets before creation.

Error: Missing Required Parameters

Cause: The -Name or -PlanId parameter is missing.

Solution: Ensure all required parameters are provided.

Error: Insufficient Permissions

Cause: The user does not have sufficient permissions to create buckets.

Solution: Ensure the user has the necessary permissions in Microsoft Planner. Group.ReadWrite.All is the required Graph API permission.

Conclusion

The New-MgPlannerBucket cmdlet is a powerful tool for automating the creation and management of buckets in Microsoft Planner. By following the syntax and examples provided in this article, administrators can efficiently set up and organize tasks within their plans. Proper error handling and the use of cmdlet tips can further streamline the process, ensuring a smooth and error-free experience.

For further details, refer to the official Microsoft documentation.

Additional Resources

Graph PowerShell New-MgPlannerBucket cmdlet documenation
Microsoft Graph PowerShell Module Documentation
Microsoft Graph API Documentation

Using Get-MgDirectoryRole in Graph PowerShell
Using Get-MgUserLicenseDetail in Graph PowerShell
Using Find-GraphMgCommand in Graph PowerShell
Connect to Microsoft 365 Using PowerShell
How to Create Bulk Users in Office 365 Using Graph PowerShell?
Create Microsoft 365 Group Using Microsoft Graph PowerShell
Block Microsoft 365 User Using Microsoft Graph PowerShell
Assign Microsoft 365 License Using Graph PowerShell
Microsoft 365 User Management Using Graph PowerShell
Checking Group Membership in Microsoft 365
Bulk Assign Microsoft 365 License
Find Inactive Users in Microsoft 365
Using Powershell Graph Search Query
Using Powershell Graph Filter Query
Using Where-Object In Graph PowerShell
Using Expand Property In Graph PowerShell
Using Select Object In Graph PowerShell
Using -Contains Operator In Graph PowerShell
Add User to Multiple Microsoft 365 Groups Using Graph PowerShell
Get Microsoft 365 User Location Using Graph PowerShell
Import Microsoft 365 Groups from CSV File Using Graph PowerShell
Microsoft 365 Group User Import Using Graph PowerShell