From 2a48edcb71f297923167a65f7d36f8c08e604544 Mon Sep 17 00:00:00 2001 From: Tommy Brosman Date: Mon, 23 Apr 2018 14:30:16 -0700 Subject: [PATCH] First version of the WhiteboardAdmin PowerShell documentation. --- whiteboard/docfx.json | 71 ++++++++++++ whiteboard/docs-conceptual/index.md | 7 ++ whiteboard/docs-conceptual/intro.md | 7 ++ whiteboard/docs-conceptual/overview.md | 3 + whiteboard/docs-conceptual/toc.yml | 5 + whiteboard/mapping/monikerMapping.json | 11 ++ .../whiteboard/Get-Whiteboard.md | 73 ++++++++++++ .../Invoke-TransferAllWhiteboards.md | 101 +++++++++++++++++ .../whiteboard/Set-WhiteboardOwner.md | 106 ++++++++++++++++++ .../whiteboard-ps/whiteboard/whiteboard.md | 18 +++ 10 files changed, 402 insertions(+) create mode 100644 whiteboard/docfx.json create mode 100644 whiteboard/docs-conceptual/index.md create mode 100644 whiteboard/docs-conceptual/intro.md create mode 100644 whiteboard/docs-conceptual/overview.md create mode 100644 whiteboard/docs-conceptual/toc.yml create mode 100644 whiteboard/mapping/monikerMapping.json create mode 100644 whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md create mode 100644 whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md create mode 100644 whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md create mode 100644 whiteboard/whiteboard-ps/whiteboard/whiteboard.md diff --git a/whiteboard/docfx.json b/whiteboard/docfx.json new file mode 100644 index 0000000000..a7e705cca0 --- /dev/null +++ b/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" + } +} \ No newline at end of file diff --git a/whiteboard/docs-conceptual/index.md b/whiteboard/docs-conceptual/index.md new file mode 100644 index 0000000000..8bc8f5f245 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/whiteboard/docs-conceptual/intro.md b/whiteboard/docs-conceptual/intro.md new file mode 100644 index 0000000000..8bc8f5f245 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/whiteboard/docs-conceptual/overview.md b/whiteboard/docs-conceptual/overview.md new file mode 100644 index 0000000000..c7ef055789 --- /dev/null +++ b/whiteboard/docs-conceptual/overview.md @@ -0,0 +1,3 @@ +#My overview + +This is an overview page \ No newline at end of file diff --git a/whiteboard/docs-conceptual/toc.yml b/whiteboard/docs-conceptual/toc.yml new file mode 100644 index 0000000000..2f726b4da1 --- /dev/null +++ b/whiteboard/docs-conceptual/toc.yml @@ -0,0 +1,5 @@ +- name: Overview + href: index.md + items: + - name: Introduction + href: intro.md diff --git a/whiteboard/mapping/monikerMapping.json b/whiteboard/mapping/monikerMapping.json new file mode 100644 index 0000000000..de334b7c4b --- /dev/null +++ b/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": {} + } + } +} diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md new file mode 100644 index 0000000000..182be19e22 --- /dev/null +++ b/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 ] -UserId -WhiteboardId [] + +Get-Whiteboard [-Token ] -UserId [] +``` + +## 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. \ No newline at end of file diff --git a/whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md b/whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md new file mode 100644 index 0000000000..5b4068332a --- /dev/null +++ b/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] ] [-OwnerId] [-NewOwnerId] [-WhatIf] [-Confirm] [] +``` + +## 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 [] + +```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). \ No newline at end of file diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md new file mode 100644 index 0000000000..98a023bdda --- /dev/null +++ b/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] ] [-WhiteboardId] [-OldOwnerId] [-NewOwnerId] [-WhatIf] [-Confirm] [] +``` + +## 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 [] + +```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. \ No newline at end of file diff --git a/whiteboard/whiteboard-ps/whiteboard/whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/whiteboard.md new file mode 100644 index 0000000000..af1f16e222 --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/whiteboard.md @@ -0,0 +1,18 @@ +--- +Module Name: Microsoft Whiteboard Admin +Module Guid: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +title: whiteboard +Locale: en-US +--- + +# Microsoft Whiteboard Admin + +## Description +The following cmdlet references are for Microsoft Whiteboard. + +## Cmdlets +### [Get-Whiteboard](Get-Whiteboard.md) + +### [Set-WhiteboardOwner](Set-WhiteboardOwner.md) + +### [Invoke-TransferAllWhiteboard](Invoke-TransferAllWhiteboard.md) \ No newline at end of file