Share via


Get-AppBackgroundTask

Get-AppBackgroundTask

Gets background task information.

Sintaxe

Parameter Set: Get0
Get-AppBackgroundTask [-AsJob] [-CimSession <CimSession[]> ] [-IncludeResourceUsage] [-PackageFamilyName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Descrição detalhada

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.

Parâmetros

-AsJob

Aliases

nenhuma

Necessário?

false

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-CimSession<CimSession[]>

Executa o cmdlet em uma sessão remota ou em um computador remoto. Insira um nome do computador ou um objeto de sessão, como a saída de um cmdlet New-CimSession ou Get-CimSession. O padrão é a sessão atual do computador local.

Aliases

Session

Necessário?

false

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-IncludeResourceUsage

Indicates that the cmdlet displays detailed resource usage data for a background task.

Aliases

iru

Necessário?

false

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-PackageFamilyName<String>

Specifies the package family name for which to display background task information.

Aliases

pfn

Necessário?

false

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-ThrottleLimit<Int32>

Especifica o número máximo de operações simultâneas que podem ser estabelecidas para executar o cmdlet. Se esse parâmetro for omitido ou um valor de 0 for inserido, o Windows PowerShell® calculará o limite ideal de restrição para o cmdlet com base no número de cmdlets do CIM que estão em execução no computador. O limite de restrição se aplica somente ao cmdlet atual, e não à sessão ou ao computador.

Aliases

nenhuma

Necessário?

false

Posição?

named

Valor padrão

nenhuma

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

<CommonParameters>

Esse cmdlet dá suporte a parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entradas

O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet.

Saídas

O tipo de saída é o tipo de objeto emitido pelo cmdlet.

  • Microsoft.Management.Infrastructure.CimInstance# MSFT_BackgroundTask[]

Exemplos

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

Tópicos relacionados

Start-AppBackgroundTask

Unregister-AppBackgroundTask