New-PSScriptFileInfo

Modul:

Microsoft.PowerShell.PSResourceGet Module

Cmdlet membuat file skrip baru, termasuk metadata tentang skrip.

Sintaks

Default (Default)

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

Deskripsi

Cmdlet membuat file skrip baru yang berisi metadata yang diperlukan untuk menerbitkan paket skrip.

Contoh

Contoh 1: Membuat skrip kosong dengan informasi minimal

Contoh ini menjalankan cmdlet hanya menggunakan parameter yang diperlukan. Parameter Jalur menentukan nane dan lokasi skrip. Parameter Deskripsi memberikan deskripsi yang digunakan dalam bantuan berbasis komentar untuk skrip.

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.

#>

Contoh 2: Membuat skrip dengan modul yang diperlukan

Contoh ini menjalankan cmdlet dengan parameter tambahan, termasuk RequiredModules. RequiredModules adalah array spesifikasi modul.

$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.

#>

Parameter

-Author

Nama penulis skrip.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-CompanyName

Nama perusahaan pemilik skrip.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Copyright

Informasi hak cipta untuk skrip.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Description

Deskripsi skrip.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	True
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-ExternalModuleDependencies

Daftar dependensi modul eksternal yang diambil oleh skrip ini.

Properti parameter

Jenis:	String[]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-ExternalScriptDependencies

Daftar dependensi skrip eksternal yang diambil oleh skrip ini.

Properti parameter

Jenis:	String[]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Force

Memaksa cmdlet untuk menimpa file yang ada.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	False
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Guid

Pengidentifikasi unik untuk skrip dalam format GUID. Jika Anda tidak menyediakan GUID, cmdlet akan membuat yang baru secara otomatis.

Properti parameter

Jenis:	Guid
Nilai default:	Randomly generated
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-IconUri

Pengidentifikasi Sumber Daya Seragam (URI) menunjuk ke ikon yang terkait dengan skrip.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-LicenseUri

URI yang menunjuk ke file perjanjian lisensi yang terkait dengan skrip.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Path

Nama file dan lokasi tempat skrip dibuat.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	0
Wajib:	True
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-PrivateData

Data privat yang terkait dengan skrip.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-ProjectUri

URI yang menunjuk ke situs proyek yang terkait dengan skrip.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-ReleaseNotes

Catatan rilis untuk skrip.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-RequiredModules

Parameter mengambil array hashtable spesifikasi modul. Spesifikasi modul adalah hashtable yang memiliki kunci berikut.

• ModuleName - Diperlukan Menentukan nama modul.
• GUID - Opsional Menentukan GUID modul.
• Ini juga Diperlukan untuk menentukan setidaknya salah satu dari tiga kunci di bawah ini.
  • ModuleVersion - Menentukan versi minimum modul yang dapat diterima.
  • MaximumVersion - Menentukan versi maksimum modul yang dapat diterima.
  • RequiredVersion - Menentukan versi modul yang tepat dan diperlukan. Ini tidak dapat digunakan dengan kunci Versi lainnya.

Properti parameter

Jenis:	Hashtable[]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-RequiredScripts

Daftar skrip yang diperlukan oleh skrip.

Properti parameter

Jenis:	String[]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Tags

Tag yang terkait dengan skrip. Nilai tag adalah string yang seharusnya tidak berisi spasi. Untuk informasi selengkapnya, lihat detail tag .

Properti parameter

Jenis:	String[]
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False
Alias:	Etiket

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-Version

Versi skrip. Jika tidak ada nilai yang disediakan Versi default ke 1.0.0.0.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

None

Output

Object

Catatan

Cmdlet New-PSScriptFileInfo dan Update-PSScriptFileInfo menempatkan pernyataan #requires untuk modul yang diperlukan antara blok bantuan berbasis <#PSScriptInfo dan komentar dari file bantuan. Get-PSScriptFileInfo mengharapkan pernyataan #requires ditempatkan di suatu tempat sebelum blok bantuan berbasis komentar. Setiap pernyataan #requires yang ditempatkan setelah blok bantuan berbasis komentar diabaikan oleh Get-PSScriptFileInfo dan Publish-PSResource.

Link Terkait

• Get-PSScriptFileInfo
• Update-PSScriptFileInfo
• Test-PSScriptFileInfo
• Panduan Penerbitan dan Praktik Terbaik PowerShellGallery
• Nilai manifes paket yang berdampak pada UI Galeri PowerShell