diff --git a/reference/5.1/Microsoft.PowerShell.Core/About/about_Classes_Methods.md b/reference/5.1/Microsoft.PowerShell.Core/About/about_Classes_Methods.md index c69f6911cea8..f1bc886ef7d4 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/About/about_Classes_Methods.md +++ b/reference/5.1/Microsoft.PowerShell.Core/About/about_Classes_Methods.md @@ -198,7 +198,7 @@ overloads. The first overload has parameters for the dimensions of the cube and a flag to indicate whether the method should validate the input. The second overload only includes the numeric inputs. It calls the first -overload with `$Static` as `$true`. The second overload gives users a way to +overload with `$Strict` as `$true`. The second overload gives users a way to call the method without always having to define whether to strictly validate the input. diff --git a/reference/7.4/CimCmdlets/CimCmdlets.md b/reference/7.4/CimCmdlets/CimCmdlets.md index cf06e6fb0d6c..b23ebba51607 100644 --- a/reference/7.4/CimCmdlets/CimCmdlets.md +++ b/reference/7.4/CimCmdlets/CimCmdlets.md @@ -19,10 +19,6 @@ This module is only available on the Windows platform. ## CimCmdlets Cmdlets -### [Export-BinaryMiLog](Export-BinaryMiLog.md) - -Creates a binary encoded representation of an object or objects and stores it in a file. - ### [Get-CimAssociatedInstance](Get-CimAssociatedInstance.md) Retrieves the CIM instances that are connected to a specific CIM instance by an association. @@ -39,10 +35,6 @@ Gets the CIM instances of a class from a CIM server. Gets the CIM session objects from the current session. -### [Import-BinaryMiLog](Import-BinaryMiLog.md) - -Used to re-create the saved objects based on the contents of an export file. - ### [Invoke-CimMethod](Invoke-CimMethod.md) Invokes a method of a CIM class. @@ -57,7 +49,7 @@ Creates a CIM session. ### [New-CimSessionOption](New-CimSessionOption.md) -Specifies advanced options for the `New-CimSession` cmdlet. +Specifies advanced options for the New-CimSession cmdlet. ### [Register-CimIndicationEvent](Register-CimIndicationEvent.md) @@ -73,4 +65,4 @@ Removes one or more CIM sessions. ### [Set-CimInstance](Set-CimInstance.md) -Modifies a CIM instance on a CIM server by calling the **ModifyInstance** method of the CIM class. +Modifies a CIM instance on a CIM server by calling the ModifyInstance method of the CIM class. diff --git a/reference/7.4/Microsoft.PowerShell.Core/About/about_Classes_Methods.md b/reference/7.4/Microsoft.PowerShell.Core/About/about_Classes_Methods.md index b0dfa9419b41..47bb27c75f46 100644 --- a/reference/7.4/Microsoft.PowerShell.Core/About/about_Classes_Methods.md +++ b/reference/7.4/Microsoft.PowerShell.Core/About/about_Classes_Methods.md @@ -195,7 +195,7 @@ overloads. The first overload has parameters for the dimensions of the cube and a flag to indicate whether the method should validate the input. The second overload only includes the numeric inputs. It calls the first -overload with `$Static` as `$true`. The second overload gives users a way to +overload with `$Strict` as `$true`. The second overload gives users a way to call the method without always having to define whether to strictly validate the input. diff --git a/reference/7.4/Microsoft.PowerShell.Utility/Microsoft.PowerShell.Utility.md b/reference/7.4/Microsoft.PowerShell.Utility/Microsoft.PowerShell.Utility.md index a0f16bb806e4..aeae396e0f2f 100644 --- a/reference/7.4/Microsoft.PowerShell.Utility/Microsoft.PowerShell.Utility.md +++ b/reference/7.4/Microsoft.PowerShell.Utility/Microsoft.PowerShell.Utility.md @@ -19,347 +19,465 @@ PowerShell. ## Microsoft.PowerShell.Utility Cmdlets ### [Add-Member](Add-Member.md) + Adds custom properties and methods to an instance of a PowerShell object. ### [Add-Type](Add-Type.md) + Adds a Microsoft .NET class to a PowerShell session. ### [Clear-Variable](Clear-Variable.md) + Deletes the value of a variable. ### [Compare-Object](Compare-Object.md) + Compares two sets of objects. ### [ConvertFrom-Csv](ConvertFrom-Csv.md) + Converts object properties in character-separated value (CSV) format into CSV versions of the original objects. ### [ConvertFrom-Json](ConvertFrom-Json.md) + Converts a JSON-formatted string to a custom object or a hash table. ### [ConvertFrom-Markdown](ConvertFrom-Markdown.md) + Convert the contents of a string or a file to a **MarkdownInfo** object. ### [ConvertFrom-SddlString](ConvertFrom-SddlString.md) + Converts a SDDL string to a custom object. ### [ConvertFrom-StringData](ConvertFrom-StringData.md) + Converts a string containing one or more key and value pairs to a hash table. ### [ConvertTo-Csv](ConvertTo-Csv.md) + Converts .NET objects into a series of character-separated value (CSV) strings. ### [ConvertTo-Html](ConvertTo-Html.md) + Converts .NET objects into HTML that can be displayed in a Web browser. ### [ConvertTo-Json](ConvertTo-Json.md) + Converts an object to a JSON-formatted string. ### [ConvertTo-Xml](ConvertTo-Xml.md) + Creates an XML-based representation of an object. ### [Debug-Runspace](Debug-Runspace.md) + Starts an interactive debugging session with a runspace. ### [Disable-PSBreakpoint](Disable-PSBreakpoint.md) + Disables the breakpoints in the current console. ### [Disable-RunspaceDebug](Disable-RunspaceDebug.md) + Disables debugging on one or more runspaces, and releases any pending debugger stop. ### [Enable-PSBreakpoint](Enable-PSBreakpoint.md) + Enables the breakpoints in the current console. ### [Enable-RunspaceDebug](Enable-RunspaceDebug.md) + Enables debugging on runspaces where any breakpoint is preserved until a debugger is attached. ### [Export-Alias](Export-Alias.md) + Exports information about currently defined aliases to a file. ### [Export-Clixml](Export-Clixml.md) + Creates an XML-based representation of an object or objects and stores it in a file. ### [Export-Csv](Export-Csv.md) + Converts objects into a series of character-separated value (CSV) strings and saves the strings to a file. ### [Export-FormatData](Export-FormatData.md) + Saves formatting data from the current session in a formatting file. ### [Export-PSSession](Export-PSSession.md) + Exports commands from another session and saves them in a PowerShell module. ### [Format-Custom](Format-Custom.md) + Uses a customized view to format the output. ### [Format-Hex](Format-Hex.md) + Displays a file or other input as hexadecimal. ### [Format-List](Format-List.md) + Formats the output as a list of properties in which each property appears on a new line. ### [Format-Table](Format-Table.md) + Formats the output as a table. ### [Format-Wide](Format-Wide.md) + Formats objects as a wide table that displays only one property of each object. ### [Get-Alias](Get-Alias.md) + Gets the aliases for the current session. ### [Get-Culture](Get-Culture.md) + Gets the current culture set in the operating system. ### [Get-Date](Get-Date.md) + Gets the current date and time. ### [Get-Error](Get-Error.md) + Gets and displays the most recent error messages from the current session. ### [Get-Event](Get-Event.md) + Gets the events in the event queue. ### [Get-EventSubscriber](Get-EventSubscriber.md) + Gets the event subscribers in the current session. ### [Get-FileHash](Get-FileHash.md) + Computes the hash value for a file by using a specified hash algorithm. ### [Get-FormatData](Get-FormatData.md) + Gets the formatting data in the current session. ### [Get-Host](Get-Host.md) + Gets an object that represents the current host program. ### [Get-MarkdownOption](Get-MarkdownOption.md) + Returns the current colors and styles used for rendering Markdown content in the console. ### [Get-Member](Get-Member.md) + Gets the properties and methods of objects. ### [Get-PSBreakpoint](Get-PSBreakpoint.md) + Gets the breakpoints that are set in the current session. ### [Get-PSCallStack](Get-PSCallStack.md) + Displays the current call stack. ### [Get-Random](Get-Random.md) + Gets a random number, or selects objects randomly from a collection. ### [Get-Runspace](Get-Runspace.md) + Gets active runspaces within a PowerShell host process. ### [Get-RunspaceDebug](Get-RunspaceDebug.md) + Shows runspace debugging options. +### [Get-SecureRandom](Get-SecureRandom.md) + +Gets a random number, or selects objects randomly from a collection. + ### [Get-TraceSource](Get-TraceSource.md) + Gets PowerShell components that are instrumented for tracing. ### [Get-TypeData](Get-TypeData.md) + Gets the extended type data in the current session. ### [Get-UICulture](Get-UICulture.md) + Gets the current UI culture settings in the operating system. ### [Get-Unique](Get-Unique.md) + Returns unique items from a sorted list. ### [Get-Uptime](Get-Uptime.md) + Get the **TimeSpan** since last boot. ### [Get-Variable](Get-Variable.md) + Gets the variables in the current console. ### [Get-Verb](Get-Verb.md) + Gets approved PowerShell verbs. ### [Group-Object](Group-Object.md) + Groups objects that contain the same value for specified properties. ### [Import-Alias](Import-Alias.md) + Imports an alias list from a file. ### [Import-Clixml](Import-Clixml.md) + Imports a CLIXML file and creates corresponding objects in PowerShell. ### [Import-Csv](Import-Csv.md) + Creates table-like custom objects from the items in a character-separated value (CSV) file. ### [Import-LocalizedData](Import-LocalizedData.md) -Imports language-specific data into scripts and functions based on the UI culture that is selected for the operating system. + +Imports language-specific data into scripts and functions based on the UI culture that's selected for the operating system. ### [Import-PowerShellDataFile](Import-PowerShellDataFile.md) + Imports values from a `.psd1` file without invoking its contents. ### [Import-PSSession](Import-PSSession.md) + Imports commands from another session into the current session. ### [Invoke-Expression](Invoke-Expression.md) + Runs commands or expressions on the local computer. ### [Invoke-RestMethod](Invoke-RestMethod.md) + Sends an HTTP or HTTPS request to a RESTful web service. ### [Invoke-WebRequest](Invoke-WebRequest.md) + Gets content from a web page on the internet. ### [Join-String](Join-String.md) + Combines objects from the pipeline into a single string. ### [Measure-Command](Measure-Command.md) + Measures the time it takes to run script blocks and cmdlets. ### [Measure-Object](Measure-Object.md) + Calculates the numeric properties of objects, and the characters, words, and lines in string objects, such as files of text. ### [New-Alias](New-Alias.md) + Creates a new alias. ### [New-Event](New-Event.md) + Creates a new event. ### [New-Guid](New-Guid.md) + Creates a GUID. ### [New-Object](New-Object.md) + Creates an instance of a Microsoft .NET Framework or COM object. ### [New-TemporaryFile](New-TemporaryFile.md) + Creates a temporary file. ### [New-TimeSpan](New-TimeSpan.md) + Creates a TimeSpan object. ### [New-Variable](New-Variable.md) + Creates a new variable. ### [Out-File](Out-File.md) + Sends output to a file. ### [Out-GridView](Out-GridView.md) + Sends output to an interactive table in a separate window. ### [Out-Printer](Out-Printer.md) + Sends output to a printer. ### [Out-String](Out-String.md) -Outputs input objects as a strings. + +Outputs input objects as a string. ### [Read-Host](Read-Host.md) + Reads a line of input from the console. ### [Register-EngineEvent](Register-EngineEvent.md) + Subscribes to events that are generated by the PowerShell engine and by the `New-Event` cmdlet. ### [Register-ObjectEvent](Register-ObjectEvent.md) + Subscribes to the events that are generated by a Microsoft .NET Framework object. ### [Remove-Alias](Remove-Alias.md) + Remove an alias from the current session. ### [Remove-Event](Remove-Event.md) + Deletes events from the event queue. ### [Remove-PSBreakpoint](Remove-PSBreakpoint.md) + Deletes breakpoints from the current console. ### [Remove-TypeData](Remove-TypeData.md) + Deletes extended types from the current session. ### [Remove-Variable](Remove-Variable.md) + Deletes a variable and its value. ### [Select-Object](Select-Object.md) + Selects objects or object properties. ### [Select-String](Select-String.md) + Finds text in strings and files. ### [Select-Xml](Select-Xml.md) + Finds text in an XML string or document. ### [Send-MailMessage](Send-MailMessage.md) + Sends an email message. ### [Set-Alias](Set-Alias.md) + Creates or changes an alias for a cmdlet or other command in the current PowerShell session. ### [Set-Date](Set-Date.md) + Changes the system time on the computer to a time that you specify. ### [Set-MarkdownOption](Set-MarkdownOption.md) + Sets the colors and styles used for rendering Markdown content in the console. ### [Set-PSBreakpoint](Set-PSBreakpoint.md) + Sets a breakpoint on a line, command, or variable. ### [Set-TraceSource](Set-TraceSource.md) + Configures, starts, and stops a trace of PowerShell components. ### [Set-Variable](Set-Variable.md) + Sets the value of a variable. Creates the variable if one with the requested name does not exist. ### [Show-Command](Show-Command.md) + Displays PowerShell command information in a graphical window. ### [Show-Markdown](Show-Markdown.md) + Shows a Markdown file or string in the console in a friendly way using VT100 escape sequences or in a browser using HTML. ### [Sort-Object](Sort-Object.md) + Sorts objects by property values. ### [Start-Sleep](Start-Sleep.md) + Suspends the activity in a script or session for the specified period of time. ### [Tee-Object](Tee-Object.md) + Saves command output in a file or variable and also sends it down the pipeline. ### [Test-Json](Test-Json.md) + Tests whether a string is a valid JSON document ### [Trace-Command](Trace-Command.md) + Configures and starts a trace of the specified expression or command. ### [Unblock-File](Unblock-File.md) -Unblocks files that were downloaded from the Internet. + +Unblocks files that were downloaded from the internet. ### [Unregister-Event](Unregister-Event.md) + Cancels an event subscription. ### [Update-FormatData](Update-FormatData.md) + Updates the formatting data in the current session. ### [Update-List](Update-List.md) + Adds items to and removes items from a property value that contains a collection of objects. ### [Update-TypeData](Update-TypeData.md) + Updates the extended type data in the session. ### [Wait-Debugger](Wait-Debugger.md) + Stops a script in the debugger before running the next statement in the script. ### [Wait-Event](Wait-Event.md) + Waits until a particular event is raised before continuing to run. ### [Write-Debug](Write-Debug.md) + Writes a debug message to the console. ### [Write-Error](Write-Error.md) + Writes an object to the error stream. ### [Write-Host](Write-Host.md) + Writes customized output to a host. ### [Write-Information](Write-Information.md) + Specifies how PowerShell handles information stream data for a command. ### [Write-Output](Write-Output.md) -Sends the specified objects to the next command in the pipeline. If the command is the last command in the pipeline, the objects are displayed in the console. + +Writes the specified objects to the pipeline. ### [Write-Progress](Write-Progress.md) + Displays a progress bar within a PowerShell command window. ### [Write-Verbose](Write-Verbose.md) + Writes text to the verbose message stream. ### [Write-Warning](Write-Warning.md) -Writes a warning message. +Writes a warning message. diff --git a/reference/7.5/CimCmdlets/CimCmdlets.md b/reference/7.5/CimCmdlets/CimCmdlets.md index 485d03ff3926..70d2d2de41c9 100644 --- a/reference/7.5/CimCmdlets/CimCmdlets.md +++ b/reference/7.5/CimCmdlets/CimCmdlets.md @@ -19,10 +19,6 @@ This module is only available on the Windows platform. ## CimCmdlets Cmdlets -### [Export-BinaryMiLog](Export-BinaryMiLog.md) - -Creates a binary encoded representation of an object or objects and stores it in a file. - ### [Get-CimAssociatedInstance](Get-CimAssociatedInstance.md) Retrieves the CIM instances that are connected to a specific CIM instance by an association. @@ -39,10 +35,6 @@ Gets the CIM instances of a class from a CIM server. Gets the CIM session objects from the current session. -### [Import-BinaryMiLog](Import-BinaryMiLog.md) - -Used to re-create the saved objects based on the contents of an export file. - ### [Invoke-CimMethod](Invoke-CimMethod.md) Invokes a method of a CIM class. @@ -57,7 +49,7 @@ Creates a CIM session. ### [New-CimSessionOption](New-CimSessionOption.md) -Specifies advanced options for the `New-CimSession` cmdlet. +Specifies advanced options for the New-CimSession cmdlet. ### [Register-CimIndicationEvent](Register-CimIndicationEvent.md) @@ -73,4 +65,4 @@ Removes one or more CIM sessions. ### [Set-CimInstance](Set-CimInstance.md) -Modifies a CIM instance on a CIM server by calling the **ModifyInstance** method of the CIM class. +Modifies a CIM instance on a CIM server by calling the ModifyInstance method of the CIM class. diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Classes_Methods.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Classes_Methods.md index cb5a5a044f5a..8299ac4fe640 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Classes_Methods.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Classes_Methods.md @@ -195,7 +195,7 @@ overloads. The first overload has parameters for the dimensions of the cube and a flag to indicate whether the method should validate the input. The second overload only includes the numeric inputs. It calls the first -overload with `$Static` as `$true`. The second overload gives users a way to +overload with `$Strict` as `$true`. The second overload gives users a way to call the method without always having to define whether to strictly validate the input. diff --git a/reference/7.5/Microsoft.PowerShell.Core/Microsoft.PowerShell.Core.md b/reference/7.5/Microsoft.PowerShell.Core/Microsoft.PowerShell.Core.md index d8c079622bab..c91be0fe58c0 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/Microsoft.PowerShell.Core.md +++ b/reference/7.5/Microsoft.PowerShell.Core/Microsoft.PowerShell.Core.md @@ -37,7 +37,7 @@ Reconnects to disconnected sessions. ### [Debug-Job](Debug-Job.md) -Debugs a running background, remote, or PowerShell Workflow job. +Debugs a running background or remote job. ### [Disable-ExperimentalFeature](Disable-ExperimentalFeature.md) @@ -113,7 +113,7 @@ Gets PowerShell background jobs that are running in the current session. ### [Get-Module](Get-Module.md) -Gets the modules that have been imported or that can be imported into the current session. +List the modules imported in the current session or that can be imported from the PSModulePath. ### [Get-PSHostProcessInfo](Get-PSHostProcessInfo.md) @@ -133,7 +133,7 @@ Gets the registered session configurations on the computer. ### [Get-PSSubsystem](Get-PSSubsystem.md) -Retrieves information about the subsystems registered in PowerShell. (Experimental Feature) +Retrieves information about the subsystems registered in PowerShell. ### [Import-Module](Import-Module.md) @@ -239,6 +239,14 @@ Starts a PowerShell background job. Stops a PowerShell background job. +### [Switch-Process](Switch-Process.md) + +On Linux and macOS, the cmdlet calls the `execv()` function to provide similar behavior as POSIX shells. + +### [TabExpansion2](TabExpansion2.md) + +A helper function that wraps the `CompleteInput()` method of the **CommandCompletion** class to provide tab completion for PowerShell scripts. + ### [Test-ModuleManifest](Test-ModuleManifest.md) Verifies that a module manifest file accurately describes the contents of a module. @@ -257,8 +265,7 @@ Downloads and installs the newest help files on your computer. ### [Wait-Job](Wait-Job.md) -Suppresses the command prompt until one or all of the PowerShell background jobs running in the -session are completed. +Waits until one or all of the PowerShell jobs running in the session are in a terminating state. ### [Where-Object](Where-Object.md) diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Microsoft.PowerShell.Utility.md b/reference/7.5/Microsoft.PowerShell.Utility/Microsoft.PowerShell.Utility.md index f33f592fcfbd..e584894eea48 100644 --- a/reference/7.5/Microsoft.PowerShell.Utility/Microsoft.PowerShell.Utility.md +++ b/reference/7.5/Microsoft.PowerShell.Utility/Microsoft.PowerShell.Utility.md @@ -34,6 +34,10 @@ Deletes the value of a variable. Compares two sets of objects. +### [ConvertFrom-CliXml](ConvertFrom-CliXml.md) + +Converts a CliXml-formatted string to a custom **PSObject**. + ### [ConvertFrom-Csv](ConvertFrom-Csv.md) Converts object properties in character-separated value (CSV) format into CSV versions of the original objects. @@ -54,6 +58,10 @@ Converts a SDDL string to a custom object. Converts a string containing one or more key and value pairs to a hash table. +### [ConvertTo-CliXml](ConvertTo-CliXml.md) + +Converts an object to a CliXml-formatted string. + ### [ConvertTo-Csv](ConvertTo-Csv.md) Converts .NET objects into a series of character-separated value (CSV) strings. @@ -194,6 +202,10 @@ Gets active runspaces within a PowerShell host process. Shows runspace debugging options. +### [Get-SecureRandom](Get-SecureRandom.md) + +Gets a random number, or selects objects randomly from a collection. + ### [Get-TraceSource](Get-TraceSource.md) Gets PowerShell components that are instrumented for tracing. @@ -240,7 +252,7 @@ Creates table-like custom objects from the items in a character-separated value ### [Import-LocalizedData](Import-LocalizedData.md) -Imports language-specific data into scripts and functions based on the UI culture that is selected for the operating system. +Imports language-specific data into scripts and functions based on the UI culture that's selected for the operating system. ### [Import-PowerShellDataFile](Import-PowerShellDataFile.md) @@ -316,7 +328,7 @@ Sends output to a printer. ### [Out-String](Out-String.md) -Outputs input objects as a strings. +Outputs input objects as a string. ### [Read-Host](Read-Host.md) @@ -420,7 +432,7 @@ Configures and starts a trace of the specified expression or command. ### [Unblock-File](Unblock-File.md) -Unblocks files that were downloaded from the Internet. +Unblocks files that were downloaded from the internet. ### [Unregister-Event](Unregister-Event.md) @@ -464,7 +476,7 @@ Specifies how PowerShell handles information stream data for a command. ### [Write-Output](Write-Output.md) -Sends the specified objects to the next command in the pipeline. If the command is the last command in the pipeline, the objects are displayed in the console. +Writes the specified objects to the pipeline. ### [Write-Progress](Write-Progress.md) diff --git a/reference/7.6/CimCmdlets/CimCmdlets.md b/reference/7.6/CimCmdlets/CimCmdlets.md index 4fd9f0673f62..910275a3ea5f 100644 --- a/reference/7.6/CimCmdlets/CimCmdlets.md +++ b/reference/7.6/CimCmdlets/CimCmdlets.md @@ -19,10 +19,6 @@ This module is only available on the Windows platform. ## CimCmdlets Cmdlets -### [Export-BinaryMiLog](Export-BinaryMiLog.md) - -Creates a binary encoded representation of an object or objects and stores it in a file. - ### [Get-CimAssociatedInstance](Get-CimAssociatedInstance.md) Retrieves the CIM instances that are connected to a specific CIM instance by an association. @@ -39,10 +35,6 @@ Gets the CIM instances of a class from a CIM server. Gets the CIM session objects from the current session. -### [Import-BinaryMiLog](Import-BinaryMiLog.md) - -Used to re-create the saved objects based on the contents of an export file. - ### [Invoke-CimMethod](Invoke-CimMethod.md) Invokes a method of a CIM class. @@ -57,7 +49,7 @@ Creates a CIM session. ### [New-CimSessionOption](New-CimSessionOption.md) -Specifies advanced options for the `New-CimSession` cmdlet. +Specifies advanced options for the New-CimSession cmdlet. ### [Register-CimIndicationEvent](Register-CimIndicationEvent.md) @@ -73,4 +65,5 @@ Removes one or more CIM sessions. ### [Set-CimInstance](Set-CimInstance.md) -Modifies a CIM instance on a CIM server by calling the **ModifyInstance** method of the CIM class. +Modifies a CIM instance on a CIM server by calling the ModifyInstance method of the CIM class. + diff --git a/reference/7.6/Microsoft.PowerShell.Core/About/about_Classes_Methods.md b/reference/7.6/Microsoft.PowerShell.Core/About/about_Classes_Methods.md index 29c5bd2ab6be..58d8afb0f6fc 100644 --- a/reference/7.6/Microsoft.PowerShell.Core/About/about_Classes_Methods.md +++ b/reference/7.6/Microsoft.PowerShell.Core/About/about_Classes_Methods.md @@ -195,7 +195,7 @@ overloads. The first overload has parameters for the dimensions of the cube and a flag to indicate whether the method should validate the input. The second overload only includes the numeric inputs. It calls the first -overload with `$Static` as `$true`. The second overload gives users a way to +overload with `$Strict` as `$true`. The second overload gives users a way to call the method without always having to define whether to strictly validate the input. diff --git a/reference/7.6/Microsoft.PowerShell.Core/Microsoft.PowerShell.Core.md b/reference/7.6/Microsoft.PowerShell.Core/Microsoft.PowerShell.Core.md index 26019a6b0fb6..0b0d6695b23a 100644 --- a/reference/7.6/Microsoft.PowerShell.Core/Microsoft.PowerShell.Core.md +++ b/reference/7.6/Microsoft.PowerShell.Core/Microsoft.PowerShell.Core.md @@ -37,7 +37,7 @@ Reconnects to disconnected sessions. ### [Debug-Job](Debug-Job.md) -Debugs a running background, remote, or PowerShell Workflow job. +Debugs a running background or remote job. ### [Disable-ExperimentalFeature](Disable-ExperimentalFeature.md) @@ -113,7 +113,7 @@ Gets PowerShell background jobs that are running in the current session. ### [Get-Module](Get-Module.md) -Gets the modules that have been imported or that can be imported into the current session. +List the modules imported in the current session or that can be imported from the PSModulePath. ### [Get-PSHostProcessInfo](Get-PSHostProcessInfo.md) @@ -133,7 +133,7 @@ Gets the registered session configurations on the computer. ### [Get-PSSubsystem](Get-PSSubsystem.md) -Retrieves information about the subsystems registered in PowerShell. (Experimental Feature) +Retrieves information about the subsystems registered in PowerShell. ### [Import-Module](Import-Module.md) @@ -239,6 +239,14 @@ Starts a PowerShell background job. Stops a PowerShell background job. +### [Switch-Process](Switch-Process.md) + +On Linux and macOS, the cmdlet calls the `execv()` function to provide similar behavior as POSIX shells. + +### [TabExpansion2](TabExpansion2.md) + +A helper function that wraps the `CompleteInput()` method of the **CommandCompletion** class to provide tab completion for PowerShell scripts. + ### [Test-ModuleManifest](Test-ModuleManifest.md) Verifies that a module manifest file accurately describes the contents of a module. @@ -257,7 +265,7 @@ Downloads and installs the newest help files on your computer. ### [Wait-Job](Wait-Job.md) -Suppresses the command prompt until one or all of the PowerShell background jobs running in the session are completed. +Waits until one or all of the PowerShell jobs running in the session are in a terminating state. ### [Where-Object](Where-Object.md) diff --git a/reference/7.6/Microsoft.PowerShell.Utility/Microsoft.PowerShell.Utility.md b/reference/7.6/Microsoft.PowerShell.Utility/Microsoft.PowerShell.Utility.md index 78ffaa1135b0..84e00a7bd578 100644 --- a/reference/7.6/Microsoft.PowerShell.Utility/Microsoft.PowerShell.Utility.md +++ b/reference/7.6/Microsoft.PowerShell.Utility/Microsoft.PowerShell.Utility.md @@ -34,6 +34,10 @@ Deletes the value of a variable. Compares two sets of objects. +### [ConvertFrom-CliXml](ConvertFrom-CliXml.md) + +Converts a CliXml-formatted string to a custom **PSObject**. + ### [ConvertFrom-Csv](ConvertFrom-Csv.md) Converts object properties in character-separated value (CSV) format into CSV versions of the original objects. @@ -54,6 +58,10 @@ Converts a SDDL string to a custom object. Converts a string containing one or more key and value pairs to a hash table. +### [ConvertTo-CliXml](ConvertTo-CliXml.md) + +Converts an object to a CliXml-formatted string. + ### [ConvertTo-Csv](ConvertTo-Csv.md) Converts .NET objects into a series of character-separated value (CSV) strings. @@ -194,6 +202,10 @@ Gets active runspaces within a PowerShell host process. Shows runspace debugging options. +### [Get-SecureRandom](Get-SecureRandom.md) + +Gets a random number, or selects objects randomly from a collection. + ### [Get-TraceSource](Get-TraceSource.md) Gets PowerShell components that are instrumented for tracing. @@ -240,7 +252,7 @@ Creates table-like custom objects from the items in a character-separated value ### [Import-LocalizedData](Import-LocalizedData.md) -Imports language-specific data into scripts and functions based on the UI culture that is selected for the operating system. +Imports language-specific data into scripts and functions based on the UI culture that's selected for the operating system. ### [Import-PowerShellDataFile](Import-PowerShellDataFile.md) @@ -316,7 +328,7 @@ Sends output to a printer. ### [Out-String](Out-String.md) -Outputs input objects as a strings. +Outputs input objects as a string. ### [Read-Host](Read-Host.md) @@ -420,7 +432,7 @@ Configures and starts a trace of the specified expression or command. ### [Unblock-File](Unblock-File.md) -Unblocks files that were downloaded from the Internet. +Unblocks files that were downloaded from the internet. ### [Unregister-Event](Unregister-Event.md) @@ -464,7 +476,7 @@ Specifies how PowerShell handles information stream data for a command. ### [Write-Output](Write-Output.md) -Sends the specified objects to the next command in the pipeline. If the command is the last command in the pipeline, the objects are displayed in the console. +Writes the specified objects to the pipeline. ### [Write-Progress](Write-Progress.md) diff --git a/reference/docs-conceptual/community/contributing/hackathons.md b/reference/docs-conceptual/community/contributing/hackathons.md index 89007d6bfb3d..ea776c8c09ba 100644 --- a/reference/docs-conceptual/community/contributing/hackathons.md +++ b/reference/docs-conceptual/community/contributing/hackathons.md @@ -1,6 +1,6 @@ --- description: This article describes how we manage and support hack-a-thon events like Hacktoberfest. -ms.date: 03/30/2025 +ms.date: 05/29/2025 title: Hacktoberfest and other hack-a-thon events --- # Hacktoberfest and other hack-a-thon events @@ -16,30 +16,30 @@ Before you can contribute to an open source repo, you must first configure your contribute to Microsoft Learn. If you're new to this process, start by signing up for a [GitHub account][01]. Be sure to [install Git and the Markdown tools][02]. -To get credit for participation, [register with Hacktoberfest][03] and read their -[participation guide][04]. +To get credit for participation, register with [Hacktoberfest][14] and read their participation +guide. ## Find a repo that needs your help The PowerShell-Docs team is supporting Hacktoberfest contributions for several PowerShell documentation repositories. We defined a set of cleanup tasks designed to be simple for first time -contributors. Full information can be found in the [Hacktoberfest meta-issue][05]. +contributors. Full information can be found in the [Hacktoberfest meta-issue][11]. To be successful with these tasks, you should: - Have a general understanding of PowerShell syntax -- Have an understanding of [splatting][06] -- Be able to read and follow the [PowerShell-Docs style guide][07] and [Editorial checklist][08] +- Have an understanding of [splatting][04] +- Be able to read and follow the [PowerShell-Docs style guide][06] and [Editorial checklist][05] - Have basic familiarity with Markdown -Before contributing should read the meta-issue. When you're ready to start, open a new issue using -the Hacktoberfest issue template by using one of the following links: +Before contributing should read the meta-issue. When you're ready to start, open a new Hacktoberfest +using one of the following links: -- [MicrosoftDocs/PowerShell-Docs][09] -- [MicrosoftDocs/PowerShell-Docs-DSC][10] -- [MicrosoftDocs/PowerShell-Docs-Modules][11] -- [MicrosoftDocs/windows-powershell-docs][12] -- [MicrosoftDocs/azure-docs-powershell][13] +- [MicrosoftDocs/PowerShell-Docs][12] +- [MicrosoftDocs/PowerShell-Docs-DSC][09] +- [MicrosoftDocs/PowerShell-Docs-Modules][10] +- [MicrosoftDocs/windows-powershell-docs][13] +- [MicrosoftDocs/azure-docs-powershell][08] ### Quality expectations @@ -54,8 +54,6 @@ and impactful PR. The following examples from the official Hacktoberfest site ar - PRs deemed a hindrance vs. helping - PRs that are clearly an attempt to increment your PR count for October -For more information, see [Hacktoberfest: Values][14]. - ### Open a PR A _PR_ provides a convenient way for a contributor to propose a set of changes. Successful PRs have @@ -67,28 +65,25 @@ these common characteristics: - The changes are related to an existing issue. If you're proposing a PR without a corresponding issue, create an issue first. For more information, -see [GitHub: About pull requests][15]. +see [GitHub: About pull requests][07]. ## See also -- [Git and GitHub essentials for Microsoft Learn documentation][16] -- [Official Hacktoberfest site][17] +- [Git and GitHub essentials for Microsoft Learn documentation][03] +- [Official Hacktoberfest site][14] [01]: /contribute/get-started-setup-github [02]: /contribute/get-started-setup-tools -[03]: https://hacktoberfest.com/auth/ -[04]: https://hacktoberfest.com/participation/ -[05]: https://github.com/MicrosoftDocs/PowerShell-Docs/issues/9257 -[06]: /powershell/module/microsoft.powershell.core/about/about_splatting -[07]: /powershell/scripting/community/contributing/powershell-style-guide -[08]: /powershell/scripting/community/contributing/editorial-checklist -[09]: https://github.com/MicrosoftDocs/PowerShell-Docs/issues/new?assignees=&labels=&template=00-hacktoberfest.yml&title=%F0%9F%8E%83+2022%3A+ -[10]: https://github.com/MicrosoftDocs/PowerShell-Docs-DSC/issues/new?assignees=&labels=&template=00-hacktoberfest.yml&title=%F0%9F%8E%83+2022%3A+ -[11]: https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/issues/new?assignees=&labels=&template=00-hacktoberfest.yml&title=%F0%9F%8E%83+2022%3A+ -[12]: https://github.com/MicrosoftDocs/windows-powershell-docs/issues/new?assignees=&labels=&template=00-hacktoberfest.yml&title=%F0%9F%8E%83+2022%3A+ -[13]: https://github.com/MicrosoftDocs/azure-docs-powershell/issues/new?assignees=&labels=&template=00-hacktoberfest.yml&title=%F0%9F%8E%83+2022%3A+ -[14]: https://hacktoberfest.com/participation/#values -[15]: https://docs.github.com/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests -[16]: /contribute/git-github-fundamentals -[17]: https://hacktoberfest.com/ +[03]: /contribute/git-github-fundamentals +[04]: /powershell/module/microsoft.powershell.core/about/about_splatting +[05]: /powershell/scripting/community/contributing/editorial-checklist +[06]: /powershell/scripting/community/contributing/powershell-style-guide +[07]: https://docs.github.com/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests +[08]: https://github.com/MicrosoftDocs/azure-docs-powershell/issues/new?assignees=&labels=&template=00-hacktoberfest.yml&title=%F0%9F%8E%83+2022%3A+ +[09]: https://github.com/MicrosoftDocs/PowerShell-Docs-DSC/issues/new?assignees=&labels=&template=00-hacktoberfest.yml&title=%F0%9F%8E%83+2022%3A+ +[10]: https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/issues/new?assignees=&labels=&template=00-hacktoberfest.yml&title=%F0%9F%8E%83+2022%3A+ +[11]: https://github.com/MicrosoftDocs/PowerShell-Docs/issues/9257 +[12]: https://github.com/MicrosoftDocs/PowerShell-Docs/issues/new?assignees=&labels=&template=00-hacktoberfest.yml&title=%F0%9F%8E%83+2022%3A+ +[13]: https://github.com/MicrosoftDocs/windows-powershell-docs/issues/new?assignees=&labels=&template=00-hacktoberfest.yml&title=%F0%9F%8E%83+2022%3A+ +[14]: https://hacktoberfest.com/ diff --git a/reference/docs-conceptual/security/remoting/SSH-Remoting-in-PowerShell.md b/reference/docs-conceptual/security/remoting/SSH-Remoting-in-PowerShell.md index 28274c653103..ea3ccb0459d1 100644 --- a/reference/docs-conceptual/security/remoting/SSH-Remoting-in-PowerShell.md +++ b/reference/docs-conceptual/security/remoting/SSH-Remoting-in-PowerShell.md @@ -70,51 +70,66 @@ remote computer. And, you must enable **password** or **key-based** authenticati 1. Edit the `sshd_config` file located at `$Env:ProgramData\ssh`. - Make sure password authentication is enabled: + - Make sure password authentication is enabled: - ``` - PasswordAuthentication yes - ``` + ``` + PasswordAuthentication yes + ``` - Create the SSH subsystem that hosts a PowerShell process on the remote computer: + - Create the SSH subsystem that hosts a PowerShell process on the remote computer: - ``` - Subsystem powershell C:/progra~1/powershell/7/pwsh.exe -sshs -NoLogo - ``` + ``` + Subsystem powershell C:/progra~1/powershell/7/pwsh.exe -sshs + ``` - > [!NOTE] - > Starting in PowerShell 7.4, you no longer need to use the `-NoLogo` parameter when running - > PowerShell in SSH server mode. + > [!NOTE] + > There is a bug in OpenSSH for Windows that prevents you from using a path with spaces for the + > subsystem executable. There are two ways to work around this issue: + > + > - Use the Windows _8.3-style_ short name for the PowerShell executable path + > - Create a symbolic link to the PowerShell executable that results in a path without spaces + > + > For more information, see [issue #784][09] in the PowerShell/Win32-OpenSSH repository. - > [!NOTE] - > The default location of the PowerShell executable is `C:/progra~1/powershell/7/pwsh.exe`. The - > location can vary depending on how you installed PowerShell. - > - > You must use the 8.3 short name for any file paths that contain spaces. There's a bug in - > OpenSSH for Windows that prevents spaces from working in subsystem executable paths. For more - > information, see this [GitHub issue][09]. - > - > The 8.3 short name for the `Program Files` folder in Windows is usually `Progra~1`. However, - > you can use the following command to make sure: - > - > ```powershell - > Get-CimInstance Win32_Directory -Filter 'Name="C:\\Program Files"' | - > Select-Object EightDotThreeFileName - > ``` - > - > ```Output - > EightDotThreeFileName - > --------------------- - > C:\progra~1 - > ``` - - Optionally, enable key authentication: + You only need to get the 8.3-style name for the segment of the path that contains the space. By + default PowerShell 7 is installed in `C:\Program Files\PowerShell\7\`. The 8.3-style name for + `Program Files` should be `progra~1`. You can use the following command to verify the name: - ``` - PubkeyAuthentication yes - ``` + ```powershell + Get-CimInstance Win32_Directory -Filter 'Name="C:\\Program Files"' | + Select-Object EightDotThreeFileName + ``` + + The 8.3 name is a legacy feature of the NTFS file system that can be disabled. This feature + must be enabled for the volume on which PowerShell is installed. - For more information, see [Managing OpenSSH Keys][05]. + Alternatively, you can create a symbolic link to the PowerShell executable that results in a + path without spaces. This method is preferred because it allows you to update the link if the + path to the PowerShell executable ever changes, without also needing to update your + `sshd_config` file. + + Use the following command to create a symbolic link to the executable: + + ```powershell + $newItemSplat = @{ + ItemType = 'SymbolicLink' + Path = 'C:\ProgramData\ssh\' + Name = 'pwsh.exe' + Value = (Get-Command pwsh.exe).Source + } + New-Item @newItemSplat + ``` + + This command creates the symbolic link in the same directory used by the OpenSSH server to store + the host keys and other configuration. + + - Optionally, enable key authentication: + + ``` + PubkeyAuthentication yes + ``` + + For more information, see [Managing OpenSSH Keys][05]. 1. Restart the **sshd** service. @@ -137,34 +152,29 @@ remote computer. And, you must enable **password** or **key-based** authenticati 1. Edit the `sshd_config` file at location `/etc/ssh`. - Make sure password authentication is enabled: + - Make sure password authentication is enabled: - ``` - PasswordAuthentication yes - ``` + ``` + PasswordAuthentication yes + ``` - Optionally, enable key authentication: + - Optionally, enable key authentication: - ``` - PubkeyAuthentication yes - ``` + ``` + PubkeyAuthentication yes + ``` - For more information about creating SSH keys on Ubuntu, see the manpage for - [ssh-keygen][08]. + For more information about creating SSH keys on Ubuntu, see the manpage for [ssh-keygen][08]. - Add a PowerShell subsystem entry: - - ``` - Subsystem powershell /usr/bin/pwsh -sshs -NoLogo - ``` + - Add a PowerShell subsystem entry: - > [!NOTE] - > The default location of the PowerShell executable is `/usr/bin/pwsh`. The location can vary - > depending on how you installed PowerShell. + ``` + Subsystem powershell /usr/bin/pwsh -sshs -NoLogo + ``` - > [!NOTE] - > Starting in PowerShell 7.4, you no longer need to use the `-NoLogo` parameter when running - > PowerShell in SSH server mode. + > [!NOTE] + > The default location of the PowerShell executable is `/usr/bin/pwsh`. The location can vary + > depending on how you installed PowerShell. 1. Restart the **ssh** service. @@ -193,31 +203,27 @@ remote computer. And, you must enable **password** or **key-based** authenticati sudo nano /private/etc/ssh/sshd_config ``` - Make sure password authentication is enabled: - - ``` - PasswordAuthentication yes - ``` + - Make sure password authentication is enabled: - Add a PowerShell subsystem entry: + ``` + PasswordAuthentication yes + ``` - ``` - Subsystem powershell /usr/local/bin/pwsh -sshs -NoLogo - ``` + - Add a PowerShell subsystem entry: - > [!NOTE] - > The default location of the PowerShell executable is `/usr/local/bin/pwsh`. The location can - > vary depending on how you installed PowerShell. + ``` + Subsystem powershell /usr/local/bin/pwsh -sshs -NoLogo + ``` - > [!NOTE] - > Starting in PowerShell 7.4, you no longer need to use the `-NoLogo` parameter when running - > PowerShell in SSH server mode. + > [!NOTE] + > The default location of the PowerShell executable is `/usr/local/bin/pwsh`. The location can + > vary depending on how you installed PowerShell. - Optionally, enable key authentication: + - Optionally, enable key authentication: - ``` - PubkeyAuthentication yes - ``` + ``` + PubkeyAuthentication yes + ``` 1. Restart the **sshd** service.