Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
For your Agentic Retrieval deployment, register an application, create app roles, and assign users or groups in Microsoft Entra ID. This article is part of the deployment prerequisites checklist and also a prerequisite of Quickstart: Install Agentic Retrieval.
You might need to work with your Microsoft Entra or cloud administrator to configure authentication.
Important
Agentic Retrieval in Foundry Local is currently in PREVIEW. See the Supplemental Terms of Use for Microsoft Azure Previews for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
Prerequisites
Before you begin, make sure you have:
- An active Azure subscription. If you don't have a service subscription, create a free account before you begin.
- Microsoft Entra ID permissions:
- Permissions to create a Microsoft Enterprise Entra application.
- Ability to add new or existing Microsoft Entra users and groups to the application.
Register an application in Microsoft Entra ID
Create and configure an application registration for Agentic Retrieval in your Microsoft Entra ID tenant.
In the Azure portal, go to Microsoft Entra ID.
Go to the appropriate tenant and select Manage > App registrations.
Select New registration to create an application registration.
Enter EdgeRAG for Name.
Select Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant).
Select Register.
After the application is registered, go to the registration and select Manage > Authentication.
Select Add a platform > Single-page application.
Specify your domain name (for example,
https://arcrag.contoso.com/) as the Redirect URIs.Select Configure.
For Supported account types, select Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant).
Select + Add a platform > Mobile and desktop applications.
For Redirect URIs, select
https://login.microsoftonline.com/common/oauth2/nativeclient.Select Configure.
Create app roles for Agentic Retrieval
Within the Agentic Retrieval app registration, create app roles for AI application developers and end users of the chat endpoint.
In the app registration, on the left-hand side menu, under Manage, select App roles.
Create two app roles. One for EdgeRAGDeveloper and another for EdgeRAGEndUser. Use the appropriate values listed in the table that follows the image.
Field Value Display name EdgeRAGDeveloper or EdgeRAGEndUser Allowed member types User/Groups Value EdgeRAGDeveloper or EdgeRAGEndUser Description EdgeRAGDeveloper or EdgeRAGEndUser Do you want to enable this app role? Checked When complete, close the App roles page.
Assign users or groups to roles
Next, in the Microsoft Entra ID tenant, assign users or groups to the roles you created for Agentic Retrieval.
- In the Microsoft Entra ID tenant, on the left-hand side menu under Manage, select Enterprise applications.
- Search for and select the EdgeRag application you created.
- Go to Manage > Properties.
- Disable Assignment Required.
- On the left-hand side menu, select Users and groups > Add user/group.
- Select users and groups and assign the EdgeRAGDeveloper or EdgeRAGEndUser role as appropriate. Assign both roles to the developers working on the chat solution.
- When complete, close the Users and groups page.
Create app roles for collection access
The EdgeRAGEndUser role alone doesn't grant query access. Each end user also needs an app role whose Value exactly matches each collection name they can query.
Start with the default edgeragapp collection that's created when you deploy the extension. If you don't specify a collection during ingestion, data is ingested into edgeragapp. After deployment, create and assign one matching app role for each additional collection you add.
Create and assign collection app roles for edgeragapp and every additional collection before end users query data. Data ingestion succeeds without these roles, but queries fail with 403 Forbidden.
Create a collection app role
In the Azure portal, go to Microsoft Entra ID > App registrations and select your Agents and Tools app registration.
On the left-hand side menu, under Manage, select App roles.
Select Create app role.
Create an app role for the default
edgeragappcollection or a collection you create after you install the extension. Use the following values:Field Value Display name A descriptive name (for example, Default Collection or Finance Docs Collection) Allowed member types Users/Groups Value The exact collection name. For the default collection, use edgeragapp. This value must match the collection name used in the API.Description Description of the collection access (for example, Grants query access to the default edgeragapp collection) Do you want to enable this app role? Checked Select Apply.
After deployment, if you create additional collections, repeat these steps for each collection (for example,
finance-docs).
Assign users to collection app roles
- In the Microsoft Entra ID tenant, on the left-hand side menu under Manage, select Enterprise applications.
- Search for and select the EdgeRag application.
- On the left-hand side menu, select Users and groups > Add user/group.
- Select the users or groups who need access to the collection.
- Select the collection app role (for example,
edgeragappfor the default collection). - Complete the assignment.
Example
The following table shows an example of collection app role assignments:
| Collection name | App role value | Assigned users |
|---|---|---|
edgeragapp |
edgeragapp |
All chat end users |
finance-docs |
finance-docs |
Finance team |
hr-data |
hr-data |
HR team |
At query time, a user querying edgeragapp must have the edgeragapp app role in their token. The same rule applies to each additional collection (for example, finance-docs). Otherwise, the request is denied with 403 Forbidden.
For more information about how collections use RBAC, see Collections and RBAC.
(Optional) Register a Foundry Local application
If you use Foundry Local as your model endpoint, you need a second app registration to identify the Foundry inference service. This registration provides the foundryClientId value used for managed identity token scope (<client_id>/.default).
| App registration | Purpose | Key value |
|---|---|---|
| Agents and Tools app (EdgeRAG) | Identifies the Agents and Tools extension for Microsoft Entra authentication (JWT validation on external endpoints). | auth.clientId - passed to the Agents and Tools extension. |
| Foundry Local app | Identifies the Foundry inference service. Used as the managed identity token audience scope. | foundryClientId - passed to the inference operator and Agents and Tools extension. |
For instructions on creating the Foundry Local app registration, see Configure authentication for Foundry Local.
Important
foundryClientId and byom-api-key are mutually exclusive. When foundryClientId is set, Agents and Tools uses managed identity token authentication exclusively. No API key secret is needed, and if one exists it's ignored. When foundryClientId is not set, a byom-api-key Kubernetes secret is required. Choose one authentication method per deployment.
After you deploy the extension, configure Foundry Local managed identity role assignments. For steps, see Configure Foundry Local inference authentication for Agentic Retrieval.
(Optional) Get app and tenant IDs
If you plan to use the quickstart or want to deploy Agentic Retrieval by using the command line, get the application ID for the registration you created and the tenant ID.
- In the Azure portal, search for app registration.
- Select the Agentic Retrieval registration you created.
- Copy the Application (client) ID and Directory (tenant) ID.
- Paste the values to an app like Windows Notepad to use later.