New-PSScriptFileInfo
コマンドレットは、スクリプトに関するメタデータを含む新しいスクリプト ファイルを作成します。
構文
New-PSScriptFileInfo
[-Path] <String>
[-Version <String>]
[-Author <String>]
-Description <String>
[-Guid <Guid>]
[-CompanyName <String>]
[-Copyright <String>]
[-RequiredModules <Hashtable[]>]
[-ExternalModuleDependencies <String[]>]
[-RequiredScripts <String[]>]
[-ExternalScriptDependencies <String[]>]
[-Tags <String[]>]
[-ProjectUri <String>]
[-LicenseUri <String>]
[-IconUri <String>]
[-ReleaseNotes <String>]
[-PrivateData <String>]
[-Force]
[<CommonParameters>]
説明
コマンドレットは、スクリプト パッケージを発行するために必要なメタデータを含む新しいスクリプト ファイルを作成します。
例
例 1: 最小限の情報で空のスクリプトを作成する
この例では、必要なパラメーターのみを使用して コマンドレットを実行します。 Path パラメーターは、スクリプトのナーンと場所を指定します。 Description パラメーターは、スクリプトのコメント ベースのヘルプで使用される説明を提供します。
New-PSScriptFileInfo -Path ./test_script.ps1 -Description 'This is a test script.'
Get-Content ./test_script.ps1
<#PSScriptInfo
.VERSION 1.0.0.0
.GUID 6ec3934e-a2e0-495b-9a9c-480e555ad1d1
.AUTHOR johndoe
.COMPANYNAME
.COPYRIGHT
.TAGS
.LICENSEURI
.PROJECTURI
.ICONURI
.EXTERNALMODULEDEPENDENCIES
.REQUIREDSCRIPTS
.EXTERNALSCRIPTDEPENDENCIES
.RELEASENOTES
.PRIVATEDATA
#>
<#
.DESCRIPTION
This is a test script.
#>
例 2: 必要なモジュールを使用してスクリプトを作成する
この例では、 RequiredModules を含む追加のパラメーターを指定して コマンドレットを実行します。 RequiredModules は、モジュール仕様の配列です。
$parameters = @{
Path = './test_script2.ps1'
Description = 'This is a test script.'
Version = '2.0.0.0'
Author = 'janedoe'
RequiredModules = @(
@{ModuleName = 'PackageManagement'; ModuleVersion = '1.0.0.0' },
@{ModuleName = 'PSReadLine'}
)
}
New-PSScriptFileInfo @parameters
Get-Content ./test_script2.ps1
<#PSScriptInfo
.VERSION 2.0.0.0
.GUID 7ec4832e-a4e1-562b-8a8c-241e535ad7d7
.AUTHOR janedoe
.COMPANYNAME
.COPYRIGHT
.TAGS
.LICENSEURI
.PROJECTURI
.ICONURI
.EXTERNALMODULEDEPENDENCIES
.REQUIREDSCRIPTS
.EXTERNALSCRIPTDEPENDENCIES
.RELEASENOTES
.PRIVATEDATA
#>
#Requires -Module PSReadLine
#Requires -Module @{ ModuleName = 'PackageManagement'; ModuleVersion = '1.0.0.0' }
<#
.DESCRIPTION
This is a test script.
#>
パラメーター
-Author
スクリプトの作成者の名前。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-CompanyName
スクリプトを所有している会社の名前。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Copyright
スクリプトの著作権情報。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Description
スクリプトの説明。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ExternalModuleDependencies
このスクリプトによって取得された外部モジュールの依存関係の一覧。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ExternalScriptDependencies
このスクリプトによって取得された外部スクリプトの依存関係の一覧。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Force
コマンドレットで既存のファイルを強制的に上書きします。
型: | SwitchParameter |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Guid
GUID 形式のスクリプトの一意識別子。 GUID を指定しない場合、コマンドレットは自動的に新しい GUID を作成します。
型: | Guid |
配置: | Named |
規定値: | Randomly generated |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-IconUri
スクリプトに関連付けられているアイコンを指す Uri (Uniform Resource Identifier) です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-LicenseUri
スクリプトに関連付けられている使用許諾契約書ファイルを指す URI。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Path
スクリプトが作成されるファイル名と場所。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PrivateData
スクリプトに関連付けられているプライベート データ。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ProjectUri
スクリプトに関連付けられているプロジェクト サイトを指す URI。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ReleaseNotes
スクリプトのリリース ノート。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RequiredModules
パラメーターは、モジュール仕様ハッシュテーブルの配列を受け取ります。 モジュール仕様は、次のキーを持つハッシュテーブルです。
-
ModuleName
- 必須 モジュール名を指定します。 -
GUID
- オプション モジュールの GUID を指定します。 - また、以下の 3 つのキーのうち少なくとも 1 つを指定する 必要 もあります。
-
ModuleVersion
- モジュールの最小許容バージョンを指定します。 -
MaximumVersion
- モジュールの許容される最大バージョンを指定します。 -
RequiredVersion
- モジュールの正確で必要なバージョンを指定します。 これは、他のバージョン キーでは使用できません。
-
型: | Hashtable[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RequiredScripts
スクリプトに必要なスクリプトの一覧。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Tags
スクリプトに関連付けられているタグ。 タグ値は、スペースを含むべきではない文字列です。 詳細については、「タグの 詳細」を参照してください。
型: | String[] |
Aliases: | Tag |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Version
スクリプトのバージョン。 値が指定されていない場合、 バージョン の既定値は になります 1.0.0.0
。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
None
出力
メモ
コマンドレットと Update-PSScriptFileInfo
コマンドレットはNew-PSScriptFileInfo
、ヘルプ ファイルの #requires
と コメントベースのヘルプ ブロックの間に<#PSScriptInfo
、必要なモジュールの ステートメントを配置します。
は Get-PSScriptFileInfo
、 #requires
ステートメントがコメントベースのヘルプ ブロックの前のどこかに配置されることを想定しています。
#requires
コメントベースのヘルプ ブロックの後に配置されたステートメントは、 および Publish-PSResource
によってGet-PSScriptFileInfo
無視されます。
関連リンク
PSResourceGet