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

Note

This module is part of the azure.azcollection collection (version 1.16.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

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

New in azure.azcollection 0.1.2

Synopsis

  • Create, delete an Azure IoT hub device.

Requirements

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

  • python >= 2.7

  • The host that executes this module must have the azure.azcollection collection installed via galaxy

  • All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection

  • Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter

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 azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

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.

Default: "latest"

append_tags

boolean

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.

Choices:

  • false

  • true ← (default)

auth_method

string

The authorization type an entity is to be created with.

Choices:

  • "sas" ← (default)

  • "certificate_authority"

  • "self_signed"

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.

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.

Choices:

  • "auto" ← (default)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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.

Choices:

  • "ignore"

  • "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal.

cloud_environment

string

added in azure.azcollection 0.0.1

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.

Default: "AzureCloud"

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.

Not supported in IoT Hub with Basic tier.

edge_enabled

boolean

Flag indicating edge enablement.

Not supported in IoT Hub with Basic tier.

Choices:

  • false

  • true

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 ‘RegistryWrite, ServiceConnect, DeviceConnect’ accesses. You may get 401 error when you lack any of these.

log_mode

string

Parent argument.

log_path

string

Parent argument.

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

aliases: primary_thumbprint

string

Explicit self-signed certificate thumbprint to use for primary key.

Explicit Shared Private Key to use for primary key.

profile

string

Security profile found in ~/.azure/credentials file.

secondary_key

aliases: secondary_thumbprint

string

Explicit self-signed certificate thumbprint to use for secondary key.

Explicit Shared Private Key to use for secondary key.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

state

string

State of the IoT hub. Use present to create or update an IoT hub device and absent to delete an IoT hub device.

Choices:

  • "absent"

  • "present" ← (default)

status

boolean

Set device status upon creation.

Choices:

  • false

  • true

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.

Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.

Azure Front Door doesn’t support the use of

Azure Automation and Azure CDN only support 15 tags on resources.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

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.

Not supported in IoT Hub with Basic tier.

x509_certificate_path

path

added in azure.azcollection 1.14.0

Path to the X509 certificate used to create the service principal in PEM format.

The certificate must be appended to the private key.

Use when authenticating with a Service Principal.

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
  azure_rm_iotdevice:
    hub: myHub
    name: Testing
    hub_policy_name: iothubowner
    hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

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

- name: Create Azure IoT Hub device with device twin properties and tag
  azure_rm_iotdevice:
    hub: myHub
    name: Testing
    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

Description

device

dictionary

IoT Hub device.

Returned: always

Sample: {"authentication": {"symmetricKey": {"primaryKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "secondaryKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"}, "type": "sas", "x509Thumbprint": {"primaryThumbprint": null, "secondaryThumbprint": null}}, "capabilities": {"iotEdge": false}, "changed": true, "cloudToDeviceMessageCount": 0, "connectionState": "Disconnected", "connectionStateUpdatedTime": "0001-01-01T00:00:00", "deviceId": "Testing", "etag": "NzA2NjU2ODc=", "failed": false, "generationId": "636903014505613307", "lastActivityTime": "0001-01-01T00:00:00", "modules": [{"authentication": {"symmetricKey": {"primaryKey": "XXXXXXXXXXXXXXXXXXX", "secondaryKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"}, "type": "sas", "x509Thumbprint": {"primaryThumbprint": null, "secondaryThumbprint": null}}, "cloudToDeviceMessageCount": 0, "connectionState": "Disconnected", "connectionStateUpdatedTime": "0001-01-01T00:00:00", "deviceId": "testdevice", "etag": "MjgxOTE5ODE4", "generationId": "636903840872788074", "lastActivityTime": "0001-01-01T00:00:00", "managedBy": null, "moduleId": "test"}], "properties": {"desired": {"$metadata": {"$lastUpdated": "2019-04-10T05:00:46.2702079Z", "$lastUpdatedVersion": 8, "period": {"$lastUpdated": "2019-04-10T05:00:46.2702079Z", "$lastUpdatedVersion": 8}}, "$version": 1, "period": 100}, "reported": {"$metadata": {"$lastUpdated": "2019-04-08T06:24:10.5613307Z"}, "$version": 1}}, "status": "enabled", "statusReason": null, "statusUpdatedTime": "0001-01-01T00:00:00", "tags": {"location": {"city": "Redmond", "country": "us"}, "sensor": "humidity"}}

Authors

  • Yuwei Zhou (@yuwzho)