Installation

Minimum requirements

Each major version of ExamineX supports one major version of Umbraco:

ExamineX.AzureSearch.UmbracoPackage	.NET	Umbraco	Umbraco Forms (if used)
10.x	10	18.0.2+	18.0.4+
9.x	10	17.0.0+	17.0.1+
8.x	9	16.0.0+	16.0.0+
7.x	9	15.x	15.x
6.x	8	13.1.0+	13.0.0+

You’ll also need:

• Azure Cognitive Search subscription (minimum Basic tier, the Free tier’s 3 index limit is less than the number of indexes Umbraco creates, see Azure Search Limits)

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 Startup.cs and add the .AddExamineXAzureSearch() call after the .AddComposers() call:

public void ConfigureServices(IServiceCollection services)
{
    services.AddUmbraco(_env, _config)
        .AddBackOffice()
        .AddWebsite()
        .AddDeliveryApi()
        .AddComposers()
        .AddExamineXAzureSearch()
        .Build();
}

Using Managed Identity / Token-based authentication

Available from ExamineX 6.1.9, 7.0.6, 8.0.5 and 9.0.3, and in every 10.x release.

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;

public void ConfigureServices(IServiceCollection services)
{
    services.AddUmbraco(_env, _config)
        .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.

Plugins

Media

You can take advantage of Azure Search features and have all of your PDFs and other Office documents automatically indexed into the Umbraco content indexes (i.e. Internal and External indexes).

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

Forms

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.