Skip to content

Commit c86d48f

Browse files
committed
edits
1 parent 42c3315 commit c86d48f

9 files changed

+74
-67
lines changed

articles/azure-web-pubsub/howto-authorize-from-application.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Authorize an application request to Web PubSub resources
2+
title: Authorize an application request by using Microsoft Entra ID
33
description: Learn how to authorize an application request to Web PubSub resources by using Microsoft Entra ID.
44
author: terencefan
55
ms.author: tefa
@@ -8,9 +8,9 @@ ms.service: azure-web-pubsub
88
ms.topic: conceptual
99
---
1010

11-
# Authorize an application request to Web PubSub resources by using Microsoft Entra ID
11+
# Authorize an application request by using Microsoft Entra ID
1212

13-
Azure Web PubSub Service supports Microsoft Entra ID for authorizing requests from [applications](../active-directory/develop/app-objects-and-service-principals.md).
13+
Azure Web PubSub supports Microsoft Entra ID for authorizing requests from [applications](../active-directory/develop/app-objects-and-service-principals.md).
1414

1515
This article shows you how to configure your Web PubSub resource and codes to authorize the request to a Web PubSub resource from an Azure application.
1616

@@ -141,7 +141,7 @@ To learn more about how to assign and manage Azure role assignments, see these a
141141

142142
![Screenshot that shows the response token when you use Postman to get the token.](./media/howto-authorize-from-application/get-azure-ad-token-using-postman-response.png)
143143

144-
## Sample codes that use Microsoft Entra authorization
144+
## Code samples that use Microsoft Entra authorization
145145

146146
Get samples that use Microsoft Entra authorization in our four officially supported programming languages:
147147

@@ -153,5 +153,5 @@ Get samples that use Microsoft Entra authorization in our four officially suppor
153153
## Related content
154154

155155
- [Overview of Microsoft Entra ID for Web PubSub](concept-azure-ad-authorization.md)
156-
- [Authorize a request to Web PubSub resources with Microsoft Entra ID from managed identities](howto-authorize-from-managed-identity.md)
156+
- [Use Microsoft Entra ID to authorize a request from a managed identity to Web PubSub resources](howto-authorize-from-managed-identity.md)
157157
- [Disable local authentication](./howto-disable-local-auth.md)

articles/azure-web-pubsub/howto-secure-private-endpoints.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Secure traffic by using a private endpoint
2+
title: Use a private endpoint for access control
33
description: Learn how to use private endpoints for secure access to Azure Web PubSub from a virtual network.
44
author: yjin81
55
ms.author: yajin1
@@ -8,25 +8,27 @@ ms.topic: how-to
88
ms.date: 08/16/2024
99
---
1010

11-
# Use private endpoints for Azure Web PubSub
11+
# Use private endpoints for access control
1212

1313
You can use [private endpoints](../private-link/private-endpoint-overview.md) for your Azure Web PubSub resource to allow clients in a virtual network (VNet) to securely access data over a [private link](../private-link/private-link-overview.md). The private endpoint uses an IP address from the VNet address space for your Web PubSub resource. Network traffic between the clients on the VNet and your Web PubSub resource traverses a private link on the Microsoft network, eliminating exposure on the public internet.
1414

1515
Using private endpoints for your Web PubSub resource helps you:
1616

1717
- Secure your Web PubSub resource by using network access control to block all connections on the public endpoint for Web PubSub.
1818
- Increase security for the VNet by enabling you to block exfiltration of data from the VNet.
19-
- Securely connect to Web PubSub from on-premises networks that connect to the VNet by using [VPN](../vpn-gateway/vpn-gateway-about-vpngateways.md) or [Azure ExpressRoute](../expressroute/expressroute-locations.md) with private-peering.
19+
- Securely connect to Web PubSub from on-premises networks that connect to the VNet by using a [VPN](../vpn-gateway/vpn-gateway-about-vpngateways.md) or [Azure ExpressRoute](../expressroute/expressroute-locations.md) with private peering.
2020

21-
## Conceptual overview
21+
## Use private endpoints in a virtual network
2222

23-
:::image type="content" source="./media/howto-secure-private-endpoints/private-endpoint-overview.png" alt-text="Overview of private endpoints for Azure Web PubSub.":::
23+
:::image type="content" source="./media/howto-secure-private-endpoints/private-endpoint-overview.png" alt-text="Diagram that shows an overview of private endpoints for Azure Web PubSub." lightbox="media/howto-secure-private-endpoints/private-endpoint-overview.png":::
2424

