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/azure-web-pubsub/howto-authorize-from-application.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
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Authorize an application request to Web PubSub resources
2
+
title: Authorize an application request by using Microsoft Entra ID
3
3
description: Learn how to authorize an application request to Web PubSub resources by using Microsoft Entra ID.
4
4
author: terencefan
5
5
ms.author: tefa
@@ -8,9 +8,9 @@ ms.service: azure-web-pubsub
8
8
ms.topic: conceptual
9
9
---
10
10
11
-
# Authorize an application request to Web PubSub resources by using Microsoft Entra ID
11
+
# Authorize an application request by using Microsoft Entra ID
12
12
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).
14
14
15
15
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.
16
16
@@ -141,7 +141,7 @@ To learn more about how to assign and manage Azure role assignments, see these a
141
141
142
142

143
143
144
-
## Sample codes that use Microsoft Entra authorization
144
+
## Code samples that use Microsoft Entra authorization
145
145
146
146
Get samples that use Microsoft Entra authorization in our four officially supported programming languages:
147
147
@@ -153,5 +153,5 @@ Get samples that use Microsoft Entra authorization in our four officially suppor
153
153
## Related content
154
154
155
155
-[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)
157
157
-[Disable local authentication](./howto-disable-local-auth.md)
Copy file name to clipboardExpand all lines: articles/azure-web-pubsub/howto-secure-private-endpoints.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Secure traffic by using a private endpoint
2
+
title: Use a private endpoint for access control
3
3
description: Learn how to use private endpoints for secure access to Azure Web PubSub from a virtual network.
4
4
author: yjin81
5
5
ms.author: yajin1
@@ -8,25 +8,27 @@ ms.topic: how-to
8
8
ms.date: 08/16/2024
9
9
---
10
10
11
-
# Use private endpoints for Azure Web PubSub
11
+
# Use private endpoints for access control
12
12
13
13
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.
14
14
15
15
Using private endpoints for your Web PubSub resource helps you:
16
16
17
17
- Secure your Web PubSub resource by using network access control to block all connections on the public endpoint for Web PubSub.
18
18
- 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 privatepeering.
20
20
21
-
## Conceptual overview
21
+
## Use private endpoints in a virtual network
22
22
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":::
24
24
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.
26
26
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.*
28
28
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.
30
32
31
33
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).
Copy file name to clipboardExpand all lines: articles/azure-web-pubsub/howto-secure-rotate-access-key.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,38 +5,38 @@ author: yjin81
5
5
ms.author: yajin1
6
6
ms.service: azure-web-pubsub
7
7
ms.topic: how-to
8
-
ms.date: 11/08/2021
8
+
ms.date: 08/16/2024
9
9
---
10
10
11
-
# Rotate access keys for Azure Web PubSub
11
+
# Rotate access keys
12
12
13
13
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.
14
14
15
15
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.
16
16
17
17
## When to rotate access keys
18
18
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.
20
20
21
21
To regenerate an access key, complete the steps that are described in the following sections.
22
22
23
23
### Enforced access key rotation
24
24
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.
26
26
27
27
## Regenerate an access key
28
28
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.
30
30
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.
32
32
33
33
1. On the resource menu, select **Keys**.
34
34
35
35
1. Select **Regenerate Primary Key** or **Regenerate Secondary Key**.
36
36
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.
38
38
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.
40
40
41
41
## Update configurations with the new connection string
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**.
50
53
1. Select **Add**.
51
54
52
55
:::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
94
97
95
98
### Approve the private endpoint connection for the key vault
96
99
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.
98
101
99
102
#### [Azure portal](#tab/azure-portal)
100
103
@@ -105,8 +108,9 @@ After the private endpoint connection is created, you need to approve the connec
105
108
:::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" :::
106
109
107
110
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**.
110
114
111
115
:::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" :::
Copy file name to clipboardExpand all lines: articles/azure-web-pubsub/howto-secure-shared-private-endpoints.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
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.
5
5
author: ArchangelSDY
6
6
ms.service: azure-web-pubsub
7
7
ms.custom: devx-track-azurecli
@@ -10,7 +10,7 @@ ms.date: 08/16/2024
10
10
ms.author: dayshen
11
11
---
12
12
13
-
# Secure Azure Web PubSub outbound traffic through shared private endpoints
13
+
# Secure outbound traffic through shared private endpoints
14
14
15
15
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.
16
16
@@ -40,32 +40,32 @@ Private endpoints of secured resources that are created by using Azure Web PubSu
40
40
>
41
41
> 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.
42
42
43
-
## Create a shared private link resource to the function
43
+
## Create a shared private link resource to a function
44
44
45
45
### [Azure portal](#tab/azure-portal)
46
46
47
47
1. In the Azure portal, go to your Azure Web PubSub resource.
1. To set your target linked sources, either choose **Select from your resources** or enter your resource ID in **Specify resource ID**.
56
56
57
57
Optionally, you can enter text in **Request message** to send a request to the target resource owner.
58
58
1. Select **Add**.
59
59
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" :::
61
61
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.
63
63
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" :::
65
65
66
66
### [Azure CLI](#tab/azure-cli)
67
67
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.
69
69
70
70
```bash:
71
71
@@ -104,10 +104,10 @@ Wait until the status changes to "Succeeded" before you go to the next step.
104
104
105
105
## Approve the private endpoint connection for the function
106
106
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.
108
108
109
109
> [!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.
111
111
112
112
### [Azure portal](#tab/azure-portal)
113
113
@@ -194,7 +194,7 @@ When `properties.provisioningState` is `Succeeded` and `properties.status` (conn
194
194
195
195
At this point, the private endpoint between Azure Web PubSub and Azure Functions is established.
196
196
197
-
## Verify that upstream calls are from a private IP
197
+
## Verify that upstream calls are from a private IP address
198
198
199
199
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.
0 commit comments