Службы поиска Microsoft.Search

Определение ресурсов Bicep

Тип ресурса searchServices можно развернуть с помощью операций, целевых:

Список измененных свойств в каждой версии API см. в журнала изменений.

Примеры использования

Примеры Bicep

Простой пример развертывания службы поиска.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource searchService 'Microsoft.Search/searchServices@2022-09-01' = {
  name: resourceName
  location: location
  sku: {
    name: 'standard'
  }
  properties: {
    authOptions: {
      apiKeyOnly: {}
    }
    disableLocalAuth: false
    encryptionWithCmk: {
      enforcement: 'Disabled'
    }
    hostingMode: 'default'
    networkRuleSet: {
      ipRules: []
    }
    partitionCount: 1
    publicNetworkAccess: 'Enabled'
    replicaCount: 1
  }
  tags: {
    environment: 'staging'
  }
}

Проверенные модули Azure

Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.

Модуль Описание
службы поиска Модуль ресурсов AVM для службы поиска

Примеры быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.

Bicep-файл Описание
Ограниченная сеть Azure AI Foundry В этом наборе шаблонов показано, как настроить Azure AI Foundry с отключенным приватным каналом и исходящим трафиком, используя ключи, управляемые корпорацией Майкрософт, для шифрования и конфигурацию удостоверений, управляемую корпорацией Майкрософт для ресурса ИИ.
службы когнитивного поиска Azure Этот шаблон создает службу Когнитивного поиска Azure
агент с управляемым удостоверением пользователя Этот набор шаблонов демонстрирует настройку службы агента ИИ Azure с изоляцией виртуальной сети с помощью проверки подлинности управляемого удостоверения пользователей для подключения службы ИИ/AOAI и частных сетевых каналов для подключения агента к защищенным данным.
настройка стандартного агента В этом наборе шаблонов показано, как настроить службу агента ИИ Azure со стандартной настройкой, то есть с проверкой подлинности управляемого удостоверения для подключений к проекту или концентратору и общедоступного доступа к Интернету. Агенты используют ресурсы поиска и хранилища с одним клиентом. С помощью этой настройки вы можете полностью контролировать и просматривать эти ресурсы, но вы будете нести расходы на основе использования.

Формат ресурса

Чтобы создать ресурс Microsoft.Search/searchServices, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.Search/searchServices@2026-09-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    authOptions: {
      aadOrApiKey: {
        aadAuthFailureMode: 'string'
      }
      apiKeyOnly: any(...)
    }
    autoGeneratedDomainNameLabelScope: 'string'
    computeType: 'string'
    dataExfiltrationProtections: [
      'string'
    ]
    disableLocalAuth: bool
    encryptionWithCmk: {
      enforcement: 'string'
      serviceLevelEncryptionKey: {
        accessCredentials: {
          applicationId: 'string'
          applicationSecret: 'string'
        }
        identity: {
          @odata.type: 'string'
          // For remaining properties, see DataIdentity objects
        }
        keyVaultKeyName: 'string'
        keyVaultKeyVersion: 'string'
        keyVaultUri: 'string'
      }
    }
    endpoint: 'string'
    hostingMode: 'string'
    knowledgeRetrieval: 'string'
    networkRuleSet: {
      bypass: 'string'
      ipRules: [
        {
          value: 'string'
        }
      ]
    }
    partitionCount: int
    publicNetworkAccess: 'string'
    replicaCount: int
    semanticSearch: 'string'
    upgradeAvailable: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Объекты DataIdentity

Задайте свойство @odata.type, чтобы указать тип объекта.

Для #Microsoft.Azure.Search.DataNoneIdentity используйте:

{
  @odata.type: '#Microsoft.Azure.Search.DataNoneIdentity'
}

Для #Microsoft.Azure.Search.DataUserAssignedIdentity используйте:

{
  @odata.type: '#Microsoft.Azure.Search.DataUserAssignedIdentity'
  federatedIdentityClientId: 'string'
  userAssignedIdentity: 'string'
}

Значения свойств

Microsoft.Search/searchServices

Имя Описание Ценность
тождество Удостоверение ресурса. удостоверения
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
имя Имя ресурса string

Ограничения целостности:
Pattern = ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ (обязательно)
свойства Свойства службы поиска. SearchServiceProperties (Свойства SearchService)
SKU SKU службы поиска, которая определяет ценовую категорию и ограничения емкости. Это свойство необходимо при создании новой службы поиска. SKU
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

AzureActiveDirectoryApplicationCredentials

Имя Описание Ценность
applicationId ID приложения (клиента) регистрации приложения в арендаторе. струна
applicationSecret Секрет клиента AAD, сгенерированный для регистрации приложения, использовался для аутентификации с Azure Key Vault. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

Идентификация данных

Имя Описание Ценность
@odata.type Задайте значение "#Microsoft.Azure.Search.DataNoneIdentity" для типа DataNoneIdentity. Задайте значение "#Microsoft.Azure.Search.DataUserAssignedIdentity" для типа DataUserAssignedIdentity. '#Microsoft.Azure.Search.DataNoneIdentity'
"#Microsoft.Azure.Search.DataUserAssignedIdentity" (обязательно)

