Skip to content

Commit 8829a10

Browse files
committed
Update content from lastest module and fix PlatyPS errors
1 parent 83b11af commit 8829a10

15 files changed

+415
-317
lines changed

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

Lines changed: 62 additions & 13 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
@@ -18,8 +18,9 @@ Gets one or more whiteboards that are originally created as Fluid whiteboards, d
1818

1919
## SYNTAX
2020

21-
```powershell
22-
Get-OriginalFluidWhiteboards [-UserId] [-ForceAuthPrompt] [<CommonParameters>]
21+
```
22+
Get-OriginalFluidWhiteboards [-UserId] <Guid> [[-ConnectMgGraph] <String>] [[-ContinuationToken] <String>]
23+
[-ForceAuthPrompt] [[-IncrementalRunName] <String>] [<CommonParameters>]
2324
```
2425

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

3132
### EXAMPLE 1
3233

34+
Get all user's whiteboards that are originally created as Fluid whiteboards directly into users OneDrive.
35+
3336
```powershell
3437
PS C:\>Get-OriginalFluidWhiteboards -UserId 00000000-0000-0000-0000-000000000001
3538
```
3639

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

41-
```yaml
41+
```Output
4242
Drive Items found for User 00000000-0000-0000-0000-000000000001 ---------------------------------------------------
4343
Name: TradeTestwhiteboard.whiteboard
4444
ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4
@@ -62,21 +62,34 @@ User Name: Adele Vance
6262

6363
## PARAMETERS
6464

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

6968
```yaml
70-
Type: Guid
69+
Type: System.String
7170
Parameter Sets: (All)
7271
Aliases:
7372

74-
Required: True
73+
Required: False
7574
Position: 1
7675
Default value: None
7776
Accept pipeline input: False
7877
Accept wildcard characters: False
79-
Applicable: Microsoft Whiteboard
78+
```
79+
80+
### -ContinuationToken
81+
{{ Fill ContinuationToken Description }}
82+
83+
```yaml
84+
Type: System.String
85+
Parameter Sets: (All)
86+
Aliases:
87+
88+
Required: False
89+
Position: 2
90+
Default value: None
91+
Accept pipeline input: False
92+
Accept wildcard characters: False
8093
```
8194
8295
### -ForceAuthPrompt
@@ -96,14 +109,50 @@ Accept wildcard characters: False
96109
Applicable: Microsoft Whiteboard
97110
```
98111
112+
### -IncrementalRunName
113+
{{ Fill IncrementalRunName Description }}
114+
115+
```yaml
116+
Type: System.String
117+
Parameter Sets: (All)
118+
Aliases:
119+
120+
Required: False
121+
Position: 3
122+
Default value: None
123+
Accept pipeline input: False
124+
Accept wildcard characters: False
125+
```
126+
127+
### -UserId
128+
129+
The ID of the user account to query whiteboards for. Admin should have access to user OneDrive to get that user whiteboards.
130+
131+
```yaml
132+
Type: Guid
133+
Parameter Sets: (All)
134+
Aliases:
135+
136+
Required: True
137+
Position: 0
138+
Default value: None
139+
Accept pipeline input: False
140+
Accept wildcard characters: False
141+
Applicable: Microsoft Whiteboard
142+
```
143+
99144
### CommonParameters
100145
101146
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)
102147
103148
## INPUTS
104149
150+
### None
151+
105152
## OUTPUTS
106153
154+
### System.Object
155+
107156
## NOTES
108157
109158
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: 20 additions & 18 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
@@ -18,8 +18,8 @@ Gets one or more whiteboards that are originally created as fluid directly into
1818

1919
## SYNTAX
2020

21-
```powershell
22-
Get-OriginalFluidWhiteboardsForTenant [-IncrementalRunName <String>] [-ForceAuthPrompt] [<CommonParameters>]
21+
```
22+
Get-OriginalFluidWhiteboardsForTenant [[-IncrementalRunName] <String>] [-ForceAuthPrompt] [<CommonParameters>]
2323
```
2424

2525
## DESCRIPTION
@@ -36,9 +36,7 @@ PS C:\>Get-OriginalFluidWhiteboardsForTenant
3636

3737
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.
3838

39-
### Output
40-
41-
```yaml
39+
```Output
4240
Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 ---------------------------------------------------
4341
Name: Test11whiteboard.whiteboard
4442
ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4
@@ -127,37 +125,37 @@ Get all user's originally created fluid whiteboards in that tenant and increment
127125

128126
## PARAMETERS
129127

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

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

136132
```yaml
137-
Type: String
133+
Type: System.Management.Automation.SwitchParameter
138134
Parameter Sets: (All)
139135
Aliases:
140136

141137
Required: False
142-
Position: 2
143-
Default value: None
138+
Position: Named
139+
Default value: False
144140
Accept pipeline input: False
145141
Accept wildcard characters: False
146142
Applicable: Microsoft Whiteboard
147143
```
148144
149-
### -ForceAuthPrompt
145+
### -IncrementalRunName
150146
151-
Optional. Always prompt for auth. Use to ignore cached credentials.
147+
Saves incremental progress as the cmdlet runs. Writes progress and results to `.txt` files in the current directory:
148+
149+
- `WhiteboardsOriginalFluid-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**.
152150

