Resource Type: dsc_xexchecpvirtualdirectory

Defined in:

lib/puppet/type/dsc_xexchecpvirtualdirectory.rb

Providers:

powershell

Overview

The DSC xExchEcpVirtualDirectory resource type. Automatically generated from ‘xExchange/DSCResources/MSFT_xExchEcpVirtualDirectory/MSFT_xExchEcpVirtualDirectory.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present

Parameters

• dsc_adfsauthentication

  AdfsAuthentication - The AdfsAuthentication parameter specifies that the ECP virtual directory allows users to authenticate through Active Directory Federation Services (AD FS) authentication. This parameter accepts $true or $false. The default value is $false.

  Supported values:

  • true
  • false
• dsc_adminenabled

  AdminEnabled - The AdminEnabled parameter specifies that the EAC isn’t able to be accessed through the Internet.

  Supported values:

  • true
  • false
• dsc_allowservicerestart

  AllowServiceRestart - Whether it is OK to recycle the app pool after making changes. Defaults to $true.

  Supported values:

  • true
  • false
• dsc_basicauthentication

  BasicAuthentication - The BasicAuthentication parameter specifies whether Basic authentication is enabled on the virtual directory.

  Supported values:

  • true
  • false
• dsc_credential

  Credential - Credentials used to establish a remote PowerShell session to Exchange.

• dsc_digestauthentication

  DigestAuthentication - The DigestAuthentication parameter specifies whether Digest authentication is enabled on the virtual directory.

  Supported values:

  • true
  • false
• dsc_domaincontroller

  DomainController - The DomainController parameter specifies the domain controller that’s used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

• dsc_extendedprotectionflags

  ExtendedProtectionFlags - Specifies custom settings for Extended Protection for Authentication on the virtual directory. Valid values are None, Proxy, NoServiceNameCheck, AllowDotlessSpn, ProxyCohosting.

• dsc_extendedprotectionspnlist

  ExtendedProtectionSPNList - Specifies a list of valid Service Principal Names (SPNs) if you’re using Extended Protection for Authentication on the virtual directory.

• dsc_extendedprotectiontokenchecking

  ExtendedProtectionTokenChecking - Defines how you want to use Extended Protection for Authentication on the virtual directory. Valid values are None, Allow, Require.

• dsc_externalauthenticationmethods

  ExternalAuthenticationMethods - The ExternalAuthenticationMethods parameter specifies the authentication methods supported on the Exchange server from outside the firewall.

• dsc_externalurl

  ExternalUrl - The ExternalURL parameter specifies the URL that’s used to connect to the virtual directory from outside the firewall.

• dsc_formsauthentication

  FormsAuthentication - The FormsAuthentication parameter specifies whether forms-based authentication is enabled on the ECP virtual directory.

  Supported values:

  • true
  • false
• dsc_gziplevel

  GzipLevel - The GzipLevel parameter sets Gzip configuration information for the ECP virtual directory. Valid values are Off, Low, High, Error.

• dsc_identity

  Identity - The Identity of the ECP Virtual Directory.

• dsc_internalurl

  InternalUrl - The InternalURL parameter specifies the URL that’s used to connect to the virtual directory from inside the firewall.

• dsc_owaoptionsenabled

  OwaOptionsEnabled - Specifies that Outlook on the web Options is enabled for end users.

  Supported values:

  • true
  • false
• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_windowsauthentication

  WindowsAuthentication - The WindowsAuthentication parameter specifies whether Integrated Windows authentication is enabled on the virtual directory.

  Supported values:

  • true
  • false
• name (namevar)
• provider

  The specific backend to use for this ‘dsc_xexchecpvirtualdirectory` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.