New-PSScriptFileInfo

  • Referência
Módulo:
Microsoft.PowerShell.PSResourceGet

O cmdlet cria um novo ficheiro de script, incluindo metadados sobre o script.

Sintaxe

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

O cmdlet cria um novo ficheiro de script que contém os metadados necessários para publicar um pacote de script.

Exemplos

Exemplo 1: criar um script vazio com informações mínimas

Este exemplo executa o cmdlet com apenas os parâmetros necessários. O parâmetro Path especifica a nane e a localização do script. O parâmetro Description fornece a descrição utilizada na ajuda baseada em comentários para o script.

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.

#>

Exemplo 2: criar um script com módulos necessários

Este exemplo executa o cmdlet com parâmetros adicionais, incluindo RequiredModules. RequiredModules é uma matriz de especificações do módulo.

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

#>

Parâmetros

-Author

O nome do autor do script.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-CompanyName

O nome da empresa proprietária do script.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Copyright

As informações de direitos de autor do script.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Description

A descrição do script.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ExternalModuleDependencies

A lista de dependências de módulos externos obtidas por este script.

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ExternalScriptDependencies

A lista de dependências de script externo obtidas por este script.

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Force

Força o cmdlet a substituir qualquer ficheiro existente.

Tipo:SwitchParameter
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Guid

O identificador exclusivo do script no formato GUID. Se não fornecer um GUID, o cmdlet cria automaticamente um novo.

Tipo:Guid
Position:Named
Default value:Randomly generated
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-IconUri

Um Uniform Resource Identifier (URI) a apontar para o ícone associado ao script.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-LicenseUri

O URI que aponta para o ficheiro do contrato de licença associado ao script.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Path

O nome do ficheiro e a localização onde o script é criado.

Tipo:String
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-PrivateData

Os dados privados associados ao script.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ProjectUri

O URI a apontar para o site do projeto associado ao script.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ReleaseNotes

As notas de versão do script.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-RequiredModules

O parâmetro utiliza uma matriz de tabelas hash de especificação do módulo. Uma especificação de módulo é uma tabela hash que tem as seguintes chaves.

  • ModuleName - Obrigatório Especifica o nome do módulo.
  • GUID - Opcional Especifica o GUID do módulo.
  • Também é necessário especificar, pelo menos, uma das três chaves abaixo.
    • ModuleVersion - Especifica uma versão mínima aceitável do módulo.
    • MaximumVersion - Especifica a versão máxima aceitável do módulo.
    • RequiredVersion - Especifica uma versão exata e necessária do módulo. Isto não pode ser utilizado com as outras chaves de Versão.
Tipo:Hashtable[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-RequiredScripts

A lista de scripts necessários para o script.

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Tags

As etiquetas associadas ao script. Os valores das etiquetas são cadeias que não devem conter espaços. Para obter mais informações, veja Detalhes da etiqueta.

Tipo:String[]
Aliases:Tag
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Version

A versão do script. Se não for fornecido nenhum valor, a 1.0.0.0versão predefinida será .

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

None

Saídas

Object

Notas

Os New-PSScriptFileInfo cmdlets e Update-PSScriptFileInfo colocam as instruções para os #requires módulos necessários entre os <#PSScriptInfo blocos de ajuda baseados em comentários e do ficheiro de ajuda. Espera Get-PSScriptFileInfo que as declarações #requires sejam colocadas algures antes do bloco de ajuda baseado em comentários. Todas #requires as declarações colocadas após o bloco de ajuda baseado em comentários são ignoradas por Get-PSScriptFileInfo e Publish-PSResource.