EXOIntraOrganizationConnector

Parameters

Parameter Attribute DataType Description Allowed Values
Identity Key String The Identity parameter specifies the intraorg connector that you want to modify.
DiscoveryEndpoint Write String The DiscoveryEndpoint parameter specifies the externally-accessible URL that's used for the Autodiscover service for the domain that's configured in the Intra-Organization connector.
Enabled Write Boolean Specifies whether connector is enabled.
TargetAddressDomains Write StringArray[] The TargetAddressDomains parameter specifies the domain namespaces that will be used in the Intra-organization connector. These domains must have valid Autodiscover endpoints defined in their organizations. The domains and their associated Autodiscover endpoints are used by the Intra-Organization connector for feature and service connectivity. You can specify multiple domains separated by commas.
TargetSharingEpr Write String The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services that will be used in the Intra-Organization connector.
Ensure Write String Specifies if this Intra-Organization connector should exist. Present, Absent
Credential Write PSCredential Credentials of the Exchange Global Admin
ApplicationId Write String Id of the Azure Active Directory application to authenticate with.
TenantId Write String Id of the Azure Active Directory tenant used for authentication.
CertificateThumbprint Write String Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication.
CertificatePassword Write PSCredential Username can be made up to anything but password will be used for CertificatePassword
CertificatePath Write String Path to certificate used in service principal usually a PFX file.
ManagedIdentity Write Boolean Managed ID being used for authentication.
AccessTokens Write StringArray[] Access token used for authentication.

Description

Create a new EXOIntraOrganizationConnector in your cloud-based organization.

Permissions

Exchange

To authenticate with Microsoft Exchange, this resource required the following permissions:

Roles

  • Federated Sharing, Organization Transport Settings, View-Only Configuration, Mail Tips, Message Tracking

Role Groups

  • Organization Management

Examples

Example 1

This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $Credscredential
    )
    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        EXOIntraOrganizationConnector 'ConfigureIntraOrganizationConnector'
        {
            Identity             = "MainCloudConnector"
            DiscoveryEndpoint    = "https://ExternalDiscovery.Contoso.com/"
            TargetAddressDomains = "Cloud1.contoso.com","Cloud2.contoso.com"
            Enabled              = $True
            Ensure               = "Present"
            Credential           = $Credscredential
        }
    }
}

Example 2

This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $Credscredential
    )
    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        EXOIntraOrganizationConnector 'ConfigureIntraOrganizationConnector'
        {
            Identity             = "MainCloudConnector"
            DiscoveryEndpoint    = "https://ExternalDiscovery.Contoso.com/"
            TargetAddressDomains = "Cloud1.contoso.com","Cloud2.contoso.com"
            Enabled              = $False # Updated Property
            Ensure               = "Present"
            Credential           = $Credscredential
        }
    }
}

Example 3

This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $Credscredential
    )
    Import-DscResource -ModuleName Microsoft365DSC

    node localhost
    {
        EXOIntraOrganizationConnector 'ConfigureIntraOrganizationConnector'
        {
            Identity             = "MainCloudConnector"
            Ensure               = "Absent"
            Credential           = $Credscredential
        }
    }
}