Resource Type: dsc_scretentioncompliancepolicy

Defined in:
lib/puppet/type/dsc_scretentioncompliancepolicy.rb

Overview

The DSC SCRetentionCompliancePolicy resource type. Automatically generated from version 1.21.1222.1

Properties

  • dsc_comment

    The Comment parameter specifies an optional comment.

  • dsc_dynamicscopelocation

    Location of the dynamic scope for this policy.

  • dsc_enabled

    Determines if the policy is enabled or not.

  • dsc_ensure

    Specify if this policy should exist or not.

  • dsc_exchangelocation

    The ExchangeLocation parameter specifies the mailboxes to include.

  • dsc_exchangelocationexception

    This parameter specifies the mailboxes to remove from the list of excluded mailboxes when you use the value All for the ExchangeLocation parameter

  • dsc_moderngrouplocation

    The ModernGroupLocation parameter specifies the Office 365 groups to include in the policy.

  • dsc_moderngrouplocationexception

    The ModernGroupLocationException parameter specifies the Office 365 groups to exclude when you’re using the value All for the ModernGroupLocation parameter.

  • dsc_onedrivelocation

    The OneDriveLocation parameter specifies the OneDrive for Business sites to include. You identify the site by its URL value, or you can use the value All to include all sites.

  • dsc_onedrivelocationexception

    This parameter specifies the OneDrive for Business sites to exclude when you use the value All for the OneDriveLocation parameter. You identify the site by its URL value.

  • dsc_publicfolderlocation

    The PublicFolderLocation parameter specifies that you want to include all public folders in the retention policy. You use the value All for this parameter.

  • dsc_restrictiveretention

    The RestrictiveRetention parameter specifies whether Preservation Lock is enabled for the policy.

  • dsc_sharepointlocation

    The SharePointLocation parameter specifies the SharePoint Online sites to include. You identify the site by its URL value, or you can use the value All to include all sites.

  • dsc_sharepointlocationexception

    This parameter specifies the SharePoint Online sites to exclude when you use the value All for the SharePointLocation parameter. You identify the site by its URL value.

  • dsc_skypelocation

    The SkypeLocation parameter specifies the Skype for Business Online users to include in the policy.

  • dsc_skypelocationexception

    This parameter is reserved for internal Microsoft use.

  • dsc_teamschannellocation

    The TeamsChannelLocation parameter specifies the Teams Channel to include in the policy.

  • dsc_teamschannellocationexception

    This parameter specifies the SharePoint Online sites to exclude when you use the value All for the TeamsChannelLocation parameter. You identify the site by its URL value.

  • dsc_teamschatlocation

    The TeamsChatLocation parameter specifies the Teams Chat to include in the policy.

  • dsc_teamschatlocationexception

    This parameter specifies the SharePoint Online sites to exclude when you use the value All for the TeamsChatLocation parameter. You identify the site by its URL value.

Parameters

  • dsc_credential

    Credentials of the Exchange Global Admin

  • dsc_name (namevar)

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

  • 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).