Authenticate a managed identity with Azure Active Directory to access Azure Relay resources
Managed identities for Azure resources is a cross-Azure feature that enables you to create a secure identity associated with the deployment under which your application code runs. You can then associate that identity with access-control roles that grant custom permissions for accessing specific Azure resources that your application needs.
With managed identities, the Azure platform manages this runtime identity. You don't need to store and protect access keys in your application code or configuration, either for the identity itself, or for the resources you need to access. A Relay client app running inside an Azure App Service application or in a virtual machine with enabled managed entities for Azure resources support doesn't need to handle SAS rules and keys, or any other access tokens. The client app only needs the endpoint address of the Relay namespace. When the app connects, Relay binds the managed entity's context to the client in an operation that is shown in an example later in this article. Once it's associated with a managed identity, your Relay client can do all authorized operations. Authorization is granted by associating a managed entity with Relay roles.
This feature is generally available in all regions except Microsoft Azure operated by 21Vianet (Azure China).
When a security principal (a user, group, application) attempts to access a Relay entity, the request must be authorized. With Azure AD, access to a resource is a two-step process.
- First, the security principal’s identity is authenticated, and an OAuth 2.0 token is returned. The resource name to request a token is
https://relay.azure.net. If an application is running within an Azure entity such as an Azure VM, a virtual machine scale set, or an Azure Function app, it can use a managed identity to access the resources.
- Next, the token is passed as part of a request to the Relay service to authorize access to the specified resource (hybrid connections, WCF relays). Azure Active Directory (Azure AD) authorizes access rights to secured resources through Azure role-based access control (Azure RBAC). Azure Relay defines a set of Azure built-in roles that encompass common sets of permissions used to access Relay entities. You can also define custom roles for accessing the data. For a list of built-in roles supported by Azure Relay, see Azure Built-in roles for Azure Relay. Native applications and web applications that make requests to Relay can also authorize with Azure AD.
Azure built-in roles for Azure Relay
For Azure Relay, the management of namespaces and all related resources through the Azure portal and the Azure resource management API is already protected using the Azure RBAC model. Azure provides the below Azure built-in roles for authorizing access to a Relay namespace:
|Azure Relay Owner||Use this role to grant full access to Azure Relay resources.|
|Azure Relay Listener||Use this role to grant listen and entity read access to Azure Relay resources.|
|Azure Relay Sender||Use this role to grant send and entity read access to Azure Relay resources.|
Before you assign an Azure role to a security principal, determine the scope of access that the security principal should have. Best practices dictate that it's always best to grant only the narrowest possible scope.
The following list describes the levels at which you can scope access to Azure Relay resources, starting with the narrowest scope:
- Relay entities: Role assignment applies to a specific Relay entity like a hybrid connection or a WCF relay.
- Relay namespace: Role assignment applies to all the Relay entities under the namespace.
- Resource group: Role assignment applies to all the Relay resources under the resource group.
- Subscription: Role assignment applies to all the Relay resources in all of the resource groups in the subscription.
Keep in mind that Azure role assignments may take up to five minutes to propagate. For more information about how built-in roles are defined, see Understand role definitions. For information about creating Azure custom roles, see Azure custom roles.
Enable managed identity
First, enable managed identity for the Azure resource that needs to access Azure Relay entities (hybrid connections or WCF relays). For an example, if your Relay client application is running on an Azure VM, enable managed identity for the VM by following instructions from the Configure managed identity for an Azure VM article. Once you've enabled this setting, a new managed service identity is created in your Azure Active Directory (Azure AD).
For a list of services that support managed identities, see Services that support managed identities for Azure resources.
Assign an Azure Relay role to the managed identity
After you enable the managed identity, assign one of the Azure Relay roles (Azure Relay Owner, Azure Relay Listener, or Azure Relay Sender) to the identity at the appropriate scope. When the Azure role is assigned to a managed identity, the managed identity is granted access to Relay entities at the appropriate scope.
The following section uses a simple application that runs under a managed identity on an Azure VM instance and accesses Relay resources.
Sample app on VM accessing Relay entities
Download the Hybrid Connections sample console application to your computer from GitHub.
Create an Azure VM. For this sample, use a Windows 10 image.
Enable system-assigned identity or a user-assigned identity for the Azure VM. For instructions, see Enable identity for a VM.
Assign one of the Relay roles to the managed service identity at the desired scope (Relay entity, Relay namespace, resource group, subscription). For detailed steps, see Assign Azure roles using the Azure portal.
Build the console app locally on your local computer as per instructions from the README document.
Copy the executable under <your local path>\RoleBasedAccessControl\bin\Debug folder to the VM. You can use RDP to connect to your Azure VM. For more information, see How to connect and sign on to an Azure virtual machine running Windows.
Run RoleBasedAccessControl.exe on the Azure VM as per instructions from the README document.
Follow the same steps above to run the console application for WCF Relays.
Highlighted code from the sample
Here's the code from the sample that shows how to use Azure AD authentication to connect to the Azure Relay service.
Create a TokenProvider object by using the
- If you are using a system-assigned managed identity:
- If you are using a user-assigned managed identity, get the Client ID for the user-assigned identity from the Managed Identity page in the Azure portal. For instructions, see List user-assigned managed identities.
var managedCredential = new ManagedIdentityCredential(clientId); tokenProvider = TokenProvider.CreateManagedIdentityTokenProvider(managedCredential);
- If you are using a system-assigned managed identity:
var listener = new HybridConnectionListener(hybridConnectionUri, tokenProvider);
var sender = new HybridConnectionClient(hybridConnectionUri, tokenProvider);
To learn more about Azure Relay, see the following topics.