Skip to content

Commit 7157612

Browse files
authored
Merge pull request #264188 from MicrosoftDocs/release-preview-voice-protect
Create Operator Call Protection (Preview) documentation
2 parents 0b5ec69 + f30fe85 commit 7157612

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1962
-514
lines changed

articles/communications-gateway/breadcrumb/toc.yml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,12 @@ items:
33
tocHref: /azure/
44
topicHref: /azure/index
55
items:
6-
- name: Communications Gateway
7-
tocHref: /security/benchmark/azure/baselines/
6+
- tocHref: /security/benchmark/azure/baselines/
7+
name: Communications Gateway
88
topicHref: /azure/communications-gateway/
9-
- name: Communications Gateway
10-
tocHref: /azure/communications-gateway/
9+
- tocHref: /azure/operator-call-protection/
10+
name: Communications Gateway
11+
topicHref: /azure/communications-gateway/
12+
- tocHref: /azure/communications-gateway/
13+
name: Communications Gateway
1114
topicHref: /azure/communications-gateway/

articles/communications-gateway/configure-test-customer-teams-direct-routing.md

Lines changed: 29 additions & 6 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: 03/22/2024
8+
ms.date: 03/31/2024
99

1010
#CustomerIntent: As someone deploying Azure Communications Gateway, I want to test my deployment so that I can be sure that calls work.
1111
---
@@ -34,7 +34,9 @@ You must complete the following procedures.
3434
- [Deploy Azure Communications Gateway](deploy.md)
3535
- [Connect Azure Communications Gateway to Microsoft Teams Direct Routing](connect-teams-direct-routing.md)
3636

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.
38+
39+
[!INCLUDE [communications-gateway-provisioning-permissions](includes/communications-gateway-provisioning-permissions.md)]
3840

3941
You must be able to sign in to the Microsoft 365 admin center for your test customer tenant as a Global Administrator.
4042

@@ -84,20 +86,41 @@ To route calls to a customer tenant, the customer tenant must be configured with
8486
1. (Production deployments only) Repeat the previous step for the second customer subdomain.
8587

8688
> [!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 Gateway and generate DNS records](#configure-the-customer-on-azure-communications-gateway-and-generate-dns-records) first.
8890
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
9092

9193
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.
9294

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).
96+
97+
# [Number Management Portal (preview)](#tab/azure-portal)
98+
99+
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:
94115
- 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`).
96117
- 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.
97118
2. Use the Provisioning API to confirm that the DNS records have been generated, by checking the `direct_routing_provisioning_state` for the account.
98119

99120
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.
100121

122+
---
123+
101124
## Finish verifying the domains in the customer tenant
102125

103126
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.

articles/communications-gateway/configure-test-numbers-teams-direct-routing.md

Lines changed: 39 additions & 4 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: 03/22/2024
8+
ms.date: 03/31/2024
99

1010
#CustomerIntent: As someone deploying Azure Communications Gateway, I want to test my deployment so that I can be sure that calls work.
1111
---
@@ -30,16 +30,51 @@ You must complete the following procedures.
3030
- [Connect Azure Communications Gateway to Microsoft Teams Direct Routing](connect-teams-direct-routing.md)
3131
- [Configure a test customer for Microsoft Teams Direct Routing](configure-test-customer-teams-direct-routing.md)
3232

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.
34+
35+
[!INCLUDE [communications-gateway-provisioning-permissions](includes/communications-gateway-provisioning-permissions.md)]
3436

3537
You must be able to sign in to the Microsoft 365 admin center for your test customer tenant as a Global Administrator.
3638

37-
## Configure the test numbers on Azure Communications Gateway with the Provisioning API
39+
## Configure the test numbers on Azure Communications Gateway
3840

3941
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.
4042

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).
44+
45+
# [Number Management Portal (preview)](#tab/number-management-portal)
46+
47+
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+
4174
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.
4275

76+
---
77+
4378
## Update your network's routing configuration
4479

4580
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
5085

5186
Follow [Create a user and assign the license](/microsoftteams/direct-routing-enable-users#create-a-user-and-assign-the-license).
5287

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).
5489

5590
### Configure phone numbers for the user and enable enterprise voice
5691

articles/communications-gateway/configure-test-numbers-zoom.md

Lines changed: 40 additions & 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: how-to
8-
ms.date: 11/06/2023
8+
ms.date: 03/31/2024
99

1010
#CustomerIntent: As someone deploying Azure Communications Gateway, I want to test my deployment so that I can be sure that calls work.
1111
---
@@ -26,7 +26,9 @@ You must complete the following procedures.
2626
- [Deploy Azure Communications Gateway](deploy.md)
2727
- [Connect Azure Communications Gateway to Zoom Phone Cloud Peering](connect-zoom.md)
2828

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.
30+
31+
[!INCLUDE [communications-gateway-provisioning-permissions](includes/communications-gateway-provisioning-permissions.md)]
3032

3133
You must be an owner or admin of a Zoom account that you want to use for testing.
3234

@@ -39,7 +41,40 @@ You must provision Azure Communications Gateway with the details of the test num
3941
> [!IMPORTANT]
4042
> 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.
4143
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).
45+
46+
# [Number Management Portal (preview)](#tab/number-management-portal)
47+
48+
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+
4378
- Account resources are descriptions of your customers (typically, an enterprise), and per-customer settings for service provisioning.
4479
- 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.
4580

@@ -50,6 +85,8 @@ Use the Provisioning API for Azure Communications Gateway to:
5085

5186
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.
5287

88+
---
89+
5390
## Configure users in Zoom with the test numbers for integration testing
5491

5592
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_.

articles/communications-gateway/connect-teams-direct-routing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ ms.custom:
1212

1313
# Connect Azure Communications Gateway to Microsoft Teams Direct Routing
1414

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.
1616

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.
1818

1919
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).
2020

@@ -25,9 +25,9 @@ This article provides detailed guidance equivalent to the following steps in the
2525

2626
You must [deploy Azure Communications Gateway](deploy.md).
2727

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
3131

3232
You must have **Reader** access to the subscription into which Azure Communications Gateway is deployed.
3333

articles/communications-gateway/connect-zoom.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ You must start the onboarding process with Zoom to become a Zoom Phone Cloud Pee
2222

2323
You must [deploy Azure Communications Gateway](deploy.md).
2424

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
2828

2929
You must allocate "service verification" test numbers for Zoom. Zoom use these numbers for continuous call testing.
3030
- 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

Comments
 (0)