Skip to main content

New-IMAlbum

SYNOPSIS​

Creates a new Immich album

SYNTAX​

New-IMAlbum [[-Session] <ImmichSession>] [-AlbumName] <String> [[-AssetIds] <String[]>]
 [[-Description] <String>] [[-AlbumUsers] <Hashtable[]>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION​

Creates a new album in Immich with the specified name and optional properties. Albums can be created with initial assets, descriptions, and shared with other users.

EXAMPLES​

EXAMPLE 1​

New-IMAlbum -AlbumName 'Family Vacation 2024'

Creates a new album named 'Family Vacation 2024'.

EXAMPLE 2​

New-IMAlbum -AlbumName 'Wedding Photos' -Description 'Photos from Sarah and John wedding ceremony'

Creates a new album with a description.

EXAMPLE 3​

$assets = @('asset1-uuid', 'asset2-uuid')
New-IMAlbum -AlbumName 'Best of 2024' -AssetIds $assets

Creates a new album and adds specific assets to it.

EXAMPLE 4​

$users = @(@{userId='user1-uuid'; role='editor'}, @{userId='user2-uuid'; role='viewer'})
New-IMAlbum -AlbumName 'Shared Memories' -AlbumUsers $users

Creates a new album shared with multiple users with different roles.

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

-AlbumName​

The name for the new album. This will be displayed in the Immich interface.

Type: String
Parameter Sets: (All)
Aliases:

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

-AssetIds​

An array of asset UUIDs to add to the album during creation.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Description​

A description for the album to provide additional context about its contents.

Type: String
Parameter Sets: (All)
Aliases:

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

-AlbumUsers​

An array of user objects to share the album with. Each object should contain 'userId' and 'role' properties.

Type: Hashtable[]
Parameter Sets: (All)
Aliases:

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