Skip to content

Commit c67413c

Browse files
garycentricgarycentric
authored
Merge pull request #12685 from swagh-microsoft/user/shwetawagh/onedrive-whiteboard-docupdate
Admin commands documentation update for whiteboard to get migrated and originally created fluid boards
2 parents fa4e51f + 9d7ff33 commit c67413c

10 files changed

+885
-8
lines changed

‎whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
external help file: WhiteboardAdmin-help.xml
3+
Module Name: WhiteboardAdmin
4+
online version: https://learn.microsoft.com/powershell/module/whiteboard/get-originalfluidwhiteboards
5+
applicable: Microsoft Whiteboard
6+
title: Get-OriginalFluidWhiteboards
7+
schema: 2.0.0
8+
author: shwetawagh
9+
ms.author: shwetawagh
10+
ms.reviewer:
11+
---
12+
13+
# Get-OriginalFluidWhiteboards
14+
15+
## SYNOPSIS
16+
17+
Gets one or more whiteboards that are originally created as Fluid whiteboards, directly into users OneDrive and return them as objects.
18+
19+
## SYNTAX
20+
21+
```powershell
22+
Get-OriginalFluidWhiteboards [-UserId] [-ForceAuthPrompt] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
27+
Gets one or more whiteboards that are originally created as Fluid whiteboards, directly into users OneDrive.
28+
29+
## EXAMPLES
30+
31+
### EXAMPLE 1
32+
33+
```powershell
34+
PS C:\>Get-OriginalFluidWhiteboards -UserId 00000000-0000-0000-0000-000000000001
35+
```
36+
37+
Get all user's whiteboards that are originally created as Fluid whiteboards directly into users OneDrive.
38+
39+
### Output
40+
41+
```yaml
42+
Drive Items found for User 00000000-0000-0000-0000-000000000001 ---------------------------------------------------
43+
Name: TradeTestwhiteboard.whiteboard
44+
ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4
45+
Last Modified: 03/06/2025 09:59:32
46+
Size: 15222 bytes
47+
Migration Date: 03/06/2025 09:58:57
48+
User ID: 00000000-0000-0000-0000-000000000001
49+
User Email: [email protected]
50+
User Name: Adele Vance
51+
--------------------------------------
52+
Name: Test11whiteboard-Copy.whiteboard
53+
ID: 01ZSJH4YZFODVVZ6LTNNC35BT4QON7GTJI
54+
Last Modified: 03/06/2025 09:59:25
55+
Size: 15225 bytes
56+
Migration Date: 03/06/2025 09:58:57
57+
User ID: 00000000-0000-0000-0000-000000000001
58+
User Email: [email protected]
59+
User Name: Adele Vance
60+
--------------------------------------
61+
```
62+
63+
## PARAMETERS
64+
65+
### -UserId
66+
67+
The ID of the user account to query whiteboards for. Admin should have access to user OneDrive to get that user whiteboards.
68+
69+
```yaml
70+
Type: Guid
71+
Parameter Sets: (All)
72+
Aliases:
73+
74+
Required: True
75+
Position: 1
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
Applicable: Microsoft Whiteboard
80+
```
81+
82+
### -ForceAuthPrompt
83+
84+
Optional. Always prompt for auth. Use to ignore cached credentials.
85+
86+
```yaml
87+
Type: SwitchParameter
88+
Parameter Sets: (All)
89+
Aliases:
90+
91+
Required: False
92+
Position: Named
93+
Default value: False
94+
Accept pipeline input: False
95+
Accept wildcard characters: False
96+
Applicable: Microsoft Whiteboard
97+
```
98+
99+
### CommonParameters
100+
101+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216)
102+
103+
## INPUTS
104+
105+
## OUTPUTS
106+
107+
## NOTES
108+
109+
For details on user IDs, see the [overview page](../../docs-conceptual/overview.md).
110+
111+
## RELATED LINKS

‎whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md

+178
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
---
2+
external help file: WhiteboardAdmin-help.xml
3+
Module Name: WhiteboardAdmin
4+
online version: https://learn.microsoft.com/powershell/module/whiteboard/get-originalfluidwhiteboardsfortenant
5+
applicable: Microsoft Whiteboard
6+
title: Get-OriginalFluidWhiteboardsForTenant
7+
schema: 2.0.0
8+
author: shwetawagh
9+
ms.author: shwetawagh
10+
ms.reviewer:
11+
---
12+
13+
# Get-OriginalFluidWhiteboardsForTenant
14+
15+
## SYNOPSIS
16+
17+
Gets one or more whiteboards that are originally created as fluid directly into OneDrive for all users under that admin and returns them as objects.
18+
19+
## SYNTAX
20+
21+
```powershell
22+
Get-OriginalFluidWhiteboardsForTenant [-IncrementalRunName <String>] [-ForceAuthPrompt] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
27+
Gets one or more whiteboards that are originally created as fluid directly into OneDrive and returns them as objects. It output all boards created directly into OneDrive in all user accounts under that Tenant
28+
29+
## EXAMPLES
30+
31+
### EXAMPLE 1
32+
33+
```powershell
34+
PS C:\>Get-OriginalFluidWhiteboardsForTenant
35+
```
36+
37+
Get all user's originally created fluid whiteboards in that tenant and outputs in cmd with all users whiteboards provided admin has access to all those users oneDrive for which it is intended to get whiteboards.
38+
39+
### Output
40+
41+
```yaml
42+
Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 ---------------------------------------------------
43+
Name: Test11whiteboard.whiteboard
44+
ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4
45+
Last Modified: 03/06/2025 09:59:32
46+
Size: 15222 bytes
47+
Migration Date: 03/06/2025 09:58:57
48+
User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4
49+
User Email: [email protected]
50+
User Name: Adele Vance
51+
--------------------------------------
52+
Name: Test11whiteboard-Copy.whiteboard
53+
ID: 01ZSJH4YZFODVVZ6LTNNC35BT4QON7GTJI
54+
Last Modified: 03/06/2025 09:59:25
55+
Size: 15225 bytes
56+
Migration Date: 03/06/2025 09:58:57
57+
User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4
58+
User Email: [email protected]
59+
User Name: Adele Vance
60+
--------------------------------------
61+
Drive Items found for User 98f9e197-f331-4cca-b7b7-0c0307452fdd ---------------------------------------------------
62+
Name: Azure111 whiteboard 1.whiteboard
63+
ID: 01BYRZZIGVVILTKNPTFFFL2M5WFSTDVMSZ
64+
Last Modified: 02/13/2025 16:45:58
65+
Size: 23110 bytes
66+
Migration Date: 02/13/2025 16:45:37
67+
User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd
68+
User Email: [email protected]
69+
User Name: MOD Administrator
70+
--------------------------------------
71+
Name: Azure111 whiteboard.whiteboard
72+
ID: 01BYRZZIBSVZZUYVJ2JZAKUOV5FMPHM2NL
73+
Last Modified: 02/19/2025 07:35:25
74+
Size: 12007 bytes
75+
Migration Date: 02/19/2025 07:35:24
76+
User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd
77+
User Email: [email protected]
78+
User Name: MOD Administrator
79+
--------------------------------------
80+
No drive items found for User cc078d4f-5ba1-48ff-847f-0f4af2ee8cf5 with DriveID b!Upfgzjfpx0e4lqL84H-BRZGV7qFNQ-hCobqXYyyCS1clCfsBBCS5T75ca0pe4UQS
81+
Admin does not have access to User 4f14ba28-e678-4535-a9ea-c9f3b32c46f0 OneDrive.
82+
```
83+
84+
### EXAMPLE 2
85+
86+
```powershell
87+
PS C:\>Get-OriginalFluidWhiteboardsForTenant -IncrementalRunName 1
88+
```
89+
90+
Get all user's originally created fluid whiteboards in that tenant and incrementally creates file "WhiteboardsOriginalFluid-$IncrementalRunName.txt" with all users whiteboards provided admin has access to all those users oneDrive for which it is intended to get whiteboards.
91+
92+
### Output
93+
94+
```yaml
95+
[
96+
"Name: Test11whiteboard.whiteboard",
97+
"ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4",
98+
"Last Modified: 03/06/2025 09:59:32",
99+
"Size: 15222 bytes",
100+
"Migration Date: 03/06/2025 09:58:57",
101+
"User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4",
102+
"User Email: [email protected]",
103+
"User Name: Adele Vance",
104+
"-----------------------------------------------",
105+
"Name: Untitled.whiteboard",
106+
"ID: 01ZSJH4YYNHPBYXNRAIFAY42SHQ365Z32M",
107+
"Last Modified: 02/19/2025 05:19:04",
108+
"Size: 15307 bytes",
109+
"Migration Date: 02/19/2025 05:19:04",
110+
"User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4",
111+
"User Email: [email protected]",
112+
"User Name: Adele Vance",
113+
"-----------------------------------------------"
114+
]
115+
[
116+
"Name: Azure111 whiteboard.whiteboard",
117+
"ID: 01BYRZZIBSVZZUYVJ2JZAKUOV5FMPHM2NL",
118+
"Last Modified: 02/19/2025 07:35:25",
119+
"Size: 12007 bytes",
120+
"Migration Date: 02/19/2025 07:35:24",
121+
"User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd",
122+
"User Email: [email protected]",
123+
"User Name: MOD Administrator",
124+
"-----------------------------------------------"
125+
]
126+
```
127+
128+
## PARAMETERS
129+
130+
### -IncrementalRunName
131+
132+
Saves incremental progress as the cmdlet runs. Writes progress and results to `.txt` files in the current directory:
133+
134+
- `WhiteboardsOriginalFluid-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**.
135+
136+
```yaml
137+
Type: String
138+
Parameter Sets: (All)
139+
Aliases:
140+
141+
Required: False
142+
Position: 2
143+
Default value: None
144+
Accept pipeline input: False
145+
Accept wildcard characters: False
146+
Applicable: Microsoft Whiteboard
147+
```
148+
149+
### -ForceAuthPrompt
150+
151+
Optional. Always prompt for auth. Use to ignore cached credentials.
152+
153+
```yaml
154+
Type: SwitchParameter
155+
Parameter Sets: (All)
156+
Aliases:
157+
158+
Required: False
159+
Position: Named
160+
Default value: False
161+
Accept pipeline input: False
162+
Accept wildcard characters: False
163+
Applicable: Microsoft Whiteboard
164+
```
165+
166+
### CommonParameters
167+
168+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216)
169+
170+
## INPUTS
171+
172+
## OUTPUTS
173+
174+
## NOTES
175+
176+
For details on user IDs, see the [overview page](../../docs-conceptual/overview.md).
177+
178+
## RELATED LINKS

‎whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.reviewer:
1414

1515
## SYNOPSIS
1616

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

1919
## SYNTAX
2020

@@ -24,7 +24,7 @@ Get-Whiteboard [-UserId] <Guid> [[-WhiteboardId] <Guid>] [-ForceAuthPrompt] [<Co
2424

2525
## DESCRIPTION
2626

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

2929
## EXAMPLES
3030

‎whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardSettings.md

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
external help file: WhiteboardAdmin-help.xml
3+
Module Name: WhiteboardAdmin
4+
online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardsettings
5+
applicable: Microsoft Whiteboard
6+
title: Get-WhiteboardSettings
7+
schema: 2.0.0
8+
author: shwetawagh
9+
ms.author: shwetawagh
10+
ms.reviewer:
11+
---
12+
13+
# Get-WhiteboardSettings
14+
15+
## SYNOPSIS
16+
17+
Get the users Whiteboard settings.
18+
19+
## SYNTAX
20+
21+
```powershell
22+
Get-WhiteboardSettings
23+
[-ForceAuthPrompt]
24+
[<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
29+
Gets tenant settings from the Microsoft Whiteboard service and returns them as an object.
30+
31+
## EXAMPLES
32+
33+
### EXAMPLE 1
34+
35+
This command gets tenant settings from the Microsoft Whiteboard service and returns them as an object.
36+
37+
```powershell
38+
PS C:\> Get-WhiteboardSettings
39+
```
40+
41+
```Output
42+
isClaimEnabled : True
43+
privacySettings : @{telemetryDataPolicy=Optional; isEnabledConnectedServices=True}
44+
tenantMetadata : @{isGovUser=False; isEduUser=False}
45+
isSharePointDefault : False
46+
isSharePointDefaultGa : True
47+
isSharePointDefaultRolledOut : True
48+
isAzureBlocked : False
49+
licenseCheckInformation : Success
50+
isFluidMigrationEnabled : False
51+
isTenantAdminMigrationEnabled : True
52+
isEnabled : True
53+
isEnabledGa : True
54+
```
55+
56+
## PARAMETERS
57+
58+
### -ForceAuthPrompt
59+
60+
Always prompt for authentication. Use to ignore cached credentials.
61+
62+
```yaml
63+
Type: SwitchParameter
64+
Parameter Sets: (All)
65+
Aliases:
66+
67+
Required: False
68+
Position: Named
69+
Default value: False
70+
Accept pipeline input: False
71+
Accept wildcard characters: False
72+
Applicable: Microsoft Whiteboard
73+
```
74+
75+
### CommonParameters
76+
77+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
78+
79+
## INPUTS
80+
81+
## OUTPUTS
82+
83+
## NOTES
84+
85+
For details on user IDs, see the [overview page](../../docs-conceptual/overview.md).
86+
87+
## RELATED LINKS

0 commit comments

Comments
 (0)