Skip to content

Commit a4427cc

Browse files
kenwithkenwith
authored
Merge pull request MicrosoftDocs#909 from tbrosman/whiteboard-admin-ps-doc
WhiteboardAdmin PowerShell documentation
2 parents 7bcebbe + 2a48edc commit a4427cc

File tree

10 files changed

+402
-0
lines changed

10 files changed

+402
-0
lines changed

‎whiteboard/docfx.json

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
{
2+
"build": {
3+
"content": [
4+
{
5+
"files": ["**/*.md"],
6+
"src": "docs-conceptual",
7+
"version": "whiteboard-ps",
8+
"dest": "whiteboard",
9+
"exclude": [
10+
"**/obj/**",
11+
"**/includes/**",
12+
"README.md",
13+
"LICENSE",
14+
"LICENSE-CODE",
15+
"ThirdPartyNotices"]
16+
},
17+
{
18+
"files": ["toc.yml"],
19+
"src": "docs-conceptual",
20+
"version": "whiteboard-ps",
21+
"dest": "whiteboard/whiteboard-ps"
22+
},
23+
{
24+
"files": ["**/*.md"],
25+
"src": "whiteboard-ps",
26+
"version": "whiteboard-ps",
27+
"dest": "module"
28+
},
29+
{
30+
"files": ["toc.yml"],
31+
"src": "whiteboard-ps",
32+
"version": "whiteboard-ps",
33+
"dest": "module/whiteboard-ps"
34+
}
35+
],
36+
"resource": [
37+
{
38+
"files": [
39+
"**/*.png",
40+
"**/*.jpg"
41+
],
42+
"exclude": [
43+
"**/obj/**",
44+
"**/includes/**"
45+
]
46+
}
47+
],
48+
"versions": {
49+
"whiteboard-ps": {
50+
"dest": "whiteboard-ps"
51+
}
52+
},
53+
"overwrite": [],
54+
"externalReference": [],
55+
"globalMetadata": {
56+
"author" : "tbrosman",
57+
"ms.author" : "tbrosman",
58+
"manager" : "shanejc",
59+
"ms.date" : "04/23/2018",
60+
"ms.topic" : "reference",
61+
"ms.service" : "whiteboard-powershell",
62+
"ms.devlang" : "powershell",
63+
"feedback_system": "GitHub",
64+
"feedback_github_repo": "MicrosoftDocs/office-docs-powershell",
65+
"feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues"
66+
},
67+
"fileMetadata": {},
68+
"template": [],
69+
"dest": "whiteboard-ps"
70+
}
71+
}

‎whiteboard/docs-conceptual/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#Microsoft Teams cmdlet reference
2+
3+
Welcome to the Microsoft Teams PowerShell cmdlet help references. The Microsoft Teams cmdlets provide the command line interface for service administration and management.
4+
5+
Here you will find all of the Microsoft Teams PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README.
6+
7+
The repo is located here: https://github.com/microsoftdocs/office-docs-powershell and you can find the README displayed at the bottom of the page.

‎whiteboard/docs-conceptual/intro.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#Microsoft Teams cmdlet reference
2+
3+
Welcome to the Microsoft Teams PowerShell cmdlet help references. The Microsoft Teams cmdlets provide the command line interface for service administration and management.
4+
5+
Here you will find all of the Microsoft Teams PowerShell help topics. These topics are 'open source' and open for contributions. If you are interested in contributing to this content head over to the source GitHub repo and look through the README.
6+
7+
The repo is located here: https://github.com/microsoftdocs/office-docs-powershell and you can find the README displayed at the bottom of the page.

‎whiteboard/docs-conceptual/overview.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#My overview
2+
3+
This is an overview page

‎whiteboard/docs-conceptual/toc.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
- name: Overview
2+
href: index.md
3+
items:
4+
- name: Introduction
5+
href: intro.md

