New-VBOBackupAccount

In this article

    Short Description

    Creates auxiliary backup accounts to back up SharePoint and OneDrive for Business.

    Syntax

    New-VBOBackupAccount -SecurityGroupMember <VBOOrganizationGroupMember> -Password <securestring> [<CommonParameters>]

    Detailed Description

    This cmdlet creates the VBOBackupAccount object that defines settings of auxiliary backup accounts. You may want to use these backup accounts to reduce throttling when backing up SharePoint and OneDrive for Business data.

    New-VBOBackupAccount Important

    You can not configure auxiliary backup accounts for on-premises Microsoft SharePoint organizations.

    The entire security group will be granted the Site Collection Administrator role, which means that each user in this group will be granted this role as well, regardless of what users have been added with the SecurityGroupMember parameter. The role, however, can only be granted if you have used the GrantRolesAndPermissions parameter when defining connection settings to access the Microsoft Office 365 organization. Granting occurs during the first session of each of the backup jobs with SharePoint or OneDrive for Business items. If a user ceases to be a member of the group, the role is automatically annulled for this user.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    SecurityGroupMember

    Specifies security groups. The cmdlet will use accounts from these security groups to back up Microsoft SharePoint and OneDrive for Business data.

    Accepts the VBOOrganizationGroupMember object. To get this object, run the Get-VBOOrganizationGroupMember cmdlet.

    True

    Named

    False

    False

    Password

    Specifies a password. The cmdlet will use this password to back up Microsoft SharePoint and OneDrive for Business data.

    SecureString

    True

    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

    This cmdlet returns the VBOBackupAccount object that defines settings of auxiliary backup accounts to back up Microsoft SharePoint and OneDrive for Business data

    Examples

    Defining Auxiliary Backup Account to Back up Microsoft SharePoint and OneDrive for Business

    This example shows how to define auxiliary backup account to back up Microsoft SharePoint and OneDrive for Business.

    $org = Get-VBOOrganization

    $group = Get-VBOOrganizationGroup -Organization $org -Name "VBOWorkGroup"

    $members = Get-VBOOrganizationGroupMember -Group $group

    $pwd = ConvertTo-SecureString -String "Pa$$word123" -AsPlainText -Force

    $account = New-VBOBackupAccount -SecurityGroupMember $members[0] -Password $pwd

    Perform the following steps:

    1. Run the Get-VBOOrganization cmdlet. Save the result to the $org variable.
    2. Run the Get-VBOOrganizationGroup cmdlet. Set the $org variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $group variable.
    3. Run the Get-VBOOrganizationGroupMember cmdlet. Set the $group variable as the Group variable value. Save the result to the $members variable.
    4. Run the ConvertTo-SecureString cmdlet. Specify the necessary parameters. Save the result to the $pwd variable.
    5. Run the New-VBOBackupAccount cmdlet. Set the $members variable as the SecurityGroupMember parameter value. Set the $pwd variable as the Password parameter value. Save the result to the $pwd variable.

    Related Commands