Skip to content

Commit bbfcd06

Browse files
authored
Merge pull request #247750 from rcdun/number_management_portal_fixes
Fix Number Management Portal docs
2 parents 2458233 + 0cfea0c commit bbfcd06

File tree

6 files changed

+59
-46
lines changed

6 files changed

+59
-46
lines changed

articles/communications-gateway/connect-operator-connect.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: rcdun
55
ms.author: rdunstan
66
ms.service: communications-gateway
77
ms.topic: integration
8-
ms.date: 11/15/2023
8+
ms.date: 11/27/2023
99
ms.custom:
1010
- template-how-to-pattern
1111
- has-azure-ad-ps-ref
@@ -85,9 +85,9 @@ To add the Project Synergy application:
8585
1. Select **Properties**.
8686
1. Scroll down to the Tenant ID field. Your tenant ID is in the box. Make a note of your tenant ID.
8787
1. Open PowerShell.
88-
1. Run the following cmdlet, replacing *`<AADTenantID>`* with the tenant ID you noted down in step 5.
88+
1. Run the following cmdlet, replacing *`<TenantID>`* with the tenant ID you noted down in step 5.
8989
```azurepowershell
90-
Connect-AzureAD -TenantId "<AADTenantID>"
90+
Connect-AzureAD -TenantId "<TenantID>"
9191
New-AzureADServicePrincipal -AppId eb63d611-525e-4a31-abd7-0cb33f679599 -DisplayName "Operator Connect"
9292
```
9393
@@ -106,7 +106,7 @@ The user who sets up Azure Communications Gateway needs to have the Admin user r
106106
107107
## Find the Object ID and Application ID for your Azure Communication Gateway resource
108108
109-
Each Azure Communications Gateway resource automatically receives a [system-assigned managed identity](../active-directory/managed-identities-azure-resources/overview.md), which Azure Communications Gateway uses to connect to the Operator Connect environment. You need to find the Object ID and Application ID of the managed identity, so that you can connect Azure Communications Gateway to the Operator Connect or Teams Phone Mobile environment in [Set up application roles for Azure Communications Gateway](#set-up-application-roles-for-azure-communications-gateway) and [Add the Application ID for Azure Communications Gateway to Operator Connect](#add-the-application-id-for-azure-communications-gateway-to-operator-connect).
109+
Each Azure Communications Gateway resource automatically receives a [system-assigned managed identity](../active-directory/managed-identities-azure-resources/overview.md), which Azure Communications Gateway uses to connect to the Operator Connect environment. You need to find the Object ID and Application ID of the managed identity, so that you can connect Azure Communications Gateway to the Operator Connect or Teams Phone Mobile environment in [Set up application roles for Azure Communications Gateway](#set-up-application-roles-for-azure-communications-gateway) and [Add the Application IDs for Azure Communications Gateway to Operator Connect](#add-the-application-ids-for-azure-communications-gateway-to-operator-connect).
110110
111111
1. Sign in to the [Azure portal](https://azure.microsoft.com/).
112112
1. In the search bar at the top of the page, search for your Communications Gateway resource.
@@ -124,7 +124,7 @@ Each Azure Communications Gateway resource automatically receives a [system-assi
124124
Azure Communications Gateway contains services that need to access the Operator Connect API on your behalf. To enable this access, you must grant specific application roles to the system-assigned managed identity for Azure Communications Gateway under the Project Synergy Enterprise Application. You created the Project Synergy Enterprise Application in [Add the Project Synergy application to your Azure tenancy](#add-the-project-synergy-application-to-your-azure-tenancy).
125125
126126
> [!IMPORTANT]
127-
> Granting permissions has two parts: configuring the system-assigned managed identity for Azure Communications Gateway with the appropriate roles (this step) and adding the application ID of the managed identity to the Operator Connect or Teams Phone Mobile environment. You'll add the application ID to the Operator Connect or Teams Phone Mobile environment later, in [Add the Application ID for Azure Communications Gateway to Operator Connect](#add-the-application-id-for-azure-communications-gateway-to-operator-connect).
127+
> Granting permissions has two parts: configuring the system-assigned managed identity for Azure Communications Gateway with the appropriate roles (this step) and adding the application ID of the managed identity to the Operator Connect or Teams Phone Mobile environment. You'll add the application ID to the Operator Connect or Teams Phone Mobile environment later, in [Add the Application IDs for Azure Communications Gateway to Operator Connect](#add-the-application-ids-for-azure-communications-gateway-to-operator-connect).
128128
129129
Do the following steps in the tenant that contains your Project Synergy application.
130130
@@ -147,9 +147,9 @@ Do the following steps in the tenant that contains your Project Synergy applicat
147147
1. Select **Properties**.
148148
1. Scroll down to the Tenant ID field. Your tenant ID is in the box. Make a note of your tenant ID.
149149
1. Open PowerShell.
150-
1. Run the following cmdlet, replacing *`<AADTenantID>`* with the tenant ID you noted down in step 5.
150+
1. Run the following cmdlet, replacing *`<TenantID>`* with the tenant ID you noted down in step 5.
151151
```azurepowershell
152-
Connect-AzureAD -TenantId "<AADTenantID>"
152+
Connect-AzureAD -TenantId "<TenantID>"
153153
```
154154
1. Run the following cmdlet, replacing *`<CommunicationsGatewayObjectID>`* with the Object ID you noted down in [Find the Object ID and Application ID for your Azure Communication Gateway resource](#find-the-object-id-and-application-id-for-your-azure-communication-gateway-resource).
155155
```azurepowershell
@@ -200,14 +200,17 @@ If you don't already have an onboarding team, contact azcog-enablement@microsoft
200200
201201
Go to the [Operator Connect homepage](https://operatorconnect.microsoft.com/) and check that you're able to sign in.
202202
203-
## Add the Application ID for Azure Communications Gateway to Operator Connect
203+
## Add the Application IDs for Azure Communications Gateway to Operator Connect
204204
205-
You must enable the Azure Communications Gateway application within the Operator Connect or Teams Phone Mobile environment. Enabling the application allows Azure Communications Gateway to use the roles that you set up in [Set up application roles for Azure Communications Gateway](#set-up-application-roles-for-azure-communications-gateway).
205+
You must enable Azure Communications Gateway within the Operator Connect or Teams Phone Mobile environment. This process requires configuring your environment with two Application IDs:
206+
- The Application ID of the system-assigned managed identity that you found in [Find the Object ID and Application ID for your Azure Communication Gateway resource](#find-the-object-id-and-application-id-for-your-azure-communication-gateway-resource). This Application ID allows Azure Communications Gateway to use the roles that you set up in [Set up application roles for Azure Communications Gateway](#set-up-application-roles-for-azure-communications-gateway).
207+
- A standard Application ID for Azure Communications Gateway. This ID always has the value `8502a0ec-c76d-412f-836c-398018e2312b`.
206208
207-
To enable the application, add the Application ID of the system-assigned managed identity representing Azure Communications Gateway to your Operator Connect or Teams Phone Mobile environment. You found this ID in [Find the Object ID and Application ID for your Azure Communication Gateway resource](#find-the-object-id-and-application-id-for-your-azure-communication-gateway-resource).
209+
To add the Application IDs:
208210
209211
1. Log into the [Operator Connect portal](https://operatorconnect.microsoft.com/operator/configuration).
210-
1. Add a new **Application Id**, using the Application ID that you found.
212+
1. Add a new **Application Id** for the Application ID that you found for the managed identity.
213+
1. Add a second **Application Id** for the value `8502a0ec-c76d-412f-836c-398018e2312b`.
211214
212215
## Register your deployment's domain name in Microsoft Entra
213216

articles/communications-gateway/includes/communications-gateway-nmp-project-synergy-permissions.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

articles/communications-gateway/interoperability-operator-connect.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,6 @@ For full details of the media interworking features available in Azure Communica
9595

9696
Operator Connect and Teams Phone Mobile require API integration between your IT systems and Microsoft Teams for flow-through provisioning and automation. After your deployment has been certified and launched, you must not use the Operator Connect portal for provisioning. You can use Azure Communications Gateway's Number Management Portal instead. This Azure portal feature enables you to pass the certification process and sell Operator Connect or Teams Phone Mobile services while you carry out a custom API integration project.
9797

98-
The Number Management Portal is available as part of the optional API Bridge feature.
99-
10098
For more information, see [Manage an enterprise with Azure Communications Gateway's Number Management Portal for Operator Connect and Teams Phone Mobile](manage-enterprise-operator-connect.md).
10199

102100
> [!TIP]

articles/communications-gateway/manage-enterprise-operator-connect.md

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: rcdun
55
ms.author: rdunstan
66
ms.service: communications-gateway
77
ms.topic: how-to
8-
ms.date: 07/17/2023
8+
ms.date: 11/27/2023
99
ms.custom: template-how-to-pattern
1010
---
1111

@@ -15,23 +15,26 @@ Azure Communications Gateway's Number Management Portal enables you to manage en
1515

1616
The Operator Connect and Teams Phone Mobile programs don't allow you to use the Operator Connect portal for provisioning after you've launched your service in the Teams Admin Center. The Number Management Portal is a simple alternative that you can use until you've finished integrating with the Operator Connect APIs.
1717

18-
> [!IMPORTANT]
19-
> You must have selected Azure Communications Gateway's API Bridge option to use the Number Management Portal.
20-
2118
## Prerequisites
2219

23-
Confirm that you have [!INCLUDE [project-synergy-nmp-permissions](includes/communications-gateway-nmp-project-synergy-permissions.md)] permissions for the Project Synergy enterprise application and **Reader** access to your subscription. If you don't have these permissions, ask your administrator to set them up by following [Set up user roles for Azure Communications Gateway](provision-user-roles.md).
20+
Confirm that you have **Reader** access to your subscription and appropriate permissions for the Project Synergy enterprise application:
21+
22+
<!-- Must be kept in sync with provision-user-roles.md - steps for understanding and configuring -->
23+
* To view existing configuration: **PartnerSettings.Read**, **TrunkManagement.Read**, and **NumberManagement.Read**
24+
* To make changes to consents (which represent your relationships with enterprises) and numbers: **PartnerSettings.Read**, **TrunkManagement.Read**, and **NumberManagement.Write**
25+
26+
If you don't have these permissions, ask your administrator to set them up by following [Set up user roles for Azure Communications Gateway](provision-user-roles.md).
2427

25-
If you're assigning new numbers to an enterprise customer:
28+
If you're uploading new numbers for an enterprise customer:
2629

27-
* You must know the numbers you need to assign (as E.164 numbers). Each number must:
30+
* You must know the numbers you need to upload (as E.164 numbers). Each number must:
2831
* Contain only digits (0-9), with an optional `+` at the start.
2932
* Include the country code.
3033
* Be up to 19 characters long.
3134
* You must have completed any internal procedures for assigning numbers.
32-
* You need to know the following information for each range of numbers.
35+
* You must know the following information for each number.
3336

34-
|Information for each range of numbers |Notes |
37+
|Information for each number |Notes |
3538
|---------|---------|
3639
|Calling profile |One of the Calling Profiles created by Microsoft for you.|
3740
|Intended usage | Individuals (calling users), applications or conference calls.|
@@ -40,7 +43,19 @@ If you're assigning new numbers to an enterprise customer:
4043
|Location | A description of the location for emergency calls. The enterprise must have configured this location in the Teams Admin Center. Only required for individuals (calling users) and only if you don't allow the enterprise to update the address.|
4144
|Whether the enterprise can update the civic address or location | If you don't allow the enterprise to update the civic address or location, you must specify a civic address or location. You can specify an address or location and also allow the enterprise to update it.|
4245
|Country | The country for the number. Only required if you're uploading a North American Toll-Free number, otherwise optional.|
43-
|Ticket number (optional) |The ID of any ticket or other request that you want to associate with this range of numbers. Up to 64 characters. |
46+
|Ticket number (optional) |The ID of any ticket or other request that you want to associate with this number. Up to 64 characters. |
47+
48+
If you're uploading multiple numbers, prepare a `.csv` file with the heading `Numbers` and one number per line (up to 10,000 numbers), as in the following example. You can use this file to upload multiple numbers at once with the same settings (for example, the same calling profile).
49+
50+
```
51+
Numbers
52+
+441632960000
53+
+441632960001
54+
+441632960002
55+
+441632960003
56+
+441632960004
57+
```
58+
4459

4560
## Go to your Communications Gateway resource
4661

@@ -50,39 +65,41 @@ If you're assigning new numbers to an enterprise customer:
5065

5166
## Select an enterprise customer to manage
5267

53-
When an enterprise customer uses the Teams Admin Center to request service, the Operator Connect APIs create a **consent**. This consent represents the relationship between you and the enterprise.
68+
When an enterprise customer uses the Teams Admin Center to request service, the Operator Connect APIs create a *consent*. This consent represents the relationship between you and the enterprise.
5469

5570
The Number Management Portal allows you to update the status of these consents. Finding the consent for an enterprise is also the easiest way to manage numbers for an enterprise.
5671

57-
1. From the overview page for your Communications Gateway resource, select **Consents** in the sidebar.
72+
1. From the overview page for your Communications Gateway resource, find the **Number Management** section in the sidebar. Select **Consents**.
5873
1. Find the enterprise that you want to manage.
5974
1. If you need to change the status of the relationship, select **Update Relationship Status** from the menu for the enterprise. Set the new status. For example, if you're agreeing to provide service to a customer, set the status to **Agreement signed**. If you set the status to **Consent Declined** or **Contract Terminated**, you must provide a reason.
6075

6176
## Manage numbers for the enterprise
6277

63-
Assigning numbers to an enterprise allows IT administrators at the enterprise to allocate those numbers to their users.
78+
Uploading numbers for an enterprise allows IT administrators at the enterprise to allocate those numbers to their users.
6479

6580
1. Go to the number management page for the enterprise.
6681
* If you followed [Select an enterprise customer to manage](#select-an-enterprise-customer-to-manage), select **Manage numbers** from the menu.
67-
* Otherwise, select **Numbers** in the sidebar and search for the enterprise using the enterprise's Microsoft Entra tenant ID.
68-
1. To add new numbers for an enterprise:
82+
* Otherwise, find the **Number Management** section in the sidebar and select **Numbers**. Search for the enterprise using the enterprise's Microsoft Entra tenant ID.
83+
1. To upload new numbers for an enterprise:
6984
1. Select **Upload numbers**.
7085
1. Fill in the fields based on the information you determined in [Prerequisites](#prerequisites). These settings apply to all the numbers you upload in the **Telephone numbers** section.
71-
1. In **Telephone numbers**, upload the numbers, as a comma-separated list.
86+
1. In **Telephone numbers**, add the numbers:
87+
* If you created a `.csv` file with multiple numbers as described in [Prerequisites](#prerequisites), select **Upload CSV file** and upload the file when prompted.
88+
* Otherwise, select **Manual input** and add each number individually.
7289
1. Select **Review + upload** and **Upload**. Uploading creates an order for uploading numbers over the Operator Connect API.
7390
1. Wait 30 seconds, then refresh the order status. When the order status is **Complete**, the numbers are available to the enterprise. You might need to refresh more than once.
7491
1. To remove numbers from an enterprise:
7592
1. Select the numbers.
7693
1. Select **Release numbers**.
77-
1. 1. Wait 30 seconds, then refresh the order status. When the order status is **Complete**, the numbers have been removed.
94+
1. Wait 30 seconds, then refresh the order status. When the order status is **Complete**, the numbers have been removed.
7895

7996
## View civic addresses for an enterprise
8097

8198
You can view civic addresses for an enterprise. The enterprise configures the details of each civic address, so you can't configure these details.
8299

83100
1. Go to the civic address page for the enterprise.
84101
* If you followed [Select an enterprise customer to manage](#select-an-enterprise-customer-to-manage), select **Civic addresses** from the menu.
85-
* Otherwise, select **Civic addresses** in the sidebar and search for the enterprise using the enterprise's Microsoft Entra tenant ID.
102+
* Otherwise, find the **Number Management** section in the sidebar and select **Civic addresses**. Search for the enterprise using the enterprise's Microsoft Entra tenant ID.
86103
1. View the civic addresses. You can see the address, the company name, the description and whether the address was validated when the enterprise configured the address.
87104
1. Optionally, select an individual address to view additional information provided by the enterprise (for example, the ELIN information).
88105

articles/communications-gateway/overview.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: rcdun
55
ms.author: rdunstan
66
ms.service: communications-gateway
77
ms.topic: overview
8-
ms.date: 11/06/2023
8+
ms.date: 11/27/2023
99
ms.custom: template-overview
1010
---
1111

@@ -62,8 +62,6 @@ Launching Operator Connect or Teams Phone Mobile requires you to use the Operato
6262

6363
For more information, see [Number Management Portal for provisioning with Operator Connect APIs](interoperability-operator-connect.md#number-management-portal-for-provisioning-with-operator-connect-apis) and [Manage an enterprise with Azure Communications Gateway's Number Management Portal for Operator Connect and Teams Phone Mobile](manage-enterprise-operator-connect.md).
6464

65-
The Number Management Portal is available as part of the optional API Bridge feature.
66-
6765
> [!TIP]
6866
> The Number Management Portal does not allow your enterprise customers to manage Teams Calling. For example, it does not provide self-service portals.
6967

0 commit comments

Comments
 (0)