共用方式為

New-PSScriptFileInfo

  • 參考
模組:
Microsoft.PowerShell.PSResourceGet

Cmdlet 會建立新的腳本檔案，包括腳本的相關中繼資料。

Syntax

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

Description

Cmdlet 會建立新的腳本檔案，其中包含發佈腳本套件所需的必要中繼資料。

範例

範例 1：使用最少資訊建立空白腳本

此範例只會使用必要的參數來執行 Cmdlet。 Path參數會指定腳本的nane 和位置。 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：建立具有必要模組的腳本

此範例會以其他參數執行 Cmdlet，包括 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

強制 Cmdlet 覆寫任何現有的檔案。

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

-Guid

GUID 格式之腳本的唯一識別碼。 如果您沒有提供 GUID，Cmdlet 會自動建立新的 GUID。

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

-IconUri

統一資源識別項 (URI) 指向與腳本相關聯的圖示。

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。
  • 另外，至少需要指定下列三個索引鍵的其中一個。
    • 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

腳本的版本。 如果未提供任何值 ，則 Version 預設為 1.0.0.0 。

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

輸入

None

輸出

Object

備註

New-PSScriptFileInfo和 Update-PSScriptFileInfo Cmdlet 會在說明檔的 <#PSScriptInfo 和批註型說明區塊之間，放置 #requires 必要模組的 語句。 #requires預期 Get-PSScriptFileInfo 語句放在批註型說明區塊之前的位置。 和 Publish-PSResource 會忽略 Get-PSScriptFileInfo 置於批註式說明區塊之後的任何 #requires 語句。