Commands › Exchange Online

New-UMIPGateway

Exchange Online ExchangeOnlineManagement New-*

Create a Unified Messaging (UM) IP gateway. A UM IP gateway is used to connect Unified Messaging servers to an IP gateway or a Session Initiation Protocol (SIP)-enabled IP Private Branch eXchange (PBX).

Quick start script

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

# 3. Make the change (dry run first)
New-UMIPGateway -Name <String> -Address <UMSmartHost> -WhatIf
New-UMIPGateway -Name <String> -Address <UMSmartHost>

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

Syntax

New-UMIPGateway [-Name] <String> -Address <UMSmartHost>
 [-Confirm]
 [-DomainController <Fqdn>]
 [-IPAddressFamily <IPAddressFamily>]
 [-UMDialPlan <UMDialPlanIdParameter>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (7)

Parameter	Type	Required	What it controls
-Name	String	yes	The Name parameter specifies the display name for the UM IP gateway. The name for the new UM IP gateway can contain up to 64 characters.
-Address	UMSmartHost	yes	The Address parameter specifies the IP address configured on the IP gateway or SIP-enabled IP PBX.
-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		This parameter is available only in on-premises Exchange.
-IPAddressFamily	IPAddressFamily		The IPAddressFamily parameter specifies the Internet Protocol (IP) version to use. Valid values are:
-UMDialPlan	UMDialPlanIdParameter		The UMDialPlan parameter specifies the UM dial plan to be associated with the UM IP gateway.
-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.