New-PSScriptFileInfo

  • Başvuru
Modül:
Microsoft.PowerShell.PSResourceGet

cmdlet'i, betikle ilgili meta veriler de dahil olmak üzere yeni bir betik dosyası oluşturur.

Sözdizimi

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'i bir betik paketi yayımlamak için gereken meta verileri içeren yeni bir betik dosyası oluşturur.

Örnekler

Örnek 1: En az bilgi içeren boş bir betik oluşturma

Bu örnek cmdlet'i yalnızca gerekli parametreleri kullanarak çalıştırır. Path parametresi betiğin nane ve konumunu belirtir. Description parametresi, betik için açıklama tabanlı yardımda kullanılan açıklamayı sağlar.

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.

#>

Örnek 2: Gerekli modüllerle betik oluşturma

Bu örnek, cmdlet'ini RequiredModules dahil olmak üzere ek parametrelerle çalıştırır. RequiredModules , modül belirtimlerinden oluşan bir dizidir.

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

#>

Parametreler

-Author

Betiğin yazarının adı.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-CompanyName

Betiğin sahibi olan şirketin adı.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Copyright

Betiğin telif hakkı bilgileri.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Description

Betiğin açıklaması.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-ExternalModuleDependencies

Bu betik tarafından alınan dış modül bağımlılıklarının listesi.

Tür:String[]
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-ExternalScriptDependencies

Bu betik tarafından alınan dış betik bağımlılıklarının listesi.

Tür:String[]
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Force

cmdlet'ini varolan dosyaların üzerine yazmaya zorlar.

Tür:SwitchParameter
Position:Named
Default value:False
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Guid

Betiğin GUID biçimindeki benzersiz tanımlayıcısı. GUID sağlamazsanız, cmdlet otomatik olarak yeni bir guid oluşturur.

Tür:Guid
Position:Named
Default value:Randomly generated
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-IconUri

Betikle ilişkilendirilmiş simgeye işaret eden Tekdüzen Kaynak Tanımlayıcısı (URI).

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-LicenseUri

Betikle ilişkilendirilmiş lisans sözleşmesi dosyasına işaret eden URI.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Path

Betiğin oluşturulduğu dosya adı ve konum.

Tür:String
Position:0
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-PrivateData

Betikle ilişkili özel veriler.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-ProjectUri

Betikle ilişkilendirilmiş proje sitesine işaret eden URI.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-ReleaseNotes

Betiğin sürüm notları.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-RequiredModules

parametresi, modül belirtimi karma tablolarından oluşan bir dizi alır. Modül belirtimi, aşağıdaki anahtarlara sahip bir karma tablodur.

  • ModuleName - Gerekli Modül adını belirtir.
  • GUID - Isteğe bağlı Modülün GUID değerini belirtir.
  • Ayrıca aşağıdaki üç anahtardan en az birini belirtmek gerekir .
    • ModuleVersion - Modülün kabul edilebilir en düşük sürümünü belirtir.
    • MaximumVersion - Modülün kabul edilebilir en yüksek sürümünü belirtir.
    • RequiredVersion - Modülün tam, gerekli bir sürümünü belirtir. Bu, diğer Sürüm anahtarlarıyla kullanılamaz.
Tür:Hashtable[]
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-RequiredScripts

Betiğin gerektirdiği betiklerin listesi.

Tür:String[]
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Tags

Betikle ilişkilendirilmiş etiketler. Etiket değerleri boşluk içermemesi gereken dizelerdir. Daha fazla bilgi için bkz. Etiket ayrıntıları.

Tür:String[]
Diğer adlar:Tag
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Version

Betiğin sürümü. Değer sağlanmazsa Sürüm varsayılan olarak 1.0.0.0olur.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

Girişler

None

Çıkışlar

Object

Notlar

ve Update-PSScriptFileInfo cmdlet'leriNew-PSScriptFileInfo, gerekli modüllerin #requires deyimlerini yardım dosyasının <#PSScriptInfo ve açıklama tabanlı yardım blokları arasına yerleştirir. deyimlerinin Get-PSScriptFileInfo#requires açıklama tabanlı yardım bloğundan önce bir yere yerleştirilmesini bekler. Açıklama tabanlı yardım bloğundan sonra yerleştirilen tüm #requires deyimler ve Publish-PSResourcetarafından Get-PSScriptFileInfo yoksayılır.