Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_cognitivesearch – Управление службой Azure Cognitive Search

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости, см. Требования для подробностей.

Для использования в playbook укажите: azure.azcollection.azure_rm_cognitivesearch.

Новая версия в azure.azcollection 1.4.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Значения возврата

Описание

  • Создание, обновление или удаление службы Azure Cognitive Search.

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

  • python >= 2.7
  • На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
  • Все пакеты python, перечисленные в requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

append_tags

boolean

Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам.

В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.

Choices:

  • false
  • true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных, используемых для аутентификации.

Также может быть установлено через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE.

При установке в auto (по умолчанию) приоритет имеет параметры модуля -> env -> credential_file -> cli.

При установке в env, учетные данные будут считываться из переменных среды

При установке в credential_file, он будет считывать профиль из ~/.azure/credentials.

При установке в cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию.

При установке в msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурс имеет доступ к более чем одной подписке, в противном случае выбирается первая подписка.

Параметр msi был добавлен в Ansible 2.6.

Choices:

  • "auto" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Choices:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi).

Также может быть установлено через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляра, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате важно убедиться, что настроенный узел полномочий действителен и заслуживает доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Choices:

  • false ← (default)
  • true

hosting_mode

string

Применимо только для SKU standard3.

Вы можете установить это свойство, чтобы включить до 3 разделов высокой плотности, которые позволяют до 1000 индексов.

Для SKU standard3 значением является либо «default», либо «highDensity».

Для всех остальных SKU это значение должно быть «default».

Choices:

  • "default" ← (default)
  • "highDensity"

identity

string

Идентификатор для ресурса.

Choices:

  • "None" ← (default)
  • "SystemAssigned"

location

string

Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

имя

строка / обязательно

Имя службы Azure Cognitive Search.

Имена служб поиска должны содержать только строчные буквы, цифры или дефисы.

Дефис не может быть первой или последней парой символов.

Нельзя использовать последовательные дефисы.

Длина имени должна быть от 2 до 60 символов.

Имена служб поиска должны быть уникальными во всем пространстве имен.

После создания службы изменить имя невозможно.

network_rule_set

список / элементы=строка

Сеть специфические правила, определяющие, как можно получить доступ к службе Azure Cognitive Search.

partition_count

целое число

Количество партиций в службе поиска.

Может принимать значения 1, 2, 3, 4, 6, или 12.

Значения, большие 1, действительны только для стандартных SKU.

Для служб «standard3» с параметром hostingMode, установленным в «highDensity», допустимые значения находятся в диапазоне от 1 до 3.

По умолчанию: 1

пароль

строка

Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо принципа службы.

профиль

строка

Профиль безопасности, найденный в файле ~/.azure/credentials.

public_network_access

строка

Это значение можно установить в enabled, чтобы избежать разрыва совместимости с существующими ресурсами и шаблонами клиентов.

Если установить значение enabled, трафик через общедоступный интерфейс будет запрещён, а подключение к частному конечному пункту станет единственным способом доступа.

Варианты:

  • "enabled" ← (по умолчанию)
  • "disabled"

replica_count

целое число

Количество реплик в службе поиска.

Для sku=standard значение должно быть от 1 до 12 включительно.

Для sku=basic значение должно быть от 1 до 3 включительно.

По умолчанию: 1

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

строка / обязательно

Имя группы ресурсов в текущей подписке.

секрет

строка

Секрет клиента Azure. Используется при аутентификации с принципом службы.

sku

строка

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

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

Варианты:

  • "free"
  • "basic" ← (по умолчанию)
  • "standard"
  • "standard2"
  • "standard3"
  • "storage_optimized_l1"
  • "storage_optimized_l2"

состояние

строка

Установите состояние экземпляра поиска. Установите в present, чтобы создать или обновить экземпляр поиска. Установите в absent, чтобы удалить экземпляр поиска.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

subscription_id

строка

Ваш идентификатор подписки Azure.

теги

словарь

Словарь пар «строка:строка» для присвоения метаданных объекту.

Метаданные тегов объекта будут обновлены всеми предоставленными значениями.

Чтобы удалить теги, установите параметр append_tags в false.

В настоящее время в зонах Azure DNS и службах Traffic Manager также не разрешено использование пробелов в теге.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.

арендатор

строка

Идентификатор аренды Azure. Используется при аутентификации с принципом службы.

thumbprint

строка

добавлен в azure.azcollection 1.14.0

Отпечаток цифрового сертификата закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с принципом службы.

Требуется, если определен x509_certificate_path.

x509_certificate_path

путь

добавлен в azure.azcollection 1.14.0

Путь к сертификату X509, используемому для создания принципа службы в формате PEM.

Сертификат должен быть присоединен к закрытому ключу.

Используется при аутентификации с принципом службы.

Примечания

Примечание

  • Для аутентификации в Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохранённый в файле ~/.azure/credentials, или войти в систему перед запуском задач или воспроизведения сценария с помощью az login.
  • Аутентификация также возможна с использованием принципа службы или пользователя Active Directory.
  • Для аутентификации через принцип службы передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
  • Для аутентификации через пользователя Active Directory передайте ad_user и пароль или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
  • В качестве альтернативы учетные данные могут быть сохранены в ~/.azure/credentials. Это файл ini, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

См. также

Sign in with Azure CLI

Как выполнить аутентификацию с помощью команды az login.

Примеры

- name: Create Azure Cognitive Search
  azure_rm_cognitivesearch:
    resource_group: myResourceGroup
    name: myAzureSearch

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ

Описание

state

dictionary

Информация для Azure Cognitive Search.

Возвращается: всегда

hosting_mode

string

Тип выбранного режима хостинга.

Возвращается: всегда

Пример: "default"

id

string

Уникальный идентификатор, связанный с этим Azure Cognitive Search.

Возвращается: всегда

Пример: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

dictionary

Идентификатор службы Azure Cognitive Search.

Возвращается: всегда

Пример: {"principal_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "type": "SystemAssigned"}

principal_id

string

Присвоенный идентификатор.

Возвращается: успех

Пример: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

type

string

Тип идентификатора.

Возвращается: всегда

Пример: "SystemAssigned"

location

string

Географическое местоположение, где находится служба Azure Cognitive Search.

Возвращается: всегда

Пример: "West Europe"

name

string

Имя службы Azure Cognitive Search.

Возвращается: всегда

Пример: "myazuresearch"

network_rule_set

list / elements=string

Правила, определяющие, как можно получить доступ к службе Azure Cognitive Search.

Возвращается: всегда

Пример: ["1.1.1.1", "8.8.8.8/31"]

partition_count

integer

Количество разделов в службе Azure Cognitive Search.

Возвращается: всегда

Пример: 3

provisioning_state

string

Состояние подготовки службы Azure Cognitive Search.

Возвращается: всегда

Пример: "succeeded"

public_network_access

string

Разрешен ли трафик через общедоступный интерфейс.

Возвращается: всегда

Пример: "enabled"

replica_count

integer

Количество реплик в службе Azure Cognitive Search.

Возвращается: всегда

Пример: 3

sku

string

SKU службы Azure Cognitive Search.

Возвращается: всегда

Пример: "standard"

status

string

Состояние Azure Cognitive Search.

Возвращается: всегда

Пример: "Active running"

tags

dictionary

Теги ресурса.

Возвращается: всегда

Пример: {"tag1": "abc"}

Авторы

  • David Duque Hernández (@next-davidduquehernandez)

Справочные ссылки по коллекции

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_cognitivesearch_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API