Skip to content

Commit 77cfe2a

Browse files
committed
freshness review for remaining articles
1 parent f762c41 commit 77cfe2a

File tree

9 files changed

+55
-158
lines changed

9 files changed

+55
-158
lines changed

articles/azure-web-pubsub/LocalFunctionProj/LocalFunctionProj/.vscode/extensions.json

Lines changed: 0 additions & 5 deletions
This file was deleted.

articles/azure-web-pubsub/LocalFunctionProj/LocalFunctionProj/HttpExample/function.json

Lines changed: 0 additions & 19 deletions
This file was deleted.

articles/azure-web-pubsub/LocalFunctionProj/LocalFunctionProj/HttpExample/run.ps1

Lines changed: 0 additions & 25 deletions
This file was deleted.

articles/azure-web-pubsub/LocalFunctionProj/LocalFunctionProj/host.json

Lines changed: 0 additions & 18 deletions
This file was deleted.

articles/azure-web-pubsub/LocalFunctionProj/LocalFunctionProj/profile.ps1

Lines changed: 0 additions & 22 deletions
This file was deleted.

articles/azure-web-pubsub/LocalFunctionProj/LocalFunctionProj/requirements.psd1

Lines changed: 0 additions & 8 deletions
This file was deleted.

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

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.author: dayshen
1111

1212
# Configure a custom domain for Azure Web PubSub Service
1313

14-
In addition to the default domain provided by the Azure Web PubSub Service, you can also add a custom domains. A custom domain is a domain name that you own and manage. You can use a custom domain to access your Azure Web PubSub Service resource. For example, you can use `contoso.example.com` instead of `contoso.webpubsub.azure.com` to access your Azure Web PubSub Service resource.
14+
In addition to the default domain provided by the Azure Web PubSub Service, you can also add a custom domain. A custom domain is a domain name that you own and manage. You can use a custom domain to access your Azure Web PubSub Service resource. For example, you can use `contoso.example.com` instead of `contoso.webpubsub.azure.com` to access your Azure Web PubSub Service resource.
1515

1616
## Prerequisites
1717

@@ -35,15 +35,14 @@ Azure Web PubSub Service uses Managed Identity to access your Key Vault. In orde
3535
1. Select **On**.
3636
1. Select **Yes** to confirm.
3737
1. Select **Save**.
38+
:::image type="content" alt-text="Screenshot of enabling system assigned managed identity." source="media\howto-custom-domain\portal-identity.png" :::
39+
3840
1. To add a User assigned identity;
39-
1. Click **Add user assigned managed identity**.
41+
1. Select **Add user assigned managed identity**.
4042
1. Select an existing identity.
4143
1. Select **Add**.
4244

43-
:::image type="content" alt-text="Screenshot of enabling managed identity." source="media\howto-custom-domain\portal-identity.png" :::
44-
1. Turn on either **System assigned** or **User assigned** identity. Click **Save**.
45-
46-
:::image type="content" alt-text="Screenshot of enabling managed identity." source="media\howto-custom-domain\portal-identity.png" :::
45+
1. Select **Save**.
4746

4847
Depending on how you configure your Key Vault permission model, you may need to grant permissions at different places.
4948

@@ -58,7 +57,7 @@ If you're using Key Vault built-in access policy as Key Vault permission model:
5857
1. Select **Vault access policy**.
5958
1. Select **Go to access policies**.
6059
1. Select **Create**.
61-
1. Select **Secret Get** permission .
60+
1. Select **Secret Get** permission.
6261
1. Select **Certificate Get** permission.
6362
1. Select **Next**.
6463

@@ -79,40 +78,41 @@ If you're using Azure role-based access control as Key Vault permission model:
7978
:::image type="content" alt-text="Screenshot of Azure RBAC selected as Key Vault permission model." source="media\howto-custom-domain\portal-key-vault-perm-model-rbac.png" :::
8079

8180
1. Go to your Key Vault resource.
82-
1. Select **Access configuration** from the menu.
83-
1. Select **go to access control (IAM)**.
84-
1. Click **Add**. Select **Add role assignment**.
81+
1. Select **Go to access control (IAM)** from the menu.
82+
1. Select **Add**, then select **Add role assignment** fro the drop-down.
8583

8684
:::image type="content" alt-text="Screenshot of Key Vault IAM." source="media\howto-custom-domain\portal-key-vault-iam.png" :::
8785

88-
1. Under the **Role** tab, select **Key Vault Secrets User**. Click **Next**.
86+
1. Under the **Role** tab, select **Key Vault Secrets User**. Select **Next**.
8987

9088
:::image type="content" alt-text="Screenshot of role tab when adding role assignment to Key Vault." source="media\howto-custom-domain\portal-key-vault-role.png" :::
9189

92-
1. Under the **Members** tab, select **Managed identity**. 1. Search for the Azure Web PubSub Service resource name or the user assigned identity name. Click **Next**.
90+
1. Under the **Members** tab, select **Managed identity**.
91+
1. Search for and **Select** the Azure Web PubSub Service resource name or the user assigned identity name.
9392

9493
:::image type="content" alt-text="Screenshot of members tab when adding role assignment to Key Vault." source="media\howto-custom-domain\portal-key-vault-members.png" :::
9594

96-
1. Click **Review + assign**.
95+
1. Select **Next**.
96+
1. Select **Review + assign**.
9797

9898
-----
9999

100100
### Step 2: Create a custom certificate
101101