153151
```yaml
154-
Type: SwitchParameter
152+
Type: System.String
155153
Parameter Sets: (All)
156154
Aliases:
157155
158156
Required: False
159-
Position: Named
160-
Default value: False
157+
Position: 0
158+
Default value: None
161159
Accept pipeline input: False
162160
Accept wildcard characters: False
163161
Applicable: Microsoft Whiteboard
@@ -169,8 +167,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
169167

170168
## INPUTS
171169

170+
### None
171+
172172
## OUTPUTS
173173

174+
### System.Object
175+
174176
## NOTES
175177

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

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

Lines changed: 18 additions & 21 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-whiteboard
@@ -44,9 +44,7 @@ PS C:\>Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 -WhiteboardId
4444

4545
Get a user's specific whiteboard.
4646

47-
### Output
48-
49-
```yaml
47+
```Output
5048
baseApi: baseApi-value
5149
id: whiteboardId-value
5250
userId: userId-value
@@ -68,52 +66,51 @@ eTag: eTag-value
6866

6967
## PARAMETERS
7068

71-
### -UserId
69+
### -ForceAuthPrompt
7270

73-
The ID of the user account to query whiteboards for. All whiteboards this account has access to will be returned.
71+
Optional. Always prompt for auth. Use to ignore cached credentials.
7472

7573
```yaml
76-
Type: Guid
74+
Type: System.Management.Automation.SwitchParameter
7775
Parameter Sets: (All)
7876
Aliases:
7977

80-
Required: True
81-
Position: 1
82-
Default value: None
78+
Required: False
79+
Position: Named
80+
Default value: False
8381
Accept pipeline input: False
8482
Accept wildcard characters: False
8583
Applicable: Microsoft Whiteboard
8684
```
8785
88-
### -WhiteboardId
86+
### -UserId
8987
90-
Optional. The ID of a specific whiteboard.
88+
The ID of the user account to query whiteboards for. All whiteboards this account has access to will be returned.
9189
9290
```yaml
93-
Type: Guid
91+
Type: System.Guid
9492
Parameter Sets: (All)
9593
Aliases:
9694

97-
Required: False
98-
Position: 2
95+
Required: True
96+
Position: 1
9997
Default value: None
10098
Accept pipeline input: False
10199
Accept wildcard characters: False
102100
Applicable: Microsoft Whiteboard
103101
```
104102
105-
### -ForceAuthPrompt
106-
107-
Optional. Always prompt for auth. Use to ignore cached credentials.
103+
### -WhiteboardId
104+
(Optional) The ID of a specific Whiteboard to query, if not specified all whiteboards are queried.
108105
109106
```yaml
110-
Type: SwitchParameter
107+
Type: System.Guid
111108
Parameter Sets: (All)
112109
Aliases:
113110

114111
Required: False
115-
Position: Named
116-
Default value: False
112+
Position: 2
113+
Default value: None
117114
Accept pipeline input: False
118115
Accept wildcard characters: False
119116
Applicable: Microsoft Whiteboard

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

Lines changed: 22 additions & 21 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-whiteboardowners
@@ -36,9 +36,7 @@ PS C:\>Get-WhiteboardOwners -Geography Europe
3636

3737
Get the owners in the European geography.
3838

39-
### Output
40-
41-
```yaml
39+
```Output
4240
TenantId: tenantId
4341
Geography: The geography queried for
4442
Items: List of user ids
@@ -47,52 +45,55 @@ ContinuationToken: continuation token
4745

4846
## PARAMETERS
4947

50-
### -Geography
51-
52-
Required. The geography to look for board owners in. Accepted values are: Europe, Australia, or Worldwide (all boards not in australia or europe).
48+
### -ContinuationToken
49+
(Optional) A continuation token based on the last time this function was called.
50+
Due to the large
51+
volume of boards in a tenant, results are returned in chunks at a time, with a continuation token
52+
to signify where to pick up from.
53+
To start from the beginning, pass in null.
5354

5455
```yaml
55-
Type: String
56+
Type: System.String
5657
Parameter Sets: (All)
5758
Aliases:
5859

59-
Required: True
60-
Position: 1
60+
Required: False
61+
Position: 2
6162
Default value: None
6263
Accept pipeline input: False
6364
Accept wildcard characters: False
6465
Applicable: Microsoft Whiteboard
6566
```
6667
67-
### -ContinuationToken
68+
### -ForceAuthPrompt
6869
69-
Optional. The continuation token returned in a previous call.
70+
Optional. Always prompt for auth. Use to ignore cached credentials.
7071
7172
```yaml
72-
Type: String
73+
Type: System.Management.Automation.SwitchParameter
7374
Parameter Sets: (All)
7475
Aliases:
7576

7677
Required: False
77-
Position: 2
78-
Default value: None
78+
Position: Named
79+
Default value: False
7980
Accept pipeline input: False
8081
Accept wildcard characters: False
8182
Applicable: Microsoft Whiteboard
8283
```
8384
84-
### -ForceAuthPrompt
85+
### -Geography
8586
86-
Optional. Always prompt for auth. Use to ignore cached credentials.
87+
Required. The geography to look for board owners in. Accepted values are: Europe, Australia, or Worldwide (all boards not in australia or europe).
8788
8889
```yaml
89-
Type: SwitchParameter
90+
Type: System.String
9091
Parameter Sets: (All)
9192
Aliases:
9293

93-
Required: False
94-
Position: Named
95-
Default value: False
94+
Required: True
95+
Position: 1
96+
Default value: None
9697
Accept pipeline input: False
9798
Accept wildcard characters: False
9899
Applicable: Microsoft Whiteboard

0 commit comments

Comments
 (0)