ДанныеНеидентификация

Имя Описание Ценность
@odata.type Фрагмент URI, указывающий тип удостоверения. "#Microsoft.Azure.Search.DataNoneIdentity" (обязательно)

DataPlaneAadOrApiKeyAuthOption

Имя Описание Ценность
aadAuthFailureMode Описывает, какой ответ БУДЕТ отправлять API плоскости данных службы поиска для запросов, которые не удалось выполнить проверку подлинности. "http401WithBearerChallenge"
"http403"

Параметры DataPlaneAuthOptions

Имя Описание Ценность
aadOrApiKey Указывает, что для проверки подлинности можно использовать ключ API или маркер доступа из клиента идентификатора Microsoft Entra ID. DataPlaneAadOrApiKeyAuthOption
apiKeyOnly Указывает, что для проверки подлинности можно использовать только ключ API. любой

Идентификатор DataUserAssignedIdentity

Имя Описание Ценность
@odata.type Фрагмент URI, указывающий тип удостоверения. "#Microsoft.Azure.Search.DataUserAssignedIdentity" (обязательно)
federatedIdentityClientId Опционально для поддержки CMK User-Assigned многоарендовательного управляемой идентичности: идентификатор клиента (в виде UUID) многоарендовантной регистрации приложения, настроенного для федерации с userAssignedIdentity. струна
userAssignedIdentity Полный идентификатор ресурса Azure управляемого удостоверения, назначенного пользователем, обычно в форме "/subscriptions/12345678-1234-1234-123467890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", который должен быть назначен службе поиска. строка (обязательно)

EncryptionWithCmk (ШифрованиеWithCmk)

Имя Описание Ценность
принуждение Описывает, как служба поиска должна обеспечить соответствие требованиям, если он находит объекты, которые не шифруются с помощью ключа, управляемого клиентом. "Отключено"
"Включено"
"Не указано"
serviceLevelEncryptionKey Описывает конфигурацию ключа, управляемую клиентом, для шифрования поисковой службы. SearchResourceEncryptionKey

Тождество

Имя Описание Ценность
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как удостоверение, созданное системой, так и набор назначенных пользователем удостоверений. Тип "Нет" приведет к удалению всех удостоверений из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned (обязательно)
ИдентичностиНазначенныеПользователем Список удостоверений пользователей, связанных с ресурсом. Ключевые ссылки на словарь удостоверений пользователей будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Имя Описание Ценность

Правило IpRule

Имя Описание Ценность
ценность Значение, соответствующее одному IPv4-адресу (например, 123.1.2.3) или диапазону IP-адресов в формате CIDR (например, 123.1.2.3/24). струна

Набор сетевых правил

Имя Описание Ценность
обходить Возможные источники входящего трафика, которые могут обойти правила, определенные в разделе ipRules. AzurePortal
AzureServices
"Нет"
ipRules Список правил ограничения IP-адресов, определяющих входящие сети с разрешением доступа к конечной точке службы поиска. В то же время все остальные общедоступные IP-сети блокируются брандмауэром. Эти правила ограничения применяются только в том случае, если функция publicNetworkAccess службы поиска включена; в противном случае трафик через общедоступный интерфейс не допускается даже с любыми правилами общедоступного IP-адреса, а подключения к частной конечной точке — монопольным методом доступа. Правило IpRule[]

SearchResourceEncryptionKey (Ключ шифрования)

Имя Описание Ценность
Учетные данные доступа Необязательные учетные данные Azure Active Directory, используемые для доступа к Azure Key Vault. Не требуется, если вместо этого используется управляемое удостоверение. AzureActiveDirectoryApplicationCredentials
тождество Явное управляемое удостоверение, используемое для этого ключа шифрования. Если не указано, а свойство учетных данных доступа равно NULL, используется управляемое удостоверение, назначаемое системой. При обновлении ресурса, если явное удостоверение не указано, оно остается неизменным. Если задано значение none, то значение этого свойства очищается. Идентификация данных
keyVaultKeyName Имя ключа Azure Key Vault, используемого для шифрования неактивных данных. струна
keyVaultKeyVersion Версия ключа Azure Key Vault, используемая для шифрования неактивных данных. струна
keyVaultUri Универсальный код ресурса (URI) Хранилища ключей Azure, который также называется DNS-именем, который содержит ключ, используемый для шифрования неактивных данных. Пример URI может быть https://my-keyvault-name.vault.azure.net. струна

SearchServiceProperties (Свойства SearchService)

