New-ScriptFromTemplate
SYNOPSIS
Create a new advanced function from a template.
SYNTAX
Named
New-ScriptFromTemplate [-Name] <String> [-Synopsis <String>] [-Description <String>] [-Alias <String>]
[-Author <String>] [-Path <String>] [-SkipValidation]
[<CommonParameters>]
VerbNoun
New-ScriptFromTemplate [-Verb] <String> [-Noun] <String> [-Synopsis <String>] [-Description <String>]
[-Alias <String>] [-Author <String>] [-Path <String>] [-SkipValidation]
[<CommonParameters>]
DESCRIPTION
This function creates a new function from a template and saves it to a file with the name of the function. It takes values for the function's synopsis, description, and alias as parameters and populates comment- based help for the new function automatically.
EXAMPLES
EXAMPLE 1
New-ScriptFromTemplate -Name 'Get-Demo' -Synopsis 'Get a demo.' -Description 'This function gets a demo.' -Alias 'Get-Sample' -Parameter 'SerialNumber'
EXAMPLE 2
New-ScriptFromTemplate -Verb Get -Noun Something -Author 'Sam Erde' -Parameter @('Name','Age')
PARAMETERS
-Name
The name of the new function to create. It is recommended to use ApprovedVerb-Noun for names.
Type: String
Parameter Sets: Named
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Verb
The verb to use for the function name.
Type: String
Parameter Sets: VerbNoun
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Noun
The noun to use for the function name.
Type: String
Parameter Sets: VerbNoun
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Synopsis
A synopsis of the new function.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
A description of the new function.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Alias
Optionally define an alias for the new function.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Author
Name of the author of the script. Attempts to default to the 'FullName' property of the currently logged in user.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (Get-CimInstance -ClassName Win32_UserAccount -Filter "Name = `'$([System.Security.Principal.WindowsIdentity]::GetCurrent().Name.Split('\')[1])`'").FullName
Accept pipeline input: False
Accept wildcard characters: False
-Path
The path of the directory to save the new script in.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SkipValidation
Optionally skip validation of the script name. This will not check for use of approved verbs or restricted characters.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).