You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/communications-gateway/configure-test-customer-teams-direct-routing.md
+29-6Lines changed: 29 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ author: rcdun
5
5
ms.author: rdunstan
6
6
ms.service: communications-gateway
7
7
ms.topic: how-to
8
-
ms.date: 03/22/2024
8
+
ms.date: 03/31/2024
9
9
10
10
#CustomerIntent: As someone deploying Azure Communications Gateway, I want to test my deployment so that I can be sure that calls work.
11
11
---
@@ -34,7 +34,9 @@ You must complete the following procedures.
34
34
-[Deploy Azure Communications Gateway](deploy.md)
35
35
-[Connect Azure Communications Gateway to Microsoft Teams Direct Routing](connect-teams-direct-routing.md)
36
36
37
-
Your organization must [integrate with Azure Communications Gateway's Provisioning API](integrate-with-provisioning-api.md). Someone in your organization must be able to make requests using the Provisioning API during this procedure.
37
+
You must provision Azure Communications Gateway with the details of your test customer tenant during this procedure.
You must be able to sign in to the Microsoft 365 admin center for your test customer tenant as a Global Administrator.
40
42
@@ -84,20 +86,41 @@ To route calls to a customer tenant, the customer tenant must be configured with
84
86
1. (Production deployments only) Repeat the previous step for the second customer subdomain.
85
87
86
88
> [!IMPORTANT]
87
-
> Don't complete the verification process yet. You must carry out [Use Azure Communications Gateway's Provisioning API to configure the customer and generate DNS records](#use-azure-communications-gateways-provisioning-api-to-configure-the-customer-and-generate-dns-records) first.
89
+
> Don't complete the verification process yet. You must carry out [Configure the customer on Azure Communications Gatewayand generate DNS records](#configure-the-customer-on-azure-communications-gateway-and-generate-dns-records) first.
88
90
89
-
## Use Azure Communications Gateway's Provisioning API to configure the customer and generate DNS records
91
+
## Configure the customer on Azure Communications Gateway and generate DNS records
90
92
91
93
Azure Communications Gateway includes a DNS server. You must use Azure Communications Gateway to create the DNS records required to verify the customer subdomains. To generate the records, provision the details of the customer tenant and the DNS TXT values on Azure Communications Gateway.
92
94
93
-
1. Use Azure Communications Gateway's Provisioning API to configure the customer as an account. The request must:
95
+
You can use Azure Communications Gateway's Number Management Portal (preview) or Provisioning API (preview).
1. From the overview page for your Communications Gateway resource, find the **Number Management** section in the sidebar.
100
+
1. Select **Accounts**.
101
+
1. Select **Create account**.
102
+
1. Enter an **Account name** and select the **Enable Teams Direct Routing** checkbox.
103
+
1. Set **Teams tenant ID** to the ID of your test customer tenant.
104
+
1. Optionally, select **Enable call screening**. This screening ensures that customers can only place Direct Routing calls from numbers that you have assigned to them.
105
+
1. Set **Subdomain** to the label for the subdomain that you chose in [Choose a DNS subdomain label to use to identify the customer](#choose-a-dns-subdomain-label-to-use-to-identify-the-customer) (for example, `test`).
106
+
1. Set the **Subdomain token region** fields to the TXT values that you obtained in [Start registering the subdomains in the customer tenant and get DNS TXT values](#start-registering-the-subdomains-in-the-customer-tenant-and-get-dns-txt-values).
107
+
1. Select **Create**.
108
+
1. Confirm that the DNS records have been generated.
109
+
1. On the **Accounts** pane, select the account name in the list.
110
+
1. Confirm that **Subdomain Provisioned State** is **Provisioned**.
111
+
112
+
# [Provisioning API (preview)](#tab/api)
113
+
114
+
1. Use the Provisioning API to configure an account for the customer. The request must:
94
115
- Enable Direct Routing for the account.
95
-
- Specify the label for the subdomain that you chose (for example, `test`).
116
+
- Specify the label for the subdomain that you chose in [Choose a DNS subdomain label to use to identify the customer](#choose-a-dns-subdomain-label-to-use-to-identify-the-customer)(for example, `test`).
96
117
- Specify the DNS TXT values from [Start registering the subdomains in the customer tenant and get DNS TXT values](#start-registering-the-subdomains-in-the-customer-tenant-and-get-dns-txt-values). These values allow Azure Communications Gateway to generate DNS records for the subdomain.
97
118
2. Use the Provisioning API to confirm that the DNS records have been generated, by checking the `direct_routing_provisioning_state` for the account.
98
119
99
120
For example API requests, see [Create an account to represent a customer](/rest/api/voiceservices/#create-an-account-to-represent-a-customer) and [View the details of the account](/rest/api/voiceservices/#view-the-details-of-the-account) in the _API Reference_ for the Provisioning API.
100
121
122
+
---
123
+
101
124
## Finish verifying the domains in the customer tenant
102
125
103
126
When you have used Azure Communications Gateway to generate the DNS records for the customer subdomains, verify the subdomains in the Microsoft 365 admin center for your customer tenant.
Copy file name to clipboardExpand all lines: articles/communications-gateway/configure-test-numbers-teams-direct-routing.md
+39-4Lines changed: 39 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ author: rcdun
5
5
ms.author: rdunstan
6
6
ms.service: communications-gateway
7
7
ms.topic: how-to
8
-
ms.date: 03/22/2024
8
+
ms.date: 03/31/2024
9
9
10
10
#CustomerIntent: As someone deploying Azure Communications Gateway, I want to test my deployment so that I can be sure that calls work.
11
11
---
@@ -30,16 +30,51 @@ You must complete the following procedures.
30
30
-[Connect Azure Communications Gateway to Microsoft Teams Direct Routing](connect-teams-direct-routing.md)
31
31
-[Configure a test customer for Microsoft Teams Direct Routing](configure-test-customer-teams-direct-routing.md)
32
32
33
-
Your organization must [integrate with Azure Communications Gateway's Provisioning API](integrate-with-provisioning-api.md). Someone in your organization must be able to make requests using the Provisioning API during this procedure.
33
+
You must provision Azure Communications Gateway with numbers for integration testing during this procedure.
You must be able to sign in to the Microsoft 365 admin center for your test customer tenant as a Global Administrator.
36
38
37
-
## Configure the test numbers on Azure Communications Gateway with the Provisioning API
39
+
## Configure the test numbers on Azure Communications Gateway
38
40
39
41
In [Configure a test customer for Microsoft Teams Direct Routing with Azure Communications Gateway](configure-test-customer-teams-direct-routing.md), you configured Azure Communications Gateway with an account for the test customer.
40
42
43
+
We recommend using the Number Management Portal (preview) to provision the test numbers. Alternatively, you can use Azure Communications Gateway's Provisioning API (preview).
You can configure numbers directly in the Number Management Portal, or by uploading a CSV file containing number configuration.
48
+
49
+
1. From the overview page for your Communications Gateway resource, find the **Number Management** section in the sidebar. Select **Accounts**.
50
+
1. Select the checkbox next to the enterprise's **Account name** and select **View numbers**.
51
+
1. Select **Create numbers**.
52
+
1. To configure the numbers directly in the Number Management Portal:
53
+
1. Select **Manual input**.
54
+
1. Select **Enable Teams Direct Routing**.
55
+
1. Optionally, enter a value for **Custom SIP header**.
56
+
1. Add the numbers in **Telephone Numbers**.
57
+
1. Select **Create**.
58
+
1. To upload a CSV containing multiple numbers:
59
+
1. Prepare a `.csv` file. It must use the headings shown in the following table, and contain one number per line (up to 10,000 numbers).
60
+
61
+
| Heading | Description | Valid values |
62
+
|---------|--------------|--------------|
63
+
|`telephoneNumber`|The number to upload | E.164 numbers, including `+` and the country code |
64
+
|`accountName`| The account to upload the number to | The name of an existing account |
65
+
|`serviceDetails_teamsDirectRouting_enabled`| Whether Microsoft Teams Direct Routing is enabled |`true` or `false`|
66
+
|`configuration_customSipHeader`| Optional: the value for a SIP custom header. | Can only contain letters, numbers, underscores, and dashes. Can be up to 100 characters in length. |
67
+
68
+
1. Select **File Upload**.
69
+
1. Select the `.csv` file that you prepared.
70
+
1. Select **Upload**.
71
+
72
+
# [Provisioning API (preview)](#tab/api)
73
+
41
74
Use Azure Communications Gateway's Provisioning API to provision the details of the numbers you chose under the account. Enable each number for Teams Direct Routing. For example API requests, see [Add one number to the account](/rest/api/voiceservices/#add-one-number-to-the-account) or [Add or update multiple numbers at once](/rest/api/voiceservices/#add-or-update-multiple-numbers-at-once) in the _API Reference_ for the Provisioning API.
42
75
76
+
---
77
+
43
78
## Update your network's routing configuration
44
79
45
80
Update your network configuration to route calls involving the test numbers to Azure Communications Gateway. For more information about how to route calls to Azure Communications Gateway, see [Call routing requirements](reliability-communications-gateway.md#call-routing-requirements).
@@ -50,7 +85,7 @@ Update your network configuration to route calls involving the test numbers to A
50
85
51
86
Follow [Create a user and assign the license](/microsoftteams/direct-routing-enable-users#create-a-user-and-assign-the-license).
52
87
53
-
If you are migrating users from Skype for Business Server Enterprise Voice, you must also [ensure that the user is homed online](/microsoftteams/direct-routing-enable-users#ensure-that-the-user-is-homed-online).
88
+
If you're migrating users from Skype for Business Server Enterprise Voice, you must also [ensure that the user is homed online](/microsoftteams/direct-routing-enable-users#ensure-that-the-user-is-homed-online).
54
89
55
90
### Configure phone numbers for the user and enable enterprise voice
Copy file name to clipboardExpand all lines: articles/communications-gateway/configure-test-numbers-zoom.md
+40-3Lines changed: 40 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ author: rcdun
5
5
ms.author: rdunstan
6
6
ms.service: communications-gateway
7
7
ms.topic: how-to
8
-
ms.date: 11/06/2023
8
+
ms.date: 03/31/2024
9
9
10
10
#CustomerIntent: As someone deploying Azure Communications Gateway, I want to test my deployment so that I can be sure that calls work.
11
11
---
@@ -26,7 +26,9 @@ You must complete the following procedures.
26
26
-[Deploy Azure Communications Gateway](deploy.md)
27
27
-[Connect Azure Communications Gateway to Zoom Phone Cloud Peering](connect-zoom.md)
28
28
29
-
Your organization must [integrate with Azure Communications Gateway's Provisioning API](integrate-with-provisioning-api.md). Someone in your organization must be able to make requests using the Provisioning API during this procedure.
29
+
You must provision Azure Communications Gateway with the numbers for integration testing during this procedure.
You must be an owner or admin of a Zoom account that you want to use for testing.
32
34
@@ -39,7 +41,40 @@ You must provision Azure Communications Gateway with the details of the test num
39
41
> [!IMPORTANT]
40
42
> Do not provision the service verification numbers for Zoom. Azure Communications Gateway routes calls involving those numbers automatically. Any provisioning you do for those numbers has no effect.
41
43
42
-
This step requires Azure Communications Gateway's Provisioning API. The API allows you to indicate to Azure Communications Gateway which service(s) you're supporting for each number, using _account_ and _number_ resources.
44
+
We recommend using the Number Management Portal (preview) to provision the test numbers. Alternatively, you can use Azure Communications Gateway's Provisioning API (preview).
You can configure numbers directly in the Number Management Portal, or by uploading a CSV file containing number configuration.
49
+
50
+
1. From the overview page for your Communications Gateway resource, find the **Number Management** section in the sidebar. Select **Accounts**.
51
+
1. Select **Create account**. Enter an **Account name** and select the **Enable Zoom Phone Cloud Peering** checkbox. Select **Create**.
52
+
1. Select the checkbox next to the new **Account name** and select **View numbers**.
53
+
1. Select **Create numbers**.
54
+
1. To configure the numbers directly in the Number Management Portal:
55
+
1. Select **Manual input**.
56
+
1. Select **Enable Zoom Phone Cloud Peering**.
57
+
1. Optionally, enter a value for **Custom SIP header**.
58
+
1. Add the numbers in **Telephone Numbers**.
59
+
1. Select **Create**.
60
+
1. To upload a CSV containing multiple numbers:
61
+
1. Prepare a `.csv` file. It must use the headings shown in the following table, and contain one number per line (up to 10,000 numbers).
62
+
63
+
| Heading | Description | Valid values |
64
+
|---------|--------------|--------------|
65
+
|`telephoneNumber`|The number to upload | E.164 numbers, including `+` and the country code |
66
+
|`accountName`| The account to upload the number to | The name of an existing account |
67
+
|`serviceDetails_zoomPhoneCloudPeering_enabled`| Whether Zoom Phone Cloud Peering is enabled |`true` or `false`|
68
+
|`configuration_customSipHeader`| Optional: the value for a SIP custom header. | Can only contain letters, numbers, underscores, and dashes. Can be up to 100 characters in length. |
69
+
70
+
1. Select **File Upload**.
71
+
1. Select the `.csv` file that you prepared.
72
+
1. Select **Upload**.
73
+
74
+
# [Provisioning API (preview)](#tab/provisioning-api)
75
+
76
+
The API allows you to indicate to Azure Communications Gateway which service you're supporting for each number, using _account_ and _number_ resources.
77
+
43
78
- Account resources are descriptions of your customers (typically, an enterprise), and per-customer settings for service provisioning.
44
79
- Number resources belong to an account. They describe numbers, the services (for example, Zoom) that the numbers make use of, and any extra per-number configuration.
45
80
@@ -50,6 +85,8 @@ Use the Provisioning API for Azure Communications Gateway to:
50
85
51
86
For example API requests, see [Create an account to represent a customer](/rest/api/voiceservices/#create-an-account-to-represent-a-customer) and [Add one number to the account](/rest/api/voiceservices/#add-one-number-to-the-account) or [Add or update multiple numbers at once](/rest/api/voiceservices/#add-or-update-multiple-numbers-at-once) in the _API Reference_ for the Provisioning API.
52
87
88
+
---
89
+
53
90
## Configure users in Zoom with the test numbers for integration testing
54
91
55
92
Upload the numbers for integration testing to Zoom. When you upload numbers, you can optionally configure Zoom to add a header containing custom contents to SIP INVITEs. You can use this header to identify the Zoom account for the number or indicate that these numbers are test numbers. For more information on this header, see Zoom's _Zoom Phone Provider Exchange Solution Reference Guide_.
Copy file name to clipboardExpand all lines: articles/communications-gateway/connect-teams-direct-routing.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,9 +12,9 @@ ms.custom:
12
12
13
13
# Connect Azure Communications Gateway to Microsoft Teams Direct Routing
14
14
15
-
After you deploy Azure Communications Gateway and connect it to your core network, you need to connect it to Microsoft Phone System.
15
+
After you deploy Azure Communications Gateway and connect it to your core network, you need to connect it to Microsoft Teams Direct Routing by following the steps in this article.
16
16
17
-
This article describes how to start connecting Azure Communications Gateway to Microsoft Teams Direct Routing. After you finish the steps in this article, you can set up test users for test calls and prepare for live traffic.
17
+
After you finish the steps in this article, you can set up test users for test calls and prepare for live traffic.
18
18
19
19
This article provides detailed guidance equivalent to the following steps in the [Microsoft Teams documentation for configuring an SBC for multiple tenants](/microsoftteams/direct-routing-sbc-multiple-tenants).
20
20
@@ -25,9 +25,9 @@ This article provides detailed guidance equivalent to the following steps in the
25
25
26
26
You must [deploy Azure Communications Gateway](deploy.md).
27
27
28
-
Your organization must [integrate with Azure Communications Gateway's Provisioning API](integrate-with-provisioning-api.md). If you didn't configure the Provisioning API in the Azure portal as part of deploying, you also need to know:
29
-
-The IP addresses or address ranges (in CIDR format) in your network that should be allowed to connect to the Provisioning API, as a comma-separated list.
30
-
-(Optional) The name of any custom SIP header that Azure Communications Gateway should add to messages entering your network.
28
+
Using Azure Communications Gateway for Microsoft Teams Direct Routing requires provisioning the details of your customers and the numbers that you assign to them on Azure Communications Gateway. You can do this with Azure Communications Gateway's Provisioning API (preview) or its Number Management Portal (preview). If you're planning to use the Provisioning API:
29
+
-Your organization must [integrate with the API](integrate-with-provisioning-api.md)
30
+
-You must know the IP addresses or address ranges (in CIDR format) in your network that should be allowed to connect to the Provisioning API
31
31
32
32
You must have **Reader** access to the subscription into which Azure Communications Gateway is deployed.
Copy file name to clipboardExpand all lines: articles/communications-gateway/connect-zoom.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,9 +22,9 @@ You must start the onboarding process with Zoom to become a Zoom Phone Cloud Pee
22
22
23
23
You must [deploy Azure Communications Gateway](deploy.md).
24
24
25
-
Your organization must [integrate with Azure Communications Gateway's Provisioning API](integrate-with-provisioning-api.md). If you didn't configure the Provisioning API in the Azure portal as part of deploying, you also need to know:
26
-
-The IP addresses or address ranges (in CIDR format) in your network that should be allowed to connect to the Provisioning API, as a comma-separated list.
27
-
-(Optional) The name of any custom SIP header that Azure Communications Gateway should add to messages entering your network.
25
+
Using Azure Communications Gateway for Zoom Phone Cloud Peering requires provisioning the details of your customers and the numbers that you assign to them on Azure Communications Gateway. You can do this with Azure Communications Gateway's Provisioning API (preview) or its Number Management Portal (preview). If you're planning to use the Provisioning API:
26
+
-Your organization must [integrate with the API](integrate-with-provisioning-api.md)
27
+
-You must know the IP addresses or address ranges (in CIDR format) in your network that should be allowed to connect to the Provisioning API
28
28
29
29
You must allocate "service verification" test numbers for Zoom. Zoom use these numbers for continuous call testing.
30
30
- If you selected the service you're setting up as part of deploying Azure Communications Gateway, you've allocated numbers for the service already.
0 commit comments