25-
A private endpoint is a special network interface for an Azure service in your [Virtual Network](../virtual-network/virtual-networks-overview.md) (VNet). When you create a private endpoint for your Web PubSub resource, it provides secure connectivity between clients on your VNet and your service. The private endpoint is assigned an IP address from the IP address range of your VNet. The connection between the private endpoint and Azure Web PubSub uses a secure private link.
25+
A private endpoint is a special network interface for an Azure service in your [virtual network](../virtual-network/virtual-networks-overview.md) (VNet). When you create a private endpoint for your Web PubSub resource, it provides secure connectivity between clients on your VNet and your service. The private endpoint is assigned an IP address from the IP address range of your VNet. The connection between the private endpoint and Azure Web PubSub uses a secure private link.
2626

27-
Applications in the VNet can connect to Azure Web PubSub over the private endpoint seamlessly, **using the same connection strings and authorization mechanisms that they would use otherwise**. Private endpoints can be used with all protocols supported by the Web PubSub resource, including REST API.
27+
Applications in the VNet can connect to Web PubSub resources seamlessly by using the private endpoint. The applications *use the same connection strings and authorization mechanisms that they would use otherwise.*
2828

29-
When you create a private endpoint for a Web PubSub resource in your VNet, a consent request is sent for approval to the Web PubSub resource owner. If the user requesting the creation of the private endpoint is also an owner of the Web PubSub resource, this consent request is automatically approved.
29+
Private endpoints can be used with all protocols that the Web PubSub resource supports, including REST API.
30+
31+
When you create a private endpoint for a Web PubSub resource in your VNet, a consent request is sent for approval to the Web PubSub resource owner. If the user who requests the private endpoint is also an owner of the Web PubSub resource, this consent request is automatically approved.
3032

