Skip to content

Fixes #11303 - Fix description of -AsJob #11304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 31, 2024
Merged

Fixes #11303 - Fix description of -AsJob #11304

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 4 additions & 12 deletions reference/5.1/Microsoft.PowerShell.Management/Test-Connection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
Locale: en-US
Module Name: Microsoft.PowerShell.Management
ms.date: 12/12/2022
ms.date: 07/31/2024
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.management/test-connection?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: Test-Connection
Expand Down Expand Up @@ -162,17 +162,9 @@ cmdlet to create the **PSSession**.

### -AsJob

Indicates that this cmdlet runs as a background job.

To use this parameter, the local and remote computers must be configured for remoting and, on
Windows Vista and later versions of the Windows operating system, you must open PowerShell by using
the **Run as administrator** option. For more information, see
[about_Remote_Requirements](../microsoft.powershell.core/about/about_remote_requirements.md).

When you specify the **AsJob** parameter, the command immediately returns an object that represents
the background job. You can continue to work in the session while the job finishes. The job is
created on the local computer and the results from remote computers are automatically returned to
the local computer. To get the job results, use the `Receive-Job` cmdlet.
Indicates that this cmdlet runs as a background job. When you specify the **AsJob** parameter, the
command immediately returns an object that represents the background job. You can continue to work
in the session while the job finishes. To get the job results, use the `Receive-Job` cmdlet.

For more information about PowerShell background jobs, see
[about_Jobs](../Microsoft.PowerShell.Core/About/about_jobs.md) and
Expand Down