This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VBRCloudTapeBackupTenantJob

Short Description

Returns tenant jobs.

Applies to

Product Edition: Enterprise

Requires Cloud Connect license

Syntax

This cmdlet provides the following parameter sets:

  • For getting tenant jobs by the job name

Get-VBRCloudTapeBackupTenantJob [-Name <string[]>]  [<CommonParameters>]

  • For getting tenant jobs by the job ID

Get-VBRCloudTapeBackupTenantJob -Id <guid[]>  [<CommonParameters>]

  • For getting tenant jobs by the tenant ID

Get-VBRCloudTapeBackupTenantJob -TenantId <guid[]>  [<CommonParameters>]

  • For getting tenant jobs by the tenant repository ID

Get-VBRCloudTapeBackupTenantJob -TenantRepositoryId <guid[]>  [<CommonParameters>]

Detailed Description

This cmdlet returns the array of jobs from the tenant Veeam Backup & Replication infrastructure.

Get-VBRCloudTapeBackupTenantJob Important!

You can run this cmdlet from the service provider side only.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Id

Specifies an array of tenant jobs IDs. The cmdlet will return tenant jobs with specified IDs.

True

Named

True (ByValue,
ByProperty
Name)

False

TenantId

Specifies an array of tenant IDs. The cmdlet will return tenant jobs of specified tenant IDs.

True

Named

True (ByValue,
ByProperty
Name)

False

TenantRepositoryId

Specifies an array of the tenant cloud repository IDs. The cmdlet will return tenant jobs that are targeted to these repositories.

True

Named

True (ByValue,
ByProperty
Name)

False

Name

Specifies an array of tenant jobs names. The cmdlet will return tenant jobs with these names.

False

Named

True (ByValue,
ByProperty
Name)

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

Example 1

This command gets a tenant job by the job name.

Get-VBRCloudTapeBackupTenantJob -Name "Backup Job 01"

Example 2

This command gets a tenant job by the job ID.

Get-VBRCloudTapeBackupTenantJob -Id "0814a9b4-5fba-4f20-86dd-4790a5b659ab"

Example 3

This command gets a tenant job by the tenant ID.

Get-VBRCloudTapeBackupTenantJob -TenantId "12a6f8f5-832a-4c7c-9b9b-74b020d6d78e"

Example 4

This command gets a tenant job by the tenant repository ID.

Get-VBRCloudTapeBackupTenantJob -TenantRepositoryId "729c82d6-54d5-4eb6-b0f2-9d85bcff1b9b"