Resource Type: dsc_exosafelinkspolicy

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

Overview

The DSC EXOSafeLinksPolicy resource type. Automatically generated from version 1.21.1222.1

Properties

  • dsc_admindisplayname

    The AdminDisplayName parameter specifies a description for the policy.

  • dsc_applicationid

    Id of the Azure Active Directory application to authenticate with.

  • dsc_certificatepath

    Path to certificate used in service principal usually a PFX file.

  • dsc_certificatethumbprint

    Thumbprint of the Azure Active Directory application’s authentication certificate to use for authentication.

  • dsc_customnotificationtext

    The custom notification text specifies the customized notification text to show to users.

  • dsc_delivermessageafterscan

    The DeliverMessageAfterScan parameter specifies whether to deliver email messages only after Safe Links scanning is complete. Valid values are: $true: Wait until Safe Links scanning is complete before delivering the message. $false: If Safe Links scanning can’t complete, deliver the message anyway. This is the default value.

  • dsc_donotallowclickthrough

    The DoNotAllowClickThrough parameter specifies whether to allow users to click through to the original URL. Valid values are: $true: The user isn’t allowed to click through to the original URL. This is the default value. $false: The user is allowed to click through to the original URL.

  • dsc_donotrewriteurls

    The DoNotRewriteUrls parameter specifies a URL that’s skipped by Safe Links scanning. You can specify multiple values separated by commas.

  • dsc_donottrackuserclicks

    The DoNotTrackUserClicks parameter specifies whether to track user clicks related to links in email messages. Valid values are: $true: User clicks aren’t tracked. This is the default value. $false: User clicks are tracked.

  • dsc_enableforinternalsenders

    The EnableForInternalSenders parameter specifies whether the Safe Links policy is applied to messages sent between internal senders and internal recipients within the same Exchange Online organization.

  • dsc_enableorganizationbranding

    The EnableOrganizationBranding parameter specifies whether your organization’s logo is displayed on Safe Links warning and notification pages.

  • dsc_enablesafelinksforteams

    The EnableSafeLinksForTeams parameter specifies whether Safe Links is enabled for Microsoft Teams. Valid values are: $true: Safe Links is enabled for Teams. If a protected user clicks a malicious link in a Teams conversation, group chat, or from channels, a warning page will appear in the default web browser. $false: Safe Links isn’t enabled for Teams. This is the default value.

  • dsc_ensure

    Specify if this policy should exist or not.

  • dsc_isenabled

    This parameter specifies whether the rule or policy is enabled.

  • dsc_scanurls

    The ScanUrls parameter specifies whether to enable or disable the scanning of links in email messages. Valid values are: $true: Scanning links in email messages is enabled. $false: Scanning links in email messages is disabled. This is the default value.

  • dsc_tenantid

    Id of the Azure Active Directory tenant used for authentication.

  • dsc_usetranslatednotificationtext

    The UseTranslatedNotificationText specifies whether to use Microsoft Translator to automatically localize the custom notification text that you specified with the CustomNotificationText parameter.

Parameters

  • dsc_certificatepassword

    Username can be made up to anything but password will be used for CertificatePassword

  • dsc_credential

    Credentials of the Exchange Global Admin

  • dsc_identity (namevar)

    The Identity parameter specifies the SafeLinks policy that you want to modify.

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