Имя Описание Ценность
Параметры authOptions Определяет параметры того, как API плоскости данных службы поиска выполняет проверку подлинности запросов. Это невозможно задать, если параметр disableLocalAuth имеет значение true. Параметры DataPlaneAuthOptions
autoGeneratedDomainNameLabelScope Определяет уровень повторного использования автоматически сгенерированной метки доменного имени для поискового сервиса (например, myservice-uniqueId.search.windows.net<>). Если не указано, автоматически сгенерированная метка доменного имени для поиска не создаётся. NoReuse
SubscriptionReuse
"TenantReuse"
computeType Настройте это свойство для поддержки службы поиска с помощью вычислений по умолчанию или конфиденциальных вычислений Azure. "Конфиденциальный"
По умолчанию
dataExfiltrationProtections Список сценариев кражи данных, которые явно запрещены для службы поиска. В настоящее время единственным поддерживаемым значением является "Все", чтобы отключить все возможные сценарии экспорта данных с более точными элементами управления, запланированными в будущем. Массив строк, содержащий любой из:
«БлокВсе»
disableLocalAuth Если задано значение true, вызовы службы поиска не будут разрешены использовать ключи API для проверки подлинности. Это не может быть задано значение true, если определен параметр dataPlaneAuthOptions. булевая переменная (bool)
encryptionWithCmk Указывает любую политику шифрования ресурсов (таких как индексы) с помощью ключей диспетчера клиентов в службе поиска. EncryptionWithCmk (ШифрованиеWithCmk)
конечная точка Конечная точка службы поиска ИИ Azure. струна
hostingMode Применимо только для номера SKU standard3. Это свойство можно настроить для включения до 3 секций высокой плотности, которые позволяют до 1000 индексов, что гораздо выше, чем максимальные индексы, разрешенные для любого другого номера SKU. Для номера SKU standard3 используется значение "Default" или "HighDensity". Для всех остальных номеров SKU это значение должно быть "Default". По умолчанию
«Высокая плотность»
knowledgeRetrieval Указывает план выставления счетов для агентного поиска в сервисе Поиск с использованием ИИ Azure. Эта конфигурация доступна только для определённых уровней ценообразования в определённых регионах. "бесплатный"
"Стандартный"
набор правил networkRuleSet Правила конкретной сети, определяющие, как может быть достигнута служба поиска ИИ Azure. Набор сетевых правил
Количество разделов Количество разделов в выделенном поисковом сервисе; если указано, это может быть 1, 2, 3, 4, 6 или 12. Значения, превышающие 1, допустимы только для стандартных номеров SKU. Для служб "standard3" с параметром hostingMode задано значение highDensity, допустимые значения имеют значение от 1 до 3. int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 12
доступ к публичной сети Для этого значения можно установить значение "Включено", чтобы избежать критических изменений на существующих клиентских ресурсах и шаблонах. Если установлено значение «Отключено», трафик через публичный интерфейс не разрешен, а подключения к частным конечным точкам будут эксклюзивным методом доступа. "Отключено"
"Включено"
«ЗащищеноПоПериметру»
репликаCount Количество реплик в специализированном поисковом сервисе. Если задано, оно должно быть значением от 1 до 12 включительно для стандартных номеров SKU или от 1 до 3 включительно для базового номера SKU. int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 12
семантический поиск Указывает доступность и план оплаты для семантического поиска в сервисе Поиск с использованием ИИ Azure. Эта конфигурация доступна только для определённых уровней ценообразования в определённых регионах. "отключено"
"бесплатный"
"Стандартный"
upgradeДоступно Указывает, доступна ли служба поиска обновление. "доступно"
«Недоступно»

Артикул

Имя Описание Ценность
имя Номер SKU службы поиска. Допустимые значения: "бесплатный": общая служба. "базовый": выделенная служба с 3 репликами. "Стандартный": выделенная служба с 12 секциями и 12 репликами. "standard2": аналогично стандарту, но с большей емкостью на единицу поиска. "Standard3": наибольшее стандартное предложение с до 12 секций и 12 реплик (или до 3 секций с большим количеством индексов, если свойство hostingMode также имеет значение highDensity). "storage_optimized_l1": поддерживает 1TB на секцию до 12 секций. 'storage_optimized_l2': поддерживает 2 ТБ на раздел, до 12 разделов. 'serverless': уровень без сервера с возможностью автомасштабирования. "базовый"
"бесплатный"
«Без сервера»
"Стандартный"
"Standard2"
"Standard3"
"storage_optimized_l1"
"storage_optimized_l2"

Отслеживаемые Ресурсные Теги

Имя Описание Ценность

Пользовательская назначенная идентичность

Имя Описание Ценность

Определение ресурса шаблона ARM

Тип ресурса searchServices можно развернуть с помощью операций, целевых:

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Шаблон Описание
Ограниченная сеть Azure AI Foundry

развертывание в Azure
В этом наборе шаблонов показано, как настроить Azure AI Foundry с отключенным приватным каналом и исходящим трафиком, используя ключи, управляемые корпорацией Майкрософт, для шифрования и конфигурацию удостоверений, управляемую корпорацией Майкрософт для ресурса ИИ.
службы когнитивного поиска Azure

развертывание в Azure
Этот шаблон создает службу Когнитивного поиска Azure
Службе Когнитивного поиска Azure с частной конечной точкой

развертывание в Azure
Этот шаблон создает службу Когнитивного поиска Azure с частной конечной точкой.
агент с управляемым удостоверением пользователя

развертывание в Azure
Этот набор шаблонов демонстрирует настройку службы агента ИИ Azure с изоляцией виртуальной сети с помощью проверки подлинности управляемого удостоверения пользователей для подключения службы ИИ/AOAI и частных сетевых каналов для подключения агента к защищенным данным.
настройка стандартного агента

