Skip to content

Commit 68ec0c2

Browse files
committed
Fix schema violations
1 parent 8829a10 commit 68ec0c2

14 files changed

+159
-91
lines changed

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ 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

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

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ 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

@@ -24,20 +24,25 @@ Get-OriginalFluidWhiteboardsForTenant [[-IncrementalRunName] <String>] [-ForceAu
2424

2525
## DESCRIPTION
2626

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

2931
## EXAMPLES
3032

3133
### EXAMPLE 1
3234

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

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-
3943
```Output
40-
Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 ---------------------------------------------------
44+
Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4
45+
---------------------------------------------------
4146
Name: Test11whiteboard.whiteboard
4247
ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4
4348
Last Modified: 03/06/2025 09:59:32
@@ -56,7 +61,8 @@ User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4
5661
User Email: [email protected]
5762
User Name: Adele Vance
5863
--------------------------------------
59-
Drive Items found for User 98f9e197-f331-4cca-b7b7-0c0307452fdd ---------------------------------------------------
64+
Drive Items found for User 98f9e197-f331-4cca-b7b7-0c0307452fdd
65+
---------------------------------------------------
6066
Name: Azure111 whiteboard 1.whiteboard
6167
ID: 01BYRZZIGVVILTKNPTFFFL2M5WFSTDVMSZ
6268
Last Modified: 02/13/2025 16:45:58
@@ -81,15 +87,15 @@ Admin does not have access to User 4f14ba28-e678-4535-a9ea-c9f3b32c46f0 OneDrive
8187

8288
### EXAMPLE 2
8389

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

88-
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.
89-
90-
### Output
91-
92-
```yaml
98+
```Output
9399
[
94100
"Name: Test11whiteboard.whiteboard",
95101
"ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4",
@@ -144,9 +150,11 @@ Applicable: Microsoft Whiteboard
144150
145151
### -IncrementalRunName
146152
147-
Saves incremental progress as the cmdlet runs. Writes progress and results to `.txt` files in the current directory:
153+
Saves incremental progress as the cmdlet runs. Writes progress and results to `.txt` files in the
154+
current directory:
148155

149-
- `WhiteboardsOriginalFluid-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**.
156+
- `WhiteboardsOriginalFluid-*.txt` contains the incremental results containing whiteboard objects
157+
for the tenant where `*` is the provided **IncrementalRunName**.
150158

151159
```yaml
152160
Type: System.String
@@ -163,7 +171,10 @@ Applicable: Microsoft Whiteboard
163171

164172
### CommonParameters
165173

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

168179
## INPUTS
169180

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

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,37 +13,38 @@ ms.reviewer:
1313
# Get-Whiteboard
1414

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

1919
## SYNTAX
2020

21-
```powershell
21+
```
2222
Get-Whiteboard [-UserId] <Guid> [[-WhiteboardId] <Guid>] [-ForceAuthPrompt] [<CommonParameters>]
2323
```
2424

2525
## DESCRIPTION
2626

27-
Gets one or more whiteboards in Azure 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
28+
objects.
2829

2930
## EXAMPLES
3031

3132
### EXAMPLE 1
3233

3334
```powershell
34-
PS C:\>Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001
35+
Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001
3536
```
3637

3738
Get all of a user's whiteboards.
3839

3940
### EXAMPLE 2
4041

42+
Get a user's specific whiteboard.
43+
4144
```powershell
42-
PS C:\>Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 -WhiteboardId 00000000-0000-0000-0000-000000000002
45+
Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 -WhiteboardId 00000000-0000-0000-0000-000000000002
4346
```
4447

45-
Get a user's specific whiteboard.
46-
4748
```Output
4849
baseApi: baseApi-value
4950
id: whiteboardId-value
@@ -85,7 +86,8 @@ Applicable: Microsoft Whiteboard
8586
8687
### -UserId
8788
88-
The ID of the user account to query whiteboards for. All whiteboards this account has access to will be returned.
89+
The ID of the user account to query whiteboards for. All whiteboards this account has access to will
90+
be returned.
8991
9092
```yaml
9193
Type: System.Guid
@@ -118,7 +120,10 @@ Applicable: Microsoft Whiteboard
118120
119121
### CommonParameters
120122
121-
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)
123+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
124+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
125+
-WarningAction, and -WarningVariable. For more information, see
126+
[about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216)
122127
123128
## INPUTS
124129

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

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,33 @@ ms.reviewer:
1313
# Get-WhiteboardOwners
1414

