Resource Type: dsc_exoclientaccessrule

Defined in:

lib/puppet/type/dsc_exoclientaccessrule.rb

Overview

The DSC EXOClientAccessRule resource type. Automatically generated from version 1.21.1222.1

Properties

• dsc_action

  The Action parameter specifies the action for the client access rule. Valid values for this parameter are AllowAccess and DenyAccess.

• dsc_anyofauthenticationtypes

  The AnyOfAuthenticationTypes parameter specifies a condition for the client access rule that is based on the client’s authentication type. Valid values for this parameter are AdfsAuthentication, BasicAuthentication, CertificateBasedAuthentication, NonBasicAuthentication, OAuthAuthentication.

• dsc_anyofclientipaddressesorranges

  The AnyOfClientIPAddressesOrRanges parameter specifies a condition for the client access rule that is based on the client’s IP address. Valid values for this parameter are: A single IP address, an IP address range, a CIDR IP.

• dsc_anyofprotocols

  The AnyOfProtocols parameter specifies a condition for the client access rule that is based on the client’s protocol. Valid values for this parameter are ExchangeActiveSync,ExchangeAdminCenter,ExchangeWebServices,IMAP4,OfflineAddressBook,OutlookAnywhere,OutlookWebApp,POP3,PowerShellWebServices,RemotePowerShell,REST,UniversalOutlook.

• 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_enabled

  The Enabled parameter specifies whether the client access rule is enabled or disabled. Default is $true.

• dsc_ensure

  Specifies if this Client Access Rule should exist.

• dsc_exceptanyofauthenticationtypes

  The ExceptAnyOfAuthenticationTypes parameter specifies an exception for the client access rule that is based on the client’s authentication type. Valid values for this parameter are AdfsAuthentication, BasicAuthentication, CertificateBasedAuthentication, NonBasicAuthentication, OAuthAuthentication.

• dsc_exceptanyofclientipaddressesorranges

  The ExceptAnyOfClientIPAddressesOrRanges parameter specifies an exception for the client access rule that is based on the client’s IP address. Valid values for this parameter are: A single IP address, an IP address range, a CIDR IP.

• dsc_exceptanyofprotocols

  The ExceptAnyOfProtocols parameter specifies an exception for the client access rule that is based on the client’s protocol. Valid values for this parameter are ExchangeActiveSync,ExchangeAdminCenter,ExchangeWebServices,IMAP4,OfflineAddressBook,OutlookAnywhere,OutlookWebApp,POP3,PowerShellWebServices,RemotePowerShell,REST,UniversalOutlook.

• dsc_exceptusernamematchesanyofpatterns

  The ExceptUsernameMatchesAnyOfPatterns parameter specifies an exception for the client access rule that is based on the user’s account name.

• dsc_priority

  The Priority parameter specifies a priority value for the client access rule. A lower integer value indicates a higher priority, and a higher priority rule is evaluated before a lower priority rule. The default value is 1.

• dsc_rulescope

  The RuleScope parameter specifies the scope of the client access rule. Valid values are All and Users

• dsc_tenantid

  Id of the Azure Active Directory tenant used for authentication.

• dsc_usernamematchesanyofpatterns

  The UsernameMatchesAnyOfPatterns parameter specifies a condition for the client access rule that is based on the user’s account name.

• dsc_userrecipientfilter

  The UserRecipientFilter parameter specifies a condition for the client access rule that uses OPath filter syntax to identify the user.

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 client access rule 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).