Invoke-TransferAllInkCanvases

Module:

InkCanvasAdmin Module

Transfers all Ink Canvas canvases from one user to another.

Syntax

Default (Default)

Invoke-TransferAllInkCanvases
    -FromUserId <String>
    -ToUserId <String>
    [-DryRun]
    [-TenantId <String>]
    [-ClientId <String>]
    [-ClientSecret <String>]
    [-ContainerTypeId <String>]
    [-Auth <String>]
    [-Tenant <String>]
    [<CommonParameters>]

Description

Transfers all Ink Canvas canvases from a source user to a target user. This is typically used when an employee leaves the organization and their canvases need to be reassigned. Each canvas is copied to the target user's SharePoint Embedded container and then deleted from the source user's container. The target user must have opened Ink Canvas at least once to provision their container.

Use Set-InkCanvasOwner to transfer a single specific canvas.

Examples

EXAMPLE 1

Transfer all canvases from one user to another.

PS C:\>Invoke-TransferAllInkCanvases -FromUserId 00000000-0000-0000-0000-000000000001 -ToUserId 00000000-0000-0000-0000-000000000002

EXAMPLE 2

Preview all canvases that would be transferred without making any changes.

PS C:\>Invoke-TransferAllInkCanvases -FromUserId 00000000-0000-0000-0000-000000000001 -ToUserId 00000000-0000-0000-0000-000000000002 -DryRun

Parameters

-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

-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

-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

-DryRun

If specified, prints what would be transferred without performing any actual changes.

Parameter properties

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

-FromUserId

Required. The Azure Active Directory object GUID of the source user whose canvases will be transferred.

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

-ToUserId

Required. The Azure Active Directory object GUID of the target user who will receive the canvases.

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

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

The target user must have opened Ink Canvas at least once to provision their SharePoint Embedded container before a transfer can be performed.