Add-VBOOrganizationRetentionExclusion

Short Description

Adds retention policy settings for contacts and calendars of a specific organization.

Syntax

Add-VBOOrganizationRetentionExclusion -Organization <VBOOrganization> [-Contacts <SwitchParameter>] [-Calendar <SwitchParameter>] [<CommonParameters>]

Detailed Description

This cmdlet adds retention policy settings for contacts and calendars of a specific organization.

Add-VBOOrganizationRetentionExclusion Important

This retention policy has higher priority than the global retention policy.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Organization	Specifies an organization. The cmdlet will set retention policy for contacts and calendars added to the specified organization.	Accepts the VBOOrganization object. To get this object, run the Get-VBOOrganization cmdlet.	True	Named	False	False
Contacts	Defines that Veeam Backup for Microsoft 365 will not apply retention policy for contacts of the specified organization. If you do not provide this parameter, Veeam Backup for Microsoft 365 will apply retention policy for contacts.	SwitchParameter	False	Named	False	False
Calendar	Defines that Veeam Backup for Microsoft 365 will not apply retention policy for calendars of the specified organization. If you do not provide this parameter, Veeam Backup for Microsoft 365 will apply retention policy for calendars.	SwitchParameter	False	Named	False	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Organization

Specifies an organization. The cmdlet will set retention policy for contacts and calendars added to the specified organization.

Accepts the VBOOrganization object.

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

True

Named

False

Contacts

Defines that Veeam Backup for Microsoft 365 will not apply retention policy for contacts of the specified organization.

If you do not provide this parameter, Veeam Backup for Microsoft 365 will apply retention policy for contacts.

SwitchParameter

False

Named

False

Calendar

Defines that Veeam Backup for Microsoft 365 will not apply retention policy for calendars of the specified organization.

If you do not provide this parameter, Veeam Backup for Microsoft 365 will apply retention policy for calendars.

SwitchParameter

False

Named

False

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 VBOOrganizationRetentionExclusion object that contains settings of organization retention policy for contacts and calendars.

Examples

Add-VBOOrganizationRetentionExclusion Example 1. Enabling Retention Policy for Organization Contacts

This example shows how to enable retention policy for contacts of the Atlanta organization. Veeam Backup for Microsoft 365 will apply retention policy for contacts added to the Atlanta organization.

$org = Get-VBOOrganization -Name "Atlanta"

Add-VBOOrganizationRetentionExclusion -Organization $org -Contacts

Perform the following steps:

Run the Get-VBOOrganization cmdlet. Set the Name parameter value. Save the result to the $org variable.
Run the Add-VBOOrganizationRetentionExclusion cmdlet. Set the $org variable as the Organization parameter value. Provide the Contacts parameter.

Add-VBOOrganizationRetentionExclusion Example 2. Enabling Retention Policy for Organization Calendars

This example shows how to enable retention policy for calendars of the Atlanta organization. Veeam Backup for Microsoft 365 will apply retention policy for calendars added to the Atlanta organization.

$org = Get-VBOOrganization -Name "Atlanta"

Add-VBOOrganizationRetentionExclusion -Organization $org -Calendar

Perform the following steps:

Run the Get-VBOOrganization cmdlet. Set the Name parameter value. Save the result to the $org variable.
Run the Add-VBOOrganizationRetentionExclusion cmdlet. Set the $org variable as the Organization parameter value. Provide the Calendar parameter.

Related Commands

Get-VBOOrganization