Commands › Exchange Online

Set-DeliveryAgentConnector

Exchange Online ExchangeOnlineManagement Set-*

Configure a specific delivery agent connector in your organization.

Quick start script

# Set-DeliveryAgentConnector — 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-DeliveryAgentConnector
$before | Format-List

# 3. Make the change (dry run first)
Set-DeliveryAgentConnector -Identity <DeliveryAgentConnectorIdParameter> -WhatIf
Set-DeliveryAgentConnector -Identity <DeliveryAgentConnectorIdParameter>

# 4. Verify and diff
$after = Get-DeliveryAgentConnector
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-DeliveryAgentConnector [-Identity] <DeliveryAgentConnectorIdParameter>
 [-AddressSpaces <MultiValuedProperty>]
 [-Comment <String>]
 [-Confirm]
 [-DeliveryProtocol <String>]
 [-DomainController <Fqdn>]
 [-Enabled <Boolean>]
 [-Force]
 [-IsScopedConnector <Boolean>]
 [-MaxConcurrentConnections <Int32>]
 [-MaxMessageSize <Unlimited>]
 [-MaxMessagesPerConnection <Int32>]
 [-Name <String>]
 [-SourceTransportServers <MultiValuedProperty>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (15)

ParameterTypeRequiredWhat it controls
-Identity DeliveryAgentConnectorIdParameter yes The Identity parameter specifies the GUID or name of the delivery agent connector.
-AddressSpaces MultiValuedProperty The AddressSpaces parameter specifies the domain names that the delivery agent connector is responsible for. The complete syntax for entering an 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.
-DeliveryProtocol String The DeliveryProtocol parameter specifies the communication protocol that determines which delivery agents are responsible for servicing the connector.
-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...
-Enabled Boolean The Enabled parameter specifies whether the delivery agent connector is enabled.
-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. If the value of this parameter is $false, the connector can be used by all Mailbox servers in your organization....
-MaxConcurrentConnections Int32 The MaxConcurrentConnections parameter specifies the maximum number of concurrent connections this connector accepts from a specific IP address.
-MaxMessageSize Unlimited The MaxMessageSize parameter specifies the maximum size of a message that's allowed to pass through this connector. When you enter a value, qualify the value with one of the following units:
-MaxMessagesPerConnection Int32 The MaxMessagesPerConnection parameter specifies the maximum number of messages this connector accepts per connection. The connector terminates the connection after this limit is reached and the sending server has to...
-Name String The Name parameter specifies the name of this delivery agent connector. The value for the Name parameter can't exceed 64 characters.
-SourceTransportServers MultiValuedProperty The SourceTransportServers parameter specifies the list of Mailbox servers that host this connector. You can specify more than one server by separating their names with commas.
-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.