О ОбщиепараметрыAbout CommonParameters

КРАТКОЕ ОПИСАНИЕSHORT DESCRIPTION

Описывает параметры, которые можно использовать с любым командлетом.Describes the parameters that can be used with any cmdlet.

ПОДРОБНОЕ ОПИСАНИЕLONG DESCRIPTION

Общие параметры — это набор параметров командлета, которые можно использовать с любым командлетом.The common parameters are a set of cmdlet parameters that you can use with any cmdlet. Они реализуются с помощью PowerShell, а не разработчика командлетов и автоматически доступны любому командлету.They're implemented by PowerShell, not by the cmdlet developer, and they're automatically available to any cmdlet.

Общие параметры можно использовать с любыми командлетами, но они могут не влиять на все командлеты.You can use the common parameters with any cmdlet, but they might not have an effect on all cmdlets. Например, если командлет не создает подробные выходные данные, использование параметра verbose Common не оказывает никакого влияния.For example, if a cmdlet doesn't generate any verbose output, using the Verbose common parameter has no effect.

Общие параметры также доступны для расширенных функций, использующих атрибут CmdletBinding или Parameter .The common parameters are also available on advanced functions that use the CmdletBinding attribute or the Parameter attribute.

Несколько общих параметров переопределяют системные значения по умолчанию или настройки, заданные с помощью переменных предпочтений PowerShell.Several common parameters override system defaults or preferences that you set by using the PowerShell preference variables. В отличие от привилегированных переменных, общие параметры влияют только на те команды, в которых они используются.Unlike the preference variables, the common parameters affect only the commands in which they're used.

Дополнительные сведения см. в разделе about_Preference_Variables.For more information, see about_Preference_Variables.

В следующем списке отображаются общие параметры.The following list displays the common parameters. Их псевдонимы перечислены в скобках.Their aliases are listed in parentheses.

  • Debug (db)Debug (db)
  • ErrorAction (EA)ErrorAction (ea)
  • ErrorVariable (EV)ErrorVariable (ev)
  • InformationAction (инфа)InformationAction (infa)
  • InformationVariable (IV)InformationVariable (iv)
  • Переменная (OV)OutVariable (ov)
  • Буфер (OB)OutBuffer (ob)
  • PipelineVariable (ПС)PipelineVariable (pv)
  • Verbose (VB)Verbose (vb)
  • WarningAction (штат Вашингтон)WarningAction (wa)
  • WarningVariable (WV)WarningVariable (wv)

Параметры действия — это значения типа действие .The Action parameters are ActionPreference type values. Действие — это перечисление со следующими значениями:ActionPreference is an enumeration with the following values:

nameName ЗначениеValue
ПриостановитьSuspend 55
ИгнорироватьIgnore 44
InquireInquire 33
ПродолжитьContinue 22
СтопStop 11
SilentlyContinueSilentlyContinue 00

Можно использовать имя или значение с параметром.You may use the name or the value with the parameter.

Помимо общих параметров, многие командлеты предлагают параметры устранения рисков.In addition to the common parameters, many cmdlets offer risk mitigation parameters. Командлеты, которые подразумевают риск для системы или для пользовательских данных, обычно предлагают эти параметры.Cmdlets that involve risk to the system or to user data usually offer these parameters.

Параметры устранения рисков:The risk mitigation parameters are:

  • WhatIf (Wi-in)WhatIf (wi)
  • Подтверждение (CF)Confirm (cf)

ОБЩИЕ ОПИСАНИЯ ПАРАМЕТРОВCOMMON PARAMETER DESCRIPTIONS

ОтладкаDebug

Отображает сведения на уровне программиста об операции, выполняемой командой.Displays programmer-level detail about the operation done by the command. Этот параметр работает только в том случае, если команда создает сообщение отладки.This parameter works only when the command generates a debugging message. Например, этот параметр работает, если команда содержит Write-Debug командлет.For example, this parameter works when a command contains the Write-Debug cmdlet.

Type: SwitchParameter
Aliases: db

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

По умолчанию сообщения отладки не отображаются, так как значение $DebugPreference переменной — SilentlyContinue.By default, debugging messages aren't displayed because the value of the $DebugPreference variable is SilentlyContinue.

В интерактивном режиме параметр Debug переопределяет значение $DebugPreference переменной для текущей команды, устанавливая для параметра значение "запрос" $DebugPreference . In interactive mode, the Debug parameter overrides the value of the $DebugPreference variable for the current command, setting the value of $DebugPreference to Inquire.

