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

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

При установке в msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_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

list_consumer_groups

boolean

Вывести список групп потребителей встроенного концентратора событий.

Варианты:

• false
• true

list_keys

boolean

Вывести список ключей IoT Hub.

Обратите внимание, что это будет создавать сетевую нагрузку для каждого IoT Hub.

Варианты:

• false
• true

log_mode

string

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

log_path

string

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

name

string

Ограничить результаты определенной группой ресурсов.

password

string

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

profile

string

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

resource_group

string

Группа ресурсов для поиска нужного IoT Hub.

secret

string

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

show_endpoint_health

boolean

Получить состояние маршрутизируемых конечных точек.

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

Выберите:

• false
• true

show_quota_metrics

boolean

Получить квоты метрик для IoT Hub.

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

Выберите:

• false
• true

show_stats

boolean

Отобразить статистику для IoT Hub.

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

Выберите:

• false
• true

subscription_id

string

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

tags

list / elements=string

Ограничить результаты, предоставив список тегов. Формат тегов — ‘ключ’ или ‘ключ:значение’.

tenant

string

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

test_route_message

string

Сообщение для тестирования маршрутов. Оно будет использоваться для проверки всех маршрутов.

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_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"

identity

сложное

Идентификатор сервера.

Возвращается: при наличии

type

строка

Тип управляемой идентификации

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

Пример: "UserAssigned"

user_assigned_identities

сложное

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

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

id

словарь

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

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

ip_filters

complex

Настройка правил для отклонения или принятия трафика от определенных IPv4-адресов.

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

action

string

Требуемое действие для запросов, захваченных этим правилом.

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

Пример: "Reject"

ip_mask

string

Строка, содержащая диапазон IP-адресов в нотации CIDR для правила.

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

Пример: "40.54.7.3"

name

string

Имя фильтра.

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

Пример: "filter"

location

string

Местоположение центра IoT.

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

Пример: "eastus"

name

string

Имя центра IoT.

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

Пример: "Testing"

resource_group

string

Группа ресурсов центра IoT.

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

Пример: "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 отправляет сообщения, соответствующие запросу.

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

Пример: "foo"

name

string

Имя маршрута.

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

Пример: "route1"

source

string

Источник потока данных, к которому нужно применить действие.

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

Пример: "device_messages"

routing_endpoints

complex

Пользовательские конечные точки.

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

event_hubs

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_queues

complex

Список настраиваемых конечных точек очереди Service Bus.

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

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

Список настраиваемых конечных точек темы Service Bus.

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

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"

storage_containers

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"

sku

string

Ценовой тариф Azure IoT Hub.

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

Пример: "f1"

tags

словарь

Ограничить результаты, предоставив список тегов. Формат тегов — ‘ключ’ или ‘ключ:значение’.

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

Пример: {"key1": "value1"}

unit

целое число

Единицы в IoT Hub.

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

Пример: 1