Get-Whiteboard

Module:

MicrosoftWhiteboardAdmin

Applies to:

Microsoft Whiteboard

Gets one or more whiteboards from the Microsoft Whiteboard service and returns them as objects.

Syntax

Get-Whiteboard
   [-UserId] <Guid>
   [[-WhiteboardId] <Guid>]
   [-ForceAuthPrompt]
   [<CommonParameters>]

Description

Gets one or more whiteboards from the Microsoft Whiteboard service and returns them as objects.

Examples

EXAMPLE 1

PS C:\>Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001

Get all of a user's whiteboards.

EXAMPLE 2

PS C:\>Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 -WhiteboardId 00000000-0000-0000-0000-000000000002

Get a user's specific whiteboard.

Output

baseApi:                   baseApi-value
id:                        whiteboardId-value
userId:                    userId-value
folioId:                   folioId-value
title:                     title-value
createdBy:                 createdBy-value
ownerId:                   ownerId-value
ownerTenantId:             ownerTenantId-value
isShared:                  isShared-value
createdTime:               createdTime-value
invitedTime:               invitedTime-value
personalLastModifiedTime:  personalLastModifiedTime-value
lastModifiedTime:          lastModifiedTime-value
globalLastViewedTime:      globalLastViewedTime-value
lastViewedTime:            lastViewedTime-value
meetingId:                 meetingId-value
eTag:                      eTag-value

Parameters

-ForceAuthPrompt

Optional. Always prompt for auth. Use to ignore cached credentials.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Whiteboard

-UserId

The ID of the user account to query whiteboards for. All whiteboards this account has access to will be returned.

Type:	Guid
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Whiteboard

-WhiteboardId

Optional. The ID of a specific whiteboard.

Type:	Guid
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Whiteboard

Notes

For details on user IDs, see the overview page.