Spec-Zone.ru › Ansible 2.9

azure_rm_iothub_info – Получение фактов о Центре IoT

Новая версия 2.9.

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

Обзор

  • Получение фактов о конкретном Центре IoT или всех Центрах IoT.

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не принципала службы.
adfs_authority_url
строка
добавлено в 2.6
URL-адрес источника Azure AD. Используется при аутентификации с именем пользователя/паролем и собственном источнике ADFS.
api_profile
строка
добавлено в 2.5
 По умолчанию:
"latest"
Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source
строка
добавлено в 2.5
    Варианты:
  • auto
  • cli
  • credential_file
  • env
  • msi
Определяет источник учетных данных для аутентификации.
Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE, по умолчанию auto при отсутствии переменной.
auto будет следовать стандартному порядку приоритета параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.
При значении cli, учетные данные берутся из профиля Azure CLI по умолчанию.
Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.
При значении msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурс имеет доступ к нескольким подпискам; в противном случае выбирается первая подписка.
msi было добавлено в Ansible 2.6.
cert_validation_mode
строка
добавлено в 2.5
    Варианты:
  • ignore
  • validate
Определяет поведение проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передавая ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
cloud_environment
строка
добавлено в 2.4
 По умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки доступа к метаданным (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.
list_consumer_groups
логическое
    Варианты:
  • no
  • yes
Отобразить группу потребителей встроенного узла событий.
list_keys
логическое
    Варианты:
  • no
  • yes
Отобразить ключи Центра IoT.
Обратите внимание, что это повлечёт сетевую нагрузку для каждого Центра IoT.
name
строка
Ограничить результаты конкретной группой ресурсов.
password
строка
Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не принципала службы.
profile
строка
Профиль безопасности, расположенный в файле ~/.azure/credentials.
resource_group
строка
Группа ресурсов, в которой необходимо найти Центр IoT.
secret
строка
Секретный ключ клиента Azure. Используется при аутентификации с принципалом службы.
show_endpoint_health
логическое
    Варианты:
  • no
  • yes
Получить состояние маршрутизируемых точек доступа.
Обратите внимание, что это повлечёт сетевую нагрузку для каждого Центра IoT.
show_quota_metrics
логическое
    Варианты:
  • no
  • yes
Получить квоты для Центра IoT.
Обратите внимание, что это повлечёт сетевую нагрузку для каждого Центра IoT.
show_stats
логическое
    Варианты:
  • no
  • yes
Отобразить статистику Центра IoT.
Обратите внимание, что это повлечёт сетевую нагрузку для каждого Центра IoT.
subscription_id
строка
Ваш идентификатор подписки Azure.
tags
список
Ограничить результаты, предоставив список тегов. Формат тегов: 'ключ' или 'ключ:значение'.
tenant
строка
Идентификатор Azure-аренды. Используется при аутентификации с принципалом службы.
test_route_message
строка
Текст сообщения для проверки маршрутов. Он будет использован для проверки всех маршрутов.

Примечания

Примечание

  • Для аутентификации в 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 и 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 facts for one IoT Hub
  azure_rm_iothub_info:
    name: Testing
    resource_group: myResourceGroup

- name: Get facts for all IoT Hubs
  azure_rm_iothub_info:

- name: Get facts for all IoT Hubs in a specific resource group
  azure_rm_iothub_info:
    resource_group: myResourceGroup

- name: Get facts by tags
  azure_rm_iothub_info:
    tags:
      - testing

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

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

Ключ Возвращаемое значение Описание
azure_iothubs
сложный
всегда
Список словарей IoT Hub.
cloud_to_device
сложный
всегда
Свойства сообщения с облака на устройство.
max_delivery_count
целое число
всегда
Количество попыток IoT Hub доставить сообщение в очередь обратной связи.
См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

Пример:
10
ttl_as_iso8601
строка
всегда
Период времени, в течение которого сообщение доступно для обработки, прежде чем IoT Hub его устареет.
См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

Пример:
1:00:00
enable_file_upload_notifications
строка
всегда
Включены ли уведомления о загрузке файлов.

Пример:
True
event_endpoints
сложный
всегда
Встроенный конечный пункт для доставки сообщений устройства.
endpoint
строка
всегда
Конечный пункт, совместимый с Event Hub.

Пример:
sb://iothub-ns-testing-1478811-9bbc4a15f0.servicebus.windows.net/
partition_count
целое число
всегда
Количество разделов для получения сообщений с устройства на облако в совместимом с Event Hub конечном пункте.
См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

Пример:
2
partition_ids
список
всегда
Список идентификаторов разделов для конечного пункта событий.

Пример:
['0', '1']
retention_time_in_days
целое число
всегда
Срок хранения сообщений с устройства на облако в днях.
См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

Пример:
1
host_name
строка
всегда
Хост IoT Hub.

Пример:
testing.azure-devices.net
id
строка
всегда
Идентификатор ресурса IoT Hub.

Пример:
/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/Testing
ip_filters
сложный
всегда
Настройка правил для отклонения или принятия трафика со специфических IPv4 адресов.
action
строка
всегда
Желаемое действие для запросов, захваченных этим правилом.

Пример:
Reject
ip_mask
строка
всегда
Строка, содержащая диапазон IP-адресов в формате CIDR для правила.

Пример:
40.54.7.3
name
строка
всегда
Имя фильтра.

Пример:
filter
location
строка
всегда
Расположение IoT Hub.

Пример:
eastus
name
строка
всегда
Имя IoT Hub.

Пример:
Testing
resource_group
строка
всегда
Ресурсная группа IoT Hub.

Пример:
myResourceGroup.
routes
сложный
всегда
Маршрутизация сообщений с устройства на облако к конечным точкам, ориентированным на службы.
condition
логический
всегда
Выражение запроса для запроса маршрутизации, выполняемого над свойствами приложения сообщения, системными свойствами, телом сообщения, тегами твина устройства и свойствами твина устройства, чтобы определить, соответствует ли оно конечной точке.
Для получения дополнительной информации о построении запроса см. https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-routing-query-syntax

Пример:
true
enabled
логический
всегда
Включить маршрут.

Пример:
True
endpoint_name
строка
всегда
Имя конечной точки в routing_endpoints, куда IoT Hub отправляет сообщения, соответствующие запросу.

Пример:
foo
name
строка
всегда
Имя маршрута.

Пример:
route1
source
строка
всегда
Источник потока данных, к которому применяется действие.

Пример:
device_messages
routing_endpoints
complex
always
Пользовательские конечные точки.
event_hubs
complex
always
Список пользовательских конечных точек центров событий.
connection_string
string
always
Строка подключения к пользовательской конечной точке.

Пример:
Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo
name
string
always
Имя пользовательской конечной точки.

Пример:
foo
resource_group
string
always
Группа ресурсов конечной точки.

Пример:
bar
subscription
string
always
Идентификатор подписки на конечную точку.

Пример:
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
service_bus_queues
complex
always
Список пользовательских конечных точек очереди службы сообщений.
connection_string
string
always
Строка подключения к пользовательской конечной точке.

Пример:
Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo
name
string
always
Имя пользовательской конечной точки.

Пример:
foo
resource_group
string
always
Группа ресурсов конечной точки.

Пример:
bar
subscription
string
always
Идентификатор подписки на конечную точку.

Пример:
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
service_bus_topics
complex
always
Список пользовательских конечных точек темы службы сообщений.
connection_string
string
always
Строка подключения к пользовательской конечной точке.

Пример:
Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo
name
string
always
Имя пользовательской конечной точки.

Пример:
foo
resource_group
string
always
Группа ресурсов конечной точки.

Пример:
bar
subscription
string
always
Идентификатор подписки на конечную точку.

Пример:
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
storage_containers
complex
always
Список пользовательских конечных точек хранилища.
connection_string
string
always
Строка подключения к пользовательской конечной точке.

Пример:
Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo
name
string
always
Имя пользовательской конечной точки.

Пример:
foo
resource_group
string
always
Группа ресурсов конечной точки.

Пример:
bar
subscription
string
always
Идентификатор подписки на конечную точку.

Пример:
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
sku
string
always
Тарифный план ценообразования для Azure IoT Hub.

Пример:
f1
tags
dictionary
always
Ограничение результатов с помощью списка тегов. Формат тегов: 'ключ' или 'ключ:значение'.

Пример:
{'key1': 'value1'}
unit
integer
always
Единицы измерения в IoT Hub.

Пример:
1


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Yuwei Zhou (@yuwzho)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_iothub_info_module.html

Spec-Zone.ru

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