Microsoft.Search searchServices 2023-11-01

Статья
12/21/2024

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

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

группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

resource symbolicname 'Microsoft.Search/searchServices@2023-11-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    authOptions: {
      aadOrApiKey: {
        aadAuthFailureMode: 'string'
      }
      apiKeyOnly: any(Azure.Bicep.Types.Concrete.AnyType)
    }
    disableLocalAuth: bool
    encryptionWithCmk: {
      enforcement: 'string'
    }
    hostingMode: 'string'
    networkRuleSet: {
      ipRules: [
        {
          value: 'string'
        }
      ]
    }
    partitionCount: int
    publicNetworkAccess: 'string'
    replicaCount: int
    semanticSearch: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

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

DataPlaneAadOrApiKeyAuthOption

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

DataPlaneAuthOptions

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

EncryptionWithCmk

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

Тождество

Имя	Описание	Ценность
тип	Тип удостоверения.	"Нет" SystemAssigned (обязательно)

IpRule

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

Microsoft.Search/searchServices

Имя	Описание	Ценность
тождество	Удостоверение ресурса.	удостоверения
местоположение	Географическое расположение, в котором находится ресурс	строка (обязательно)
имя	Имя ресурса	строка (обязательно)
свойства	Свойства службы поиска.	SearchServiceProperties
SKU	SKU службы поиска, которая определяет частоту выставления счетов и ограничения емкости. Это свойство необходимо при создании новой службы поиска.	Sku
Теги	Теги ресурсов	Словарь имен и значений тегов. См. теги в шаблонах

NetworkRuleSet

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

SearchServiceProperties

Имя	Описание	Ценность
authOptions	Определяет параметры того, как API плоскости данных службы поиска выполняет проверку подлинности запросов. Это невозможно задать, если параметр disableLocalAuth имеет значение true.	DataPlaneAuthOptions
disableLocalAuth	Если задано значение true, вызовы службы поиска не будут разрешены использовать ключи API для проверки подлинности. Это не может быть задано значение true, если определен параметр dataPlaneAuthOptions.	bool
encryptionWithCmk	Указывает любую политику шифрования ресурсов (таких как индексы) с помощью ключей диспетчера клиентов в службе поиска.	EncryptionWithCmk
hostingMode	Применимо только для номера SKU standard3. Это свойство можно настроить для включения до 3 секций высокой плотности, которые позволяют до 1000 индексов, что гораздо выше, чем максимальные индексы, разрешенные для любого другого номера SKU. Для номера SKU уровня "стандартный" значение равно "default" или "highDensity". Для всех остальных номеров SKU это значение должно иметь значение по умолчанию.	"по умолчанию" "highDensity"
networkRuleSet	Правила для конкретной сети, определяющие, как может быть достигнута служба поиска.	NetworkRuleSet
partitionCount	Количество секций в службе поиска; Значение 1, 2, 3, 4, 6 или 12. Значения, превышающие 1, допустимы только для стандартных номеров SKU. Для служб "standard3" с параметром hostingMode задано значение highDensity, допустимые значения имеют значение от 1 до 3.	int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 12
publicNetworkAccess	Это значение можно задать как "включено", чтобы избежать критических изменений в существующих ресурсах и шаблонах клиентов. Если задано значение "отключено", трафик через общедоступный интерфейс не разрешен, а подключения к частной конечной точке — это монопольный метод доступа.	"отключено" "Включено"
репликаCount	Количество реплик в службе поиска. Если задано, оно должно быть значением от 1 до 12 включительно для стандартных номеров SKU или от 1 до 3 включительно для базового номера SKU.	int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 12
семантический поиск	Задает параметры, управляющие доступностью семантического поиска. Эта конфигурация возможна только для определенных номеров SKU поиска в определенных расположениях.	"отключено" "бесплатный" "Стандартный"

Sku

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

TrackedResourceTags

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

Примеры краткого руководства

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

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

Bicep-файл

Описание

ограниченной сети Azure AI Studio

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

службы когнитивного поиска Azure

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

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

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

группы ресурсов . См. команды развертывания группы ресурсов

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

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

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

