Get-VBOBackupApplication

In this article

    Short Description

    Returns backup application settings that are added to Microsoft organizations.

    Syntax

    Get-VBOBackupApplication -Organization <VBOOrganization> [-DisplayName <string>] [-ApplicationId <guid>][-ThumbprintCertificate <string>] [<CommonParameters>]

    Detailed Description

    This cmdlet returns backup application settings that are added to Microsoft organizations. The backup application represents settings of an Azure AD application.

    Get-VBOBackupApplication Important

    • This cmdlet is available only in Veeam Backup for Microsoft 365 version 4c or later.
    • This cmdlet will run only for Microsoft organizations that are added to the Veeam Backup for Microsoft 365 infrastructure using modern app-only authentication method.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Organization

    Specifies a Microsoft organization. The cmdlet will return settings of backup applications that are added to the specified Microsoft organization.

    Accepts the VBOOrganization object.

    To get this object, run the Get-VBOOrganization cmdlet.

    True

    Named

    True (ByValue)

    False

    DisplayName

    Specifies a display name of a backup application. The cmdlet will return settings of a backup application with the specified name.

    String

    False

    Named

    False

    True

    ApplicationId

    Specifies an ID of a backup application. The cmdlet will return settings of a backup application with the specified ID.

    Guid

    False

    Named

    False

    False

    ThumbprintCertificate

    Specifies a thumbprint of a backup application. The cmdlet will return settings of a backup application with the specified thumbprint.

    String

    False

    Named

    False

    False

    <CommonParameters>

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

    Output Object

    The cmdlet returns the VBOBackupApplication object that contains backup application settings that are added to Microsoft organizations.

    Examples

    Get-VBOBackupApplicationExample 1. Getting All Backup Application Settings

    This example shows how to get all backup application settings that are added to Microsoft organizations.

    $org = Get-VBOOrganization

    Get-VBOBackupApplication -Organization $org

    Perform the following steps:

    1. Run the Get-VBOOrganization cmdlet. Save the result to the $org variable.
    2. Run the Get-VBOBackupApplication cmdlet. Set the $org variable as the Organization parameter value.

    Get-VBOBackupApplicationExample 2. Getting Backup Application Settings by ID

    This example shows how to get the c3adb1ab-dc54-4a1c-8d7c-63dacf5209f3 backup application settings that are added to Microsoft organizations.

    $org = Get-VBOOrganization

    Get-VBOBackupApplication -Organization $org -ApplicationId c3adb1ab-dc54-4a1c-8d7c-63dacf5209f3

    Perform the following steps:

    1. Run the Get-VBOOrganization cmdlet. Save the result to the $org variable.
    2. Run the Get-VBOBackupApplication cmdlet. Set the $org variable as the Organization parameter value. Specify the ApplicationId parameter value.

    Related Commands

    Get-VBOOrganization