‎whiteboard/mapping/monikerMapping.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"whiteboard-ps": {
3+
"conceptualToc": "docs-conceptual/toc.yml",
4+
"conceptualTocUrl": "/powershell/whiteboard/whiteboard-ps/toc.json",
5+
"referenceTocUrl": "/powershell/module/whiteboard-ps/toc.json",
6+
"packageRoot": "whiteboard-ps",
7+
"modules": {
8+
"whiteboard": {}
9+
}
10+
}
11+
}

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

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
external help file: Microsoft.Whiteboard.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftWhiteboard
4+
applicable: Microsoft Whiteboard
5+
title: Get-Whiteboard
6+
online version:
7+
schema: 2.0.0
8+
---
9+
10+
# Get-Whiteboard
11+
12+
## SYNOPSIS
13+
14+
Gets one or more Whiteboards from the Microsoft Whiteboard service and returns them as objects.
15+
16+
## SYNTAX
17+
18+
```
19+
Get-Whiteboard [-Token <AuthenticationResult>] -UserId <Guid> -WhiteboardId <Guid> [<CommonParameters>]
20+
21+
Get-Whiteboard [-Token <AuthenticationResult>] -UserId <Guid> [<CommonParameters>]
22+
```
23+
24+
## PARAMETERS
25+
26+
### -Token
27+
28+
The Azure AD bearer token corresponding to the specified credentials. If unspecified, a new token will be generated.
29+
30+
```yaml
31+
Type: Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult
32+
Required: false
33+
Position: named
34+
Default value: None
35+
Accept pipeline input: false
36+
Accept wildcard characters: false
37+
```
38+
39+
### -UserId
40+
41+
(Optional) The ID of the user account to query Whiteboards for. All Whiteboards this account has access to will be returned.
42+
43+
```yaml
44+
Type: Guid
45+
Required: true
46+
Position: named
47+
Default value: None
48+
Accept pipeline input: false
49+
Accept wildcard characters: false
50+
```
51+
52+
### -WhiteboardId
53+
54+
(Optional) The ID of a specific Whiteboard.
55+
56+
```yaml
57+
Type: Guid
58+
Required: true
59+
Position: named
60+
Default value: None
61+
Accept pipeline input: false
62+
Accept wildcard characters: false
63+
```
64+
65+
## EXAMPLES
66+
67+
### -------------------------- EXAMPLE 1 --------------------------
68+
69+
```
70+
PS C:\>Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001
71+
```
72+
73+
Get all of a user's Whiteboards.

‎whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
external help file: Microsoft.Whiteboard.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftWhiteboard
4+
applicable: Microsoft Whiteboard
5+
title: Set-WhiteboardOwner
6+
online version:
7+
schema: 2.0.0
8+
---
9+
10+
# Invoke-TransferAllWhiteboards
11+
12+
## SYNOPSIS
13+
14+
Transfer ownership of all Whiteboards owned by a user to another user.
15+
16+
## SYNTAX
17+
18+
```
19+
Invoke-TransferAllWhiteboards [[-Token] <AuthenticationResult>] [-OwnerId] <Guid> [-NewOwnerId] <Guid> [-WhatIf] [-Confirm] [<CommonParameters>]
20+
```
21+
22+
## PARAMETERS
23+
24+
### -Token
25+
26+
The Azure AD bearer token corresponding to the specified credentials. If unspecified, a new token will be generated.
27+
28+
```yaml
29+
Type: Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult
30+
Required: false
31+
Position: 1
32+
Default value: None
33+
Accept pipeline input: false
34+
Accept wildcard characters: false
35+
```
36+
37+
### -OldOwnerId
38+
39+
The ID of the previous owner.
40+
41+
```yaml
42+
Type: Guid
43+
Required: true
44+
Position: 3
45+
Default value: None
46+
Accept pipeline input: false
47+
Accept wildcard characters: false
48+
```
49+
50+
### -NewOwnerId
51+
52+
The ID of the new owner.
53+
54+
```yaml
55+
Type: Guid
56+
Required: true
57+
Position: 4
58+
Default value: None
59+
Accept pipeline input: false
60+
Accept wildcard characters: false
61+
```
62+
63+
### -WhatIf
64+
65+
```yaml
66+
Type: SwitchParameter
67+
Required: false
68+
Position: named
69+
Default value: None
70+
Accept pipeline input: false
71+
Accept wildcard characters: false
72+
```
73+
74+
### -Confirm [<SwitchParameter>]
75+
76+
```yaml
77+
Type: SwitchParameter
78+
Required: false
79+
Position: named
80+
Default value: None
81+
Accept pipeline input: false
82+
Accept wildcard characters: false
83+
```
84+
85+
## EXAMPLES
86+
87+
### -------------------------- EXAMPLE 1 --------------------------
88+
89+
```
90+
PS C:\>Invoke-TransferAllWhiteboards -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 -WhatIf
91+
```
92+
93+
Check how many Whiteboards will be transferred without transferring them.
94+
95+
### -------------------------- EXAMPLE 2 --------------------------
96+
97+
```
98+
PS C:\>Invoke-TransferAllWhiteboards -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002
99+
```
100+
101+
Transfer (and prompt before performing any write actions).

