次の方法で共有


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 、スクリプトのプロパティ値を更新します。 たとえば、バージョン、作成者、または説明の値です。

これは、Microsoft.PowerShell.PSResourceGet の コマンドレットのプロキシ コマンドレットUpdate-PSScriptFileInfoです。 詳細については、「 Update-PSScriptFileInfo」を参照してください。

例 1: スクリプト ファイルのバージョンを更新する

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

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 には、 PathVersionAuthorCompanyName、Description のパラメーター値が格納 されますUpdate-ScriptFileInfo は から @Parms パラメーター値を取得し、スクリプトを更新します。 PassThru パラメーターは、PowerShell コンソールにスクリプトの内容を表示します。

パラメーター

-Author

スクリプト作成者を指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CompanyName

スクリプトを作成した会社またはベンダーを指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Update-PSScriptFileInfo

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

スクリプトの copyright ステートメントを指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

スクリプトの説明を指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExternalModuleDependencies

外部モジュールの依存関係の配列を指定します。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExternalScriptDependencies

外部スクリプトの依存関係の配列を指定します。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Update-PSScriptFileInfo

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Guid

スクリプトの一意の ID を指定します。

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IconUri

スクリプトのアイコンの URL を指定します。 指定したアイコンが、スクリプトのギャラリー Web ページに表示されます。

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LicenseUri

ライセンス条項の URL を指定します。

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LiteralPath

1 つ以上の場所へのパスを指定します。 LiteralPath パラメーターの値は、入力されたとおりに使用されます。 ワイルドカードとして解釈される文字はありません。 パスにエスケープ文字が含まれている場合は、それらを単一引用符で囲みます。 一重引用符は、文字をエスケープ シーケンスとして解釈しないように PowerShell に指示します。

プロキシ コマンドレットは、このパラメーターを の Path パラメーターにマップします Update-PSScriptFileInfo

Type:String
Aliases:PSPath
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Update-PSScriptFileInfo

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

スクリプト ファイルの場所を指定します。 ワイルドカードを使用できます。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-PrivateData

スクリプトのプライベート データを指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProjectUri

このプロジェクトに関する Web ページの URL を指定します。

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReleaseNotes

このバージョンのスクリプトで使用できるリリース ノートまたはコメントを含む文字列配列を指定します。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RequiredModules

グローバル セッション状態にする必要があるモジュールを指定します。 必要なモジュールがグローバル セッション状態でない場合、PowerShell によってインポートされます。

Type:Object[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RequiredScripts

必要なスクリプトの配列を指定します。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tags

タグの配列を指定します。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Version

スクリプトのバージョンを指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Update-PSScriptFileInfo

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

String

出力

Object

メモ

コマンドレットを Test-ScriptFileInfo 使用して、スクリプトのメタデータを検証します。 スクリプトには、 VersionGUIDDescriptionAuthor の値を含める必要があります。