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-signalr/howto-custom-domain.md
+24-24Lines changed: 24 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,24 +12,24 @@ ms.author: dayshen
12
12
13
13
# Configure a custom domain for Azure SignalR Service
14
14
15
-
In addition to the default domain provided with Azure SignalR Service, you can also add a custom DNS domain to your service. In this article, you learn how to add a custom domain to your Azure SignalR Service resource.
15
+
In addition to the default domain provided with Azure SignalR Service, you can also add a custom Domain Name System (DNS) domain to your service. In this article, you learn how to add a custom domain to your Azure SignalR Service resource.
16
16
17
17
## Prerequisites
18
18
19
-
- A custom domain registered through Azure App Service or a third-party registrar.
19
+
- A custom domain registered through Azure App Service or a non-Microsoft registrar.
20
20
- An Azure account with an active subscription. If you don't have one, you can [create one for free](https://azure.microsoft.com/free/).
21
21
- An Azure resource group.
22
22
- An Azure SignalR Service resource.
23
23
- An Azure Key Vault instance.
24
-
- A custom domain Secure Sockets Layer (SSL) certificate stored in your Key Vault instance. For more information, see [Get started with Key Vault certificates](/azure/key-vault/certificates/certificate-scenarios)
24
+
- A custom domain TLS/SSL certificate stored in your Key Vault instance. For more information, see [Get started with Key Vault certificates](/azure/key-vault/certificates/certificate-scenarios)
25
25
- An Azure DNS zone (optional).
26
26
27
27
## Add a custom certificate
28
28
29
-
Before you can add a custom domain, you need to add a custom SSL certificate. Your Azure SignalR Service resource accesses the certificate stored in your key vault through a managed identity.
29
+
Before you can add a custom domain, you need to add a custom TLS/SSL certificate. Your Azure SignalR Service resource accesses the certificate stored in your key vault through a managed identity.
30
30
31
31
> [!NOTE]
32
-
> Custom domains is a Premium tier feature. Standard tier resources can be upgraded to Premium tier without downtime.
32
+
> The custom domains feature is a Premium tier feature. You can upgrade Standard tier resources to Premium tier without downtime.
33
33
34
34
### Enable managed identity in an Azure SignalR Service
35
35
@@ -49,7 +49,7 @@ After the identity is created, the object (principal) ID appears. Azure SignalR
49
49
50
50
Azure SignalR Service uses a [managed identity](~/articles/active-directory/managed-identities-azure-resources/overview.md) to access your key vault. You must give the managed identity permission to access your key vault.
51
51
52
-
The steps to grant permission depends on whether you selected **Vault access policy** or **Azure role-based access control** as your key vault permission model.
52
+
The steps to grant permission depend on whether you selected **Vault access policy** or **Azure role-based access control** as your key vault permission model.
@@ -86,7 +86,7 @@ When you use the Azure role-based access control permission model, follow this p
86
86
87
87
:::image type="content" alt-text="Screenshot that shows Azure role-based access control selected as the vault permission model." source="media/howto-custom-domain/portal-key-vault-perm-model-rbac.png" :::
88
88
89
-
1. Go to your key vault resource.
89
+
1. Go to your Key Vault resource.
90
90
1. On the menu on the left, select **Access control (IAM)**.
91
91
1. Select **Add** > **Add role assignment**.
92
92
@@ -97,66 +97,66 @@ When you use the Azure role-based access control permission model, follow this p
97
97
:::image type="content" alt-text="Screenshot that shows the Role tab when you add a role assignment to Key Vault." source="media/howto-custom-domain/portal-key-vault-role.png" :::
98
98
99
99
1. On the **Members** tab, under **Assign access to**, select **Managed identity**.
100
-
1.Select**+Select members**. The **Select members** pane opens on the right.
101
-
1. Search for the Azure SignalR Service resource name or the user-assigned identity name. Select**Select**.
100
+
1.Choose**+Select members** to open the **Select managed identities** pane.
101
+
1. Search for the Azure SignalR Service resource name or the user-assigned identity name. Choose**Select**.
102
102
103
103
:::image type="content" alt-text="Screenshot that shows the Members tab when you add a role assignment to Key Vault." source="media/howto-custom-domain/portal-key-vault-members.png" :::
104
104
105
105
1. Select **Review + assign**.
106
106
107
107
-----
108
108
109
-
### Add a custom certificate to your Azure SignalR Service
109
+
### Add a custom certificate to your Azure SignalR Service resource
110
110
111
-
To add the custom certificate to your Azure SignalR Service, follow these steps:
111
+
To add the custom certificate to your Azure SignalR Service resource, follow these steps:
112
112
113
113
1. In the Azure portal, go to your Azure SignalR Service resource.
114
-
1. On the menu pane, select **Custom domain**.
114
+
1. On the menu on the left, select **Custom domain**.
115
115
1. Under **Custom certificate**, select **Add**.
116
116
117
117
:::image type="content" alt-text="Screenshot that shows custom certificate management." source="media/howto-custom-domain/portal-custom-certificate-management.png" :::
118
118
119
119
1. Enter a name of the custom certificate.
120
-
1. To choose a key vault certificate, choose **Select from your Key Vault**. After your selection, **Key Vault Base URI** and **Key Vault Secret Name** fill automatically. Alternatively, fill in the fields manually.
121
-
1. Optionally, you can specify a **Key Vault Secret Version** if you want to pin the certificate to a specific version.
120
+
1. To choose a Key Vault certificate, choose **Select from your Key Vault**. After you make your selection, **Key Vault Base URI** and **Key Vault Secret Name** fill automatically. Alternatively, fill in the fields manually.
121
+
1. Optionally, you can specify a value for **Key Vault Secret Version** if you want to pin the certificate to a specific version.
122
122
1. Select **Add**.
123
123
124
124
:::image type="content" alt-text="Screenshot that shows adding a custom certificate." source="media/howto-custom-domain/portal-custom-certificate-add.png" :::
125
125
126
-
The Azure SignalR Service fetches the certificate and validates its content. When it succeeds, **Provisioning State** shows **Succeeded** for the certificate.
126
+
Azure SignalR Service fetches the certificate and validates its content. When it succeeds, **Provisioning State** shows **Succeeded** for the certificate.
127
127
128
128
:::image type="content" alt-text="Screenshot that shows an added custom certificate." source="media/howto-custom-domain/portal-custom-certificate-added.png" :::
129
129
130
130
## Create a custom domain CNAME record
131
131
132
-
You must create a CNAME record for your custom domain in an Azure DNS zone or with your third-party registrar service. The CNAME record creates an alias from your custom domain to the default domain of Azure SignalR Service. The Azure SignalR Service uses the record to validate the ownership of your custom domain.
132
+
You must create a CNAME record for your custom domain in an Azure DNS zone or with your non-Microsoft registrar service. The CNAME record creates an alias from your custom domain to the default domain of Azure SignalR Service. Azure SignalR Service uses the record to validate the ownership of your custom domain.
133
133
134
-
For example, if your default domain is `contoso.service.signalr.net` and your custom domain is `contoso.example.com`, you need to create a CNAME record on `example.com`.
134
+
For example, if your default domain is `contoso.service.signalr.net` and your custom domain is `contoso.example.com`, you need to create a CNAME record on `example.com`.
135
135
136
136
After you create the CNAME record, you can perform a DNS lookup to see the CNAME information. In the example, the output from the `linux dig` (DNS lookup) command looks similar to this output:
137
137
138
138
```
139
139
contoso.example.com. 0 IN CNAME contoso.service.signalr.net.
140
140
```
141
141
142
-
If you're using Azure DNS zone, see [Manage DNS records](~/articles/dns/dns-operations-recordsets-portal.md) to learn how to add a CNAME record.
142
+
If you're using an Azure DNS zone, see [Manage DNS records](~/articles/dns/dns-operations-recordsets-portal.md) to learn how to add a CNAME record.
143
143
144
-
:::image type="content" alt-text="Screenshot that shows adding a CNAME record in Azure DNS zone." source="media/howto-custom-domain/portal-dns-cname.png" :::
144
+
:::image type="content" alt-text="Screenshot that shows adding a CNAME record in an Azure DNS zone." source="media/howto-custom-domain/portal-dns-cname.png" :::
145
145
146
146
If you're using other DNS providers, follow the provider's guide to create a CNAME record.
147
147
148
148
## Add a custom domain
149
149
150
-
Now add the custom domain to your Azure SignalR Service.
150
+
Now add the custom domain to your Azure SignalR Service resource.
151
151
152
152
1. In the Azure portal, go to your Azure SignalR Service resource.
153
-
1. On the menu, select **Custom domain**.
153
+
1. On the menu on the left, select **Custom domain**.
154
154
1. Under **Custom domain**, select **Add**.
155
155
156
156
:::image type="content" alt-text="Screenshot that shows custom domain management." source="media/howto-custom-domain/portal-custom-domain-management.png" :::
157
157
158
158
1. Enter a name for the custom domain.
159
-
1. Enter the full domain name of your custom domain. For example, use `contoso.com`.
159
+
1. Enter the full domain name of your custom domain. For example, use **contoso.com**.
160
160
1. Select a custom certificate that applies to this custom domain.
161
161
1. Select **Add**.
162
162
@@ -200,7 +200,7 @@ It should return the `200` status code without any certificate error.
200
200
201
201
If you configured a [private endpoint](../private-link/private-endpoint-overview.md) to your key vault, Azure SignalR Service can't access your key vault via a public network. You can give Azure SignalR Service access to your key vault through a private network by creating a [shared private endpoint](./howto-shared-private-endpoints-key-vault.md).
202
202
203
-
After you create a shared private endpoint, add a custom certificate. For instructions, see [Add a custom certificate to Azure SignalR Service](#add-a-custom-certificate-to-your-azure-signalr-service).
203
+
After you create a shared private endpoint, add a custom certificate. For more information, see [Add a custom certificate to Azure SignalR Service](#add-a-custom-certificate-to-your-azure-signalr-service).
204
204
205
205
>[!IMPORTANT]
206
206
>You don't have to change the domain in your key vault URI. For example, if your key vault base URI is `https://contoso.vault.azure.net`, you use this URI to configure a custom certificate.
@@ -218,7 +218,7 @@ Alternatively, you can pin a custom certificate to a specific secret version in
218
218
If you don't plan to use the resources you created in this article, you can delete the resource group.
219
219
220
220
>[!CAUTION]
221
-
> Deleting the resource group deletes all resources contained within it. If resources outside the scope of this article exist in the specified resource group, they're' also deleted.
221
+
> Deleting the resource group deletes all resources contained within it. If resources outside the scope of this article exist in the specified resource group, they're also deleted.
0 commit comments