SearchService Класс
Описывает службу Когнитивный поиск Azure и ее текущее состояние.
Переменные заполняются только сервером и игнорируются при отправке запроса.
Для отправки в Azure необходимо заполнить все необходимые параметры.
- Наследование
-
azure.mgmt.search.models._models_py3.TrackedResourceSearchService
Конструктор
SearchService(*, location: str, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, identity: _models.Identity | None = None, replica_count: int = 1, partition_count: int = 1, hosting_mode: str | _models.HostingMode = 'default', public_network_access: str | _models.PublicNetworkAccess = 'enabled', network_rule_set: _models.NetworkRuleSet | None = None, encryption_with_cmk: _models.EncryptionWithCmk | None = None, disable_local_auth: bool | None = None, auth_options: _models.DataPlaneAuthOptions | None = None, **kwargs: Any)Параметры
- location
- str
Географическое расположение, в котором находится ресурс. Обязательный.
- sku
- Sku
Номер SKU службы поиска, который определяет ценовую категорию и ограничения емкости. Это свойство является обязательным при создании новой службы поиска.
- identity
- Identity
Удостоверение ресурса.
- replica_count
- int
Количество реплик в службе поиска. Если указано значение, оно должно быть значением от 1 до 12 включительно для номеров SKU уровня "Стандартный" или от 1 до 3 включительно для SKU "Базовый".
- partition_count
- int
Количество секций в службе поиска; Если указано, это может быть 1, 2, 3, 4, 6 или 12. Значения больше 1 допустимы только для стандартных номеров SKU. Для служб standard3 с параметром hostingMode, для которых задано значение highDensity, допустимые значения находятся в диапазоне от 1 до 3.
- hosting_mode
- str или HostingMode
Применимо только для SKU "Стандартный3". Это свойство можно задать, чтобы включить до 3 секций с высокой плотностью, допускающих до 1000 индексов, что значительно превышает максимальное значение, допустимое для любого другого номера SKU. Для номера SKU Standard3 используется значение default или highDensity. Для всех остальных номеров SKU это значение должно быть "default". Известные значения: default и highDensity.
- public_network_access
- str или PublicNetworkAccess
Для этого значения можно задать значение enabled, чтобы избежать критических изменений в существующих клиентских ресурсах и шаблонах. Если задано значение disabled, трафик через общедоступный интерфейс не разрешен, и подключения к частным конечным точкам будут монопольным методом доступа. Известные значения: "enabled" и "disabled".
- network_rule_set
- NetworkRuleSet
Правила, относящиеся к сети, которые определяют, как может быть достигнута служба Когнитивный поиск Azure.
- encryption_with_cmk
- EncryptionWithCmk
Указывает любую политику, касающуюся шифрования ресурсов (например, индексов) с помощью ключей диспетчера клиентов в службе поиска.
- disable_local_auth
- bool
Если задано значение true, вызовы службы поиска не смогут использовать ключи API для проверки подлинности. Если задано значение "dataPlaneAuthOptions", для этого параметра не может быть задано значение true.
- auth_options
- DataPlaneAuthOptions
Определяет параметры того, как API плоскости данных службы поиска проверяет подлинность запросов. Этот параметр не может быть задан, если для параметра disableLocalAuth задано значение true.
Переменные
- id
- str
Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
- name
- str
Имя ресурса.
- type
- str
Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.
- location
- str
Географическое расположение, в котором находится ресурс. Обязательный.
- sku
- Sku
Номер SKU службы поиска, который определяет ценовую категорию и ограничения емкости. Это свойство является обязательным при создании новой службы поиска.
- identity
- Identity
Удостоверение ресурса.
- replica_count
- int
Количество реплик в службе поиска. Если указано значение, оно должно быть значением от 1 до 12 включительно для номеров SKU уровня "Стандартный" или от 1 до 3 включительно для SKU "Базовый".
- partition_count
- int
Количество секций в службе поиска; Если указано, это может быть 1, 2, 3, 4, 6 или 12. Значения больше 1 допустимы только для стандартных номеров SKU. Для служб standard3 с параметром hostingMode, для которых задано значение highDensity, допустимые значения находятся в диапазоне от 1 до 3.
- hosting_mode
- str или HostingMode
Применимо только для SKU "Стандартный3". Это свойство можно задать, чтобы включить до 3 секций с высокой плотностью, допускающих до 1000 индексов, что значительно превышает максимальное значение, допустимое для любого другого номера SKU. Для номера SKU Standard3 используется значение default или highDensity. Для всех остальных номеров SKU это значение должно быть "default". Известные значения: default и highDensity.
- public_network_access
- str или PublicNetworkAccess
Для этого значения можно задать значение enabled, чтобы избежать критических изменений в существующих клиентских ресурсах и шаблонах. Если задано значение disabled, трафик через общедоступный интерфейс не разрешен, и подключения к частным конечным точкам будут монопольным методом доступа. Известные значения: "enabled" и "disabled".
- status
- str или SearchServiceStatus
Состояние службы поиска. Возможные значения: running: служба поиска запущена и операции подготовки не выполняются. "подготовка": служба поиска подготавливается, масштабируется вверх или вниз. "deleting": служба поиска удаляется. "ухудшено": служба поиска понижена. Это может произойти, если базовые единицы поиска не работоспособны. Служба поиска, скорее всего, работает, но производительность может быть низкой, а некоторые запросы могут быть удалены. "disabled": служба поиска отключена. В этом состоянии служба отклоняет все запросы API. "error": служба поиска находится в состоянии ошибки. Если служба находится в состоянии понижения производительности, отключения или ошибки, это означает, что команда Когнитивный поиск Azure активно изучает базовую проблему. Выделенные службы в этих состояниях по-прежнему оплачиваются по количеству подготовленных единиц поиска. Известные значения: "running", "provisioning", "deleting", "degraded", "disabled", "error" и "stopped".
- status_details
- str
Сведения о состоянии службы поиска.
- provisioning_state
- str или ProvisioningState
Состояние последней операции подготовки, выполненной в службе поиска. Подготовка — это промежуточное состояние, которое наступает при установке емкости службы. После настройки емкости provisioningState изменится на "успешно" или "сбой". Клиентские приложения могут опрашивать состояние подготовки (рекомендуемый интервал опроса — от 30 секунд до одной минуты), используя операцию Получения службы поиска, чтобы узнать, когда операция завершена. Если вы используете бесплатную службу, это значение, как правило, возвращается как "успешно" непосредственно в вызове create search service. Это объясняется тем, что бесплатная служба использует уже настроенную емкость. Известные значения: "успешно", "подготовка" и "сбой".
- network_rule_set
- NetworkRuleSet
Правила, относящиеся к сети, которые определяют, как может быть достигнута служба Когнитивный поиск Azure.
- encryption_with_cmk
- EncryptionWithCmk
Указывает любую политику, касающуюся шифрования ресурсов (например, индексов) с помощью ключей диспетчера клиентов в службе поиска.
- disable_local_auth
- bool
Если задано значение true, вызовы службы поиска не смогут использовать ключи API для проверки подлинности. Если задано значение "dataPlaneAuthOptions", для этого параметра не может быть задано значение true.
- auth_options
- DataPlaneAuthOptions
Определяет параметры того, как API плоскости данных службы поиска проверяет подлинность запросов. Этот параметр не может быть задан, если для параметра disableLocalAuth задано значение true.
- private_endpoint_connections
- list[PrivateEndpointConnection]
Список подключений к частной конечной точке к службе Когнитивный поиск Azure.
- shared_private_link_resources
- list[SharedPrivateLinkResource]
Список общих ресурсов приватного канала, управляемых службой Когнитивный поиск Azure.