Edit

Share via

Get-Whiteboard

Module:
WhiteboardAdmin Module

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

Syntax

Default (Default) 

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

Description

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

Examples

EXAMPLE 1

Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001

Get all of a user's whiteboards.

EXAMPLE 2

Get a user's specific whiteboard.

Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 -WhiteboardId 00000000-0000-0000-0000-000000000002

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.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserId

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

Parameter properties

Type:System.Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhiteboardId

(Optional) The ID of a specific Whiteboard to query, if not specified all whiteboards are queried.

Parameter properties

Type:System.Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Notes

For details on user IDs, see the overview page.