Commands › Exchange Online
New-UMDialPlan
Create a Unified Messaging (UM) dial plan to establish a link between UM IP gateways, UM hunt groups, and Mailbox servers to enable communication between Unified Messaging components.
Quick start script
# New-UMDialPlan — 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-UMDialPlan
$before | Format-List
# 3. Make the change (dry run first)
New-UMDialPlan -Name <String> -CountryOrRegionCode <String> -NumberOfDigitsInExtension <Int32> -WhatIf
New-UMDialPlan -Name <String> -CountryOrRegionCode <String> -NumberOfDigitsInExtension <Int32>
# 4. Verify and diff
$after = Get-UMDialPlan
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
New-UMDialPlan [-Name] <String> -CountryOrRegionCode <String> -NumberOfDigitsInExtension <Int32>
[-AccessTelephoneNumbers <MultiValuedProperty>]
[-Confirm]
[-DefaultLanguage <UMLanguage>]
[-DomainController <Fqdn>]
[-FaxEnabled <Boolean>]
[-GenerateUMMailboxPolicy <Boolean>]
[-URIType <UMURIType>]
[-VoIPSecurity <UMVoIPSecurityType>]
[-WhatIf]
[<CommonParameters>]Parameters (12)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Name | String | yes | The Name parameter specifies the display name of the UM dial plan. This description is presented to the administrator when a user is enabled for Unified Messaging. The UM dial plan name field can contain as many as... |
| -CountryOrRegionCode | String | yes | The CountryOrRegionCode parameter specifies the country or region code that precedes a telephone number used to place calls from other countries or regions to the country or region in which the UM dial plan is... |
| -NumberOfDigitsInExtension | Int32 | yes | The NumberOfDigitsInExtension parameter specifies the fixed number of digits in an extension number. The range for this parameter is from 1 through 20 digits. |
| -AccessTelephoneNumbers | MultiValuedProperty | The AccessTelephoneNumbers parameter specifies the telephone number or numbers used for subscriber access. These numbers are sometimes referred to as pilot or pilot ID numbers. The telephone number is limited to 32... | |
| -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. | |
| -DefaultLanguage | UMLanguage | The DefaultLanguage parameter specifies the default language of the system. This default language is selected from the list of available languages. If there are no other UM language packs installed, the default value... | |
| -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... | |
| -FaxEnabled | Boolean | The FaxEnabled parameter specifies whether the Mailbox servers associated with the dial plan answer and process incoming fax calls. The default is $true. | |
| -GenerateUMMailboxPolicy | Boolean | The GenerateUMMailboxPolicy parameter specifies whether a default UM mailbox policy is created when the UM dial plan is created. The default setting is to create a UM mailbox when the UM dial plan is created. | |
| -URIType | UMURIType | The URIType parameter specifies the URI type to be sent and received with SIP messages from the Private Branch eXchange (PBX). | |
| -VoIPSecurity | UMVoIPSecurityType | The VoIPSecurity parameter specifies whether the signaling channel is encrypted using mutual Transport Layer Security (TLS). The default setting is Unsecured. | |
| -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.