Installation

• .NET 8+
• Umbraco version 13.1.0+
• Azure Cognitive Search subscription (minimum Free tier if only working with 3 indexes)
• Umbraco Forms (if applicable) version 13.0.0+

• .NET 5+
• Umbraco version 9.0.0+
• Azure Cognitive Search subscription (minimum Free tier if only working with 3 indexes)
• Umbraco Forms (if applicable) version 12.1.2+

• .NET Framework 4.7.2
• Umbraco version 8.4.0+
• Azure Cognitive Search subscription (minimum Free tier if only working with 3 indexes)
• Umbraco Forms (if applicable) version 8.4.0+

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

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.

Install and upgrade is done via dotnet CLI:

dotnet add package ExamineX.AzureSearch.Umbraco

You will then need to enter a couple configuration settings. Once installed ExamineX will be automatically enabled.

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.

Install and upgrade is done via nuget:

PM> Install-Package ExamineX.AzureSearch.Umbraco

You will then need to enter a couple configuration settings. Once installed ExamineX will be automatically enabled.

Plugins

If you are using the UmbracoFileSystemProviders.Azure then you can take advantage of having your PDFs and other Office documents automatically indexed into the Umbraco content indexes (i.e. Internal and External indexes). With UmbracoFileSystemProviders.Azure configured, you can install this package to enable media document indexing:

PM> Install-Package ExamineX.AzureSearch.Umbraco.BlobMedia

See the Media guide for more details.

If you are using Umbraco Forms then you will also need:

PM> Install-Package ExamineX.AzureSearch.Umbraco.Forms

If you are using UmbracoExamine.PDF then you will also need:

PM> Install-Package ExamineX.AzureSearch.Umbraco.PDF