Commands › Exchange Online
Set-ForeignConnector
Modify an existing Foreign connector in the Transport service of a Mailbox server.
Quick start script
# Set-ForeignConnector — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org
# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-ForeignConnector
$before | Format-List
# 3. Make the change (dry run first)
Set-ForeignConnector -Identity <ForeignConnectorIdParameter> -WhatIf
Set-ForeignConnector -Identity <ForeignConnectorIdParameter>
# 4. Verify and diff
$after = Get-ForeignConnector
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
Set-ForeignConnector [-Identity] <ForeignConnectorIdParameter>
[-AddressSpaces <MultiValuedProperty>]
[-Comment <String>]
[-Confirm]
[-DomainController <Fqdn>]
[-DropDirectory <String>]
[-DropDirectoryQuota <Unlimited>]
[-Enabled <Boolean>]
[-Force]
[-IsScopedConnector <Boolean>]
[-MaxMessageSize <Unlimited>]
[-Name <String>]
[-RelayDsnRequired <Boolean>]
[-SourceTransportServers <MultiValuedProperty>]
[-WhatIf]
[<CommonParameters>]Parameters (15)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Identity | ForeignConnectorIdParameter | yes | The Identity parameter specifies the Foreign connector that you want to modify. The Identity parameter can take any of the following values for the Foreign connector object: |
| -AddressSpaces | MultiValuedProperty | The AddressSpaces parameter specifies the domain names to which the Foreign connector sends messages. The complete syntax for entering each address space is: `AddressSpaceType:AddressSpace;AddressSpaceCost`. | |
| -Comment | String | The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note". | |
| -Confirm | SwitchParameter | The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. | |
| -DomainController | Fqdn | 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... | |
| -DropDirectory | String | The DropDirectory parameter specifies the name of the Drop directory used by this Foreign connector. All outbound messages sent to address spaces defined by this Foreign connector are put in the specified Drop... | |
| -DropDirectoryQuota | Unlimited | The DropDirectoryQuota parameter specifies the maximum size of all message files in the Drop directory. When the specified value is reached, no new message files can be copied into the Drop directory until the... | |
| -Enabled | Boolean | The Enabled parameter specifies whether to enable the Foreign connector. The valid values are $true or $false. The default value is $true. | |
| -Force | SwitchParameter | The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch. | |
| -IsScopedConnector | Boolean | The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers. When the value of this parameter is $false, the connector can be used by all Mailbox servers in the Exchange... | |
| -MaxMessageSize | Unlimited | The MaxMessageSize parameter specifies the maximum size of a message that can pass through this Foreign connector. | |
| -Name | String | The Name parameter specifies a descriptive name for the Foreign connector. | |
| -RelayDsnRequired | Boolean | The RelayDsnRequired parameter specifies whether a Relay delivery status notification (DSN) is required by the Foreign connector when messages are written to the Drop directory. The valid input values for this... | |
| -SourceTransportServers | MultiValuedProperty | The SourceTransportServers parameter specifies the names of the Mailbox servers that use this Foreign connector. Having a single Foreign connector homed on multiple Mailbox servers running the Transport service... | |
| -WhatIf | SwitchParameter | The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch. |
Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.