1515
## SYNOPSIS
16-
1716
Gets all the users in a tenant who own whiteboards in a specified geography.
1817

1918
## SYNTAX
2019

21-
```powershell
22-
Get-WhiteboardOwners [-Geography] <String> [[-ContinuationToken] <String>] [-ForceAuthPrompt] [<CommonParameters>]
20+
```
21+
Get-WhiteboardOwners [-Geography] <String> [[-ContinuationToken] <String>] [-ForceAuthPrompt]
22+
[<CommonParameters>]
2323
```
2424

2525
## DESCRIPTION
2626

27-
Gets all the users in a tenant who own whiteboards in a specified geography. Returns them as an object containing a list of user object, a tenantId and a continuation token. By calling repeatedly passing in the new continuation tokens, all the owners for a tenant can be gathered. The data returned is precalculated and therefore not realtime. Results are precalculated approximately every two weeks.
27+
Gets all the users in a tenant who own whiteboards in a specified geography. Returns them as an
28+
object containing a list of user object, a tenantId and a continuation token. By calling repeatedly
29+
passing in the new continuation tokens, all the owners for a tenant can be gathered. The data
30+
returned is precalculated and therefore not realtime. Results are precalculated approximately every
31+
two weeks.
2832

2933
## EXAMPLES
3034

3135
### EXAMPLE 1
3236

37+
Get the owners in the European geography.
38+
3339
```powershell
3440
PS C:\>Get-WhiteboardOwners -Geography Europe
3541
```
3642

37-
Get the owners in the European geography.
38-
3943
```Output
4044
TenantId: tenantId
4145
Geography: The geography queried for
@@ -46,11 +50,10 @@ ContinuationToken: continuation token
4650
## PARAMETERS
4751

4852
### -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.
53+
54+
(Optional) A continuation token based on the last time this function was called. Due to the large
55+
volume of boards in a tenant, results are returned in chunks at a time, with a continuation token to
56+
signify where to pick up from. To start from the beginning, pass in null.
5457

