Skip to content

Commit 87e934c

Browse files
Merge pull request #12884 from MicrosoftDocs/main
[AutoPublish] main to live - 07/14 15:34 PDT | 07/15 04:04 IST
2 parents 45cd454 + df95603 commit 87e934c

15 files changed

+552
-384
lines changed

whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md renamed to whiteboard/whiteboard-ps/WhiteboardAdmin/Get-OriginalFluidWhiteboards.md

Lines changed: 62 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: WhiteboardAdmin-help.xml
33
Module Name: WhiteboardAdmin
44
online version: https://learn.microsoft.com/powershell/module/whiteboard/get-originalfluidwhiteboards
@@ -13,13 +13,13 @@ ms.reviewer:
1313
# Get-OriginalFluidWhiteboards
1414

1515
## SYNOPSIS
16-
1716
Gets one or more whiteboards that are originally created as Fluid whiteboards, directly into users OneDrive and return them as objects.
1817

1918
## SYNTAX
2019

21-
```powershell
22-
Get-OriginalFluidWhiteboards [-UserId] [-ForceAuthPrompt] [<CommonParameters>]
20+
```
21+
Get-OriginalFluidWhiteboards [-UserId] <Guid> [[-ConnectMgGraph] <String>] [[-ContinuationToken] <String>]
22+
[-ForceAuthPrompt] [[-IncrementalRunName] <String>] [<CommonParameters>]
2323
```
2424

2525
## DESCRIPTION
@@ -30,15 +30,14 @@ Gets one or more whiteboards that are originally created as Fluid whiteboards, d
3030

3131
### EXAMPLE 1
3232

33+
Get all user's whiteboards that are originally created as Fluid whiteboards directly into users OneDrive.
34+
3335
```powershell
3436
PS C:\>Get-OriginalFluidWhiteboards -UserId 00000000-0000-0000-0000-000000000001
3537
```
3638

37-
Get all user's whiteboards that are originally created as Fluid whiteboards directly into users OneDrive.
38-
39-
### Output
4039

41-
```yaml
40+
```Output
4241
Drive Items found for User 00000000-0000-0000-0000-000000000001 ---------------------------------------------------
4342
Name: TradeTestwhiteboard.whiteboard
4443
ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4
@@ -62,21 +61,34 @@ User Name: Adele Vance
6261

6362
## PARAMETERS
6463

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.
64+
### -ConnectMgGraph
65+
{{ Fill ConnectMgGraph Description }}
6866

6967
```yaml
70-
Type: Guid
68+
Type: System.String
7169
Parameter Sets: (All)
7270
Aliases:
7371

74-
Required: True
72+
Required: False
7573
Position: 1
7674
Default value: None
7775
Accept pipeline input: False
7876
Accept wildcard characters: False
79-
Applicable: Microsoft Whiteboard
77+
```
78+
79+
### -ContinuationToken
80+
{{ Fill ContinuationToken Description }}
81+
82+
```yaml
83+
Type: System.String
84+
Parameter Sets: (All)
85+
Aliases:
86+
87+
Required: False
88+
Position: 2
89+
Default value: None
90+
Accept pipeline input: False
91+
Accept wildcard characters: False
8092
```
8193
8294
### -ForceAuthPrompt
@@ -96,14 +108,50 @@ Accept wildcard characters: False
96108
Applicable: Microsoft Whiteboard
97109
```
98110
111+
### -IncrementalRunName
112+
{{ Fill IncrementalRunName Description }}
113+
114+
```yaml
115+
Type: System.String
116+
Parameter Sets: (All)
117+
Aliases:
118+
119+
Required: False
120+
Position: 3
121+
Default value: None
122+
Accept pipeline input: False
123+
Accept wildcard characters: False
124+
```
125+
126+
### -UserId
127+
128+
The ID of the user account to query whiteboards for. Admin should have access to user OneDrive to get that user whiteboards.
129+
130+
```yaml
131+
Type: Guid
132+
Parameter Sets: (All)
133+
Aliases:
134+
135+
Required: True
136+
Position: 0
137+
Default value: None
138+
Accept pipeline input: False
139+
Accept wildcard characters: False
140+
Applicable: Microsoft Whiteboard
141+
```
142+
99143
### CommonParameters
100144
101145
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)
102146
103147
## INPUTS
104148
149+
### None
150+
105151
## OUTPUTS
106152
153+
### System.Object
154+
107155
## NOTES
108156
109157
For details on user IDs, see the [overview page](../../docs-conceptual/overview.md).

whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md renamed to whiteboard/whiteboard-ps/WhiteboardAdmin/Get-OriginalFluidWhiteboardsForTenant.md

Lines changed: 45 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
external help file: WhiteboardAdmin-help.xml
33
Module Name: WhiteboardAdmin
44
online version: https://learn.microsoft.com/powershell/module/whiteboard/get-originalfluidwhiteboardsfortenant
@@ -13,33 +13,37 @@ ms.reviewer:
1313
# Get-OriginalFluidWhiteboardsForTenant
1414

