Skip to main content

Restore-IMAsset

SYNOPSIS​

Restores Immich assets from trash

SYNTAX​

id (Default)​

Restore-IMAsset [-Session <ImmichSession>] -Id <String[]> [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

all​

Restore-IMAsset [-Session <ImmichSession>] [-All] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION​

Restores one or more assets from the Immich trash back to the active library. Assets in trash can be restored individually by ID or all trash items can be restored at once.

EXAMPLES​

EXAMPLE 1​

Restore-IMAsset -Id 'asset-uuid'

Restores a specific asset from trash with confirmation prompt.

EXAMPLE 2​

@('asset1-uuid', 'asset2-uuid') | Restore-IMAsset

Restores multiple specific assets from trash via pipeline.

EXAMPLE 3​

Restore-IMAsset -All

Restores all assets currently in trash.

EXAMPLE 4​

Restore-IMAsset -Id 'asset-uuid' -Confirm:$false

Restores an asset without confirmation prompt.

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: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

The UUID(s) of specific asset(s) to restore from trash. Accepts pipeline input and multiple values.

Type: String[]
Parameter Sets: id
Aliases: assetId

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

-All​

Restores all assets currently in trash back to the active library.

Type: SwitchParameter
Parameter Sets: all
Aliases:

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

-WhatIf​

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm​

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
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​

This cmdlet supports ShouldProcess and will prompt for confirmation before restoring assets. Use Get-IMTrash to view assets currently in trash before restoring.

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