5558
```yaml
5659
Type: System.String
@@ -84,7 +87,8 @@ Applicable: Microsoft Whiteboard
8487
8588
### -Geography
8689
87-
Required. The geography to look for board owners in. Accepted values are: Europe, Australia, or Worldwide (all boards not in australia or europe).
90+
Required. The geography to look for board owners in. Accepted values are: Europe, Australia, or
91+
Worldwide (all boards not in australia or europe).
8892
8993
```yaml
9094
Type: System.String
@@ -101,7 +105,10 @@ Applicable: Microsoft Whiteboard
101105
102106
### CommonParameters
103107
104-
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).
108+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
109+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
110+
-WarningAction, and -WarningVariable. For more information, see
111+
[about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
105112
106113
## INPUTS
107114

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ ms.reviewer:
1313
# Get-WhiteboardSettings
1414

1515
## SYNOPSIS
16-
1716
Get the users Whiteboard settings.
1817

1918
## SYNTAX
@@ -33,7 +32,7 @@ Gets tenant settings from the Microsoft Whiteboard service and returns them as a
3332
This command gets tenant settings from the Microsoft Whiteboard service and returns them as an object.
3433

3534
```powershell
36-
PS C:\> Get-WhiteboardSettings
35+
Get-WhiteboardSettings
3736
```
3837

3938
```Output
@@ -72,7 +71,10 @@ Applicable: Microsoft Whiteboard
7271
7372
### CommonParameters
7473
75-
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).
74+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
75+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
76+
-WarningAction, and -WarningVariable. For more information, see
77+
[about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
7678
7779
## INPUTS
7880

whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsForTenant.md

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ ms.reviewer:
1313
# Get-WhiteboardsForTenant
1414

1515
## SYNOPSIS
16-
1716
Gets all the whiteboards in Azure associated with a tenant in a specified geography.
1817

1918
## SYNTAX
@@ -25,13 +24,15 @@ Get-WhiteboardsForTenant [-Geography] <String> [[-IncrementalRunName] <String>]
2524

2625
## DESCRIPTION
2726

28-
Gets all the whiteboards in Azure 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.
27+
Gets all the whiteboards in Azure in a tenant in a specified geography. Returns a list of whiteboard
28+
objects. The data is pre-calculated approximately every two weeks and is not realtime.
2929

3030
## EXAMPLES
3131

32-
### EXAMPLE 1
32+
### Example 1
3333

34-
This command gets all the whiteboards in Azure associated with the caller's tenant in Europe as a list of whiteboard metadata objects.
34+
This command gets all the whiteboards in Azure associated with the caller's tenant in Europe as a
35+
list of whiteboard metadata objects.
3536

3637
```powershell
3738
Get-WhiteboardsForTenant -Geography Europe
@@ -75,14 +76,15 @@ meetingId :
7576
eTag : W/"datetime'2023-01-06T19%3A22%3A42.6717851Z'"
7677
```
7778

78-
### EXAMPLE 2
79-
```
79+
### Example 2
80+
81+
```powershell
8082
Get-WhiteboardsForTenant -Geography Europe -IncrementalRunName 1
8183
```
8284

83-
Gets all the tenant whiteboards in Europe and incrementally writes them to Whiteboards-1.txt file in the current directory.
84-
Saves progress at WhiteboardAdminRun-1.txt file until the request is completed.
85-
If this file already exists, continues the progress using the last saved token.
85+
Gets all the tenant whiteboards in Europe and incrementally writes them to Whiteboards-1.txt file in
86+
the current directory. Saves progress at WhiteboardAdminRun-1.txt file until the request is
87+
completed. If this file already exists, continues the progress using the last saved token.
8688

8789
## PARAMETERS
8890

@@ -105,7 +107,8 @@ Applicable: Microsoft Whiteboard
105107
106108
### -Geography
107109
108-
The geography to look for board owners in. Accepted values are `Europe`, `Australia`, or `Worldwide` (all boards not in Australia or Europe).
110+
The geography to look for board owners in. Accepted values are `Europe`, `Australia`, or `Worldwide`
111+
(all boards not in Australia or Europe).
109112

110113
```yaml
111114
Type: System.String
@@ -122,10 +125,14 @@ Applicable: Microsoft Whiteboard
122125

123126
### -IncrementalRunName
124127

125-
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:
128+
Saves incremental progress as the cmdlet runs. Use to resume a partially completed run. Use the same
129+
**IncrementalRunName** value on later calls to continue a previously canceled or failed run. Writes
130+
progress and results to `.txt` files in the current directory:
126131

127-
- `Whiteboards-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**.
128-
- `WhiteboardAdminRun-*.txt` contains the current state where `*` is the provided **IncrementalRunName**. This file should not be modified manually.
132+
- `Whiteboards-*.txt` contains the incremental results containing whiteboard objects for the tenant
133+
where `*` is the provided **IncrementalRunName**.
134+
- `WhiteboardAdminRun-*.txt` contains the current state where `*` is the provided
135+
**IncrementalRunName**. This file should not be modified manually.
129136

130137
```yaml
131138
Type: System.String
@@ -142,7 +149,10 @@ Applicable: Microsoft Whiteboard
142149

143150
### CommonParameters
144151

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

147157
## INPUTS
148158

0 commit comments

Comments
 (0)