‎whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
external help file: Microsoft.Whiteboard.PowerShell.Custom.dll-Help.xml
3+
Module Name: MicrosoftWhiteboard
4+
applicable: Microsoft Whiteboard
5+
title: Set-WhiteboardOwner
6+
online version:
7+
schema: 2.0.0
8+
---
9+
10+
# Set-WhiteboardOwner
11+
12+
## SYNOPSIS
13+
14+
Sets the owner for a Whiteboard.
15+
16+
## SYNTAX
17+
18+
```
19+
Set-WhiteboardOwner [[-Token] <AuthenticationResult>] [-WhiteboardId] <Guid> [-OldOwnerId] <Guid> [-NewOwnerId] <Guid> [-WhatIf] [-Confirm] [<CommonParameters>]
20+
```
21+
22+
## PARAMETERS
23+
24+
### -Token
25+
26+
The Azure AD bearer token corresponding to the specified credentials. If unspecified, a new token will be generated.
27+
28+
```yaml
29+
Type: Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult
30+
Required: false
31+
Position: 1
32+
Default value: None
33+
Accept pipeline input: false
34+
Accept wildcard characters: false
35+
```
36+
37+
### -WhiteboardId
38+
39+
The Whiteboard for which the owner is being changed.
40+
41+
```yaml
42+
Type: Guid
43+
Required: true
44+
Position: 2
45+
Default value: None
46+
Accept pipeline input: false
47+
Accept wildcard characters: false
48+
```
49+
50+
### -OldOwnerId
51+
52+
The ID of the previous owner.
53+
54+
```yaml
55+
Type: Guid
56+
Required: true
57+
Position: 3
58+
Default value: None
59+
Accept pipeline input: false
60+
Accept wildcard characters: false
61+
```
62+
63+
### -NewOwnerId
64+
65+
The ID of the new owner.
66+
67+
```yaml
68+
Type: Guid
69+
Required: true
70+
Position: 4
71+
Default value: None
72+
Accept pipeline input: false
73+
Accept wildcard characters: false
74+
```
75+
76+
### -WhatIf
77+
78+
```yaml
79+
Type: SwitchParameter
80+
Required: false
81+
Position: named
82+
Default value: None
83+
Accept pipeline input: false
84+
Accept wildcard characters: false
85+
```
86+
87+
### -Confirm [<SwitchParameter>]
88+
89+
```yaml
90+
Type: SwitchParameter
91+
Required: false
92+
Position: named
93+
Default value: None
94+
Accept pipeline input: false
95+
Accept wildcard characters: false
96+
```
97+
98+
## EXAMPLES
99+
100+
### -------------------------- EXAMPLE 1 --------------------------
101+
102+
```
103+
PS C:\>Set-WhiteboardOwner -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002
104+
```
105+
106+
Move a Whiteboard from one user to another.

0 commit comments

Comments
 (0)