次の方法で共有

Update-ScriptFileInfo

  • リファレンス
モジュール:
PowerShellGet

スクリプトの情報を更新します。

構文

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

パラメーター

-Author

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

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-CompanyName

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

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Confirm

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

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Copyright

スクリプトの著作権に関する声明を指定します。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Description

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

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ExternalModuleDependencies

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

型:String[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ExternalScriptDependencies

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

型:String[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Force

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

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Guid

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

型:Guid
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-IconUri

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

型:Uri
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-LicenseUri

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

型:Uri
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-LiteralPath

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

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

型:String
Aliases:PSPath
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-PassThru

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

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Path

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

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:True

-PrivateData

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

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ProjectUri

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

型:Uri
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ReleaseNotes

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

型:String[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-RequiredModules

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

型:Object[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-RequiredScripts

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

型:String[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Tags

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

型:String[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Version

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

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

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

型:SwitchParameter
Aliases:wi
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

String

出力

Object

メモ

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