Skip to content
ExamineX
These docs are for ExamineX 11 · Umbraco 19 (pre-release). For the current release see ExamineX 6–10 · Umbraco 13–18.

Installation

Install and upgrade is done via dotnet CLI:

dotnet add package ExamineX.AzureSearch.Umbraco

You will then need to enter a couple configuration settings. Then you’ll need to enable the integration in your Program.cs and add the .AddExamineXAzureSearch() call after the .AddComposers() call:

builder.CreateUmbracoBuilder()
.AddBackOffice()
.AddWebsite()
.AddDeliveryApi()
.AddComposers()
.AddExamineXAzureSearch()
.Build();

Using Managed Identity / Token-based authentication

Section titled “Using Managed Identity / Token-based authentication”

If you need to authenticate using Azure Managed Identity instead of an API key, install the Azure.Identity package and pass your TokenCredential when registering ExamineX:

dotnet add package Azure.Identity
using Azure.Identity;
builder.CreateUmbracoBuilder()
.AddBackOffice()
.AddWebsite()
.AddDeliveryApi()
.AddComposers()
.AddExamineXAzureSearch(options =>
{
options.TokenCredential = new ManagedIdentityCredential();
})
.Build();

See the Configuration docs for more details on token-based authentication and required Azure RBAC roles.

Umbraco 19 indexes content with Umbraco Search and its Examine search provider. ExamineX replaces that provider’s Lucene indexes with Azure AI Search indexes, so the Umbraco Search APIs, the backoffice search and the Delivery API all use Azure AI Search. Umbraco 19 has 5 indexes: Umb_Content, Umb_PublishedContent, Umb_Media, Umb_Members and Umb_Elements, see Index and field names. Rebuilds use ExamineX’s own zero downtime rebuilds, so Umbraco’s ZeroDowntimeIndexing setting is turned off.

You can also use Azure AI Search for some indexes and Elasticsearch for others, see Using both products together. See Known limitations for what isn’t supported yet.

You can take advantage of Azure Search features and have all of your PDFs and other Office documents automatically indexed into the Umbraco media index (Umb_Media).

See the ExamineX for Azure Search & Blob Media docs for installation and usage details.

If you are using Umbraco Forms then you may also need the ExamineX.AzureSearch.Umbraco.Forms package.

See the ExamineX for Azure Search & Forms docs for installation and usage details.

See Licensing for more information about the types of licenses and what the limitations are without a license.