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

SearchService interface

  • Ссылка
Пакет:
@azure/arm-search

Описывает службу Когнитивный поиск Azure и ее текущее состояние.

Extends
TrackedResource

Свойства

authOptions

Определяет параметры того, как API плоскости данных службы поиска проверяет подлинность запросов. Этот параметр не может быть задан, если параметру disableLocalAuth присвоено значение true.
disableLocalAuth

Если задано значение true, вызовы службы поиска не смогут использовать ключи API для проверки подлинности. Если определены dataPlaneAuthOptions, это значение не может быть равно true.
encryptionWithCmk

Задает любую политику шифрования ресурсов (например, индексов) с помощью ключей диспетчера клиентов в службе поиска.
hostingMode

Применимо только для номера SKU Standard3. Это свойство можно задать, чтобы включить до 3 секций с высокой плотностью, допускающих до 1000 индексов, что значительно превышает максимальное число индексов, разрешенных для любого другого номера SKU. Для номера SKU Standard3 используется значение default или highDensity. Для всех остальных номеров SKU это значение должно быть "default".
identity

Удостоверение ресурса.
networkRuleSet

Правила, относящиеся к сети, которые определяют способ доступа к службе Когнитивный поиск Azure.
partitionCount

Количество секций в службе поиска; Если указано значение, это может быть 1, 2, 3, 4, 6 или 12. Значения больше 1 допустимы только для стандартных номеров SKU. Для служб standard3 с параметром hostingMode, для которых задано значение highDensity, допустимые значения находятся в диапазоне от 1 до 3.
privateEndpointConnections

Список подключений частных конечных точек к службе Когнитивный поиск Azure. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
provisioningState

Состояние последней операции подготовки, выполненной в службе поиска. Подготовка — это промежуточное состояние, которое наступает при установке емкости службы. После настройки емкости provisioningState изменится на "успешно" или "сбой". Клиентские приложения могут опрашивать состояние подготовки (рекомендуемый интервал опроса составляет от 30 секунд до одной минуты), используя операцию Получения службы поиска, чтобы узнать, когда операция будет завершена. Если вы используете бесплатную службу, это значение, как правило, возвращается как "успешно" непосредственно в вызове create search service. Это объясняется тем, что бесплатная служба использует уже настроенную емкость. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
publicNetworkAccess

Для этого значения можно задать значение "включено", чтобы избежать критических изменений в существующих клиентских ресурсах и шаблонах. Если задано значение "отключено", трафик через общедоступный интерфейс не разрешен, а подключения к частной конечной точке будут монопольным методом доступа.
replicaCount

Количество реплик в службе поиска. Если он указан, это должно быть значение от 1 до 12 включительно для номеров SKU категории "Стандартный" или от 1 до 3 включительно для номера SKU "Базовый".
semanticSearch

Задает параметры, управляющие доступностью семантического поиска. Такая конфигурация возможна только для определенных номеров SKU Когнитивный поиск Azure в определенных расположениях.
sharedPrivateLinkResources

Список общих ресурсов приватного канала, управляемых службой Когнитивный поиск Azure. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
sku

Номер SKU службы поиска, определяющий ценовую категорию и ограничения емкости. Это свойство является обязательным при создании новой службы поиска.
status

Состояние службы поиска. Возможные значения: "running": служба поиска запущена и операции подготовки не выполняются. "подготовка". Служба поиска подготавливается или масштабируется вверх или вниз. "deleting": служба поиска удаляется. "понижено": служба поиска понижена. Это может произойти, если базовые единицы поиска не работоспособны. Служба поиска, скорее всего, работает, но производительность может быть низкой, а некоторые запросы могут быть удалены. "disabled": служба поиска отключена. В этом состоянии служба отклоняет все запросы API. "error": служба поиска находится в состоянии ошибки. Если ваша служба находится в состоянии понижения, отключения или ошибки, это означает, что команда Когнитивный поиск Azure активно изучает базовую проблему. Выделенные службы в этих состояниях по-прежнему оплачиваются по количеству подготовленных единиц поиска. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
statusDetails

Сведения о состоянии службы поиска. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

Унаследованные свойства

id

Полный идентификатор ресурса. Пример — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
location

Географическое расположение, в котором находится ресурс
name

Имя ресурса ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
tags

Теги ресурсов.
type

Тип ресурса. Например Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

Сведения о свойстве

authOptions

Определяет параметры того, как API плоскости данных службы поиска проверяет подлинность запросов. Этот параметр не может быть задан, если параметру disableLocalAuth присвоено значение true.

authOptions?: DataPlaneAuthOptions

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

DataPlaneAuthOptions

disableLocalAuth

Если задано значение true, вызовы службы поиска не смогут использовать ключи API для проверки подлинности. Если определены dataPlaneAuthOptions, это значение не может быть равно true.

disableLocalAuth?: boolean

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

boolean

encryptionWithCmk

