Skip to main content

Export-IMAssetThumbnail

SYNOPSIS​

Exports Immich asset thumbnails

SYNTAX​

Export-IMAssetThumbnail [[-Session] <ImmichSession>] [-Id] <String> [[-Path] <DirectoryInfo>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Downloads and saves thumbnail images for Immich assets to a local directory. Thumbnails are saved as JPEG files with the asset UUID as the filename.

EXAMPLES​

EXAMPLE 1​

Export-IMAssetThumbnail -Id 'asset-uuid' -Path 'C:\Thumbnails'

Exports the thumbnail for the specified asset to the C:\Thumbnails directory.

EXAMPLE 2​

Get-IMAsset -Random -Count 10 | Export-IMAssetThumbnail -Path 'C:\RandomThumbnails'

Exports thumbnails for 10 random assets using pipeline input.

EXAMPLE 3​

Get-IMAsset -TagId 'portrait-tag' | Export-IMAssetThumbnail -Path 'C:\Portraits\Thumbs'

Exports thumbnails for all assets tagged as portraits.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

The UUID of the asset to export the thumbnail for. Accepts pipeline input.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Path​

The local directory where the thumbnail file will be saved. The file will be named using the asset UUID with a .jpeg extension.

Type: DirectoryInfo
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github