From e05bc1413645033e2eacefe621e7a1e2111ecfb1 Mon Sep 17 00:00:00 2001 From: Shweta Wagh Date: Wed, 16 Apr 2025 10:48:31 +0530 Subject: [PATCH 01/10] Admin commands documentation update for whiteboard to get migrated and originally created fluid whiteboards. --- .../Get-OriginalFluidWhiteboards.md | 111 +++++++++++ .../Get-OriginalFluidWhiteboardsForTenant.md | 178 ++++++++++++++++++ .../whiteboard/Get-Whiteboard.md | 4 +- .../whiteboard/Get-WhiteboardSettings.md | 87 +++++++++ .../whiteboard/Get-WhiteboardsForTenant.md | 6 +- .../Get-WhiteboardsForTenantMigrated.md | 178 ++++++++++++++++++ .../whiteboard/Get-WhiteboardsMigrated.md | 111 +++++++++++ .../whiteboard/Restore-Whiteboard.md | 86 +++++++++ .../whiteboard/Set-WhiteboardSettings.md | 78 ++++++++ .../whiteboard-ps/whiteboard/whiteboard.md | 40 +++- 10 files changed, 871 insertions(+), 8 deletions(-) create mode 100644 whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md create mode 100644 whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md create mode 100644 whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardSettings.md create mode 100644 whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenantMigrated.md create mode 100644 whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsMigrated.md create mode 100644 whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md create mode 100644 whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md b/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md new file mode 100644 index 0000000000..1b2ef53c77 --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md @@ -0,0 +1,111 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-originalfluidwhiteboards +applicable: Microsoft Whiteboard +title: Get-OriginalFluidWhiteboards +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Get-OriginalFluidWhiteboards + +## SYNOPSIS + +Gets one or more whiteboards that are originally created as Fluid whiteboards, directly into users OneDrive and return them as objects. + +## SYNTAX + +```powershell +Get-OriginalFluidWhiteboards [-UserId] [-ForceAuthPrompt] [] +``` + +## DESCRIPTION + +Gets one or more whiteboards that are originally created as Fluid whiteboards, directly into users OneDrive. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\>Get-OriginalFluidWhiteboards -UserId 00000000-0000-0000-0000-000000000001 +``` + +Get all user's whiteboards that are originally created as Fluid whiteboards directly into users OneDrive. + +### Output + +```yaml +Drive Items found for User 00000000-0000-0000-0000-000000000001 --------------------------------------------------- +Name: TradeTestwhiteboard.whiteboard +ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 +Last Modified: 03/06/2025 09:59:32 +Size: 15222 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: 00000000-0000-0000-0000-000000000001 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Name: Test11whiteboard-Copy.whiteboard +ID: 01ZSJH4YZFODVVZ6LTNNC35BT4QON7GTJI +Last Modified: 03/06/2025 09:59:25 +Size: 15225 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: 00000000-0000-0000-0000-000000000001 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +``` + +## PARAMETERS + +### -UserId + +The ID of the user account to query whiteboards for. Admin should have access to user OneDrive to get that user whiteboards. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +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) + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md b/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md new file mode 100644 index 0000000000..e6779e12ce --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md @@ -0,0 +1,178 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-originalfluidwhiteboardsfortenant +applicable: Microsoft Whiteboard +title: Get-OriginalFluidWhiteboardsForTenant +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Get-OriginalFluidWhiteboardsForTenant + +## SYNOPSIS + +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. + +## SYNTAX + +```powershell +Get-OriginalFluidWhiteboardsForTenant [-IncrementalRunName ] [-ForceAuthPrompt] [] +``` + +## DESCRIPTION + +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 + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\>Get-OriginalFluidWhiteboardsForTenant +``` + +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. + +### Output + +```yaml +Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 --------------------------------------------------- +Name: Test11whiteboard.whiteboard +ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 +Last Modified: 03/06/2025 09:59:32 +Size: 15222 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Name: Test11whiteboard-Copy.whiteboard +ID: 01ZSJH4YZFODVVZ6LTNNC35BT4QON7GTJI +Last Modified: 03/06/2025 09:59:25 +Size: 15225 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Drive Items found for User 98f9e197-f331-4cca-b7b7-0c0307452fdd --------------------------------------------------- +Name: Azure111 whiteboard 1.whiteboard +ID: 01BYRZZIGVVILTKNPTFFFL2M5WFSTDVMSZ +Last Modified: 02/13/2025 16:45:58 +Size: 23110 bytes +Migration Date: 02/13/2025 16:45:37 +User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd +User Email: admin@M365x86764163.onmicrosoft.com +User Name: MOD Administrator +-------------------------------------- +Name: Azure111 whiteboard.whiteboard +ID: 01BYRZZIBSVZZUYVJ2JZAKUOV5FMPHM2NL +Last Modified: 02/19/2025 07:35:25 +Size: 12007 bytes +Migration Date: 02/19/2025 07:35:24 +User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd +User Email: admin@M365x86764163.onmicrosoft.com +User Name: MOD Administrator +-------------------------------------- +No drive items found for User cc078d4f-5ba1-48ff-847f-0f4af2ee8cf5 with DriveID b!Upfgzjfpx0e4lqL84H-BRZGV7qFNQ-hCobqXYyyCS1clCfsBBCS5T75ca0pe4UQS +Admin does not have access to User 4f14ba28-e678-4535-a9ea-c9f3b32c46f0 OneDrive. +``` + +### EXAMPLE 2 + +```powershell +PS C:\>Get-OriginalFluidWhiteboardsForTenant -IncrementalRunName 1 +``` + +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. + +### Output + +```yaml +[ + "Name: Test11whiteboard.whiteboard", + "ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4", + "Last Modified: 03/06/2025 09:59:32", + "Size: 15222 bytes", + "Migration Date: 03/06/2025 09:58:57", + "User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4", + "User Email: AdeleV@M365x86764163.OnMicrosoft.com", + "User Name: Adele Vance", + "-----------------------------------------------", + "Name: Untitled.whiteboard", + "ID: 01ZSJH4YYNHPBYXNRAIFAY42SHQ365Z32M", + "Last Modified: 02/19/2025 05:19:04", + "Size: 15307 bytes", + "Migration Date: 02/19/2025 05:19:04", + "User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4", + "User Email: AdeleV@M365x86764163.OnMicrosoft.com", + "User Name: Adele Vance", + "-----------------------------------------------" +] +[ + "Name: Azure111 whiteboard.whiteboard", + "ID: 01BYRZZIBSVZZUYVJ2JZAKUOV5FMPHM2NL", + "Last Modified: 02/19/2025 07:35:25", + "Size: 12007 bytes", + "Migration Date: 02/19/2025 07:35:24", + "User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd", + "User Email: admin@M365x86764163.onmicrosoft.com", + "User Name: MOD Administrator", + "-----------------------------------------------" +] +``` + +## PARAMETERS + +### -IncrementalRunName + +Saves incremental progress as the cmdlet runs. Writes progress and results to `.txt` files in the current directory: + +- `WhiteboardsOriginalFluid-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +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) + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md index ca0223451d..a533b03ca5 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md +++ b/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS -Gets one or more whiteboards from the Microsoft Whiteboard service and returns them as objects. +Gets one or more whiteboards in Azure from the Microsoft Whiteboard service and returns them as objects. ## SYNTAX @@ -24,7 +24,7 @@ Get-Whiteboard [-UserId] [[-WhiteboardId] ] [-ForceAuthPrompt] [] +``` + +## DESCRIPTION + +Gets tenant settings from the Microsoft Whiteboard service and returns them as an object. + +## EXAMPLES + +### EXAMPLE 1 + +This command gets tenant settings from the Microsoft Whiteboard service and returns them as an object. + +```powershell +PS C:\> Get-WhiteboardSettings +``` + +```Output +isClaimEnabled : True +privacySettings : @{telemetryDataPolicy=Optional; isEnabledConnectedServices=True} +tenantMetadata : @{isGovUser=False; isEduUser=False} +isSharePointDefault : False +isSharePointDefaultGa : True +isSharePointDefaultRolledOut : True +isAzureBlocked : False +licenseCheckInformation : Success +isFluidMigrationEnabled : False +isTenantAdminMigrationEnabled : True +isEnabled : True +isEnabledGa : True +``` + +## PARAMETERS + +### -ForceAuthPrompt + +Always prompt for authentication. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +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). + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md index 2f9679d567..531dc66db0 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md +++ b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md @@ -14,7 +14,7 @@ ms.reviewer: ## SYNOPSIS -Gets all the whiteboards associated with a tenant in a specified geography. +Gets all the whiteboards in Azure associated with a tenant in a specified geography. ## SYNTAX @@ -27,13 +27,13 @@ Get-WhiteboardsForTenant [-Geography ] ## DESCRIPTION -Gets all the whiteboards 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. +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. ## EXAMPLES ### EXAMPLE 1 -This command gets all the whiteboards associated with the caller's tenant in Europe as a list of whiteboard metadata objects. +This command gets all the whiteboards in Azure associated with the caller's tenant in Europe as a list of whiteboard metadata objects. ```powershell PS C:\> Get-WhiteboardsForTenant -Geography Europe diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenantMigrated.md b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenantMigrated.md new file mode 100644 index 0000000000..c29105b13b --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenantMigrated.md @@ -0,0 +1,178 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardsfortenantmigrated +applicable: Microsoft Whiteboard +title: Get-WhiteboardsForTenantMigrated +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Get-WhiteboardsForTenantMigrated + +## SYNOPSIS + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. + +## SYNTAX + +```powershell +Get-WhiteboardsForTenantMigrated [-IncrementalRunName ] [-ForceAuthPrompt] [] +``` + +## DESCRIPTION + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. It output all boards migrated to OneDrive in all user accounts under that Tenant provided Admin have access to all those users OneDrive. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\>Get-WhiteboardsForTenantMigrated +``` + +Get all user's migrated whiteboards in that tenant and outputs in cmd with all users whiteboards provided admin has access to all those users oneDrive. + +### Output + +```yaml +Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 --------------------------------------------------- +Name: Test11whiteboard.whiteboard +ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 +Last Modified: 03/06/2025 09:59:32 +Size: 15222 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Name: Test11whiteboard-Copy.whiteboard +ID: 01ZSJH4YZFODVVZ6LTNNC35BT4QON7GTJI +Last Modified: 03/06/2025 09:59:25 +Size: 15225 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Drive Items found for User 98f9e197-f331-4cca-b7b7-0c0307452fdd --------------------------------------------------- +Name: Azure111 whiteboard 1.whiteboard +ID: 01BYRZZIGVVILTKNPTFFFL2M5WFSTDVMSZ +Last Modified: 02/13/2025 16:45:58 +Size: 23110 bytes +Migration Date: 02/13/2025 16:45:37 +User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd +User Email: admin@M365x86764163.onmicrosoft.com +User Name: MOD Administrator +-------------------------------------- +Name: Azure111 whiteboard.whiteboard +ID: 01BYRZZIBSVZZUYVJ2JZAKUOV5FMPHM2NL +Last Modified: 02/19/2025 07:35:25 +Size: 12007 bytes +Migration Date: 02/19/2025 07:35:24 +User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd +User Email: admin@M365x86764163.onmicrosoft.com +User Name: MOD Administrator +-------------------------------------- +No drive items found for User cc078d4f-5ba1-48ff-847f-0f4af2ee8cf5 with DriveID b!Upfgzjfpx0e4lqL84H-BRZGV7qFNQ-hCobqXYyyCS1clCfsBBCS5T75ca0pe4UQS +Admin does not have access to User 4f14ba28-e678-4535-a9ea-c9f3b32c46f0 OneDrive. +``` + +### EXAMPLE 2 + +```powershell +PS C:\>Get-WhiteboardsForTenantMigrated -IncrementalRunName 1 +``` + +Get all user's migrated whiteboards in that tenant and incrementally creates file "WhiteboardsMigrated-$IncrementalRunName.txt" with all users whiteboards provided admin has access to all those users oneDrive. + +### Output + +```yaml +[ + "Name: Test11whiteboard.whiteboard", + "ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4", + "Last Modified: 03/06/2025 09:59:32", + "Size: 15222 bytes", + "Migration Date: 03/06/2025 09:58:57", + "User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4", + "User Email: AdeleV@M365x86764163.OnMicrosoft.com", + "User Name: Adele Vance", + "-----------------------------------------------", + "Name: Untitled.whiteboard", + "ID: 01ZSJH4YYNHPBYXNRAIFAY42SHQ365Z32M", + "Last Modified: 02/19/2025 05:19:04", + "Size: 15307 bytes", + "Migration Date: 02/19/2025 05:19:04", + "User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4", + "User Email: AdeleV@M365x86764163.OnMicrosoft.com", + "User Name: Adele Vance", + "-----------------------------------------------" +] +[ + "Name: Azure111 whiteboard.whiteboard", + "ID: 01BYRZZIBSVZZUYVJ2JZAKUOV5FMPHM2NL", + "Last Modified: 02/19/2025 07:35:25", + "Size: 12007 bytes", + "Migration Date: 02/19/2025 07:35:24", + "User ID: 98f9e197-f331-4cca-b7b7-0c0307452fdd", + "User Email: admin@M365x86764163.onmicrosoft.com", + "User Name: MOD Administrator", + "-----------------------------------------------" +] +``` + +## PARAMETERS + +### -IncrementalRunName + +Saves incremental progress as the cmdlet runs. Writes progress and results to `.txt` files in the current directory: + +- `WhiteboardsMigrated-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +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) + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsMigrated.md b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsMigrated.md new file mode 100644 index 0000000000..6bff3167e4 --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsMigrated.md @@ -0,0 +1,111 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardsmigrated +applicable: Microsoft Whiteboard +title: Get-WhiteboardsMigrated +schema: 2.0.0 +author: shwetawagh +ms.author: shwetawagh +ms.reviewer: +--- + +# Get-WhiteboardsMigrated + +## SYNOPSIS + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. + +## SYNTAX + +```powershell +Get-WhiteboardsMigrated [-UserId] [-ForceAuthPrompt] [] +``` + +## DESCRIPTION + +Gets one or more whiteboards that are migrated to OneDrive for particular user and returns them as objects provided Admin have access to that user OneDrive. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +PS C:\>Get-WhiteboardsMigrated -UserId e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +``` + +Get all user's migrated whiteboards. + +### Output + +```yaml +Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 --------------------------------------------------- +Name: Test11whiteboard.whiteboard +ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 +Last Modified: 03/06/2025 09:59:32 +Size: 15222 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +Name: Test11whiteboard-Copy.whiteboard +ID: 01ZSJH4YZFODVVZ6LTNNC35BT4QON7GTJI +Last Modified: 03/06/2025 09:59:25 +Size: 15225 bytes +Migration Date: 03/06/2025 09:58:57 +User ID: e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +User Email: AdeleV@M365x86764163.OnMicrosoft.com +User Name: Adele Vance +-------------------------------------- +``` + +## PARAMETERS + +### -UserId + +The ID of the user account to query whiteboards for. Admin should have access to user OneDrive to get that users whiteboards. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +Optional. Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +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) + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md new file mode 100644 index 0000000000..e350e94d49 --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md @@ -0,0 +1,86 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/restore-whiteboard +applicable: Microsoft Whiteboard +title: Restore-Whiteboard +schema: 2.0.0 +author: dhotrshw +ms.author: dhotrshw +ms.reviewer: +--- + +# Restore-Whiteboard + +## SYNOPSIS + +Restores the specified Whiteboard by removing the mapping to the board migrated to ODB. This will not delete the ODB board. + +## SYNTAX + +```powershell +Restore-Whiteboard [-WhiteboardId] [-ForceAuthPrompt] [] +``` + +## DESCRIPTION + +Restores the specified Whiteboard by removing the mapping to the board migrated to ODB. This will not delete the ODB board. +Restoration is only possible for approximately 90 days after migration, when the original board is still available. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell +Restore-Whiteboard -WhiteboardId 00000000-0000-0000-0000-000000000002 +``` + +Restore the whiteboard. + +## PARAMETERS + +### -WhiteboardId + +The ID of a specific whiteboard to restore. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -ForceAuthPrompt + +(Optional) Always prompt for auth. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### CommonParameters + +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). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md new file mode 100644 index 0000000000..af99df2a5b --- /dev/null +++ b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md @@ -0,0 +1,78 @@ +--- +external help file: WhiteboardAdmin-help.xml +Module Name: WhiteboardAdmin +online version: https://learn.microsoft.com/powershell/module/whiteboard/set-whiteboardsettings +applicable: Microsoft Whiteboard +title: Set-WhiteboardSettings +schema: 2.0.0 +author: dhotrshw +ms.author: dhotrshw +ms.reviewer: +--- + +# Set-WhiteboardSettings + +## SYNOPSIS + +Get the users Whiteboard settings. + +## SYNTAX + +```powershell +Set-WhiteboardSettings + [-ForceAuthPrompt][-Settings] + [] +``` + +## DESCRIPTION + +Sets the tenant settings for the Microsoft Whiteboard services. + +## EXAMPLES + +### EXAMPLE 1 + +This command sets the tenant settings for the Microsoft Whiteboard services. + +```powershell +PS C:\> $settings = Get-WhiteboardSettings +$settings.isEnabledGa = $true +Set-WhiteboardSettings -Settings $settings +``` + +## PARAMETERS + +### -ForceAuthPrompt + +Always prompt for authentication. Use to ignore cached credentials. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + +### -Settings + +The object to use as Whiteboard Settings. Should be retrieved via Get-WhiteboardSettings + +### CommonParameters + +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). + +## INPUTS + +## OUTPUTS + +## NOTES + +For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). + +## RELATED LINKS diff --git a/whiteboard/whiteboard-ps/whiteboard/whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/whiteboard.md index 00451f81bc..ba9d6b6572 100644 --- a/whiteboard/whiteboard-ps/whiteboard/whiteboard.md +++ b/whiteboard/whiteboard-ps/whiteboard/whiteboard.md @@ -8,17 +8,23 @@ title: Microsoft Whiteboard ## Description -The following cmdlet references are for Microsoft Whiteboard. See [Overview](https://learn.microsoft.com/powershell/whiteboard/overview) for details on installing the module. The module can only be run by users with Global Administrator or SharePoint Administrator roles. The module described here is for Whiteboard content stored in Azure. +The following cmdlet references are for Microsoft Whiteboard. See [Overview](https://learn.microsoft.com/powershell/whiteboard/overview) for details on installing the module. The module can only be run by users with Global Administrator or SharePoint Administrator roles. The module described here is for Whiteboard content stored in Azure. > [!IMPORTANT] > Microsoft recommends that you use roles with the fewest permissions. Using lower permissioned accounts helps improve security for your organization. Global Administrator is a highly privileged role that should be limited to emergency scenarios when you can't use an existing role. To learn more, see [About admin roles in the Microsoft 365 admin center](/microsoft-365/admin/add-users/about-admin-roles). +## Prerequisite for commands Get-OriginalFluidWhiteboards, Get-OriginalFluidWhiteboardsForTenant, Get-WhiteboardsMigrated, Get-WhiteboardsForTenantMigrated to get whiteboards from users OneDrive + +Inorder to get whiteboards which is in OneDrive for any users, Admin should have access to all those users OneDrive. +Admin can use Admin portal to give "Site-CollectionAdmin" role to users account for which they want to get all whiteboards in OneDrive. +Go to sharepoint Admin center > On left hand side, click "More features" > In User profiles, click "Open". +Manage User profiles > Search user > Manage site collection owners > Add Admin as Site Collection Administrator. ## Microsoft Whiteboard Admin cmdlets ### [Get-Whiteboard](Get-Whiteboard.md) -Gets one or more whiteboards from the Microsoft Whiteboard service and returns them as objects. +Gets one or more whiteboards in Azure from the Microsoft Whiteboard service and returns them as objects. ### [Get-WhiteboardOwners](Get-WhiteboardOwners.md) @@ -26,7 +32,23 @@ Gets all the users in a tenant who own whiteboards in a specified geography. ### [Get-WhiteboardsForTenant](Get-WhiteboardsForTenant.md) -Gets all the whiteboards associated with a tenant in a specified geography. +Gets all the whiteboards in Azure associated with a tenant in a specified geography. + +### [Get-OriginalFluidWhiteboards](Get-OriginalFluidWhiteboards.md) + +Gets one or more whiteboards that are originally created as Fluid whiteboards directly into users OneDrive and return them as objects. + +### [Get-OriginalFluidWhiteboardsForTenant](Get-OriginalFluidWhiteboardsForTenant.md) + +Gets one or more whiteboards that are originally created as fluid whiteboards directly into OneDrive for all users under that admin and returns them as objects. + +### [Get-WhiteboardsMigrated](Get-WhiteboardsMigrated.md) + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. + +### [Get-WhiteboardsForTenantMigrated](Get-WhiteboardsForTenantMigrated.md) + +Gets one or more whiteboards that are migrated to OneDrive and returns them as objects. ### [Invoke-TransferAllWhiteboard](Invoke-TransferAllWhiteboards.md) @@ -39,3 +61,15 @@ Deletes the specified whiteboard for the given user from the Microsoft Whiteboar ### [Set-WhiteboardOwner](Set-WhiteboardOwner.md) Sets the owner for a whiteboard. + +### [Restore-Whiteboard](Restore-Whiteboard.md) + +Restores the specified Whiteboard by removing the mapping to the board migrated to ODB. This will not delete the ODB board. + +### [Get-WhiteboardSettings](Get-WhiteboardSettings.md) + +Gets tenant settings from the Microsoft Whiteboard service and returns them as an object. + +### [Set-WhiteboardSettings](Set-WhiteboardSettings.md) + +Sets the tenant settings for the Microsoft Whiteboard services. From d9f02783ea367b8ddc257c0fa32227330131e52d Mon Sep 17 00:00:00 2001 From: Shweta Wagh Date: Thu, 17 Apr 2025 15:31:03 +0530 Subject: [PATCH 02/10] Changed restore whiteboard message --- whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md index e350e94d49..3aa1c086f3 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md +++ b/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md @@ -24,7 +24,7 @@ Restore-Whiteboard [-WhiteboardId] [-ForceAuthPrompt] [ ## DESCRIPTION -Restores the specified Whiteboard by removing the mapping to the board migrated to ODB. This will not delete the ODB board. +Restores the azure board. The migrated onedrive board will be retained to not lose any updates done to Azure board. Restoration is only possible for approximately 90 days after migration, when the original board is still available. ## EXAMPLES From 6e210e18c578f77c1fe969f18fcfef92ad630091 Mon Sep 17 00:00:00 2001 From: Shweta Wagh Date: Thu, 17 Apr 2025 15:38:02 +0530 Subject: [PATCH 03/10] changed author to shwetawagh as dhotrshw was not recognized --- whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardSettings.md | 4 ++-- whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md | 4 ++-- whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardSettings.md b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardSettings.md index 9bf19e5140..ca58a28bde 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardSettings.md +++ b/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardSettings.md @@ -5,8 +5,8 @@ online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whi applicable: Microsoft Whiteboard title: Get-WhiteboardSettings schema: 2.0.0 -author: dhotrshw -ms.author: dhotrshw +author: shwetawagh +ms.author: shwetawagh ms.reviewer: --- diff --git a/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md index 3aa1c086f3..5ceb33569e 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md +++ b/whiteboard/whiteboard-ps/whiteboard/Restore-Whiteboard.md @@ -5,8 +5,8 @@ online version: https://learn.microsoft.com/powershell/module/whiteboard/restore applicable: Microsoft Whiteboard title: Restore-Whiteboard schema: 2.0.0 -author: dhotrshw -ms.author: dhotrshw +author: shwetawagh +ms.author: shwetawagh ms.reviewer: --- diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md index af99df2a5b..c5ce09ab11 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md +++ b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md @@ -5,8 +5,8 @@ online version: https://learn.microsoft.com/powershell/module/whiteboard/set-whi applicable: Microsoft Whiteboard title: Set-WhiteboardSettings schema: 2.0.0 -author: dhotrshw -ms.author: dhotrshw +author: shwetawagh +ms.author: shwetawagh ms.reviewer: --- From f6fb4a3349d4f27bab514793bd0b226295afc897 Mon Sep 17 00:00:00 2001 From: Shweta Wagh Date: Wed, 23 Apr 2025 18:21:23 +0530 Subject: [PATCH 04/10] Added settings yaml and object. --- .../whiteboard/Set-WhiteboardSettings.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md index c5ce09ab11..15ccd568a5 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md +++ b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md @@ -63,6 +63,34 @@ Applicable: Microsoft Whiteboard The object to use as Whiteboard Settings. Should be retrieved via Get-WhiteboardSettings +Example of settings objects + +isClaimEnabled : True +privacySettings : @{telemetryDataPolicy=Optional; isEnabledConnectedServices=True} +tenantMetadata : @{isGovUser=False; isEduUser=False} +isSharePointDefault : False +isSharePointDefaultGa : True +isSharePointDefaultRolledOut : True +isAzureBlocked : False +licenseCheckInformation : Success +isFluidMigrationEnabled : False +isTenantAdminMigrationEnabled : True +isEnabled : True +isEnabledGa : True + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + ### CommonParameters 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). From f7c09f1513b80f0262e1708d90fcced7cde81b40 Mon Sep 17 00:00:00 2001 From: Gary Moore <5432776+garycentric@users.noreply.github.com> Date: Wed, 23 Apr 2025 08:58:33 -0700 Subject: [PATCH 05/10] Add punctuation and code block The list of objects is rendered as a single paragraph with word wrap when it is, by default, body text. --- .../whiteboard-ps/whiteboard/Set-WhiteboardSettings.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md index 15ccd568a5..3c49d56b5c 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md +++ b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md @@ -61,10 +61,11 @@ Applicable: Microsoft Whiteboard ### -Settings -The object to use as Whiteboard Settings. Should be retrieved via Get-WhiteboardSettings +The object to use as Whiteboard Settings. Should be retrieved via Get-WhiteboardSettings. -Example of settings objects +Example of settings objects: +```powershell isClaimEnabled : True privacySettings : @{telemetryDataPolicy=Optional; isEnabledConnectedServices=True} tenantMetadata : @{isGovUser=False; isEduUser=False} @@ -77,6 +78,7 @@ isFluidMigrationEnabled : False isTenantAdminMigrationEnabled : True isEnabled : True isEnabledGa : True +``` ```yaml Type: SwitchParameter From 7cdf22871ad6007bb69b9a72820cd06114a67224 Mon Sep 17 00:00:00 2001 From: Gary Moore <5432776+garycentric@users.noreply.github.com> Date: Wed, 23 Apr 2025 09:18:35 -0700 Subject: [PATCH 06/10] Replace code block with table The code block was not rendered as such. I'm trying a table as a replacement. --- .../whiteboard/Set-WhiteboardSettings.md | 29 ++++++++++--------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md index 3c49d56b5c..e520f724e2 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md +++ b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md @@ -65,20 +65,21 @@ The object to use as Whiteboard Settings. Should be retrieved via Get-Whiteboard Example of settings objects: -```powershell -isClaimEnabled : True -privacySettings : @{telemetryDataPolicy=Optional; isEnabledConnectedServices=True} -tenantMetadata : @{isGovUser=False; isEduUser=False} -isSharePointDefault : False -isSharePointDefaultGa : True -isSharePointDefaultRolledOut : True -isAzureBlocked : False -licenseCheckInformation : Success -isFluidMigrationEnabled : False -isTenantAdminMigrationEnabled : True -isEnabled : True -isEnabledGa : True -``` +| Object | Value | +|:-------|:------| +| isClaimEnabled | True | +| privacySettings | @{telemetryDataPolicy=Optional; isEnabledConnectedServices=True} | +| tenantMetadata | @{isGovUser=False; isEduUser=False} | +| isSharePointDefault | False | +| isSharePointDefaultGa | True | +| isSharePointDefaultRolledOut | True | +| isAzureBlocked | False | +| licenseCheckInformation | Success | +| isFluidMigrationEnabled | False | +| isTenantAdminMigrationEnabled | True | +| isEnabled | True | +| isEnabledGa | True | + ```yaml Type: SwitchParameter From d67f245d752dc5dc17b6ed2de368f059a32258ce Mon Sep 17 00:00:00 2001 From: Gary Moore <5432776+garycentric@users.noreply.github.com> Date: Wed, 23 Apr 2025 09:29:06 -0700 Subject: [PATCH 07/10] Revert to table, but with no content type I see that the page about Get-WhiteboardSettings has such a code block, so this ought to work (and not need to be rendered as a table). --- .../whiteboard/Set-WhiteboardSettings.md | 29 +++++++++---------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md index e520f724e2..10984418af 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md +++ b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md @@ -65,21 +65,20 @@ The object to use as Whiteboard Settings. Should be retrieved via Get-Whiteboard Example of settings objects: -| Object | Value | -|:-------|:------| -| isClaimEnabled | True | -| privacySettings | @{telemetryDataPolicy=Optional; isEnabledConnectedServices=True} | -| tenantMetadata | @{isGovUser=False; isEduUser=False} | -| isSharePointDefault | False | -| isSharePointDefaultGa | True | -| isSharePointDefaultRolledOut | True | -| isAzureBlocked | False | -| licenseCheckInformation | Success | -| isFluidMigrationEnabled | False | -| isTenantAdminMigrationEnabled | True | -| isEnabled | True | -| isEnabledGa | True | - +``` +isClaimEnabled : True +privacySettings : @{telemetryDataPolicy=Optional; isEnabledConnectedServices=True} +tenantMetadata : @{isGovUser=False; isEduUser=False} +isSharePointDefault : False +isSharePointDefaultGa : True +isSharePointDefaultRolledOut : True +isAzureBlocked : False +licenseCheckInformation : Success +isFluidMigrationEnabled : False +isTenantAdminMigrationEnabled : True +isEnabled : True +isEnabledGa : True +``` ```yaml Type: SwitchParameter From fc97a3e3c4727f9eedc6189f219003c270436236 Mon Sep 17 00:00:00 2001 From: Gary Moore <5432776+garycentric@users.noreply.github.com> Date: Wed, 23 Apr 2025 09:47:58 -0700 Subject: [PATCH 08/10] Try content type of "output" --- whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md index 10984418af..18cdcb7bb0 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md +++ b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md @@ -65,7 +65,7 @@ The object to use as Whiteboard Settings. Should be retrieved via Get-Whiteboard Example of settings objects: -``` +```Output isClaimEnabled : True privacySettings : @{telemetryDataPolicy=Optional; isEnabledConnectedServices=True} tenantMetadata : @{isGovUser=False; isEduUser=False} From 99c0b8e178414b550e61bfd84d31367e2bd092c1 Mon Sep 17 00:00:00 2001 From: Gary Moore <5432776+garycentric@users.noreply.github.com> Date: Wed, 23 Apr 2025 10:05:14 -0700 Subject: [PATCH 09/10] Move table to try to get proper rendering --- .../whiteboard/Set-WhiteboardSettings.md | 27 ++++++++++--------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md index 18cdcb7bb0..6672c3f7cc 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md +++ b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md @@ -63,9 +63,22 @@ Applicable: Microsoft Whiteboard The object to use as Whiteboard Settings. Should be retrieved via Get-WhiteboardSettings. +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +Applicable: Microsoft Whiteboard +``` + Example of settings objects: -```Output +```console isClaimEnabled : True privacySettings : @{telemetryDataPolicy=Optional; isEnabledConnectedServices=True} tenantMetadata : @{isGovUser=False; isEduUser=False} @@ -80,18 +93,6 @@ isEnabled : True isEnabledGa : True ``` -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -Applicable: Microsoft Whiteboard -``` ### CommonParameters From ee7b66eddc2f9c8fdc31b718463a1482222a48dc Mon Sep 17 00:00:00 2001 From: Gary Moore <5432776+garycentric@users.noreply.github.com> Date: Wed, 23 Apr 2025 10:39:11 -0700 Subject: [PATCH 10/10] Remove poorly rendered list of objects/properties This list of objects/properties is rendered as a single line with word wrap. Since this seems to be output from Get-WhiteboardSettings, and the page about Get-WhiteboardSettings contains this list (under "Examples")., I'm removing it here and adding a link to that article for "Get-WhiteboardSettings" in the description of "-Settings", which states, "Should be retrieved via Get-WhiteboardSettings." --- .../whiteboard/Set-WhiteboardSettings.md | 19 +------------------ 1 file changed, 1 insertion(+), 18 deletions(-) diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md index 6672c3f7cc..f7c57fa1bf 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md +++ b/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md @@ -61,7 +61,7 @@ Applicable: Microsoft Whiteboard ### -Settings -The object to use as Whiteboard Settings. Should be retrieved via Get-WhiteboardSettings. +The object to use as Whiteboard Settings. Should be retrieved via [Get-WhiteboardSettings](Get-WhiteboardSettings.md). ```yaml Type: SwitchParameter @@ -76,23 +76,6 @@ Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -Example of settings objects: - -```console -isClaimEnabled : True -privacySettings : @{telemetryDataPolicy=Optional; isEnabledConnectedServices=True} -tenantMetadata : @{isGovUser=False; isEduUser=False} -isSharePointDefault : False -isSharePointDefaultGa : True -isSharePointDefaultRolledOut : True -isAzureBlocked : False -licenseCheckInformation : Success -isFluidMigrationEnabled : False -isTenantAdminMigrationEnabled : True -isEnabled : True -isEnabledGa : True -``` - ### CommonParameters