azure.azcollection.azure_rm_iotdevicemodule – Manage Azure IoT hub device module

Note

This plugin is part of the azure.azcollection collection.

To install it use: ansible-galaxy collection install azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_rm_iotdevicemodule.

New in version 0.1.2: of azure.azcollection

Synopsis

  • Create, delete an Azure IoT hub device module.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • azure >= 2.0.0

Parameters

Parameter Choices/Defaults Comments
ad_user
string
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url
string
added in 0.0.1 of azure.azcollection
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile
string
added in 0.0.1 of azure.azcollection
Default:
"latest"
Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags
boolean
    Choices:
  • no
  • yes ←
Use to control if tags field is canonical or just appends to existing tags.
When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
auth_method
string
    Choices:
  • sas ←
  • certificate_authority
  • self_signed
The authorization type an entity is to be created with.
auth_source
string
added in 0.0.1 of azure.azcollection
    Choices:
  • auto
  • cli
  • credential_file
  • env
  • msi
Controls the source of the credentials to use for authentication.
If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.
auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.
When set to cli, the credentials will be sources from the default Azure CLI profile.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.
The msi was added in Ansible 2.6.
cert_validation_mode
string
added in 0.0.1 of azure.azcollection
    Choices:
  • ignore
  • validate
Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.
client_id
string
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
string
added in 0.0.1 of azure.azcollection
Default:
"AzureCloud"
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.
desired
dictionary
Used along with reported properties to synchronize device configuration or conditions.
The tag can be nested dictionary, '.', '$', '#', ' ' is not allowed in the key.
List is not supported.
device
string / required
Device name the module associate with.
hub
string / required
Name of IoT Hub.
hub_policy_key
string / required
Key of the hub_policy_name.
hub_policy_name
string / required
Policy name of the IoT Hub which will be used to query from IoT hub.
This policy should have at least 'Registry Read' access.
name
string / required
Name of the IoT hub device identity.
password
string
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
primary_key
string
Explicit self-signed certificate thumbprint to use for primary key.
Explicit Shared Private Key to use for primary key.

aliases: primary_thumbprint
profile
string
Security profile found in ~/.azure/credentials file.
secondary_key
string
Explicit self-signed certificate thumbprint to use for secondary key.
Explicit Shared Private Key to use for secondary key.

aliases: secondary_thumbprint
secret
string
Azure client secret. Use when authenticating with a Service Principal.
state
string
    Choices:
  • absent
  • present ←
State of the IoT hub. Use present to create or update an IoT hub device and absent to delete an IoT hub device.
subscription_id
string
Your Azure subscription Id.
tags
dictionary
Dictionary of string:string pairs to assign as metadata to the object.
Metadata tags on the object will be updated with any provided values.
To remove tags set append_tags option to false.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.
twin_tags
dictionary
A section that the solution back end can read from and write to.
Tags are not visible to device apps.
The tag can be nested dictionary, '.', '$', '#', ' ' is not allowed in the key.
List is not supported.

Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.

  • Authentication is also possible using a service principal or Active Directory user.

  • To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

  • To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

  • Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Create simplest Azure IoT Hub device module
  azure_rm_iotdevicemodule:
    hub: myHub
    name: Testing
    device: mydevice
    hub_policy_name: iothubowner
    hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

- name: Create Azure IoT Edge device module
  azure_rm_iotdevice:
    hub: myHub
    device: mydevice
    name: Testing
    hub_policy_name: iothubowner
    hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    edge_enabled: yes

- name: Create Azure IoT Hub device module with module twin properties and tag
  azure_rm_iotdevice:
    hub: myHub
    name: Testing
    device: mydevice
    hub_policy_name: iothubowner
    hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    twin_tags:
        location:
            country: US
            city: Redmond
        sensor: humidity
    desired:
        period: 100

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
module
dictionary
always
IoT Hub device.

Sample:
{'authentication': {'symmetricKey': {'primaryKey': 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', 'secondaryKey': 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'}, 'type': 'sas', 'x509Thumbprint': {'primaryThumbprint': None, 'secondaryThumbprint': None}}, 'cloudToDeviceMessageCount': 0, 'connectionState': 'Disconnected', 'connectionStateUpdatedTime': '0001-01-01T00:00:00', 'deviceId': 'mydevice', 'etag': 'ODM2NjI3ODg=', 'generationId': '636904759703045768', 'lastActivityTime': '0001-01-01T00:00:00', 'managedBy': None, 'moduleId': 'Testing'}


Authors

  • Yuwei Zhou (@yuwzho)