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

New-PSScriptFileInfo

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

Командлет создает новый файл скрипта, включая метаданные о скрипте.

Синтаксис

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

Описание

Командлет создает новый файл скрипта, содержащий необходимые метаданные для публикации пакета скрипта.

Примеры

Пример 1. Создание пустого скрипта с минимальными сведениями

В этом примере выполняется командлет, использующий только необходимые параметры. Параметр пути указывает nane и расположение скрипта. Параметр описания предоставляет описание, используемое в справке на основе комментариев для скрипта.

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.

#>

Пример 2. Создание скрипта с необходимыми модулями

В этом примере выполняется командлет с дополнительными параметрами, включая RequiredModules. RequiredModules — это массив спецификаций модулей.

$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.

#>

Параметры

-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
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ExternalModuleDependencies

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

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

-ExternalScriptDependencies

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

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

-Force

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

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

-Guid

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

Тип:Guid
Position:Named
Default value:Randomly generated
Обязательно: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

-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

Версия скрипта. Если значение не указано версии по умолчанию для 1.0.0.0.

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

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

None

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

Примечания

Командлеты New-PSScriptFileInfo и Update-PSScriptFileInfo размещают инструкции #requires для необходимых модулей между блоками справки на основе <#PSScriptInfo и комментариев файла справки. Get-PSScriptFileInfo ожидает, что операторы #requires помещаются где-то перед блоком справки на основе комментариев. Все инструкции #requires, размещенные после блока справки на основе комментариев, игнорируются Get-PSScriptFileInfo и Publish-PSResource.