You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

azure.azcollection.azure_rm_iothub module – Manage Azure IoT hub

Note

This module is part of the azure.azcollection collection (version 1.13.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.

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

New in version 0.1.2: of azure.azcollection

Synopsis

• Create, delete an Azure IoT hub.

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 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	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: no yes ← (default)
auth_source string added in 0.0.1 of azure.azcollection	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 0.0.1 of azure.azcollection	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 0.0.1 of azure.azcollection	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”
enable_file_upload_notifications boolean	File upload notifications are enabled if set to True. Choices: no yes
event_endpoint dictionary	The Event Hub-compatible endpoint property.
partition_count integer	The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. Default is 2.
retention_time_in_days integer	The retention time for device-to-cloud messages in days. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. Default is 1.
ip_filters list / elements=dictionary	Configure rules for rejecting or accepting traffic from specific IPv4 addresses.
action string / required	The desired action for requests captured by this rule. Choices: accept reject
ip_mask string / required	A string that contains the IP address range in CIDR notation for the rule.
name string / required	Name of the filter.
location string	Location of the IoT hub.
log_mode string	Parent argument.
log_path string	Parent argument.
name string / required	Name of the IoT hub.
password string	Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string	Security profile found in ~/.azure/credentials file.
resource_group string / required	Name of resource group.
routes list / elements=dictionary	Route device-to-cloud messages to service-facing endpoints.
condition string	The query expression for the routing query that is run against the message application properties, system properties, message body, device twin tags, and device twin properties to determine if it is a match for the endpoint. For more information about constructing a query, see https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-routing-query-syntax
enabled boolean / required	Whether to enable the route. Choices: no yes
endpoint_name string / required	The name of the endpoint in routing_endpoints where IoT Hub sends messages that match the query.
name string / required	Name of the route.
source string / required	The origin of the data stream to be acted upon. Choices: device_messages twin_change_events device_lifecycle_events device_job_lifecycle_events
routing_endpoints list / elements=dictionary	Custom endpoints.
connection_string string / required	Connection string of the custom endpoint. The connection string should have send privilege.
container string	Container name of the custom endpoint when resource_type=storage.
encoding string	Encoding of the message when resource_type=storage.
name string / required	Name of the custom endpoint.
resource_group string	Resource group of the endpoint. Default is the same as resource_group.
resource_type string / required	Resource type of the custom endpoint. Choices: eventhub queue storage topic
subscription string	Subscription id of the endpoint. Default is the same as subscription.
secret string	Azure client secret. Use when authenticating with a Service Principal.
sku string	Pricing tier for Azure IoT Hub. Note that only one free IoT hub instance is allowed in each subscription. Exception will be thrown if free instances exceed one. Default is s1 when creation. Choices: b1 b2 b3 f1 s1 s2 s3
state string	State of the IoT hub. Use present to create or update an IoT hub and absent to delete an IoT hub. Choices: absent present ← (default)
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.
unit integer	Units in your IoT Hub. Default is 1.

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 a simplest IoT hub
  azure_rm_iothub:
    name: Testing
    resource_group: myResourceGroup
- name: Create an IoT hub with route
  azure_rm_iothub:
    resource_group: myResourceGroup
    name: Testing
    routing_endpoints:
        - connection_string: "Endpoint=sb://qux.servicebus.windows.net/;SharedAccessKeyName=quux;SharedAccessKey=****;EntityPath=myQueue"
          name: foo
          resource_type: queue
          resource_group: myResourceGroup1
    routes:
        - name: bar
          source: device_messages
          endpoint_name: foo
          enabled: yes

Return Values

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

Key	Description
cloud_to_device complex	Cloud to device message properties. Returned: success
max_delivery_count integer	The number of times the IoT hub attempts to deliver a message on the feedback queue. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. Returned: success Sample: 10
ttl_as_iso8601 string	The period of time for which a message is available to consume before it is expired by the IoT hub. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. Returned: success Sample: “1:00:00”
enable_file_upload_notifications boolean	Whether file upload notifications are enabled. Returned: success Sample: true
event_endpoints complex	Built-in endpoint where to deliver device message. Returned: success
endpoint string	The Event Hub-compatible endpoint. Returned: success Sample: “sb://iothub-ns-testing-1478811-9bbc4a15f0.servicebus.windows.net/”
partition_count integer	The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. Returned: success Sample: 2
partition_ids list / elements=string	List of the partition id for the event endpoint. Returned: success Sample: [“0”, “1”]
retention_time_in_days integer	The retention time for device-to-cloud messages in days. See https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. Returned: success Sample: 1
host_name string	Host of the IoT hub. Returned: success Sample: “testing.azure-devices.net”
id string	Resource ID of the IoT hub. Returned: success Sample: “/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/Testing”
ip_filters complex	Configure rules for rejecting or accepting traffic from specific IPv4 addresses. Returned: success
action string	The desired action for requests captured by this rule. Returned: success Sample: “Reject”
ip_mask string	A string that contains the IP address range in CIDR notation for the rule. Returned: success Sample: “40.54.7.3”
name string	Name of the filter. Returned: success Sample: “filter”
location string	Location of the IoT hub. Returned: success Sample: “eastus”
name string	Name of the IoT hub. Returned: success Sample: “Testing”
resource_group string	Resource group of the IoT hub. Returned: success Sample: “myResourceGroup.”
routes complex	Route device-to-cloud messages to service-facing endpoints. Returned: success
condition boolean	The query expression for the routing query that is run against the message application properties, system properties, message body, device twin tags, and device twin properties to determine if it is a match for the endpoint. For more information about constructing a query, see https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-routing-query-syntax Returned: success Sample: “true”
enabled string	Whether to enable the route. Returned: success Sample: true
endpoint_name string	The name of the endpoint in routing_endpoints where IoT Hub sends messages that match the query. Returned: success Sample: “foo”
name string	Name of the route. Returned: success Sample: “route1”
source string	The origin of the data stream to be acted upon. Returned: success Sample: “device_messages”
routing_endpoints complex	Custom endpoints. Returned: success
event_hubs complex	List of custom endpoints of event hubs. Returned: success
connection_string string	Connection string of the custom endpoint. Returned: success Sample: “Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo”
name string	Name of the custom endpoint. Returned: success Sample: “foo”
resource_group string	Resource group of the endpoint. Returned: success Sample: “bar”
subscription string	Subscription id of the endpoint. Returned: success Sample: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”
service_bus_queues complex	List of custom endpoints of service bus queue. Returned: always
connection_string string	Connection string of the custom endpoint. Returned: success Sample: “Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo”
name string	Name of the custom endpoint. Returned: success Sample: “foo”
resource_group string	Resource group of the endpoint. Returned: success Sample: “bar”
subscription string	Subscription ID of the endpoint. Returned: success Sample: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”
service_bus_topics complex	List of custom endpoints of service bus topic. Returned: success
connection_string string	Connection string of the custom endpoint. Returned: success Sample: “Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo”
name string	Name of the custom endpoint. Returned: success Sample: “foo”
resource_group string	Resource group of the endpoint. Returned: success Sample: “bar”
subscription string	Subscription ID of the endpoint. Returned: success Sample: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”
storage_containers complex	List of custom endpoints of storage Returned: success
connection_string string	Connection string of the custom endpoint. Returned: success Sample: “Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo”
name string	Name of the custom endpoint. Returned: success Sample: “foo”
resource_group string	Resource group of the endpoint. Returned: success Sample: “bar”
subscription string	Subscription ID of the endpoint. Returned: success Sample: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”
sku string	Pricing tier for Azure IoT Hub. Returned: success Sample: “f1”
unit integer	Units in the IoT Hub. Returned: success Sample: 1

Authors

• Yuwei Zhou (@yuwzho)

Collection links

Issue Tracker Homepage Repository (Sources)