Get-BitsTransfer

Get-BitsTransfer

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

構文

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

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




詳細説明

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.

パラメーター

-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.


エイリアス

なし

必須?

false

位置は?

2

既定値

Current

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-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.


エイリアス

なし

必須?

true

位置は?

1

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-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.


エイリアス

なし

必須?

false

位置は?

1

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

  • Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]

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


出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

  • Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]

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


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

関連トピック

コミュニティの追加

追加
表示: