Commands › Exchange Online

Set-CmdletExtensionAgent

Exchange Online ExchangeOnlineManagement Set-*

Modify cmdlet extension agents. To enable or disable cmdlet extension agents, use the Enable-CmdletExtensionAgent and Disable-CmdletExtensionAgent cmdlets.

Quick start script

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

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

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

Syntax

Set-CmdletExtensionAgent [-Identity] <CmdletExtensionAgentIdParameter>
 [-Confirm]
 [-DomainController <Fqdn>]
 [-Name <String>]
 [-Priority <Byte>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (6)

Parameter	Type	Required	What it controls
-Identity	CmdletExtensionAgentIdParameter	yes	The Identity parameter specifies the cmdlet extension agent that you want to modify. You can use any value that uniquely identifies the agent. For example:
-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...
-Name	String		The Name parameter specifies the unique name of the cmdlet extension agent. The maximum length of the agent name is 64 characters. If the name contains spaces, enclose the name in quotation marks (").
-Priority	Byte		The Priority parameter specifies the priority of the cmdlet extension agent. Higher priority agents are applied before lower priority agents. A valid value is an integer from 0 to 255. Lower integer values indicate...
-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.