1"use strict";(self.webpackChunkgetps_dev=self.webpackChunkgetps_dev||[]).push([["4217"],{68552(e,n,s){s.r(n),s.d(n,{metadata:()=>l,default:()=>m,frontMatter:()=>r,contentTitle:()=>t,toc:()=>o,assets:()=>c});var l=JSON.parse('{"id":"PSImmich/Command Reference/New-IMAlbum","title":"New-IMAlbum","description":"Help page for the Powershell \\"New-IMAlbum\\" command","source":"@site/modules/PSImmich/03-Command Reference/New-IMAlbum.mdx","sourceDirName":"PSImmich/03-Command Reference","slug":"/PSImmich/Command Reference/New-IMAlbum","permalink":"/modules/PSImmich/Command Reference/New-IMAlbum","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"id":"New-IMAlbum","title":"New-IMAlbum","description":"Help page for the Powershell \\"New-IMAlbum\\" command","keywords":["Powershell","PSImmich","Help","Documentation"],"hide_title":false,"hide_table_of_contents":false},"sidebar":"defaultSidebar","previous":{"title":"New-IMAPIKey","permalink":"/modules/PSImmich/Command Reference/New-IMAPIKey"},"next":{"title":"New-IMLibrary","permalink":"/modules/PSImmich/Command Reference/New-IMLibrary"}}'),i=s(74848),a=s(28453);let r={id:"New-IMAlbum",title:"New-IMAlbum",description:'Help page for the Powershell "New-IMAlbum" command',keywords:["Powershell","PSImmich","Help","Documentation"],hide_title:!1,hide_table_of_contents:!1},t,c={},o=[{value:"SYNOPSIS",id:"synopsis",level:2},{value:"SYNTAX",id:"syntax",level:2},{value:"DESCRIPTION",id:"description",level:2},{value:"EXAMPLES",id:"examples",level:2},{value:"EXAMPLE 1",id:"example-1",level:3},{value:"EXAMPLE 2",id:"example-2",level:3},{value:"EXAMPLE 3",id:"example-3",level:3},{value:"EXAMPLE 4",id:"example-4",level:3},{value:"PARAMETERS",id:"parameters",level:2},{value:"-Session",id:"-session",level:3},{value:"-AlbumName",id:"-albumname",level:3},{value:"-AssetIds",id:"-assetids",level:3},{value:"-Description",id:"-description",level:3},{value:"-AlbumUsers",id:"-albumusers",level:3},{value:"-ProgressAction",id:"-progressaction",level:3},{value:"CommonParameters",id:"commonparameters",level:3},{value:"INPUTS",id:"inputs",level:2},{value:"OUTPUTS",id:"outputs",level:2},{value:"NOTES",id:"notes",level:2},{value:"RELATED LINKS",id:"related-links",level:2},{value:"EDIT THIS DOC",id:"edit-this-doc",level:2}];function d(e){let n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"synopsis",children:"SYNOPSIS"}),"\n",(0,i.jsx)(n.p,{children:"Creates a new Immich album"}),"\n",(0,i.jsx)(n.h2,{id:"syntax",children:"SYNTAX"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-powershell",children:"New-IMAlbum [[-Session] <ImmichSession>] [-AlbumName] <String> [[-AssetIds] <String[]>]\n [[-Description] <String>] [[-AlbumUsers] <Hashtable[]>] [-ProgressAction <ActionPreference>]\n [<CommonParameters>]\n"})}),"\n",(0,i.jsx)(n.h2,{id:"description",children:"DESCRIPTION"}),"\n",(0,i.jsx)(n.p,{children:"Creates a new album in Immich with the specified name and optional properties.\nAlbums can be created with\ninitial assets, descriptions, and shared with other users."}),"\n",(0,i.jsx)(n.h2,{id:"examples",children:"EXAMPLES"}),"\n",(0,i.jsx)(n.h3,{id:"example-1",children:"EXAMPLE 1"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-powershell",children:"New-IMAlbum -AlbumName 'Family Vacation 2024'\n"})}),"\n",(0,i.jsx)(n.p,{children:"Creates a new album named 'Family Vacation 2024'."}),"\n",(0,i.jsx)(n.h3,{id:"example-2",children:"EXAMPLE 2"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-powershell",children:"New-IMAlbum -AlbumName 'Wedding Photos' -Description 'Photos from Sarah and John wedding ceremony'\n"})}),"\n",(0,i.jsx)(n.p,{children:"Creates a new album with a description."}),"\n",(0,i.jsx)(n.h3,{id:"example-3",children:"EXAMPLE 3"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-powershell",children:"$assets = @('asset1-uuid', 'asset2-uuid')\nNew-IMAlbum -AlbumName 'Best of 2024' -AssetIds $assets\n"})}),"\n",(0,i.jsx)(n.p,{children:"Creates a new album and adds specific assets to it."}),"\n",(0,i.jsx)(n.h3,{id:"example-4",children:"EXAMPLE 4"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-powershell",children:"$users = @(@{userId='user1-uuid'; role='editor'}, @{userId='user2-uuid'; role='viewer'})\nNew-IMAlbum -AlbumName 'Shared Memories' -AlbumUsers $users\n"})}),"\n",(0,i.jsx)(n.p,{children:"Creates a new album shared with multiple users with different roles."}),"\n",(0,i.jsx)(n.h2,{id:"parameters",children:"PARAMETERS"}),"\n",(0,i.jsx)(n.h3,{id:"-session",children:"-Session"}),"\n",(0,i.jsx)(n.p,{children:"Optionally define an Immich session object to use.\nThis is useful when you are connected to more than one Immich instance."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-yaml",children:"Type: ImmichSession\nParameter Sets: (All)\nAliases:\n\nRequired: False\nPosition: 1\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n"})}),"\n",(0,i.jsx)(n.h3,{id:"-albumname",children:"-AlbumName"}),"\n",(0,i.jsx)(n.p,{children:"The name for the new album.\nThis will be displayed in the Immich interface."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-yaml",children:"Type: String\nParameter Sets: (All)\nAliases:\n\nRequired: True\
1nPosition: 2\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n"})}),"\n",(0,i.jsx)(n.h3,{id:"-assetids",children:"-AssetIds"}),"\n",(0,i.jsx)(n.p,{children:"An array of asset UUIDs to add to the album during creation."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-yaml",children:"Type: String[]\nParameter Sets: (All)\nAliases:\n\nRequired: False\nPosition: 3\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n"})}),"\n",(0,i.jsx)(n.h3,{id:"-description",children:"-Description"}),"\n",(0,i.jsx)(n.p,{children:"A description for the album to provide additional context about its contents."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-yaml",children:"Type: String\nParameter Sets: (All)\nAliases:\n\nRequired: False\nPosition: 4\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n"})}),"\n",(0,i.jsx)(n.h3,{id:"-albumusers",children:"-AlbumUsers"}),"\n",(0,i.jsx)(n.p,{children:"An array of user objects to share the album with.\nEach object should contain 'userId' and 'role' properties."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-yaml",children:"Type: Hashtable[]\nParameter Sets: (All)\nAliases:\n\nRequired: False\nPosition: 5\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n"})}),"\n",(0,i.jsx)(n.h3,{id:"-progressaction",children:"-ProgressAction"}),"\n",(0,i.jsx)(n.p,{children:"{{ Fill ProgressAction Description }}"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-yaml",children:"Type: ActionPreference\nParameter Sets: (All)\nAliases: proga\n\nRequired: False\nPosition: Named\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n"})}),"\n",(0,i.jsx)(n.h3,{id:"commonparameters",children:"CommonParameters"}),"\n",(0,i.jsxs)(n.p,{children:["This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see ",(0,i.jsx)(n.a,{href:"http://go.microsoft.com/fwlink/?LinkID=113216",children:"about_CommonParameters"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"inputs",children:"INPUTS"}),"\n",(0,i.jsx)(n.h2,{id:"outputs",children:"OUTPUTS"}),"\n",(0,i.jsx)(n.h2,{id:"notes",children:"NOTES"}),"\n",(0,i.jsx)(n.h2,{id:"related-links",children:"RELATED LINKS"}),"\n",(0,i.jsx)(n.h2,{id:"edit-this-doc",children:"EDIT THIS DOC"}),"\n",(0,i.jsxs)(n.p,{children:["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 ",(0,i.jsx)(n.a,{href:"https://github.com/hanpq/PSImmich",children:"Github"})]})]})}function m(e={}){let{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},28453(e,n,s){s.d(n,{R:()=>r,x:()=>t});var l=s(96540);let i={},a=l.createContext(i);function r(e){let n=l.useContext(a);return l.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),l.createElement(a.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.