New-ScriptFileInfo

Referens

Modul:: PowerShellGet

Skapar en skriptfil med metadata.

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

Cmdleten New-ScriptFileInfo skapar en PowerShell-skriptfil, inklusive metadata om skriptet.

Det här är en proxy-cmdlet för New-PSScriptFileInfo cmdleten i Microsoft.PowerShell.PSResourceGet. Mer information finns i New-PSScriptFileInfo.

Exempel

Exempel 1: Skapa en skriptfil och ange dess version, författare och beskrivning

I det här exemplet skapas en skriptfil och dess innehåll visas i PowerShell-konsolen.

$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()

Cmdleten New-ScriptFileInfo använder splatting för att konfigurera flera parametrar för skriptet. Sökvägen anger skriptets plats och namn. Version anger skriptets versionsnummer. Författare är e-postadressen till den person som skapade skriptet. Beskrivningen förklarar skriptets syfte.

När skriptet har skapats Get-Content använder parametern Path för att hitta skriptet. Skriptets innehåll visas i PowerShell-konsolen.

Exempel 2: Testa en skriptfil

I det här exemplet testas metadata för skriptet som skapades i exempel 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

Cmdleten Test-ScriptFileInfo använder parametern Path för att ange platsen för skriptfilen.

Exempel 3: Skapa en skriptfil med alla metadataegenskaper

Det här exemplet använder splatting för att skapa en skriptfil med namnet New-ScriptFile.ps1 som innehåller alla dess metadataegenskaper. Den utförliga parametern anger att utförliga utdata visas när skriptet skapas.

$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()

Parametrar

-Author

Anger skriptförfattaren.

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

-CompanyName

Anger det företag eller den leverantör som skapade skriptet.

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

-Confirm

Du uppmanas att bekräfta innan du New-ScriptFileInfokör .

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

-Copyright

Anger ett copyright-uttryck för skriptet.

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

-Description

Anger en beskrivning av skriptet.

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

-ExternalModuleDependencies

Anger en matris med externa modulberoenden.

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

-ExternalScriptDependencies

Anger en matris med externa skriptberoenden.

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

-Force

Tvingar kommandot att köras utan att be om användarbekräftelse.

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

-Guid

Anger ett unikt ID för skriptet.

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

-IconUri

Anger URL:en för en ikon för skriptet. Den angivna ikonen visas på galleriets webbsida för skriptet.

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

-LicenseUri

Anger URL:en för licensvillkor.

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

-PassThru

Proxy-cmdleten ignorerar den här parametern eftersom den inte stöds av New-PSScriptFileInfo.

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

-Path

Anger den plats där skriptfilen sparas.

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

-PrivateData

Anger privata data för skriptet.

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

-ProjectUri

Anger URL:en för en webbsida om det här projektet.

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

-ReleaseNotes

Anger en strängmatris som innehåller viktig information eller kommentarer som du vill ska vara tillgängliga för användare av den här versionen av skriptet.

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

-RequiredModules

Anger moduler som måste vara i globalt sessionstillstånd. Om de moduler som krävs inte är i det globala sessionstillståndet importerar PowerShell dem.

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

-RequiredScripts

Anger en matris med skript som krävs.

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

-Tags

Anger en matris med taggar.

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

-Version

Anger versionen av skriptet.

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

-WhatIf

Visar vad som skulle hända om New-ScriptFileInfo körs. Cmdleten körs inte.

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

Indata

String

Utdata

Object

Dela via

New-ScriptFileInfo

Syntax

Description

Exempel

Exempel 1: Skapa en skriptfil och ange dess version, författare och beskrivning

Exempel 2: Testa en skriptfil

Exempel 3: Skapa en skriptfil med alla metadataegenskaper

Parametrar

-Author

-CompanyName

-Confirm

-Copyright

-Description

-ExternalModuleDependencies

-ExternalScriptDependencies

-Force

-Guid

-IconUri

-LicenseUri

-PassThru

-Path

-PrivateData

-ProjectUri

-ReleaseNotes

-RequiredModules

-RequiredScripts

-Tags

-Version

-WhatIf

Indata

Utdata

Ytterligare resurser

Dela via

New-ScriptFileInfo

Syntax

Description

Exempel

Exempel 1: Skapa en skriptfil och ange dess version, författare och beskrivning

Exempel 2: Testa en skriptfil

Exempel 3: Skapa en skriptfil med alla metadataegenskaper

Parametrar

-Author

-CompanyName

-Confirm

-Copyright

-Description

-ExternalModuleDependencies

-ExternalScriptDependencies

-Force

-Guid

-IconUri

-LicenseUri

-PassThru

-Path

-PrivateData

-ProjectUri

-ReleaseNotes

-RequiredModules

-RequiredScripts

-Tags

-Version

-WhatIf

Indata

Utdata

Relaterade länkar

Ytterligare resurser