Remove-InkCanvas

Module:
InkCanvasAdmin Module

Deletes one or all Ink Canvas canvases for a user to satisfy data erasure requests.

Syntax

Canvas (Default) 

Remove-InkCanvas
    -UserId <String>
    -CanvasId <String>
    [-DryRun]
    [-TenantId <String>]
    [-ClientId <String>]
    [-ClientSecret <String>]
    [-ContainerTypeId <String>]
    [-Auth <String>]
    [-Tenant <String>]
    [<CommonParameters>]

All 

Remove-InkCanvas
    -UserId <String>
    -All
    [-DryRun]
    [-TenantId <String>]
    [-ClientId <String>]
    [-ClientSecret <String>]
    [-ContainerTypeId <String>]
    [-Auth <String>]
    [-Tenant <String>]
    [<CommonParameters>]

Description

Permanently deletes one or all Ink Canvas canvases belonging to a user. This cmdlet is intended for GDPR/CCPA data subject erasure requests. Use the -DryRun flag to preview what would be deleted without making any changes.

Warning

Deletion is permanent and cannot be undone. Use -DryRun to verify the scope of deletion before proceeding.

Examples

EXAMPLE 1

Delete a specific canvas for a user.

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

EXAMPLE 2

Preview all canvases that would be deleted for a user without making changes.

PS C:\>Remove-InkCanvas -UserId 00000000-0000-0000-0000-000000000001 -All -DryRun

EXAMPLE 3

Delete all canvases for a user.

PS C:\>Remove-InkCanvas -UserId 00000000-0000-0000-0000-000000000001 -All

Parameters

-All

If specified, deletes all canvases for the specified user.

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

The specific canvas ID (folder name) to delete.

Parameter properties

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

Parameter sets

Canvas
Position:Named
Mandatory:True
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 deleted without performing any actual deletions.

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

-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

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

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.