Commands › Exchange Online

New-EdgeSyncServiceConfig

Exchange Online ExchangeOnlineManagement New-*

Create edge synchronization service settings that control the general synchronization behavior shared by all EdgeSync services.

Quick start script

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

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

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

Syntax

New-EdgeSyncServiceConfig [-ConfigurationSyncInterval <EnhancedTimeSpan>]
 [-Confirm]
 [-CookieValidDuration <EnhancedTimeSpan>]
 [-DomainController <Fqdn>]
 [-FailoverDCInterval <EnhancedTimeSpan>]
 [-LockDuration <EnhancedTimeSpan>]
 [-LockRenewalDuration <EnhancedTimeSpan>]
 [-LogEnabled <Boolean>]
 [-LogLevel <EdgeSyncLoggingLevel>]
 [-LogMaxAge <EnhancedTimeSpan>]
 [-LogMaxDirectorySize <Unlimited>]
 [-LogMaxFileSize <Unlimited>]
 [-LogPath <String>]
 [-OptionDuration <EnhancedTimeSpan>]
 [-RecipientSyncInterval <EnhancedTimeSpan>]
 [-Site <AdSiteIdParameter>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (17)

ParameterTypeRequiredWhat it controls
-ConfigurationSyncInterval EnhancedTimeSpan The ConfigurationSyncInterval parameter specifies how frequently the EdgeSync service synchronizes configuration data. The default value is 3 minutes.
-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.
-CookieValidDuration EnhancedTimeSpan The CookieValidDuration parameter specifies how long a cookie record is valid. The default value is 21 days.
-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...
-FailoverDCInterval EnhancedTimeSpan The FailoverDCInterval parameter specifies how long EdgeSync waits before failing over to another domain controller if it can't read configuration data from Active Directory. The default value is 5 minutes.
-LockDuration EnhancedTimeSpan The LockDuration parameter specifies how long an instance of the EdgeSync service can maintain an exclusive lock on the synchronization rights. While an EdgeSync service maintains an exclusive lock on synchronization...
-LockRenewalDuration EnhancedTimeSpan The LockRenewalDuration parameter specifies how long before the expiry of an exclusive lock an EdgeSync service can renew the lock. The default value is 4 minutes.
-LogEnabled Boolean The LogEnabled parameter enables or disables the EdgeSync log. Valid input for this parameter is $true or $false. The default value is $true.
-LogLevel EdgeSyncLoggingLevel The LogLevel parameter specifies the EdgeSync logging level. Valid values are:
-LogMaxAge EnhancedTimeSpan The LogMaxAge parameter specifies the maximum duration in days to keep the EdgeSyncLog files. Log files older than the specified value can be overwritten. The default value is 30 days.
-LogMaxDirectorySize Unlimited The LogMaxDirectorySize parameter specifies the maximum amount of disk space the EdgeSyncLog directory can use. The default value is 250 MB.
-LogMaxFileSize Unlimited The LogMaxFileSize parameter specifies the maximum log file size for the EdgeSyncLog files. The default value is 10 MB.
-LogPath String The LogPath parameter specifies the default location for the EdgeSyncLog files. The default value is TransportRoles\\Logs\\EdgeSync\\.
-OptionDuration EnhancedTimeSpan The OptionDuration parameter specifies how long an instance of the EdgeSync service can maintain an optional lock on synchronization rights. While an EdgeSync service maintains an optional lock on synchronization...
-RecipientSyncInterval EnhancedTimeSpan The RecipientSyncInterval parameter specifies how frequently the EdgeSync service synchronizes recipient data from the global catalog. The default value is 5 minutes.
-Site AdSiteIdParameter The Site parameter specifies the Active Directory site that EdgeSync connects to for synchronizing configuration and recipient data.
-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.