Get-WhiteboardsForTenant
Gets all the whiteboards associated with a tenant in a specified geography.
Syntax
Get-WhiteboardsForTenant
[-Geography <String>]
[-IncrementalRunName <String>]
[-ForceAuthPrompt]
[<CommonParameters>]
Description
Gets all the whiteboards in a tenant in a specified geography. Returns a list of whiteboard objects. The data is pre-calculated approximately every two weeks and is not realtime.
Examples
EXAMPLE 1
This command gets all the whiteboards associated with the caller's tenant in Europe as a list of whiteboard metadata objects.
PS C:\> Get-WhiteboardsForTenant -Geography Europe
baseApi : eu.whiteboard.microsoft.com
id : 00000000-0000-0000-0000-000000000001
userId : 00000000-0000-0000-0000-000000000000
folioId : 00000000-0000-0000-0000-000000000000
title : title1
createdBy : 00000000-0000-0000-0000-000000000000
ownerId : 00000000-0000-0000-0000-000000000000
ownerTenantId : 00000000-0000-0000-0000-000000000000
isShared : False
createdTime : 2022-09-10T19:59:03.3407011Z
invitedTime :
personalLastModifiedTime : 2022-09-11T15:53:32.4494737Z
lastModifiedTime : 2022-09-11T15:53:32.4494737Z
globalLastViewedTime : 2022-09-11T15:55:28.7242817Z
lastViewedTime : 2022-09-11T15:55:28.7242817Z
meetingId :
eTag : W/"datetime'2022-09-11T19%3A23%3A56.2845616Z'"
baseApi : eu.whiteboard.microsoft.com
id : 00000000-0000-0000-0000-000000000002
userId : 00000000-0000-0000-0000-000000000000
folioId : 00000000-0000-0000-0000-000000000000
title : title2
createdBy : 00000000-0000-0000-0000-000000000000
ownerId : 00000000-0000-0000-0000-000000000000
ownerTenantId : 00000000-0000-0000-0000-000000000000
isShared : False
createdTime : 2023-01-06T19:23:04.8807147Z
invitedTime :
personalLastModifiedTime : 2023-01-06T19:23:13.6235107Z
lastModifiedTime : 2023-01-06T19:23:13.6235107Z
globalLastViewedTime : 2023-01-06T19:23:56.0264268Z
lastViewedTime : 2023-01-06T19:23:56.0264268Z
meetingId :
eTag : W/"datetime'2023-01-06T19%3A22%3A42.6717851Z'"
Parameters
-ForceAuthPrompt
Always prompt for authentication. 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 |
-Geography
The geography to look for board owners in. Accepted values are Europe
, Australia
, or Worldwide
(all boards not in Australia or Europe).
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Microsoft Whiteboard |
-IncrementalRunName
Saves incremental progress as the cmdlet runs. Use to resume a partially completed run. Use the same IncrementalRunName value on later calls to continue a previously canceled or failed run. Writes progress and results to .txt
files in the current directory:
Whiteboards-*.txt
contains the incremental results containing whiteboard objects for the tenant where*
is the provided IncrementalRunName.WhiteboardAdminRun-*.txt
contains the current state where*
is the provided IncrementalRunName. This file should not be modified manually.
Type: | String |
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.