Update-PSScriptFileInfo
Этот командлет обновляет метаданные на основе комментариев в существующем файле скрипта .ps1.
Синтаксис
Default (По умолчанию)
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. Обновление версии скрипта
В этом примере скрипт создается с версии для 1.0.0.0.
Update-PSScriptFileInfo изменяет версии на 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
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-CompanyName
Имя компании, принадлежащей скрипту.
Свойства параметров
Тип: String
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-Copyright
Сведения об авторских правах для скрипта.
Свойства параметров
Тип: String
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-Description
Описание скрипта.
Свойства параметров
Тип: String
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-ExternalModuleDependencies
Список зависимостей внешнего модуля, принятых этим скриптом.
Свойства параметров
Тип: String [ ]
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-ExternalScriptDependencies
Список зависимостей внешнего скрипта, принятых этим скриптом.
Свойства параметров
Тип: String [ ]
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-Guid
Уникальный идентификатор скрипта в формате GUID.
Свойства параметров
Тип: Guid
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-IconUri
Универсальный идентификатор ресурса (URI), указывающий на значок, связанный со скриптом.
Свойства параметров
Тип: String
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-LicenseUri
Универсальный код ресурса (URI), указывающий на файл лицензионного соглашения, связанный с скриптом.
Свойства параметров
Тип: String
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-Path
Имя файла и расположение скрипта.
Свойства параметров
Тип: String
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: 0 Обязательный: True Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-PrivateData
Частные данные, связанные с скриптом.
Свойства параметров
Тип: String
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-ProjectUri
URI, указывающий на сайт проекта, связанный с скриптом.
Свойства параметров
Тип: String
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-ReleaseNotes
Заметки о выпуске скрипта.
Свойства параметров
Тип: String
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-RemoveSignature
Удаляет подпись из подписанного файла .ps1, что позволяет обновить скрипт. После обновления файла необходимо повторно подписать файл.
Свойства параметров
Тип: SwitchParameter
Значение по умолчанию: False Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-RequiredModules
Параметр принимает массив хэш-хэшируемых значений спецификации модуля. Спецификация модуля — это хэш-файл, имеющий следующие ключи.
ModuleName
-
Обязательный Указывает имя модуля.
GUID
-
Необязательный указывает GUID модуля.
Это также Обязательный , чтобы указать хотя бы один из трех приведенных ниже ключей.
ModuleVersion. Указывает минимальную допустимую версию модуля.
MaximumVersion. Указывает максимальную допустимую версию модуля.
RequiredVersion . Указывает точную, требуемую версию модуля. Это невозможно использовать с другими ключами версии.
Свойства параметров
Тип: Hashtable [ ]
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-RequiredScripts
Список сценариев, необходимых для скрипта.
Свойства параметров
Тип: String [ ]
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
Теги, связанные со скриптом. Значения тегов — это строки, которые не должны содержать пробелы. Дополнительные сведения см. в сведения о теге .
Тип: String [ ]
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False Псевдонимы: Тег
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
-Version
Версия скрипта.
Свойства параметров
Тип: String
Значение по умолчанию: None Поддержка подстановочных знаков: False Не показывайте: False
Наборы параметров
(All)
Позиция: Named Обязательный: False Ценность воронки продаж: False Значение из конвейера по имени свойства: False Значение из оставшихся аргументов: False
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters .
None
Выходы
Примечания
Командлеты New-PSScriptFileInfo и Update-PSScriptFileInfo размещают инструкции #requires для необходимых модулей между блоками справки на основе <#PSScriptInfo и комментариев файла справки.
Get-PSScriptFileInfo ожидает, что операторы #requires помещаются где-то перед блоком справки на основе комментариев. Все инструкции #requires, размещенные после блока справки на основе комментариев, игнорируются Get-PSScriptFileInfo и Publish-PSResource.