{
  "type": "Microsoft.Search/searchServices",
  "apiVersion": "2023-11-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "string"
      },
      "apiKeyOnly": {}
    },
    "disableLocalAuth": "bool",
    "encryptionWithCmk": {
      "enforcement": "string"
    },
    "hostingMode": "string",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "string"
        }
      ]
    },
    "partitionCount": "int",
    "publicNetworkAccess": "string",
    "replicaCount": "int",
    "semanticSearch": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

DataPlaneAadOrApiKeyAuthOption

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

DataPlaneAuthOptions

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

EncryptionWithCmk

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

Тождество

Имя	Описание	Ценность
тип	Тип удостоверения.	"Нет" SystemAssigned (обязательно)

IpRule

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

Microsoft.Search/searchServices

Имя	Описание	Ценность
apiVersion	Версия API	'2023-11-01'
тождество	Удостоверение ресурса.	удостоверения
местоположение	Географическое расположение, в котором находится ресурс	строка (обязательно)
имя	Имя ресурса	строка (обязательно)
свойства	Свойства службы поиска.	SearchServiceProperties
SKU	SKU службы поиска, которая определяет частоту выставления счетов и ограничения емкости. Это свойство необходимо при создании новой службы поиска.	Sku
Теги	Теги ресурсов	Словарь имен и значений тегов. См. теги в шаблонах
тип	Тип ресурса	"Microsoft.Search/searchServices"

NetworkRuleSet

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

SearchServiceProperties

Имя	Описание	Ценность
authOptions	Определяет параметры того, как API плоскости данных службы поиска выполняет проверку подлинности запросов. Это невозможно задать, если параметр disableLocalAuth имеет значение true.	DataPlaneAuthOptions
disableLocalAuth	Если задано значение true, вызовы службы поиска не будут разрешены использовать ключи API для проверки подлинности. Это не может быть задано значение true, если определен параметр dataPlaneAuthOptions.	bool
encryptionWithCmk	Указывает любую политику шифрования ресурсов (таких как индексы) с помощью ключей диспетчера клиентов в службе поиска.	EncryptionWithCmk
hostingMode	Применимо только для номера SKU standard3. Это свойство можно настроить для включения до 3 секций высокой плотности, которые позволяют до 1000 индексов, что гораздо выше, чем максимальные индексы, разрешенные для любого другого номера SKU. Для номера SKU уровня "стандартный" значение равно "default" или "highDensity". Для всех остальных номеров SKU это значение должно иметь значение по умолчанию.	"по умолчанию" "highDensity"
networkRuleSet	Правила для конкретной сети, определяющие, как может быть достигнута служба поиска.	NetworkRuleSet
partitionCount	Количество секций в службе поиска; Значение 1, 2, 3, 4, 6 или 12. Значения, превышающие 1, допустимы только для стандартных номеров SKU. Для служб "standard3" с параметром hostingMode задано значение highDensity, допустимые значения имеют значение от 1 до 3.	int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 12
publicNetworkAccess	Это значение можно задать как "включено", чтобы избежать критических изменений в существующих ресурсах и шаблонах клиентов. Если задано значение "отключено", трафик через общедоступный интерфейс не разрешен, а подключения к частной конечной точке — это монопольный метод доступа.	"отключено" "Включено"
репликаCount	Количество реплик в службе поиска. Если задано, оно должно быть значением от 1 до 12 включительно для стандартных номеров SKU или от 1 до 3 включительно для базового номера SKU.	int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 12
семантический поиск	Задает параметры, управляющие доступностью семантического поиска. Эта конфигурация возможна только для определенных номеров SKU поиска в определенных расположениях.	"отключено" "бесплатный" "Стандартный"

Sku

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

TrackedResourceTags

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

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

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

Шаблон	Описание
ограниченной сети Azure AI Studio развертывание	Этот набор шаблонов демонстрирует настройку Azure AI Studio с закрытым каналом и отключением исходящего трафика с помощью ключей, управляемых Корпорацией Майкрософт, для шифрования и конфигурации управляемых корпорацией Майкрософт удостоверений для ресурса искусственного интеллекта.
службы когнитивного поиска Azure развертывание	Этот шаблон создает службу Когнитивного поиска Azure
Службе Когнитивного поиска Azure с частной конечной точкой развертывание	Этот шаблон создает службу Когнитивного поиска Azure с частной конечной точкой.
веб-приложение с базой данных SQL, Azure Cosmos DB, поиском Azure развертывание	Этот шаблон подготавливает веб-приложение, базу данных SQL, Azure Cosmos DB, поиск Azure и Application Insights.

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

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