102102
1. In the Azure portal, go to your Azure Web PubSub Service resource.
103103
1. In the menu pane, select **Custom domain**.
104-
1. Under **Custom certificate**, click **Add**.
104+
1. In the **Custom certificate** section, select **Add**.
105105

106106
:::image type="content" alt-text="Screenshot of custom certificate management." source="media\howto-custom-domain\portal-custom-certificate-management.png" :::
107107

108108
1. Fill in a name for the custom certificate.
109-
1. Click **Select from your Key Vault** to choose a Key Vault certificate. After selection the following **Key Vault Base URI**, **Key Vault Secret Name** should be automatically filled. Alternatively you can also fill in these fields manually.
109+
1. Select **Select from your Key Vault** to choose a Key Vault certificate. After selection the following **Key Vault Base URI**, the **Key Vault Secret Name** will be automatically filled in. Alternatively you can also fill in these fields manually.
110110
1. Optionally, you can specify a **Key Vault Secret Version** if you want to pin the certificate to a specific version.
111-
1. Click **Add**.
111+
1. Select **Add**.
112112

113113
:::image type="content" alt-text="Screenshot of adding a custom certificate." source="media\howto-custom-domain\portal-custom-certificate-add.png" :::
114114

115-
Azure Web PubSub Service will then fetch the certificate and validate its content. If everything is good, the **Provisioning State** will be **Succeeded**.
115+
Azure Web PubSub Service fetches the certificate and validates its contents. the validation succeeds, the **Provisioning State** is **Succeeded**.
116116

117117
:::image type="content" alt-text="Screenshot of an added custom certificate." source="media\howto-custom-domain\portal-custom-certificate-added.png" :::
118118

@@ -122,11 +122,11 @@ To validate the ownership of your custom domain, you need to create a CNAME reco
122122

123123
For example, if your default domain is `contoso.webpubsub.azure.com`, and your custom domain is `contoso.example.com`, you need to create a CNAME record on `example.com` like:
124124

125-
```
125+
```plaintext
126126
contoso.example.com. 0 IN CNAME contoso.webpubsub.azure.com.
127127
```
128128

129-
If you're using Azure DNS Zone, see [manage DNS records](../dns/dns-operations-recordsets-portal.md) for how to add a CNAME record.
129+
If you're using Azure DNS Zone, see [manage DNS records](../dns/dns-operations-recordsets-portal.md) to learn how to add a CNAME record.
130130

131131
:::image type="content" alt-text="Screenshot of adding a CNAME record in Azure DNS Zone." source="media\howto-custom-domain\portal-dns-cname.png" :::
132132

@@ -138,14 +138,14 @@ A custom domain is another sub resource of your Azure Web PubSub Service. It con
138138

139139
1. In the Azure portal, go to your Azure Web PubSub Service resource.
140140
1. In the menu pane, select **Custom domain**.
141-
1. Under **Custom domain**, click **Add**.
141+
1. Under **Custom domain**, select **Add**.
142142

143143
:::image type="content" alt-text="Screenshot of custom domain management." source="media\howto-custom-domain\portal-custom-domain-management.png" :::
144144

145-
1. Fill in a name for the custom domain. It's the sub resource name.
146-
1. Fill in the domain name. It's the full domain name of your custom domain, for example, `contoso.com`.
145+
1. Enter a name for the custom domain. It's the sub resource name.
146+
1. Enter the domain name. It's the full domain name of your custom domain, for example, `contoso.com`.
147147
1. Select a custom certificate that applies to this custom domain.
148-
1. Click **Add**.
148+
1. Select **Add**.
149149

150150
:::image type="content" alt-text="Screenshot of adding a custom domain." source="media\howto-custom-domain\portal-custom-domain-add.png" :::
151151

@@ -184,18 +184,18 @@ $ curl -vvv https://contoso.example.com/api/health
184184

185185
-----
186186

187-
It should return `200` status code without any certificate error.
187+
The health API should return `200` status code without any certificate error.
188188

189189
## Key Vault in private network
190190

191-
If you have configured [Private Endpoint](../private-link/private-endpoint-overview.md) to your Key Vault, Azure Web PubSub Service cannot access the Key Vault via public network. You need to set up a shared private endpoint](./howto-secure-shared-private-endpoints-key-vault.md) to let Azure Web PubSub Service access your Key Vault via private network.
191+
If you've configured a [Private Endpoint](../private-link/private-endpoint-overview.md) to your Key Vault, Azure Web PubSub Service can't access the Key Vault via public network. You need to set up a [shared private endpoint](./howto-secure-shared-private-endpoints-key-vault.md) to let Azure Web PubSub Service access your Key Vault via private network.
192192

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

195195
You don't have to explicitly allow Azure Web PubSub Service IPs in Key Vault firewall settings. For more info, see [Key Vault private link diagnostics](../key-vault/general/private-link-diagnostics.md).
196196

197197
## Next steps
198198

199-
+ [How to enable managed identity for Azure Web PubSub Service](howto-use-managed-identity.md)
200-
+ [Get started with Key Vault certificates](../key-vault/certificates/certificate-scenarios.md)
201-
+ [What is Azure DNS](../dns/dns-overview.md)
199+
* [How to enable managed identity for Azure Web PubSub Service](howto-use-managed-identity.md)
200+
* [Get started with Key Vault certificates](../key-vault/certificates/certificate-scenarios.md)
201+
* [What is Azure DNS](../dns/dns-overview.md)

0 commit comments

Comments
 (0)