3133
You can manage consent requests and private endpoints for your Web PubSub resource on the **Private endpoints** tab in the [Azure portal](https://portal.azure.com).
3234

articles/azure-web-pubsub/howto-secure-rotate-access-key.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,38 +5,38 @@ author: yjin81
55
ms.author: yajin1
66
ms.service: azure-web-pubsub
77
ms.topic: how-to
8-
ms.date: 11/08/2021
8+
ms.date: 08/16/2024
99
---
1010

11-
# Rotate access keys for Azure Web PubSub
11+
# Rotate access keys
1212

1313
Each Azure Web PubSub instance has a pair of access keys that helps you authenticate clients when requests are made to the service. Both keys are associated with the instance endpoint URL.
1414

1515
Each instance has a primary access key and a secondary access key. Rotate one access key at a time by regenerating a new key of that type, either primary or secondary. Update one access key while the other access key maintains existing authenticated connections.
1616

1717
## When to rotate access keys
1818

19-
For security reasons and to meet compliance requirements, we recommend that you routinely rotate your access keys.
19+
For security and compliance requirements, we recommend that you routinely rotate your access keys.
2020

2121
To regenerate an access key, complete the steps that are described in the following sections.
2222

2323
### Enforced access key rotation
2424

25-
In some scenarios, Azure Web PubSub might enforce a mandatory access key rotation. The service sends notifications via email and in the portal. If you receive this kind of notification or if you encounter service failure due to an access key, regenerate your access keys to rotate the keys.
25+
In some scenarios, Azure Web PubSub might enforce a mandatory access key rotation. The service sends notifications via email and in the portal. If you receive this kind of notification or if you encounter service failure due to an access key issue, regenerate your access keys to rotate the keys.
2626

2727
## Regenerate an access key
2828

29-
1. In the [Azure portal](https://portal.azure.com/), sign in with your credentials.
29+
1. In the [Azure portal](https://portal.azure.com/), sign in with your subscription credentials.
3030

31-
1. Go to the Azure Web PubSub instance that has keys you want to rotate.
31+
1. Go to the Web PubSub instance that has keys you want to rotate.
3232

3333
1. On the resource menu, select **Keys**.
3434

3535
1. Select **Regenerate Primary Key** or **Regenerate Secondary Key**.
3636

37-
A new key and a corresponding connection string are created and shown.
37+
A new key and a corresponding connection string are created. You manage them in your Web PubSub instance.
3838

39-
You also can regenerate a key by using the Azure CLI when the Azure Web PubSub service is generally available.
39+
When the Azure Web PubSub service becomes generally available, you can also regenerate a key by using the Azure CLI.
4040

4141
## Update configurations with the new connection string
4242

articles/azure-web-pubsub/howto-secure-shared-private-endpoints-key-vault.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Access a key vault in a private network via shared private endpoints
3-
titleSuffix: Azure Web PubSub Service
4-
description: Learn how to access a key vault in private network through shared private endpoints.
3+
titleSuffix: Azure Web PubSub
4+
description: Learn how to access a key vault in a private network through shared private endpoints.
55
author: ArchangelSDY
66
ms.service: azure-web-pubsub
77
ms.custom: devx-track-azurecli
@@ -45,8 +45,11 @@ Private endpoints of secured resources created through Azure Web PubSub APIs are
4545
:::image type="content" alt-text="Screenshot of shared private endpoints management." source="media\howto-secure-shared-private-endpoints-key-vault\portal-shared-private-endpoints-management.png" lightbox="media\howto-secure-shared-private-endpoints-key-vault\portal-shared-private-endpoints-management.png" :::
4646

4747
1. For **Name**, enter a name to use for the shared private endpoint.
48-
1. Enter your key vault resource: Choose **Select from your resources** and then select your resource from the lists, or select **Specify resource ID** and enter your key vault resource ID.
49-
1. For **Request message**, enter **please approve**.
48+
1. To select your key vault resource, complete one of the following steps:
49+
50+
* Choose **Select from your resources** and select your resource from the lists.
51+
* Select **Specify resource ID** and enter your key vault resource ID.
52+
1. For **Request message**, enter **Please approve**.
5053
1. Select **Add**.
5154

5255
:::image type="content" alt-text="Screenshot of adding a shared private endpoint." source="media\howto-secure-shared-private-endpoints-key-vault\portal-shared-private-endpoints-add.png" :::
@@ -94,7 +97,7 @@ az rest --method get --uri https://management.azure.com/subscriptions/00000000-0
9497

9598
### Approve the private endpoint connection for the key vault
9699

97-
After the private endpoint connection is created, you need to approve the connection request from Web PubSub in your Key Vault resource.
100+
After the private endpoint connection is created, the connection request from Web PubSub must be approved in your Key Vault resource.
98101

99102
#### [Azure portal](#tab/azure-portal)
100103

@@ -105,8 +108,9 @@ After the private endpoint connection is created, you need to approve the connec
105108
:::image type="content" alt-text="Screenshot of the Azure portal, showing the Private endpoint connections pane." source="media\howto-secure-shared-private-endpoints-key-vault\portal-key-vault-approve-private-endpoint.png" :::
106109

107110
1. Select the private endpoint that Web PubSub created.
108-
1. Select **Approve** and then select **Yes** to confirm.
109-
1. Wait for the private endpoint connection to be approved.
111+
1. Select **Approve**, and then select **Yes** to confirm.
112+
113+
It might take a few minutes for the private endpoint connection status to change to **Approved**.
110114

111115
:::image type="content" alt-text="Screenshot of the Azure portal, showing an Approved status on the Private endpoint connections pane." source="media\howto-secure-shared-private-endpoints-key-vault\portal-key-vault-approved-private-endpoint.png" :::
112116

articles/azure-web-pubsub/howto-secure-shared-private-endpoints.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Secure Azure Web PubSub outbound traffic through shared private endpoints
3-
titleSuffix: Azure Web PubSub Service
4-
description: Learn how to secure Azure Web PubSub outbound traffic through shared private endpoints.
2+
title: Secure outbound traffic through shared private endpoints
3+
titleSuffix: Azure Web PubSub
4+
description: Learn how to secure Azure Web PubSub outbound traffic by using shared private endpoints.
55
author: ArchangelSDY
66
ms.service: azure-web-pubsub
77
ms.custom: devx-track-azurecli
@@ -10,7 +10,7 @@ ms.date: 08/16/2024
1010
ms.author: dayshen
1111
---
1212

13-
# Secure Azure Web PubSub outbound traffic through shared private endpoints
13+
# Secure outbound traffic through shared private endpoints
1414

1515
If you're using an [event handler](concept-service-internals.md#event-handler) in Azure Web PubSub, you might have outbound traffic to upstream endpoints to a static web app that you created by using the Web Apps feature of Azure App Service or to a function that you created by using Azure Functions. You can configure Web Apps and Functions to use endpoints that accept connections from a list of virtual networks and refuse outside connections that originate in a public network. You can create an outbound [private endpoint connection](../private-link/private-endpoint-overview.md) in your Web PubSub services to reach these endpoints.
1616

@@ -40,32 +40,32 @@ Private endpoints of secured resources that are created by using Azure Web PubSu
4040
>
4141
> To use the steps in the following examples, replace these values with your own subscription ID, the name of your Web PubSub resource, and the name of your Azure Functions resource.
4242
43-
## Create a shared private link resource to the function
43+
## Create a shared private link resource to a function
4444

4545
### [Azure portal](#tab/azure-portal)
4646

4747
1. In the Azure portal, go to your Azure Web PubSub resource.
4848
1. On the left menu, select **Networking**.
49-
1. Select the **Private access** tab.
49+
1. Select **Private access**.
5050
1. Select **Add shared private endpoint**.
5151

52-
:::image type="content" alt-text="Screenshot of shared private endpoints management." source="media\howto-secure-shared-private-endpoints\portal-shared-private-endpoints-management.png" lightbox="media\howto-secure-shared-private-endpoints\portal-shared-private-endpoints-management.png" :::
52+
:::image type="content" alt-text="Screenshot that shows managing shared private endpoints." source="media\howto-secure-shared-private-endpoints\portal-shared-private-endpoints-management.png" lightbox="media\howto-secure-shared-private-endpoints\portal-shared-private-endpoints-management.png" :::
5353

5454
1. Enter a name for the shared private endpoint.
5555
1. To set your target linked sources, either choose **Select from your resources** or enter your resource ID in **Specify resource ID**.
5656

5757
Optionally, you can enter text in **Request message** to send a request to the target resource owner.
5858
1. Select **Add**.
5959

60-
:::image type="content" alt-text="Screenshot of adding a shared private endpoint." source="media\howto-secure-shared-private-endpoints\portal-shared-private-endpoints-add.png" :::
60+
:::image type="content" alt-text="Screenshot that shows adding a shared private endpoint." source="media\howto-secure-shared-private-endpoints\portal-shared-private-endpoints-add.png" :::
6161

62-
The **Provisioning state** value for the shared private endpoint resource is **Succeeded**. **Connection state** is **Pending** until the endpoint is approved at the target resource.
62+
The value for **Provisioning state** in the shared private endpoint resource is **Succeeded**. **Connection state** is **Pending** until the endpoint is approved at the target resource.
6363

64-
:::image type="content" alt-text="Screenshot of an added shared private endpoint." source="media\howto-secure-shared-private-endpoints\portal-shared-private-endpoints-added.png" lightbox="media\howto-secure-shared-private-endpoints\portal-shared-private-endpoints-added.png" :::
64+
:::image type="content" alt-text="Screenshot that shows an added shared private endpoint pending approval." source="media\howto-secure-shared-private-endpoints\portal-shared-private-endpoints-added.png" lightbox="media\howto-secure-shared-private-endpoints\portal-shared-private-endpoints-added.png" :::
6565

6666
### [Azure CLI](#tab/azure-cli)
6767

68-
Use the following API call with the [Azure CLI](/cli/azure/) to create a shared private link resource. Replace the values in the following example with the values in your scenario.
68+
Use the following API call with the [Azure CLI](/cli/azure/) to create a shared private link resource. Replace the values in the following example with the values from your scenario.
6969

7070
```bash:
7171
@@ -104,10 +104,10 @@ Wait until the status changes to "Succeeded" before you go to the next step.
104104

105105
## Approve the private endpoint connection for the function
106106

107-
When the shared private endpoint connection has a **Pending** status, you must approve the connection request at the target resource.
107+
When the shared private endpoint connection has a **Pending** status, the connection request must be approved at the target resource.
108108

109109
> [!IMPORTANT]
110-
> After you approve the private endpoint connection, the function is no longer accessible from a public network. You might need to create other private endpoints in your own virtual network to access the function endpoint.
110+
> After the private endpoint connection is approved, the function is no longer accessible from a public network. You might need to create other private endpoints in your own virtual network to access the function endpoint.
111111
112112
### [Azure portal](#tab/azure-portal)
113113

@@ -194,7 +194,7 @@ When `properties.provisioningState` is `Succeeded` and `properties.status` (conn
194194

195195
At this point, the private endpoint between Azure Web PubSub and Azure Functions is established.
196196

197-
## Verify that upstream calls are from a private IP
197+
## Verify that upstream calls are from a private IP address
198198

199199
When the private endpoint is set up, you can verify that incoming calls are from a private IP address by checking the `X-Forwarded-For` header for upstream calls.
200200

0 commit comments

Comments
 (0)