Updates from: 05/18/2021 03:10:44
Service Microsoft Docs article Related commit history on GitHub Change details
Microsoft.PowerShell.Core About Commonparameters (5.1) https://github.com/MicrosoftDocs/PowerShell-Docs/commits/staging/reference/5.1/Microsoft.PowerShell.Core/About/about_CommonParameters.md
---
-description: Describes the parameters that can be used with any cmdlet.
-keywords: powershell,cmdlet
+description: Describes the parameters that can be used with any cmdlet.
Locale: en-US Previously updated : 05/11/2021 Last updated : 05/17/2021
+no-loc: [Debug, Verbose, Confirm]
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 Title: about_CommonParameters --- # About CommonParameters
-## SHORT DESCRIPTION
+## Short description
Describes the parameters that can be used with any cmdlet.
-## LONG DESCRIPTION
+## Long description
The common parameters are a set of cmdlet parameters that you can use with any cmdlet. They're implemented by PowerShell, not by the cmdlet developer, and
The risk mitigation parameters are:
- **WhatIf** (wi) - **Confirm** (cf)
-### COMMON PARAMETER DESCRIPTIONS
+## Common parameter descriptions
-#### Debug
+### -Debug
Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message. For
In non-interactive mode, the **Debug** parameter overrides the value of the
suppress the display of debugging messages when `$DebugPreference` isn't **SilentlyContinue**, which is the default.
-#### ErrorAction
+### -ErrorAction
Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error,
in PowerShell 6 and beyond.
> the `$ErrorAction` preference variable when the parameter is used in a > command to run a script or function.
-#### ErrorVariable
+### -ErrorVariable
**ErrorVariable** stores error messages about the command in the specified variable and in the `$Error` automatic variable. For more information, see
variables.
> The custom error variable contains all errors generated by the command, > including errors from calls to nested functions or scripts.
-#### InformationAction
+### -InformationAction
Introduced in PowerShell 5.0. Within the command or script in which it's used, the **InformationAction** common parameter overrides the value of the
aren't (Default) displayed, and the script continues without interruption.
> value of the `$InformationAction` preference variable when the parameter > is used in a command to run a script or function.
-#### InformationVariable
+### -InformationVariable
Introduced in PowerShell 5.0. Within the command or script in which it's used, the **InformationVariable** common parameter stores in a variable a string that
Accept pipeline input: False
Accept wildcard characters: False ```
-#### OutBuffer
+### -OutBuffer
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
blocks that use the `Write-Host` cmdlet. The display alternates in batches of
4: Second ```
-#### OutVariable
+### -OutVariable
Stores output objects from the command in the specified variable in addition to sending the output along the pipeline.
$out
> The variable created by the **OutVariable** parameter is a > `[System.Collections.ArrayList]`.
-#### PipelineVariable
+### -PipelineVariable
**PipelineVariable** stores the value of the current pipeline element as a variable, for any named command as it flows through the pipeline.
range member = product".
... ```
-#### Verbose
+### -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
displayed by default.
when the value of `$VerbosePreference` isn't **SilentlyContinue** (the default).
-#### WarningAction
+### -WarningAction
Determines how the cmdlet responds to a warning from the command. **Continue** is the default value. This parameter works only when the command generates a
command.
> the `$WarningAction` preference variable when the parameter is used in a > command to run a script or function.
-#### WarningVariable
+### -WarningVariable
Stores warnings about the command in the specified variable.
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
+## Risk Management Parameter Descriptions
-#### WhatIf
+### -WhatIf
Displays a message that describes the effect of the command, instead of executing the command.
What if: Performing operation "Remove File" on
Target "C:\ps-test\date.csv". ```
-#### Confirm
+### -Confirm
Prompts you for confirmation before executing the command.
Mode LastWriteTime Length Name
-a--- 8/27/2010 2:41 PM 0 test.txt ```
-## KEYWORDS
+## Keywords
about_Common_Parameters
-## SEE ALSO
+## See also
[about_Preference_Variables](about_Preference_Variables.md)
Microsoft.PowerShell.Core About Commonparameters (7.0) https://github.com/MicrosoftDocs/PowerShell-Docs/commits/staging/reference/7.0/Microsoft.PowerShell.Core/About/about_CommonParameters.md
---
-description: Describes the parameters that can be used with any cmdlet.
-keywords: powershell,cmdlet
+description: Describes the parameters that can be used with any cmdlet.
Locale: en-US Previously updated : 05/11/2021 Last updated : 05/17/2021
+no-loc: [Debug, Verbose, Confirm]
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7&WT.mc_id=ps-gethelp schema: 2.0.0 Title: about_CommonParameters --- # About CommonParameters
-## SHORT DESCRIPTION
+## Short description
Describes the parameters that can be used with any cmdlet.
-## LONG DESCRIPTION
+## Long description
The common parameters are a set of cmdlet parameters that you can use with any cmdlet. They're implemented by PowerShell, not by the cmdlet developer, and
The risk mitigation parameters are:
- **WhatIf** (wi) - **Confirm** (cf)
-### COMMON PARAMETER DESCRIPTIONS
+## Common parameter descriptions
-#### Debug
+### -Debug
Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message. For
In non-interactive mode, the **Debug** parameter overrides the value of the
suppress the display of debugging messages when `$DebugPreference` isn't **SilentlyContinue**, which is the default.
-#### ErrorAction
+### -ErrorAction
Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error,
in PowerShell 6 and beyond.
> the `$ErrorAction` preference variable when the parameter is used in a > command to run a script or function.
-#### ErrorVariable
+### -ErrorVariable
**ErrorVariable** stores error messages about the command in the specified variable and in the `$Error` automatic variable. For more information, see
variables.
> The custom error variable contains all errors generated by the command, > including errors from calls to nested functions or scripts.
-#### InformationAction
+### -InformationAction
Introduced in PowerShell 5.0. Within the command or script in which it's used, the **InformationAction** common parameter overrides the value of the
aren't (Default) displayed, and the script continues without interruption.
> value of the `$InformationAction` preference variable when the parameter > is used in a command to run a script or function.
-#### InformationVariable
+### -InformationVariable
Introduced in PowerShell 5.0. Within the command or script in which it's used, the **InformationVariable** common parameter stores in a variable a string that
Accept pipeline input: False
Accept wildcard characters: False ```
-#### OutBuffer
+### -OutBuffer
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
blocks that use the `Write-Host` cmdlet. The display alternates in batches of
4: Second ```
-#### OutVariable
+### -OutVariable
Stores output objects from the command in the specified variable in addition to sending the output along the pipeline.
$out
> The variable created by the **OutVariable** parameter is a > `[System.Collections.ArrayList]`.
-#### PipelineVariable
+### -PipelineVariable
**PipelineVariable** stores the value of the current pipeline element as a variable, for any named command as it flows through the pipeline.
range member = product".
... ```
-#### Verbose
+### -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
displayed by default.
when the value of `$VerbosePreference` isn't **SilentlyContinue** (the default).
-#### WarningAction
+### -WarningAction
Determines how the cmdlet responds to a warning from the command. **Continue** is the default value. This parameter works only when the command generates a
command.
> the `$WarningAction` preference variable when the parameter is used in a > command to run a script or function.
-#### WarningVariable
+### -WarningVariable
Stores warnings about the command in the specified variable.
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
+## Risk Management Parameter Descriptions
-#### WhatIf
+### -WhatIf
Displays a message that describes the effect of the command, instead of executing the command.
What if: Performing operation "Remove File" on
Target "C:\ps-test\date.csv". ```
-#### Confirm
+### -Confirm
Prompts you for confirmation before executing the command.
Mode LastWriteTime Length Name
-a--- 8/27/2010 2:41 PM 0 test.txt ```
-## KEYWORDS
+## Keywords
about_Common_Parameters
-## SEE ALSO
+## See also
[about_Preference_Variables](about_Preference_Variables.md)
Microsoft.PowerShell.Core About Commonparameters (7.1) https://github.com/MicrosoftDocs/PowerShell-Docs/commits/staging/reference/7.1/Microsoft.PowerShell.Core/About/about_CommonParameters.md
---
-description: Describes the parameters that can be used with any cmdlet.
-keywords: powershell,cmdlet
+description: Describes the parameters that can be used with any cmdlet.
Locale: en-US Previously updated : 05/11/2021 Last updated : 05/17/2021
+no-loc: [Debug, Verbose, Confirm]
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.1&WT.mc_id=ps-gethelp schema: 2.0.0 Title: about_CommonParameters --- # About CommonParameters
-## SHORT DESCRIPTION
+## Short description
Describes the parameters that can be used with any cmdlet.
-## LONG DESCRIPTION
+## Long description
The common parameters are a set of cmdlet parameters that you can use with any cmdlet. They're implemented by PowerShell, not by the cmdlet developer, and
The risk mitigation parameters are:
- **WhatIf** (wi) - **Confirm** (cf)
-### COMMON PARAMETER DESCRIPTIONS
+## Common parameter descriptions
-#### Debug
+### -Debug
Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message. For
In non-interactive mode, the **Debug** parameter overrides the value of the
suppress the display of debugging messages when `$DebugPreference` isn't **SilentlyContinue**, which is the default.
-#### ErrorAction
+### -ErrorAction
Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error,
in PowerShell 6 and beyond.
> the `$ErrorAction` preference variable when the parameter is used in a > command to run a script or function.
-#### ErrorVariable
+### -ErrorVariable
**ErrorVariable** stores error messages about the command in the specified variable and in the `$Error` automatic variable. For more information, see
variables.
> The custom error variable contains all errors generated by the command, > including errors from calls to nested functions or scripts.
-#### InformationAction
+### -InformationAction
Introduced in PowerShell 5.0. Within the command or script in which it's used, the **InformationAction** common parameter overrides the value of the
aren't (Default) displayed, and the script continues without interruption.
> value of the `$InformationAction` preference variable when the parameter > is used in a command to run a script or function.
-#### InformationVariable
+### -InformationVariable
Introduced in PowerShell 5.0. Within the command or script in which it's used, the **InformationVariable** common parameter stores in a variable a string that
Accept pipeline input: False
Accept wildcard characters: False ```
-#### OutBuffer
+### -OutBuffer
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
blocks that use the `Write-Host` cmdlet. The display alternates in batches of
4: Second ```
-#### OutVariable
+### -OutVariable
Stores output objects from the command in the specified variable in addition to sending the output along the pipeline.
$out
> The variable created by the **OutVariable** parameter is a > `[System.Collections.ArrayList]`.
-#### PipelineVariable
+### -PipelineVariable
**PipelineVariable** stores the value of the current pipeline element as a variable, for any named command as it flows through the pipeline.
range member = product".
... ```
-#### Verbose
+### -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
displayed by default.
when the value of `$VerbosePreference` isn't **SilentlyContinue** (the default).
-#### WarningAction
+### -WarningAction
Determines how the cmdlet responds to a warning from the command. **Continue** is the default value. This parameter works only when the command generates a
command.
> the `$WarningAction` preference variable when the parameter is used in a > command to run a script or function.
-#### WarningVariable
+### -WarningVariable
Stores warnings about the command in the specified variable.
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
+## Risk Management Parameter Descriptions
-#### WhatIf
+### -WhatIf
Displays a message that describes the effect of the command, instead of executing the command.
What if: Performing operation "Remove File" on
Target "C:\ps-test\date.csv". ```
-#### Confirm
+### -Confirm
Prompts you for confirmation before executing the command.
Mode LastWriteTime Length Name
-a--- 8/27/2010 2:41 PM 0 test.txt ```
-## KEYWORDS
+## Keywords
about_Common_Parameters
-## SEE ALSO
+## See also
[about_Preference_Variables](about_Preference_Variables.md)
about_Common_Parameters
[Write-Error](xref:Microsoft.PowerShell.Utility.Write-Error) [Write-Verbose](xref:Microsoft.PowerShell.Utility.Write-Verbose)-
Microsoft.PowerShell.Core About Commonparameters (7.2) https://github.com/MicrosoftDocs/PowerShell-Docs/commits/staging/reference/7.2/Microsoft.PowerShell.Core/About/about_CommonParameters.md
--- description: Describes the parameters that can be used with any cmdlet. Locale: en-US Previously updated : 05/11/2021 Last updated : 05/17/2021
+no-loc: [Debug, Verbose, Confirm]
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7.2&WT.mc_id=ps-gethelp schema: 2.0.0 Title: about_CommonParameters --- # About CommonParameters
-## SHORT DESCRIPTION
+## Short description
Describes the parameters that can be used with any cmdlet.
-## LONG DESCRIPTION
+## Long description
The common parameters are a set of cmdlet parameters that you can use with any cmdlet. They're implemented by PowerShell, not by the cmdlet developer, and
The risk mitigation parameters are:
- **WhatIf** (wi) - **Confirm** (cf)
-### COMMON PARAMETER DESCRIPTIONS
+## Common parameter descriptions
-#### Debug
+### -Debug
Displays programmer-level detail about the operation done by the command. This parameter works only when the command generates a debugging message. For
In non-interactive mode, the **Debug** parameter overrides the value of the
suppress the display of debugging messages when `$DebugPreference` isn't **SilentlyContinue**, which is the default.
-#### ErrorAction
+### -ErrorAction
Determines how the cmdlet responds to a non-terminating error from the command. This parameter works only when the command generates a non-terminating error,
in PowerShell 6 and beyond.
> the `$ErrorAction` preference variable when the parameter is used in a > command to run a script or function.
-#### ErrorVariable
+### -ErrorVariable
**ErrorVariable** stores error messages about the command in the specified variable and in the `$Error` automatic variable. For more information, see
variables.
> The custom error variable contains all errors generated by the command, > including errors from calls to nested functions or scripts.
-#### InformationAction
+### -InformationAction
Introduced in PowerShell 5.0. Within the command or script in which it's used, the **InformationAction** common parameter overrides the value of the
aren't (Default) displayed, and the script continues without interruption.
> value of the `$InformationAction` preference variable when the parameter > is used in a command to run a script or function.
-#### InformationVariable
+### -InformationVariable
Introduced in PowerShell 5.0. Within the command or script in which it's used, the **InformationVariable** common parameter stores in a variable a string that
Accept pipeline input: False
Accept wildcard characters: False ```
-#### OutBuffer
+### -OutBuffer
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
blocks that use the `Write-Host` cmdlet. The display alternates in batches of
4: Second ```
-#### OutVariable
+### -OutVariable
Stores output objects from the command in the specified variable in addition to sending the output along the pipeline.
$out
> The variable created by the **OutVariable** parameter is a > `[System.Collections.ArrayList]`.
-#### PipelineVariable
+### -PipelineVariable
**PipelineVariable** stores the value of the current pipeline element as a variable, for any named command as it flows through the pipeline.
+>[!NOTE]
+> Advanced functions can have up to three script blocks: `begin`, `process`,
+> and `end`. 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](./about_functions_advanced.md).
+> PowerShell 7.2 corrects this behavior.
+ ```yaml Type: String Aliases: pv
range member = product".
... ```
-#### Verbose
+### -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
displayed by default.
when the value of `$VerbosePreference` isn't **SilentlyContinue** (the default).
-#### WarningAction
+### -WarningAction
Determines how the cmdlet responds to a warning from the command. **Continue** is the default value. This parameter works only when the command generates a
command.
> the `$WarningAction` preference variable when the parameter is used in a > command to run a script or function.
-#### WarningVariable
+### -WarningVariable
Stores warnings about the command in the specified variable.
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
+## Risk Management Parameter Descriptions
-#### WhatIf
+### -WhatIf
Displays a message that describes the effect of the command, instead of executing the command.
What if: Performing operation "Remove File" on
Target "C:\ps-test\date.csv". ```
-#### Confirm
+### -Confirm
Prompts you for confirmation before executing the command.
Mode LastWriteTime Length Name
-a--- 8/27/2010 2:41 PM 0 test.txt ```
-## KEYWORDS
+## Keywords
about_Common_Parameters
-## SEE ALSO
+## See also
[about_Preference_Variables](about_Preference_Variables.md)
about_Common_Parameters
[Write-Error](xref:Microsoft.PowerShell.Utility.Write-Error) [Write-Verbose](xref:Microsoft.PowerShell.Utility.Write-Verbose)-
Microsoft.PowerShell.Management Get Childitem (7.2) https://github.com/MicrosoftDocs/PowerShell-Docs/commits/staging/reference/7.2/Microsoft.PowerShell.Management/Get-ChildItem.md
the **Directory** property. You can use the **Recurse** parameter with **Directo
```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All)
-Aliases: ad, d
+Aliases: ad
Required: False Position: Named
Microsoft.PowerShell.Utility Convertto Json (7.2) https://github.com/MicrosoftDocs/PowerShell-Docs/commits/staging/reference/7.2/Microsoft.PowerShell.Utility/ConvertTo-Json.md
Accept wildcard characters: False
### -Depth Specifies how many levels of contained objects are included in the JSON representation. The value
-can be any number from `1` to `100`. The default value is `2`. `ConvertTo-Json` emits a
+can be any number from `0` to `100`. The default value is `2`. `ConvertTo-Json` emits a
warning if the number of levels in an input object exceeds this number. ```yaml