Spec-Zone.ru › Ansible 2.11

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

Примечание

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

Для его установки используйте: 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 могут использоваться для определения идентификатора подписки, если их несколько; иначе используется подписка по умолчанию из Azure 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
логическое значение
    Варианты:
  • no
  • yes
Вывести список групп потребителей встроенного event hub.
list_keys
логическое значение
    Варианты:
  • no
  • yes
Вывести список ключей IoT Hub.
Обратите внимание, что это потребует сетевых затрат для каждого IoT Hub.
name
строка
Ограничить результаты конкретным ресурсным группам.
password
строка
Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
строка
Ресурсная группа для поиска необходимого IoT Hub.
secret
строка
Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала.
show_endpoint_health
логическое значение
    Варианты:
  • no
  • yes
Получить состояние конечных точек маршрутизации.
Обратите внимание, что это потребует сетевых затрат для каждого IoT Hub.
show_quota_metrics
логическое значение
    Варианты:
  • no
  • yes
Получить показатели квот для IoT Hub.
Обратите внимание, что это потребует сетевых затрат для каждого IoT Hub.
show_stats
логическое значение
    Варианты:
  • no
  • yes
Показать статистику для 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
всегда
Желаемое действие для запросов, захваченных этим правилом.

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

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

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

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

Пример:
Тестирование
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_iothub_info_module.html

Spec-Zone.ru

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