Short Description
Creates a new backup item.
Syntax
This cmdlet provides 4 parameter sets.
- For creating a new user item:
New-VBOBackupItem -User <VBOOrganizationUser[]> [-Mailbox] [-ArchiveMailbox] [-OneDrive] [-Sites] [<CommonParameters>] |
- For creating a new organization item:
New-VBOBackupItem -Organization <VBOOrganization[]> [-Mailbox] [-ArchiveMailbox] [-OneDrive] [-Sites] [<CommonParameters>] |
- For creating a new site item:
New-VBOBackupItem -Site <VBOOrganizationSite> [<CommonParameters>] |
- For creating a new group item:
New-VBOBackupItem -Group <VBOOrganizationGroup[]> [-Mailbox] [-ArchiveMailbox] [-OneDrive] [-Sites] [-GroupMailbox] [-GroupSite] [<CommonParameters>] |
Detailed Description
This cmdlet creates a new backup item usable for Add-VBOJob cmdlet. There are several limitations to be considered for the usage of this cmdlet:
- All of the VBOBackupItem components cannot be set $false as there will be an error in this case.
- Only VBOBackupItem-s for the Office365 type of organization group can be set to have only GroupMailbox and GroupSite backup item processing options. The items for the rest of the organization group types must have at least one of the Mailbox, ArchiveMailbox, OneDrive or Sites processing option included.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
OneDrive | Indicates that the cmdlet will include OneDrive processing option in the backup item. Cannot be used with a PublicMailbox type of organization user. | False | Named | False | False |
Mailbox | Indicates that the cmdlet will include Mailbox processing option in the backup item. | False | Named | False | False |
ArchiveMailbox | Indicates that the cmdlet will include Archive Mailbox processing option in the backup item. Cannot be used with a PublicMailbox type of organization user. | False | Named | False | False |
User | Specifies an organization user. This cmdlet will create a backup item for the specified organization user. | True | Named | False | False |
Group | Specifies an organization group. This cmdlet will create a backup item for the specified organization group. | True | Named | False | False |
Site | Specifies an organization site. This cmdlet will create a backup item for the specified organization site. | True | Named | False | False |
Sites | Indicates that the cmdlet will include Sites processing option in the backup item. | False | Named | False | False |
Organization | Specifies an organization. This cmdlet will create a backup item for the specified organization. | True | Named | False | False |
GroupMailbox | Indicates that the cmdlet will include Group Mailbox processing option in the backup item. Can be used only for a group backup item. | False | Named | False | False |
GroupSite | Indicates that the cmdlet will include Group Site processing option in the backup item.Can be used only for a group backup item. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example 1
This example shows how to create a backup item with all "UserAlpha" processing options, except for the mailbox:
- Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
- Run Get-VBOOrganizationUser with the $org variable and a "UserAlpha" value for the Name parameter to get a user with the name "UserAlpha". Save the result to the $user variable.
- Run New-VBOBackupItem with the $user value for the User parameter, ArchiveMailbox and OneDrive parameters, and a $false value for the Mailbox parameter to create a backup item with all "UserAlpha" processing options except for the mailbox.
PS C:\PS> $org = Get-VBOOrganization -Name "ABC" PS C:\PS> $user = Get-VBOOrganizationUser -Organization $org -Name "UserAlpha" PS C:\PS> New-VBOBackupItem -User $user -Mailbox:$false -ArchiveMailbox -OneDrive |
Example 2
This example shows how to create a backup item with an organization "ABC" mailbox, archive mailbox, all of the sites but without the OneDrive processing option:
- Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
- Run New-VBOBackupItem with the $org value for the Organization parameter, Mailbox, Archive Mailbox and Sites parameters, and a $false value for the OneDrive parameter to create a backup item with all "ABC" organization processing options except for the OneDrive components.
PS C:\PS> $org = Get-VBOOrganization -Name "ABC" PS C:\PS> New-VBOBackupItem -Organization $org -Mailbox -ArchiveMailbox -OneDrive$:false -Sites |
Example 3
This example shows how to create a backup item with "ABC" organization site with a given URL:
- Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
- Save a certain SharePoint organization site URL address to the $siteUrl variable.
- Run Get-VBOOrganizationSite with the $org variable and a $siteURL value for the URL parameter to get an "ABC" organization site. Save the result to the $site variable.
- Run New-VBOBackupItem with the $site variable to create a backup item with "ABC" organization site with a given URL.
PS C:\PS> $org = Get-VBOOrganization -Name "ABC" PS C:\PS> $siteUrl = https://exampleorganization.sharepoint.com/sites/exampleparentsite PS C:\PS> $site = Get-VBOOrganizationSite -Organization $org -URL $siteUrl PS C:\PS> New-VBOBackupItem -Site $site |
Example 4
This example shows how to create a backup item with all processing options for the "UsersAlpha" organization user group:
- Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
- Run Get-VBOOrganizationGroup with the $org variable and a "UsersAlpha" value for the Name parameter to get an organization user group with the name "UsersAlpha". Save the result to the $group variable.
- Run New-VBOBackupItem with the $group value for the Group parameter and Mailbox, ArchiveMailbox, OneDrive, Sites, GroupMailbox and GroupSite parameters, to create a backup item with all processing options for the "UsersAlpha" organization user group.
PS C:\PS> $org = Get-VBOOrganization -Name "ABC" PS C:\PS> $group = Get-VBOOrganizationGroup -Organization $org -Name "UsersAlpha" PS C:\PS> New-VBOBackupItem -Group $group -Mailbox -ArchiveMailbox -OneDrive -Sites -GroupMailbox -GroupSite |
