Update-ScriptFileInfo

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>]

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>]

Update-ScriptFileInfo コマンドレットは、スクリプトのプロパティ値を更新します。 たとえば、バージョン、作成者、または説明の値です。

この例では、既存のスクリプト ファイルが新しいプロパティ値で更新されます。

splatting は、パラメーターを Update-ScriptFileInfo コマンドレットに渡すために使用されます。 詳細については、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 には、 Path、 Version、 Author、 CompanyName、Description のパラメーター値が格納 されます。 Update-ScriptFileInfo は、 @Parms からパラメーター値を取得し、スクリプトを更新します。 PassThru パラメーターは、PowerShell コンソールにスクリプトの内容を表示します。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

スクリプトのメタデータを検証するには、 Test-ScriptFileInfo コマンドレットを使用します。 スクリプトには、バージョン、GUID、説明、作成者の値を含める必要があります。