New-ScriptFileInfo

Hiermee maakt u een scriptbestand met metagegevens.

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

Met de New-ScriptFileInfo cmdlet wordt een PowerShell-scriptbestand gemaakt, inclusief metagegevens over het script.

In de voorbeelden wordt splatting gebruikt om parameters door te geven aan de New-ScriptFileInfo cmdlet. Zie about_Splatting voor meer informatie.

Voorbeelden

Voorbeeld 1: Een scriptbestand maken en de versie, auteur en beschrijving opgeven

In dit voorbeeld wordt een scriptbestand gemaakt en wordt de inhoud ervan weergegeven in de PowerShell-console.

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

De New-ScriptFileInfo cmdlet maakt gebruik van splatting om verschillende parameters voor het script te configureren. Het pad stelt de locatie en naam van het script in. Versie geeft het versienummer van het script op. Auteur is het e-mailadres van de persoon die het script heeft gemaakt. Beschrijving legt het doel van het script uit.

Nadat het script is gemaakt, Get-Content gebruikt u de parameter Path om het script te vinden. De inhoud van het script wordt weergegeven in de PowerShell-console.

Voorbeeld 2: Een scriptbestand testen

In dit voorbeeld worden de metagegevens voor het script dat is gemaakt in voorbeeld 1 getest.

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

De Test-ScriptFileInfo cmdlet gebruikt de parameter Path om de locatie van het scriptbestand op te geven.

Voorbeeld 3: Een scriptbestand maken met alle metagegevenseigenschappen

In dit voorbeeld wordt splatting gebruikt om een scriptbestand met de naam New-ScriptFile.ps1 te maken dat alle metagegevenseigenschappen bevat. De uitgebreide parameter geeft aan dat uitgebreide uitvoer wordt weergegeven terwijl het script wordt gemaakt.

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

Parameters

-Author

Hiermee geeft u de scriptauteur.

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

-CompanyName

Hiermee geeft u het bedrijf of de leverancier op die het script heeft gemaakt.

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

-Confirm

Vraagt u om bevestiging voordat u de New-ScriptFileInfo.

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

-Copyright

Hiermee geeft u een copyrightverklaring voor het script op.

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

-Description

Hiermee geeft u een beschrijving voor het script.

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

-ExternalModuleDependencies

Hiermee geeft u een matrix van externe moduleafhankelijkheden.

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

-ExternalScriptDependencies

Hiermee geeft u een matrix van externe scriptafhankelijkheden.

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

-Force

Dwingt de opdracht uit te voeren zonder te vragen om bevestiging van de gebruiker.

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

-Guid

Hiermee geeft u een unieke id voor het script.

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

-IconUri

Hiermee geeft u de URL van een pictogram voor het script. Het opgegeven pictogram wordt weergegeven op de webpagina van de galerie voor het script.

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

-LicenseUri

Hiermee geeft u de URL van licentievoorwaarden op.

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

-PassThru

Retourneert een object dat het item vertegenwoordigt waarmee u werkt. New-ScriptFileInfo Genereert standaard geen uitvoer.

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

-Path

Hiermee geeft u de locatie op waar het scriptbestand wordt opgeslagen.

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

-PrivateData

Hiermee geeft u persoonlijke gegevens voor het script op.

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

-ProjectUri

Hiermee geeft u de URL van een webpagina over dit project.

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

-ReleaseNotes

Hiermee geeft u een tekenreeksmatrix op die releaseopmerkingen of opmerkingen bevat die beschikbaar zijn voor gebruikers van deze versie van het script.

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

-RequiredModules

Hiermee geeft u modules op die de globale sessiestatus moeten hebben. Als de vereiste modules niet de status van de globale sessie hebben, worden deze geïmporteerd in PowerShell.

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

-RequiredScripts

Hiermee geeft u een matrix van vereiste scripts.

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

-Tags

Hiermee geeft u een matrix van tags.

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

-Version

Hiermee geeft u de versie van het script.

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

-WhatIf

Laat zien wat er zou gebeuren als New-ScriptFileInfo deze wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

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

Invoerwaarden

String

Uitvoerwaarden

Object