Resource Type: dsc_exooutboundconnector
- Defined in:
- lib/puppet/type/dsc_exooutboundconnector.rb
Overview
The DSC EXOOutboundConnector resource type. Automatically generated from version 1.21.1222.1
Properties
-
dsc_allaccepteddomains
The AllAcceptedDomains parameter specifies whether the Outbound connector is used in hybrid organizations where message recipients are in accepted domains of the cloud-based organization. Valid values are: $true | $false (default)
-
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_cloudservicesmailenabled
The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft Office 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers. DO NOT USE MANUALLY! Valid values are: $true | $false
-
dsc_comment
The Comment parameter specifies an optional comment.
-
dsc_connectorsource
The ConnectorSource parameter specifies how the connector is created. DO NOT CHANGE THIS! values are Default (the default) | Migrated | HybridWizard
-
dsc_connectortype
The ConnectorType parameter specifies a category for the domains that are serviced by the connector. Valid values are Partner and OnPremises
-
dsc_enabled
Specifies whether connector is enabled.
-
dsc_ensure
Specifies if this Outbound connector should exist.
-
dsc_istransportrulescoped
The IsTransportRuleScoped parameter specifies whether the Outbound connector is associated with a transport rule (also known as a mail flow rule). Valid values are: $true | $false
-
dsc_recipientdomains
The RecipientDomains parameter specifies the domain that the Outbound connector routes mail to. You can specify multiple domains separated by commas.
-
dsc_routeallmessagesviaonpremises
The RouteAllMessagesViaOnPremises parameter specifies that all messages serviced by this connector are first routed through the on-premises messaging system (Centralized mailrouting). Valid values are: $true | $false
-
dsc_smarthosts
The SmartHosts parameter specifies the smart hosts the Outbound connector uses to route mail. This parameter is required if you set the UseMxRecord parameter to $false and must be specified on the same command line.
-
dsc_tenantid
Id of the Azure Active Directory tenant used for authentication.
-
dsc_testmode
The TestMode parameter specifies whether you want to enabled or disable test mode for the Outbound connector. Valid values are: $true | $false (default)
-
dsc_tlsdomain
The TlsDomain parameter specifies the domain name that the Outbound connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. This parameter is only used if the TlsSettings parameter is set to DomainValidation. Valid input for the TlsDomain parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: *.contoso.com. However, you can’t embed a wildcard character, as shown in the following example: domain.*.contoso.com
-
dsc_tlssettings
The TlsSettings parameter specifies the TLS authentication level that’s used for outbound TLS connections established by this Outbound connector. Valid values are:EncryptionOnly | CertificateValidation | DomainValidation
-
dsc_usemxrecord
Specifies whether connector should use MXRecords for target resolution.
-
dsc_validationrecipients
The ValidationRecipients parameter specifies the email addresses of the validation recipients for the Outbound connector. You can specify multiple email addresses separated by commas.
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 outbound connector 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).