WhiteboardAdmin PowerShell documentation

whiteboard/docfx.json

@@ -0,0 +1,71 @@
+{
+  "build": {
+    "content": [
+      {
+        "files": ["**/*.md"],
+        "src": "docs-conceptual",
+        "version": "whiteboard-ps",
+        "dest": "whiteboard",
+        "exclude": [
+          "**/obj/**",
+          "**/includes/**",
+          "README.md",
+          "LICENSE",
+          "LICENSE-CODE",
+          "ThirdPartyNotices"]
+      },
+      {
+         "files": ["toc.yml"],
+        "src": "docs-conceptual",
+        "version": "whiteboard-ps",
+        "dest": "whiteboard/whiteboard-ps"
+      },
+      {
+      "files": ["**/*.md"],
+      "src": "whiteboard-ps",
+      "version": "whiteboard-ps",
+      "dest": "module"
+    },
+    {
+      "files": ["toc.yml"],
+      "src": "whiteboard-ps",
+      "version": "whiteboard-ps",
+      "dest": "module/whiteboard-ps"
+    }
+    ],
+    "resource": [
+      {
+        "files": [
+          "**/*.png",
+          "**/*.jpg"
+        ],
+        "exclude": [
+          "**/obj/**",
+          "**/includes/**"
+        ]
+      }
+    ],
+    "versions": {
+      "whiteboard-ps": {
+        "dest": "whiteboard-ps"
+      }
+    },
+    "overwrite": [],
+    "externalReference": [],
+    "globalMetadata": {
+      "author" : "tbrosman",
+      "ms.author" : "tbrosman",
+      "manager" : "shanejc",
+      "ms.date" : "04/23/2018",
+      "ms.topic" : "reference",
+      "ms.service" : "whiteboard-powershell",
+      "ms.devlang" : "powershell",
+      "feedback_system": "GitHub",
+      "feedback_github_repo": "MicrosoftDocs/office-docs-powershell",
+      "feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues"
+    },
+    "fileMetadata": {},
+    "template": [],
+    "dest": "whiteboard-ps"
+  }
+}

whiteboard/docs-conceptual/index.md

@@ -0,0 +1,7 @@
+#Microsoft Teams cmdlet reference
+
+Welcome to the Microsoft Teams PowerShell cmdlet help references. The Microsoft Teams cmdlets provide the command line interface for service administration and management.
+
+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. 
+
+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

@@ -0,0 +1,7 @@
+#Microsoft Teams cmdlet reference
+
+Welcome to the Microsoft Teams PowerShell cmdlet help references. The Microsoft Teams cmdlets provide the command line interface for service administration and management.
+
+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. 
+
+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

@@ -0,0 +1,3 @@
+#My overview
+
+This is an overview page

whiteboard/docs-conceptual/toc.yml

@@ -0,0 +1,5 @@
+- name: Overview
+  href: index.md
+  items:
+  - name: Introduction
+    href: intro.md

whiteboard/mapping/monikerMapping.json

@@ -0,0 +1,11 @@
+{
+    "whiteboard-ps": {
+        "conceptualToc": "docs-conceptual/toc.yml",
+        "conceptualTocUrl": "/powershell/whiteboard/whiteboard-ps/toc.json",
+        "referenceTocUrl": "/powershell/module/whiteboard-ps/toc.json",
+        "packageRoot": "whiteboard-ps",
+        "modules": {
+            "whiteboard": {}     
+        }
+    }
+}

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

@@ -0,0 +1,73 @@
+---
+external help file: Microsoft.Whiteboard.PowerShell.Custom.dll-Help.xml
+Module Name: MicrosoftWhiteboard
+applicable: Microsoft Whiteboard
+title: Get-Whiteboard
+online version: 
+schema: 2.0.0
+---
+
+# Get-Whiteboard
+
+## SYNOPSIS
+
+Gets one or more Whiteboards from the Microsoft Whiteboard service and returns them as objects.
+
+## SYNTAX
+
+```
+Get-Whiteboard [-Token <AuthenticationResult>] -UserId <Guid> -WhiteboardId <Guid> [<CommonParameters>]
+
+Get-Whiteboard [-Token <AuthenticationResult>] -UserId <Guid> [<CommonParameters>]
+```
+
+## PARAMETERS
+
+### -Token
+
+The Azure AD bearer token corresponding to the specified credentials. If unspecified, a new token will be generated.
+
+```yaml
+Type:                        Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult
+Required:                    false
+Position:                    named
+Default value:               None               
+Accept pipeline input:       false
+Accept wildcard characters:  false
+```
+
+### -UserId
+
+(Optional) The ID of the user account to query Whiteboards for. All Whiteboards this account has access to will be returned.
+
+```yaml
+Type:                        Guid
+Required:                    true
+Position:                    named
+Default value:               None
+Accept pipeline input:       false
+Accept wildcard characters:  false
+```
+
+### -WhiteboardId
+
+(Optional) The ID of a specific Whiteboard.
+
+```yaml
+Type:                        Guid
+Required:                    true
+Position:                    named
+Default value:               None       
+Accept pipeline input:       false
+Accept wildcard characters:  false
+```
+
+## EXAMPLES
+
+### -------------------------- EXAMPLE 1 --------------------------
+
+```
+PS C:\>Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001
+```
+
+Get all of a user's Whiteboards.

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

