次の方法で共有

New-PSScriptFileInfo

  • リファレンス
モジュール:
Microsoft.PowerShell.PSResourceGet

コマンドレットは、スクリプトに関するメタデータを含む新しいスクリプト ファイルを作成します。

構文

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

スクリプトの作成者の名前。

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

-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:True
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

コマンドレットで既存のファイルを強制的に上書きします。

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

-Guid

GUID 形式のスクリプトの一意識別子。 GUID を指定しない場合、コマンドレットは自動的に新しい GUID を作成します。

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

-IconUri

スクリプトに関連付けられているアイコンを指す Uri (Uniform Resource Identifier) です。

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

-LicenseUri

スクリプトに関連付けられている使用許諾契約書ファイルを指す URI。

Type:String
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:False
Accept wildcard characters:False

-PrivateData

スクリプトに関連付けられているプライベート データ。

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

-ProjectUri

スクリプトに関連付けられているプロジェクト サイトを指す URI。

Type:String
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

パラメーターは、モジュール仕様ハッシュテーブルの配列を受け取ります。 モジュール仕様は、次のキーを持つハッシュテーブルです。

  • ModuleName - 必須 モジュール名を指定します。
  • GUID - オプション モジュールの GUID を指定します。
  • また、以下の 3 つのキーのうち少なくとも 1 つを指定する 必要 もあります。
    • ModuleVersion - モジュールの最小許容バージョンを指定します。
    • MaximumVersion - モジュールの許容される最大バージョンを指定します。
    • RequiredVersion - モジュールの正確で必要なバージョンを指定します。 これは、他のバージョン キーでは使用できません。
Type:Hashtable[]
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[]
Aliases:Tag
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Version

スクリプトのバージョン。 値が指定されていない場合、 バージョン の既定値は になります 1.0.0.0。

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

入力

None

出力

Object

メモ

コマンドレットと Update-PSScriptFileInfo コマンドレットはNew-PSScriptFileInfo、ヘルプ ファイルの #requires と コメントベースのヘルプ ブロックの間に<#PSScriptInfo、必要なモジュールの ステートメントを配置します。 は Get-PSScriptFileInfo 、 #requires ステートメントがコメントベースのヘルプ ブロックの前のどこかに配置されることを想定しています。 #requiresコメントベースのヘルプ ブロックの後に配置されたステートメントは、 および Publish-PSResourceによってGet-PSScriptFileInfo無視されます。