New-PSScriptFileInfo
O cmdlet cria um novo arquivo de script, incluindo metadados sobre o script.
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
O cmdlet cria um novo arquivo de script que contém os metadados necessários para publicar um pacote de script.
Exemplos
Exemplo 1: Criando um script vazio com informações mínimas
Este exemplo executa o cmdlet usando apenas os parâmetros necessários. O parâmetro Path especifica o nane e o local do script. O parâmetro Description fornece a descrição usada 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: criando um script com os módulos necessários
Este exemplo executa o cmdlet com parâmetros adicionais, incluindo RequiredModules. RequiredModules é uma matriz de especificações de 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CompanyName
O nome da empresa que possui o script.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Copyright
As informações de direitos autorais do script.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
A descrição do script.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExternalModuleDependencies
A lista de dependências de módulo externas obtidas por esse script.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExternalScriptDependencies
A lista de dependências de script externo obtidas por esse script.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Força o cmdlet a substituir qualquer arquivo existente.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Guid
O identificador exclusivo do script no formato GUID. Se você não fornecer um GUID, o cmdlet criará um novo automaticamente.
| Type: | Guid |
| Position: | Named |
| Default value: | Randomly generated |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IconUri
Um URI (Uniform Resource Identifier) apontando para o ícone associado ao script.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LicenseUri
O URI que aponta para o arquivo de contrato de licença associado ao script.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
O nome do arquivo e o local em que o script é criado.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrivateData
Os dados privados associados ao script.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProjectUri
O URI que aponta para o site do projeto associado ao script.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReleaseNotes
As notas sobre a versão do script.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequiredModules
O parâmetro usa uma matriz de tabelas de hash de especificação de módulo. Uma especificação de módulo é uma tabela de hash que tem as chaves a seguir.
ModuleName- Necessá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. Isso não pode ser usado com as outras chaves de versão.
| Type: | Hashtable[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequiredScripts
A lista de scripts exigida pelo script.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tags
As marcas associadas ao script. Os valores de marca são cadeias de caracteres que não devem conter espaços. Para obter mais informações, consulte Detalhes da marca.
| Type: | String[] |
| Aliases: | Tag |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Version
A versão do script. Se nenhum valor for fornecido , a versão usará como padrão 1.0.0.0.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Entradas
None
Saídas
Observações
Os New-PSScriptFileInfo cmdlets e Update-PSScriptFileInfo colocam as #requires instruções para os módulos necessários entre os <#PSScriptInfo blocos de ajuda baseados em comentário e do arquivo de ajuda.
A Get-PSScriptFileInfo espera que as instruções sejam colocadas #requires em algum lugar antes do bloco de ajuda baseado em comentários. Todas as #requires instruções colocadas após o bloco de ajuda baseado em comentário são ignoradas por Get-PSScriptFileInfo e Publish-PSResource.
Links Relacionados
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de