Megosztás a következőn keresztül:

New-PSScriptFileInfo

  • Referencia
Modul:
Microsoft.PowerShell.PSResourceGet

A parancsmag létrehoz egy új szkriptfájlt, beleértve a szkript metaadatait is.

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

A parancsmag létrehoz egy új szkriptfájlt, amely tartalmazza a szkriptcsomag közzétételéhez szükséges metaadatokat.

Példák

1. példa: Üres szkript létrehozása minimális információval

Ez a példa csak a szükséges paraméterekkel futtatja a parancsmagot. A Path paraméter a szkript nane-ját és helyét határozza meg. A Description paraméter a szkript megjegyzésalapú súgójában használt leírást adja meg.

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. példa: Szkript létrehozása kötelező modulokkal

Ez a példa további paraméterekkel futtatja a parancsmagot, beleértve a RequiredModules modulokat is. A RequiredModules a modul specifikációinak tömbje.

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

#>

Paraméterek

-Author

A szkript szerzőjének neve.

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

-CompanyName

A szkriptet tulajdonos vállalat neve.

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

-Copyright

A szkript szerzői jogi információi.

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

-Description

A szkript leírása.

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

-ExternalModuleDependencies

A szkript által használt külső modulfüggőségek listája.

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

-ExternalScriptDependencies

A szkript által használt külső szkriptfüggőségek listája.

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

-Force

Kényszeríti a parancsmagot, hogy felülírja a meglévő fájlokat.

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

-Guid

A szkript egyedi azonosítója GUID formátumban. Ha nem ad meg GUID azonosítót, a parancsmag automatikusan létrehoz egy újat.

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

-IconUri

A szkripthez társított ikonra mutató egységes erőforrás-azonosító (URI).

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

-LicenseUri

A szkripthez társított licencszerződés-fájlra mutató URI.

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

-Path

A fájlnév és a hely, ahol a szkript létrejön.

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

-PrivateData

A szkripthez társított privát adatok.

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

-ProjectUri

A szkripthez társított projektwebhelyre mutató URI.

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

-ReleaseNotes

A szkript kibocsátási megjegyzései.

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

-RequiredModules

A paraméter modulspecifikációs kivonattáblák tömbjére épül. A modulspecifikáció olyan kivonattábla, amely az alábbi kulcsokkal rendelkezik.

  • ModuleName - Szükséges Megadja a modul nevét.
  • GUID - Választható A modul GUID azonosítóját adja meg.
  • Az alábbi három kulcs közül legalább egyet meg kell adnia.
    • ModuleVersion – A modul minimálisan elfogadható verzióját adja meg.
    • MaximumVersion – A modul maximálisan elfogadható verzióját adja meg.
    • RequiredVersion – A modul pontos, kötelező verzióját adja meg. Ez nem használható a többi verziókulcshoz.
Type:Hashtable[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RequiredScripts

A szkript által igényelt szkriptek listája.

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

-Tags

A szkripthez társított címkék. A címkeértékek olyan sztringek, amelyeknek nem szabad szóközöket tartalmazniuk. További információ: Címke részletei.

Type:String[]
Aliases:Tag
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Version

A szkript verziója. Ha nincs megadva érték, a verzió alapértelmezett értéke .1.0.0.0

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

Bevitelek

None

Kimenetek

Object

Jegyzetek

A New-PSScriptFileInfo és Update-PSScriptFileInfo a parancsmagok elhelyezik a #requires szükséges modulokra vonatkozó utasításokat a súgófájl és a <#PSScriptInfo megjegyzésalapú súgóblokkok között. A Get-PSScriptFileInfo várt #requires utasítások valahol a megjegyzésalapú súgóblokk előtt lesznek elhelyezve. A #requires megjegyzésalapú súgóblokk után elhelyezett utasításokat a és Publish-PSResourcea Get-PSScriptFileInfo figyelmen kívül hagyja.