групп ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Search/searchServices@2023-11-01"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authOptions = {
        aadOrApiKey = {
          aadAuthFailureMode = "string"
        }
        apiKeyOnly = ?
      }
      disableLocalAuth = bool
      encryptionWithCmk = {
        enforcement = "string"
      }
      hostingMode = "string"
      networkRuleSet = {
        ipRules = [
          {
            value = "string"
          }
        ]
      }
      partitionCount = int
      publicNetworkAccess = "string"
      replicaCount = int
      semanticSearch = "string"
    }
  })
}

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

DataPlaneAadOrApiKeyAuthOption

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

DataPlaneAuthOptions

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

EncryptionWithCmk

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

Тождество

Имя	Описание	Ценность
тип	Тип удостоверения.	"Нет" SystemAssigned (обязательно)

IpRule

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

Microsoft.Search/searchServices

Имя	Описание	Ценность
тождество	Удостоверение ресурса.	удостоверения
местоположение	Географическое расположение, в котором находится ресурс	строка (обязательно)
имя	Имя ресурса	строка (обязательно)
свойства	Свойства службы поиска.	SearchServiceProperties
SKU	SKU службы поиска, которая определяет частоту выставления счетов и ограничения емкости. Это свойство необходимо при создании новой службы поиска.	Sku
Теги	Теги ресурсов	Словарь имен и значений тегов.
тип	Тип ресурса	"Microsoft.Search/searchServices@2023-11-01"

NetworkRuleSet

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

SearchServiceProperties

Имя	Описание	Ценность
authOptions	Определяет параметры того, как API плоскости данных службы поиска выполняет проверку подлинности запросов. Это невозможно задать, если параметр disableLocalAuth имеет значение true.	DataPlaneAuthOptions
disableLocalAuth	Если задано значение true, вызовы службы поиска не будут разрешены использовать ключи API для проверки подлинности. Это не может быть задано значение true, если определен параметр dataPlaneAuthOptions.	bool
encryptionWithCmk	Указывает любую политику шифрования ресурсов (таких как индексы) с помощью ключей диспетчера клиентов в службе поиска.	EncryptionWithCmk
hostingMode	Применимо только для номера SKU standard3. Это свойство можно настроить для включения до 3 секций высокой плотности, которые позволяют до 1000 индексов, что гораздо выше, чем максимальные индексы, разрешенные для любого другого номера SKU. Для номера SKU уровня "стандартный" значение равно "default" или "highDensity". Для всех остальных номеров SKU это значение должно иметь значение по умолчанию.	"по умолчанию" "highDensity"
networkRuleSet	Правила для конкретной сети, определяющие, как может быть достигнута служба поиска.	NetworkRuleSet
partitionCount	Количество секций в службе поиска; Значение 1, 2, 3, 4, 6 или 12. Значения, превышающие 1, допустимы только для стандартных номеров SKU. Для служб "standard3" с параметром hostingMode задано значение highDensity, допустимые значения имеют значение от 1 до 3.	int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 12
publicNetworkAccess	Это значение можно задать как "включено", чтобы избежать критических изменений в существующих ресурсах и шаблонах клиентов. Если задано значение "отключено", трафик через общедоступный интерфейс не разрешен, а подключения к частной конечной точке — это монопольный метод доступа.	"отключено" "Включено"
репликаCount	Количество реплик в службе поиска. Если задано, оно должно быть значением от 1 до 12 включительно для стандартных номеров SKU или от 1 до 3 включительно для базового номера SKU.	int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 12
семантический поиск	Задает параметры, управляющие доступностью семантического поиска. Эта конфигурация возможна только для определенных номеров SKU поиска в определенных расположениях.	"отключено" "бесплатный" "Стандартный"

Sku

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

TrackedResourceTags

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

Поделиться через

Microsoft.Search searchServices 2023-11-01

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

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

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

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

Тождество

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

Примеры краткого руководства

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

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

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

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

Тождество

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

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

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

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

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

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

Тождество

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

Обратная связь

Дополнительные ресурсы