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
+20-17Lines changed: 20 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,37 +36,40 @@ To configure a custom domain, you need to:
36
36
37
37
## Add a custom certificate
38
38
39
-
Before you can add a custom domain, you need to add a custom SSL certificate. Your SignalR Service accesses the certificate stored in Key Vault through a managed identity.
39
+
Before you can add a custom domain, you need to add a custom SSL certificate. Your SignalR Service accesses the certificate stored in your key vault through a managed identity.
40
40
41
41
There are three steps to adding a domain certificate.
42
42
43
43
1. Enable managed identity in your SignalR Service.
44
-
1. Give the managed identity access to your Key Vault.
44
+
1. Give the managed identity access to your key vault.
45
45
1. Add a custom certificate to your SignalR Service.
46
46
47
47
### Enable managed identity in SignalR Service
48
48
49
-
You can use either system-assigned or user-assigned managed identity. This article demonstrates using a system-assign managed identity.
49
+
You can use either a system-assigned or user-assigned managed identity. This article demonstrates using a system-assigned managed identity.
50
50
51
51
1. In the Azure portal, go to your SignalR service resource.
52
52
1. Select **Identity** from the menu on the left.
53
53
1. On the **System assigned** table, set **Status** to **On**.
54
54
55
55
:::image type="content" alt-text="Screenshot of enabling managed identity." source="media/howto-custom-domain/portal-identity.png" :::
56
56
57
-
1. Select **Save**, and then select **Yes** when prompted to enable systemassigned managed identity.
57
+
1. Select **Save**, and then select **Yes** when prompted to enable system-assigned managed identity.
58
58
59
-
When the configuration is complete, the screen will show an **Object (principal) ID**. The object ID is the ID of the system-assigned managed identity SignalR Service will use to access the Key Vault. The name of the managed identity is the same as the name of the SignalR Service instance. In the next section, you'll need to search for the principal (managed identity) using the name or Object ID.
59
+
Once the identity is created, the **Object (principal) ID** is displayed. SignalR Service will use the object ID of the system-assigned managed identity to access the key vault. The name of the managed identity is the same as the name of the SignalR Service instance. In the next section, you'll need to search for the principal (managed identity) using the name or Object ID.
60
60
61
-
### Give the managed identity access to Key Vault
62
61
63
-
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. The way you grant permission depends on your Key Vault permission model.
62
+
### Give the managed identity access to your key vault
63
+
64
+
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.
65
+
66
+
The steps to grant permission depends whether you selected *vault access policy* or *Azure role-based access control* as your key vault permission model.
If you're using **Vault access policy** as the Key Vault permission model, follow this procedure to add a new access policy.
70
+
If you're using **Vault access policy** as your key vault permission model, follow this procedure to add a new access policy.
68
71
69
-
1. Go to your Key Vault resource.
72
+
1. Go to your key vault resource.
70
73
1. Select **Access policies** from the menu on the left.
71
74
1. Select **Create**.
72
75
:::image type="content" source="media/howto-custom-domain/portal-key-vault-access-policies.png" alt-text="Screenshot of Key Vault's access policy page.":::
@@ -95,7 +98,7 @@ When using the **Azure role-based access control** permission model, follow this
95
98
96
99
:::image type="content" alt-text="Screenshot of Azure role-based access control selected as the vault permission model." source="media/howto-custom-domain/portal-key-vault-perm-model-rbac.png" :::
97
100
98
-
1. Go to your Key Vault resource.
101
+
1. Go to your key vault resource.
99
102
1. In the menu on the left, select **Access control (IAM)**.
100
103
1. Select **Add**. Select **Add role assignment**.
101
104
@@ -126,7 +129,7 @@ Use the following steps to add the custom certificate to your SignalR Service:
126
129
:::image type="content" alt-text="Screenshot of custom certificate management." source="media/howto-custom-domain/portal-custom-certificate-management.png" :::
127
130
128
131
1. Enter a name of the custom certificate.
129
-
1. Select **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.
132
+
1. Select **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.
130
133
1. Optionally, you can specify a **Key Vault Secret Version** if you want to pin the certificate to a specific version.
131
134
1. Select **Add**.
132
135
@@ -153,7 +156,7 @@ If you're using Azure DNS Zone, see [manage DNS records](~/articles/dns/dns-oper
153
156
154
157
:::image type="content" alt-text="Screenshot of adding a CNAME record in Azure DNS Zone." source="media/howto-custom-domain/portal-dns-cname.png" :::
155
158
156
-
If you're using other DNS providers, follow provider's guide to create a CNAME record.
159
+
If you're using other DNS providers, follow the provider's guide to create a CNAME record.
157
160
158
161
## Add a custom domain
159
162
@@ -165,8 +168,8 @@ Now add the custom domain to your SignalR Service.
165
168
166
169
:::image type="content" alt-text="Screenshot of custom domain management." source="media/howto-custom-domain/portal-custom-domain-management.png" :::
167
170
168
-
1.Fill in a name for the custom domain.
169
-
1.Fill in the full domain name of your custom domain, for example, `contoso.com`.
171
+
1.Enter a name for the custom domain.
172
+
1.Enter the full domain name of your custom domain, for example, `contoso.com`.
170
173
1. Select a custom certificate that applies to this custom domain.
171
174
1. Select **Add**.
172
175
@@ -208,14 +211,14 @@ It should return `200` status code without any certificate error.
208
211
209
212
## Access Key Vault in private network
210
213
211
-
If you've configured a [Private Endpoint](../private-link/private-endpoint-overview.md) to your Key Vault, your SignalR Service won't be able to access the Key Vault via a public network. You can give your SignalR Service access to your Key Vault through a private network by creating a [Shared Private Endpoint](./howto-shared-private-endpoints-key-vault.md).
214
+
If you've configured a [Private Endpoint](../private-link/private-endpoint-overview.md) to your key vault, your SignalR Service won't be able to access your key vault via a public network. You can give your SignalR Service access to your key vault through a private network by creating a [Shared Private Endpoint](./howto-shared-private-endpoints-key-vault.md).
212
215
213
216
After you create a Shared Private Endpoint, you can add a custom certificate as described in the [Add a custom certificate to your SignalR Service](#add-a-custom-certificate-to-your-signalr-service) section above.
214
217
215
218
>[!IMPORTANT]
216
-
>**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`, you'll use this URI to configure a custom certificate.
219
+
>**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'll use this URI to configure a custom certificate.
217
220
218
-
You don't have to explicitly allow SignalR Service IP addresses in Key Vault firewall settings. For more info, see [Key Vault private link diagnostics](../key-vault/general/private-link-diagnostics.md).
221
+
You don't have to explicitly allow SignalR Service IP addresses in key vault firewall settings. For more info, see [Key Vault private link diagnostics](../key-vault/general/private-link-diagnostics.md).
0 commit comments