Spec-Zone.ru › Ansible 2.10

azure.azcollection.azure_rm_iothub_info – Получение фактов об IoT Hub

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

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

Новое в версии 0.1.2: из azure.azcollection

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

Обзор

  • Получение фактов для определенного IoT Hub или всех IoT Hub.

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным принципом службы.
adfs_authority_url
строка
добавлено в 0.0.1 azure.azcollection
URL-адрес полномочий Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственным авторитетом ADFS.
api_profile
строка
добавлено в 0.0.1 azure.azcollection
По умолчанию:
"latest"
Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
auth_source
строка
добавлено в 0.0.1 azure.azcollection
    Варианты:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Также можно установить через переменную среды 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.
cert_validation_mode
строка
добавлено в 0.0.1 azure.azcollection
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задан в профиле файла учетных данных или в переменной среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используйте при аутентификации с главным принципом службы.
cloud_environment
строка
добавлено в 0.0.1 azure.azcollection
По умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки доступа для обнаружения метаданных (требуется для Azure Stack). Также может быть задан в профиле файла учетных данных или в переменной среды AZURE_CLOUD_ENVIRONMENT.
list_consumer_groups
булево
    Варианты:
  • нет
  • да
Список групп потребителей встроенного Event Hub.
list_keys
булево
    Варианты:
  • нет
  • да
Список ключей IoT Hub.
Обратите внимание, что это потребует сетевых затрат для каждого IoT Hub.
name
строка
Ограничить результаты определенной группой ресурсов.
password
строка
Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным принципом службы.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
строка
Группа ресурсов, в которой нужно искать нужный IoT Hub.
secret
строка
Секрет клиента Azure. Используйте при аутентификации с главным принципом службы.
show_endpoint_health
булево
    Варианты:
  • нет
  • да
Получить состояние маршрутизируемых точек входа.
Обратите внимание, что это потребует сетевых затрат для каждого IoT Hub.
show_quota_metrics
булево
    Варианты:
  • нет
  • да
Получить показатели квот для IoT Hub.
Обратите внимание, что это потребует сетевых затрат для каждого IoT Hub.
show_stats
булево
    Варианты:
  • нет
  • да
Показать статистику для IoT Hub.
Обратите внимание, что это потребует сетевых затрат для каждого IoT Hub.
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
complex
всегда
Список словарей IoT Hub.
cloud_to_device
complex
всегда
Свойства сообщения "облако-устройство".
max_delivery_count
integer
всегда
Количество попыток IoT Hub доставить сообщение в очередь обратной связи.
См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

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

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

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

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

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

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

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

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

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

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

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

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

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

Пример:
Testing
resource_group
string
всегда
Группа ресурсов IoT Hub.

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

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

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

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

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

Пример:
device_messages
routing_endpoints
complex
всегда
Пользовательские конечные пункты.
event_hubs
complex
всегда
Список пользовательских конечных пунктов Event Hub.
connection_string
string
всегда
Строка подключения к пользовательскому конечному пункту.

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

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

Пример:
bar
subscription
string
всегда
Идентификатор подписки на конечный пункт.

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

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

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

Пример:
bar
subscription
string
всегда
Идентификатор подписки на конечный пункт.

Пример:
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


Авторы

  • 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.10/collections/azure/azcollection/azure_rm_iothub_info_module.html

Spec-Zone.ru

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