Azure Search

Installation

Install provider

Please install the package from nuget:

dotnet add package Bielu.Examine.AzureSearch

Disclaimer: This package is not yet available on nuget, but it will be available soon. For testing Please build it from source after making sure that it is tagged as packable in csproj file.

Add registration

After installation, you need to add registration of the package to your Program.cs file:

First find

.AddBieluExamineForUmbraco()

Extend it by Fluent Configuration in following way

    .AddBieluExamineForUmbraco(bieluExamineConfigurator =>
    {
        bieluExamineConfigurator.AddAzureSearchServices();
    })

Default Recommended configuration

For Local development

Please use following configuration for local development

{
  "bielu": {
    "Examine": {
      "Enabled": true,
      "AzureSearch": {
        "DevMode": true,
        "DefaultIndexConfiguration": {
          "Name": "ExternalIndex",
          "ConnectionString": "http://localhost:9200",
          "AuthenticationType": "None"
        },
        "IndexConfigurations": [
          {
            "Name": "ExternalIndex"
          },
          {
            "Name": "InternalIndex"
          },
          {
            "Name": "MembersIndex"
          },
          {
            "Name": "DeliveryApiContentIndex"
          }
        ]
      }
    }
  }
}

Configuration schema

This schema correspond to configuration for elasticsearch. It is possible to configure elasticsearch for each index separately or use shared configuration for all indexes.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "BieluExamineElasticsearchConfigurationBieluExamineAzureSearchOptions",
  "type": "object",
  "properties": {
    "DevMode": {
      "type": "boolean"
    },
    "IndexConfigurations": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "null"
          },
          {
            "$ref": "#/definitions/BieluExamineElasticsearchConfigurationIndexConfiguration"
          }
        ]
      }
    },
    "DefaultIndexConfiguration": {
      "$ref": "#/definitions/BieluExamineElasticsearchConfigurationIndexConfiguration"
    }
  },
  "definitions": {
    "BieluExamineElasticsearchConfigurationIndexConfiguration": {
      "type": "object",
      "properties": {
        "Name": {
          "type": "string"
        },
        "Analyzer": {
          "type": "string"
        },
        "OverrideClientConfiguration": {
          "type": "boolean"
        },
        "AuthenticationDetails": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/definitions/BieluExamineElasticsearchConfigurationAuthenticationDetails"
            }
          ]
        },
        "Prefix": {
          "type": "string"
        }
      }
    },
    "BieluExamineElasticsearchConfigurationAuthenticationDetails": {
      "type": "object",
      "properties": {
        "Username": {
          "type": "string"
        },
        "Password": {
          "type": "string"
        },
        "ApiKey": {
          "type": "string"
        },
        "Id": {
          "type": "string"
        }
      }
    }
  }
}

Last modified: 17 March 2024