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

SearchServiceUpdate interface

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

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

Extends
Resource

Свойства

authOptions

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

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

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

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

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

Географическое расположение ресурса. Это должен быть один из поддерживаемых и зарегистрированных регионов Azure Geo (например, западная часть США, восточная часть США, юго-восточная Азия и т. д.). Это свойство необходимо при создании нового ресурса.
networkRuleSet

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

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

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

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

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

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

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

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

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

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

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

Теги, помогающие классифицировать ресурс на портале Azure.

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

id

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

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

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts": это свойство не будет сериализовано. Его можно заполнить только сервером.

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

authOptions

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

authOptions?: DataPlaneAuthOptions

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

DataPlaneAuthOptions

disableLocalAuth

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

disableLocalAuth?: boolean

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

boolean

encryptionWithCmk

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

encryptionWithCmk?: EncryptionWithCmk

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

EncryptionWithCmk

hostingMode

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

hostingMode?: HostingMode

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

HostingMode

identity

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

identity?: Identity

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

Identity

location

Географическое расположение ресурса. Это должен быть один из поддерживаемых и зарегистрированных регионов Azure Geo (например, западная часть США, восточная часть США, юго-восточная Азия и т. д.). Это свойство необходимо при создании нового ресурса.

location?: string

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

string

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

Состояние последней операции подготовки, выполняемой в службе поиска. Подготовка — это промежуточное состояние, которое происходит во время установки емкости службы. После настройки емкости подготовкаstate изменится на "успешно" или "не удалось". Клиентские приложения могут опрашивать состояние подготовки (рекомендуемый интервал опроса составляет от 30 секунд до одной минуты) с помощью операции Get 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

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

status?: SearchServiceStatus

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

SearchServiceStatus

statusDetails

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

statusDetails?: string

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

string

tags

Теги, помогающие классифицировать ресурс на портале Azure.

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

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

{[propertyName: string]: string}

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

id

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

id?: string

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

string

унаследован отResource.id

name

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

name?: string

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

string

унаследован отResource.name

type

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts": это свойство не будет сериализовано. Его можно заполнить только сервером.

type?: string

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

string

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