В неинтерактивном режиме параметр Debug переопределяет значение $DebugPreference переменной для текущей команды, устанавливая $DebugPreference для значение Continue.In non-interactive mode, the Debug parameter overrides the value of the $DebugPreference variable for the current command, setting the value of $DebugPreference to Continue.

-Debug:$true имеет тот же результат, что и -Debug .-Debug:$true has the same effect as -Debug. Используйте, -Debug:$false чтобы подавлять отображение отладочных сообщений $DebugPreference , если не SilentlyContinue, что является значением по умолчанию.Use -Debug:$false to suppress the display of debugging messages when $DebugPreference isn't SilentlyContinue, which is the default.

ErrorActionErrorAction

Определяет реакцию командлета на неустранимую ошибку команды.Determines how the cmdlet responds to a non-terminating error from the command. Этот параметр работает только в том случае, если команда создает неустранимую ошибку, например из Write-Error командлета.This parameter works only when the command generates a non-terminating error, such as those from the Write-Error cmdlet.

Type: ActionPreference
Aliases: ea
Accepted values: Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue

Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

Параметр ErrorAction переопределяет значение $ErrorActionPreference переменной для текущей команды.The ErrorAction parameter overrides the value of the $ErrorActionPreference variable for the current command. Так как значение переменной по умолчанию $ErrorActionPreference продолжится, отображаются сообщения об ошибках и выполнение продолжается, если не используется параметр ErrorAction .Because the default value of the $ErrorActionPreference variable is Continue, error messages are displayed and execution continues unless you use the ErrorAction parameter.