развертывание в Azure
В этом наборе шаблонов показано, как настроить службу агента ИИ Azure со стандартной настройкой, то есть с проверкой подлинности управляемого удостоверения для подключений к проекту или концентратору и общедоступного доступа к Интернету. Агенты используют ресурсы поиска и хранилища с одним клиентом. С помощью этой настройки вы можете полностью контролировать и просматривать эти ресурсы, но вы будете нести расходы на основе использования.
веб-приложение с базой данных SQL, Azure Cosmos DB, поиском Azure

развертывание в Azure
Этот шаблон подготавливает веб-приложение, базу данных SQL, Azure Cosmos DB, поиск Azure и Application Insights.

Формат ресурса

Чтобы создать ресурс Microsoft.Search/searchServices, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.Search/searchServices",
  "apiVersion": "2026-09-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "string"
      },
      "apiKeyOnly": {}
    },
    "autoGeneratedDomainNameLabelScope": "string",
    "computeType": "string",
    "dataExfiltrationProtections": [ "string" ],
    "disableLocalAuth": "bool",
    "encryptionWithCmk": {
      "enforcement": "string",
      "serviceLevelEncryptionKey": {
        "accessCredentials": {
          "applicationId": "string",
          "applicationSecret": "string"
        },
        "identity": {
          "@odata.type": "string"
          // For remaining properties, see DataIdentity objects
        },
        "keyVaultKeyName": "string",
        "keyVaultKeyVersion": "string",
        "keyVaultUri": "string"
      }
    },
    "endpoint": "string",
    "hostingMode": "string",
    "knowledgeRetrieval": "string",
    "networkRuleSet": {
      "bypass": "string",
      "ipRules": [
        {
          "value": "string"
        }
      ]
    },
    "partitionCount": "int",
    "publicNetworkAccess": "string",
    "replicaCount": "int",
    "semanticSearch": "string",
    "upgradeAvailable": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Объекты DataIdentity

Задайте свойство @odata.type, чтобы указать тип объекта.

Для #Microsoft.Azure.Search.DataNoneIdentity используйте:

{
  "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity"
}

Для #Microsoft.Azure.Search.DataUserAssignedIdentity используйте:

{
  "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
  "federatedIdentityClientId": "string",
  "userAssignedIdentity": "string"
}

Значения свойств

Microsoft.Search/searchServices

Имя Описание Ценность
apiVersion Версия API «2026-09-01-превью»
тождество Удостоверение ресурса. удостоверения
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
имя Имя ресурса string

Ограничения целостности:
Pattern = ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ (обязательно)
свойства Свойства службы поиска. SearchServiceProperties (Свойства SearchService)
SKU SKU службы поиска, которая определяет ценовую категорию и ограничения емкости. Это свойство необходимо при создании новой службы поиска. SKU
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.Search/searchServices"

AzureActiveDirectoryApplicationCredentials

Имя Описание Ценность
applicationId ID приложения (клиента) регистрации приложения в арендаторе. струна
applicationSecret Секрет клиента AAD, сгенерированный для регистрации приложения, использовался для аутентификации с Azure Key Vault. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

Идентификация данных

Имя Описание Ценность
@odata.type Задайте значение "#Microsoft.Azure.Search.DataNoneIdentity" для типа DataNoneIdentity. Задайте значение "#Microsoft.Azure.Search.DataUserAssignedIdentity" для типа DataUserAssignedIdentity. '#Microsoft.Azure.Search.DataNoneIdentity'
"#Microsoft.Azure.Search.DataUserAssignedIdentity" (обязательно)

ДанныеНеидентификация

Имя Описание Ценность
@odata.type Фрагмент URI, указывающий тип удостоверения. "#Microsoft.Azure.Search.DataNoneIdentity" (обязательно)

DataPlaneAadOrApiKeyAuthOption

Имя Описание Ценность
aadAuthFailureMode Описывает, какой ответ БУДЕТ отправлять API плоскости данных службы поиска для запросов, которые не удалось выполнить проверку подлинности. "http401WithBearerChallenge"
"http403"

Параметры DataPlaneAuthOptions

Имя Описание Ценность
aadOrApiKey Указывает, что для проверки подлинности можно использовать ключ API или маркер доступа из клиента идентификатора Microsoft Entra ID. DataPlaneAadOrApiKeyAuthOption
apiKeyOnly Указывает, что для проверки подлинности можно использовать только ключ API. любой

Идентификатор DataUserAssignedIdentity

Имя Описание Ценность
@odata.type Фрагмент URI, указывающий тип удостоверения. "#Microsoft.Azure.Search.DataUserAssignedIdentity" (обязательно)
federatedIdentityClientId Опционально для поддержки CMK User-Assigned многоарендовательного управляемой идентичности: идентификатор клиента (в виде UUID) многоарендовантной регистрации приложения, настроенного для федерации с userAssignedIdentity. струна
userAssignedIdentity Полный идентификатор ресурса Azure управляемого удостоверения, назначенного пользователем, обычно в форме "/subscriptions/12345678-1234-1234-123467890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", который должен быть назначен службе поиска. строка (обязательно)

EncryptionWithCmk (ШифрованиеWithCmk)

