Commands › Exchange Online

Set-ClientAccessArray

Exchange Online ExchangeOnlineManagement Set-*

Modify RPC Client Access arrays (load-balanced arrays of Client Access servers within a single Active Directory site).

Quick start script

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

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

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

Syntax

Set-ClientAccessArray [-Identity] <ClientAccessArrayIdParameter>
 [-Confirm]
 [-DomainController <Fqdn>]
 [-Fqdn <Fqdn>]
 [-Name <String>]
 [-Site <AdSiteIdParameter>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (7)

Parameter	Type	Required	What it controls
-Identity	ClientAccessArrayIdParameter	yes	The Identity parameter specifies the Client Access array that you want to modify. You can use these values:
-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...
-Fqdn	Fqdn		The Fqdn parameter specifies the fully qualified domain name of the Client Access array (for example, casarray01.contoso.com). This is the value that RPC over TCP clients use to connect to the Client Access servers...
-Name	String		The Name parameter specifies the descriptive name of the Client Access array. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). If the value contains spaces,...
-Site	AdSiteIdParameter		The Site parameter specifies the Active Directory site that contains the Client Access array. You can use any value that uniquely identifies the site. For example:
-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.