Параметры действия

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

Параметр Функциональность
Append
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы пользователь смог добавить содержимое в конец ресурса при указании параметра.
CaseSensitive
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы пользователь может требовать конфиденциальность регистра при указании параметра.
Command
Тип данных: String
Реализуйте этот параметр, чтобы пользователь смог указать командную строку для выполнения.
СовместимостьVersion
Тип данных: объект System.Version
Реализуйте этот параметр, чтобы пользователь смог указать семантику, с которой командлет должен быть совместим с совместимостью с предыдущими версиями.
Compress
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы сжатие данных использовалось при указании параметра.
CompressionLevel
Тип данных: Keyword
Реализуйте этот параметр, чтобы пользователь смог указать алгоритм, используемый для сжатия данных.
Continuous
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы данные обрабатывались до тех пор, пока пользователь не завершит командлет при указании параметра. Если параметр не указан, командлет обрабатывает предопределенный объем данных, а затем завершает операцию.
Create
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы указать, что ресурс создается, если он еще не существует при указании параметра.
Delete
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы ресурсы были удалены, когда командлет завершил свою операцию при указании параметра.
Drain
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы указать, что выдающиеся рабочие элементы обрабатываются перед обработкой командлетом новых данных при указании параметра. Если параметр не указан, рабочие элементы обрабатываются немедленно.
Erase
Тип данных: Int32
Реализуйте этот параметр, чтобы пользователь смог указать время удаления ресурса перед удалением.
ErrorLevel
Тип данных: Int32
Реализуйте этот параметр, чтобы пользователь смог указать уровень ошибок для отчета.
исключить
Тип данных: String[]
Реализуйте этот параметр, чтобы пользователь смог исключить что-то из действия. Дополнительные сведения об использовании фильтров ввода см. в параметрах входного фильтра.
фильтр
Тип данных: Keyword
Реализуйте этот параметр, чтобы пользователь смог указать фильтр, который выбирает ресурсы для выполнения действия командлета. Дополнительные сведения об использовании фильтров ввода см. в параметрах входного фильтра.
Следуйте
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы ход выполнения отслеживался при указании параметра.
Принудительное
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы указать, что пользователь может выполнить действие, даже если ограничения возникают при указании параметра. Параметр не позволяет скомпрометировать безопасность. Например, этот параметр позволяет пользователю перезаписать файл, доступный только для чтения.
Include
Тип данных: String[]
Реализуйте этот параметр, чтобы пользователь смог включить что-то в действие. Дополнительные сведения об использовании фильтров ввода см. в параметрах входного фильтра.
Incremental
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы указать, что обработка выполняется постепенно при указании параметра. Например, этот параметр позволяет пользователю выполнять добавочные резервные копии, резервные копии файлов только с момента последнего резервного копирования.
InputObject
Тип данных: Object
Реализуйте этот параметр, когда командлет принимает входные данные из других командлетов. При определении параметра inputObject всегда указывайте ключевое слово ValueFromPipeline при объявлении атрибута параметра . Дополнительные сведения об использовании фильтров ввода см. в разделе Параметры входного фильтра.
Insert
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы командлет вставлял элемент при указании параметра.
интерактивные
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы командлет работал в интерактивном режиме с пользователем при указании параметра.
Interval
Тип данных: HashTable
Реализуйте этот параметр, чтобы пользователь смог указать хэш-таблицу ключевых слов, содержащих значения. В следующем примере показаны примеры значений для параметра Interval: -interval @{ResumeScan=15; Retry=3}.
журнал
Тип данных: SwitchParameter
Реализуйте этот параметр аудит действий командлета при указании параметра.
NoClobber
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы ресурс не перезаписывался при указании параметра. Этот параметр обычно применяется к командлетам, которые создают новые объекты, чтобы их можно было запретить перезаписывать существующие объекты с тем же именем.
Notify
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы пользователь был уведомлен о завершении действия при указании параметра.
NotifyAddress
Тип данных: адрес электронной почты
Реализуйте этот параметр, чтобы пользователь смог указать адрес электронной почты, используемый для отправки уведомления при указании параметра Notify.
перезаписать
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы командлет перезаписывал все существующие данные при указании параметра.
Prompt
Тип данных: String
Реализуйте этот параметр, чтобы пользователь смог указать запрос для командлета.
Quiet
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы командлет подавлял отзывы пользователей во время его действий при указании параметра.
recurse
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы командлет рекурсивно выполнял действия по ресурсам при указании параметра.
ремонт
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы командлет попытается исправить что-то из неработающего состояния при указании параметра.
repairString
Тип данных: String
Реализуйте этот параметр, чтобы пользователь смог указать строку, используемую при указании параметра repair.
Retry
Тип данных: Int32
Реализуйте этот параметр, чтобы пользователь смог указать количество попыток выполнения командлета.
Select
Тип данных: Keywordarray
Реализуйте этот параметр, чтобы пользователь смог указать array типов элементов.
Поток
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы пользователь может передавать несколько выходных объектов через конвейер при указании параметра.
Strict
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы все ошибки обрабатывались как завершающие ошибки при указании параметра.
TempLocation
Тип данных: String
Реализуйте этот параметр, чтобы пользователь смог указать расположение временных данных, используемых во время операции командлета.
время ожидания
Тип данных: Int32
Реализуйте этот параметр, чтобы пользователь смог указать интервал времени ожидания (в миллисекундах).
Truncate
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы командлет усечь свои действия при указании параметра. Если параметр не указан, командлет выполняет другое действие.
Verify
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы командлет протестировал, чтобы определить, произошло ли действие при указании параметра.
ожидание
Тип данных: SwitchParameter
Реализуйте этот параметр, чтобы командлет ждал входных данных пользователя, прежде чем продолжить при указании параметра.
WaitTime
Тип данных: Int32
Реализуйте этот параметр, чтобы пользователь смог указать длительность (в секундах), которую командлет будет ожидать ввода пользователем при указании параметра Wait.

См. также

параметров командлета

написание командлета Windows PowerShell

пакета SDK для Windows PowerShell