Имя Описание Ценность
принуждение Описывает, как служба поиска должна обеспечить соответствие требованиям, если он находит объекты, которые не шифруются с помощью ключа, управляемого клиентом. "Отключено"
"Включено"
"Не указано"
serviceLevelEncryptionKey Описывает конфигурацию ключа, управляемую клиентом, для шифрования поисковой службы. SearchResourceEncryptionKey

Тождество

Имя Описание Ценность
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как удостоверение, созданное системой, так и набор назначенных пользователем удостоверений. Тип "Нет" приведет к удалению всех удостоверений из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned (обязательно)
ИдентичностиНазначенныеПользователем Список удостоверений пользователей, связанных с ресурсом. Ключевые ссылки на словарь удостоверений пользователей будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Имя Описание Ценность

Правило IpRule

Имя Описание Ценность
ценность Значение, соответствующее одному IPv4-адресу (например, 123.1.2.3) или диапазону IP-адресов в формате CIDR (например, 123.1.2.3/24). струна

Набор сетевых правил

Имя Описание Ценность
обходить Возможные источники входящего трафика, которые могут обойти правила, определенные в разделе ipRules. AzurePortal
AzureServices
"Нет"
ipRules Список правил ограничения IP-адресов, определяющих входящие сети с разрешением доступа к конечной точке службы поиска. В то же время все остальные общедоступные IP-сети блокируются брандмауэром. Эти правила ограничения применяются только в том случае, если функция publicNetworkAccess службы поиска включена; в противном случае трафик через общедоступный интерфейс не допускается даже с любыми правилами общедоступного IP-адреса, а подключения к частной конечной точке — монопольным методом доступа. Правило IpRule[]

SearchResourceEncryptionKey (Ключ шифрования)

Имя Описание Ценность
Учетные данные доступа Необязательные учетные данные Azure Active Directory, используемые для доступа к Azure Key Vault. Не требуется, если вместо этого используется управляемое удостоверение. AzureActiveDirectoryApplicationCredentials
тождество Явное управляемое удостоверение, используемое для этого ключа шифрования. Если не указано, а свойство учетных данных доступа равно NULL, используется управляемое удостоверение, назначаемое системой. При обновлении ресурса, если явное удостоверение не указано, оно остается неизменным. Если задано значение none, то значение этого свойства очищается. Идентификация данных
keyVaultKeyName Имя ключа Azure Key Vault, используемого для шифрования неактивных данных. струна
keyVaultKeyVersion Версия ключа Azure Key Vault, используемая для шифрования неактивных данных. струна
keyVaultUri Универсальный код ресурса (URI) Хранилища ключей Azure, который также называется DNS-именем, который содержит ключ, используемый для шифрования неактивных данных. Пример URI может быть https://my-keyvault-name.vault.azure.net. струна

SearchServiceProperties (Свойства SearchService)

Имя Описание Ценность
Параметры authOptions Определяет параметры того, как API плоскости данных службы поиска выполняет проверку подлинности запросов. Это невозможно задать, если параметр disableLocalAuth имеет значение true. Параметры DataPlaneAuthOptions
autoGeneratedDomainNameLabelScope Определяет уровень повторного использования автоматически сгенерированной метки доменного имени для поискового сервиса (например, myservice-uniqueId.search.windows.net<>). Если не указано, автоматически сгенерированная метка доменного имени для поиска не создаётся. NoReuse
SubscriptionReuse
"TenantReuse"
computeType Настройте это свойство для поддержки службы поиска с помощью вычислений по умолчанию или конфиденциальных вычислений Azure. "Конфиденциальный"
По умолчанию
dataExfiltrationProtections Список сценариев кражи данных, которые явно запрещены для службы поиска. В настоящее время единственным поддерживаемым значением является "Все", чтобы отключить все возможные сценарии экспорта данных с более точными элементами управления, запланированными в будущем. Массив строк, содержащий любой из:
«БлокВсе»
disableLocalAuth Если задано значение true, вызовы службы поиска не будут разрешены использовать ключи API для проверки подлинности. Это не может быть задано значение true, если определен параметр dataPlaneAuthOptions. булевая переменная (bool)
encryptionWithCmk Указывает любую политику шифрования ресурсов (таких как индексы) с помощью ключей диспетчера клиентов в службе поиска. EncryptionWithCmk (ШифрованиеWithCmk)
конечная точка Конечная точка службы поиска ИИ Azure. струна
hostingMode Применимо только для номера SKU standard3. Это свойство можно настроить для включения до 3 секций высокой плотности, которые позволяют до 1000 индексов, что гораздо выше, чем максимальные индексы, разрешенные для любого другого номера SKU. Для номера SKU standard3 используется значение "Default" или "HighDensity". Для всех остальных номеров SKU это значение должно быть "Default". По умолчанию
«Высокая плотность»
knowledgeRetrieval Указывает план выставления счетов для агентного поиска в сервисе Поиск с использованием ИИ Azure. Эта конфигурация доступна только для определённых уровней ценообразования в определённых регионах. "бесплатный"
"Стандартный"
набор правил networkRuleSet Правила конкретной сети, определяющие, как может быть достигнута служба поиска ИИ Azure. Набор сетевых правил
Количество разделов Количество разделов в выделенном поисковом сервисе; если указано, это может быть 1, 2, 3, 4, 6 или 12. Значения, превышающие 1, допустимы только для стандартных номеров SKU. Для служб "standard3" с параметром hostingMode задано значение highDensity, допустимые значения имеют значение от 1 до 3. int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 12
доступ к публичной сети Для этого значения можно установить значение "Включено", чтобы избежать критических изменений на существующих клиентских ресурсах и шаблонах. Если установлено значение «Отключено», трафик через публичный интерфейс не разрешен, а подключения к частным конечным точкам будут эксклюзивным методом доступа. "Отключено"
"Включено"
«ЗащищеноПоПериметру»
репликаCount Количество реплик в специализированном поисковом сервисе. Если задано, оно должно быть значением от 1 до 12 включительно для стандартных номеров SKU или от 1 до 3 включительно для базового номера SKU. int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 12
семантический поиск Указывает доступность и план оплаты для семантического поиска в сервисе Поиск с использованием ИИ Azure. Эта конфигурация доступна только для определённых уровней ценообразования в определённых регионах. "отключено"
"бесплатный"
"Стандартный"
upgradeДоступно Указывает, доступна ли служба поиска обновление. "доступно"
«Недоступно»

