diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-OriginalFluidWhiteboards.md similarity index 74% rename from whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Get-OriginalFluidWhiteboards.md index 1b2ef53c77..79b19d9edd 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboards.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-OriginalFluidWhiteboards.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/get-originalfluidwhiteboards @@ -13,13 +13,13 @@ 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] [] +``` +Get-OriginalFluidWhiteboards [-UserId] [[-ConnectMgGraph] ] [[-ContinuationToken] ] + [-ForceAuthPrompt] [[-IncrementalRunName] ] [] ``` ## DESCRIPTION @@ -30,15 +30,14 @@ Gets one or more whiteboards that are originally created as Fluid whiteboards, d ### EXAMPLE 1 +Get all user's whiteboards that are originally created as Fluid whiteboards directly into users OneDrive. + ```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 +```Output Drive Items found for User 00000000-0000-0000-0000-000000000001 --------------------------------------------------- Name: TradeTestwhiteboard.whiteboard ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 @@ -62,21 +61,34 @@ 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. +### -ConnectMgGraph +{{ Fill ConnectMgGraph Description }} ```yaml -Type: Guid +Type: System.String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard +``` + +### -ContinuationToken +{{ Fill ContinuationToken Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False ``` ### -ForceAuthPrompt @@ -96,14 +108,50 @@ Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` +### -IncrementalRunName +{{ Fill IncrementalRunName Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: 0 +Default value: None +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 +### None + ## OUTPUTS +### System.Object + ## NOTES For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-OriginalFluidWhiteboardsForTenant.md similarity index 76% rename from whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Get-OriginalFluidWhiteboardsForTenant.md index e6779e12ce..2d00aa0690 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-OriginalFluidWhiteboardsForTenant.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-OriginalFluidWhiteboardsForTenant.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/get-originalfluidwhiteboardsfortenant @@ -13,33 +13,37 @@ 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. +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] [] +``` +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 +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 +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. + ```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 --------------------------------------------------- +```Output +Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +--------------------------------------------------- Name: Test11whiteboard.whiteboard ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 Last Modified: 03/06/2025 09:59:32 @@ -58,7 +62,8 @@ 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 --------------------------------------------------- +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 @@ -83,15 +88,15 @@ Admin does not have access to User 4f14ba28-e678-4535-a9ea-c9f3b32c46f0 OneDrive ### EXAMPLE 2 +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. + ```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 +```Output [ "Name: Test11whiteboard.whiteboard", "ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4", @@ -127,37 +132,39 @@ Get all user's originally created fluid whiteboards in that tenant and increment ## PARAMETERS -### -IncrementalRunName - -Saves incremental progress as the cmdlet runs. Writes progress and results to `.txt` files in the current directory: +### -ForceAuthPrompt -- `WhiteboardsOriginalFluid-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**. +Optional. Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 2 -Default value: None +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -ForceAuthPrompt +### -IncrementalRunName -Optional. Always prompt for auth. Use to ignore cached credentials. +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: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: False +Position: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard @@ -165,12 +172,19 @@ 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) +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 +### None + ## OUTPUTS +### System.Object + ## NOTES For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-Whiteboard.md similarity index 76% rename from whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Get-Whiteboard.md index a533b03ca5..e892faa107 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-Whiteboard.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-Whiteboard.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboard @@ -13,40 +13,39 @@ ms.reviewer: # Get-Whiteboard ## SYNOPSIS - -Gets one or more whiteboards in Azure 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 -```powershell +``` Get-Whiteboard [-UserId] [[-WhiteboardId] ] [-ForceAuthPrompt] [] ``` ## DESCRIPTION -Gets one or more whiteboards in Azure 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. ## EXAMPLES ### EXAMPLE 1 ```powershell -PS C:\>Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 +Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 ``` Get all of a user's whiteboards. ### EXAMPLE 2 -```powershell -PS C:\>Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 -WhiteboardId 00000000-0000-0000-0000-000000000002 -``` - Get a user's specific whiteboard. -### Output +```powershell +Get-Whiteboard -UserId 00000000-0000-0000-0000-000000000001 -WhiteboardId 00000000-0000-0000-0000-000000000002 +``` -```yaml +```Output baseApi: baseApi-value id: whiteboardId-value userId: userId-value @@ -68,52 +67,52 @@ eTag: eTag-value ## PARAMETERS -### -UserId +### -ForceAuthPrompt -The ID of the user account to query whiteboards for. All whiteboards this account has access to will be returned. +Optional. Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: Guid +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -WhiteboardId +### -UserId -Optional. The ID of a specific whiteboard. +The ID of the user account to query whiteboards for. All whiteboards this account has access to will +be returned. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: -Required: False -Position: 2 +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. +### -WhiteboardId +(Optional) The ID of a specific Whiteboard to query, if not specified all whiteboards are queried. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: False +Position: 2 +Default value: None Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard @@ -121,7 +120,10 @@ 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) +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 diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardOwners.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardOwners.md similarity index 63% rename from whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardOwners.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardOwners.md index 1f5bb1aa2a..914f8e16ae 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardOwners.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardOwners.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardowners @@ -13,32 +13,34 @@ ms.reviewer: # Get-WhiteboardOwners ## SYNOPSIS - Gets all the users in a tenant who own whiteboards in a specified geography. ## SYNTAX -```powershell -Get-WhiteboardOwners [-Geography] [[-ContinuationToken] ] [-ForceAuthPrompt] [] +``` +Get-WhiteboardOwners [-Geography] [[-ContinuationToken] ] [-ForceAuthPrompt] + [] ``` ## DESCRIPTION -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. +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. ## EXAMPLES ### EXAMPLE 1 +Get the owners in the European geography. + ```powershell PS C:\>Get-WhiteboardOwners -Geography Europe ``` -Get the owners in the European geography. - -### Output - -```yaml +```Output TenantId: tenantId Geography: The geography queried for Items: List of user ids @@ -47,52 +49,55 @@ ContinuationToken: continuation token ## PARAMETERS -### -Geography +### -ContinuationToken -Required. The geography to look for board owners in. Accepted values are: Europe, Australia, or Worldwide (all boards not in australia or europe). +(Optional) A continuation token based on the last time this function was called. Due to the large +volume of boards in a tenant, results are returned in chunks at a time, with a continuation token to +signify where to pick up from. To start from the beginning, pass in null. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -ContinuationToken +### -ForceAuthPrompt -Optional. The continuation token returned in a previous call. +Optional. Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 2 -Default value: None +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -ForceAuthPrompt +### -Geography -Optional. Always prompt for auth. Use to ignore cached credentials. +Required. The geography to look for board owners in. Accepted values are: Europe, Australia, or +Worldwide (all boards not in australia or europe). ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard @@ -100,7 +105,10 @@ 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). +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 diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardSettings.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardSettings.md similarity index 82% rename from whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardSettings.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardSettings.md index ca58a28bde..6e268b8fb1 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardSettings.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardSettings.md @@ -13,15 +13,12 @@ ms.reviewer: # Get-WhiteboardSettings ## SYNOPSIS - Get the users Whiteboard settings. ## SYNTAX -```powershell -Get-WhiteboardSettings - [-ForceAuthPrompt] - [] +``` +Get-WhiteboardSettings [-ForceAuthPrompt] [] ``` ## DESCRIPTION @@ -35,7 +32,7 @@ Gets tenant settings from the Microsoft Whiteboard service and returns them as a This command gets tenant settings from the Microsoft Whiteboard service and returns them as an object. ```powershell -PS C:\> Get-WhiteboardSettings +Get-WhiteboardSettings ``` ```Output @@ -60,7 +57,7 @@ isEnabledGa : True Always prompt for authentication. Use to ignore cached credentials. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -74,7 +71,10 @@ 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). +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 diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsForTenant.md similarity index 70% rename from whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsForTenant.md index 531dc66db0..09044f3041 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenant.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsForTenant.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardsfortenant @@ -13,30 +13,29 @@ ms.reviewer: # Get-WhiteboardsForTenant ## SYNOPSIS - Gets all the whiteboards in Azure associated with a tenant in a specified geography. ## SYNTAX -```powershell -Get-WhiteboardsForTenant [-Geography ] - [-IncrementalRunName ] - [-ForceAuthPrompt] +``` +Get-WhiteboardsForTenant [-Geography] [[-IncrementalRunName] ] [-ForceAuthPrompt] [] ``` ## DESCRIPTION -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. +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 +### Example 1 -This command gets all the whiteboards in Azure 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 +Get-WhiteboardsForTenant -Geography Europe ``` ```Output @@ -77,57 +76,72 @@ meetingId : eTag : W/"datetime'2023-01-06T19%3A22%3A42.6717851Z'" ``` +### Example 2 + +```powershell +Get-WhiteboardsForTenant -Geography Europe -IncrementalRunName 1 +``` + +Gets all the tenant whiteboards in Europe and incrementally writes them to Whiteboards-1.txt file in +the current directory. Saves progress at WhiteboardAdminRun-1.txt file until the request is +completed. If this file already exists, continues the progress using the last saved token. + ## PARAMETERS -### -Geography +### -ForceAuthPrompt -The geography to look for board owners in. Accepted values are `Europe`, `Australia`, or `Worldwide` (all boards not in Australia or Europe). +Always prompt for authentication. Use to ignore cached credentials. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -IncrementalRunName - -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: +### -Geography -- `Whiteboards-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**. -- `WhiteboardAdminRun-*.txt` contains the current state where `*` is the provided **IncrementalRunName**. This file should not be modified manually. +The geography to look for board owners in. Accepted values are `Europe`, `Australia`, or `Worldwide` +(all boards not in Australia or Europe). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: -Required: False -Position: 2 +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -ForceAuthPrompt +### -IncrementalRunName -Always prompt for authentication. Use to ignore cached credentials. +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: + +- `Whiteboards-*.txt` contains the incremental results containing whiteboard objects for the tenant + where `*` is the provided **IncrementalRunName**. +- `WhiteboardAdminRun-*.txt` contains the current state where `*` is the provided + **IncrementalRunName**. This file should not be modified manually. ```yaml -Type: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: False +Position: 2 +Default value: None Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard @@ -135,7 +149,10 @@ 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). +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 diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenantMigrated.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsForTenantMigrated.md similarity index 77% rename from whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenantMigrated.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsForTenantMigrated.md index c29105b13b..c7e2391a94 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsForTenantMigrated.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsForTenantMigrated.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardsfortenantmigrated @@ -13,33 +13,35 @@ 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] [] +``` +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. +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 +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. + ```powershell -PS C:\>Get-WhiteboardsForTenantMigrated +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 --------------------------------------------------- +```Output +Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +--------------------------------------------------- Name: Test11whiteboard.whiteboard ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 Last Modified: 03/06/2025 09:59:32 @@ -58,7 +60,8 @@ 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 --------------------------------------------------- +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 @@ -83,15 +86,15 @@ Admin does not have access to User 4f14ba28-e678-4535-a9ea-c9f3b32c46f0 OneDrive ### EXAMPLE 2 +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. + ```powershell -PS C:\>Get-WhiteboardsForTenantMigrated -IncrementalRunName 1 +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 +```Output [ "Name: Test11whiteboard.whiteboard", "ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4", @@ -127,37 +130,39 @@ Get all user's migrated whiteboards in that tenant and incrementally creates fil ## PARAMETERS -### -IncrementalRunName - -Saves incremental progress as the cmdlet runs. Writes progress and results to `.txt` files in the current directory: +### -ForceAuthPrompt -- `WhiteboardsMigrated-*.txt` contains the incremental results containing whiteboard objects for the tenant where `*` is the provided **IncrementalRunName**. +Optional. Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: String +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 2 -Default value: None +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -ForceAuthPrompt +### -IncrementalRunName -Optional. Always prompt for auth. Use to ignore cached credentials. +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: SwitchParameter +Type: System.String Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: False +Position: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard @@ -165,12 +170,19 @@ 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) +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 +### None + ## OUTPUTS +### System.Object + ## NOTES For details on user IDs, see the [overview page](../../docs-conceptual/overview.md). diff --git a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsMigrated.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsMigrated.md similarity index 58% rename from whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsMigrated.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsMigrated.md index 6bff3167e4..f7e2b24f2a 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Get-WhiteboardsMigrated.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Get-WhiteboardsMigrated.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/get-whiteboardsmigrated @@ -13,33 +13,33 @@ 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] [] +``` +Get-WhiteboardsMigrated [-UserId] [[-ConnectMgGraph] ] [[-ContinuationToken] ] + [-ForceAuthPrompt] [[-IncrementalRunName] ] [] ``` ## 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. +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 +```powershell +Get-WhiteboardsMigrated -UserId e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +``` -```yaml -Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 --------------------------------------------------- +```Output +Drive Items found for User e2ff85af-37e6-4ed7-893b-7ea10c380dc4 +--------------------------------------------------- Name: Test11whiteboard.whiteboard ID: 01ZSJH4Y3TXKT7TKCRRZG3LFKTEGDGSKW4 Last Modified: 03/06/2025 09:59:32 @@ -62,21 +62,34 @@ User Name: Adele Vance ## PARAMETERS -### -UserId +### -ConnectMgGraph +{{ Fill ConnectMgGraph Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: -The ID of the user account to query whiteboards for. Admin should have access to user OneDrive to get that users whiteboards. +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContinuationToken +{{ Fill ContinuationToken Description }} ```yaml -Type: Guid +Type: System.String Parameter Sets: (All) Aliases: -Required: True -Position: 1 +Required: False +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False -Applicable: Microsoft Whiteboard ``` ### -ForceAuthPrompt @@ -84,7 +97,7 @@ Applicable: Microsoft Whiteboard Optional. Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -96,9 +109,45 @@ Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` +### -IncrementalRunName +{{ Fill IncrementalRunName Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: System.Guid +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +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) +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 diff --git a/whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Invoke-TransferAllWhiteboards.md similarity index 73% rename from whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Invoke-TransferAllWhiteboards.md index a770d4b062..a5f23e4a0f 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Invoke-TransferAllWhiteboards.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Invoke-TransferAllWhiteboards.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/invoke-transferallwhiteboards @@ -13,13 +13,13 @@ ms.reviewer: # Invoke-TransferAllWhiteboards ## SYNOPSIS - -Transfer ownership of all whiteboards owned by a user to another user. +Transfer ownership of all Whiteboards owned by a user to another user. ## SYNTAX -```powershell -Invoke-TransferAllWhiteboards [-OldOwnerId] [-NewOwnerId] [-ForceAuthPrompt] [-WhatIf] [-Confirm] [] +``` +Invoke-TransferAllWhiteboards [-OldOwnerId] [-NewOwnerId] [-ForceAuthPrompt] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,7 +31,7 @@ Transfer ownership of all whiteboards owned by a user to another user. ### EXAMPLE 1 ```powershell -PS C:\>Invoke-TransferAllWhiteboards -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 -WhatIf +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. @@ -39,25 +39,25 @@ Check how many whiteboards will be transferred without transferring them. ### EXAMPLE 2 ```powershell -PS C:\>Invoke-TransferAllWhiteboards -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 +Invoke-TransferAllWhiteboards -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 ``` Transfer (and prompt before performing any write actions). ## PARAMETERS -### -OldOwnerId +### -ForceAuthPrompt -The ID of the previous owner. +Optional. Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: Guid +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard @@ -68,7 +68,7 @@ Applicable: Microsoft Whiteboard The ID of the new owner. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: @@ -80,31 +80,31 @@ Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -ForceAuthPrompt +### -OldOwnerId -Optional. Always prompt for auth. Use to ignore cached credentials. +The ID of the previous owner. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -WhatIf +### -Confirm -Execute the command without making any actual changes. Only calls read methods on the REST service. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named @@ -114,14 +114,14 @@ Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -Confirm +### -WhatIf -Prompts you for confirmation before running the cmdlet. +Execute the command without making any actual changes. Only calls read methods on the REST service. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -133,7 +133,10 @@ 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). +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 diff --git a/whiteboard/whiteboard-ps/whiteboard/Remove-Whiteboard.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Remove-Whiteboard.md similarity index 73% rename from whiteboard/whiteboard-ps/whiteboard/Remove-Whiteboard.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Remove-Whiteboard.md index 69a0893606..7409007747 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Remove-Whiteboard.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Remove-Whiteboard.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/remove-whiteboard @@ -13,8 +13,7 @@ ms.reviewer: # Remove-Whiteboard ## SYNOPSIS - -Deletes the specified whiteboard for the given user from the Microsoft Whiteboard service. If the user is the owner of the whiteboard, the entire whiteboard will be deleted. If the user has joined the whiteboard but does not own it, they will be removed and the whiteboard will still be accessible by others. +Deletes the specified whiteboard for the given user from the Microsoft Whiteboard service. ## SYNTAX @@ -24,7 +23,10 @@ Remove-Whiteboard [-UserId] [-WhiteboardId] [-ForceAuthPrompt] [ [-ForceAuthPrompt] [ ## DESCRIPTION -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. +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 ### EXAMPLE 1 ```powershell -Restore-Whiteboard -WhiteboardId 00000000-0000-0000-0000-000000000002 +Restore-Whiteboard -WhiteboardId 00000000-0000-0000-0000-000000000000 ``` Restore the whiteboard. ## PARAMETERS -### -WhiteboardId +### -ForceAuthPrompt -The ID of a specific whiteboard to restore. +(Optional) Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) Aliases: -Required: True -Position: 2 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -ForceAuthPrompt +### -WhiteboardId -(Optional) Always prompt for auth. Use to ignore cached credentials. +The ID of a specific whiteboard to restore. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard @@ -75,7 +76,10 @@ 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). +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 diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Set-WhiteboardOwner.md similarity index 76% rename from whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Set-WhiteboardOwner.md index 3b05afdd46..8f9f93835e 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardOwner.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Set-WhiteboardOwner.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/set-whiteboardowner @@ -13,13 +13,13 @@ ms.reviewer: # Set-WhiteboardOwner ## SYNOPSIS - -Sets the owner for a whiteboard. +Sets the owner for a Whiteboard. ## SYNTAX -```powershell -Set-WhiteboardOwner [-WhiteboardId] [-OldOwnerId] [-NewOwnerId] [-ForceAuthPrompt] [-WhatIf] [-Confirm] [] +``` +Set-WhiteboardOwner [-WhiteboardId] [-OldOwnerId] [-NewOwnerId] [-ForceAuthPrompt] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,89 +31,89 @@ Sets the owner for a whiteboard. ### EXAMPLE 1 ```powershell -PS C:\>Set-WhiteboardOwner -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 -WhiteboardId 00000000-0000-0000-0000-000000000003 +Set-WhiteboardOwner -OldOwnerId 00000000-0000-0000-0000-000000000001 -NewOwnerId 00000000-0000-0000-0000-000000000002 ``` Move whiteboard ownership from one user to another. ## PARAMETERS -### -WhiteboardId +### -ForceAuthPrompt -The whiteboard for which the owner is being changed. +Optional. Always prompt for auth. Use to ignore cached credentials. ```yaml -Type: Guid +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -OldOwnerId +### -NewOwnerId -The ID of the previous owner. +The ID of the new owner. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -NewOwnerId +### -OldOwnerId -The ID of the new owner. +The ID of the previous owner. ```yaml -Type: Guid +Type: System.Guid Parameter Sets: (All) Aliases: Required: True -Position: 3 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -ForceAuthPrompt +### -WhiteboardId -Optional. Always prompt for auth. Use to ignore cached credentials. +The whiteboard for which the owner is being changed. ```yaml -Type: SwitchParameter +Type: System.Guid Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -WhatIf +### -Confirm -Shows what would happen if the cmdlet runs. The cmdlet is not run. +Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named @@ -123,14 +123,14 @@ Accept wildcard characters: False Applicable: Microsoft Whiteboard ``` -### -Confirm +### -WhatIf -Prompts you for confirmation before running the cmdlet. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -142,7 +142,10 @@ 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). +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 diff --git a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/Set-WhiteboardSettings.md similarity index 72% rename from whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md rename to whiteboard/whiteboard-ps/WhiteboardAdmin/Set-WhiteboardSettings.md index f7c57fa1bf..6b468841b2 100644 --- a/whiteboard/whiteboard-ps/whiteboard/Set-WhiteboardSettings.md +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/Set-WhiteboardSettings.md @@ -1,4 +1,4 @@ ---- +--- external help file: WhiteboardAdmin-help.xml Module Name: WhiteboardAdmin online version: https://learn.microsoft.com/powershell/module/whiteboard/set-whiteboardsettings @@ -13,15 +13,12 @@ ms.reviewer: # Set-WhiteboardSettings ## SYNOPSIS - Get the users Whiteboard settings. ## SYNTAX -```powershell -Set-WhiteboardSettings - [-ForceAuthPrompt][-Settings] - [] +``` +Set-WhiteboardSettings [-Settings] [-ForceAuthPrompt] [] ``` ## DESCRIPTION @@ -35,7 +32,7 @@ Sets the tenant settings for the Microsoft Whiteboard services. This command sets the tenant settings for the Microsoft Whiteboard services. ```powershell -PS C:\> $settings = Get-WhiteboardSettings +$settings = Get-WhiteboardSettings $settings.isEnabledGa = $true Set-WhiteboardSettings -Settings $settings ``` @@ -47,7 +44,7 @@ Set-WhiteboardSettings -Settings $settings Always prompt for authentication. Use to ignore cached credentials. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -61,16 +58,17 @@ Applicable: Microsoft Whiteboard ### -Settings -The object to use as Whiteboard Settings. Should be retrieved via [Get-WhiteboardSettings](Get-WhiteboardSettings.md). +The object to use as Whiteboard Settings. Should be retrieved via +[Get-WhiteboardSettings](Get-WhiteboardSettings.md). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: Required: True -Position: Named -Default value: False +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False Applicable: Microsoft Whiteboard @@ -79,7 +77,10 @@ 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). +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 diff --git a/whiteboard/whiteboard-ps/WhiteboardAdmin/WhiteboardAdmin.md b/whiteboard/whiteboard-ps/WhiteboardAdmin/WhiteboardAdmin.md new file mode 100644 index 0000000000..f6f901d7ef --- /dev/null +++ b/whiteboard/whiteboard-ps/WhiteboardAdmin/WhiteboardAdmin.md @@ -0,0 +1,77 @@ +--- +Module Name: WhiteboardAdmin +Module Guid: cc24f7d4-4cf7-46d3-bd87-30a3d44ecf96 +Download Help Link: +Help Version: +Locale: en-US +--- + +# WhiteboardAdmin Module + +## Description + +The following cmdlet references are for Microsoft Whiteboard. See +[Overview](/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 +> +> To get a whiteboard that is in OneDrive for any user, Admin should have access to their user's +> OneDrive. Admin can use Admin portal to give the `Site-CollectionAdmin` role to user account for +> which they want to get all whiteboards. +> +> 1. Go to **SharePoint Admin center** +> 2. On left hand side, select **More features** +> 3. In **User profiles**, select **Open** > **Manage User profiles** > **Search user** > +> **Manage site collection owners** > **Add Admin as Site Collection Administrator**. + +## WhiteboardAdmin cmdlets + +### [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 directly into OneDrive for all users under that admin and returns them as objects. + +### [Get-Whiteboard](Get-Whiteboard.md) +Gets one or more whiteboards in Azure from the Microsoft Whiteboard service and returns them as objects. + +### [Get-WhiteboardOwners](Get-WhiteboardOwners.md) +Gets all the users in a tenant who own whiteboards in a specified geography. + +### [Get-WhiteboardSettings](Get-WhiteboardSettings.md) +Get the users Whiteboard settings. + +### [Get-WhiteboardsForTenant](Get-WhiteboardsForTenant.md) +Gets all the whiteboards in Azure associated with a tenant in a specified geography. + +### [Get-WhiteboardsForTenantMigrated](Get-WhiteboardsForTenantMigrated.md) +Gets one or more whiteboards that are migrated to OneDrive 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. + +### [Invoke-TransferAllWhiteboards](Invoke-TransferAllWhiteboards.md) +Transfer ownership of all Whiteboards owned by a user to another user. + +### [Remove-Whiteboard](Remove-Whiteboard.md) +Deletes the specified whiteboard for the given user from the Microsoft Whiteboard service. + +### [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. + +### [Set-WhiteboardOwner](Set-WhiteboardOwner.md) +Sets the owner for a Whiteboard. + +### [Set-WhiteboardSettings](Set-WhiteboardSettings.md) +Get the users Whiteboard settings. diff --git a/whiteboard/whiteboard-ps/whiteboard/whiteboard.md b/whiteboard/whiteboard-ps/whiteboard/whiteboard.md deleted file mode 100644 index ba9d6b6572..0000000000 --- a/whiteboard/whiteboard-ps/whiteboard/whiteboard.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -Module Name: Microsoft Whiteboard Admin -Module Guid: CC24F7D4-4CF7-46D3-BD87-30A3D44ECF96 -title: Microsoft Whiteboard ---- - -# Microsoft Whiteboard Admin - -## 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. - -> [!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 in Azure from the Microsoft Whiteboard service and returns them as objects. - -### [Get-WhiteboardOwners](Get-WhiteboardOwners.md) - -Gets all the users in a tenant who own whiteboards in a specified geography. - -### [Get-WhiteboardsForTenant](Get-WhiteboardsForTenant.md) - -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) - -Transfer ownership of all whiteboards owned by a user to another user. - -### [Remove-Whiteboard](Remove-Whiteboard.md) - -Deletes the specified whiteboard for the given user from the Microsoft Whiteboard service. If the user is the owner of the whiteboard, the entire whiteboard will be deleted. If the user has joined the whiteboard but does not own it, they will be removed and the whiteboard will still be accessible by others. - -### [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.