Поделиться через

Update-PSScriptFileInfo

  • Ссылка
Модуль:
Microsoft.PowerShell.PSResourceGet

Этот командлет обновляет метаданные на основе комментариев в существующем файле скрипта .ps1 .

Синтаксис

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>]

Описание

Этот командлет обновляет метаданные на основе комментариев в существующем файле скрипта .ps1 . Это аналогично Update-ModuleManifest.

Примеры

Пример 1. Обновление версии скрипта

В этом примере создается скрипт с параметром Version , равным 1.0.0.0. Update-PSScriptFileInfo изменяет значение Version' на 2.0.0.0. Командлет Get-Content отображает обновленное содержимое скрипта.

$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

#>

Параметры

-Author

Имя автора скрипта.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-CompanyName

Имя компании, владеющей сценарием.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Copyright

Сведения об авторских правах для сценария.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Description

Описание скрипта.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ExternalModuleDependencies

Список зависимостей внешних модулей, принятых этим скриптом.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ExternalScriptDependencies

Список зависимостей внешних скриптов, принятых этим скриптом.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Guid

Уникальный идентификатор скрипта в формате GUID.

Тип:Guid
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-IconUri

Универсальный код ресурса (URI), указывающий на значок, связанный со сценарием.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-LicenseUri

Универсальный код ресурса (URI), указывающий на файл лицензионного соглашения, связанный со сценарием.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Path

Имя файла и расположение скрипта.

Тип:String
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-PrivateData

Личные данные, связанные со скриптом.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ProjectUri

Универсальный код ресурса (URI), указывающий на сайт проекта, связанный со скриптом.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ReleaseNotes

Заметки о выпуске скрипта.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-RemoveSignature

Удаляет подпись из подписанного .ps1 файла, позволяя обновить скрипт. После обновления файла необходимо повторно подписать .

Тип:SwitchParameter
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-RequiredModules

Параметр принимает массив хэш-таблицей спецификации модуля. Спецификация модуля — это хэш-таблице со следующими ключами.

  • ModuleName - Обязательно Указывает имя модуля.
  • GUID - Дополнительные Указывает GUID модуля.
  • Кроме того, необходимо указать по крайней мере один из трех приведенных ниже ключей.
    • ModuleVersion — задает минимальную допустимую версию модуля.
    • MaximumVersion — задает максимально допустимую версию модуля.
    • RequiredVersion — указывает точную требуемую версию модуля. Его нельзя использовать с другими ключами версии.
Тип:Hashtable[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-RequiredScripts

Список скриптов, необходимых для скрипта.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Tags

Теги, связанные со скриптом. Значения тегов — это строки, которые не должны содержать пробелы. Дополнительные сведения см. в разделе Сведения о теге.

Тип:String[]
Aliases:Tag
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Version

Версия скрипта.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Входные данные

None

Выходные данные

Object