Артикул

Имя Описание Ценность
имя Номер SKU службы поиска. Допустимые значения: "бесплатный": общая служба. "базовый": выделенная служба с 3 репликами. "Стандартный": выделенная служба с 12 секциями и 12 репликами. "standard2": аналогично стандарту, но с большей емкостью на единицу поиска. "Standard3": наибольшее стандартное предложение с до 12 секций и 12 реплик (или до 3 секций с большим количеством индексов, если свойство hostingMode также имеет значение highDensity). "storage_optimized_l1": поддерживает 1TB на секцию до 12 секций. 'storage_optimized_l2': поддерживает 2 ТБ на раздел, до 12 разделов. 'serverless': уровень без сервера с возможностью автомасштабирования. "базовый"
"бесплатный"
«Без сервера»
"Стандартный"
"Standard2"
"Standard3"
"storage_optimized_l1"
"storage_optimized_l2"

Отслеживаемые Ресурсные Теги

Имя Описание Ценность

Пользовательская назначенная идентичность

Имя Описание Ценность

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса searchServices можно развернуть с помощью операций, целевых:

Примеры использования

Примеры Terraform

Простой пример развертывания службы поиска.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "searchService" {
  type      = "Microsoft.Search/searchServices@2022-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      authOptions = {
        apiKeyOnly = {
        }
      }
      disableLocalAuth = false
      encryptionWithCmk = {
        enforcement = "Disabled"
      }
      hostingMode = "default"
      networkRuleSet = {
        ipRules = [
        ]
      }
      partitionCount      = 1
      publicNetworkAccess = "Enabled"
      replicaCount        = 1
    }
    sku = {
      name = "standard"
    }
    tags = {
      environment = "staging"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Проверенные модули Azure

Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.

Модуль Описание
службы поиска Модуль ресурсов AVM для службы поиска

Формат ресурса

Чтобы создать ресурс Microsoft.Search/searchServices, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Search/searchServices@2026-09-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      authOptions = {
        aadOrApiKey = {
          aadAuthFailureMode = "string"
        }
        apiKeyOnly = ?
      }
      autoGeneratedDomainNameLabelScope = "string"
      computeType = "string"
      dataExfiltrationProtections = [
        "string"
      ]
      disableLocalAuth = bool
      encryptionWithCmk = {
        enforcement = "string"
        serviceLevelEncryptionKey = {
          accessCredentials = {
            applicationId = "string"
            applicationSecret = "string"
          }
          identity = {
            @odata.type = "string"
            // For remaining properties, see DataIdentity objects
          }
          keyVaultKeyName = "string"
          keyVaultKeyVersion = "string"
          keyVaultUri = "string"
        }
      }
      endpoint = "string"
      hostingMode = "string"
      knowledgeRetrieval = "string"
      networkRuleSet = {
        bypass = "string"
        ipRules = [
          {
            value = "string"
          }
        ]
      }
      partitionCount = int
      publicNetworkAccess = "string"
      replicaCount = int
      semanticSearch = "string"
      upgradeAvailable = "string"
    }
    sku = {
      name = "string"
    }
  }
}

Объекты DataIdentity

Задайте свойство @odata.type, чтобы указать тип объекта.

Для #Microsoft.Azure.Search.DataNoneIdentity используйте:

{
  @odata.type = "#Microsoft.Azure.Search.DataNoneIdentity"
}

Для #Microsoft.Azure.Search.DataUserAssignedIdentity используйте:

{
  @odata.type = "#Microsoft.Azure.Search.DataUserAssignedIdentity"
  federatedIdentityClientId = "string"
  userAssignedIdentity = "string"
}

Значения свойств

Microsoft.Search/searchServices

Имя Описание Ценность
тождество Удостоверение ресурса. удостоверения
местоположение Географическое расположение, в котором находится ресурс строка (обязательно)
имя Имя ресурса string

