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-custom-domain.md
+28-28Lines changed: 28 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ ms.author: dayshen
11
11
12
12
# Configure a custom domain for Azure Web PubSub Service
13
13
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.
15
15
16
16
## Prerequisites
17
17
@@ -35,15 +35,14 @@ Azure Web PubSub Service uses Managed Identity to access your Key Vault. In orde
35
35
1. Select **On**.
36
36
1. Select **Yes** to confirm.
37
37
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
+
38
40
1. To add a User assigned identity;
39
-
1.Click**Add user assigned managed identity**.
41
+
1.Select**Add user assigned managed identity**.
40
42
1. Select an existing identity.
41
43
1. Select **Add**.
42
44
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**.
47
46
48
47
Depending on how you configure your Key Vault permission model, you may need to grant permissions at different places.
49
48
@@ -58,7 +57,7 @@ If you're using Key Vault built-in access policy as Key Vault permission model:
58
57
1. Select **Vault access policy**.
59
58
1. Select **Go to access policies**.
60
59
1. Select **Create**.
61
-
1. Select **Secret Get** permission.
60
+
1. Select **Secret Get** permission.
62
61
1. Select **Certificate Get** permission.
63
62
1. Select **Next**.
64
63
@@ -79,40 +78,41 @@ If you're using Azure role-based access control as Key Vault permission model:
79
78
:::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" :::
80
79
81
80
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.
85
83
86
84
:::image type="content" alt-text="Screenshot of Key Vault IAM." source="media\howto-custom-domain\portal-key-vault-iam.png" :::
87
85
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**.
89
87
90
88
:::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" :::
91
89
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.
93
92
94
93
:::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" :::
95
94
96
-
1. Click **Review + assign**.
95
+
1. Select **Next**.
96
+
1. Select **Review + assign**.
97
97
98
98
-----
99
99
100
100
### Step 2: Create a custom certificate
101
101
102
102
1. In the Azure portal, go to your Azure Web PubSub Service resource.
103
103
1. In the menu pane, select **Custom domain**.
104
-
1.Under **Custom certificate**, click**Add**.
104
+
1.In the **Custom certificate** section, select**Add**.
105
105
106
106
:::image type="content" alt-text="Screenshot of custom certificate management." source="media\howto-custom-domain\portal-custom-certificate-management.png" :::
107
107
108
108
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.
110
110
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**.
112
112
113
113
:::image type="content" alt-text="Screenshot of adding a custom certificate." source="media\howto-custom-domain\portal-custom-certificate-add.png" :::
114
114
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**.
116
116
117
117
:::image type="content" alt-text="Screenshot of an added custom certificate." source="media\howto-custom-domain\portal-custom-certificate-added.png" :::
118
118
@@ -122,11 +122,11 @@ To validate the ownership of your custom domain, you need to create a CNAME reco
122
122
123
123
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:
124
124
125
-
```
125
+
```plaintext
126
126
contoso.example.com. 0 IN CNAME contoso.webpubsub.azure.com.
127
127
```
128
128
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.
130
130
131
131
:::image type="content" alt-text="Screenshot of adding a CNAME record in Azure DNS Zone." source="media\howto-custom-domain\portal-dns-cname.png" :::
132
132
@@ -138,14 +138,14 @@ A custom domain is another sub resource of your Azure Web PubSub Service. It con
138
138
139
139
1. In the Azure portal, go to your Azure Web PubSub Service resource.
140
140
1. In the menu pane, select **Custom domain**.
141
-
1. Under **Custom domain**, click**Add**.
141
+
1. Under **Custom domain**, select**Add**.
142
142
143
143
:::image type="content" alt-text="Screenshot of custom domain management." source="media\howto-custom-domain\portal-custom-domain-management.png" :::
144
144
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`.
147
147
1. Select a custom certificate that applies to this custom domain.
148
-
1.Click**Add**.
148
+
1.Select**Add**.
149
149
150
150
:::image type="content" alt-text="Screenshot of adding a custom domain." source="media\howto-custom-domain\portal-custom-domain-add.png" :::
It should return `200` status code without any certificate error.
187
+
The health API should return `200` status code without any certificate error.
188
188
189
189
## Key Vault in private network
190
190
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.
192
192
193
193
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.
194
194
195
195
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).
196
196
197
197
## Next steps
198
198
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)
0 commit comments