Get-BitsTransfer

Get-BitsTransfer

Retrieves the associated BitsJob object for an existing Background Intelligent Transfer Service (BITS) transfer job.

Sintaxis

Parameter Set: ListJobsByName
Get-BitsTransfer [[-Name] <String[]> ] [[-AllUsers]] [ <CommonParameters>]

Parameter Set: ListJobsById
Get-BitsTransfer [-JobId] <Guid[]> [ <CommonParameters>]

Descripción detallada

The Get-BitsTransfer cmdlet retrieves a set of BITS transfer jobs. By default, the cmdlet returns the jobs that are owned by the current user. However, if you have administrative credentials, you can specify the AllUsers parameter so that the command returns jobs that are owned by all users. The returned jobs can be filtered by name or ID. The jobs are represented by BitsJob objects.

Parámetros

-AllUsers

Returns BITS transfer jobs that are owned by all users. If this parameter is not specified, only jobs that are owned by the current user are returned. This parameter requires administrative credentials.

-JobId<Guid[]>

Filters the returned BITS jobs by job ID. Only the BITS jobs that include a job ID in this array are returned. If BitsJob objects are piped to this cmdlet, their job IDs are used as the values of this parameter.

-Name<String[]>

Filters the returned BITS jobs based on job name. Only BITS jobs with job names that match a name in this array are returned. You can use standard wildcard characters such as the asterisk (*) and the question mark (?). Or, you can use a range operator such as"[a-r]".

For example, you can use any of the following commands:

Get-BitsTransfer -Name "BITS*"

Get-BitsTransfer -Name "BITS Transfe?"

Get-BitsTransfer -Name "BITS Transfe[a-r]"

A combination of the wildcard character and range operators is also possible.

<CommonParameters>

Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entradas

El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.

• Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]

  This cmdlet accepts one or more BitsJob objects as input that populates the JobId parameter (based on the property name).

Salidas

El tipo de resultado es el tipo de objetos que emite el cmdlet.

• Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]

  This cmdlet generates the BitsJob objects that are associated with the retrieved BITS transfer jobs.

Ejemplos

EXAMPLE 1

This command returns all the BitsJob objects that are owned by the current user.

PS C:\>Get-BitsTransfer

EXAMPLE 2

This command returns the BitsJob object that is identified by the specified job ID.

PS C:\>Get-BitsTransfer -JobId C0DD3D8C-C3A2-4562-80B19224879C

EXAMPLE 3

This command returns all the BitsJob objects, owned by all users, where the DisplayName property of the BitsJob object contains either "Microsoft" or "Windows". If the user does not have administrative credentials, this command returns an error because it uses the AllUsers parameter.

PS C:\>Get-BitsTransfer -AllUsers -Name *Microsoft*, *Windows*

EXAMPLE 4

This command returns the BitsJob object that is identified by the specified display name.

C:\PS>Get-BitsTransfer -Name testjob1

Temas relacionados

Add-BitsFile

Complete-BitsTransfer

Remove-BitsTransfer

Resume-BitsTransfer

Set-BitsTransfer

Start-BitsTransfer

Suspend-BitsTransfer