Commands › Exchange Online

Set-TransportAgent

Exchange Online ExchangeOnlineManagement Set-*

Modify existing transport agents.

Quick start script

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

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

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

Syntax

Set-TransportAgent [-Identity] <TransportAgentObjectId>
 [-Confirm]
 [-DomainController <Fqdn>]
 [-Priority <Int32>]
 [-TransportService <TransportService>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (6)

Parameter	Type	Required	What it controls
-Identity	TransportAgentObjectId	yes	The Identity parameter specifies the name (Identity property value) of the transport agent that you want to modify. If the name contains spaces, enclose the name in quotation marks (").
-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...
-Priority	Int32		The Priority parameter specifies the priority of the transport agent. The priority of the transport agent controls the order in which the transport agents process email messages. The priority must be a value between...
-TransportService	TransportService		The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are:
-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.