Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_cognitivesearch_info – Получение информации о службе Azure Cognitive Search

Примечание

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

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

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

Для использования в книге задач укажите: azure.azcollection.azure_rm_cognitivesearch_info.

Новая функция в azure.azcollection 1.4.0

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

Обзор

  • Получение информации о конкретной службе Azure Cognitive Search или всех службах 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"

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 могут использоваться для идентификации ID подписки, если присутствует более одной, в противном случае используется подписка az cli по умолчанию.

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

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

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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

Варианты:

  • "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.

Варианты:

  • false ← (по умолчанию)
  • true

log_mode

string

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

log_path

string

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

name

string

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

password

string

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

profile

string

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

resource_group

string

Имя группы ресурсов Azure.

secret

string

Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности.

show_keys

boolean

Получить ключи администратора и запроса.

Варианты:

  • false ← (по умолчанию)
  • true

subscription_id

string

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

tenant

string

Идентификатор Azure-аренды. Используется при аутентификации с помощью сервисного принципала.

thumbprint

string

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

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

Используется при аутентификации с помощью сервисного принципала.

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

x509_certificate_path

path

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

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

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

Используется при аутентификации с помощью сервисного принципала.

Примечания

Примечание

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

См. также

См. также

Вход в Azure CLI

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

Примеры

- name: Get Azure Cognitive Search info from resource group 'myResourceGroup' and name 'myAzureSearch'
  azure_rm_cognitivesearch_info:
    resource_group: myResourceGroup
    name: myAzureSearch

- name: Get Azure Cognitive Search info from resource group 'myResourceGroup'
  azure_rm_cognitivesearch_info:
    resource_group: myResourceGroup

- name: Get all Azure Cognitive Search info
  azure_rm_cognitivesearch_info:

Значения возврата

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

Ключ

Описание

search

list / elements=string

Информация для 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"

keys

dictionary

Административные и ключи запроса для службы Azure Cognitive Search.

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

admin_primary

string

Основной административный ключ для службы Azure Cognitive Search.

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

Пример: "12345ABCDE67890FGHIJ123ABC456DEF"

admin_secondary

string

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

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

Пример: "12345ABCDE67890FGHIJ123ABC456DEF"

query

list / elements=string

Список ключей запроса для службы Azure Cognitive Search.

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

Пример: [{"key": "12345ABCDE67890FGHIJ123ABC456DEF", "name": "Query key"}]

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

словарь

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

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

Пример: {"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_info_module.html

Spec-Zone.ru

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