1515
## 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.
16+
Gets one or more whiteboards that are originally created as fluid directly into OneDrive for all
17+
users under that admin and returns them as objects.
1818

1919
## SYNTAX
2020

21-
```powershell
22-
Get-OriginalFluidWhiteboardsForTenant [-IncrementalRunName <String>] [-ForceAuthPrompt] [<CommonParameters>]
21+
```
22+
Get-OriginalFluidWhiteboardsForTenant [[-IncrementalRunName] <String>] [-ForceAuthPrompt]
23+
[<CommonParameters>]
2324
```
2425

2526
## DESCRIPTION
2627

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+
Gets one or more whiteboards that are originally created as fluid directly into OneDrive and returns
29+
them as objects. It output all boards created directly into OneDrive in all user accounts under that
30+
Tenant
2831

2932
## EXAMPLES
3033

3134
### EXAMPLE 1
3235

36+
Get all user's originally created fluid whiteboards in that tenant and outputs in cmd with all users
37+
whiteboards provided admin has access to all those users oneDrive for which it is intended to get
38+
whiteboards.
39+
3340
```powershell
3441
PS C:\>Get-OriginalFluidWhiteboardsForTenant
3542
```
3643

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 ---------------------------------------------------
44+
```Output
45+
Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4
46+
---------------------------------------------------
4347
Name: Test11whiteboard.whiteboard
4448
ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4
4549
Last Modified: 03/06/2025 09:59:32
@@ -58,7 +62,8 @@ User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4
5862
User Email: [email protected]
5963
User Name: Adele Vance
6064
--------------------------------------
61-
Drive Items found for User 98f9e197-f331-4cca-b7b7-0c0307452fdd ---------------------------------------------------
65+
Drive Items found for User 98f9e197-f331-4cca-b7b7-0c0307452fdd
66+
---------------------------------------------------
6267
Name: Azure111 whiteboard 1.whiteboard
6368
ID: 01BYRZZIGVVILTKNPTFFFL2M5WFSTDVMSZ
6469
Last Modified: 02/13/2025 16:45:58
@@ -83,15 +88,15 @@ Admin does not have access to User 4f14ba28-e678-4535-a9ea-c9f3b32c46f0 OneDrive
8388

8489
### EXAMPLE 2
8590

91+
Get all user's originally created fluid whiteboards in that tenant and incrementally creates file
92+
"WhiteboardsOriginalFluid-$IncrementalRunName.txt" with all users whiteboards provided admin has
93+
access to all those users oneDrive for which it is intended to get whiteboards.
94+
8695
```powershell
8796
PS C:\>Get-OriginalFluidWhiteboardsForTenant -IncrementalRunName 1
8897
```
8998

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
99+
```Output
95100
[
96101
"Name: Test11whiteboard.whiteboard",
97102
"ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4",
@@ -127,50 +132,59 @@ Get all user's originally created fluid whiteboards in that tenant and increment
127132

128133
## PARAMETERS
129134

130-
### -IncrementalRunName
131-
132-
Saves incremental progress as the cmdlet runs. Writes progress and results to `.txt` files in the current directory:
135+
### -ForceAuthPrompt
133136

134-
- `WhiteboardsOriginalFluid-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**.
137+
Optional. Always prompt for auth. Use to ignore cached credentials.
135138

136139
```yaml
137-
Type: String
140+
Type: System.Management.Automation.SwitchParameter
138141
Parameter Sets: (All)
139142
Aliases:
140143

141144
Required: False
142-
Position: 2
143-
Default value: None
145+
Position: Named
146+
Default value: False
144147
Accept pipeline input: False
145148
Accept wildcard characters: False
146149
Applicable: Microsoft Whiteboard
147150
```
148151
149-
### -ForceAuthPrompt
152+
### -IncrementalRunName
150153
151-
Optional. Always prompt for auth. Use to ignore cached credentials.
154+
Saves incremental progress as the cmdlet runs. Writes progress and results to `.txt` files in the
155+
current directory:
156+
157+
- `WhiteboardsOriginalFluid-*.txt` contains the incremental results containing whiteboard objects
158+
for the tenant where `*` is the provided **IncrementalRunName**.
152159

153160
```yaml
154-
Type: SwitchParameter
161+
Type: System.String
155162
Parameter Sets: (All)
156163
Aliases:
157164
158165
Required: False
159-
Position: Named
160-
Default value: False
166+
Position: 0
167+
Default value: None
161168
Accept pipeline input: False
162169
Accept wildcard characters: False
163170
Applicable: Microsoft Whiteboard
164171
```
165172

166173
### CommonParameters
167174

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)
175+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
176+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
177+
-WarningAction, and -WarningVariable. For more information, see
178+
[about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216)
169179

170180
## INPUTS
171181

182+
### None
183+
172184
## OUTPUTS
173185

186+
### System.Object
187+
174188
## NOTES
175189

176190
For details on user IDs, see the [overview page](../../docs-conceptual/overview.md).

0 commit comments

Comments
 (0)