Get-IMAsset

SYNOPSIS

SYNTAX

list (Default)

Get-IMAsset [-Session <ImmichSession>] [-isFavorite <Boolean>] [-isArchived <Boolean>] [-skip <Int32>]
 [-take <Int32>] [-updatedAfter <DateTime>] [-updatedBefore <DateTime>] [-userId <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

random

Get-IMAsset [-Session <ImmichSession>] [-Random] [-Count <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

deviceid

Get-IMAsset [-Session <ImmichSession>] -deviceID <String> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

personid

Get-IMAsset [-Session <ImmichSession>] -personId <String> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

tagid

Get-IMAsset [-Session <ImmichSession>] -tagId <String> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

id

Get-IMAsset [-Session <ImmichSession>] -id <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Retreives Immich asset

EXAMPLES

EXAMPLE 1

Get-IMAsset -isFavorite:$true

Retreives all favorites

PARAMETERS

-Session

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

-Session $Session

Type: ImmichSession
Parameter Sets: (All)
Aliases:

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

-Random

Defines that random assets should be retreived. Unless -count is also specified one random asset is returned.

Type: SwitchParameter
Parameter Sets: random
Aliases:

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

-Count

Defines how many random assets should be returned. Required -Random

Type: Int32
Parameter Sets: random
Aliases:

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

-deviceID

Defines a device id

Type: String
Parameter Sets: deviceid
Aliases:

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

-personId

Defines a personId to retreive assets for

Type: String
Parameter Sets: personid
Aliases:

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

-tagId

Defines a tagid to retreive assets for

Type: String
Parameter Sets: tagid
Aliases:

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

-id

Defines a specific asset id to be retreived

Type: String
Parameter Sets: id
Aliases:

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

-isFavorite

Defines if faviorites should be returned or not. Do not specify if either should be returned.

Type: Boolean
Parameter Sets: list
Aliases:

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

-isArchived

Defines if archvied assets should be returned or not. Do not specify if either should be returned.

Type: Boolean
Parameter Sets: list
Aliases:

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

-skip

Defines skip

Type: Int32
Parameter Sets: list
Aliases:

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

-take

Defines take

Type: Int32
Parameter Sets: list
Aliases:

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

-updatedAfter

Deinfes updatedAfter

Type: DateTime
Parameter Sets: list
Aliases:

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

-updatedBefore

Defines updatedBefore

Type: DateTime
Parameter Sets: list
Aliases:

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

-userId

Defines userId

Type: String
Parameter Sets: list
Aliases:

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

RELATED LINKS

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