Compartir a través de

Update-PSScriptFileInfo

Módulo:
Microsoft.PowerShell.PSResourceGet Module

Este cmdlet actualiza los metadatos basados en comentarios en un script existente .ps1 archivo.

Sintaxis

Default (valor predeterminado) 

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 actualiza los metadatos basados en comentarios en un script existente .ps1 archivo. Esto es similar a Update-ModuleManifest.

Ejemplos

Ejemplo 1: Actualización de la versión de un script

En este ejemplo, se crea un script con Versión establecido en 1.0.0.0. Update-PSScriptFileInfo cambia la versión de " a 2.0.0.0. El cmdlet Get-Content muestra el contenido actualizado del 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

Nombre del autor del script.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-CompanyName

Nombre de la empresa propietaria del script.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Copyright

La información de copyright del script.

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Description

Descripción del script.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ExternalModuleDependencies

Lista de dependencias de módulos externos tomadas por este script.

Propiedades de parámetro

Tipo:

String[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ExternalScriptDependencies

Lista de dependencias de script externo tomadas por este script.

Propiedades de parámetro

Tipo:

String[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Guid

Identificador único del script en formato GUID.

Propiedades de parámetro

Tipo:Guid
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-IconUri

Identificador uniforme de recursos (URI) que apunta al icono asociado al script.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-LicenseUri

Identificador URI que apunta al archivo de contrato de licencia asociado al script.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Path

Nombre de archivo y ubicación del script.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:0
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-PrivateData

Datos privados asociados al script.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ProjectUri

Identificador URI que apunta al sitio del proyecto asociado al script.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ReleaseNotes

Notas de la versión del script.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-RemoveSignature

Quita la firma de un archivo de .ps1 firmado, lo que le permite actualizar el script. Debe volver a firmar después de actualizar el archivo.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:False
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-RequiredModules

El parámetro toma una matriz de tablas hash de especificación del módulo. Una especificación de módulo es una tabla hash que tiene las siguientes claves.

  • ModuleName - Required Especifica el nombre del módulo.
  • GUID - opcional Especifica el GUID del módulo.
  • También es obligatorio especificar al menos una de las tres claves siguientes.
    • ModuleVersion: especifica una versión mínima aceptable del módulo.
    • MaximumVersion: especifica la versión máxima aceptable del módulo.
    • RequiredVersion: especifica una versión exacta y necesaria del módulo. Esto no se puede usar con las otras claves de versión.

Propiedades de parámetro

Tipo:

Hashtable[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-RequiredScripts

Lista de scripts requeridos por el script.

Propiedades de parámetro

Tipo:

String[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Tags

Etiquetas asociadas al script. Los valores de etiqueta son cadenas que no deben contener espacios. Para obtener más información, vea Detalles de etiqueta.

Propiedades de parámetro

Tipo:

String[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:Etiqueta

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Version

Versión del script.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

None

Salidas

Object

Notas

Los cmdlets New-PSScriptFileInfo y Update-PSScriptFileInfo colocan las instrucciones #requires para los módulos necesarios entre los bloques de ayuda <#PSScriptInfo y basados en comentarios del archivo de ayuda. El Get-PSScriptFileInfo espera que las instrucciones #requires se coloquen en algún lugar antes del bloque de ayuda basado en comentarios. Las instrucciones de #requires colocadas después del bloque de ayuda basado en comentarios se omiten Get-PSScriptFileInfo y Publish-PSResource.