Set-OrganizationRelationship

 

Applies to: Exchange Online, Exchange Server 2016

Topic Last Modified: 2017-10-31

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-OrganizationRelationship cmdlet to modify existing organization relationships. Organization relationships define the settings that are used with external Exchange organizations to access calendar free/busy information or to move mailboxes between on-premises Exchange servers and Exchange Online as part of hybrid deployments.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-OrganizationRelationship -Identity <OrganizationRelationshipIdParameter> [-ArchiveAccessEnabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-DeliveryReportEnabled <$true | $false>] [-DomainController <Fqdn>] [-DomainNames <MultiValuedProperty>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-FreeBusyAccessEnabled <$true | $false>] [-FreeBusyAccessLevel <None | AvailabilityOnly | LimitedDetails>] [-FreeBusyAccessScope <GroupIdParameter>] [-MailboxMoveDirection <None | Inbound | Outbound>] [-MailboxMoveEnabled <$true | $false>] [-MailTipsAccessEnabled <$true | $false>] [-MailTipsAccessLevel <None | Limited | All>] [-MailTipsAccessScope <GroupIdParameter>] [-Name <String>] [-OrganizationContact <SmtpAddress>] [-PhotosEnabled <$true | $false>] [-TargetApplicationUri <Uri>] [-TargetAutodiscoverEpr <Uri>] [-TargetOwaURL <Uri>] [-TargetSharingEpr <Uri>] [-WhatIf [<SwitchParameter>]]

This example modifies the free/busy access level to LimitedDetails, which includes time, subject, and location.

Set-OrganizationRelationship -Identity "Fourth Coffee" -FreeBusyAccessLevel LimitedDetails

This example disables the organization relationship with Contoso

Set-OrganizationRelationship -Identity "Contoso" -Enabled $false

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Organization relationships" entry in the Recipients Permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.OrganizationRelationshipIdParameter

The Identity parameter specifies the organization relationship that you want to modify. You can use any value that uniquely identifies the organization relationship. For example:

  • Name

  • Canonical name

  • GUID

ArchiveAccessEnabled

Optional

System.Boolean

The ArchiveAccessEnabled parameter specifies whether the organization relationship has been configured to provide remote archive access. Valid values are:

  • $true   The external organization provides remote access to mailbox archives.

  • $false   The external organization doesn't provide remote access to mailbox archives. This is the default value

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DeliveryReportEnabled

Optional

System.Boolean

The DeliveryReportEnabled parameter specifies whether Delivery Reports should be shared over the organization relationship. Valid values are:

  • $true   Delivery Reports should be shared over the organization relationship. This value means:

    • The organization has agreed to share all Delivery Reports with the external organization.

    • The organization relationship should be used to retrieve Delivery Report information from the external organization.

  • $false   Delivery Reports shouldn't be shared over the organization relationship. This is the default value

For message tracking to work in a cross-premises Exchange scenario, this parameter must be set to $true on both sides of the organization relationship. If the value of this parameter is set to $false on one or both sides of the organization relationship, message tracking between the organizations won't work in either direction.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

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.

DomainNames

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The DomainNames parameter specifies the SMTP domains of the external organization. You can specify multiple domains separated by commas (for example, "contoso.com","northamerica.contoso.com").

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether to enable the organization relationship. Valid values are:

  • $true   The organization relationship is enabled. This is the default value.

  • $false   The organization relationship is disabled. This value completely stops sharing for the organization relationship.

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch.

FreeBusyAccessEnabled

Optional

System.Boolean

The FreeBusyAccessEnabled parameter specifies whether the organization relationship should be used to retrieve free/busy information from the external organization. Valid values are:

  • $true   Free/busy information is retrieved from the external organization.

  • $false   Free/busy information isn't retrieved from the external organization. This is the default value.

You control the free/busy access level and scope by using the FreeBusyAccessLevel and FreeBusyAccessScope parameters.

FreeBusyAccessLevel

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.FreeBusyAccessLevel

The FreeBusyAccessLevel parameter specifies the maximum amount of detail returned to the requesting organization. Valid values are:

  • None   No free/busy access.

  • AvailabilityOnly   Free/busy access with time only.

  • LimitedDetails   Free/busy access with time, subject, and location.

This parameter is only meaningful when the FreeBusyAccessEnabled parameter value is $true.

FreeBusyAccessScope

Optional

Microsoft.Exchange.Configuration.Tasks.GroupIdParameter

The FreeBusyAccessScope parameter specifies a mail-enabled security group in the internal organization that contains users whose free/busy information is accessible by an external organization. You can use any value that uniquely identifies the group.

