Модуль azure.azcollection.azure_rm_iothub_info — получение сведений об IoT Hub

ad_user

строка

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

adfs_authority_url

строка

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

URL-адрес центра сертификации Azure AD. Используйте при аутентификации по имени пользователя и паролю, если у вас есть собственный центр сертификации ADFS.

api_profile

строка

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

Выбор профиля API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

auth_source

строка

добавлено в 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; в противном случае будет использована подписка Azure CLI по умолчанию.

Если задано значение msi, узел должен быть ресурсом Azure с включенным расширением MSI. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную окружения AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

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

Варианты:

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

cert_validation_mode

строка

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

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

Варианты:

• "ignore"
• "validate"

client_id

строка

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

Можно также задать с помощью переменной окружения AZURE_CLIENT_ID.

cloud_environment

строка

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

Для облачных сред, отличных от общедоступного облака США, — имя среды (согласно определению Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязателен для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

логический

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

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра сертификации будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно связаться с конечной точкой метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляров включает получение метаданных центра сертификации с сайта https://login.microsoft.com/ для проверки центра сертификации. Если задать значение **True**, проверка центра сертификации отключается. Поэтому крайне важно убедиться, что настроенный узел центра сертификации является допустимым и заслуживающим доверия.

Задайте значение в профиле файла учетных данных или с помощью переменной окружения AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

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

list_consumer_groups

логический

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

Варианты:

• false
• true

list_keys

логический

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

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

Варианты:

• false
• true

log_mode

строка

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

log_path

строка

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

name

строка

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

oidc_token

строка

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

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC.

Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Можно также задать с помощью переменной окружения AZURE_FEDERATED_TOKEN.

oidc_token_file_path

путь

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

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации удостоверения рабочей нагрузки.

Файл должен содержать только исходный токен.

Этот способ часто используется на платформах, которые сохраняют токены OIDC в файлах.

Можно также задать с помощью переменной окружения AZURE_FEDERATED_TOKEN_FILE.

password

строка

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

profile

строка

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

resource_group

строка

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

secret

строка

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

show_endpoint_health

логический

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

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

Варианты:

• false
• true

show_quota_metrics

логический

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

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

Варианты:

• false
• true

show_stats

логический

Показать статистику IoT Hub.

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

Варианты:

• false
• true

subscription_id

строка

Идентификатор вашей подписки Azure.

tags

список / elements=string

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

tenant

строка

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

test_route_message

строка

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

thumbprint

строка

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

Отпечаток закрытого ключа, указанного в x509_certificate_path.

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

Обязателен, если задан x509_certificate_path.

x509_certificate_path

путь

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

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

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

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

azure_iothubs

complex

Список словарей IoT Hub.

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

cloud_to_device

complex

Свойства сообщений из облака на устройство.

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

max_delivery_count

integer

Количество попыток центра IoT доставить сообщение в очередь обратной связи.

См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.

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

Пример: 10

ttl_as_iso8601

string

Период времени, в течение которого сообщение доступно для получения, прежде чем центр IoT удалит его по истечении срока действия.

См. 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.

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

Пример: "testing.azure-devices.net"

id

string

Идентификатор ресурса центра IoT.

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

Пример: "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/Testing"

identity

complex

Удостоверение сервера.

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

type

string

Тип управляемого удостоверения

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

Пример: "UserAssigned"

user_assigned_identities

complex

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

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

id

dictionary

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

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

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

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

Пример: "foo"

name

string

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

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

Пример: "route1"

source

string

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

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

Пример: "device_messages"

routing_endpoints

complex

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

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

event_hubs

complex

Список пользовательских конечных точек Event Hubs.

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

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

dictionary

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

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

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

unit

integer

Количество единиц в IoT Hub.

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

Пример: 1