File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 2121. COMPONENT
2222Notes
2323
24- . PARAMETER Name
24+ . PARAMETER Note
2525Returns notes that match the specified name. Wildcards are supported.
2626
2727. PARAMETER Tag
Original file line number Diff line number Diff line change @@ -19,17 +19,6 @@ Maintenance
1919. COMPONENT
2020Store
2121
22- . PARAMETER Path
23- Specifies the root path where the PSNotes store should be created or validated.
24-
25- If not specified, the default PSNotes store path is used.
26-
27- . PARAMETER Force
28- Recreates missing files and folders and can overwrite base configuration artifacts where supported.
29-
30- . PARAMETER PassThru
31- Returns the initialized store configuration object.
32-
3322. EXAMPLE
3423PS> Initialize-PSNoteStore
3524
Original file line number Diff line number Diff line change @@ -21,16 +21,10 @@ Public
2121. COMPONENT
2222Notes
2323
24- . PARAMETER Name
25- The name of the note to move. Wildcards may be supported depending on the implementation.
26-
27- . PARAMETER Alias
28- The alias of the note to move.
29-
3024. PARAMETER InputObject
3125One or more PSNote objects to move. Accepts pipeline input from Get-PSNote.
3226
33- . PARAMETER Catalog
27+ . PARAMETER DestinationCatalog
3428The destination catalog to move the note(s) into.
3529
3630. PARAMETER Force
@@ -39,23 +33,19 @@ Suppresses confirmation prompts when moving notes.
3933. PARAMETER PassThru
4034Returns the moved PSNote objects.
4135
42- . EXAMPLE
43- PS> Move-PSNote -Name 'Get-VMInfo' -Catalog 'Azure'
44-
45- Moves the note named 'Get-VMInfo' to the Azure catalog.
4636
4737. EXAMPLE
48- PS> Get-PSNote -Catalog 'General' | Move-PSNote -Catalog 'Archive'
38+ PS> Get-PSNote -Catalog 'General' | Move-PSNote -DestinationCatalog 'Archive'
4939
5040Moves all notes from the General catalog to the Archive catalog.
5141
5242. EXAMPLE
53- PS> Move-PSNote -Alias 'azvm' -Catalog 'Azure' -WhatIf
43+ PS> Move-PSNote -Alias 'azvm' -DestinationCatalog 'Azure' -WhatIf
5444
5545Shows what would happen if the note were moved, without performing the action.
5646
5747. EXAMPLE
58- PS> Get-PSNote -Tag 'Legacy' | Move-PSNote -Catalog 'Archive' -Force -PassThru
48+ PS> Get-PSNote -Tag 'Legacy' | Move-PSNote -DestinationCatalog 'Archive' -Force -PassThru
5949
6050Moves all notes tagged 'Legacy' into the Archive catalog without prompting and returns the updated notes.
6151
Original file line number Diff line number Diff line change 2323. COMPONENT
2424Notes
2525
26- . PARAMETER Name
26+ . PARAMETER Note
2727The name of the note.
2828
2929. PARAMETER Catalog
@@ -41,11 +41,17 @@ The PowerShell snippet content to store in the note.
4141. PARAMETER ScriptPath
4242A script path to store in the note for later execution.
4343
44+ . PARAMETER ScriptBlock
45+ A PowerShell script block containing the code to store in the note.
46+
47+ . PARAMETER Details
48+ Additional details or description about the note.
49+
4450. PARAMETER Force
4551Overwrites an existing note with the same name (or alias conflict) where supported.
4652
47- . PARAMETER PassThru
48- Returns the created PSNote object .
53+ . PARAMETER Run
54+ When specified, executes the snippet content of the note immediately after creation .
4955
5056. EXAMPLE
5157PS> New-PSNote -Name 'List-AzVMs' -Catalog 'Azure' -Alias 'azvms' -Tag 'VM','Azure' -Snippet 'Get-AzVM'
Original file line number Diff line number Diff line change @@ -20,29 +20,26 @@ Public
2020. COMPONENT
2121Notes
2222
23- . PARAMETER Name
23+ . PARAMETER Note
2424The name of the note to remove. Wildcards may be supported depending on implementation.
2525
26- . PARAMETER Alias
27- The alias of the note to remove.
28-
2926. PARAMETER Catalog
3027Removes notes from the specified catalog.
3128
3229. PARAMETER Tag
3330Removes notes that contain one or more specified tags.
3431
32+ . PARAMETER SearchString
33+ Performs a broader search across note properties such as name, alias, and tags to identify notes for removal.
34+
3535. PARAMETER InputObject
3636One or more PSNote objects to remove. Accepts pipeline input from Get-PSNote.
3737
3838. PARAMETER Force
3939Suppresses confirmation prompts.
4040
41- . PARAMETER PassThru
42- Returns the removed PSNote objects.
43-
4441. EXAMPLE
45- PS> Remove-PSNote -Name 'OldNote'
42+ PS> Remove-PSNote -Note 'OldNote'
4643
4744Removes the note named 'OldNote'.
4845
You can’t perform that action at this time.
0 commit comments