Skip to main content

Get-IMAlbum

SYNOPSIS​

SYNTAX​

list (Default)​

Get-IMAlbum [-Session <ImmichSession>] [-AssetId <String>] [-IncludeAssets] [-Shared <Boolean>]
 [-Name <String>] [-SearchString <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

id​

Get-IMAlbum [-Session <ImmichSession>] -AlbumId <String> [-IncludeAssets] [-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
Aliases:

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

-IncludeAssets​

Defines weather to return assets as part of the object or not

Type: SwitchParameter
Parameter Sets: (All)
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
Aliases:

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

-Name​

Specify an exact name of an album

Type: String
Parameter Sets: list
Aliases:

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

-SearchString​

Specify a string to search for in album names, accepts wildcard

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​

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