Задает любую политику шифрования ресурсов (например, индексов) с помощью ключей диспетчера клиентов в службе поиска.

encryptionWithCmk?: EncryptionWithCmk

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

EncryptionWithCmk

hostingMode

Применимо только для номера SKU Standard3. Это свойство можно задать, чтобы включить до 3 секций с высокой плотностью, допускающих до 1000 индексов, что значительно превышает максимальное число индексов, разрешенных для любого другого номера SKU. Для номера SKU Standard3 используется значение default или highDensity. Для всех остальных номеров SKU это значение должно быть "default".

hostingMode?: HostingMode

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

HostingMode

identity

Удостоверение ресурса.

identity?: Identity

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

Identity

networkRuleSet

Правила, относящиеся к сети, которые определяют способ доступа к службе Когнитивный поиск Azure.

networkRuleSet?: NetworkRuleSet

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

NetworkRuleSet

partitionCount

Количество секций в службе поиска; Если указано значение, это может быть 1, 2, 3, 4, 6 или 12. Значения больше 1 допустимы только для стандартных номеров SKU. Для служб standard3 с параметром hostingMode, для которых задано значение highDensity, допустимые значения находятся в диапазоне от 1 до 3.

partitionCount?: number

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

number

privateEndpointConnections

Список подключений частных конечных точек к службе Когнитивный поиск Azure. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

privateEndpointConnections?: PrivateEndpointConnection[]

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

PrivateEndpointConnection[]

provisioningState

Состояние последней операции подготовки, выполненной в службе поиска. Подготовка — это промежуточное состояние, которое наступает при установке емкости службы. После настройки емкости provisioningState изменится на "успешно" или "сбой". Клиентские приложения могут опрашивать состояние подготовки (рекомендуемый интервал опроса составляет от 30 секунд до одной минуты), используя операцию Получения службы поиска, чтобы узнать, когда операция будет завершена. Если вы используете бесплатную службу, это значение, как правило, возвращается как "успешно" непосредственно в вызове create search service. Это объясняется тем, что бесплатная служба использует уже настроенную емкость. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

provisioningState?: ProvisioningState

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

ProvisioningState

publicNetworkAccess

Для этого значения можно задать значение "включено", чтобы избежать критических изменений в существующих клиентских ресурсах и шаблонах. Если задано значение "отключено", трафик через общедоступный интерфейс не разрешен, а подключения к частной конечной точке будут монопольным методом доступа.

publicNetworkAccess?: PublicNetworkAccess

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

PublicNetworkAccess

replicaCount

Количество реплик в службе поиска. Если он указан, это должно быть значение от 1 до 12 включительно для номеров SKU категории "Стандартный" или от 1 до 3 включительно для номера SKU "Базовый".

replicaCount?: number

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

number

semanticSearch

Задает параметры, управляющие доступностью семантического поиска. Такая конфигурация возможна только для определенных номеров SKU Когнитивный поиск Azure в определенных расположениях.

semanticSearch?: string

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

string

sharedPrivateLinkResources

Список общих ресурсов приватного канала, управляемых службой Когнитивный поиск Azure. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

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

SharedPrivateLinkResource[]

sku

Номер SKU службы поиска, определяющий ценовую категорию и ограничения емкости. Это свойство является обязательным при создании новой службы поиска.

sku?: Sku

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

Sku

status

Состояние службы поиска. Возможные значения: "running": служба поиска запущена и операции подготовки не выполняются. "подготовка". Служба поиска подготавливается или масштабируется вверх или вниз. "deleting": служба поиска удаляется. "понижено": служба поиска понижена. Это может произойти, если базовые единицы поиска не работоспособны. Служба поиска, скорее всего, работает, но производительность может быть низкой, а некоторые запросы могут быть удалены. "disabled": служба поиска отключена. В этом состоянии служба отклоняет все запросы API. "error": служба поиска находится в состоянии ошибки. Если ваша служба находится в состоянии понижения, отключения или ошибки, это означает, что команда Когнитивный поиск Azure активно изучает базовую проблему. Выделенные службы в этих состояниях по-прежнему оплачиваются по количеству подготовленных единиц поиска. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

status?: SearchServiceStatus

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

SearchServiceStatus

statusDetails

Сведения о состоянии службы поиска. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

statusDetails?: string

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

string

Сведения об унаследованном свойстве

id

Полный идентификатор ресурса. Пример — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

id?: string

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

string

Наследуетсяот TrackedResource.id

location

Географическое расположение, в котором находится ресурс

location: string

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

string

Наследуется отTrackedResource.location

name

Имя ресурса ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

name?: string

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

string

Наследуетсяот TrackedResource.name

tags

Теги ресурсов.

tags?: {[propertyName: string]: string}

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

{[propertyName: string]: string}

Наследуется отTrackedResource.tags

type

Тип ресурса. Например Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.

type?: string

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

string

Наследуется отTrackedResource.type