For example:

  • Name

  • Display name

  • Distinguished name (DN)

  • Canonical DN

  • GUID

This parameter is only meaningful when the FreeBusyAccessEnabled parameter value is $true.

MailboxMoveDirection

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MailboxMoveDirection

This parameter is reserved for internal Microsoft use.

MailboxMoveEnabled

Optional

System.Boolean

The MailboxMoveEnabled parameter specifies whether the organization relationship enables moving mailboxes to or from the external organization. Valid values are:

  • $true   Mailbox moves to or from the external organization are allowed.

  • $false   Mailbox moves to from the external organization aren't allowed. This is the default value.

MailTipsAccessEnabled

Optional

System.Boolean

The MailTipsAccessEnabled parameter specifies whether MailTips for users in this organization are returned over this organization relationship. Valid values are:

  • $true   MailTips for users in this organization are returned over the organization relationship.

  • $false   MailTips for users in this organization aren't returned over the organization relationship. This is the default value.

You control the MailTips access level by using the MailTipsAccessLevel parameter.

MailTipsAccessLevel

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MailTipsAccessLevel

The MailTipsAccessLevel parameter specifies the level of MailTips data externally shared over this organization relationship. This parameter can have the following values:

  • All   All MailTips are returned, but the recipients in the remote organization are considered external. For the Auto Reply MailTip, the external Auto Reply message is returned.

  • Limited   Only those MailTips that could prevent a non-delivery report (NDR) or an Auto Reply are returned. Custom MailTips, the Large Audience MailTip, and Moderated Recipient MailTips won't be returned.

  • None   No MailTips are returned to the remote organization. This is the default value.

This parameter is only meaningful when the MailTipsAccessEnabled parameter value is $true.

MailTipsAccessScope

Optional

Microsoft.Exchange.Configuration.Tasks.GroupIdParameter

The MailTipsAccessScope parameter specifies a mail-enabled security group in the internal organization that contains users whose free/busy information is accessible by an external organization. You can use any value that uniquely identifies the group.

For example:

  • Name

  • Display name

  • Distinguished name (DN)

  • Canonical DN

  • GUID

The default value is blank ($null), which means no group is specified.

If you use this parameter, recipient-specific MailTips are returned only for those recipients that are members of the specified group. The recipient-specific MailTips are:

  • Auto Reply

  • Mailbox Full

  • Custom

If you don't use this parameter, recipient-specific MailTips are returned for all recipients in the organization.

This restriction only applies to mailboxes, mail users, and mail contacts. It doesn't apply to distribution groups.

Name

Optional

System.String

The Name parameter specifies the unique name of the organization relationship. The maximum length is 64 characters.

OrganizationContact

Optional

Microsoft.Exchange.Data.SmtpAddress

The OrganizationContact parameter specifies the email address that can be used to contact the external organization (for example, administrator@fourthcoffee.com).

PhotosEnabled

Optional

System.Boolean

The PhotosEnabled parameter specifies whether photos for users in the internal organization are returned over the organization relationship. Valid values are:

  • $true   Photos for users in this organization are returned over the organization relationship.

  • $false   Photos for users in this organization aren't returned over the organization relationship. This is the default value.

TargetApplicationUri

Optional

System.Uri

The TargetApplicationUri parameter specifies the target Uniform Resource Identifier (URI) of the external organization. The TargetApplicationUri parameter is specified by Exchange when requesting a delegated token to retrieve free and busy information, for example, mail.contoso.com.

TargetAutodiscoverEpr

Optional

System.Uri

The TargetAutodiscoverEpr parameter specifies the Autodiscover URL of Exchange Web Services for the external organization, for example, https://contoso.com/autodiscover/autodiscover.svc/wssecurity. Exchange uses Autodiscover to automatically detect the correct Exchangeserver endpoint to use for external requests.

TargetOwaURL

Optional

System.Uri

The TargetOwaURL parameter specifies the Outlook on the web (formerly Outlook Web App) URL of the external organization that's defined in the organization relationship. It is used for Outlook on the web redirection in a cross-premise Exchange scenario. Configuring this attribute enables users in the organization to use their current Outlook on the web URL to access Outlook on the web in the external organization.

TargetSharingEpr

Optional

System.Uri

The TargetSharingEpr parameter specifies the URL of the target Exchange Web Services for the external organization.

If you use this parameter, this URL is always used to reach the external Exchange server. TheURL that's specified by the TargetAutoDiscoverEpr parameter isn't used to locate the external Exchange server.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show: