Skip to content

Commit 0303b96

Browse files
committed
edits
1 parent 4d71cac commit 0303b96

12 files changed

+35
-38
lines changed

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

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.topic: conceptual
1212

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

15-
This article shows you how to configure your Web PubSub resource and code to authorize the request to a Web PubSub resource from an Azure application.
15+
This article shows you how to configure your Web PubSub resource and code to authorize a request to a Web PubSub resource from an Azure application.
1616

1717
## Register an application
1818

@@ -21,11 +21,10 @@ The first step is to register an Azure application.
2121
1. In the [Azure portal](https://portal.azure.com/), search for and then select **Microsoft Entra ID**
2222
1. On the left menu under **Manage**, select **App registrations**.
2323
1. Select **New registration**.
24-
25-
:::image type="content" source="media/howto-authorize-from-application/register-an-application.png" alt-text="Screenshot that shows registering an application.":::
26-
2724
1. For **Name**, enter a name to use for your application.
28-
1. Select **Register** to confirm the register.
25+
1. Select **Register** to confirm the application registration.
26+
27+
:::image type="content" source="media/howto-authorize-from-application/register-an-application.png" alt-text="Screenshot that shows registering an application.":::
2928

3029
When your application is registered, go to the application overview to view the values for **Application (client) ID** and **Directory (tenant) ID**. You use these values in the following sections.
3130

@@ -37,6 +36,8 @@ For more information about registering an application, see the quickstart [Regis
3736

3837
You can add both certificates and client secrets (a string) as credentials to your confidential client app registration.
3938

39+
For more information about adding credentials, see [Add credentials](../active-directory/develop/quickstart-register-app.md#add-credentials).
40+
4041
### Add a client secret
4142

4243
The application requires a client secret for a client to prove its identity when it requests a token.
@@ -48,34 +49,32 @@ To create a client secret:
4849

4950
:::image type="content" source="media/howto-authorize-from-application/new-client-secret.png" alt-text="Screenshot that shows creating a client secret.":::
5051

51-
1. Enter a description for the client secret, and then choose an expire time for the secret.
52+
1. Enter a description for the client secret, and then choose an **Expires** time for the secret.
5253
1. Copy the value of the client secret, and then paste it to a secure location to save for later use.
5354

5455
> [!NOTE]
5556
> The secret is visible only when you create the secret. You can't view the client secret in the portal later.
5657
5758
### Add a certificate
5859

59-
You can also upload a certificate instead of creating a client secret.
60+
You can upload a certificate instead of creating a client secret.
6061

6162
:::image type="content" source="media/howto-authorize-from-application/upload-certificate.png" alt-text="Screenshot that shows uploading a certificate.":::
6263

63-
For more information about adding credentials, see [Add credentials](../active-directory/develop/quickstart-register-app.md#add-credentials).
64-
6564
## Add a role assignment in the Azure portal
6665

6766
This section demonstrates how to assign a Web PubSub Service Owner role to a service principal (application) for a Web PubSub resource.
6867

6968
> [!NOTE]
70-
> You can assign a role to any scope, including management group, subscription, resource group, and single resource. For more information about scope, see [Understand scope for Azure RBAC](../role-based-access-control/scope-overview.md).
69+
> You can assign a role to any scope, including management group, subscription, resource group, and single resource. For more information about scope, see [Understand scope for Azure role-based access control](../role-based-access-control/scope-overview.md).
7170
7271
1. In the [Azure portal](https://portal.azure.com/), go to your Web PubSub resource.
7372

74-
1. On the left menu, select **Access control (IAM)** to display access control settings for your Web PubSub resource.
73+
1. On the left menu, select **Access control (IAM)** to display access control settings for the resource.
7574

7675
1. Select the **Role assignments** tab and view the role assignments at this scope.
7776

78-
The following screenshot shows an example of the Access control (IAM) pane for a Web PubSub resource:
77+
The following figure shows an example of the **Access control (IAM)** pane for a Web PubSub resource:
7978

8079
:::image type="content" source="media/howto-authorize-from-application/access-control.png" alt-text="Screenshot that shows an example of the Access control (IAM) pane.":::
8180

@@ -89,9 +88,9 @@ This section demonstrates how to assign a Web PubSub Service Owner role to a ser
8988

9089
1. Select the **Members** tab. Under **Assign access to**, select **User, group, or service principal**.
9190

92-
1. Choose **Select Members**
91+
1. Choose **Select members**.
9392

94-
1. Search for and select the application that you want to assign the role to.
93+
1. Search for and select the application to assign the role to.
9594

9695
1. Choose **Select** to confirm the selection.
9796

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

119118
1. For **Method**, select **GET**.
120119

121-
1. For **URI**, enter `https://login.microsoftonline.com/<TENANT ID>/oauth2/token`. Replace `<TENANT ID>` with the value for **Directory (tenant) ID** on the **Overview** tab of the application you created.
120+
1. For **URI**, enter `https://login.microsoftonline.com/<TENANT ID>/oauth2/token`. Replace `<TENANT ID>` with the value for **Directory (tenant) ID** on the **Overview** pane of the application you created.
122121

123122
1. Select the **Headers** tab, and then add the following keys and values:
124123

@@ -132,8 +131,8 @@ To learn more about how to assign and manage Azure role assignments, see these a
132131
1. Under **Key**, add the following keys and values:
133132

134133
1. Select **grant_type**, and then select the value **client_credentials**.
135-
1. Select **client_id**, and then paste the value of **Application (client) ID** from the **Overview** tab of the application you created.
136-
1. Select **client_secret**, and then paste the value of client secret you saved.
134+
1. Select **client_id**, and then paste the value of **Application (client) ID** from the **Overview** pane of the application you created.
135+
1. Select **client_secret**, and then paste the value of the client secret you saved.
137136
1. Select **resource**, and then enter `https://webpubsub.azure.com` for the value.
138137

139138
:::image type="content" source="media/howto-authorize-from-application/get-azure-ad-token-using-postman-body.png" alt-text="Screenshot that shows the Body tab parameters when you use Postman to get the token.":::

articles/azure-web-pubsub/howto-client-certificate.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ You can restrict access to your instance of Azure Web PubSub by turning on diffe
2525

2626
## Deploy Web PubSub
2727

28-
In this example, you use a function called `func-client-cert` as an event handler to process `connect` events. Clients connect to a hub called `echo`. Here are the Bicep and Azure Resource Manager templates you use to deploy an Azure Web PubSub service with client certificate authentication enabled and event handlers configured.
28+
In this example, you use a function called `func-client-cert` as an event handler to process `connect` events. Clients connect to a hub called `echo`. The next sections have Bicep and Azure Resource Manager templates that you can use to deploy an Azure Web PubSub service with client certificate authentication enabled and event handlers configured.
2929

3030
The templates enable client certificate authentication via the property `tls.clientCertEnabled`.
3131

@@ -140,9 +140,9 @@ resource hub 'Microsoft.SignalRService/WebPubSub/hubs@2023-03-01-preview' = {
140140

141141
## Validate a client certificate in an event handler
142142

143-
You can validate an incoming client certificate via its SHA-1 thumbprint in the `connect` event. The value is available in `clientCertificates` field. For more information, see [CloudEvents HTTP extension for event handler](reference-cloud-events.md#connect).
143+
You can validate an incoming client certificate via its SHA-1 thumbprint in the `connect` event. The value is available in `clientCertificates`. For more information, see [CloudEvents HTTP extension for event handler](reference-cloud-events.md#connect).
144144

145-
The following code samples have function codes that you can use to implement validation logic.
145+
The following code sample has function code that you can use to implement validation logic.
146146

147147
### JavaScript
148148

@@ -174,15 +174,15 @@ module.exports = async function (context, req) {
174174
}
175175
```
176176

177-
## Certificate rotation
177+
## Rotate the certificate
178178

179179
If you want to rotate the certificate, you can update your event handler code to accept multiple thumbprints.
180180

181-
## Missing client certificate
181+
## Handle a missing client certificate
182182

183183
Azure Web PubSub doesn't abort a TLS handshake when a client doesn't provide a client certificate. It's up to the event handler to decide whether to accept or reject a connection without a client certificate.
184184

185185
## Related content
186186

187-
* [How to configure event handler](howto-develop-eventhandler.md)
187+
* [How to configure an event handler](howto-develop-eventhandler.md)
188188
* [Golang sample](https://github.com/Azure/azure-webpubsub/blob/main/samples/golang/clientWithCert/Readme.md)

articles/azure-web-pubsub/howto-custom-domain.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,17 +201,17 @@ $ curl -vvv https://contoso.example.com/api/health
201201

202202
The Health API should return a `200` status code without any certificate errors.
203203

204-
## Private network key vault
204+
## Configure a private network key vault
205205

206206
If you configure a [private endpoint](../private-link/private-endpoint-overview.md) to your key vault, Web PubSub can't access the key vault by using a public network. You must set up a [shared private endpoint](./howto-secure-shared-private-endpoints-key-vault.md) to give Web PubSub access to your key vault via a private network.
207207

208208
After you create a shared private endpoint, you can create a custom certificate as usual. You *don't have to change the domain in the key vault URI*. For example, if your key vault base URI is `https://contoso.vault.azure.net`, continue to use this URI to configure a custom certificate.
209209

210210
You don't have to explicitly allow Web PubSub IP addresses in your key vault firewall settings. For more information, see [Key vault private link diagnostics](/azure/key-vault/general/private-link-diagnostics).
211211

212-
## Certificate rotation
212+
## Rotate the certificate
213213

214-
If you don't specify a secret version when you create a custom certificate, Web PubSub periodically checks for the latest version in the key vault. When a new version is detected, it's automatically applied. The delay is usually within an hour.
214+
If you don't specify a secret version when you create a custom certificate, Web PubSub periodically checks for the latest version in the key vault. When a new version is detected, it's automatically applied. The delay is typically less than an hour.
215215

216216
Alternatively, you can pin a custom certificate to a specific secret version in your key vault. When you need to apply a new certificate, you can edit the secret version, and then update the custom certificate proactively.
217217

articles/azure-web-pubsub/howto-secure-network-access-control.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ The next sections describe your two options to control access to your Web PubSub
2323
- Deny all requests that originate in a public endpoint.
2424
- Allow only client connections from a public network.
2525

26-
### Deny all public traffic
26+
## Deny all public traffic
2727

2828
To completely deny all public traffic, first configure the public network rule to allow no request type. Then, configure rules that grant access to traffic from specific virtual networks. This configuration enables you to build a secure network boundary for your applications.
2929

30-
### Allow only client connections from a public network
30+
## Allow only client connections from a public network
3131

3232
In this scenario, you configure the public network rule to allow only client connections from a public network. You can then configure private network rules to allow other types of requests that originate from a specific virtual network. This configuration hides your app servers on a public network and establishes secure connections between your app servers and Azure Web PubSub.
3333

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Rotate access keys for Azure Web PubSub
2+
title: Rotate access keys
33
description: Learn how and when to rotate Azure Web PubSub access keys by regenerating one key at a time.
44
author: yjin81
55
ms.author: yajin1
@@ -30,18 +30,16 @@ In some scenarios, Azure Web PubSub might enforce a mandatory access key rotatio
3030

3131
1. Go to the Web PubSub instance that has keys you want to rotate.
3232

33-
1. On the resource menu, select **Keys**.
33+
1. On the left menu, select **Keys**.
3434

35-
1. Select **Regenerate Primary Key** or **Regenerate Secondary Key**.
36-
37-
A new key and a corresponding connection string are created. You manage them in your Web PubSub instance.
35+
1. Select **Regenerate Primary Key** or **Regenerate Secondary Key**. A new key and a corresponding connection string are created. You manage them in your Web PubSub instance.
3836

3937
When the Azure Web PubSub service becomes generally available, you can also regenerate a key by using the Azure CLI.
4038

4139
## Update configurations with the new connection string
4240

4341
1. Copy the new connection string.
4442

45-
1. Update all configurations to use the new connection string.
43+
1. Update all existing configurations to use the new connection string.
4644

4745
1. Close the application, and then reopen it.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This article shows you how to configure your Web PubSub resource to send upstrea
2020

2121
This outbound method is subject to the following requirements:
2222

23-
- The network endpoint must be deployed by using Azure App Service or Azure Functions.
23+
- The upstream endpoint must be deployed by using Azure App Service or Azure Functions.
2424
- The Web PubSub resource must be on the Standard tier or the Premium tier.
2525
- An Azure App Service or an Azure Functions resource must be created by choosing a specific tier to create the resource. For more information, see [Use private endpoints for Azure Web App](../app-service/networking/private-endpoint.md).
2626

articles/azure-web-pubsub/howto-use-managed-identity.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Use a managed identity in Azure Web PubSub
2+
title: Use a managed identity
33
description: Learn how managed identities work in Azure Web PubSub and how to use a managed identity in a serverless scenario.
44
author: vicancy
55
ms.service: azure-web-pubsub
@@ -8,7 +8,7 @@ ms.date: 08/16/2024
88
ms.author: lianwei
99
---
1010

11-
# Use a managed identity in Azure Web PubSub
11+
# Use a managed identity
1212

1313
This article shows you how to create and use a managed identity for Azure Web PubSub.
1414

@@ -51,7 +51,7 @@ Azure Web PubSub is a fully managed service, so you can't use a managed identity
5151

5252
1. Add a system-assigned identity or a user-assigned identity.
5353

54-
1. Go to **Configure hub settings** and add or edit an event handler for the network.
54+
1. Go to **Configure hub settings** and add or edit an upstream event handler.
5555

5656
:::image type="content" source="media/howto-use-managed-identity/msi-settings.png" alt-text="Screenshot that shows settings to use on the Configure hub settings pane.":::
5757

-19.6 KB
Loading
-1.35 KB
Loading
237 Bytes
Loading

0 commit comments

Comments
 (0)