Commands › Exchange Online

New-EdgeSubscription

Exchange Online ExchangeOnlineManagement New-*

Export an Edge Subscription file from an Edge Transport server and to import the Edge Subscription file to a Mailbox server.

Quick start script

# New-EdgeSubscription — 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-EdgeSubscription
$before | Format-List

# 3. Make the change (dry run first)
New-EdgeSubscription  -WhatIf
New-EdgeSubscription

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

Syntax

New-EdgeSubscription [-AccountExpiryDuration <TimeSpan>]
 [-Confirm]
 [-CreateInboundSendConnector <Boolean>]
 [-CreateInternetSendConnector <Boolean>]
 [-DomainController <Fqdn>]
 [-FileData <Byte[]>]
 [-FileName <LongPath>]
 [-Force]
 [-Site <AdSiteIdParameter>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (10)

ParameterTypeRequiredWhat it controls
-AccountExpiryDuration TimeSpan The AccountExpiryDuration parameter specifies how soon the EdgeSync bootstrap replication account (ESBRA) created by this command expires.
-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.
-CreateInboundSendConnector Boolean The CreateInboundSendConnector parameter specifies whether to create the Send connector to connect the Edge Transport server and the Hub Transport servers. The default value is $true. The Send connector address space...
-CreateInternetSendConnector Boolean The CreateInternetSendConnector parameter specifies whether to create the Send connector to connect to the Internet. The default value is $true. The Send connector address space is set to all domains (\*), the Edge...
-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...
-FileData Byte[] The FileData parameter specifies the byte-encoded data object that contains the Edge Subscription file information.
-FileName LongPath The FileName parameter specifies the full path of the Edge Subscription file.
-Force SwitchParameter The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch.
-Site AdSiteIdParameter The Site parameter specifies the name of the Active Directory site that contains the Mailbox servers with which the Edge Transport servers are associated. This parameter is used and required only when you run the...
-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.