New-Script File Info

Syntax

New-ScriptFileInfo
   [[-Path] <String>]
   [-Version <Version>]
   [-Author <String>]
   -Description <String>
   [-Guid <Guid>]
   [-CompanyName <String>]
   [-Copyright <String>]
   [-RequiredModules <Object[]>]
   [-ExternalModuleDependencies <String[]>]
   [-RequiredScripts <String[]>]
   [-ExternalScriptDependencies <String[]>]
   [-Tags <String[]>]
   [-ProjectUri <Uri>]
   [-LicenseUri <Uri>]
   [-IconUri <Uri>]
   [-ReleaseNotes <String[]>]
   [-PassThru]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-ScriptFileInfo cmdlet creates a PowerShell script file, including metadata about the script.

Examples

Example 1: Create a script file and specify its version, author, and description

PS C:\> New-ScriptFileInfo -Path "\temp\Temp-Scriptfile.ps1" -Version 1.0 -Author "pattif@contoso.com" -Description "My test script file description goes here"

PS C:\> Get-Content -Path "\temp\Temp-Scriptfile.ps1"

<#PSScriptInfo



.VERSION 1.0



.GUID eb246b19-17da-4392-8c89-7c280f69ad0e



.AUTHOR pattif@microsoft.com



.COMPANYNAME



.COPYRIGHT



.TAGS



.LICENSEURI



.PROJECTURI



.ICONURI



.EXTERNALMODULEDEPENDENCIES



.REQUIREDSCRIPTS



.EXTERNALSCRIPTDEPENDENCIES



.RELEASENOTES





#>



<#



.DESCRIPTION

 my test script file description goes here



#>

Param() PS C:\> Test-ScriptFileInfo -Path "\temp\Temp-Scriptfile.ps1"

Version    Name                      Author               Description

-------    ----                      ------               -----------

1.0        temp-scriptfile           pattif@contoso.com   my test script file description goes here

The first command creates the script file Temp-Scriptfile.ps1 and sets the Version, Author, and Description properties for it.

The second command uses the Get-Content cmdlet to get the contents of the script file and display them.

Example 2: Create a script file with all of the metadata properties

PS C:\> New-ScriptFileInfo -Path "C:\temp\temp_scripts\New-ScriptFile.ps1" -Verbose

>> -Version 1.0 -Author pattif -Description "my new script file test" -CompanyName "Contoso Corporation" `

>> -Copyright "© 2015 Contoso Corporation. All rights reserved." -ExternalModuleDependencies 'ff','bb' `

>> -RequiredScripts 'Start-WFContosoServer', 'Stop-ContosoServerScript' `

>> -ExternalScriptDependencies Stop-ContosoServerScript -Tags @('Tag1', 'Tag2', 'Tag3') `

>> -ProjectUri https://contoso.com -LicenseUri "https://contoso.com/License" -IconUri 'https://contoso.com/Icon' `

>> -Verbose -PassThru `

>> -ReleaseNotes @('contoso script now supports following features',

>>          'Feature 1',

>>          'Feature 2',

>>          'Feature 3',

>>          'Feature 4',

>>          'Feature 5') `

>> -RequiredModules "1","2",RequiredModule1,@{ModuleName='RequiredModule2';ModuleVersion='1.0'},@{ModuleName='RequiredModule3';RequiredVersion='2.0'},ExternalModule1 `

>>

VERBOSE: Performing the operation "Creating the 'C:\temp\temp_scripts\New-ScriptFile.ps1' PowerShell Script file" on target "C:\temp\temp_scripts\New-ScriptFile.ps1".



<#PSScriptInfo



.VERSION 1.0



.GUID eb246b19-17da-4392-8c89-7c280f69ad0a



.AUTHOR pattif



.COMPANYNAME Microsoft Corporation



.COPYRIGHT © 2015 Microsoft Corporation. All rights reserved.



.TAGS Tag1 Tag2 Tag3



.LICENSEURI https://contoso.com/License



.PROJECTURI https://contoso.com/



.ICONURI https://contoso.com/Icon



.EXTERNALMODULEDEPENDENCIES ff,bb



.REQUIREDSCRIPTS Start-WFContosoServer,Stop-ContosoServerScript



.EXTERNALSCRIPTDEPENDENCIES Stop-ContosoServerScript



.RELEASENOTES

contoso script now supports following features

Feature 1

Feature 2

Feature 3

Feature 4

Feature 5



#>



#Requires -Module Module1

#Requires -Module Module2

#Requires -Module RequiredModule1

#Requires -Module @{ModuleName = 'RequiredModule2'; ModuleVersion = '1.0'}

#Requires -Module @{RequiredVersion = '2.0'; ModuleName = 'RequiredModule3'}

#Requires -Module ExternalModule1



<#



.DESCRIPTION

 my new script file test



#>

Param()

This command creates creates a script file New-ScriptFile.ps1 with all of its metadata properties. The Verbose parameter specifies that the command display verbose output.

Required Parameters

Optional Parameters

Related Links

• Test-ScriptFileInfo
• Update-ScriptFileInfo