Export-InkCanvas

Module:: InkCanvasAdmin Module

Exports Ink Canvas canvases as standalone HTML files for data portability or access requests.

Syntax

User (Default)

Export-InkCanvas
    -UserId <String>
    -OutputPath <String>
    [-CanvasId <String>]
    [-CheckpointPath <String>]
    [-Concurrency <Int32>]
    [-TenantId <String>]
    [-ClientId <String>]
    [-ClientSecret <String>]
    [-ContainerTypeId <String>]
    [-Auth <String>]
    [-Tenant <String>]
    [<CommonParameters>]

All

Export-InkCanvas
    -All
    -OutputPath <String>
    [-CanvasId <String>]
    [-CheckpointPath <String>]
    [-Concurrency <Int32>]
    [-TenantId <String>]
    [-ClientId <String>]
    [-ClientSecret <String>]
    [-ContainerTypeId <String>]
    [-Auth <String>]
    [-Tenant <String>]
    [<CommonParameters>]

Description

Exports Ink Canvas canvases as standalone HTML files. Supports exporting a single canvas, all canvases for a specific user, or all canvases across the entire tenant. Supports checkpoint files for resumable bulk exports in case of interruption.

Output structure:

Single canvas or user export: <OutputPath>/<canvasName>.html
Tenant-wide export: <OutputPath>/<userId>/<canvasName>.html

Examples

EXAMPLE 1

Export a specific canvas for a user.

PS C:\>Export-InkCanvas -UserId 00000000-0000-0000-0000-000000000001 -CanvasId canvas_1712345678_abc12 -OutputPath C:\Export

EXAMPLE 2

Export all canvases for a user.

PS C:\>Export-InkCanvas -UserId 00000000-0000-0000-0000-000000000001 -OutputPath C:\Export

EXAMPLE 3

Export all canvases for the entire tenant with a checkpoint file to support resuming.

PS C:\>Export-InkCanvas -All -OutputPath C:\Export -CheckpointPath C:\Export\checkpoint.json

Parameters

-All

If specified, exports canvases for all users in the tenant.

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
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

-Auth

Authentication method to use. Accepted values are: device-code, client-credentials. Defaults to device-code.

Parameter properties

Type:	System.String
Default value:	device-code
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

-CanvasId

Optional. The specific canvas ID (folder name) to export. If not specified, all canvases for the user are exported.

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

-CheckpointPath

Optional. Path to a checkpoint file that tracks already-exported canvases. Allows interrupted bulk exports to resume without re-exporting completed canvases.

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

-ClientId

The client ID of the admin app registration in Azure Active Directory.

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

-ClientSecret

The client secret for client-credentials authentication.

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

-Concurrency

Optional. Number of parallel export operations. Defaults to 5.

Parameter properties

Type:	System.Int32
Default value:	5
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

-ContainerTypeId

The SharePoint Embedded container type ID for Ink Canvas.

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

-OutputPath

Required. The directory path where exported HTML files will be written.

Parameter properties

Type:	System.String
Default value:	None
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

-Tenant

A known tenant preset name that automatically fills in TenantId, ClientId, and ContainerTypeId.

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

-TenantId

The Azure Active Directory tenant ID.

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

-UserId

The Azure Active Directory object GUID of the user whose canvases to export.

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

User

Position:	Named
Mandatory:	True
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

If any canvases fail to export, a summary report is written to <OutputPath>/export-failures.json.

Feedback

Was this page helpful?