Update-PSScriptFileInfo

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

Este cmdlet atualiza os metadados baseados em comentários num ficheiro de script .ps1 existente.

Sintaxe

Update-PSScriptFileInfo
      [-Author <String>]
      [-CompanyName <String>]
      [-Copyright <String>]
      [-Description <String>]
      [-ExternalModuleDependencies <String[]>]
      [-ExternalScriptDependencies <String[]>]
      [-Guid <Guid>]
      [-IconUri <String>]
      [-LicenseUri <String>]
      [-Path] <String>
      [-PrivateData <String>]
      [-ProjectUri <String>]
      [-ReleaseNotes <String>]
      [-RemoveSignature]
      [-RequiredModules <Hashtable[]>]
      [-RequiredScripts <String[]>]
      [-Tags <String[]>]
      [-Version <String>]
      [<CommonParameters>]

Description

Este cmdlet atualiza os metadados baseados em comentários num ficheiro de script .ps1 existente. Isto é semelhante a Update-ModuleManifest.

Exemplos

Exemplo 1: atualizar a versão de um script

Neste exemplo, é criado um script com a Versão definida como 1.0.0.0. Update-PSScriptFileInfo altera a Versão para 2.0.0.0. O Get-Content cmdlet mostra os conteúdos atualizados do script.

$parameters = @{
    FilePath = "C:\Users\johndoe\MyScripts\test_script.ps1"
    Version = "1.0.0.0"
    Description = "this is a test script"
}
New-PSScriptFileInfo @parameters
$parameters.Version = "2.0.0.0"
Update-PSScriptFileInfo @parameters
Get-Content $parameters.FilePath

<#PSScriptInfo

.VERSION 2.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

#>

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:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ExternalModuleDependencies

A lista de dependências de módulos externos tomadas 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 scripts externos tomadas por este script.

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

-Guid

O identificador exclusivo do script no formato GUID.

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

-IconUri

Um Uniform Resource Identifier (URI) que aponta 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 do script.

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 que aponta 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

-RemoveSignature

Remove a assinatura de um ficheiro assinado .ps1 , permitindo-lhe atualizar o script. Deve voltar a assinar o depois de atualizar o ficheiro.

Tipo:SwitchParameter
Position:Named
Default value:False
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 - 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 aceitável mínima 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, consulte 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.

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

Entradas

None

Saídas

Object