| title | titleSuffix | description | services | author | ms.service | ms.custom | ms.topic | ms.date | ms.author |
|---|---|---|---|---|---|---|---|---|---|
Use private endpoints |
Azure SignalR Service |
Overview of private endpoints for secure access to Azure SignalR Service from virtual networks. |
signalr |
vicancy |
azure-signalr-service |
devx-track-azurecli |
how-to |
12/09/2022 |
lianwei |
You can use private endpoints for your Azure SignalR Service to allow clients on a virtual network (VNet) to securely access data over a Private Link. The private endpoint uses an IP address from the VNet address space for your Azure SignalR Service. Network traffic between the clients on the VNet and Azure SignalR Service traverses over a private link on the Microsoft backbone network, eliminating exposure from the public internet.
Using private endpoints for your Azure SignalR Service enables you to:
- Secure your Azure SignalR Service using the network access control to block all connections on the public endpoint for Azure SignalR Service.
- Increase security for the virtual network (VNet) by enabling you to block the exfiltration of data from the VNet.
- Securely connect to Azure SignalR Services from on-premises networks that connect to the VNet using VPN or ExpressRoutes with private-peering.
This article shows you how to use private endpoints for your Azure SignalR Service.
A private endpoint is a special network interface for an Azure service in your Virtual Network (VNet). When you create a private endpoint for your Azure SignalR Service, it provides secure connectivity between clients on your VNet and your service. The private endpoint is assigned an IP address from the IP address range of your VNet. The connection between the private endpoint and Azure SignalR Service uses a secure private link.
Applications in the VNet can connect to Azure SignalR Service over the private endpoint seamlessly, using the same connection strings and authorization mechanisms that they would use otherwise. Private endpoints can be used with all protocols supported by the Azure SignalR Service, including REST API.
When you create a private endpoint for an Azure SignalR Service in your VNet, a consent request is sent for approval to the Azure SignalR Service owner. If the user requesting the creation of the private endpoint is also an owner of the Azure SignalR Service, this consent request is automatically approved.
Azure SignalR Service owners can manage consent requests and the private endpoints, through the 'Private endpoints' tab for the Azure SignalR Service in the Azure portal.
Tip
If you want to restrict access to your Azure SignalR Service through the private endpoint only, configure the Network Access Control to deny or control access through the public endpoint.
Clients on a VNet using the private endpoint should use the same connection string for the Azure SignalR Service, as clients connecting to the public endpoint. We rely upon DNS resolution to automatically route the connections from the VNet to Azure SignalR Service over a private link.
Important
Use the same connection string to connect to Azure SignalR Service using private endpoints, as you'd use otherwise. Please don't connect to Azure SignalR Service using its privatelink subdomain URL.
We create a private DNS zone attached to the VNet with the necessary updates for the private endpoints, by default. However, if you're using your own DNS server, you may need to make other changes to your DNS configuration. The section DNS changes for private endpoints describes the updates required for private endpoints.
When you create a private endpoint, the DNS CNAME resource record for your Azure SignalR Service is updated to an alias in a subdomain with the prefix privatelink. By default, we also create a private DNS zone, corresponding to the privatelink subdomain, with the DNS A resource records for the private endpoints.
When you resolve your Azure SignalR Service domain name from outside the VNet with the private endpoint, it resolves to the public endpoint of the Azure SignalR Service. When resolved from the VNet hosting the private endpoint, the domain name resolves to the private endpoint's IP address.
In the illustrated example, the DNS resource records for the Azure SignalR Service 'foobar', when resolved from outside the VNet hosting the private endpoint, will be:
| Name | Type | Value |
|---|---|---|
foobar.service.signalr.net |
CNAME | foobar.privatelink.service.signalr.net |
foobar.privatelink.service.signalr.net |
A | <Azure SignalR Service public IP address> |
As previously mentioned, you can deny or control access for clients outside the VNet through the public endpoint using the network access control.
The DNS resource records for 'foobar', when resolved by a client in the VNet hosting the private endpoint, will be:
| Name | Type | Value |
|---|---|---|
foobar.service.signalr.net |
CNAME | foobar.privatelink.service.signalr.net |
foobar.privatelink.service.signalr.net |
A | 10.1.1.5 |
This approach enables access to Azure SignalR Service using the same connection string for clients on the VNet hosting the private endpoints and clients outside the VNet.
If you're using a custom DNS server on your network, clients must be able to resolve the FQDN for the Azure SignalR Service endpoint to the private endpoint IP address. You should configure your DNS server to delegate your private link subdomain to the private DNS zone for the VNet, or configure the A records for foobar.privatelink.service.signalr.net with the private endpoint IP address.
Tip
When using a custom or on-premises DNS server, you should configure your DNS server to resolve the Azure SignalR Service name in the privatelink subdomain to the private endpoint IP address. You can do this by delegating the privatelink subdomain to the private DNS zone of the VNet, or configuring the DNS zone on your DNS server and adding the DNS A records.
The recommended DNS zone name for private endpoints for Azure SignalR Service is: privatelink.service.signalr.net.
For more information on configuring your own DNS server to support private endpoints, see the following articles:
-
When creating a new Azure SignalR Service, select Networking tab. Choose Private endpoint as connectivity method.
-
Select Add. Fill in subscription, resource group, location, name for the new private endpoint. Choose a virtual network and subnet.
-
Select Review + create.
-
Go to the Azure SignalR Service.
-
Select on the settings menu called Private endpoint connections.
-
Select the button + Private endpoint on the top.
-
Enter subscription, resource group, resource name and region for the new private endpoint.
-
Choose target Azure SignalR Service resource.
-
Choose target virtual network
-
Select Review + create.
- Log in to Azure CLI
az login - Set your Azure Subscription
az account set --subscription {AZURE SUBSCRIPTION ID} - Create a new Resource Group
az group create -n {RG} -l {AZURE REGION} - Register Microsoft.SignalRService as a provider
az provider register -n Microsoft.SignalRService - Create a new Azure SignalR Service
az signalr create --name {NAME} --resource-group {RG} --location {AZURE REGION} --sku Standard_S1 - Create a Virtual Network
az network vnet create --resource-group {RG} --name {vNet NAME} --location {AZURE REGION} - Add a subnet
az network vnet subnet create --resource-group {RG} --vnet-name {vNet NAME} --name {subnet NAME} --address-prefixes {addressPrefix} - Disable Virtual Network Policies
az network vnet subnet update --name {subnet NAME} --resource-group {RG} --vnet-name {vNet NAME} --disable-private-endpoint-network-policies true - Add a Private DNS Zone
az network private-dns zone create --resource-group {RG} --name privatelink.service.signalr.net - Link Private DNS Zone to Virtual Network
az network private-dns link vnet create --resource-group {RG} --virtual-network {vNet NAME} --zone-name privatelink.service.signalr.net --name {dnsZoneLinkName} --registration-enabled true - Create a Private Endpoint (Automatically Approve)
az network private-endpoint create --resource-group {RG} --vnet-name {vNet NAME} --subnet {subnet NAME} --name {Private Endpoint Name} --private-connection-resource-id "/subscriptions/{AZURE SUBSCRIPTION ID}/resourceGroups/{RG}/providers/Microsoft.SignalRService/SignalR/{NAME}" --group-ids signalr --connection-name {Private Link Connection Name} --location {AZURE REGION} - Create a Private Endpoint (Manually Request Approval)
az network private-endpoint create --resource-group {RG} --vnet-name {vNet NAME} --subnet {subnet NAME} --name {Private Endpoint Name} --private-connection-resource-id "/subscriptions/{AZURE SUBSCRIPTION ID}/resourceGroups/{RG}/providers/Microsoft.SignalRService/SignalR/{NAME}" --group-ids signalr --connection-name {Private Link Connection Name} --location {AZURE REGION} --manual-request - Show Connection Status
az network private-endpoint show --resource-group {RG} --name {Private Endpoint Name}
For pricing details, see Azure Private Link pricing.
Keep in mind the following known issues about private endpoints for Azure SignalR Service
You can't create any private endpoint for free tier Azure SignalR Service.
Clients in VNets with existing private endpoints face constraints when accessing other Azure SignalR Service instances that have private endpoints. For example:
- When VNet N1 has a private endpoint for an Azure SignalR Service instance S1
- If Azure SignalR Service S2 has a private endpoint in a VNet N2, the clients in VNet N1 must also access Azure SignalR Service S2 using a private endpoint.
- If Azure SignalR Service S2 doesn't have any private endpoints, the clients in VNet N1 can access Azure SignalR Service in that account without a private endpoint.
This constraint is a result of the DNS changes made when Azure SignalR Service S2 creates a private endpoint.