New-ScriptFileInfo

Reference

Modul:: PowerShellGet

Vytvoří soubor skriptu s metadaty.

Syntax

New-ScriptFileInfo
   [[-Path] <String>]
   [-Version <String>]
   [-Author <String>]
   -Description <String>
   [-Guid <Guid>]
   [-CompanyName <String>]
   [-Copyright <String>]
   [-RequiredModules <Object[]>]
   [-ExternalModuleDependencies <String[]>]
   [-RequiredScripts <String[]>]
   [-ExternalScriptDependencies <String[]>]
   [-Tags <String[]>]
   [-ProjectUri <Uri>]
   [-LicenseUri <Uri>]
   [-IconUri <Uri>]
   [-ReleaseNotes <String[]>]
   [-PrivateData <String>]
   [-PassThru]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Rutina New-ScriptFileInfo vytvoří soubor skriptu PowerShellu včetně metadat o skriptu.

Toto je rutina proxy pro rutinu New-PSScriptFileInfo v Microsoft.PowerShell.PSResourceGet. Další informace najdete v tématu New-PSScriptFileInfo.

Příklady

Příklad 1: Vytvoření souboru skriptu a zadání jeho verze, autora a popisu

V tomto příkladu se vytvoří soubor skriptu a jeho obsah se zobrazí v konzole PowerShellu.

$Parms = @{
  Path = "C:\Test\Temp-Scriptfile.ps1"
  Version = "1.0"
  Author = "pattif@contoso.com"
  Description = "My test script file description goes here"
  }
New-ScriptFileInfo @Parms
Get-Content -Path C:\Test\Temp-Scriptfile.ps1

<#PSScriptInfo

.VERSION 1.0

.GUID 3bb10ee7-38c1-41b9-88ea-16899164fc19

.AUTHOR pattif@contoso.com

.COMPANYNAME

.COPYRIGHT

.TAGS

.LICENSEURI

.PROJECTURI

.ICONURI

.EXTERNALMODULEDEPENDENCIES

.REQUIREDSCRIPTS

.EXTERNALSCRIPTDEPENDENCIES

.RELEASENOTES

.PRIVATEDATA

#>

<#

.DESCRIPTION
 My test script file description goes here

#>
Param()

Rutina New-ScriptFileInfo pomocí splattingu nakonfiguruje několik parametrů pro skript. Cesta nastaví umístění a název skriptu. Version určuje číslo verze skriptu. Autor je e-mailová adresa osoby, která skript vytvořila. Popis vysvětluje účel skriptu.

Po vytvoření Get-Content skriptu použije parametr Path k vyhledání skriptu. Obsah skriptu se zobrazí v konzole PowerShellu.

Příklad 2: Testování souboru skriptu

V tomto příkladu se testují metadata pro skript vytvořený v příkladu 1 .

Test-ScriptFileInfo -Path C:\Test\Temp-Scriptfile.ps1

Version   Name                  Author               Description
-------   ----                  ------               -----------
1.0       Temp-Scriptfile       pattif@contoso.com   My test script file description goes here

Rutina Test-ScriptFileInfo používá parametr Path k určení umístění souboru skriptu.

Příklad 3: Vytvoření souboru skriptu se všemi vlastnostmi metadat

Tento příklad používá splatting k vytvoření souboru skriptu s názvem New-ScriptFile.ps1 , který obsahuje všechny jeho vlastnosti metadat. Parametr Podrobné určuje, že se při vytváření skriptu zobrazí podrobný výstup.

$Parms = @{
 Path = "C:\Test\New-ScriptFile.ps1"
 Verbose = $True
 Version = "1.0"
 Author = "pattif@contoso.com"
 Description = "My new script file test"
 CompanyName = "Contoso Corporation"
 Copyright = "2019 Contoso Corporation. All rights reserved."
 ExternalModuleDependencies = "ff","bb"
 RequiredScripts = "Start-WFContosoServer", "Stop-ContosoServerScript"
 ExternalScriptDependencies = "Stop-ContosoServerScript"
 Tags = @("Tag1", "Tag2", "Tag3")
 ProjectUri = "https://contoso.com"
 LicenseUri = "https://contoso.com/License"
 IconUri = "https://contoso.com/Icon"
 PassThru = $True
 ReleaseNotes = @("Contoso script now supports the following features:",
   "Feature 1",
   "Feature 2",
   "Feature 3",
   "Feature 4",
   "Feature 5")
 RequiredModules =
   "1",
   "2",
   "RequiredModule1",
   @{ModuleName="RequiredModule2";ModuleVersion="1.0"},
   @{ModuleName="RequiredModule3";RequiredVersion="2.0"},
   "ExternalModule1"
 }
New-ScriptFileInfo @Parms