@@ -0,0 +1,101 @@
+---
+external help file: Microsoft.Whiteboard.PowerShell.Custom.dll-Help.xml
+Module Name: MicrosoftWhiteboard
+applicable: Microsoft Whiteboard
+title: Set-WhiteboardOwner
+online version: 
+schema: 2.0.0
+---
+
+# Invoke-TransferAllWhiteboards
+
+## SYNOPSIS
+
+Transfer ownership of all Whiteboards owned by a user to another user.
+
+## SYNTAX
+
+```
+Invoke-TransferAllWhiteboards [[-Token] <AuthenticationResult>] [-OwnerId] <Guid> [-NewOwnerId] <Guid> [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+## PARAMETERS
+
+### -Token
+
+The Azure AD bearer token corresponding to the specified credentials. If unspecified, a new token will be generated.
+
+```yaml
+Type:                        Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult
+Required:                    false
+Position:                    1
+Default value:               None               
+Accept pipeline input:       false
+Accept wildcard characters:  false
+```
+
+### -OldOwnerId
+
+The ID of the previous owner.
+
+```yaml
+Type:                        Guid
+Required:                    true
+Position:                    3
+Default value:               None
+Accept pipeline input:       false
+Accept wildcard characters:  false
+```
+
+### -NewOwnerId
+
+The ID of the new owner.
+
+```yaml
+Type:                        Guid
+Required:                    true
+Position:                    4
+Default value:               None
+Accept pipeline input:       false
+Accept wildcard characters:  false
+```
+
+### -WhatIf
+
+```yaml
+Type:                        SwitchParameter
+Required:                    false
+Position:                    named
+Default value:               None
+Accept pipeline input:       false
+Accept wildcard characters:  false
+```
+
+### -Confirm [<SwitchParameter>]
+
+```yaml
+Type:                        SwitchParameter
+Required:                    false
+Position:                    named
+Default value:               None
+Accept pipeline input:       false
+Accept wildcard characters:  false
+```
+
+## EXAMPLES
+
+### -------------------------- EXAMPLE 1 --------------------------
+
+```
+PS C:\>Invoke-TransferAllWhiteboards -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 -WhatIf
+```
+
+Check how many Whiteboards will be transferred without transferring them.
+
+### -------------------------- EXAMPLE 2 --------------------------
+
+```
+PS C:\>Invoke-TransferAllWhiteboards -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002
+```
+
+Transfer (and prompt before performing any write actions).

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

@@ -0,0 +1,106 @@
+---
+external help file: Microsoft.Whiteboard.PowerShell.Custom.dll-Help.xml
+Module Name: MicrosoftWhiteboard
+applicable: Microsoft Whiteboard
+title: Set-WhiteboardOwner
+online version: 
+schema: 2.0.0
+---
+
+# Set-WhiteboardOwner
+
+## SYNOPSIS
+
+Sets the owner for a Whiteboard.
+
+## SYNTAX
+
+```
+Set-WhiteboardOwner [[-Token] <AuthenticationResult>] [-WhiteboardId] <Guid> [-OldOwnerId] <Guid> [-NewOwnerId] <Guid> [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+## PARAMETERS
+
+### -Token
+
+The Azure AD bearer token corresponding to the specified credentials. If unspecified, a new token will be generated.
+
+```yaml
+Type:                        Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult
+Required:                    false
+Position:                    1
+Default value:               None               
+Accept pipeline input:       false
+Accept wildcard characters:  false
+```
+
+### -WhiteboardId
+
+The Whiteboard for which the owner is being changed.
+
+```yaml
+Type:                        Guid
+Required:                    true
+Position:                    2
+Default value:               None       
+Accept pipeline input:       false
+Accept wildcard characters:  false
+```
+
+### -OldOwnerId
+
+The ID of the previous owner.
+
+```yaml
+Type:                        Guid
+Required:                    true
+Position:                    3
+Default value:               None
+Accept pipeline input:       false
+Accept wildcard characters:  false
+```
+
+### -NewOwnerId
+
+The ID of the new owner.
+
+```yaml
+Type:                        Guid
+Required:                    true
+Position:                    4
+Default value:               None
+Accept pipeline input:       false
+Accept wildcard characters:  false
+```
+
+### -WhatIf
+
+```yaml
+Type:                        SwitchParameter
+Required:                    false
+Position:                    named
+Default value:               None
+Accept pipeline input:       false
+Accept wildcard characters:  false
+```
+
+### -Confirm [<SwitchParameter>]
+
+```yaml
+Type:                        SwitchParameter
+Required:                    false
+Position:                    named
+Default value:               None
+Accept pipeline input:       false
+Accept wildcard characters:  false
+```
+
+## EXAMPLES
+
+### -------------------------- EXAMPLE 1 --------------------------
+
+```
+PS C:\>Set-WhiteboardOwner -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002
+```
+
+Move a Whiteboard from one user to another.