diff --git a/.markdownlint.yaml b/.markdownlint.yaml index a4f702224847..99e42414b5d0 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -122,7 +122,8 @@ MD054: # link-image-style inline: true shortcut: false url_inline: true -MD055: leading_and_trailing # table-pipe-style +MD055: # table-pipe-style + style: leading_and_trailing MD056: true # table-column-count # MD057 # undefined MD058: true # blanks-around-tables diff --git a/.vscode/cspell/psdocs/dictionaries/psdocs.txt b/.vscode/cspell/psdocs/dictionaries/psdocs.txt index 42ff0a813ed6..075b049c38c7 100644 --- a/.vscode/cspell/psdocs/dictionaries/psdocs.txt +++ b/.vscode/cspell/psdocs/dictionaries/psdocs.txt @@ -12,6 +12,7 @@ autogenerated autogenerates autoload autoloaded +autoloading autoloads autosave autosaved @@ -36,6 +37,7 @@ callstack carmonm ccontains CentOS +Certmgr cheatsheet cheatsheets checkboxes @@ -43,6 +45,7 @@ cimv2 clike cmatch cmdlet +cmdletbinding cmdlets cnotcontains cnotlike @@ -57,10 +60,12 @@ coreclr CoreOS CredSSP creplace +cscript customizations DACL datacenter datacenters +DCOM Debian deserialization deserialize @@ -94,6 +99,7 @@ frontmatter glob globbing globs +gpedit GUID hardlink hashtable @@ -147,6 +153,7 @@ notmatch nslookup NTFS NTLM +ntoskrnl nuget nupkg onboarding @@ -154,7 +161,9 @@ openpublishing openSUSE pageable parameterless +PassThru PATHEXT +pbpaste pltfrm POSIX PowerShell @@ -168,6 +177,7 @@ prerelease prereleases psadapted psbase +pscredential pscustomobject PSES psextended @@ -196,6 +206,7 @@ remoting reparse RHEL RIPEMD160 +robocopy runbook runbooks runspace @@ -226,6 +237,7 @@ Snover SPACEBAR Sqlcmd SQLPS +SQLSERVER stepover struct subcontainer @@ -233,7 +245,6 @@ subcontainers subexpression subexpressions subfolder -subfolder subfolders subkey subkeys @@ -250,6 +261,7 @@ taskbar timespan Titlecase TMPDIR +Traceroute triaged Ubuntu UMCI @@ -272,6 +284,7 @@ unregistering unregisters untrusted updateable +UPDATECHECK USERMODE USERROLE userspace @@ -285,4 +298,6 @@ WinCompat wmicimv2 workgroup workgroups +wscript wwwroot +xclip diff --git a/reference/5.1/CimCmdlets/Set-CimInstance.md b/reference/5.1/CimCmdlets/Set-CimInstance.md index ab6c1f1eb04c..9da90b0b89ac 100644 --- a/reference/5.1/CimCmdlets/Set-CimInstance.md +++ b/reference/5.1/CimCmdlets/Set-CimInstance.md @@ -100,14 +100,14 @@ Set-CimInstance -InputObject $x -Property @{VariableValue="somevalue"} -PassThru This example retrieves the CIM instance objects filtered by the Query parameter in to a variable `$x` using `Get-CimInstance`, and then passes the contents of the variable to the `Set-CimInstance` cmdlet. `Set-CimInstance` then modifies the **VariableValue** property to **somevalue**. Because the -**Passthru** parameter is used, This example returns a modified CIM instance object. +**PassThru** parameter is used, This example returns a modified CIM instance object. ### Example 4: Set the CIM instance property This example retrieves the CIM instance object that is specified in the **Query** parameter into a variable `$x` using the `Get-CimInstance` cmdlet, and changes the **VariableValue** property value of the object to change. The CIM instance object is then saved using the `Set-CimInstance` cmdlet. -Because the **Passthru** parameter is used, This example returns a modified CIM instance object. +Because the **PassThru** parameter is used, This example returns a modified CIM instance object. ```powershell $x = Get-CimInstance -Query 'Select * from Win32_Environment where name="testvar"' @@ -138,7 +138,7 @@ Set-CimInstance -Query 'Select * from Win32_Environment where name LIKE "testvar This example creates a CIM instance with the specified properties using the `New-CimInstance` cmdlet, and retrieves its contents in to a variable `$x`. The variable is then passed to the `Set-CimInstance` cmdlet, which modifies the value of **VariableValue** property to **somevalue**. -Because the **Passthru** parameter is used, This example returns a modified CIM instance object. +Because the **PassThru** parameter is used, This example returns a modified CIM instance object. ```powershell $x = New-CimInstance -ClassName Win32_Environment -Property @{Name="testvar";UserName="domain\user"} -Key Name,UserName -ClientOnly @@ -409,7 +409,7 @@ By default, this cmdlet returns no output. ### Microsoft.Management.Infrastructure.CimInstance -When you use the **Passthru** parameter, this cmdlet returns the modified CIM instance object. +When you use the **PassThru** parameter, this cmdlet returns the modified CIM instance object. ## NOTES diff --git a/reference/5.1/Microsoft.PowerShell.Core/About/About.md b/reference/5.1/Microsoft.PowerShell.Core/About/About.md index 4b57ad7beafa..8258ca1cefb7 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/About/About.md +++ b/reference/5.1/Microsoft.PowerShell.Core/About/About.md @@ -2,7 +2,7 @@ description: About topics cover a range of concepts about PowerShell. Help Version: 6.0 Locale: en-US -ms.date: 11/10/2023 +ms.date: 11/06/2024 title: About topics --- # About topics @@ -14,427 +14,591 @@ About topics cover a range of concepts about PowerShell. ## About Topics ### [about_Alias_Provider](about_Alias_Provider.md) + Provides access to the PowerShell aliases and the values that they represent. ### [about_Aliases](about_Aliases.md) + Describes how to use alternate names for cmdlets and commands in PowerShell. ### [about_ANSI_Terminals](about_ANSI_Terminals.md) + Describes the support available for ANSI escape sequences in Windows PowerShell. ### [about_Arithmetic_Operators](about_Arithmetic_Operators.md) + Describes the operators that perform arithmetic in PowerShell. ### [about_Arrays](about_Arrays.md) + Describes arrays, which are data structures designed to store collections of items. ### [about_Assignment_Operators](about_Assignment_Operators.md) + Describes how to use operators to assign values to variables. ### [about_Automatic_Variables](about_Automatic_Variables.md) -Describes variables that store state information for PowerShell. These variables are created and maintained by PowerShell. + +Describes variables that store state information for PowerShell. These variables are created and +maintained by PowerShell. ### [about_Booleans](about_Booleans.md) + Describes how boolean expressions are evaluated. ### [about_Break](about_Break.md) + Describes the `break` statement, which provides a way to exit the current control block. ### [about_Built-in_Functions](about_Built-in_Functions.md) + Describes the built-in functions in PowerShell. ### [about_Calculated_Properties](about_Calculated_Properties.md) -PowerShell provides the ability to dynamically add new properties and alter the formatting of objects output to the pipeline. + +PowerShell provides the ability to dynamically add new properties and alter the formatting of +objects output to the pipeline. ### [about_Case-Sensitivity](about_Case-Sensitivity.md) + PowerShell is as case-insensitive as possible while preserving case. ### [about_Character_Encoding](about_Character_Encoding.md) + Describes how PowerShell uses character encoding for input and output of string data. ### [about_CimSession](about_CimSession.md) + Describes a **CimSession** object and the difference between CIM sessions and PowerShell sessions. ### [about_Classes](about_Classes.md) + Describes how you can use classes to create your own custom types. ### [about_Classes_Constructors](about_Classes_Constructors.md) + Describes how to define constructors for PowerShell classes. ### [about_Classes_Inheritance](about_Classes_Inheritance.md) + Describes how you can define classes that extend other types. ### [about_Classes_Methods](about_Classes_Methods.md) + Describes how to define methods for PowerShell classes. ### [about_Classes_Properties](about_Classes_Properties.md) + Describes how to define properties for PowerShell classes. ### [about_Command_Precedence](about_Command_Precedence.md) + Describes how PowerShell determines which command to run. ### [about_Command_Syntax](about_Command_Syntax.md) + Describes the syntax diagrams that are used in PowerShell. ### [about_Comment_Based_Help](about_Comment_Based_Help.md) + Describes how to write comment-based help topics for functions and scripts. ### [about_CommonParameters](about_CommonParameters.md) + Describes the parameters that can be used with any cmdlet. ### [about_Comparison_Operators](about_Comparison_Operators.md) -The comparison operators in PowerShell can either compare two values or filter elements of a collection against an input value. + +The comparison operators in PowerShell can either compare two values or filter elements of a +collection against an input value. ### [about_Continue](about_Continue.md) -Describes how the `continue` statement immediately returns the program flow to the top of a program loop, a `switch` statement, or a `trap` statement. + +Describes how the `continue` statement immediately returns the program flow to the top of a program +loop, a `switch` statement, or a `trap` statement. ### [about_Core_Commands](about_Core_Commands.md) + Lists the cmdlets that are designed for use with PowerShell providers. ### [about_Data_Files](about_Data_Files.md) + PowerShell data files are used to store arbitrary data using PowerShell syntax. ### [about_Data_Sections](about_Data_Sections.md) + Explains Data sections, which isolate text strings and other read-only data from script logic. ### [about_Debuggers](about_Debuggers.md) + Describes the PowerShell debugger. ### [about_DesiredStateConfiguration](about_DesiredStateConfiguration.md) + Provides a brief introduction to the PowerShell Desired State Configuration (DSC) feature. ### [about_Do](about_Do.md) + Runs a statement list one or more times, subject to a `While` or `Until` condition. ### [about_Enum](about_Enum.md) -The `enum` statement is used to declare an enumeration. An enumeration is a distinct type that consists of a set of named labels called the enumerator list. + +The `enum` statement is used to declare an enumeration. An enumeration is a distinct type that +consists of a set of named labels called the enumerator list. ### [about_Environment_Provider](about_Environment_Provider.md) + Provides access to the Windows environment variables. ### [about_Environment_Variables](about_Environment_Variables.md) + Describes how to access and manage environment variables in PowerShell. ### [about_Eventlogs](about_Eventlogs.md) + This article describes how PowerShell logs events to the Windows Event log. ### [about_Execution_Policies](about_Execution_Policies.md) + Describes the PowerShell execution policies and explains how to manage them. ### [about_FileSystem_Provider](about_FileSystem_Provider.md) + Provides access to files and directories. ### [about_For](about_For.md) + Describes a language command you can use to run statements based on a conditional test. ### [about_Foreach](about_Foreach.md) + Describes a language command you can use to traverse all the items in a collection of items. ### [about_Format.ps1xml](about_Format.ps1xml.md) -The `Format.ps1xml` files in PowerShell define the default display of objects in the PowerShell console. + +The `Format.ps1xml` files in PowerShell define the default display of objects in the PowerShell +console. ### [about_Function_Provider](about_Function_Provider.md) + Provides access to the functions defined in PowerShell. ### [about_Functions_Advanced_Methods](about_Functions_Advanced_Methods.md) -Describes how functions that specify the `CmdletBinding` attribute can use the methods and properties that are available to compiled cmdlets. + +Describes how functions that specify the `CmdletBinding` attribute can use the methods and +properties that are available to compiled cmdlets. ### [about_Functions_Advanced_Parameters](about_Functions_Advanced_Parameters.md) + Explains how to add parameters to advanced functions. ### [about_Functions_Advanced](about_Functions_Advanced.md) + Introduces advanced functions that are a way to create cmdlets using scripts. ### [about_Functions_Argument_Completion](about_Functions_Argument_Completion.md) -Argument completion is a feature of PowerShell that provide hints, enables discovery, and speeds up input entry of argument values. + +Argument completion is a feature of PowerShell that provide hints, enables discovery, and speeds up +input entry of argument values. ### [about_Functions_CmdletBindingAttribute](about_Functions_CmdletBindingAttribute.md) + Describes the attribute that makes a function work like a compiled cmdlet. ### [about_Functions_OutputTypeAttribute](about_Functions_OutputTypeAttribute.md) + Describes an attribute that reports the type of object that the function returns. ### [about_Functions](about_Functions.md) + Describes how to create and use functions in PowerShell. ### [about_Group_Policy_Settings](about_Group_Policy_Settings.md) + Describes the Group Policy settings for Windows PowerShell ### [about_Hash_Tables](about_Hash_Tables.md) + Describes how to create, use, and sort hashtables in PowerShell. ### [about_Hidden](about_Hidden.md) + Describes the `hidden` keyword, which hides class members from default `Get-Member` results. ### [about_History](about_History.md) + Describes how to get and run commands in the command history. ### [about_If](about_If.md) -Describes a language command you can use to run statement lists based on the results of one or more conditional tests. + +Describes a language command you can use to run statement lists based on the results of one or more +conditional tests. ### [about_Intrinsic_Members](about_Intrinsic_Members.md) -Provides information about PowerShell's intrinsic members that are available to all PowerShell objects. + +Provides information about PowerShell's intrinsic members that are available to all PowerShell +objects. ### [about_Job_Details](about_Job_Details.md) + Provides details about background jobs on local and remote computers. ### [about_Jobs](about_Jobs.md) -Provides information about how PowerShell background jobs run a command or expression in the background without interacting with the current session. + +Provides information about how PowerShell background jobs run a command or expression in the +background without interacting with the current session. ### [about_Join](about_Join.md) + Describes how the join operator (-join) combines multiple strings into a single string. ### [about_Language_Keywords](about_Language_Keywords.md) + Describes the keywords in the PowerShell scripting language. ### [about_Language_Modes](about_Language_Modes.md) + Explains language modes and their effect on PowerShell sessions. ### [about_Line_Editing](about_Line_Editing.md) + Describes how to edit commands at the PowerShell command prompt. ### [about_Locations](about_Locations.md) + Describes how to access items from the working location in PowerShell. ### [about_Logging](about_Logging.md) + PowerShell logs internal operations from the engine, providers, and cmdlets. ### [about_Logical_Operators](about_Logical_Operators.md) + Describes the operators that connect statements in PowerShell. ### [about_Member-Access_Enumeration](about_Member-Access_Enumeration.md) + Describes the automatic enumeration of list collection items when using the member-access operator. ### [about_Methods](about_Methods.md) + Describes how to use methods to perform actions on objects in PowerShell. ### [about_Module_Manifests](about_Module_Manifests.md) + Describes the settings and practices for writing module manifest files. ### [about_Modules](about_Modules.md) + Explains how to install, import, and use PowerShell modules. ### [about_Numeric_Literals](about_Numeric_Literals.md) + This article describes the syntax and usage of numeric values in PowerShell. ### [about_Object_Creation](about_Object_Creation.md) + Explains how to create objects in PowerShell. ### [about_Objects](about_Objects.md) + Provides essential information about objects in Windows PowerShell. ### [about_Operator_Precedence](about_Operator_Precedence.md) + Lists the PowerShell operators in precedence order. ### [about_Operators](about_Operators.md) + Describes the operators that are supported by PowerShell. ### [about_Output_Streams](about_Output_Streams.md) + Explains the availability and purpose of output streams in PowerShell. ### [about_PackageManagement](about_PackageManagement.md) + PackageManagement is an aggregator for software package managers. ### [about_Parameter_Sets](about_Parameter_Sets.md) + Describes how to define and use parameter sets in advanced functions. ### [about_Parameters_Default_Values](about_Parameters_Default_Values.md) + Describes how to set custom default values for cmdlet parameters and advanced functions. ### [about_Parameters](about_Parameters.md) + Describes how to work with command parameters in PowerShell. ### [about_Parsing](about_Parsing.md) + Describes how PowerShell parses commands. ### [about_Path_Syntax](about_Path_Syntax.md) + Describes the full and relative path formats in PowerShell. ### [about_Pipelines](about_Pipelines.md) + Combining commands into pipelines in the PowerShell ### [about_PowerShell_exe](about_PowerShell_exe.md) + Explains how to use the `powershell.exe` command-line interface. Displays the command-line parameters and describes the syntax. ### [about_PowerShell_Ise_exe](about_PowerShell_Ise_exe.md) + Explains how to use the PowerShell_Ise.exe command-line tool. ### [about_Preference_Variables](about_Preference_Variables.md) + Variables that customize the behavior of PowerShell. ### [about_Profiles](about_Profiles.md) + Describes how to create and use a PowerShell profile. ### [about_Prompts](about_Prompts.md) + Describes the `Prompt` function and demonstrates how to create a custom `Prompt` function. ### [about_Properties](about_Properties.md) + Describes how to use object properties in PowerShell. ### [about_Providers](about_Providers.md) -Describes how PowerShell providers provide access to data and components that wouldn't otherwise be easily accessible at the command line. The data is presented in a consistent format that resembles a file system drive. + +PowerShell providers provide access to data and components, presented in a consistent format that +resembles a file system drive. ### [about_PSConsoleHostReadLine](about_PSConsoleHostReadLine.md) + Explains how to create a customize how PowerShell reads input at the console prompt. ### [about_PSCustomObject](about_PSCustomObject.md) + Explains the differences between the `[psobject]` and `[pscustomobject]` type accelerators. ### [about_PSItem](about_PSItem.md) + The automatic variable that contains the current object in the pipeline object. ### [about_PSModulePath](about_PSModulePath.md) + This article the purpose and usage of the `$env:PSModulePath` environment variable. ### [about_PSSession_Details](about_PSSession_Details.md) -Provides detailed information about Windows PowerShell sessions and the role they play in remote commands. + +Provides detailed information about PowerShell sessions and the role they play in remote commands. ### [about_PSSessions](about_PSSessions.md) -Describes Windows PowerShell sessions (PSSessions) and explains how to establish a persistent connection to a remote computer. + +Describes PowerShell sessions (PSSessions) and explains how to establish a persistent connection to +a remote computer. ### [about_PSSnapins](about_PSSnapins.md) + Describes Windows PowerShell snap-ins and shows how to use and manage them. ### [about_Quoting_Rules](about_Quoting_Rules.md) + Describes rules for using single and double quotation marks in PowerShell. ### [about_Redirection](about_Redirection.md) + Explains how to redirect output from PowerShell to text files. ### [about_Ref](about_Ref.md) -Describes how to create and use a reference type variable. You can use reference type variables to permit a function to change the value of a variable that is passed to it. + +Describes how to create and use a reference type variable. You can use reference type variables to +permit a function to change the value of a variable that is passed to it. ### [about_Registry_Provider](about_Registry_Provider.md) -Registry + +Describes teh features and functions of the Registry provider. ### [about_Regular_Expressions](about_Regular_Expressions.md) + Describes regular expressions in PowerShell. ### [about_Remote_Disconnected_Sessions](about_Remote_Disconnected_Sessions.md) + Explains how to disconnect and reconnect to a PowerShell Session (PSSession). ### [about_Remote_Jobs](about_Remote_Jobs.md) + Describes how to run jobs on remote computers. ### [about_Remote_Output](about_Remote_Output.md) + Describes how to interpret and format the output of remote commands. ### [about_Remote_Requirements](about_Remote_Requirements.md) -Describes the system requirements and configuration requirements for running remote commands in PowerShell. + +Describes the system requirements and configuration requirements for running remote commands in +PowerShell. ### [about_Remote_Troubleshooting](about_Remote_Troubleshooting.md) + Describes how to troubleshoot remote operations in PowerShell. ### [about_Remote_Variables](about_Remote_Variables.md) + Explains how to use local and remote variables in remote commands. ### [about_Remote](about_Remote.md) + Describes how to run remote commands in PowerShell. ### [about_Requires](about_Requires.md) + Prevents a script from running without the required elements. ### [about_Reserved_Words](about_Reserved_Words.md) -Lists the reserved words that cannot be used as identifiers because they have a special meaning in PowerShell. + +Lists the reserved words that cannot be used as identifiers because they have a special meaning in +PowerShell. ### [about_Return](about_Return.md) + Exits the current scope, which can be a function, script, or script block. ### [about_Run_With_PowerShell](about_Run_With_PowerShell.md) + Explains how to use the "Run with PowerShell" feature to run a script from a file system drive. ### [about_Scopes](about_Scopes.md) + Explains the concept of scope in PowerShell and shows how to set and change the scope of elements. ### [about_Script_Blocks](about_Script_Blocks.md) + Defines what a script block is and explains how to use script blocks in the PowerShell programming language. ### [about_Script_Internationalization](about_Script_Internationalization.md) -Describes the script internationalization features that make it easy for scripts to display messages and instructions to users in their user interface (UI) language. + +Describes the script internationalization features that make it easy for scripts to display messages +and instructions to users in their user interface (UI) language. ### [about_Scripts](about_Scripts.md) + Describes how to run and write scripts in PowerShell. ### [about_Session_Configuration_Files](about_Session_Configuration_Files.md) -Describes session configuration files, which are used in a session configuration (also known as an "endpoint") to define the environment of sessions that use the session configuration. + +Describes session configuration files, which are used in a session configuration (also known as an +"endpoint") to define the environment of sessions that use the session configuration. ### [about_Session_Configurations](about_Session_Configurations.md) -Describes session configurations, which determine the users who can connect to the computer remotely and the commands they can run. + +Describes session configurations, which determine the users who can connect to the computer remotely +and the commands they can run. ### [about_Signing](about_Signing.md) + Explains how to sign scripts so that they comply with the PowerShell execution policies. ### [about_Simplified_Syntax](about_Simplified_Syntax.md) + Describes easier, more natural-language ways of scripting filters for collections of objects. ### [about_Special_Characters](about_Special_Characters.md) -Describes the special character sequences that control how PowerShell interprets the next characters in the sequence. + +Describes the special character sequences that control how PowerShell interprets the next characters +in the sequence. ### [about_Splatting](about_Splatting.md) + Describes how to use splatting to pass parameters to commands in PowerShell. ### [about_Split](about_Split.md) + Explains how to use the Split operator to split one or more strings into substrings. ### [about_Switch](about_Switch.md) + Explains how to use a switch to handle multiple `if` statements. ### [about_Tab_Expansion](about_Tab_Expansion.md) -PowerShell provides completions on input to provide hints, enable discovery, and speed up input entry. Command names, parameter names, argument values and file paths can all be completed by pressing the Tab key. + +PowerShell provides completions on input to provide hints, enable discovery, and speed up input +entry by pressing the Tab key. ### [about_Throw](about_Throw.md) + Describes the `throw` keyword that generates a terminating error. ### [about_Transactions](about_Transactions.md) + Describes how to manage transacted operations in PowerShell. ### [about_Trap](about_Trap.md) + Describes a keyword that handles a terminating error. ### [about_Try_Catch_Finally](about_Try_Catch_Finally.md) + Describes how to use the `try`, `catch`, and `finally` blocks to handle terminating errors. ### [about_Type_Accelerators](about_Type_Accelerators.md) + Describes the Type accelerators available for .NET framework classes ### [about_Type_Operators](about_Type_Operators.md) + Describes the operators that work with Microsoft .NET types. ### [about_Types.ps1xml](about_Types.ps1xml.md) + Explains how to use `Types.ps1xml` files to extend the types of objects that are used in PowerShell. ### [about_Updatable_Help](about_Updatable_Help.md) + Describes the updatable help system in PowerShell. ### [about_Using](about_Using.md) + Allows you to indicate which namespaces are used in the session. ### [about_Variable_Provider](about_Variable_Provider.md) + Variable ### [about_Variables](about_Variables.md) + Describes how variables store values that can be used in PowerShell. ### [about_While](about_While.md) -Describes a language statement that you can use to run a command block based on the results of a conditional test. + +Describes a language statement that you can use to run a command block based on the results of a +conditional test. ### [about_Wildcards](about_Wildcards.md) + Describes how to use wildcard characters in PowerShell. ### [about_Windows_Powershell_5.1](about_Windows_Powershell_5.1.md) + Describes new features that are included in Windows PowerShell 5.1. ### [about_Windows_PowerShell_ISE](about_Windows_PowerShell_ISE.md) + Describes the features and system requirements of Windows PowerShell Integrated Scripting Environment (ISE). ### [about_Windows_RT](about_Windows_RT.md) + Explains limitations of Windows PowerShell 4.0 on Windows RT 8.1. ### [about_WMI_Cmdlets](about_WMI_Cmdlets.md) + Provides background information about Windows Management Instrumentation (WMI) and Windows PowerShell. ### [about_WMI](about_WMI.md) + Windows Management Instrumentation (WMI) uses the Common Information Model (CIM) to represent systems, applications, networks, devices, and other manageable components of the modern enterprise. ### [about_WQL](about_WQL.md) + Describes WMI Query Language (WQL), which can be used to get WMI objects in Windows PowerShell. diff --git a/reference/5.1/Microsoft.PowerShell.Core/Add-History.md b/reference/5.1/Microsoft.PowerShell.Core/Add-History.md index fc0a7abc6be1..44b57f17d9ae 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/Add-History.md +++ b/reference/5.1/Microsoft.PowerShell.Core/Add-History.md @@ -16,7 +16,7 @@ Appends entries to the session history. ## SYNTAX ``` -Add-History [[-InputObject] ] [-Passthru] [] +Add-History [[-InputObject] ] [-PassThru] [] ``` ## DESCRIPTION @@ -138,7 +138,7 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Passthru +### -PassThru Indicates that this cmdlet returns a **HistoryInfo** object for each history entry. By default, this cmdlet does not generate any output. diff --git a/reference/5.1/Microsoft.PowerShell.Core/Add-PSSnapin.md b/reference/5.1/Microsoft.PowerShell.Core/Add-PSSnapin.md index be94622b8e6d..bc4ac92aa355 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/Add-PSSnapin.md +++ b/reference/5.1/Microsoft.PowerShell.Core/Add-PSSnapin.md @@ -46,7 +46,7 @@ This command adds the Microsoft Exchange and Active Directory snap-ins to the cu ### Example 2: Add all the registered snap-ins ```powershell -PS C:\> Get-PSSnapin -Registered | Add-PSSnapin -Passthru +PS C:\> Get-PSSnapin -Registered | Add-PSSnapin -PassThru ``` This command adds all of the registered Windows PowerShell snap-ins to the session. It uses the diff --git a/reference/5.1/Microsoft.PowerShell.Core/Import-Module.md b/reference/5.1/Microsoft.PowerShell.Core/Import-Module.md index 82d9f1492744..3a1631a73763 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/Import-Module.md +++ b/reference/5.1/Microsoft.PowerShell.Core/Import-Module.md @@ -292,7 +292,7 @@ TestCmdlets Script ``` ```powershell -$a = Import-Module -Name Show-Calendar -AsCustomObject -Passthru +$a = Import-Module -Name Show-Calendar -AsCustomObject -PassThru $a | Get-Member ``` diff --git a/reference/5.1/Microsoft.PowerShell.Security/Set-Acl.md b/reference/5.1/Microsoft.PowerShell.Security/Set-Acl.md index 29c26ba521a4..445f31b977f8 100644 --- a/reference/5.1/Microsoft.PowerShell.Security/Set-Acl.md +++ b/reference/5.1/Microsoft.PowerShell.Security/Set-Acl.md @@ -19,14 +19,14 @@ Changes the security descriptor of a specified item, such as a file or a registr ``` Set-Acl [-Path] [-AclObject] [[-CentralAccessPolicy] ] [-ClearCentralAccessPolicy] - [-Passthru] [-Filter ] [-Include ] [-Exclude ] [-WhatIf] [-Confirm] + [-PassThru] [-Filter ] [-Include ] [-Exclude ] [-WhatIf] [-Confirm] [-UseTransaction] [] ``` ### ByInputObject ``` -Set-Acl [-InputObject] [-AclObject] [-Passthru] [-Filter ] [-Include ] +Set-Acl [-InputObject] [-AclObject] [-PassThru] [-Filter ] [-Include ] [-Exclude ] [-WhatIf] [-Confirm] [-UseTransaction] [] ``` @@ -34,7 +34,7 @@ Set-Acl [-InputObject] [-AclObject] [-Passthru] [-Filter [-AclObject] [[-CentralAccessPolicy] ] - [-ClearCentralAccessPolicy] [-Passthru] [-Filter ] [-Include ] [-Exclude ] + [-ClearCentralAccessPolicy] [-PassThru] [-Filter ] [-Include ] [-Exclude ] [-WhatIf] [-Confirm] [-UseTransaction] [] ``` @@ -341,7 +341,7 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Passthru +### -PassThru Returns an object that represents the security descriptor that was changed. By default, this cmdlet does not generate any output. diff --git a/reference/5.1/Microsoft.PowerShell.Utility/Invoke-WebRequest.md b/reference/5.1/Microsoft.PowerShell.Utility/Invoke-WebRequest.md index e60be6dc1538..4a8ffe7689df 100644 --- a/reference/5.1/Microsoft.PowerShell.Utility/Invoke-WebRequest.md +++ b/reference/5.1/Microsoft.PowerShell.Utility/Invoke-WebRequest.md @@ -434,7 +434,7 @@ Specifies the output file for which this cmdlet saves the response body. Enter a If you omit the path, the default is the current location. By default, `Invoke-WebRequest` returns the results to the pipeline. To send the results to a file -and to the pipeline, use the **Passthru** parameter. +and to the pipeline, use the **PassThru** parameter. ```yaml Type: System.String diff --git a/reference/5.1/Microsoft.PowerShell.Utility/Out-GridView.md b/reference/5.1/Microsoft.PowerShell.Utility/Out-GridView.md index 3b0042d09e6e..26ca61cb8108 100644 --- a/reference/5.1/Microsoft.PowerShell.Utility/Out-GridView.md +++ b/reference/5.1/Microsoft.PowerShell.Utility/Out-GridView.md @@ -188,7 +188,7 @@ The values of this parameter determine how many items you can send down the pipe - `Single`. Zero items or one item. Use this value when the next command can take only one input object. - `Multiple`. Zero, one, or many items. Use this value when the next command can take multiple input - objects. This value is equivalent to the **Passthru** parameter. + objects. This value is equivalent to the **PassThru** parameter. This parameter was introduced in Windows PowerShell 3.0. diff --git a/reference/5.1/PSScheduledJob/About/about_Scheduled_Jobs.md b/reference/5.1/PSScheduledJob/About/about_Scheduled_Jobs.md index c0e26c5e07c4..057678279528 100644 --- a/reference/5.1/PSScheduledJob/About/about_Scheduled_Jobs.md +++ b/reference/5.1/PSScheduledJob/About/about_Scheduled_Jobs.md @@ -96,7 +96,7 @@ This example uses the **ContinueIfGoingOnBattery** parameter of the ```powershell Get-ScheduledJob -Name ProcessJob | Set-ScheduledJobOption ` --ContinueIfGoingOnBattery -Passthru +-ContinueIfGoingOnBattery -PassThru ``` ```Output diff --git a/reference/5.1/PSScheduledJob/Disable-ScheduledJob.md b/reference/5.1/PSScheduledJob/Disable-ScheduledJob.md index 3ffae67c5668..a24b0ea8bd43 100644 --- a/reference/5.1/PSScheduledJob/Disable-ScheduledJob.md +++ b/reference/5.1/PSScheduledJob/Disable-ScheduledJob.md @@ -59,7 +59,7 @@ This cmdlet was introduced in Windows PowerShell 3.0. This example disables a scheduled job on the local computer. ```powershell -Disable-ScheduledJob -ID 2 -Passthru +Disable-ScheduledJob -ID 2 -PassThru ``` This command disables the scheduled job with ID 2 on the local computer. @@ -69,7 +69,7 @@ This command disables the scheduled job with ID 2 on the local computer. This example disables all scheduled jobs on the local computer. ```powershell -Get-ScheduledJob | Disable-ScheduledJob -Passthru +Get-ScheduledJob | Disable-ScheduledJob -PassThru ``` ```Output diff --git a/reference/5.1/PSScheduledJob/Enable-ScheduledJob.md b/reference/5.1/PSScheduledJob/Enable-ScheduledJob.md index f0eafdb4dbac..5cb01239dde0 100644 --- a/reference/5.1/PSScheduledJob/Enable-ScheduledJob.md +++ b/reference/5.1/PSScheduledJob/Enable-ScheduledJob.md @@ -57,7 +57,7 @@ This cmdlet was introduced in Windows PowerShell 3.0. This example enables the scheduled job on a local computer. ```powershell -Enable-ScheduledJob -ID 2 -Passthru +Enable-ScheduledJob -ID 2 -PassThru ``` The `Enable-ScheduledJob` command enables the scheduled job with ID 2 on the local computer. The diff --git a/reference/5.1/PSScheduledJob/Set-JobTrigger.md b/reference/5.1/PSScheduledJob/Set-JobTrigger.md index 479ada213773..4e3c5b5f647b 100644 --- a/reference/5.1/PSScheduledJob/Set-JobTrigger.md +++ b/reference/5.1/PSScheduledJob/Set-JobTrigger.md @@ -69,7 +69,7 @@ Id Frequency Time DaysOfWeek Enable ``` ```powershell -Get-JobTrigger -Name "DeployPackage" | Set-JobTrigger -DaysOfWeek "Wednesday", "Sunday" -Passthru +Get-JobTrigger -Name "DeployPackage" | Set-JobTrigger -DaysOfWeek "Wednesday", "Sunday" -PassThru ``` ```Output @@ -85,7 +85,7 @@ Saturdays. The second command uses the `Get-JobTrigger` cmdlet to get the job trigger of the `DeployPackage` scheduled job. A pipeline operator (`|`) sends the trigger to the `Set-JobTrigger` cmdlet, which changes the job trigger so that it starts the `DeployPackage` job on Wednesdays and Sundays. The -command uses the **Passthru** parameter to return the trigger after the change. +command uses the **PassThru** parameter to return the trigger after the change. This command is not required; it is included only to show the effect of the trigger change. @@ -124,7 +124,7 @@ The second command uses the `Get-JobTrigger` cmdlet to get the **AtStartup** job `Inventory` job. The command uses the **TriggerID** parameter to identify the job trigger. A pipeline operator (`|`) sends the job trigger to the `Set-JobTrigger` cmdlet, which changes it to a weekly job trigger that runs every four weeks on Monday at midnight. The command uses the -**Passthru** parameter to return the trigger after the change. +**PassThru** parameter to return the trigger after the change. This command is not required; it is included only to show the effect of the trigger change. diff --git a/reference/5.1/PSScheduledJob/Set-ScheduledJob.md b/reference/5.1/PSScheduledJob/Set-ScheduledJob.md index 0eb7bbf1a56c..0d54fbe827a2 100644 --- a/reference/5.1/PSScheduledJob/Set-ScheduledJob.md +++ b/reference/5.1/PSScheduledJob/Set-ScheduledJob.md @@ -88,7 +88,7 @@ Id Name Triggers Command ``` ```powershell -Get-ScheduledJob -Name "Inventory" | Set-ScheduledJob -FilePath "C:\Scripts\Get-FullInventory.ps1" -Passthru +Get-ScheduledJob -Name "Inventory" | Set-ScheduledJob -FilePath "C:\Scripts\Get-FullInventory.ps1" -PassThru ``` ```Output @@ -103,7 +103,7 @@ shows that the job runs the Get-Inventory.ps1 script. The second command uses the `Get-ScheduledJob` cmdlet to get the Inventory scheduled job. A pipeline operator (`|`) sends the scheduled job to the `Set-ScheduledJob` cmdlet. The `Set-ScheduledJob` cmdlet uses the **Script** parameter to specify a new script, `Get-FullInventory.ps1`. The command -uses the **Passthru** parameter to return the scheduled job after the change. +uses the **PassThru** parameter to return the scheduled job after the change. This command is not required; it is included only to show the effect of the script change. diff --git a/reference/5.1/PSScheduledJob/Set-ScheduledJobOption.md b/reference/5.1/PSScheduledJob/Set-ScheduledJobOption.md index fa8799e7bc43..647273b6d656 100644 --- a/reference/5.1/PSScheduledJob/Set-ScheduledJobOption.md +++ b/reference/5.1/PSScheduledJob/Set-ScheduledJobOption.md @@ -77,7 +77,7 @@ JobDefinition : ```powershell Get-ScheduledJobOption -Name "DeployPackage" | - Set-ScheduledJobOption -WakeToRun -RequireNetwork:$false -Passthru + Set-ScheduledJobOption -WakeToRun -RequireNetwork:$false -PassThru ``` ```Output @@ -103,7 +103,7 @@ DeployPackage scheduled job. The output shows that the WakeToRun and RunElevated to `$false`. The second command uses the `Set-ScheduledJobOpton` cmdlet to change the job options so the values -of the WakeToRun and RunWithoutNetwork properties are $True. The command uses the **Passthru** +of the WakeToRun and RunWithoutNetwork properties are $True. The command uses the **PassThru** parameter to return the trigger after the change. This command is not required; it is included only to show the effect of the option change. diff --git a/reference/7.2/Microsoft.PowerShell.Core/About/About.md b/reference/7.2/Microsoft.PowerShell.Core/About/About.md index d1a8d6a97b84..af722a18d2e9 100644 --- a/reference/7.2/Microsoft.PowerShell.Core/About/About.md +++ b/reference/7.2/Microsoft.PowerShell.Core/About/About.md @@ -2,7 +2,7 @@ description: About topics cover a range of concepts about PowerShell. Help Version: 7.2.0.0 Locale: en-US -ms.date: 11/10/2023 +ms.date: 11/06/2024 title: About topics --- # About topics @@ -14,421 +14,587 @@ About topics cover a range of concepts about PowerShell. ## About Topics ### [about_Alias_Provider](about_Alias_Provider.md) + Provides access to the PowerShell aliases and the values that they represent. ### [about_Aliases](about_Aliases.md) + Describes how to use alternate names for cmdlets and commands in PowerShell. ### [about_ANSI_Terminals](about_ANSI_Terminals.md) + Describes the support available for ANSI escape sequences in Windows PowerShell. ### [about_Arithmetic_Operators](about_Arithmetic_Operators.md) + Describes the operators that perform arithmetic in PowerShell. ### [about_Arrays](about_Arrays.md) + Describes arrays, which are data structures designed to store collections of items. ### [about_Assignment_Operators](about_Assignment_Operators.md) + Describes how to use operators to assign values to variables. ### [about_Automatic_Variables](about_Automatic_Variables.md) -Describes variables that store state information for PowerShell. These variables are created and maintained by PowerShell. + +Describes variables that store state information for PowerShell. These variables are created and +maintained by PowerShell. ### [about_Booleans](about_Booleans.md) + Describes how boolean expressions are evaluated. ### [about_Break](about_Break.md) + Describes the `break` statement, which provides a way to exit the current control block. ### [about_Built-in_Functions](about_Built-in_Functions.md) + Describes the built-in functions in PowerShell. ### [about_Calculated_Properties](about_Calculated_Properties.md) -PowerShell provides the ability to dynamically add new properties and alter the formatting of objects output to the pipeline. + +PowerShell provides the ability to dynamically add new properties and alter the formatting of +objects output to the pipeline. ### [about_Case-Sensitivity](about_Case-Sensitivity.md) + PowerShell is as case-insensitive as possible while preserving case. ### [about_Character_Encoding](about_Character_Encoding.md) + Describes how PowerShell uses character encoding for input and output of string data. ### [about_CimSession](about_CimSession.md) + Describes a **CimSession** object and the difference between CIM sessions and PowerShell sessions. ### [about_Classes](about_Classes.md) + Describes how you can use classes to create your own custom types. ### [about_Classes_Constructors](about_Classes_Constructors.md) + Describes how to define constructors for PowerShell classes. ### [about_Classes_Inheritance](about_Classes_Inheritance.md) + Describes how you can define classes that extend other types. ### [about_Classes_Methods](about_Classes_Methods.md) + Describes how to define methods for PowerShell classes. ### [about_Classes_Properties](about_Classes_Properties.md) + Describes how to define properties for PowerShell classes. ### [about_Command_Precedence](about_Command_Precedence.md) + Describes how PowerShell determines which command to run. ### [about_Command_Syntax](about_Command_Syntax.md) + Describes the syntax diagrams that are used in PowerShell. ### [about_Comment_Based_Help](about_Comment_Based_Help.md) + Describes how to write comment-based help topics for functions and scripts. ### [about_CommonParameters](about_CommonParameters.md) + Describes the parameters that can be used with any cmdlet. ### [about_Comparison_Operators](about_Comparison_Operators.md) -The comparison operators in PowerShell can either compare two values or filter elements of a collection against an input value. + +The comparison operators in PowerShell can either compare two values or filter elements of a +collection against an input value. ### [about_Continue](about_Continue.md) -Describes how the `continue` statement immediately returns the program flow to the top of a program loop, a `switch` statement, or a `trap` statement. + +Describes how the `continue` statement immediately returns the program flow to the top of a program +loop, a `switch` statement, or a `trap` statement. ### [about_Core_Commands](about_Core_Commands.md) + Lists the cmdlets that are designed for use with PowerShell providers. ### [about_Data_Files](about_Data_Files.md) + PowerShell data files are used to store arbitrary data using PowerShell syntax. ### [about_Data_Sections](about_Data_Sections.md) + Explains Data sections, which isolate text strings and other read-only data from script logic. ### [about_Debuggers](about_Debuggers.md) + Describes the PowerShell debugger. ### [about_Do](about_Do.md) + Runs a statement list one or more times, subject to a `While` or `Until` condition. ### [about_Enum](about_Enum.md) -The `enum` statement is used to declare an enumeration. An enumeration is a distinct type that consists of a set of named labels called the enumerator list. + +The `enum` statement is used to declare an enumeration. An enumeration is a distinct type that +consists of a set of named labels called the enumerator list. ### [about_Environment_Provider](about_Environment_Provider.md) + Provides access to the Windows environment variables. ### [about_Environment_Variables](about_Environment_Variables.md) + Describes how to access and manage environment variables in PowerShell. ### [about_Execution_Policies](about_Execution_Policies.md) + Describes the PowerShell execution policies and explains how to manage them. ### [about_Experimental_Features](about_Experimental_Features.md) -Use the `Experimental` attribute to declare some code as experimental. Use the following syntax to declare the `Experimental` attribute providing the name of the experimental feature and the action to take if the experimental feature is enabled: ```csharp [Experimental(NameOfExperimentalFeature, ExperimentAction)] ``` For modules, the `NameOfExperimentalFeature` must follow the form of `.`. The `ExperimentAction` parameter must be specified and the only valid values are: - `Show` means to show this experimental feature if the feature is enabled - `Hide` means to hide this experimental feature if the feature is enabled + +The PowerShell provides a mechanism for experimental features to coexist with existing stable +features in the PowerShell engine or in a PowerShell module. ### [about_FileSystem_Provider](about_FileSystem_Provider.md) + Provides access to files and directories. ### [about_For](about_For.md) + Describes a language command you can use to run statements based on a conditional test. ### [about_Foreach](about_Foreach.md) + Describes a language command you can use to traverse all the items in a collection of items. ### [about_Format.ps1xml](about_Format.ps1xml.md) -The `Format.ps1xml` files in PowerShell define the default display of objects in the PowerShell console. + +The `Format.ps1xml` files in PowerShell define the default display of objects in the PowerShell +console. ### [about_Function_Provider](about_Function_Provider.md) + Provides access to the functions defined in PowerShell. ### [about_Functions_Advanced_Methods](about_Functions_Advanced_Methods.md) -Describes how functions that specify the `CmdletBinding` attribute can use the methods and properties that are available to compiled cmdlets. + +Describes how functions that specify the `CmdletBinding` attribute can use the methods and +properties that are available to compiled cmdlets. ### [about_Functions_Advanced_Parameters](about_Functions_Advanced_Parameters.md) + Explains how to add parameters to advanced functions. ### [about_Functions_Advanced](about_Functions_Advanced.md) + Introduces advanced functions that are a way to create cmdlets using scripts. ### [about_Functions_Argument_Completion](about_Functions_Argument_Completion.md) -Argument completion is a feature of PowerShell that provide hints, enables discovery, and speeds up input entry of argument values. + +Argument completion is a feature of PowerShell that provide hints, enables discovery, and speeds up +input entry of argument values. ### [about_Functions_CmdletBindingAttribute](about_Functions_CmdletBindingAttribute.md) + Describes the attribute that makes a function work like a compiled cmdlet. ### [about_Functions_OutputTypeAttribute](about_Functions_OutputTypeAttribute.md) + Describes an attribute that reports the type of object that the function returns. ### [about_Functions](about_Functions.md) + Describes how to create and use functions in PowerShell. ### [about_Group_Policy_Settings](about_Group_Policy_Settings.md) + Describes the Group Policy settings for PowerShell ### [about_Hash_Tables](about_Hash_Tables.md) + Describes how to create, use, and sort hashtables in PowerShell. ### [about_Hidden](about_Hidden.md) + Describes the `hidden` keyword, which hides class members from default `Get-Member` results. ### [about_History](about_History.md) + Describes how to get and run commands in the command history. ### [about_If](about_If.md) -Describes a language command you can use to run statement lists based on the results of one or more conditional tests. + +Describes a language command you can use to run statement lists based on the results of one or more +conditional tests. ### [about_Intrinsic_Members](about_Intrinsic_Members.md) -Provides information about PowerShell's intrinsic members that are available to all PowerShell objects. + +Provides information about PowerShell's intrinsic members that are available to all PowerShell +objects. ### [about_Job_Details](about_Job_Details.md) + Provides details about background jobs on local and remote computers. ### [about_Jobs](about_Jobs.md) -Provides information about how PowerShell background jobs run a command or expression in the background without interacting with the current session. + +Provides information about how PowerShell background jobs run a command or expression in the +background without interacting with the current session. ### [about_Join](about_Join.md) + Describes how the join operator (-join) combines multiple strings into a single string. ### [about_Language_Keywords](about_Language_Keywords.md) + Describes the keywords in the PowerShell scripting language. ### [about_Language_Modes](about_Language_Modes.md) + Explains language modes and their effect on PowerShell sessions. ### [about_Line_Editing](about_Line_Editing.md) + Describes how to edit commands at the PowerShell command prompt. ### [about_Locations](about_Locations.md) + Describes how to access items from the working location in PowerShell. ### [about_Logging_Non-Windows](about_Logging_Non-Windows.md) + PowerShell logs internal operations from the engine, providers, and cmdlets. ### [about_Logging_Windows](about_Logging_Windows.md) -PowerShell logs internal operations from the engine, providers, and cmdlets to the Windows event log. + +PowerShell logs internal operations from the engine, providers, and cmdlets to the Windows event +log. ### [about_Logical_Operators](about_Logical_Operators.md) + Describes the operators that connect statements in PowerShell. ### [about_Member-Access_Enumeration](about_Member-Access_Enumeration.md) + Describes the automatic enumeration of list collection items when using the member-access operator. ### [about_Methods](about_Methods.md) + Describes how to use methods to perform actions on objects in PowerShell. ### [about_Module_Manifests](about_Module_Manifests.md) + Describes the settings and practices for writing module manifest files. ### [about_Modules](about_Modules.md) + Explains how to install, import, and use PowerShell modules. ### [about_Numeric_Literals](about_Numeric_Literals.md) + This article describes the syntax and usage of numeric values in PowerShell. ### [about_Object_Creation](about_Object_Creation.md) + Explains how to create objects in PowerShell. ### [about_Objects](about_Objects.md) + Provides essential information about objects in PowerShell. ### [about_Operator_Precedence](about_Operator_Precedence.md) + Lists the PowerShell operators in precedence order. ### [about_Operators](about_Operators.md) + Describes the operators that are supported by PowerShell. ### [about_Output_Streams](about_Output_Streams.md) + Explains the availability and purpose of output streams in PowerShell. ### [about_PackageManagement](about_PackageManagement.md) + PackageManagement is an aggregator for software package managers. ### [about_Parameter_Sets](about_Parameter_Sets.md) + Describes how to define and use parameter sets in advanced functions. ### [about_Parameters_Default_Values](about_Parameters_Default_Values.md) + Describes how to set custom default values for cmdlet parameters and advanced functions. ### [about_Parameters](about_Parameters.md) + Describes how to work with command parameters in PowerShell. ### [about_Parsing](about_Parsing.md) + Describes how PowerShell parses commands. ### [about_Path_Syntax](about_Path_Syntax.md) + Describes the full and relative path formats in PowerShell. ### [about_Pipeline_Chain_Operators](about_Pipeline_Chain_Operators.md) + Describes chaining pipelines with the `&&` and `||` operators in PowerShell. ### [about_Pipelines](about_Pipelines.md) + Combining commands into pipelines in the PowerShell ### [about_PowerShell_Config](about_PowerShell_Config.md) + Configuration files for PowerShell, replacing Registry configuration. ### [about_PowerShell_Editions](about_PowerShell_Editions.md) + Different editions of PowerShell run on different underlying runtimes. ### [about_Preference_Variables](about_Preference_Variables.md) + Variables that customize the behavior of PowerShell. ### [about_Profiles](about_Profiles.md) + Describes how to create and use a PowerShell profile. ### [about_Prompts](about_Prompts.md) + Describes the `Prompt` function and demonstrates how to create a custom `Prompt` function. ### [about_Properties](about_Properties.md) + Describes how to use object properties in PowerShell. ### [about_Providers](about_Providers.md) -Describes how PowerShell providers provide access to data and components that wouldn't otherwise be easily accessible at the command line. The data is presented in a consistent format that resembles a file system drive. + +PowerShell providers provide access to data and components, presented in a consistent format that +resembles a file system drive. ### [about_PSConsoleHostReadLine](about_PSConsoleHostReadLine.md) + Explains how to create a customize how PowerShell reads input at the console prompt. ### [about_PSCustomObject](about_PSCustomObject.md) + Explains the differences between the `[psobject]` and `[pscustomobject]` type accelerators. ### [about_PSItem](about_PSItem.md) + The automatic variable that contains the current object in the pipeline object. ### [about_PSModulePath](about_PSModulePath.md) + This article the purpose and usage of the `$env:PSModulePath` environment variable. ### [about_PSSession_Details](about_PSSession_Details.md) + Provides detailed information about PowerShell sessions and the role they play in remote commands. ### [about_PSSessions](about_PSSessions.md) -Describes PowerShell sessions (PSSessions) and explains how to establish a persistent connection to a remote computer. + +Describes PowerShell sessions (PSSessions) and explains how to establish a persistent connection to +a remote computer. ### [about_Pwsh](about_Pwsh.md) -Explains how to use the `pwsh` command-line interface. Displays the command-line parameters and describes the syntax. + +Explains how to use the `pwsh` command-line interface. Displays the command-line parameters and +describes the syntax. ### [about_Quoting_Rules](about_Quoting_Rules.md) + Describes rules for using single and double quotation marks in PowerShell. ### [about_Redirection](about_Redirection.md) + Explains how to redirect output from PowerShell to text files. ### [about_Ref](about_Ref.md) -Describes how to create and use a reference type variable. You can use reference type variables to permit a function to change the value of a variable that is passed to it. + +Describes how to create and use a reference type variable. You can use reference type variables to +permit a function to change the value of a variable that is passed to it. ### [about_Registry_Provider](about_Registry_Provider.md) -Registry + +Describes teh features and functions of the Registry provider. ### [about_Regular_Expressions](about_Regular_Expressions.md) + Describes regular expressions in PowerShell. ### [about_Remote_Disconnected_Sessions](about_Remote_Disconnected_Sessions.md) + Explains how to disconnect and reconnect to a PowerShell Session (PSSession). ### [about_Remote_Jobs](about_Remote_Jobs.md) + Describes how to run jobs on remote computers. ### [about_Remote_Output](about_Remote_Output.md) + Describes how to interpret and format the output of remote commands. ### [about_Remote_Requirements](about_Remote_Requirements.md) -Describes the system requirements and configuration requirements for running remote commands in PowerShell. + +Describes the system requirements and configuration requirements for running remote commands in +PowerShell. ### [about_Remote_Troubleshooting](about_Remote_Troubleshooting.md) + Describes how to troubleshoot remote operations in PowerShell. ### [about_Remote_Variables](about_Remote_Variables.md) + Explains how to use local and remote variables in remote commands. ### [about_Remote](about_Remote.md) + Describes how to run remote commands in PowerShell. ### [about_Requires](about_Requires.md) + Prevents a script from running without the required elements. ### [about_Reserved_Words](about_Reserved_Words.md) -Lists the reserved words that cannot be used as identifiers because they have a special meaning in PowerShell. + +Lists the reserved words that cannot be used as identifiers because they have a special meaning in +PowerShell. ### [about_Return](about_Return.md) + Exits the current scope, which can be a function, script, or script block. ### [about_Run_With_PowerShell](about_Run_With_PowerShell.md) + Explains how to use the "Run with PowerShell" feature to run a script from a file system drive. ### [about_Scopes](about_Scopes.md) + Explains the concept of scope in PowerShell and shows how to set and change the scope of elements. ### [about_Script_Blocks](about_Script_Blocks.md) + Defines what a script block is and explains how to use script blocks in the PowerShell programming language. ### [about_Script_Internationalization](about_Script_Internationalization.md) -Describes the script internationalization features that make it easy for scripts to display messages and instructions to users in their user interface (UI) language. + +Describes the script internationalization features that make it easy for scripts to display messages +and instructions to users in their user interface (UI) language. ### [about_Scripts](about_Scripts.md) + Describes how to run and write scripts in PowerShell. ### [about_Session_Configuration_Files](about_Session_Configuration_Files.md) -Describes session configuration files, which are used in a session configuration (also known as an "endpoint") to define the environment of sessions that use the session configuration. + +Describes session configuration files, which are used in a session configuration (also known as an +"endpoint") to define the environment of sessions that use the session configuration. ### [about_Session_Configurations](about_Session_Configurations.md) -Describes session configurations, which determine the users who can connect to the computer remotely and the commands they can run. + +Describes session configurations, which determine the users who can connect to the computer remotely +and the commands they can run. ### [about_Signing](about_Signing.md) + Explains how to sign scripts so that they comply with the PowerShell execution policies. ### [about_Simplified_Syntax](about_Simplified_Syntax.md) + Describes easier, more natural-language ways of scripting filters for collections of objects. ### [about_Special_Characters](about_Special_Characters.md) -Describes the special character sequences that control how PowerShell interprets the next characters in the sequence. + +Describes the special character sequences that control how PowerShell interprets the next characters +in the sequence. ### [about_Splatting](about_Splatting.md) + Describes how to use splatting to pass parameters to commands in PowerShell. ### [about_Split](about_Split.md) + Explains how to use the Split operator to split one or more strings into substrings. ### [about_Switch](about_Switch.md) + Explains how to use a switch to handle multiple `if` statements. ### [about_Tab_Expansion](about_Tab_Expansion.md) -PowerShell provides completions on input to provide hints, enable discovery, and speed up input entry. Command names, parameter names, argument values and file paths can all be completed by pressing the Tab key. + +PowerShell provides completions on input to provide hints, enable discovery, and speed up input +entry by pressing the Tab key. ### [about_Telemetry](about_Telemetry.md) + Describes the telemetry collected in PowerShell and how to opt-out. ### [about_Thread_Jobs](about_Thread_Jobs.md) -Provides information about PowerShell thread-based jobs. A thread job is a type of background job that runs a command or expression in a separate thread within the current session process. + +Provides information about PowerShell thread-based jobs. A thread job is a type of background job +that runs a command or expression in a separate thread within the current session process. ### [about_Throw](about_Throw.md) + Describes the `throw` keyword that generates a terminating error. ### [about_Trap](about_Trap.md) + Describes a keyword that handles a terminating error. ### [about_Try_Catch_Finally](about_Try_Catch_Finally.md) + Describes how to use the `try`, `catch`, and `finally` blocks to handle terminating errors. ### [about_Type_Accelerators](about_Type_Accelerators.md) + Describes the Type accelerators available for .NET framework classes ### [about_Type_Operators](about_Type_Operators.md) + Describes the operators that work with Microsoft .NET types. ### [about_Types.ps1xml](about_Types.ps1xml.md) + Explains how to use `Types.ps1xml` files to extend the types of objects that are used in PowerShell. ### [about_Updatable_Help](about_Updatable_Help.md) + Describes the updatable help system in PowerShell. ### [about_Update_Notifications](about_Update_Notifications.md) + Notifies users on startup of PowerShell that a new version of PowerShell has been released. ### [about_Using](about_Using.md) + Allows you to indicate which namespaces are used in the session. ### [about_Variable_Provider](about_Variable_Provider.md) + Variable ### [about_Variables](about_Variables.md) + Describes how variables store values that can be used in PowerShell. ### [about_While](about_While.md) -Describes a language statement that you can use to run a command block based on the results of a conditional test. + +Describes a language statement that you can use to run a command block based on the results of a +conditional test. ### [about_Wildcards](about_Wildcards.md) + Describes how to use wildcard characters in PowerShell. ### [about_Windows_PowerShell_Compatibility](about_Windows_PowerShell_Compatibility.md) + Describes the Windows PowerShell Compatibility functionality for PowerShell 7. diff --git a/reference/7.4/CimCmdlets/Set-CimInstance.md b/reference/7.4/CimCmdlets/Set-CimInstance.md index fc7c3267ef9b..ebc205641666 100644 --- a/reference/7.4/CimCmdlets/Set-CimInstance.md +++ b/reference/7.4/CimCmdlets/Set-CimInstance.md @@ -102,14 +102,14 @@ Set-CimInstance -InputObject $x -Property @{VariableValue="somevalue"} -PassThru This example retrieves the CIM instance objects filtered by the Query parameter in to a variable `$x` using `Get-CimInstance`, and then passes the contents of the variable to the `Set-CimInstance` cmdlet. `Set-CimInstance` then modifies the **VariableValue** property to **somevalue**. Because the -**Passthru** parameter is used, This example returns a modified CIM instance object. +**PassThru** parameter is used, This example returns a modified CIM instance object. ### Example 4: Set the CIM instance property This example retrieves the CIM instance object that is specified in the **Query** parameter into a variable `$x` using the `Get-CimInstance` cmdlet, and changes the **VariableValue** property value of the object to change. The CIM instance object is then saved using the `Set-CimInstance` cmdlet. -Because the **Passthru** parameter is used, This example returns a modified CIM instance object. +Because the **PassThru** parameter is used, This example returns a modified CIM instance object. ```powershell $x = Get-CimInstance -Query 'Select * from Win32_Environment where name="testvar"' @@ -140,7 +140,7 @@ Set-CimInstance -Query 'Select * from Win32_Environment where name LIKE "testvar This example creates a CIM instance with the specified properties using the `New-CimInstance` cmdlet, and retrieves its contents in to a variable `$x`. The variable is then passed to the `Set-CimInstance` cmdlet, which modifies the value of **VariableValue** property to **somevalue**. -Because the **Passthru** parameter is used, This example returns a modified CIM instance object. +Because the **PassThru** parameter is used, This example returns a modified CIM instance object. ```powershell $x = New-CimInstance -ClassName Win32_Environment -Property @{Name="testvar";UserName="domain\user"} -Key Name,UserName -ClientOnly @@ -411,7 +411,7 @@ By default, this cmdlet returns no output. ### Microsoft.Management.Infrastructure.CimInstance -When you use the **Passthru** parameter, this cmdlet returns the modified CIM instance object. +When you use the **PassThru** parameter, this cmdlet returns the modified CIM instance object. ## NOTES diff --git a/reference/7.4/Microsoft.PowerShell.Core/About/About.md b/reference/7.4/Microsoft.PowerShell.Core/About/About.md index 9c2a3ddaddfa..4cc9179b9b55 100644 --- a/reference/7.4/Microsoft.PowerShell.Core/About/About.md +++ b/reference/7.4/Microsoft.PowerShell.Core/About/About.md @@ -2,7 +2,7 @@ description: About topics cover a range of concepts about PowerShell. Help Version: 7.4.0.0 Locale: en-US -ms.date: 11/10/2023 +ms.date: 11/06/2024 title: About topics --- # About topics @@ -14,424 +14,592 @@ About topics cover a range of concepts about PowerShell. ## About Topics ### [about_Alias_Provider](about_Alias_Provider.md) + Provides access to the PowerShell aliases and the values that they represent. ### [about_Aliases](about_Aliases.md) + Describes how to use alternate names for cmdlets and commands in PowerShell. ### [about_ANSI_Terminals](about_ANSI_Terminals.md) + Describes the support available for ANSI escape sequences in Windows PowerShell. ### [about_Arithmetic_Operators](about_Arithmetic_Operators.md) + Describes the operators that perform arithmetic in PowerShell. ### [about_Arrays](about_Arrays.md) + Describes arrays, which are data structures designed to store collections of items. ### [about_Assignment_Operators](about_Assignment_Operators.md) + Describes how to use operators to assign values to variables. ### [about_Automatic_Variables](about_Automatic_Variables.md) -Describes variables that store state information for PowerShell. These variables are created and maintained by PowerShell. + +Describes variables that store state information for PowerShell. These variables are created and +maintained by PowerShell. ### [about_Booleans](about_Booleans.md) + Describes how boolean expressions are evaluated. ### [about_Break](about_Break.md) + Describes the `break` statement, which provides a way to exit the current control block. ### [about_Built-in_Functions](about_Built-in_Functions.md) + Describes the built-in functions in PowerShell. ### [about_Calculated_Properties](about_Calculated_Properties.md) -PowerShell provides the ability to dynamically add new properties and alter the formatting of objects output to the pipeline. + +PowerShell provides the ability to dynamically add new properties and alter the formatting of +objects output to the pipeline. ### [about_Calling_Generic_Methods](about_Calling_Generic_Methods.md) -A generic method is a method with two parameter lists: a list of generic types and a list of method arguments. The following examples show the new PowerShell syntax for accessing a generic method: ```Syntax # static generic methods [type_name]::MethodName[generic_type_arguments](method_arguments) # instance generic methods $object.MethodName[generic_type_arguments](method_arguments) ``` The `generic_type_arguments` can be a single type or comma-separated list of types, like `[string, int]`, including other generic types like `$obj.MethodName[string, System.Collections.Generic.Dictionary[string, int]]()` The `method_arguments` can be zero or more items. For more information, see [Generics in .NET](/dotnet/standard/generics/). + +Generics let you tailor a method, class, structure, or interface to the precise data type it acts +upon. ### [about_Case-Sensitivity](about_Case-Sensitivity.md) + PowerShell is as case-insensitive as possible while preserving case. ### [about_Character_Encoding](about_Character_Encoding.md) + Describes how PowerShell uses character encoding for input and output of string data. ### [about_CimSession](about_CimSession.md) + Describes a **CimSession** object and the difference between CIM sessions and PowerShell sessions. ### [about_Classes](about_Classes.md) + Describes how you can use classes to create your own custom types. ### [about_Classes_Constructors](about_Classes_Constructors.md) + Describes how to define constructors for PowerShell classes. ### [about_Classes_Inheritance](about_Classes_Inheritance.md) + Describes how you can define classes that extend other types. ### [about_Classes_Methods](about_Classes_Methods.md) + Describes how to define methods for PowerShell classes. ### [about_Classes_Properties](about_Classes_Properties.md) + Describes how to define properties for PowerShell classes. ### [about_Command_Precedence](about_Command_Precedence.md) + Describes how PowerShell determines which command to run. ### [about_Command_Syntax](about_Command_Syntax.md) + Describes the syntax diagrams that are used in PowerShell. ### [about_Comment_Based_Help](about_Comment_Based_Help.md) + Describes how to write comment-based help topics for functions and scripts. ### [about_CommonParameters](about_CommonParameters.md) + Describes the parameters that can be used with any cmdlet. ### [about_Comparison_Operators](about_Comparison_Operators.md) -The comparison operators in PowerShell can either compare two values or filter elements of a collection against an input value. + +The comparison operators in PowerShell can either compare two values or filter elements of a +collection against an input value. ### [about_Continue](about_Continue.md) -Describes how the `continue` statement immediately returns the program flow to the top of a program loop, a `switch` statement, or a `trap` statement. + +Describes how the `continue` statement immediately returns the program flow to the top of a program +loop, a `switch` statement, or a `trap` statement. ### [about_Core_Commands](about_Core_Commands.md) + Lists the cmdlets that are designed for use with PowerShell providers. ### [about_Data_Files](about_Data_Files.md) + PowerShell data files are used to store arbitrary data using PowerShell syntax. ### [about_Data_Sections](about_Data_Sections.md) + Explains Data sections, which isolate text strings and other read-only data from script logic. ### [about_Debuggers](about_Debuggers.md) + Describes the PowerShell debugger. ### [about_Do](about_Do.md) + Runs a statement list one or more times, subject to a `While` or `Until` condition. ### [about_Enum](about_Enum.md) -The `enum` statement is used to declare an enumeration. An enumeration is a distinct type that consists of a set of named labels called the enumerator list. + +The `enum` statement is used to declare an enumeration. An enumeration is a distinct type that +consists of a set of named labels called the enumerator list. ### [about_Environment_Provider](about_Environment_Provider.md) + Provides access to the Windows environment variables. ### [about_Environment_Variables](about_Environment_Variables.md) + Describes how to access and manage environment variables in PowerShell. ### [about_Execution_Policies](about_Execution_Policies.md) + Describes the PowerShell execution policies and explains how to manage them. ### [about_Experimental_Features](about_Experimental_Features.md) -Use the `Experimental` attribute to declare some code as experimental. Use the following syntax to declare the `Experimental` attribute providing the name of the experimental feature and the action to take if the experimental feature is enabled: ```csharp [Experimental(NameOfExperimentalFeature, ExperimentAction)] ``` For modules, the `NameOfExperimentalFeature` must follow the form of `.`. The `ExperimentAction` parameter must be specified and the only valid values are: - `Show` means to show this experimental feature if the feature is enabled - `Hide` means to hide this experimental feature if the feature is enabled + +The PowerShell provides a mechanism for experimental features to coexist with existing stable +features in the PowerShell engine or in a PowerShell module. ### [about_FileSystem_Provider](about_FileSystem_Provider.md) + Provides access to files and directories. ### [about_For](about_For.md) + Describes a language command you can use to run statements based on a conditional test. ### [about_Foreach](about_Foreach.md) + Describes a language command you can use to traverse all the items in a collection of items. ### [about_Format.ps1xml](about_Format.ps1xml.md) -The `Format.ps1xml` files in PowerShell define the default display of objects in the PowerShell console. + +The `Format.ps1xml` files in PowerShell define the default display of objects in the PowerShell +console. ### [about_Function_Provider](about_Function_Provider.md) + Provides access to the functions defined in PowerShell. ### [about_Functions_Advanced_Methods](about_Functions_Advanced_Methods.md) -Describes how functions that specify the `CmdletBinding` attribute can use the methods and properties that are available to compiled cmdlets. + +Describes how functions that specify the `CmdletBinding` attribute can use the methods and +properties that are available to compiled cmdlets. ### [about_Functions_Advanced_Parameters](about_Functions_Advanced_Parameters.md) + Explains how to add parameters to advanced functions. ### [about_Functions_Advanced](about_Functions_Advanced.md) + Introduces advanced functions that are a way to create cmdlets using scripts. ### [about_Functions_Argument_Completion](about_Functions_Argument_Completion.md) -Argument completion is a feature of PowerShell that provide hints, enables discovery, and speeds up input entry of argument values. + +Argument completion is a feature of PowerShell that provide hints, enables discovery, and speeds up +input entry of argument values. ### [about_Functions_CmdletBindingAttribute](about_Functions_CmdletBindingAttribute.md) + Describes the attribute that makes a function work like a compiled cmdlet. ### [about_Functions_OutputTypeAttribute](about_Functions_OutputTypeAttribute.md) + Describes an attribute that reports the type of object that the function returns. ### [about_Functions](about_Functions.md) + Describes how to create and use functions in PowerShell. ### [about_Group_Policy_Settings](about_Group_Policy_Settings.md) + Describes the Group Policy settings for PowerShell ### [about_Hash_Tables](about_Hash_Tables.md) + Describes how to create, use, and sort hashtables in PowerShell. ### [about_Hidden](about_Hidden.md) + Describes the `hidden` keyword, which hides class members from default `Get-Member` results. ### [about_History](about_History.md) + Describes how to get and run commands in the command history. ### [about_If](about_If.md) -Describes a language command you can use to run statement lists based on the results of one or more conditional tests. + +Describes a language command you can use to run statement lists based on the results of one or more +conditional tests. ### [about_Intrinsic_Members](about_Intrinsic_Members.md) -Provides information about PowerShell's intrinsic members that are available to all PowerShell objects. + +Provides information about PowerShell's intrinsic members that are available to all PowerShell +objects. ### [about_Job_Details](about_Job_Details.md) + Provides details about background jobs on local and remote computers. ### [about_Jobs](about_Jobs.md) -Provides information about how PowerShell background jobs run a command or expression in the background without interacting with the current session. + +Provides information about how PowerShell background jobs run a command or expression in the +background without interacting with the current session. ### [about_Join](about_Join.md) + Describes how the join operator (-join) combines multiple strings into a single string. ### [about_Language_Keywords](about_Language_Keywords.md) + Describes the keywords in the PowerShell scripting language. ### [about_Language_Modes](about_Language_Modes.md) + Explains language modes and their effect on PowerShell sessions. ### [about_Line_Editing](about_Line_Editing.md) + Describes how to edit commands at the PowerShell command prompt. ### [about_Locations](about_Locations.md) + Describes how to access items from the working location in PowerShell. ### [about_Logging_Non-Windows](about_Logging_Non-Windows.md) + PowerShell logs internal operations from the engine, providers, and cmdlets. ### [about_Logging_Windows](about_Logging_Windows.md) -PowerShell logs internal operations from the engine, providers, and cmdlets to the Windows event log. + +PowerShell logs internal operations from the engine, providers, and cmdlets to the Windows event +log. ### [about_Logical_Operators](about_Logical_Operators.md) + Describes the operators that connect statements in PowerShell. ### [about_Member-Access_Enumeration](about_Member-Access_Enumeration.md) + Describes the automatic enumeration of list collection items when using the member-access operator. ### [about_Methods](about_Methods.md) + Describes how to use methods to perform actions on objects in PowerShell. ### [about_Module_Manifests](about_Module_Manifests.md) + Describes the settings and practices for writing module manifest files. ### [about_Modules](about_Modules.md) + Explains how to install, import, and use PowerShell modules. ### [about_Numeric_Literals](about_Numeric_Literals.md) + This article describes the syntax and usage of numeric values in PowerShell. ### [about_Object_Creation](about_Object_Creation.md) + Explains how to create objects in PowerShell. ### [about_Objects](about_Objects.md) + Provides essential information about objects in PowerShell. ### [about_Operator_Precedence](about_Operator_Precedence.md) + Lists the PowerShell operators in precedence order. ### [about_Operators](about_Operators.md) + Describes the operators that are supported by PowerShell. ### [about_Output_Streams](about_Output_Streams.md) + Explains the availability and purpose of output streams in PowerShell. ### [about_PackageManagement](about_PackageManagement.md) + PackageManagement is an aggregator for software package managers. ### [about_Parameter_Sets](about_Parameter_Sets.md) + Describes how to define and use parameter sets in advanced functions. ### [about_Parameters_Default_Values](about_Parameters_Default_Values.md) + Describes how to set custom default values for cmdlet parameters and advanced functions. ### [about_Parameters](about_Parameters.md) + Describes how to work with command parameters in PowerShell. ### [about_Parsing](about_Parsing.md) + Describes how PowerShell parses commands. ### [about_Path_Syntax](about_Path_Syntax.md) + Describes the full and relative path formats in PowerShell. ### [about_Pipeline_Chain_Operators](about_Pipeline_Chain_Operators.md) + Describes chaining pipelines with the `&&` and `||` operators in PowerShell. ### [about_Pipelines](about_Pipelines.md) + Combining commands into pipelines in the PowerShell ### [about_PowerShell_Config](about_PowerShell_Config.md) + Configuration files for PowerShell, replacing Registry configuration. ### [about_PowerShell_Editions](about_PowerShell_Editions.md) + Different editions of PowerShell run on different underlying runtimes. ### [about_Preference_Variables](about_Preference_Variables.md) + Variables that customize the behavior of PowerShell. ### [about_Profiles](about_Profiles.md) + Describes how to create and use a PowerShell profile. ### [about_Prompts](about_Prompts.md) + Describes the `Prompt` function and demonstrates how to create a custom `Prompt` function. ### [about_Properties](about_Properties.md) + Describes how to use object properties in PowerShell. ### [about_Providers](about_Providers.md) -Describes how PowerShell providers provide access to data and components that wouldn't otherwise be easily accessible at the command line. The data is presented in a consistent format that resembles a file system drive. + +PowerShell providers provide access to data and components, presented in a consistent format that +resembles a file system drive. ### [about_PSConsoleHostReadLine](about_PSConsoleHostReadLine.md) + Explains how to create a customize how PowerShell reads input at the console prompt. ### [about_PSCustomObject](about_PSCustomObject.md) + Explains the differences between the `[psobject]` and `[pscustomobject]` type accelerators. ### [about_PSItem](about_PSItem.md) + The automatic variable that contains the current object in the pipeline object. ### [about_PSModulePath](about_PSModulePath.md) + This article the purpose and usage of the `$env:PSModulePath` environment variable. ### [about_PSSession_Details](about_PSSession_Details.md) + Provides detailed information about PowerShell sessions and the role they play in remote commands. ### [about_PSSessions](about_PSSessions.md) -Describes PowerShell sessions (PSSessions) and explains how to establish a persistent connection to a remote computer. + +Describes PowerShell sessions (PSSessions) and explains how to establish a persistent connection to +a remote computer. ### [about_Pwsh](about_Pwsh.md) -Explains how to use the `pwsh` command-line interface. Displays the command-line parameters and describes the syntax. + +Explains how to use the `pwsh` command-line interface. Displays the command-line parameters and +describes the syntax. ### [about_Quoting_Rules](about_Quoting_Rules.md) + Describes rules for using single and double quotation marks in PowerShell. ### [about_Redirection](about_Redirection.md) + Explains how to redirect output from PowerShell to text files. ### [about_Ref](about_Ref.md) -Describes how to create and use a reference type variable. You can use reference type variables to permit a function to change the value of a variable that is passed to it. + +Describes how to create and use a reference type variable. You can use reference type variables to +permit a function to change the value of a variable that is passed to it. ### [about_Registry_Provider](about_Registry_Provider.md) -Registry + +Describes teh features and functions of the Registry provider. ### [about_Regular_Expressions](about_Regular_Expressions.md) + Describes regular expressions in PowerShell. ### [about_Remote_Disconnected_Sessions](about_Remote_Disconnected_Sessions.md) + Explains how to disconnect and reconnect to a PowerShell Session (PSSession). ### [about_Remote_Jobs](about_Remote_Jobs.md) + Describes how to run jobs on remote computers. ### [about_Remote_Output](about_Remote_Output.md) + Describes how to interpret and format the output of remote commands. ### [about_Remote_Requirements](about_Remote_Requirements.md) -Describes the system requirements and configuration requirements for running remote commands in PowerShell. + +Describes the system requirements and configuration requirements for running remote commands in +PowerShell. ### [about_Remote_Troubleshooting](about_Remote_Troubleshooting.md) + Describes how to troubleshoot remote operations in PowerShell. ### [about_Remote_Variables](about_Remote_Variables.md) + Explains how to use local and remote variables in remote commands. ### [about_Remote](about_Remote.md) + Describes how to run remote commands in PowerShell. ### [about_Requires](about_Requires.md) + Prevents a script from running without the required elements. ### [about_Reserved_Words](about_Reserved_Words.md) -Lists the reserved words that cannot be used as identifiers because they have a special meaning in PowerShell. + +Lists the reserved words that cannot be used as identifiers because they have a special meaning in +PowerShell. ### [about_Return](about_Return.md) + Exits the current scope, which can be a function, script, or script block. ### [about_Run_With_PowerShell](about_Run_With_PowerShell.md) + Explains how to use the "Run with PowerShell" feature to run a script from a file system drive. ### [about_Scopes](about_Scopes.md) + Explains the concept of scope in PowerShell and shows how to set and change the scope of elements. ### [about_Script_Blocks](about_Script_Blocks.md) + Defines what a script block is and explains how to use script blocks in the PowerShell programming language. ### [about_Script_Internationalization](about_Script_Internationalization.md) -Describes the script internationalization features that make it easy for scripts to display messages and instructions to users in their user interface (UI) language. + +Describes the script internationalization features that make it easy for scripts to display messages +and instructions to users in their user interface (UI) language. ### [about_Scripts](about_Scripts.md) + Describes how to run and write scripts in PowerShell. ### [about_Session_Configuration_Files](about_Session_Configuration_Files.md) -Describes session configuration files, which are used in a session configuration (also known as an "endpoint") to define the environment of sessions that use the session configuration. + +Describes session configuration files, which are used in a session configuration (also known as an +"endpoint") to define the environment of sessions that use the session configuration. ### [about_Session_Configurations](about_Session_Configurations.md) -Describes session configurations, which determine the users who can connect to the computer remotely and the commands they can run. + +Describes session configurations, which determine the users who can connect to the computer remotely +and the commands they can run. ### [about_Signing](about_Signing.md) + Explains how to sign scripts so that they comply with the PowerShell execution policies. ### [about_Simplified_Syntax](about_Simplified_Syntax.md) + Describes easier, more natural-language ways of scripting filters for collections of objects. ### [about_Special_Characters](about_Special_Characters.md) -Describes the special character sequences that control how PowerShell interprets the next characters in the sequence. + +Describes the special character sequences that control how PowerShell interprets the next characters +in the sequence. ### [about_Splatting](about_Splatting.md) + Describes how to use splatting to pass parameters to commands in PowerShell. ### [about_Split](about_Split.md) + Explains how to use the Split operator to split one or more strings into substrings. ### [about_Switch](about_Switch.md) + Explains how to use a switch to handle multiple `if` statements. ### [about_Tab_Expansion](about_Tab_Expansion.md) -PowerShell provides completions on input to provide hints, enable discovery, and speed up input entry. Command names, parameter names, argument values and file paths can all be completed by pressing the Tab key. + +PowerShell provides completions on input to provide hints, enable discovery, and speed up input +entry by pressing the Tab key. ### [about_Telemetry](about_Telemetry.md) + Describes the telemetry collected in PowerShell and how to opt-out. ### [about_Thread_Jobs](about_Thread_Jobs.md) -Provides information about PowerShell thread-based jobs. A thread job is a type of background job that runs a command or expression in a separate thread within the current session process. + +Provides information about PowerShell thread-based jobs. A thread job is a type of background job +that runs a command or expression in a separate thread within the current session process. ### [about_Throw](about_Throw.md) + Describes the `throw` keyword that generates a terminating error. ### [about_Trap](about_Trap.md) + Describes a keyword that handles a terminating error. ### [about_Try_Catch_Finally](about_Try_Catch_Finally.md) + Describes how to use the `try`, `catch`, and `finally` blocks to handle terminating errors. ### [about_Type_Accelerators](about_Type_Accelerators.md) + Describes the Type accelerators available for .NET framework classes ### [about_Type_Operators](about_Type_Operators.md) + Describes the operators that work with Microsoft .NET types. ### [about_Types.ps1xml](about_Types.ps1xml.md) + Explains how to use `Types.ps1xml` files to extend the types of objects that are used in PowerShell. ### [about_Updatable_Help](about_Updatable_Help.md) + Describes the updatable help system in PowerShell. ### [about_Update_Notifications](about_Update_Notifications.md) + Notifies users on startup of PowerShell that a new version of PowerShell has been released. ### [about_Using](about_Using.md) + Allows you to indicate which namespaces are used in the session. ### [about_Variable_Provider](about_Variable_Provider.md) + Variable ### [about_Variables](about_Variables.md) + Describes how variables store values that can be used in PowerShell. ### [about_While](about_While.md) -Describes a language statement that you can use to run a command block based on the results of a conditional test. + +Describes a language statement that you can use to run a command block based on the results of a +conditional test. ### [about_Wildcards](about_Wildcards.md) + Describes how to use wildcard characters in PowerShell. ### [about_Windows_PowerShell_Compatibility](about_Windows_PowerShell_Compatibility.md) + Describes the Windows PowerShell Compatibility functionality for PowerShell 7. diff --git a/reference/7.4/Microsoft.PowerShell.Core/Add-History.md b/reference/7.4/Microsoft.PowerShell.Core/Add-History.md index cf3c68df767c..2199864ca462 100644 --- a/reference/7.4/Microsoft.PowerShell.Core/Add-History.md +++ b/reference/7.4/Microsoft.PowerShell.Core/Add-History.md @@ -16,7 +16,7 @@ Appends entries to the session history. ## SYNTAX ``` -Add-History [[-InputObject] ] [-Passthru] [] +Add-History [[-InputObject] ] [-PassThru] [] ``` ## DESCRIPTION @@ -138,7 +138,7 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Passthru +### -PassThru Indicates that this cmdlet returns a **HistoryInfo** object for each history entry. By default, this cmdlet does not generate any output. diff --git a/reference/7.4/Microsoft.PowerShell.Core/Import-Module.md b/reference/7.4/Microsoft.PowerShell.Core/Import-Module.md index 88a46751b4ae..570e08a17213 100644 --- a/reference/7.4/Microsoft.PowerShell.Core/Import-Module.md +++ b/reference/7.4/Microsoft.PowerShell.Core/Import-Module.md @@ -311,7 +311,7 @@ TestCmdlets Script ``` ```powershell -$a = Import-Module -Name Show-Calendar -AsCustomObject -Passthru +$a = Import-Module -Name Show-Calendar -AsCustomObject -PassThru $a | Get-Member ``` diff --git a/reference/7.4/Microsoft.PowerShell.Security/Set-Acl.md b/reference/7.4/Microsoft.PowerShell.Security/Set-Acl.md index 319f1aaf83a0..1f67bace631d 100644 --- a/reference/7.4/Microsoft.PowerShell.Security/Set-Acl.md +++ b/reference/7.4/Microsoft.PowerShell.Security/Set-Acl.md @@ -18,21 +18,21 @@ Changes the security descriptor of a specified item, such as a file or a registr ### ByPath (Default) ``` -Set-Acl [-Path] [-AclObject] [-ClearCentralAccessPolicy] [-Passthru] [-Filter ] +Set-Acl [-Path] [-AclObject] [-ClearCentralAccessPolicy] [-PassThru] [-Filter ] [-Include ] [-Exclude ] [-WhatIf] [-Confirm] [] ``` ### ByInputObject ``` -Set-Acl [-InputObject] [-AclObject] [-Passthru] [-Filter ] [-Include ] +Set-Acl [-InputObject] [-AclObject] [-PassThru] [-Filter ] [-Include ] [-Exclude ] [-WhatIf] [-Confirm] [] ``` ### ByLiteralPath ``` -Set-Acl -LiteralPath [-AclObject] [-ClearCentralAccessPolicy] [-Passthru] +Set-Acl -LiteralPath [-AclObject] [-ClearCentralAccessPolicy] [-PassThru] [-Filter ] [-Include ] [-Exclude ] [-WhatIf] [-Confirm] [] ``` @@ -318,7 +318,7 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Passthru +### -PassThru Returns an object that represents the security descriptor that was changed. By default, this cmdlet does not generate any output. diff --git a/reference/7.4/Microsoft.PowerShell.Utility/Invoke-RestMethod.md b/reference/7.4/Microsoft.PowerShell.Utility/Invoke-RestMethod.md index 08348ea5b971..4b1d6fe0b809 100644 --- a/reference/7.4/Microsoft.PowerShell.Utility/Invoke-RestMethod.md +++ b/reference/7.4/Microsoft.PowerShell.Utility/Invoke-RestMethod.md @@ -892,7 +892,7 @@ Accept wildcard characters: False By default, `Invoke-RestMethod` returns the results to the pipeline. When you use the **OutFile** parameter, the results are saved to the specified file and not returned to the pipeline. Enter a -path and filename. To send the results to a file and to the pipeline, add the **Passthru** +path and filename. To send the results to a file and to the pipeline, add the **PassThru** parameter. If you omit the path, the default is the current location. The name is treated as a literal path. diff --git a/reference/7.4/Microsoft.PowerShell.Utility/Invoke-WebRequest.md b/reference/7.4/Microsoft.PowerShell.Utility/Invoke-WebRequest.md index 11ba7f0dd8f1..002d7621ac68 100644 --- a/reference/7.4/Microsoft.PowerShell.Utility/Invoke-WebRequest.md +++ b/reference/7.4/Microsoft.PowerShell.Utility/Invoke-WebRequest.md @@ -917,7 +917,7 @@ Accept wildcard characters: False By default, `Invoke-WebRequest` returns the results to the pipeline. When you use the **OutFile** parameter, the results are saved to the specified file and not returned to the pipeline. Enter a -path and filename. To send the results to a file and to the pipeline, add the **Passthru** +path and filename. To send the results to a file and to the pipeline, add the **PassThru** parameter. If you omit the path, the default is the current location. The name is treated as a literal path. diff --git a/reference/7.4/Microsoft.PowerShell.Utility/Out-GridView.md b/reference/7.4/Microsoft.PowerShell.Utility/Out-GridView.md index b13eb4271499..dd0c634aacd6 100644 --- a/reference/7.4/Microsoft.PowerShell.Utility/Out-GridView.md +++ b/reference/7.4/Microsoft.PowerShell.Utility/Out-GridView.md @@ -196,7 +196,7 @@ The values of this parameter determine how many items you can send down the pipe - `Single`. Zero items or one item. Use this value when the next command can take only one input object. - `Multiple`. Zero, one, or many items. Use this value when the next command can take multiple input - objects. This value is equivalent to the **Passthru** parameter. + objects. This value is equivalent to the **PassThru** parameter. This parameter was introduced in Windows PowerShell 3.0. diff --git a/reference/7.5/CimCmdlets/Set-CimInstance.md b/reference/7.5/CimCmdlets/Set-CimInstance.md index dfdc16586778..a45f6a7953d8 100644 --- a/reference/7.5/CimCmdlets/Set-CimInstance.md +++ b/reference/7.5/CimCmdlets/Set-CimInstance.md @@ -102,14 +102,14 @@ Set-CimInstance -InputObject $x -Property @{VariableValue="somevalue"} -PassThru This example retrieves the CIM instance objects filtered by the Query parameter in to a variable `$x` using `Get-CimInstance`, and then passes the contents of the variable to the `Set-CimInstance` cmdlet. `Set-CimInstance` then modifies the **VariableValue** property to **somevalue**. Because the -**Passthru** parameter is used, This example returns a modified CIM instance object. +**PassThru** parameter is used, This example returns a modified CIM instance object. ### Example 4: Set the CIM instance property This example retrieves the CIM instance object that is specified in the **Query** parameter into a variable `$x` using the `Get-CimInstance` cmdlet, and changes the **VariableValue** property value of the object to change. The CIM instance object is then saved using the `Set-CimInstance` cmdlet. -Because the **Passthru** parameter is used, This example returns a modified CIM instance object. +Because the **PassThru** parameter is used, This example returns a modified CIM instance object. ```powershell $x = Get-CimInstance -Query 'Select * from Win32_Environment where name="testvar"' @@ -140,7 +140,7 @@ Set-CimInstance -Query 'Select * from Win32_Environment where name LIKE "testvar This example creates a CIM instance with the specified properties using the `New-CimInstance` cmdlet, and retrieves its contents in to a variable `$x`. The variable is then passed to the `Set-CimInstance` cmdlet, which modifies the value of **VariableValue** property to **somevalue**. -Because the **Passthru** parameter is used, This example returns a modified CIM instance object. +Because the **PassThru** parameter is used, This example returns a modified CIM instance object. ```powershell $x = New-CimInstance -ClassName Win32_Environment -Property @{Name="testvar";UserName="domain\user"} -Key Name,UserName -ClientOnly @@ -411,7 +411,7 @@ By default, this cmdlet returns no output. ### Microsoft.Management.Infrastructure.CimInstance -When you use the **Passthru** parameter, this cmdlet returns the modified CIM instance object. +When you use the **PassThru** parameter, this cmdlet returns the modified CIM instance object. ## NOTES diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/About.md b/reference/7.5/Microsoft.PowerShell.Core/About/About.md index bfc06d422c9b..5f9572b08a66 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/About.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/About.md @@ -2,7 +2,7 @@ description: About topics cover a range of concepts about PowerShell. Help Version: 7.5.0.0 Locale: en-US -ms.date: 11/10/2023 +ms.date: 11/06/2024 title: About topics --- # About topics @@ -39,7 +39,8 @@ Describes how to use operators to assign values to variables. ### [about_Automatic_Variables](about_Automatic_Variables.md) -Describes variables that store state information for PowerShell. These variables are created and maintained by PowerShell. +Describes variables that store state information for PowerShell. These variables are created and +maintained by PowerShell. ### [about_Booleans](about_Booleans.md) @@ -55,11 +56,13 @@ Describes the built-in functions in PowerShell. ### [about_Calculated_Properties](about_Calculated_Properties.md) -PowerShell provides the ability to dynamically add new properties and alter the formatting of objects output to the pipeline. +PowerShell provides the ability to dynamically add new properties and alter the formatting of +objects output to the pipeline. ### [about_Calling_Generic_Methods](about_Calling_Generic_Methods.md) -A generic method is a method with two parameter lists: a list of generic types and a list of method arguments. The following examples show the new PowerShell syntax for accessing a generic method: ```Syntax # static generic methods [type_name]::MethodName[generic_type_arguments](method_arguments) # instance generic methods $object.MethodName[generic_type_arguments](method_arguments) ``` The `generic_type_arguments` can be a single type or comma-separated list of types, like `[string, int]`, including other generic types like `$obj.MethodName[string, System.Collections.Generic.Dictionary[string, int]]()` The `method_arguments` can be zero or more items. For more information, see [Generics in .NET](/dotnet/standard/generics/). +Generics let you tailor a method, class, structure, or interface to the precise data type it acts +upon. ### [about_Case-Sensitivity](about_Case-Sensitivity.md) @@ -111,11 +114,13 @@ Describes the parameters that can be used with any cmdlet. ### [about_Comparison_Operators](about_Comparison_Operators.md) -The comparison operators in PowerShell can either compare two values or filter elements of a collection against an input value. +The comparison operators in PowerShell can either compare two values or filter elements of a +collection against an input value. ### [about_Continue](about_Continue.md) -Describes how the `continue` statement immediately returns the program flow to the top of a program loop, a `switch` statement, or a `trap` statement. +Describes how the `continue` statement immediately returns the program flow to the top of a program +loop, a `switch` statement, or a `trap` statement. ### [about_Core_Commands](about_Core_Commands.md) @@ -139,7 +144,8 @@ Runs a statement list one or more times, subject to a `While` or `Until` conditi ### [about_Enum](about_Enum.md) -The `enum` statement is used to declare an enumeration. An enumeration is a distinct type that consists of a set of named labels called the enumerator list. +The `enum` statement is used to declare an enumeration. An enumeration is a distinct type that +consists of a set of named labels called the enumerator list. ### [about_Environment_Provider](about_Environment_Provider.md) @@ -155,7 +161,8 @@ Describes the PowerShell execution policies and explains how to manage them. ### [about_Experimental_Features](about_Experimental_Features.md) -Use the `Experimental` attribute to declare some code as experimental. Use the following syntax to declare the `Experimental` attribute providing the name of the experimental feature and the action to take if the experimental feature is enabled: ```csharp [Experimental(NameOfExperimentalFeature, ExperimentAction)] ``` For modules, the `NameOfExperimentalFeature` must follow the form of `.`. The `ExperimentAction` parameter must be specified and the only valid values are: - `Show` means to show this experimental feature if the feature is enabled - `Hide` means to hide this experimental feature if the feature is enabled +The PowerShell provides a mechanism for experimental features to coexist with existing stable +features in the PowerShell engine or in a PowerShell module. ### [about_FileSystem_Provider](about_FileSystem_Provider.md) @@ -171,7 +178,8 @@ Describes a language command you can use to traverse all the items in a collecti ### [about_Format.ps1xml](about_Format.ps1xml.md) -The `Format.ps1xml` files in PowerShell define the default display of objects in the PowerShell console. +The `Format.ps1xml` files in PowerShell define the default display of objects in the PowerShell +console. ### [about_Function_Provider](about_Function_Provider.md) @@ -179,7 +187,8 @@ Provides access to the functions defined in PowerShell. ### [about_Functions_Advanced_Methods](about_Functions_Advanced_Methods.md) -Describes how functions that specify the `CmdletBinding` attribute can use the methods and properties that are available to compiled cmdlets. +Describes how functions that specify the `CmdletBinding` attribute can use the methods and +properties that are available to compiled cmdlets. ### [about_Functions_Advanced_Parameters](about_Functions_Advanced_Parameters.md) @@ -191,7 +200,8 @@ Introduces advanced functions that are a way to create cmdlets using scripts. ### [about_Functions_Argument_Completion](about_Functions_Argument_Completion.md) -Argument completion is a feature of PowerShell that provide hints, enables discovery, and speeds up input entry of argument values. +Argument completion is a feature of PowerShell that provide hints, enables discovery, and speeds up +input entry of argument values. ### [about_Functions_CmdletBindingAttribute](about_Functions_CmdletBindingAttribute.md) @@ -223,11 +233,13 @@ Describes how to get and run commands in the command history. ### [about_If](about_If.md) -Describes a language command you can use to run statement lists based on the results of one or more conditional tests. +Describes a language command you can use to run statement lists based on the results of one or more +conditional tests. ### [about_Intrinsic_Members](about_Intrinsic_Members.md) -Provides information about PowerShell's intrinsic members that are available to all PowerShell objects. +Provides information about PowerShell's intrinsic members that are available to all PowerShell +objects. ### [about_Job_Details](about_Job_Details.md) @@ -235,7 +247,8 @@ Provides details about background jobs on local and remote computers. ### [about_Jobs](about_Jobs.md) -Provides information about how PowerShell background jobs run a command or expression in the background without interacting with the current session. +Provides information about how PowerShell background jobs run a command or expression in the +background without interacting with the current session. ### [about_Join](about_Join.md) @@ -263,7 +276,8 @@ PowerShell logs internal operations from the engine, providers, and cmdlets. ### [about_Logging_Windows](about_Logging_Windows.md) -PowerShell logs internal operations from the engine, providers, and cmdlets to the Windows event log. +PowerShell logs internal operations from the engine, providers, and cmdlets to the Windows event +log. ### [about_Logical_Operators](about_Logical_Operators.md) @@ -367,7 +381,8 @@ Describes how to use object properties in PowerShell. ### [about_Providers](about_Providers.md) -Describes how PowerShell providers provide access to data and components that wouldn't otherwise be easily accessible at the command line. The data is presented in a consistent format that resembles a file system drive. +PowerShell providers provide access to data and components, presented in a consistent format that +resembles a file system drive. ### [about_PSConsoleHostReadLine](about_PSConsoleHostReadLine.md) @@ -391,11 +406,13 @@ Provides detailed information about PowerShell sessions and the role they play i ### [about_PSSessions](about_PSSessions.md) -Describes PowerShell sessions (PSSessions) and explains how to establish a persistent connection to a remote computer. +Describes PowerShell sessions (PSSessions) and explains how to establish a persistent connection to +a remote computer. ### [about_Pwsh](about_Pwsh.md) -Explains how to use the `pwsh` command-line interface. Displays the command-line parameters and describes the syntax. +Explains how to use the `pwsh` command-line interface. Displays the command-line parameters and +describes the syntax. ### [about_Quoting_Rules](about_Quoting_Rules.md) @@ -407,11 +424,12 @@ Explains how to redirect output from PowerShell to text files. ### [about_Ref](about_Ref.md) -Describes how to create and use a reference type variable. You can use reference type variables to permit a function to change the value of a variable that is passed to it. +Describes how to create and use a reference type variable. You can use reference type variables to +permit a function to change the value of a variable that is passed to it. ### [about_Registry_Provider](about_Registry_Provider.md) -Registry +Describes teh features and functions of the Registry provider. ### [about_Regular_Expressions](about_Regular_Expressions.md) @@ -431,7 +449,8 @@ Describes how to interpret and format the output of remote commands. ### [about_Remote_Requirements](about_Remote_Requirements.md) -Describes the system requirements and configuration requirements for running remote commands in PowerShell. +Describes the system requirements and configuration requirements for running remote commands in +PowerShell. ### [about_Remote_Troubleshooting](about_Remote_Troubleshooting.md) @@ -451,7 +470,8 @@ Prevents a script from running without the required elements. ### [about_Reserved_Words](about_Reserved_Words.md) -Lists the reserved words that cannot be used as identifiers because they have a special meaning in PowerShell. +Lists the reserved words that cannot be used as identifiers because they have a special meaning in +PowerShell. ### [about_Return](about_Return.md) @@ -471,7 +491,8 @@ Defines what a script block is and explains how to use script blocks in the Powe ### [about_Script_Internationalization](about_Script_Internationalization.md) -Describes the script internationalization features that make it easy for scripts to display messages and instructions to users in their user interface (UI) language. +Describes the script internationalization features that make it easy for scripts to display messages +and instructions to users in their user interface (UI) language. ### [about_Scripts](about_Scripts.md) @@ -479,11 +500,13 @@ Describes how to run and write scripts in PowerShell. ### [about_Session_Configuration_Files](about_Session_Configuration_Files.md) -Describes session configuration files, which are used in a session configuration (also known as an "endpoint") to define the environment of sessions that use the session configuration. +Describes session configuration files, which are used in a session configuration (also known as an +"endpoint") to define the environment of sessions that use the session configuration. ### [about_Session_Configurations](about_Session_Configurations.md) -Describes session configurations, which determine the users who can connect to the computer remotely and the commands they can run. +Describes session configurations, which determine the users who can connect to the computer remotely +and the commands they can run. ### [about_Signing](about_Signing.md) @@ -495,7 +518,8 @@ Describes easier, more natural-language ways of scripting filters for collection ### [about_Special_Characters](about_Special_Characters.md) -Describes the special character sequences that control how PowerShell interprets the next characters in the sequence. +Describes the special character sequences that control how PowerShell interprets the next characters +in the sequence. ### [about_Splatting](about_Splatting.md) @@ -511,7 +535,8 @@ Explains how to use a switch to handle multiple `if` statements. ### [about_Tab_Expansion](about_Tab_Expansion.md) -PowerShell provides completions on input to provide hints, enable discovery, and speed up input entry. Command names, parameter names, argument values and file paths can all be completed by pressing the Tab key. +PowerShell provides completions on input to provide hints, enable discovery, and speed up input +entry by pressing the Tab key. ### [about_Telemetry](about_Telemetry.md) @@ -519,7 +544,8 @@ Describes the telemetry collected in PowerShell and how to opt-out. ### [about_Thread_Jobs](about_Thread_Jobs.md) -Provides information about PowerShell thread-based jobs. A thread job is a type of background job that runs a command or expression in a separate thread within the current session process. +Provides information about PowerShell thread-based jobs. A thread job is a type of background job +that runs a command or expression in a separate thread within the current session process. ### [about_Throw](about_Throw.md) @@ -567,7 +593,8 @@ Describes how variables store values that can be used in PowerShell. ### [about_While](about_While.md) -Describes a language statement that you can use to run a command block based on the results of a conditional test. +Describes a language statement that you can use to run a command block based on the results of a +conditional test. ### [about_Wildcards](about_Wildcards.md) diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_ANSI_Terminals.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_ANSI_Terminals.md index 4957724d6c7b..89b6f13d14a0 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_ANSI_Terminals.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_ANSI_Terminals.md @@ -230,7 +230,7 @@ in the `bash` process, outside of the PowerShell host, the output isn't affected by **OutputRendering**. ```bash -pwsh -noprofile -command 'Get-Childitem' > out.txt +pwsh -noprofile -command 'Get-ChildItem' > out.txt ``` When you inspect the contents of `out.txt` you see the ANSI escape sequences. @@ -239,7 +239,7 @@ By contrast, when redirection occurs within the PowerShell session, **OutputRendering** affects the redirected output. ```bash -pwsh -noprofile -command 'Get-Childitem > out.txt' +pwsh -noprofile -command 'Get-ChildItem > out.txt' ``` When you inspect the contents of `out.txt` there are no ANSI escape sequences. diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Arithmetic_Operators.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Arithmetic_Operators.md index f24422ddebec..66405c4c2e61 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Arithmetic_Operators.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Arithmetic_Operators.md @@ -227,7 +227,7 @@ following example, the negative value can't be cast to an unsigned integer, and the unsigned integer is too large to be cast to `Int32`: ```powershell -([int32]::minvalue + [uint32]::maxvalue).gettype().fullname +([int32]::minvalue + [uint32]::maxvalue).GetType().FullName ``` ```output diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md index 15274405dc6c..dc02ac212b81 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md @@ -675,11 +675,11 @@ PS> .\Update-Month.ps1 .EXAMPLE -PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv +PS> .\Update-Month.ps1 -InputPath C:\Data\January.csv .EXAMPLE -PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv -outputPath ` +PS> .\Update-Month.ps1 -InputPath C:\Data\January.csv -outputPath ` C:\Reports\2009\January.csv #> diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Data_Sections.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Data_Sections.md index 4673e7cc6b50..f285108e5225 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Data_Sections.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Data_Sections.md @@ -173,7 +173,7 @@ A single-quoted here-string that uses the `ConvertFrom-StringData` cmdlet: ```powershell DATA { - ConvertFrom-StringData -stringdata @' + ConvertFrom-StringData -StringData @' Text001 = Windows 7 Text002 = Windows Server 2008 R2 '@ @@ -184,7 +184,7 @@ A double-quoted here-string that uses the `ConvertFrom-StringData` cmdlet: ```powershell DATA { - ConvertFrom-StringData -stringdata @" + ConvertFrom-StringData -StringData @" Msg1 = To start, press any key. Msg2 = To exit, type "quit". "@ diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Function_Provider.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Function_Provider.md index 1b8f84a499e9..0ce0be66aa66 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Function_Provider.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Function_Provider.md @@ -126,11 +126,11 @@ ${function:Clear-Host} This command gets the `man` function from the `Function:` drive. It uses the `Get-Item` cmdlet to get the function. The pipeline operator (`|`) sends the result to `Format-Table`. The `-Wrap` parameter directs text that does not fit -on the line onto the next line. The `-Autosize` parameter resizes the table +on the line onto the next line. The `-AutoSize` parameter resizes the table columns to accommodate the text. ```powershell -Get-Item -Path man | Format-Table -Wrap -Autosize +Get-Item -Path man | Format-Table -Wrap -AutoSize ``` ### Working with Function provider paths diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Line_Editing.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Line_Editing.md index 310b2f6a1b77..9d7b8a40ed4d 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Line_Editing.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Line_Editing.md @@ -78,4 +78,4 @@ key. To scroll through a list of values, press the Tab key again. - [about_Command_Syntax](about_Command_Syntax.md) - [about_Path_Syntax](about_Path_Syntax.md) -- [about_PSReadline](../../PSReadline/About/about_PSReadline.md) +- [about_PSReadLine](../../PSReadline/About/about_PSReadline.md) diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Logging_Non-Windows.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Logging_Non-Windows.md index ffb4687cab42..d9a5684334c9 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Logging_Non-Windows.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Logging_Non-Windows.md @@ -46,7 +46,7 @@ PowerShell supports configuring two categories of logging: ```powershell $psrl = Get-Module PSReadLine $psrl.LogPipelineExecutionDetails = $true - Get-Module PSReadline | Select-Object Name, LogPipelineExecutionDetails + Get-Module PSReadLine | Select-Object Name, LogPipelineExecutionDetails ``` ```Output diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Logging_Windows.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Logging_Windows.md index 54697eb11e47..5a67d5f67ead 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Logging_Windows.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Logging_Windows.md @@ -38,7 +38,7 @@ PowerShell supports configuring two categories of logging: ```powershell $psrl = Get-Module PSReadLine $psrl.LogPipelineExecutionDetails = $true - Get-Module PSReadline | Select-Object Name, LogPipelineExecutionDetails + Get-Module PSReadLine | Select-Object Name, LogPipelineExecutionDetails ``` ```Output diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Operators.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Operators.md index 57d5d2373090..8995fa382fb6 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Operators.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Operators.md @@ -252,9 +252,9 @@ This example stores a command in a string and executes it using the call operator. ``` -PS> $c = "get-executionpolicy" +PS> $c = "Get-ExecutionPolicy" PS> $c -get-executionpolicy +Get-ExecutionPolicy PS> & $c AllSigned ``` diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Parameter_Sets.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Parameter_Sets.md index 9907fb1d0dfd..b1993dc37afa 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Parameter_Sets.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Parameter_Sets.md @@ -126,9 +126,9 @@ function Measure-Lines { } foreach ($file in $Files) { $result = [ordered]@{ } - $result.Add('File', $file.fullname) + $result.Add('File', $file.FullName) - $content = Get-Content -LiteralPath $file.fullname + $content = Get-Content -LiteralPath $file.FullName if ($Lines) { $result.Add('Lines', $content.Length) } diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Regular_Expressions.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Regular_Expressions.md index 299db41b23af..35f1a1ac10b6 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Regular_Expressions.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Regular_Expressions.md @@ -37,7 +37,7 @@ shown above has a different way to force case sensitivity. - For `Select-String`, use the **CaseSensitive** parameter. - For operators that use regular expressions, use the case-sensitive version: `-cmatch`, `-creplace`, or `-csplit` -- For the `switch` statement, use the `-casesensitive` option +- For the `switch` statement, use the `-CaseSensitive` option ## Character literals diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Scripts.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Scripts.md index 287a5ae61d97..05589362c3cc 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Scripts.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Scripts.md @@ -152,8 +152,8 @@ running on the current system and saves them to a log file. The log filename is created from the current date. ```powershell -$date = (get-date).dayofyear -get-service | out-file "$date.log" +$date = (Get-Date).DayOfYear +Get-Service | Out-File "$date.log" ``` To create this script, open a text editor or a script editor, type these @@ -182,7 +182,7 @@ param ($ComputerName = $(throw "ComputerName parameter is required.")) function CanPing { $error.clear() - $tmp = test-connection $computername -erroraction SilentlyContinue + $tmp = Test-Connection $computername -ErrorAction SilentlyContinue if (!$?) {write-host "Ping failed: $ComputerName."; return $false} @@ -191,7 +191,7 @@ function CanPing { } function CanRemote { - $s = new-pssession $computername -erroraction SilentlyContinue + $s = New-PSSession $computername -ErrorAction SilentlyContinue if ($s -is [System.Management.Automation.Runspaces.PSSession]) {write-host "Remote test succeeded: $ComputerName."} diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Signing.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Signing.md index bb8fdf4b7a74..6652d4762404 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Signing.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Signing.md @@ -203,7 +203,7 @@ a certificate file in the file system directory. At the PowerShell prompt, type: ```powershell -Get-ChildItem cert:\CurrentUser\my -codesigning +Get-ChildItem cert:\CurrentUser\my -CodeSigning ``` This command uses the PowerShell Certificate provider to view information diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Type_Operators.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Type_Operators.md index ee6cca8b428e..86ee04aaf949 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Type_Operators.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Type_Operators.md @@ -30,13 +30,13 @@ PowerShell has the following type operators: - `-is` |Returns TRUE when the input is an instance of the specified .NET type. ```powershell - (get-date) -is [DateTime] # Result is True + (Get-Date) -is [DateTime] # Result is True ``` - `-isnot`|Returns TRUE when the input not an instance of the specified.NET type. ```powershell - (get-date) -isnot [DateTime] # Result is False + (Get-Date) -isnot [DateTime] # Result is False ``` - `-as` |Converts the input to the specified .NET type. @@ -155,7 +155,7 @@ False PS> 32 -is "int" True -PS> (get-date) -is [DateTime] +PS> (Get-Date) -is [DateTime] True PS> "12/31/2007" -is [DateTime] @@ -180,25 +180,25 @@ return **System.Globalization.CultureInfo** objects, a collection of these objects is a System.Object array. ```powershell -PS> (get-culture) -is [System.Globalization.CultureInfo] +PS> (Get-Culture) -is [System.Globalization.CultureInfo] True -PS> (get-uiculture) -is [System.Globalization.CultureInfo] +PS> (Get-UICulture) -is [System.Globalization.CultureInfo] True -PS> (get-culture), (get-uiculture) -is [System.Globalization.CultureInfo] +PS> (Get-Culture), (Get-UICulture) -is [System.Globalization.CultureInfo] False -PS> (get-culture), (get-uiculture) -is [Array] +PS> (Get-Culture), (Get-UICulture) -is [Array] True -PS> (get-culture), (get-uiculture) | foreach { +PS> (Get-Culture), (Get-UICulture) | foreach { $_ -is [System.Globalization.CultureInfo]) } True True -PS> (get-culture), (get-uiculture) -is [Object] +PS> (Get-Culture), (Get-UICulture) -is [Object] True ``` diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Types.ps1xml.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Types.ps1xml.md index b53d02e5097d..30394fb0ffeb 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Types.ps1xml.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Types.ps1xml.md @@ -217,7 +217,7 @@ For more information about `Update-TypeData`, see [Update-TypeData](xref:Microsoft.PowerShell.Utility.Update-TypeData). ```powershell -Update-Typedata -PrependPath $PSHOME\MyTypes.ps1xml +Update-TypeData -PrependPath $PSHOME\MyTypes.ps1xml ``` To test the change, run a `Get-ChildItem` command to get the PowerShell.exe diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Variable_Provider.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Variable_Provider.md index 3f765bc1d2f2..8baca994b16f 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Variable_Provider.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Variable_Provider.md @@ -152,7 +152,7 @@ a wildcard in paths, but `Get-ChildItem` does not attempt to resolve any wildcards in the values of the `-LiteralPath` parameter. ```powershell -Get-ChildItem -Literalpath ? +Get-ChildItem -LiteralPath ? ``` ### Get ReadOnly and Constant variables diff --git a/reference/7.5/Microsoft.PowerShell.Core/Add-History.md b/reference/7.5/Microsoft.PowerShell.Core/Add-History.md index 4936174c0bbd..cfc81afadb0f 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/Add-History.md +++ b/reference/7.5/Microsoft.PowerShell.Core/Add-History.md @@ -16,7 +16,7 @@ Appends entries to the session history. ## SYNTAX ``` -Add-History [[-InputObject] ] [-Passthru] [] +Add-History [[-InputObject] ] [-PassThru] [] ``` ## DESCRIPTION @@ -138,7 +138,7 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Passthru +### -PassThru Indicates that this cmdlet returns a **HistoryInfo** object for each history entry. By default, this cmdlet does not generate any output. diff --git a/reference/7.5/Microsoft.PowerShell.Core/Get-Command.md b/reference/7.5/Microsoft.PowerShell.Core/Get-Command.md index 02dc652230cd..47a79d70243d 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/Get-Command.md +++ b/reference/7.5/Microsoft.PowerShell.Core/Get-Command.md @@ -113,7 +113,7 @@ This command uses the **ArgumentList** and **Syntax** parameters to get the synt that the Certificate Provider adds to the session. ```powershell -Get-Command -Name Get-Childitem -Args Cert: -Syntax +Get-Command -Name Get-ChildItem -Args Cert: -Syntax ``` When you compare the syntax displayed in the output with the syntax that is displayed when you omit diff --git a/reference/7.5/Microsoft.PowerShell.Core/Get-Module.md b/reference/7.5/Microsoft.PowerShell.Core/Get-Module.md index 3b97f0a41d65..329effea5a19 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/Get-Module.md +++ b/reference/7.5/Microsoft.PowerShell.Core/Get-Module.md @@ -201,7 +201,7 @@ in Windows PowerShell 3.0. ### Example 6: Group all modules by name ```powershell -Get-Module -ListAvailable -All | Format-Table -Property Name, Moduletype, Path -Groupby Name +Get-Module -ListAvailable -All | Format-Table -Property Name, ModuleType, Path -GroupBy Name ``` ```Output diff --git a/reference/7.5/Microsoft.PowerShell.Core/Import-Module.md b/reference/7.5/Microsoft.PowerShell.Core/Import-Module.md index 874b59531fd6..9d87b4cd7c4b 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/Import-Module.md +++ b/reference/7.5/Microsoft.PowerShell.Core/Import-Module.md @@ -311,7 +311,7 @@ TestCmdlets Script ``` ```powershell -$a = Import-Module -Name Show-Calendar -AsCustomObject -Passthru +$a = Import-Module -Name Show-Calendar -AsCustomObject -PassThru $a | Get-Member ``` diff --git a/reference/7.5/Microsoft.PowerShell.Core/Register-PSSessionConfiguration.md b/reference/7.5/Microsoft.PowerShell.Core/Register-PSSessionConfiguration.md index 59df621d1d6d..dc1679ae76b2 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/Register-PSSessionConfiguration.md +++ b/reference/7.5/Microsoft.PowerShell.Core/Register-PSSessionConfiguration.md @@ -98,7 +98,7 @@ $sessionConfiguration = @{ Register-PSSessionConfiguration @sessionConfiguration ``` -To use this configuration, type `New-PSSession -ConfigurationName newshell`. +To use this configuration, type `New-PSSession -ConfigurationName NewShell`. ### Example 2: Register a MaintenanceShell session configuration @@ -120,7 +120,7 @@ This example registers the **AdminShell** session configuration. The `$sessionParams` variable is a hashtable containing all the parameter values. This hashtable is passed to the cmdlet using PowerShell splatting. The `Register-PSSessionConfiguration` command uses -the **SecurityDescritorSDDL** parameter to specify the SDDL in the value of the `$sddl` variable and +the **SecurityDescriptorSDDL** parameter to specify the SDDL in the value of the `$sddl` variable and the **MaximumReceivedObjectSizeMB** parameter to increase the object size limit. It also uses the **StartupScript** parameter to specify a script that configures the session. diff --git a/reference/7.5/Microsoft.PowerShell.Core/Test-ModuleManifest.md b/reference/7.5/Microsoft.PowerShell.Core/Test-ModuleManifest.md index f684ee866f67..4ee4f99781f4 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/Test-ModuleManifest.md +++ b/reference/7.5/Microsoft.PowerShell.Core/Test-ModuleManifest.md @@ -44,7 +44,7 @@ This command tests the `TestModule.psd1` module manifest. ### Example 2: Test a manifest by using the pipeline ```powershell -"$pshome\Modules\TestModule.psd1" | test-modulemanifest +"$pshome\Modules\TestModule.psd1" | Test-ModuleManifest ``` ```Output diff --git a/reference/7.5/Microsoft.PowerShell.Core/Update-Help.md b/reference/7.5/Microsoft.PowerShell.Core/Update-Help.md index 2f68e182ca99..f75fcda5cda1 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/Update-Help.md +++ b/reference/7.5/Microsoft.PowerShell.Core/Update-Help.md @@ -206,10 +206,10 @@ foreach ($mModule in $Modules) { $mDir = $mModule.ModuleBase - if (Test-Path $mdir\*helpinfo.xml) + if (Test-Path $mDir\*helpinfo.xml) { $mName=$mModule.Name - $mNodes = dir $mdir\*helpinfo.xml -ErrorAction SilentlyContinue | + $mNodes = dir $mDir\*helpinfo.xml -ErrorAction SilentlyContinue | Select-Xml -Namespace $HelpInfoNamespace -XPath "//helpInfo:UICulture" foreach ($mNode in $mNodes) { diff --git a/reference/7.5/Microsoft.PowerShell.Diagnostics/Get-WinEvent.md b/reference/7.5/Microsoft.PowerShell.Diagnostics/Get-WinEvent.md index 78b99e810e98..119e5cdc8cc2 100644 --- a/reference/7.5/Microsoft.PowerShell.Diagnostics/Get-WinEvent.md +++ b/reference/7.5/Microsoft.PowerShell.Diagnostics/Get-WinEvent.md @@ -596,7 +596,7 @@ that occurred within the last week. ```powershell $StartTime = (Get-Date).AddDays(-7) Get-WinEvent -FilterHashtable @{ - Logname='Application' + LogName='Application' ProviderName='Application Error' Data='iexplore.exe' StartTime=$StartTime @@ -842,7 +842,7 @@ cmdlet. > PowerShell does not limit the amount of logs you can request. However, the `Get-WinEvent` cmdlet > queries the Windows API which has a limit of 256. This can make it difficult to filter through all > of your logs at one time. You can work around this by using a `foreach` loop to iterate through each -> log like this: `Get-WinEvent -ListLog * | ForEach-Object{ Get-WinEvent -LogName $_.Logname }` +> log like this: `Get-WinEvent -ListLog * | ForEach-Object{ Get-WinEvent -LogName $_.LogName }` ```yaml Type: System.String[] diff --git a/reference/7.5/Microsoft.PowerShell.Management/Get-Content.md b/reference/7.5/Microsoft.PowerShell.Management/Get-Content.md index 0c1f470eca30..70befdee0283 100644 --- a/reference/7.5/Microsoft.PowerShell.Management/Get-Content.md +++ b/reference/7.5/Microsoft.PowerShell.Management/Get-Content.md @@ -253,7 +253,7 @@ This example demonstrates how to get the contents of a file as a `[byte[]]` as a ```powershell $byteArray = Get-Content -Path C:\temp\test.txt -AsByteStream -Raw -Get-Member -InputObject $bytearray +Get-Member -InputObject $byteArray ``` ```Output diff --git a/reference/7.5/Microsoft.PowerShell.Management/Get-PSProvider.md b/reference/7.5/Microsoft.PowerShell.Management/Get-PSProvider.md index 8e85c004cba4..0235841b80ad 100644 --- a/reference/7.5/Microsoft.PowerShell.Management/Get-PSProvider.md +++ b/reference/7.5/Microsoft.PowerShell.Management/Get-PSProvider.md @@ -102,7 +102,7 @@ C:\Users\User01 ``` ```powershell -PS C:\> (get-psprovider FileSystem).home +PS C:\> (Get-PSProvider FileSystem).Home ``` ```Output diff --git a/reference/7.5/Microsoft.PowerShell.Management/Get-Process.md b/reference/7.5/Microsoft.PowerShell.Management/Get-Process.md index 2ca5e438ca8c..2b28077359d5 100644 --- a/reference/7.5/Microsoft.PowerShell.Management/Get-Process.md +++ b/reference/7.5/Microsoft.PowerShell.Management/Get-Process.md @@ -227,7 +227,7 @@ The second command gets the PowerShell process that's hosting the current sessio ### Example 10: Get all processes that have a main window title and display them in a table ```powershell -Get-Process | Where-Object {$_.mainWindowTitle} | Format-Table Id, Name, mainWindowtitle -AutoSize +Get-Process | Where-Object {$_.mainWindowTitle} | Format-Table Id, Name, mainWindowTitle -AutoSize ``` This command gets all the processes that have a main window title, and it displays them in a table diff --git a/reference/7.5/Microsoft.PowerShell.Management/Get-Service.md b/reference/7.5/Microsoft.PowerShell.Management/Get-Service.md index 130972ac3936..5015a7184dd4 100644 --- a/reference/7.5/Microsoft.PowerShell.Management/Get-Service.md +++ b/reference/7.5/Microsoft.PowerShell.Management/Get-Service.md @@ -75,7 +75,7 @@ display name finds network-related services even when the service name doesn't i xmlprov, the Network Provisioning Service. ```powershell -Get-Service -Displayname "*network*" +Get-Service -DisplayName "*network*" ``` ### Example 4: Get services that begin with a search string and an exclusion @@ -109,7 +109,7 @@ This example gets services that have dependent services. Get-Service | Where-Object {$_.DependentServices} | Format-List -Property Name, DependentServices, @{ - Label="NoOfDependentServices"; Expression={$_.dependentservices.count} + Label="NoOfDependentServices"; Expression={$_.DependentServices.Count} } ``` diff --git a/reference/7.5/Microsoft.PowerShell.Management/New-Item.md b/reference/7.5/Microsoft.PowerShell.Management/New-Item.md index a9a790ef381b..d67d2f066969 100644 --- a/reference/7.5/Microsoft.PowerShell.Management/New-Item.md +++ b/reference/7.5/Microsoft.PowerShell.Management/New-Item.md @@ -90,7 +90,7 @@ This command creates a directory named "Logfiles" in the `C:` drive. The **ItemT specifies that the new item is a directory, not a file or other file system object. ```powershell -New-Item -Path "c:\" -Name "logfiles" -ItemType "directory" +New-Item -Path "c:\" -Name "Logfiles" -ItemType "directory" ``` ### Example 3: Create a profile diff --git a/reference/7.5/Microsoft.PowerShell.Management/New-ItemProperty.md b/reference/7.5/Microsoft.PowerShell.Management/New-ItemProperty.md index b556e664c2a9..27835213fe88 100644 --- a/reference/7.5/Microsoft.PowerShell.Management/New-ItemProperty.md +++ b/reference/7.5/Microsoft.PowerShell.Management/New-ItemProperty.md @@ -97,7 +97,7 @@ $newValue = New-ItemProperty -Path "HKLM:\SOFTWARE\ContosoCompany\" -Name 'HereS This is text which contains newlines It can also contain "quoted" strings "@ -$newValue.multistring +$newValue.MultiString ``` ```output @@ -111,7 +111,7 @@ The example shows how to use an array of values to create the `MultiString` valu ```powershell $newValue = New-ItemProperty -Path "HKLM:\SOFTWARE\ContosoCompany\" -Name 'MultiString' -PropertyType MultiString -Value ('a','b','c') -$newValue.multistring[0] +$newValue.MultiString[0] ``` ```output diff --git a/reference/7.5/Microsoft.PowerShell.Management/Test-Connection.md b/reference/7.5/Microsoft.PowerShell.Management/Test-Connection.md index 41635c3a725d..64d25a677bc4 100644 --- a/reference/7.5/Microsoft.PowerShell.Management/Test-Connection.md +++ b/reference/7.5/Microsoft.PowerShell.Management/Test-Connection.md @@ -536,7 +536,7 @@ Accept wildcard characters: False ### -Traceroute -Causes the cmdlet to do a traceroute test. When this parameter is used, the cmdlet returns a +Causes the cmdlet to do a Traceroute test. When this parameter is used, the cmdlet returns a `TestConnectionCommand+TraceStatus` object. ```yaml diff --git a/reference/7.5/Microsoft.PowerShell.Security/Set-Acl.md b/reference/7.5/Microsoft.PowerShell.Security/Set-Acl.md index 5ca60aa42b6d..7c8f8a2bdf6b 100644 --- a/reference/7.5/Microsoft.PowerShell.Security/Set-Acl.md +++ b/reference/7.5/Microsoft.PowerShell.Security/Set-Acl.md @@ -18,21 +18,21 @@ Changes the security descriptor of a specified item, such as a file or a registr ### ByPath (Default) ``` -Set-Acl [-Path] [-AclObject] [-ClearCentralAccessPolicy] [-Passthru] [-Filter ] +Set-Acl [-Path] [-AclObject] [-ClearCentralAccessPolicy] [-PassThru] [-Filter ] [-Include ] [-Exclude ] [-WhatIf] [-Confirm] [] ``` ### ByInputObject ``` -Set-Acl [-InputObject] [-AclObject] [-Passthru] [-Filter ] [-Include ] +Set-Acl [-InputObject] [-AclObject] [-PassThru] [-Filter ] [-Include ] [-Exclude ] [-WhatIf] [-Confirm] [] ``` ### ByLiteralPath ``` -Set-Acl -LiteralPath [-AclObject] [-ClearCentralAccessPolicy] [-Passthru] +Set-Acl -LiteralPath [-AclObject] [-ClearCentralAccessPolicy] [-PassThru] [-Filter ] [-Include ] [-Exclude ] [-WhatIf] [-Confirm] [] ``` @@ -318,7 +318,7 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Passthru +### -PassThru Returns an object that represents the security descriptor that was changed. By default, this cmdlet does not generate any output. diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Invoke-RestMethod.md b/reference/7.5/Microsoft.PowerShell.Utility/Invoke-RestMethod.md index bced273a9e70..5efc3687bdc6 100644 --- a/reference/7.5/Microsoft.PowerShell.Utility/Invoke-RestMethod.md +++ b/reference/7.5/Microsoft.PowerShell.Utility/Invoke-RestMethod.md @@ -892,7 +892,7 @@ Accept wildcard characters: False By default, `Invoke-RestMethod` returns the results to the pipeline. When you use the **OutFile** parameter, the results are saved to the specified file and not returned to the pipeline. Enter a -path and filename. To send the results to a file and to the pipeline, add the **Passthru** +path and filename. To send the results to a file and to the pipeline, add the **PassThru** parameter. If you omit the path, the default is the current location. The name is treated as a literal path. diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Invoke-WebRequest.md b/reference/7.5/Microsoft.PowerShell.Utility/Invoke-WebRequest.md index 89bfb5addc07..89f5cc48ff24 100644 --- a/reference/7.5/Microsoft.PowerShell.Utility/Invoke-WebRequest.md +++ b/reference/7.5/Microsoft.PowerShell.Utility/Invoke-WebRequest.md @@ -917,7 +917,7 @@ Accept wildcard characters: False By default, `Invoke-WebRequest` returns the results to the pipeline. When you use the **OutFile** parameter, the results are saved to the specified file and not returned to the pipeline. Enter a -path and filename. To send the results to a file and to the pipeline, add the **Passthru** +path and filename. To send the results to a file and to the pipeline, add the **PassThru** parameter. If you omit the path, the default is the current location. The name is treated as a literal path. diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Out-GridView.md b/reference/7.5/Microsoft.PowerShell.Utility/Out-GridView.md index 0d79ee5beda2..c316023af91e 100644 --- a/reference/7.5/Microsoft.PowerShell.Utility/Out-GridView.md +++ b/reference/7.5/Microsoft.PowerShell.Utility/Out-GridView.md @@ -196,7 +196,7 @@ The values of this parameter determine how many items you can send down the pipe - `Single`. Zero items or one item. Use this value when the next command can take only one input object. - `Multiple`. Zero, one, or many items. Use this value when the next command can take multiple input - objects. This value is equivalent to the **Passthru** parameter. + objects. This value is equivalent to the **PassThru** parameter. This parameter was introduced in Windows PowerShell 3.0. diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Select-Xml.md b/reference/7.5/Microsoft.PowerShell.Utility/Select-Xml.md index 71d9a1fc8434..a9b97e5ee751 100644 --- a/reference/7.5/Microsoft.PowerShell.Utility/Select-Xml.md +++ b/reference/7.5/Microsoft.PowerShell.Utility/Select-Xml.md @@ -140,7 +140,7 @@ $Namespace = @{ $Path = "$Pshome\en-us\*dll-Help.xml" $Xml = Select-Xml -Path $Path -Namespace $Namespace -XPath "//command:name" -$Xml | Format-Table @{Label="Name"; Expression= {($_.node.innerxml).trim()}}, Path -AutoSize +$Xml | Format-Table @{Label="Name"; Expression= {($_.Node.InnerXml).trim()}}, Path -AutoSize ``` ```Output @@ -221,7 +221,7 @@ value of the **InnerXml** property of the node. $SnippetNamespace = @{snip = "http://schemas.microsoft.com/PowerShell/Snippets"} Select-Xml -Path $HOME\Documents\WindowsPowerShell\Snippets -Namespace $SnippetNamespace -XPath "//snip:Title" | - ForEach-Object {$_.Node.Innerxml} + ForEach-Object {$_.Node.InnerXml} ``` ## PARAMETERS diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Set-Alias.md b/reference/7.5/Microsoft.PowerShell.Utility/Set-Alias.md index 09fb0c127100..a37bc0e1fd79 100644 --- a/reference/7.5/Microsoft.PowerShell.Utility/Set-Alias.md +++ b/reference/7.5/Microsoft.PowerShell.Utility/Set-Alias.md @@ -260,7 +260,7 @@ Accept wildcard characters: False Sets the **Option** property value of the alias. Values such as `ReadOnly` and `Constant` protect an alias from unintended changes. To see the **Option** property of all aliases in the -session, type `Get-Alias | Format-Table -Property Name, Options -Autosize`. +session, type `Get-Alias | Format-Table -Property Name, Options -AutoSize`. The acceptable values for this parameter are as follows: @@ -419,7 +419,7 @@ cmdlet displays the aliases available in a PowerShell session. To create an alias, use the cmdlets `Set-Alias` or `New-Alias`. In PowerShell 6, to delete an alias, use the `Remove-Alias` cmdlet. `Remove-Item` is accepted for backwards compatibility such as for scripts created with prior versions of PowerShell. Use a command such as -`Remove-Item -Path Alias:aliasname`. +`Remove-Item -Path Alias:AliasName`. To create an alias that's available in each PowerShell session, add it to your PowerShell profile. For more information, see [about_Profiles](../Microsoft.PowerShell.Core/About/about_Profiles.md). diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Set-PSBreakpoint.md b/reference/7.5/Microsoft.PowerShell.Utility/Set-PSBreakpoint.md index c0cc4599cf5b..e895bbd26a92 100644 --- a/reference/7.5/Microsoft.PowerShell.Utility/Set-PSBreakpoint.md +++ b/reference/7.5/Microsoft.PowerShell.Utility/Set-PSBreakpoint.md @@ -152,9 +152,9 @@ script, the breakpoint is set on anything that runs in the current session. The the function is called, not when it is declared. ``` -PS> Set-PSBreakpoint -Command "checklog" +PS> Set-PSBreakpoint -Command "CheckLog" Id : 0 -Command : checklog +Command : CheckLog Enabled : True HitCount : 0 Action : @@ -164,9 +164,9 @@ function CheckLog { >> where {($_.source -like "TestApp") -and ($_.Message -like "*failed*")} >>} >> -PS> Checklog +PS> CheckLog DEBUG: Hit breakpoint(s) -DEBUG: Function breakpoint on 'prompt:Checklog' +DEBUG: Function breakpoint on 'prompt:CheckLog' ``` ### Example 7: Set breakpoints on multiple lines diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Tee-Object.md b/reference/7.5/Microsoft.PowerShell.Utility/Tee-Object.md index 46e8148f1be0..033a87ba7b6b 100644 --- a/reference/7.5/Microsoft.PowerShell.Utility/Tee-Object.md +++ b/reference/7.5/Microsoft.PowerShell.Utility/Tee-Object.md @@ -67,7 +67,7 @@ This example gets a list of the processes running on the computer, saves them to variable, and pipes them to `Select-Object`. ```powershell -Get-Process notepad | Tee-Object -Variable proc | Select-Object processname,handles +Get-Process notepad | Tee-Object -Variable proc | Select-Object ProcessName, Handles ``` ```Output diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Wait-Event.md b/reference/7.5/Microsoft.PowerShell.Utility/Wait-Event.md index 1c7545a967cb..90a7dd967929 100644 --- a/reference/7.5/Microsoft.PowerShell.Utility/Wait-Event.md +++ b/reference/7.5/Microsoft.PowerShell.Utility/Wait-Event.md @@ -62,7 +62,7 @@ $objectEventArgs = @{ } Register-ObjectEvent @objectEventArgs $Timer.Interval = 2000 -$Timer.Autoreset = $False +$Timer.AutoReset = $False $Timer.Enabled = $True Wait-Event Timer.Elapsed ``` diff --git a/reference/7.5/Microsoft.WSMan.Management/About/about_WSMan_Provider.md b/reference/7.5/Microsoft.WSMan.Management/About/about_WSMan_Provider.md index 79082eef835d..1048dad0e3a9 100644 --- a/reference/7.5/Microsoft.WSMan.Management/About/about_WSMan_Provider.md +++ b/reference/7.5/Microsoft.WSMan.Management/About/about_WSMan_Provider.md @@ -153,7 +153,7 @@ Set-Location -Path WSMan:\SERVER01 ## Displaying the Contents of the WSMan: Drive -This command uses the `Get-Childitem` cmdlet to display the WS-Management stores +This command uses the `Get-ChildItem` cmdlet to display the WS-Management stores in the Localhost store location. ```powershell @@ -162,7 +162,7 @@ Get-ChildItem -path WSMan:\Localhost If you are in the `WSMan:` drive, you can omit the drive name. -This command uses the `Get-Childitem` cmdlet to display the WS-Management +This command uses the `Get-ChildItem` cmdlet to display the WS-Management stores in the remote computer "SERVER01" store location. ```powershell diff --git a/reference/7.5/Microsoft.WSMan.Management/Invoke-WSManAction.md b/reference/7.5/Microsoft.WSMan.Management/Invoke-WSManAction.md index cee1c5e52607..2ce82b1045ac 100644 --- a/reference/7.5/Microsoft.WSMan.Management/Invoke-WSManAction.md +++ b/reference/7.5/Microsoft.WSMan.Management/Invoke-WSManAction.md @@ -47,7 +47,7 @@ This cmdlet uses the WSMan connection/transport layer to run the action. ### Example 1: Invoke a method ```powershell -Invoke-WSManAction -Action startservice -ResourceURI wmicimv2/win32_service -SelectorSet @{name="spooler"} -Authentication default +Invoke-WSManAction -Action StartService -ResourceURI wmicimv2/win32_service -SelectorSet @{name="spooler"} -Authentication default ``` ```Output @@ -67,7 +67,7 @@ indicates success. A return value of 5 indicates that the service is already sta ### Example 2: Invoke a method ```powershell -Invoke-WSManAction -Action stopservice -ResourceURI wmicimv2/Win32_Service -SelectorSet @{Name="spooler"} -FilePath:input.xml -Authentication default +Invoke-WSManAction -Action StopService -ResourceURI wmicimv2/Win32_Service -SelectorSet @{Name="spooler"} -FilePath:input.xml -Authentication default ``` ```Output @@ -86,7 +86,7 @@ The file, `Input.xml`, contains the following content: ### Example 3: Invoke a method with specified parameter values ```powershell -Invoke-WSManAction -Action create -ResourceURI wmicimv2/win32_process -ValueSet @{commandline="notepad.exe";currentdirectory="C:\"} +Invoke-WSManAction -Action create -ResourceURI wmicimv2/win32_process -ValueSet @{CommandLine="notepad.exe";CurrentDirectory="C:\"} ``` ```Output @@ -105,7 +105,7 @@ the current directory of the new process is set to `C:\`. ### Example 4: Invoke a method on a remote computer ```powershell -Invoke-WSManAction -Action startservice -ResourceURI wmicimv2/win32_service -SelectorSet @{name="spooler"} -ComputerName server01 -Authentication default +Invoke-WSManAction -Action StartService -ResourceURI wmicimv2/win32_service -SelectorSet @{name="spooler"} -ComputerName server01 -Authentication default ``` ```Output @@ -299,7 +299,7 @@ Specifies the path of a file that is used to update a management resource. You s management resource by using the ResourceURI parameter and the SelectorSet parameter. For example, the following command uses the FilePath parameter: -`Invoke-WSManAction -Action stopservice -ResourceUri wmicimv2/Win32_Service -SelectorSet @{Name="spooler"} -FilePath c:\input.xml -Authentication default` +`Invoke-WSManAction -Action StopService -ResourceUri wmicimv2/Win32_Service -SelectorSet @{Name="spooler"} -FilePath c:\input.xml -Authentication default` This command calls the **StopService** method on the Spooler service by using input from a file. The file, `Input.xml`, contains the following content: diff --git a/reference/7.5/Microsoft.WSMan.Management/New-WSManInstance.md b/reference/7.5/Microsoft.WSMan.Management/New-WSManInstance.md index c725bd7b7348..c8c81bcb5810 100644 --- a/reference/7.5/Microsoft.WSMan.Management/New-WSManInstance.md +++ b/reference/7.5/Microsoft.WSMan.Management/New-WSManInstance.md @@ -213,7 +213,7 @@ Specifies the path of a file that is used to create a management resource. You s management resource using the **ResourceURI** parameter and the **SelectorSet** parameter . For example, the following command uses the **File** parameter: -`Invoke-WSManAction -Action stopservice -ResourceUri wmi/cimv2/Win32_Service -SelectorSet @{Name="spooler"} -File c:\input.xml -Authentication Default` +`Invoke-WSManAction -Action StopService -ResourceUri wmi/cimv2/Win32_Service -SelectorSet @{Name="spooler"} -File c:\input.xml -Authentication Default` This command calls the **StopService** method on the Spooler service using input from a file. The file, `Input.xml`, contains the following content: diff --git a/reference/7.5/PSReadLine/About/about_PSReadLine_Functions.md b/reference/7.5/PSReadLine/About/about_PSReadLine_Functions.md index 3669529c3a96..f40b4bcb7e5f 100644 --- a/reference/7.5/PSReadLine/About/about_PSReadLine_Functions.md +++ b/reference/7.5/PSReadLine/About/about_PSReadLine_Functions.md @@ -557,7 +557,7 @@ Deletes backwards until given character. - Vi command mode: `` -### ViInsertAtBegining +### ViInsertAtBeginning Switch to Insert mode and position the cursor at the beginning of the line. diff --git a/reference/docs-conceptual/samples/Manipulating-Items-Directly.md b/reference/docs-conceptual/samples/Manipulating-Items-Directly.md index 1b80078b1443..557fa6e2b41a 100644 --- a/reference/docs-conceptual/samples/Manipulating-Items-Directly.md +++ b/reference/docs-conceptual/samples/Manipulating-Items-Directly.md @@ -187,7 +187,7 @@ in the command. If you have already copied the directory without its contents, a parameter, which allows you to overwrite the empty folder. ```powershell -Copy-Item -Path C:\New.Directory -Destination C:\temp -Recurse -Force -Passthru +Copy-Item -Path C:\New.Directory -Destination C:\temp -Recurse -Force -PassThru ``` ```Output