модуль azure.azcollection.azure_rm_iothub — управление центром Azure IoT

ad_user

string

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

adfs_authority_url

string

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

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

api_profile

string

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

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

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

append_tags

boolean

Определяет, является ли поле тегов каноническим или только дополняет существующие теги.

Если поле является каноническим, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.

Варианты:

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

auth_source

string

добавлено в 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

добавлено в 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

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

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

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

disable_instance_discovery

boolean

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

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

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

Варианты:

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

enable_file_upload_notifications

boolean

Уведомления о передаче файлов включаются, если задано значение True.

Варианты:

• false
• true

event_endpoint

dictionary

Свойство конечной точки, совместимой с Event Hub.

partition_count

integer

Количество разделов для получения сообщений от устройства к облаку в конечной точке, совместимой с Event Hub.

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

Значение по умолчанию — 2.

retention_time_in_days

integer

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

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

Значение по умолчанию — 1.

identity

dictionary

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

type

string

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

Варианты:

• "SystemAssigned"
• "UserAssigned"
• "None" ← (по умолчанию)

user_assigned_identities

dictionary

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

По умолчанию: {}

append

boolean

Следует ли добавить список удостоверений к текущим удостоверениям (true) или заменить текущие удостоверения (false)

Варианты:

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

id

list / элементы=string

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

По умолчанию: []

ip_filters

list / элементы=dictionary

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

action

string / обязательный

Действие, которое следует выполнить для запросов, соответствующих этому правилу.

Варианты:

• "accept"
• "reject"

ip_mask

string / обязательный

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

name

string / обязательный

Имя фильтра.

location

string

Расположение центра Интернета вещей (IoT Hub).

log_mode

string

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

log_path

string

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

name

string / обязательный

Имя центра Интернета вещей (IoT Hub).

oidc_token

string

добавлено в 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

path

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

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

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

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

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

password

string

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

profile

string

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

resource_group

string / обязательный

Имя группы ресурсов.

routes

list / элементы=dictionary

Маршрутизация сообщений от устройства к облаку в конечные точки служб.

condition

string

Выражение запроса для запроса маршрутизации, выполняемого над свойствами приложения сообщения, системными свойствами, телом сообщения, тегами двойника устройства и свойствами двойника устройства, чтобы определить, соответствует ли сообщение конечной точке.

Дополнительные сведения о составлении запроса см. в разделе https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-routing-query-syntax

enabled

boolean / обязательный

Включить ли маршрут.

Варианты:

• false
• true

endpoint_name

string / обязательный

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

name

string / обязательный

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

source

string / обязательный

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

Варианты:

• "device_messages"
• "twin_change_events"
• "device_lifecycle_events"
• "device_job_lifecycle_events"

routing_endpoints

list / элементы=dictionary

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

connection_string

string / обязательный

Строка подключения пользовательской конечной точки.

Строка подключения должна предоставлять разрешение на отправку.

container_name

псевдонимы: container

string

Имя контейнера пользовательской конечной точки, если resource_type=storage.

encoding

string

Кодировка сообщения, если resource_type=storage.

name

string / обязательный

Имя пользовательской конечной точки.

resource_group

string

Группа ресурсов конечной точки.

По умолчанию используется та же группа, что и в resource_group.

resource_type

string / обязательный

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

Варианты:

• "eventhub"
• "queue"
• "storage"
• "topic"

subscription

string

Идентификатор подписки конечной точки.

По умолчанию используется та же подписка, что и в subscription.

secret

string

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

sku

string

Ценовая категория Azure IoT Hub.

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

При создании по умолчанию используется s1.

Варианты:

• "b1"
• "b2"
• "b3"
• "f1"
• "s1"
• "s2"
• "s3"

state

string

Состояние центра IoT Hub. Используйте present для создания или обновления центра IoT Hub и absent для его удаления.

Варианты:

• "absent"
• "present" ← (по умолчанию)

subscription_id

string

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

tags

dictionary

Словарь пар строка:строка для назначения объекту в качестве метаданных.

Теги метаданных объекта будут обновлены с учетом всех указанных значений.

Чтобы удалить теги, установите для параметра append_tags значение false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в тегах.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.

tenant

string

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

thumbprint

string

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

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

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

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

unit

integer

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

Значение по умолчанию — 1.

x509_certificate_path

path

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

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

Закрытый ключ должен быть добавлен в конец сертификата.

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

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

boolean

Указывает, включены ли уведомления о загрузке файлов.

Возвращается: успешно

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

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

string

Указывает, включен ли маршрут.

Возвращается: успешно

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

unit

integer

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

Возвращается: успешно

Пример: 1