Get-VBREntraIDTenantBackupJob

Short Description

Returns backup jobs that protect Microsoft Entra ID tenants.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides cmdlet sets that allow you to:

  • Get all Entra ID tenant backup jobs.

Get-VBREntraIDTenantBackupJob [<CommonParameters>]

  • Get tenant backup jobs by job IDs.

Get-VBREntraIDTenantBackupJob -Id <Guid[]> [<CommonParameters>]

  • Get tenant backup jobs by job names.

Get-VBREntraIDTenantBackupJob -Name <String[]> [<CommonParameters>]

Detailed Description

This cmdlet returns backup jobs that protect Entra ID tenants.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Id

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

Guid[]

True

Named

True (ByPropertyName)

Name

Specifies an array of names of tenant backup jobs. The cmdlet will return an array of jobs with the specified names.

String[]

True

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the array of VBREntraIDTenantBackupJob objects that contain settings of the tenant backup job.

Examples

Get-VBREntraIDTenantBackupJobExample 1. Get All Tenant Backup Jobs

This example shows how to get all tenant backup jobs.

$backupJobs = Get-VBREntraIDTenantBackupJob

Get-VBREntraIDTenantBackupJobExample 2. Get Tenant Backup Job by Name

This example shows how to get the Tenant Backup backup job.

$backupJob = Get-VBREntraIDTenantBackupJob -Name "Tenant Backup"

Page updated 11/19/2024

Page content applies to build 12.3.0.310