Kentico.Xperience.AzureSearch 2.1.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

dotnet add package Kentico.Xperience.AzureSearch --version 2.1.0

NuGet\Install-Package Kentico.Xperience.AzureSearch -Version 2.1.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Kentico.Xperience.AzureSearch" Version="2.1.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Kentico.Xperience.AzureSearch --version 2.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Kentico.Xperience.AzureSearch, 2.1.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install Kentico.Xperience.AzureSearch as a Cake Addin
#addin nuget:?package=Kentico.Xperience.AzureSearch&version=2.1.0

// Install Kentico.Xperience.AzureSearch as a Cake Tool
#tool nuget:?package=Kentico.Xperience.AzureSearch&version=2.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Xperience by Kentico Azure Search

Description

This integration enables you to create AzureSearch search indexes to index content of pages (content types with the 'Page' feature enabled) from the Xperience content tree using a code-first approach. To provide a search interface for the indexed content, developers can use the .NET API, JavaScript API library.

Library Version Matrix

Xperience Version	Library Version
>= 29.0.0	>= 2.1.0
>= 28.2.0	>= 1.0.0

Dependencies

Package Installation

Add the package to your application using the .NET CLI

dotnet add package Kentico.Xperience.AzureSearch

Quick Start

Add configuration from your Azure portal to the ASP.NET Core appsettings.json file:

"CMSAzureSearch": {
    "SearchServiceEndPoint": "<your application url>",
    "SearchServiceAdminApiKey": "<your application admin key>",
    "SearchServiceQueryApiKey": "<your application query key>"
}

Define a custom BaseAzureSearchIndexingStrategy<TSearchModel> implementation to customize how content pages/content items are processed for the index. See Custom-index-strategy.md

Add this library to the application services, registering your custom BaseAzureSearchIndexingStrategy with type parameter GlobalSearchModel and Azure search services

// Program.cs
services.AddKenticoAzureSearch(builder =>
 {
     builder.RegisterStrategy<GlobalAzureSearchStrategy, GlobalSearchModel>("DefaultStrategy");
 }, configuration);

Create an index in Xperience's Administration within the Search application added by this library.
Rebuild the index in Xperience's Administration within the Search application added by this library.
Display the results on your site with a Razor View 👍.

Use DancingGoat sample

You can restore database with configured samples. View DancingGoat Sample Database.

Full Instructions

View the Usage Guide for more detailed instructions.

Contributing

To see the guidelines for Contributing to Kentico open source software, please see Kentico's CONTRIBUTING.md for more information and follow the Kentico's CODE_OF_CONDUCT.

Instructions and technical details for contributing to this project can be found in Contributing Setup.

License

Distributed under the MIT License. See LICENSE.md for more information.

Support

This project has Full support by 7-day bug-fix policy.

See SUPPORT.md for more information.

For any security issues see SECURITY.md.

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.