Update-ScriptFileInfo
Updates information for a script.
Syntax
PathParameterSet (Default)
Update-ScriptFileInfo
[-Path] <String>
[-Version <String>]
[-Author <String>]
[-Guid <Guid>]
[-Description <String>]
[-CompanyName <String>]
[-Copyright <String>]
[-RequiredModules <Object[]>]
[-ExternalModuleDependencies <String[]>]
[-RequiredScripts <String[]>]
[-ExternalScriptDependencies <String[]>]
[-Tags <String[]>]
[-ProjectUri <Uri>]
[-LicenseUri <Uri>]
[-IconUri <Uri>]
[-ReleaseNotes <String[]>]
[-PrivateData <String>]
[-PassThru]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LiteralPathParameterSet
Update-ScriptFileInfo
[-LiteralPath] <String>
[-Version <String>]
[-Author <String>]
[-Guid <Guid>]
[-Description <String>]
[-CompanyName <String>]
[-Copyright <String>]
[-RequiredModules <Object[]>]
[-ExternalModuleDependencies <String[]>]
[-RequiredScripts <String[]>]
[-ExternalScriptDependencies <String[]>]
[-Tags <String[]>]
[-ProjectUri <Uri>]
[-LicenseUri <Uri>]
[-IconUri <Uri>]
[-ReleaseNotes <String[]>]
[-PrivateData <String>]
[-PassThru]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Update-ScriptFileInfo cmdlet updates a script's property values. For example, the values for
version, author, or description.
This is a proxy cmdlet for the Update-PSScriptFileInfo cmdlet in the
Microsoft.PowerShell.PSResourceGet . For more information, see
Update-PSScriptFileInfo .
Examples
Example 1: Update the version of a script file
In this example, an existing script file is updated with new property values.
Splatting is used to pass parameters to the Update-ScriptFileInfo cmdlet. For more information,
see about_Splatting .
$Parms = @{
Path = "C:\Test\Temp-Scriptfile.ps1"
Version = "2.0"
Author = "bob@contoso.com"
CompanyName = "Contoso"
Description = "This is the updated description"
}
Update-ScriptFileInfo @Parms -PassThru
<#PSScriptInfo
.VERSION 2.0
.GUID 4609f00c-e850-4d3f-9c69-3741e56e4133
.AUTHOR bob@contoso.com
.COMPANYNAME Contoso
.COPYRIGHT
.TAGS
.LICENSEURI
.PROJECTURI
.ICONURI
.EXTERNALMODULEDEPENDENCIES
.REQUIREDSCRIPTS
.EXTERNALSCRIPTDEPENDENCIES
.RELEASENOTES
.PRIVATEDATA
#>
<#
.DESCRIPTION
This is the updated description
#>
Param()
$Parms stores the parameter values for Path , Version , Author , CompanyName , and
Description . Update-ScriptFileInfo gets the parameter values from @Parms and updates the
script. The PassThru parameter displays the script's contents in the PowerShell console.
Parameters
-Author
Specifies the script author.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CompanyName
Specifies the company or vendor who created the script.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
The proxy cmdlet ignores this parameter since it's not supported by Update-PSScriptFileInfo.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Copyright
Specifies a copyright statement for the script.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Description
Specifies a description for the script.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ExternalModuleDependencies
Specifies an array of external module dependencies.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ExternalScriptDependencies
Specifies an array of external script dependencies.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Force
The proxy cmdlet ignores this parameter since it's not supported by Update-PSScriptFileInfo.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Guid
Specifies a unique ID for a script.
Parameter properties
Type: Guid
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IconUri
Specifies the URL of an icon for the script. The specified icon is displayed on the gallery web page
for the script.
Parameter properties
Type: Uri
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-LicenseUri
Specifies the URL of licensing terms.
Parameter properties
Type: Uri
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-LiteralPath
Specifies a path to one or more locations. The LiteralPath parameter's value is used exactly as
it's entered. No characters are interpreted as wildcards. If the path includes escape characters,
enclose them in single quotation marks. Single quotation marks tell PowerShell not to interpret any
characters as escape sequences.
The proxy cmdlet maps this parameter to the Path parameter of Update-PSScriptFileInfo.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: PSPath
Parameter sets
LiteralPathParameterSet
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-PassThru
The proxy cmdlet ignores this parameter since it's not supported by Update-PSScriptFileInfo.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Path
Specifies the script file's location. Wildcards are permitted.
Parameter properties
Type: String
Default value: None Supports wildcards: True DontShow: False
Parameter sets
PathParameterSet
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-PrivateData
Specifies the private data for the script.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ProjectUri
Specifies the URL of a web page about this project.
Parameter properties
Type: Uri
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ReleaseNotes
Specifies a string array that contains release notes or comments that you want available for this
version of the script.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RequiredModules
Specifies modules that must be in the global session state. If the required modules aren't in the
global session state, PowerShell imports them.
Parameter properties
Type: Object [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RequiredScripts
Specifies an array of required scripts.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Specifies an array of tags.
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Version
Specifies the script's version.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
The proxy cmdlet ignores this parameter since it's not supported by Update-PSScriptFileInfo.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
Notes
Use the Test-ScriptFileInfo cmdlet to validate a script's metadata. Scripts must include values
for Version , GUID , Description , and Author .
