Commands › Exchange Online
Set-ADSite
Configure the Exchange settings of Active Directory sites.
Quick start script
# Set-ADSite — 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-ADSite
$before | Format-List
# 3. Make the change (dry run first)
Set-ADSite -Identity <AdSiteIdParameter> -WhatIf
Set-ADSite -Identity <AdSiteIdParameter>
# 4. Verify and diff
$after = Get-ADSite
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
Set-ADSite [-Identity] <AdSiteIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-HubSiteEnabled <Boolean>]
[-InboundMailEnabled <Boolean>]
[-PartnerId <Int32>]
[-WhatIf]
[<CommonParameters>]Parameters (7)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Identity | AdSiteIdParameter | yes | The Identity parameter specifies the identity of the Active Directory site you want to modify. You can use any value that uniquely identifies the site. For example, you can use the name, GUID or distinguished name... |
| -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... | |
| -HubSiteEnabled | Boolean | The HubSiteEnabled parameter specifies whether this site acts as a hub site. The default value is $false. | |
| -InboundMailEnabled | Boolean | The InboundMailEnabled parameter enables or disables receiving incoming messages for all Exchange servers located in the Active Directory site. Typically, you use this parameter after Active Directory site failover... | |
| -PartnerId | Int32 | This parameter is reserved for internal Microsoft use. | |
| -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.