Invoke-WhiteboardHtmlRetry
Retries whiteboard HTML exports that failed in a previous Export-WhiteboardHtml run.
Syntax
User mode
Invoke-WhiteboardHtmlRetry
-Mode
-Environment <String>
[-OutputPath <String>]
[-LoginAs <String>]
[-ThrottleDelayMs <Int32>]
[<CommonParameters>]
Admin mode
Invoke-WhiteboardHtmlRetry
-Mode
-TenantId <String>
-Environment <String>
[-OutputPath <String>]
[-LoginAs <String>]
[-ThrottleDelayMs <Int32>]
[<CommonParameters>]
Description
Individual whiteboard exports can fail due to transient Graph API errors. The
Export-WhiteboardHtml command retries each whiteboard up to 3 times automatically during the run.
If a whiteboard still fails after all retries, it is recorded in export_state.json.
Run Invoke-WhiteboardHtmlRetry after an export to re-attempt all recorded failures. Use the same
-Mode, -TenantId, -Environment, and -OutputPath values as the original export.
If there are no recorded failures, the command exits immediately with a message confirming nothing needs to be retried.
Examples
EXAMPLE 1
Invoke-WhiteboardHtmlRetry -Mode Admin -TenantId contoso.onmicrosoft.com -Environment AzureCloud
Retry failed exports from an Admin run on a commercial tenant.
EXAMPLE 2
Invoke-WhiteboardHtmlRetry -Mode User -Environment AzureCloud
Retry failed exports from a User run.
EXAMPLE 3
Invoke-WhiteboardHtmlRetry -Mode Admin -TenantId contoso.onmicrosoft.com -Environment AzureCloud `
-OutputPath C:\Exports
Retry with a custom output path (must match the original export).
Parameters
-Environment
Must match the original export. The target cloud environment.
| Value | Cloud | Graph endpoint |
|---|---|---|
| AzureCloud | Commercial / GCC | graph.microsoft.com |
| AzureUSGovernment | GCC-High | graph.microsoft.us |
| AzureUSDoD | DoD | dod-graph.microsoft.us |
| AzureUSNat | Air-Gap (USNat) | graph.eaglex.ic.gov |
| AzureUSSec | Air-Gap (USSec) | graph.microsoft.scloud |
Parameter properties
| Type: | System.String |
| Default value: | None |
| Accepted values: | AzureCloud, AzureUSGovernment, AzureUSDoD, AzureUSNat, AzureUSSec |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-LoginAs
UPN hint shown before the sign-in prompt. Useful when multiple accounts are cached.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Mode
Must match the original export: User or Admin.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Accepted values: | User, Admin |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OutputPath
Must match the original export if a custom path was used. Defaults to the current user's Downloads folder.
Parameter properties
| Type: | System.String |
| Default value: | Downloads folder |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TenantId
Must match the original export. The tenant domain or GUID (for example,
contoso.onmicrosoft.com). Required in Admin mode.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Admin
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ThrottleDelayMs
Milliseconds to pause between API calls.
Parameter properties
| Type: | System.Int32 |
| Default value: | 100 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Notes
For details on the module, see the overview page.