Windows PowerShell command on Get-command Update-ScriptFileInfo

NAME

Update-ScriptFileInfo

SYNOPSIS

Updates information for a script.

SYNTAX

Update-ScriptFileInfo [-LiteralPath] [-Author ] [-CompanyName ] [-Confirm] [-Copyright

] [-Description ] [-ExternalModuleDependencies ] [-ExternalScriptDependencies

] [-Force] [-Guid ] [-IconUri ] [-LicenseUri ] [-PassThru] [-ProjectUri ]

[-ReleaseNotes ] [-RequiredModules ] [-RequiredScripts ] [-Tags ]

[-Version ] [-WhatIf] []

Update-ScriptFileInfo [-Path] [-Author ] [-CompanyName ] [-Confirm] [-Copyright ]

[-Description ] [-ExternalModuleDependencies ] [-ExternalScriptDependencies ] [-Force]

[-Guid ] [-IconUri ] [-LicenseUri ] [-PassThru] [-ProjectUri ] [-ReleaseNotes ]

[-RequiredModules ] [-RequiredScripts ] [-Tags ] [-Version ] [-WhatIf]

[]

DESCRIPTION

The Update-ScriptFileInfo cmdlet updates information for a script.

PARAMETERS

-Author

Specifies the script author. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-CompanyName

Specifies the company or vendor who created the script. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-Confirm []

Prompts you for confirmation before running the cmdlet. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-Copyright

Specifies a copyright statement for the script. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-Description

Specifies a description for the script. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-ExternalModuleDependencies

Specifies an array of external module dependencies. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-ExternalScriptDependencies

Specifies an array of external script dependencies. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-Force []

Forces the command to run without asking for user confirmation. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-Guid

Specifies a unique ID for a script. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-IconUri

Specifies the URL of an icon for the script. The specified icon is displayed on the gallery web page for the script. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-LicenseUri

Specifies the URL of licensing terms. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-LiteralPath

Specifies a path to one or more locations. Unlike the Path parameter, the value of the LiteralPath parameter is used exactly as it is entered. No characters are interpreted as wildcards. If the path includes escape characters, enclose them in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences. Required? true Position? 0 Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-PassThru []

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-Path

Specifies a path to one or more locations. Wildcards are permitted. The default location is the current directory (.). Required? true Position? 0 Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-ProjectUri

Specifies the URL of a web page about this project. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-ReleaseNotes

Specifies a string array that contains release notes or comments that you want to be available to users for this version of the script. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-RequiredModules

Specifies modules that must be in the global session state. If the required modules are not in the global session state, Windows PowerShell imports them. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-RequiredScripts

Specifies an array of required scripts. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-Tags

Specifies an array of tags. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-Version

Specifies the version of the script. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-WhatIf []

Shows what would happen if the cmdlet runs. The cmdlet is not run. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

Example 1: Update the version of a script file

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:\> Test-ScriptFileInfo -Path "\temp\temp-scriptfile.ps1"

Version Name Author Description

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

1.0 temp-scriptfile manikb@microsoft.com my test script file description goes here PS

C:\>Update-ScriptFileInfo -Path "\temp\temp-scriptfile.ps1" -Version 2.0 -PassThru

<#PSScriptInfo .VERSION 2.0

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

.AUTHOR manikb@microsoft.com

.COMPANYNAME

.COPYRIGHT .TAGS .LICENSEURI .PROJECTURI .ICONURI .EXTERNALMODULEDEPENDENCIES .REQUIREDSCRIPTS .EXTERNALSCRIPTDEPENDENCIES

.RELEASENOTES

#> <#

.DESCRIPTION

my test script file description goes here #> Param() The first command creates a script file and assigns it version 1.0.

The second command uses the Test-ScriptFileInfo cmdlet to validate temp-scriptfile.ps1 and display the results.