Get-AppBackgroundTask
Get-AppBackgroundTask
Gets background task information.
構文
Parameter Set: Get0
Get-AppBackgroundTask [-AsJob] [-CimSession <CimSession[]> ] [-IncludeResourceUsage] [-PackageFamilyName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
詳細説明
The Get-AppBackgroundTask cmdlet gets background task information for a task specified in the PackageFamilyName parameter. A background task performs an activity for an application, such as downloading a file. You must have administrator access to get background information.
パラメーター
-AsJob
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-CimSession<CimSession[]>
リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。
エイリアス |
Session |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-IncludeResourceUsage
Indicates that the cmdlet displays detailed resource usage data for a background task.
エイリアス |
iru |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-PackageFamilyName<String>
Specifies the package family name for which to display background task information.
エイリアス |
pfn |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-ThrottleLimit<Int32>
このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0
を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
- Microsoft.Management.Infrastructure.CimInstance# MSFT_BackgroundTask[]
例
Example 1: Display background tasks
This command displays the registered background tasks that belong to the Microsoft.BingSports_8wekyb3d8bbwe package family.
PS C:\> Get-AppBackgroundTask -PackageFamilyName "Microsoft.BingSports_8wekyb3d8bbwe "
Example 2: Display background tasks with resource usage data
This command displays the registered background tasks that belong to the Microsoft.BingSports_8wekyb3d8bbwe package family, including detailed resource usage information.
PS C:\> Get-AppBackgroundTask -PackageFamilyName "Microsoft.BingSports_8wekyb3d8bbwe " -IncludeResourceUsage
Example 3: Display all background tasks for a user
This command displays all registered background tasks for the current user.
PS C:\> Get-AppBackgroundTask