Ограничения целостности:
Pattern = ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ (обязательно)
свойства Свойства службы поиска. SearchServiceProperties (Свойства SearchService)
SKU SKU службы поиска, которая определяет ценовую категорию и ограничения емкости. Это свойство необходимо при создании новой службы поиска. SKU
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft. Поиск/searchServices@2026-09-01-preview"

AzureActiveDirectoryApplicationCredentials

Имя Описание Ценность
applicationId ID приложения (клиента) регистрации приложения в арендаторе. струна
applicationSecret Секрет клиента AAD, сгенерированный для регистрации приложения, использовался для аутентификации с Azure Key Vault. string

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.

Идентификация данных

Имя Описание Ценность
@odata.type Задайте значение "#Microsoft.Azure.Search.DataNoneIdentity" для типа DataNoneIdentity. Задайте значение "#Microsoft.Azure.Search.DataUserAssignedIdentity" для типа DataUserAssignedIdentity. '#Microsoft.Azure.Search.DataNoneIdentity'
"#Microsoft.Azure.Search.DataUserAssignedIdentity" (обязательно)

ДанныеНеидентификация

Имя Описание Ценность
@odata.type Фрагмент URI, указывающий тип удостоверения. "#Microsoft.Azure.Search.DataNoneIdentity" (обязательно)

DataPlaneAadOrApiKeyAuthOption

Имя Описание Ценность
aadAuthFailureMode Описывает, какой ответ БУДЕТ отправлять API плоскости данных службы поиска для запросов, которые не удалось выполнить проверку подлинности. "http401WithBearerChallenge"
"http403"

Параметры DataPlaneAuthOptions

Имя Описание Ценность
aadOrApiKey Указывает, что для проверки подлинности можно использовать ключ API или маркер доступа из клиента идентификатора Microsoft Entra ID. DataPlaneAadOrApiKeyAuthOption
apiKeyOnly Указывает, что для проверки подлинности можно использовать только ключ API. любой

Идентификатор DataUserAssignedIdentity

Имя Описание Ценность
@odata.type Фрагмент URI, указывающий тип удостоверения. "#Microsoft.Azure.Search.DataUserAssignedIdentity" (обязательно)
federatedIdentityClientId Опционально для поддержки CMK User-Assigned многоарендовательного управляемой идентичности: идентификатор клиента (в виде UUID) многоарендовантной регистрации приложения, настроенного для федерации с userAssignedIdentity. струна
userAssignedIdentity Полный идентификатор ресурса Azure управляемого удостоверения, назначенного пользователем, обычно в форме "/subscriptions/12345678-1234-1234-123467890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", который должен быть назначен службе поиска. строка (обязательно)

EncryptionWithCmk (ШифрованиеWithCmk)

Имя Описание Ценность
принуждение Описывает, как служба поиска должна обеспечить соответствие требованиям, если он находит объекты, которые не шифруются с помощью ключа, управляемого клиентом. "Отключено"
"Включено"
"Не указано"
serviceLevelEncryptionKey Описывает конфигурацию ключа, управляемую клиентом, для шифрования поисковой службы. SearchResourceEncryptionKey

Тождество

Имя Описание Ценность
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned, UserAssigned включает как удостоверение, созданное системой, так и набор назначенных пользователем удостоверений. Тип "Нет" приведет к удалению всех удостоверений из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned (обязательно)
ИдентичностиНазначенныеПользователем Список удостоверений пользователей, связанных с ресурсом. Ключевые ссылки на словарь удостоверений пользователей будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Имя Описание Ценность

Правило IpRule

Имя Описание Ценность
ценность Значение, соответствующее одному IPv4-адресу (например, 123.1.2.3) или диапазону IP-адресов в формате CIDR (например, 123.1.2.3/24). струна

Набор сетевых правил

Имя Описание Ценность
обходить Возможные источники входящего трафика, которые могут обойти правила, определенные в разделе ipRules. AzurePortal
AzureServices
"Нет"
ipRules Список правил ограничения IP-адресов, определяющих входящие сети с разрешением доступа к конечной точке службы поиска. В то же время все остальные общедоступные IP-сети блокируются брандмауэром. Эти правила ограничения применяются только в том случае, если функция publicNetworkAccess службы поиска включена; в противном случае трафик через общедоступный интерфейс не допускается даже с любыми правилами общедоступного IP-адреса, а подключения к частной конечной точке — монопольным методом доступа. Правило IpRule[]

SearchResourceEncryptionKey (Ключ шифрования)

Имя Описание Ценность
Учетные данные доступа Необязательные учетные данные Azure Active Directory, используемые для доступа к Azure Key Vault. Не требуется, если вместо этого используется управляемое удостоверение. AzureActiveDirectoryApplicationCredentials
тождество Явное управляемое удостоверение, используемое для этого ключа шифрования. Если не указано, а свойство учетных данных доступа равно NULL, используется управляемое удостоверение, назначаемое системой. При обновлении ресурса, если явное удостоверение не указано, оно остается неизменным. Если задано значение none, то значение этого свойства очищается. Идентификация данных
keyVaultKeyName Имя ключа Azure Key Vault, используемого для шифрования неактивных данных. струна
keyVaultKeyVersion Версия ключа Azure Key Vault, используемая для шифрования неактивных данных. струна
keyVaultUri Универсальный код ресурса (URI) Хранилища ключей Azure, который также называется DNS-именем, который содержит ключ, используемый для шифрования неактивных данных. Пример URI может быть https://my-keyvault-name.vault.azure.net. струна

