Get-IMAlbum
SYNOPSIS
SYNTAX
list-shared (Default)
Get-IMAlbum [-Session <ImmichSession>] [-shared <Boolean>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
id
Get-IMAlbum [-Session <ImmichSession>] -albumId <String> [-withoutAssets] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
list-asset
Get-IMAlbum [-Session <ImmichSession>] -assetId <String> [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Retreives Immich asset
EXAMPLES
EXAMPLE 1
Retreives Immich album
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
-albumId
Defines the album to get
Type: String
Parameter Sets: id
Aliases: id
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-assetId
Only returns albums that contain the asset
Type: String
Parameter Sets: list-asset
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-withoutAssets
Defines weather to return assets as part of the object or not
Type: SwitchParameter
Parameter Sets: id
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-shared
Defines weather to return shared albums or not.
Type: Boolean
Parameter Sets: list-shared
Aliases:
Required: False
Position: Named
Default value: False
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