VERBOSE: Performing the operation "Creating the 'C:\Test\New-ScriptFile.ps1'
  PowerShell Script file" on target "C:\Test\New-ScriptFile.ps1".

<#PSScriptInfo

.VERSION 1.0

.GUID 4fabe8c7-7862-45b1-a72e-1352a433b77d

.AUTHOR pattif@contoso.com

.COMPANYNAME Contoso Corporation

.COPYRIGHT 2019 Contoso Corporation. All rights reserved.

.TAGS Tag1 Tag2 Tag3

.LICENSEURI https://contoso.com/License

.PROJECTURI https://contoso.com/

.ICONURI https://contoso.com/Icon

.EXTERNALMODULEDEPENDENCIES ff,bb

.REQUIREDSCRIPTS Start-WFContosoServer,Stop-ContosoServerScript

.EXTERNALSCRIPTDEPENDENCIES Stop-ContosoServerScript

.RELEASENOTES
Contoso script now supports the following features:
Feature 1
Feature 2
Feature 3
Feature 4
Feature 5

.PRIVATEDATA

#>

#Requires -Module 1
#Requires -Module 2
#Requires -Module RequiredModule1
#Requires -Module @{ModuleName = 'RequiredModule2'; ModuleVersion = '1.0'}
#Requires -Module @{RequiredVersion = '2.0'; ModuleName = 'RequiredModule3'}
#Requires -Module ExternalModule1

<#

.DESCRIPTION
 My new script file test

#>
Param()

Parametry

-Author

Určuje autora skriptu.

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

-CompanyName

Určuje společnost nebo dodavatele, který skript vytvořil.

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

-Confirm

Před spuštěním nástroje zobrazí výzvu k New-ScriptFileInfopotvrzení.

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

-Copyright

Určuje prohlášení o autorských právech pro skript.

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

-Description

Určuje popis skriptu.

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

-ExternalModuleDependencies

Určuje pole závislostí externích modulů.

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

-ExternalScriptDependencies

Určuje pole závislostí externích skriptů.

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

-Force

Vynutí spuštění příkazu bez žádosti o potvrzení uživatele.

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

-Guid

Určuje jedinečné ID skriptu.

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

-IconUri

Určuje adresu URL ikony skriptu. Zadaná ikona se zobrazí na webové stránce galerie pro skript.

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

-LicenseUri

Určuje adresu URL licenčních podmínek.

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

-PassThru

Rutina proxy serveru tento parametr ignoruje, protože ho nepodporuje New-PSScriptFileInfo.

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

-Path

Určuje umístění, kam je soubor skriptu uložen.

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

-PrivateData

Určuje soukromá data pro skript.

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

-ProjectUri

Určuje adresu URL webové stránky o tomto projektu.

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

-ReleaseNotes

Určuje pole řetězců obsahující poznámky k verzi nebo komentáře, které mají být k dispozici uživatelům této verze skriptu.

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

-RequiredModules

Určuje moduly, které musí být v globálním stavu relace. Pokud požadované moduly nejsou ve stavu globální relace, PowerShell je naimportuje.

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

-RequiredScripts

Určuje pole požadovaných skriptů.

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

-Tags

Určuje pole značek.

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

-Version

Určuje verzi skriptu.

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

-WhatIf

Ukazuje, co by se stalo při New-ScriptFileInfo spuštění. Rutina se nespustí.

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

Vstupy

String

Výstupy

Object

Sdílet prostřednictvím

New-ScriptFileInfo

Syntax

Description

Příklady

Příklad 1: Vytvoření souboru skriptu a zadání jeho verze, autora a popisu

Příklad 2: Testování souboru skriptu

Příklad 3: Vytvoření souboru skriptu se všemi vlastnostmi metadat

Parametry

-Author

-CompanyName

-Confirm

-Copyright

-Description

-ExternalModuleDependencies

-ExternalScriptDependencies

-Force

-Guid

-IconUri

-LicenseUri

-PassThru

-Path

-PrivateData

-ProjectUri

-ReleaseNotes

-RequiredModules

-RequiredScripts

-Tags

-Version

-WhatIf

Vstupy

Výstupy

Další materiály

Sdílet prostřednictvím

New-ScriptFileInfo

Syntax

Description

Příklady

Příklad 1: Vytvoření souboru skriptu a zadání jeho verze, autora a popisu

Příklad 2: Testování souboru skriptu

Příklad 3: Vytvoření souboru skriptu se všemi vlastnostmi metadat

Parametry

-Author

-CompanyName

-Confirm

-Copyright

-Description

-ExternalModuleDependencies

-ExternalScriptDependencies

-Force

-Guid

-IconUri

-LicenseUri

-PassThru

-Path

-PrivateData

-ProjectUri

-ReleaseNotes

-RequiredModules

-RequiredScripts

-Tags

-Version

-WhatIf

Vstupy

Výstupy

Související odkazy

Další materiály