SearchServiceProperties (Свойства SearchService)

Имя Описание Ценность
Параметры authOptions Определяет параметры того, как API плоскости данных службы поиска выполняет проверку подлинности запросов. Это невозможно задать, если параметр disableLocalAuth имеет значение true. Параметры DataPlaneAuthOptions
autoGeneratedDomainNameLabelScope Определяет уровень повторного использования автоматически сгенерированной метки доменного имени для поискового сервиса (например, myservice-uniqueId.search.windows.net<>). Если не указано, автоматически сгенерированная метка доменного имени для поиска не создаётся. NoReuse
SubscriptionReuse
"TenantReuse"
computeType Настройте это свойство для поддержки службы поиска с помощью вычислений по умолчанию или конфиденциальных вычислений Azure. "Конфиденциальный"
По умолчанию
dataExfiltrationProtections Список сценариев кражи данных, которые явно запрещены для службы поиска. В настоящее время единственным поддерживаемым значением является "Все", чтобы отключить все возможные сценарии экспорта данных с более точными элементами управления, запланированными в будущем. Массив строк, содержащий любой из:
«БлокВсе»
disableLocalAuth Если задано значение true, вызовы службы поиска не будут разрешены использовать ключи API для проверки подлинности. Это не может быть задано значение true, если определен параметр dataPlaneAuthOptions. булевая переменная (bool)
encryptionWithCmk Указывает любую политику шифрования ресурсов (таких как индексы) с помощью ключей диспетчера клиентов в службе поиска. EncryptionWithCmk (ШифрованиеWithCmk)
конечная точка Конечная точка службы поиска ИИ Azure. струна
hostingMode Применимо только для номера SKU standard3. Это свойство можно настроить для включения до 3 секций высокой плотности, которые позволяют до 1000 индексов, что гораздо выше, чем максимальные индексы, разрешенные для любого другого номера SKU. Для номера SKU standard3 используется значение "Default" или "HighDensity". Для всех остальных номеров SKU это значение должно быть "Default". По умолчанию
«Высокая плотность»
knowledgeRetrieval Указывает план выставления счетов для агентного поиска в сервисе Поиск с использованием ИИ Azure. Эта конфигурация доступна только для определённых уровней ценообразования в определённых регионах. "бесплатный"
"Стандартный"
набор правил networkRuleSet Правила конкретной сети, определяющие, как может быть достигнута служба поиска ИИ Azure. Набор сетевых правил
Количество разделов Количество разделов в выделенном поисковом сервисе; если указано, это может быть 1, 2, 3, 4, 6 или 12. Значения, превышающие 1, допустимы только для стандартных номеров SKU. Для служб "standard3" с параметром hostingMode задано значение highDensity, допустимые значения имеют значение от 1 до 3. int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 12
доступ к публичной сети Для этого значения можно установить значение "Включено", чтобы избежать критических изменений на существующих клиентских ресурсах и шаблонах. Если установлено значение «Отключено», трафик через публичный интерфейс не разрешен, а подключения к частным конечным точкам будут эксклюзивным методом доступа. "Отключено"
"Включено"
«ЗащищеноПоПериметру»
репликаCount Количество реплик в специализированном поисковом сервисе. Если задано, оно должно быть значением от 1 до 12 включительно для стандартных номеров SKU или от 1 до 3 включительно для базового номера SKU. int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 12
семантический поиск Указывает доступность и план оплаты для семантического поиска в сервисе Поиск с использованием ИИ Azure. Эта конфигурация доступна только для определённых уровней ценообразования в определённых регионах. "отключено"
"бесплатный"
"Стандартный"
upgradeДоступно Указывает, доступна ли служба поиска обновление. "доступно"
«Недоступно»

Артикул

Имя Описание Ценность
имя Номер SKU службы поиска. Допустимые значения: "бесплатный": общая служба. "базовый": выделенная служба с 3 репликами. "Стандартный": выделенная служба с 12 секциями и 12 репликами. "standard2": аналогично стандарту, но с большей емкостью на единицу поиска. "Standard3": наибольшее стандартное предложение с до 12 секций и 12 реплик (или до 3 секций с большим количеством индексов, если свойство hostingMode также имеет значение highDensity). "storage_optimized_l1": поддерживает 1TB на секцию до 12 секций. 'storage_optimized_l2': поддерживает 2 ТБ на раздел, до 12 разделов. 'serverless': уровень без сервера с возможностью автомасштабирования. "базовый"
"бесплатный"
«Без сервера»
"Стандартный"
"Standard2"
"Standard3"
"storage_optimized_l1"
"storage_optimized_l2"

Отслеживаемые Ресурсные Теги

Имя Описание Ценность

Пользовательская назначенная идентичность

Имя Описание Ценность