Параметр ErrorAction не влияет на завершающие ошибки (такие как отсутствующие данные, недопустимые параметры или недостаточные разрешения), препятствующие успешному выполнению команды.The ErrorAction parameter has no effect on terminating errors (such as missing data, parameters that aren't valid, or insufficient permissions) that prevent a command from completing successfully.

-ErrorAction:Continue Отобразите сообщение об ошибке и продолжит выполнение команды.-ErrorAction:Continue display the error message and continues executing the command. Значение по умолчанию — Continue.Continue is the default.

-ErrorAction:Ignore Подавляет сообщение об ошибке и возобновляет выполнение команды.-ErrorAction:Ignore suppresses the error message and continues executing the command. В отличие от SilentlyContinue, Ignore не добавляет сообщение об ошибке в $Error автоматическую переменную.Unlike SilentlyContinue, Ignore doesn't add the error message to the $Error automatic variable. Значение Ignore введено в PowerShell 3,0.The Ignore value is introduced in PowerShell 3.0.

-ErrorAction:Inquire Отображает сообщение об ошибке и запрашивает подтверждение перед продолжением выполнения.-ErrorAction:Inquire displays the error message and prompts you for confirmation before continuing execution. Это значение используется редко.This value is rarely used.

-ErrorAction:SilentlyContinue Подавляет сообщение об ошибке и возобновляет выполнение команды.-ErrorAction:SilentlyContinue suppresses the error message and continues executing the command.

-ErrorAction:Stop Отображает сообщение об ошибке и останавливает выполнение команды.-ErrorAction:Stop displays the error message and stops executing the command.

-ErrorAction:Suspend доступно только для рабочих процессов, которые не поддерживаются в PowerShell 6 и более поздних версиях.-ErrorAction:Suspend is only available for workflows which aren't supported in PowerShell 6 and beyond.

Примечание

Параметр ErrorAction переопределяет, но не заменяет значение $ErrorAction привилегированной переменной, если параметр используется в команде для выполнения скрипта или функции.The ErrorAction parameter overrides, but does not replace the value of the $ErrorAction preference variable when the parameter is used in a command to run a script or function.

ErrorVariableErrorVariable

ErrorVariable хранит сообщения об ошибках команды в указанной переменной и в $Error автоматической переменной.ErrorVariable stores error messages about the command in the specified variable and in the $Error automatic variable. Дополнительные сведения см. в разделе about_Automatic_VariablesFor more information, see about_Automatic_Variables

Type: String
Aliases: ev

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

По умолчанию новые сообщения об ошибках переписывают сообщения об ошибках, которые уже хранятся в переменной.By default, new error messages overwrite error messages that are already stored in the variable. Чтобы добавить сообщение об ошибке в содержимое переменной, введите знак плюс ( + ) перед именем переменной.To append the error message to the variable content, type a plus sign (+) before the variable name.

Например, следующая команда создает $a переменную, а затем сохраняет в ней ошибки:For example, the following command creates the $a variable and then stores any errors in it:

Get-Process -Id 6 -ErrorVariable a

Следующая команда добавляет любые сообщения об ошибках в $a переменную:The following command adds any error messages to the $a variable:

Get-Process -Id 2 -ErrorVariable +a

Следующая команда отображает содержимое $a :The following command displays the contents of $a:

$a

Этот параметр можно использовать для создания переменной, которая содержит только сообщения об ошибках из конкретных команд и не влияет на поведение $Error автоматической переменной.You can use this parameter to create a variable that contains only error messages from specific commands and does not affect the behavior of the $Error automatic variable. $ErrorАвтоматическая переменная содержит сообщения об ошибках всех команд в сеансе.The $Error automatic variable contains error messages from all the commands in the session. Можно использовать нотацию массива, например $a[0] или, $error[1,2] для обращения к конкретным ошибкам, хранящимся в переменных.You can use array notation, such as $a[0] or $error[1,2] to refer to specific errors stored in the variables.

Примечание

Пользовательская переменная ошибки содержит все ошибки, сформированные командой, включая ошибки вызовов вложенных функций или скриптов.The custom error variable contains all errors generated by the command, including errors from calls to nested functions or scripts.

InformationActionInformationAction

Представлено в PowerShell 5,0.Introduced in PowerShell 5.0. В команде или сценарии, в которой они используются, общий параметр InformationAction переопределяет значение $InformationPreference привилегированной переменной, которая по умолчанию имеет значение SilentlyContinue.Within the command or script in which it's used, the InformationAction common parameter overrides the value of the $InformationPreference preference variable, which by default is set to SilentlyContinue. При использовании Write-Information в скрипте с InformationAction Write-Information значения отображаются в зависимости от значения параметра InformationAction .When you use Write-Information in a script with InformationAction, Write-Information values are shown depending on the value of the InformationAction parameter. Дополнительные сведения о $InformationPreference см. в разделе about_Preference_Variables.For more information about $InformationPreference, see about_Preference_Variables.

Type: ActionPreference
Aliases: ia
Accepted values: Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue

Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

-InformationAction:Stop Останавливает команду или скрипт при возникновении Write-Information команды.-InformationAction:Stop stops a command or script at an occurrence of the Write-Information command.

-InformationAction:Ignore подавляет информационное сообщение и возобновляет выполнение команды.-InformationAction:Ignore suppresses the informational message and continues running the command. В отличие от SilentlyContinue, Ignore полностью забыл информационное сообщение. оно не добавляет информационное сообщение в информационный поток.Unlike SilentlyContinue, Ignore completely forgets the informational message; it doesn't add the informational message to the information stream.

-InformationAction:Inquire отображает информационное сообщение, указанное в Write-Information команде, а затем спрашивает, нужно ли продолжить.-InformationAction:Inquire displays the informational message that you specify in a Write-Information command, then asks whether you want to continue.

-InformationAction:Continue отображает информационное сообщение и продолжит выполнение.-InformationAction:Continue displays the informational message, and continues running.

-InformationAction:Suspend не поддерживается в PowerShell Core, так как он доступен только для рабочих процессов.-InformationAction:Suspend isn't supported on PowerShell Core as it is only available for workflows.

-InformationAction:SilentlyContinue не действует, так как информационное сообщение не отображается (по умолчанию), и сценарий продолжается без прерывания.-InformationAction:SilentlyContinue no effect as the informational message aren't (Default) displayed, and the script continues without interruption.

Примечание

Параметр InformationAction переопределяет, но не заменяет значение $InformationAction привилегированной переменной, если параметр используется в команде для выполнения скрипта или функции.The InformationAction parameter overrides, but does not replace the value of the $InformationAction preference variable when the parameter is used in a command to run a script or function.

InformationVariableInformationVariable

Представлено в PowerShell 5,0.Introduced in PowerShell 5.0. В команде или сценарии, в которой они используются, общий параметр InformationVariable сохраняет в переменной строку, указанную путем добавления Write-Information команды.Within the command or script in which it's used, the InformationVariable common parameter stores in a variable a string that you specify by adding the Write-Information command. Write-Information значения отображаются в зависимости от значения общего параметра InformationAction . Если не добавить общий параметр InformationAction , Write-Information строки будут показаны в зависимости от значения $InformationPreference привилегированной переменной.Write-Information values are shown depending on the value of the InformationAction common parameter; if you don't add the InformationAction common parameter, Write-Information strings are shown depending on the value of the $InformationPreference preference variable. Дополнительные сведения о $InformationPreference см. в разделе about_Preference_Variables.For more information about $InformationPreference, see about_Preference_Variables.

Примечание

Информационная переменная содержит все информационные сообщения, созданные командой, включая информационные сообщения от вызовов вложенных функций или скриптов.The information variable contains all information messages generated by the command, including information messages from calls to nested functions or scripts.

Type: String
Aliases: iv

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

OutBufferOutBuffer

Определяет количество объектов, которые должны накапливаться в буфере перед отправкой объектов через конвейер.Determines the number of objects to accumulate in a buffer before any objects are sent through the pipeline. Если опустить этот параметр, то объекты будут отправляться по мере их создания.If you omit this parameter, objects are sent as they're generated.

Type: Int32
Aliases: ob

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Этот параметр управления ресурсами предназначен для опытных пользователей.This resource management parameter is designed for advanced users. При использовании этого параметра PowerShell отправляет данные в следующий командлет в пакетах OutBuffer + 1 .When you use this parameter, PowerShell sends data to the next cmdlet in batches of OutBuffer + 1.

В следующем примере в качестве альтернативы отображаются ForEach-Object блоки Process, использующие Write-Host командлет.The following example alternates displays between to ForEach-Object process blocks that use the Write-Host cmdlet. Отображаемые варианты в пакетах — 2 или OutBuffer + 1 .The display alternates in batches of 2 or OutBuffer + 1.

1..4 | ForEach-Object {
        Write-Host "$($_): First"; $_
      } -OutBuffer 1 | ForEach-Object {
                        Write-Host "$($_): Second" }
1: First
2: First
1: Second
2: Second
3: First
4: First
3: Second
4: Second

OutVariableOutVariable

Сохраняет выходные объекты из команды в указанной переменной в дополнение к отправке выходных данных в конвейере.Stores output objects from the command in the specified variable in addition to sending the output along the pipeline.

Type: String
Aliases: ov

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Чтобы добавить выходные данные в переменную, вместо того, чтобы заменять выходные данные, которые могут быть уже сохранены, введите знак плюса ( + ) перед именем переменной.To add the output to the variable, instead of replacing any output that might already be stored there, type a plus sign (+) before the variable name.

Например, следующая команда создает $out переменную и сохраняет в ней объект Process:For example, the following command creates the $out variable and stores the process object in it:

Get-Process PowerShell -OutVariable out

Следующая команда добавляет объект Process в $out переменную:The following command adds the process object to the $out variable:

Get-Process iexplore -OutVariable +out

Следующая команда отображает содержимое $out переменной:The following command displays the contents of the $out variable:

$out

Примечание

Переменная, созданная параметром переменной , имеет значение [System.Collections.ArrayList] .The variable created by the OutVariable parameter is a [System.Collections.ArrayList].

PipelineVariablePipelineVariable

PipelineVariable сохраняет значение текущего конвейера как переменную для любой именованной команды в том виде, в каком она проходит через конвейер.PipelineVariable stores the value of the current pipeline element as a variable, for any named command as it flows through the pipeline.

Примечание

Расширенные функции могут иметь до трех блоков Script: begin , process и end .Advanced functions can have up to three script blocks: begin, process, and end. При использовании параметра PipelineVariable с расширенными функциями только значения из первого определенного блока скрипта присваиваются переменной при выполнении функции.When using the PipelineVariable parameter with advanced functions, only values from the first defined script block are assigned to the variable as the function runs. Дополнительные сведения см. в разделе Расширенные функции.For more information, see Advanced functions. PowerShell 7,2 исправляет это поведение.PowerShell 7.2 corrects this behavior.

Type: String
Aliases: pv

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Допустимые значения — строки, такие же, как и для имен переменных.Valid values are strings, the same as for any variable names.

Ниже приведен пример того, как работает PipelineVariable .The following is an example of how PipelineVariable works. В этом примере параметр PipelineVariable добавляется в Foreach-Object команду для сохранения результатов выполнения команды в переменных.In this example, the PipelineVariable parameter is added to a Foreach-Object command to store the results of the command in variables. Диапазон чисел от 1 до 10 передается в первую Foreach-Object команду, результаты которых хранятся в переменной с именем Left.A range of numbers, 1 to 10, are piped into the first Foreach-Object command, the results of which are stored in a variable named Left.

Результаты первой Foreach-Object команды передаются во вторую Foreach-Object команду, которая фильтрует объекты, возвращаемые первой Foreach-Object командой.The results of the first Foreach-Object command are piped into a second Foreach-Object command, which filters the objects returned by the first Foreach-Object command. Результаты второй команды хранятся в переменной с именем right.The results of the second command are stored in a variable named Right.

В третьей Foreach-Object команде результаты первых двух Foreach-Object команд, представленных переменными слева и справа, обрабатываются с помощью оператора умножения.In the third Foreach-Object command, the results of the first two Foreach-Object piped commands, represented by the variables Left and Right, are processed by using a multiplication operator. Команда указывает, что необходимо умножить объекты, хранящиеся в левой и правой переменных, и указать, что результаты должны отображаться как «левый диапазон член * правый диапазон Member = продукт».The command instructs objects stored in the Left and Right variables to be multiplied, and specifies that the results should be displayed as "Left range member * Right range member = product".

1..10 | Foreach-Object -PipelineVariable Left -Process { $_ } |
  Foreach-Object -PV Right -Process { 1..10 } |
  Foreach-Object -Process { "$Left * $Right = " + ($Left*$Right) }
1 * 1 = 1
1 * 2 = 2
1 * 3 = 3
1 * 4 = 4
1 * 5 = 5
...

ПодробныйVerbose

Отображает подробные сведения об операции, выполненной командой.Displays detailed information about the operation done by the command. Эти сведения похожи на сведения в трассировке или в журнале транзакций.This information resembles the information in a trace or in a transaction log. Этот параметр работает, только если команда создает подробное сообщение.This parameter works only when the command generates a verbose message. Например, этот параметр работает, если команда содержит Write-Verbose командлет.For example, this parameter works when a command contains the Write-Verbose cmdlet.

Type: SwitchParameter
Aliases: vb

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Параметр verbose переопределяет значение $VerbosePreference переменной для текущей команды.The Verbose parameter overrides the value of the $VerbosePreference variable for the current command. Так как значение переменной по умолчанию $VerbosePreferenceSilentlyContinue, подробные сообщения не отображаются по умолчанию.Because the default value of the $VerbosePreference variable is SilentlyContinue, verbose messages aren't displayed by default.

-Verbose:$true имеет тот же результат, что и -Verbose-Verbose:$true has the same effect as -Verbose

-Verbose:$false подавляет отображение подробных сообщений.-Verbose:$false suppresses the display of verbose messages. Используйте этот параметр, если значение $VerbosePreference не SilentlyContinue (по умолчанию).Use this parameter when the value of $VerbosePreference isn't SilentlyContinue (the default).

WarningActionWarningAction

Определяет реакцию командлета на предупреждение от команды.Determines how the cmdlet responds to a warning from the command. Значение Continue является значением по умолчанию.Continue is the default value. Этот параметр работает, только если команда создает предупреждающее сообщение.This parameter works only when the command generates a warning message. Например, этот параметр работает, если команда содержит Write-Warning командлет.For example, this parameter works when a command contains the Write-Warning cmdlet.

Type: ActionPreference
Aliases: wa
Accepted values: Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue

Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

Параметр WarningAction переопределяет значение $WarningPreference переменной для текущей команды.The WarningAction parameter overrides the value of the $WarningPreference variable for the current command. Так как значение переменной по умолчанию $WarningPreferenceContinue, отображаются предупреждения и выполнение продолжается, если не используется параметр WarningAction .Because the default value of the $WarningPreference variable is Continue, warnings are displayed and execution continues unless you use the WarningAction parameter.

-WarningAction:Continue Отображает предупреждающие сообщения и возобновляет выполнение команды.-WarningAction:Continue displays the warning messages and continues executing the command. Значение по умолчанию — Continue.Continue is the default.

-WarningAction:Inquire отображает предупреждающее сообщение и запрашивает подтверждение перед продолжением выполнения.-WarningAction:Inquire displays the warning message and prompts you for confirmation before continuing execution. Это значение используется редко.This value is rarely used.

-WarningAction:SilentlyContinue подавляет предупреждающее сообщение и возобновляет выполнение команды.-WarningAction:SilentlyContinue suppresses the warning message and continues executing the command.

-WarningAction:Stop отображает предупреждающее сообщение и прекращает выполнение команды.-WarningAction:Stop displays the warning message and stops executing the command.

Примечание

Параметр WarningAction переопределяет, но не заменяет значение $WarningAction привилегированной переменной, если параметр используется в команде для выполнения скрипта или функции.The WarningAction parameter overrides, but does not replace the value of the $WarningAction preference variable when the parameter is used in a command to run a script or function.

WarningVariableWarningVariable

Хранит предупреждения о команде в указанной переменной.Stores warnings about the command in the specified variable.

Type: String
Aliases: wv

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Все созданные предупреждения сохраняются в переменной, даже если они не отображаются для пользователя.All generated warnings are saved in the variable even if the warnings aren't displayed to the user.

Чтобы добавить предупреждения в содержимое переменной, вместо того, чтобы заменять все предупреждения, которые могут быть уже сохранены, введите знак плюс ( + ) перед именем переменной.To append the warnings to the variable content, instead of replacing any warnings that might already be stored there, type a plus sign (+) before the variable name.

Например, следующая команда создает $a переменную, а затем сохраняет в ней все предупреждения:For example, the following command creates the $a variable and then stores any warnings in it:

Get-Process -Id 6 -WarningVariable a

Следующая команда добавляет все предупреждения в $a переменную:The following command adds any warnings to the $a variable:

Get-Process -Id 2 -WarningVariable +a

Следующая команда отображает содержимое $a :The following command displays the contents of $a:

$a

Этот параметр можно использовать для создания переменной, содержащей только предупреждения из конкретных команд.You can use this parameter to create a variable that contains only warnings from specific commands. Можно использовать нотацию массива, например $a[0] или, $warning[1,2] для ссылки на конкретные предупреждения, хранящиеся в переменной.You can use array notation, such as $a[0] or $warning[1,2] to refer to specific warnings stored in the variable.

Примечание

Переменная предупреждения содержит все предупреждения, созданные командой, включая предупреждения о вызовах вложенных функций или скриптов.The warning variable contains all warnings generated by the command, including warnings from calls to nested functions or scripts.

Описания параметров управления рискамиRisk Management Parameter Descriptions

WhatIfWhatIf

Отображает сообщение, описывающее результат выполнения команды, а не выполнение команды.Displays a message that describes the effect of the command, instead of executing the command.

Type: SwitchParameter
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Параметр WhatIf переопределяет значение $WhatIfPreference переменной для текущей команды.The WhatIf parameter overrides the value of the $WhatIfPreference variable for the current command. Так как значение переменной по умолчанию $WhatIfPreference равно 0 (отключено), поведение WhatIf не выполняется без параметра WhatIf .Because the default value of the $WhatIfPreference variable is 0 (disabled), WhatIf behavior isn't done without the WhatIf parameter. Дополнительные сведения см. в разделе about_Preference_VariablesFor more information, see about_Preference_Variables

-WhatIf:$true имеет тот же результат, что и -WhatIf .-WhatIf:$true has the same effect as -WhatIf.

-WhatIf:$false подавляет автоматическое поведение WhatIf, которое возникает, когда значение $WhatIfPreference переменной равно 1.-WhatIf:$false suppresses the automatic WhatIf behavior that results when the value of the $WhatIfPreference variable is 1.

Например, следующая команда использует -WhatIf параметр в Remove-Item команде:For example, the following command uses the -WhatIf parameter in a Remove-Item command:

Remove-Item Date.csv -WhatIf

Вместо удаления элемента в PowerShell перечислены выполняемые операции и элементы, которые были бы затронуты.Instead of removing the item, PowerShell lists the operations it would do and the items that would be affected. Эта команда создает следующие выходные данные:This command produces the following output:

What if: Performing operation "Remove File" on
Target "C:\ps-test\date.csv".

ПодтвердитьConfirm

Выводит приглашение для подтверждения перед выполнением команды.Prompts you for confirmation before executing the command.

Type: SwitchParameter
Aliases: cf

Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

Параметр Confirm переопределяет значение $ConfirmPreference переменной для текущей команды.The Confirm parameter overrides the value of the $ConfirmPreference variable for the current command. Значение по умолчанию — true.The default value is true. Дополнительные сведения см. в разделе about_Preference_VariablesFor more information, see about_Preference_Variables

-Confirm:$true имеет тот же результат, что и -Confirm .-Confirm:$true has the same effect as -Confirm.

-Confirm:$false подавляет автоматическое подтверждение, которое происходит, если значение $ConfirmPreference меньше или равно предполагаемому риску командлета.-Confirm:$false suppresses automatic confirmation, which occurs when the value of $ConfirmPreference is less than or equal to the estimated risk of the cmdlet.

Например, следующая команда использует параметр Confirm с Remove-Item командой.For example, the following command uses the Confirm parameter with a Remove-Item command. Перед удалением элемента в PowerShell будут перечислены выполняемые операции и элементы, которые будут затронуты, и запрашивается утверждение.Before removing the item, PowerShell lists the operations it would do and the items that would be affected, and asks for approval.

PS C:\ps-test> Remove-Item tmp*.txt -Confirm

Confirm
Are you sure you want to perform this action?
Performing operation "Remove File" on Target " C:\ps-test\tmp1.txt
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend
[?] Help (default is "Y"):

Ниже приведены параметры подтверждения ответа.The Confirm response options are as follows:

ОтветResponse РезультатResult
Да (Y)Yes (Y) Выполните действие.Perform the action.
Да для всех (A)Yes to All (A) Выполнение всех действий и подавление последующих запросов на подтверждениеPerform all actions and suppress subsequent Confirm queries
для этой команды.for this command.
Нет (N):No (N): Не выполняйте действие.Do not perform the action.
Нет для всех (L):No to All (L): Не выполнять никаких действий и подавлять последующие подтвержденияDo not perform any actions and suppress subsequent Confirm
запросы для этой команды.queries for this command.
Приостановка:Suspend (S): Приостановите команду и создайте временный сеанс.Pause the command and create a temporary session.
Справка (?)Help (?) Отображает справку по этим параметрам.Display help for these options.

Параметр Suspend помещает команду в удержание и создает временный вложенный сеанс, в котором можно работать, пока вы не будете готовы выбрать параметр подтверждения .The Suspend option places the command on hold and creates a temporary nested session in which you can work until you're ready to choose a Confirm option. Командная строка для вложенного сеанса имеет две дополнительные символы (>>), указывающие, что это дочерняя операция исходной родительской команды.The command prompt for the nested session has two extra carets (>>) to indicate that it's a child operation of the original parent command. Во вложенном сеансе можно выполнять команды и скрипты.You can run commands and scripts in the nested session. Чтобы завершить вложенный сеанс и вернуться к параметрам подтверждения исходной команды, введите "Exit".To end the nested session and return to the Confirm options for the original command, type "exit".

В следующем примере параметры приостановки используются для временной остановки команды, в то время как пользователь проверяет справку для параметра команды.In the following example, the Suspend option (S) is used to halt a command temporarily while the user checks the help for a command parameter. После получения необходимой информации пользователь вводит "Exit" для завершения вложенного запроса, а затем выбирает ответ "Да" (y) для подтверждения запроса.After obtaining the needed information, the user types "exit" to end the nested prompt and then selects the Yes (y) response to the Confirm query.

PS C:\ps-test> New-Item -ItemType File -Name Test.txt -Confirm

Confirm
Are you sure you want to perform this action?

Performing operation "Create File" on Target "Destination:
C:\ps-test\test.txt".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default
is "Y"): s

PS C:\ps-test> Get-Help New-Item -Parameter ItemType

-ItemType <string>
Specifies the provider-specified type of the new item.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       true (ByPropertyName)
Accept wildcard characters?  false

PS C:\ps-test> exit

Confirm
Are you sure you want to perform this action?
Performing operation "Create File" on Target "Destination: C:\ps-test\test
.txt".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (defau
lt is "Y"): y

Directory: C:\ps-test

Mode                LastWriteTime     Length Name
----                -------------     ------ ----
-a---         8/27/2010   2:41 PM          0 test.txt

СЛОВАМИKEYWORDS

about_Common_Parametersabout_Common_Parameters

СМ. ТАКЖЕSEE ALSO

about_Preference_Variablesabout_Preference_Variables

Write-DebugWrite-Debug

Write-WarningWrite-Warning

Write-ErrorWrite-Error

Write-VerboseWrite-Verbose