Модуль azure.azcollection.azure_rm_iotdevicemodule — управление модулем устройства Центра Интернета вещей Azure

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_method

string

Тип авторизации, с которым будет создана сущность.

Варианты:

• "sas" ← (по умолчанию)
• "certificate_authority"
• "self_signed"

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

desired

dictionary

Используется вместе с сообщаемыми свойствами для синхронизации конфигурации или состояния устройства.

Теги могут быть вложенным словарем; в ключах запрещены символы «.», «$», «#» и пробел.

Списки не поддерживаются.

device

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

Имя устройства, с которым связан модуль.

disable_instance_discovery

boolean

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

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

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

Варианты:

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

hub

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

Имя Центра Интернета вещей.

hub_policy_key

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

Ключ для hub_policy_name.

hub_policy_name

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

Имя политики Центра Интернета вещей, которая будет использоваться для запросов к Центру Интернета вещей.

Эта политика должна предоставлять как минимум доступ «Чтение реестра».

log_mode

string

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

log_path

string

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

name

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

Имя удостоверения устройства Центра Интернета вещей.

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, а не субъекта-службы.

primary_key

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

string

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

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

profile

string

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

secondary_key

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

string

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

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

secret

string

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

state

string

Состояние Центра Интернета вещей. Используйте present для создания или обновления устройства Центра Интернета вещей и 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.

twin_tags

dictionary

Раздел, который серверная часть решения может читать и изменять.

Теги не видны приложениям устройств.

Теги могут быть вложенным словарем; в ключах запрещены символы «.», «$», «#» и пробел.

Списки не поддерживаются.

x509_certificate_path

path

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

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

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

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

module

dictionary

Устройство Центра Интернета вещей.

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

Пример: {"authentication": {"symmetricKey": {"primaryKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "secondaryKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"}, "type": "sas", "x509Thumbprint": {"primaryThumbprint": null, "secondaryThumbprint": null}}, "cloudToDeviceMessageCount": 0, "connectionState": "Disconnected", "connectionStateUpdatedTime": "0001-01-01T00:00:00", "deviceId": "mydevice", "etag": "ODM2NjI3ODg=", "generationId": "636904759703045768", "lastActivityTime": "0001-01-01T00:00:00", "managedBy": null, "moduleId": "Testing"}