Resource Type: dsc_scretentioncompliancerule

Defined in:

lib/puppet/type/dsc_scretentioncompliancerule.rb

Overview

The DSC SCRetentionComplianceRule resource type. Automatically generated from version 1.21.1222.1

Properties

• dsc_comment

  The Comment parameter specifies an optional comment.

• dsc_contentmatchquery

  The ContentMatchQuery parameter specifies a content search filter.

• dsc_ensure

  Specify if this rule should exist or not.

• dsc_excludeditemclasses

  The ExcludedItemClasses parameter specifies the types of messages to exclude from the rule. You can use this parameter only to exclude items from a hold policy, which excludes the specified item class from being held. Using this parameter won’t exclude items from deletion policies. Typically, you use this parameter to exclude voicemail messages, IM conversations, and other Skype for Business Online content from being held by a hold policy.

• dsc_expirationdateoption

  The ExpirationDateOption parameter specifies whether the expiration date is calculated from the content creation date or last modification date. Valid values are: CreationAgeInDays and ModificationAgeInDays.

• dsc_policy

  The Policy parameter specifies the policy to contain the rule.

• dsc_retentioncomplianceaction

  The RetentionComplianceAction parameter specifies the retention action for the rule. Valid values are: Delete, Keep and KeepAndDelete.

• dsc_retentionduration

  The RetentionDuration parameter specifies the hold duration for the retention rule. Valid values are: An integer - The hold duration in days, Unlimited - The content is held indefinitely.

• dsc_retentiondurationdisplayhint

  The RetentionDurationDisplayHint parameter specifies the units that are used to display the retention duration in the Security and Compliance Center. Valid values are: Days, Months or Years.

Parameters

• dsc_credential

  Credentials of the Exchange Global Admin

• dsc_name (namevar)

  The Name parameter specifies the unique name of the retention rule.

• dsc_psdscrunascredential
• name (namevar)

  Description of the purpose for this resource declaration.

• validation_mode (defaults to: property)

  Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).