Documentation menu

resources

Cognitive Search

Overview

This example defines a Cognitive Search service

Cognitive Search Reference

Key Type Description
name (required) string The name of the Search Service (see how to name)
sku (required) Search Sku Definition The SKU name to use for this Search Service
replica_count (required) number The number of replicas to use (values depend on the sku see chart)
partition_count (required) number The number of partitions to use (values depend on the sku see chart)
keyvault Keyvault The Key Vault configuration (defaults to no keyvault config)
@log_analytics_workspace_name string (reference to a log workspace) The name of the workspace that you want to attach to (defaults to no log integration)
location string Resource Location (defaults to the resource group location)
external bool A reference to an existing Search Service (defaults to false)
resource_group_name string The name of the resource group where the resource is located, only with external resources (defaults to the resource group of the deployment)
tags object Additional tags for the resource (defaults to no additional tags)

Search Service Sku

Value Description
Free Defines a Free service bus
Basic Defines a Basic service bus
StandardOne Defines a StandardOne service bus
StandardTwo Defines a StandardTwo service bus
StandardThree Defines a StandardThree service bus
StorageOptimizedL1 Defines a StorageOptimizedL1 service bus
StorageOptimizedL2 Defines a StorageOptimizedL2 service bus

SKU limits

Value replica partition
Free 0 0
Basic 3 0
StandardOne 12 12
StandardTwo 12 12
StandardThree (hosting_mode: Default) 12 12
StandardThree (hosting_mode: HighDensity) 12 3
StorageOptimizedL1 12 12
StorageOptimizedL2 12 12

Keyvault Config

Key Type Description
@key_vault_name (required) string The name of the Key Vault to use
endpoint string The name to give to the secret of the service endpoint (defaults to SEARCH_SERVICE_NAME-endpoint)
query_key string The name to give to the secret of the Query Key (defaults to SEARCH_SERVICE_NAME-query-key)
admin_key string The name to give to the secret of the Admin Key (defaults to SEARCH_SERVICE_NAME-admin-key)