Get-InkCanvas

Module:
InkCanvasAdmin Module

Lists Ink Canvas canvases stored in SharePoint Embedded containers for a user or the entire tenant.

Syntax

User (Default) 

Get-InkCanvas
    -UserId <String>
    [-OutputPath <String>]
    [-TenantId <String>]
    [-ClientId <String>]
    [-ClientSecret <String>]
    [-ContainerTypeId <String>]
    [-Auth <String>]
    [-Tenant <String>]
    [<CommonParameters>]

All 

Get-InkCanvas
    -All
    [-OutputPath <String>]
    [-TenantId <String>]
    [-ClientId <String>]
    [-ClientSecret <String>]
    [-ContainerTypeId <String>]
    [-Auth <String>]
    [-Tenant <String>]
    [<CommonParameters>]

Description

Lists Ink Canvas canvases stored in SharePoint Embedded (SPE) containers. Can query canvases for a specific user or enumerate all canvases across the entire tenant. Returns canvas records including the canvas ID, owner, container ID, size, and timestamps.

Examples

EXAMPLE 1

List all canvases for a specific user.

PS C:\>Get-InkCanvas -UserId 00000000-0000-0000-0000-000000000001

canvasId              : canvas_1712345678_abc12
folderId              : 01ZSJH4Y3TXKT7TKCRRZG3LF
ownerUserId           : 00000000-0000-0000-0000-000000000001
containerId           : b!abc123...
driveId               : b!def456...
folderName            : canvas_1712345678_abc12
createdDateTime       : 2024-04-05T10:00:00Z
lastModifiedDateTime  : 2024-04-06T12:30:00Z
sizeBytes             : 15222

EXAMPLE 2

Enumerate all canvases for the entire tenant and write results to a JSON file.

PS C:\>Get-InkCanvas -All -OutputPath C:\Reports\canvases.json

Parameters

-All

If specified, enumerates 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

-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

-OutputPath

Optional. Path to write the results as a JSON file. If not specified, results are returned as PowerShell objects.

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

-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 to query.

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.

Outputs

System.Object

Returns an array of canvas record objects when no OutputPath is specified.