azure.azcollection.azure_rm_iothub – Manage Azure IoT hub
Note
This plugin is part of the azure.azcollection collection (version 1.10.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
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 |
---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: “latest” |
|
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:
|
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal. |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: “AzureCloud” |
|
File upload notifications are enabled if set to Choices:
|
|
The Event Hub-compatible endpoint property. |
|
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 |
|
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 |
|
Configure rules for rejecting or accepting traffic from specific IPv4 addresses. |
|
The desired action for requests captured by this rule. Choices:
|
|
A string that contains the IP address range in CIDR notation for the rule. |
|
Name of the filter. |
|
Location of the IoT hub. |
|
Parent argument. |
|
Parent argument. |
|
Name of the IoT hub. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Name of resource group. |
|
Route device-to-cloud messages to service-facing endpoints. |
|
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 |
|
Whether to enable the route. Choices:
|
|
The name of the endpoint in routing_endpoints where IoT Hub sends messages that match the query. |
|
Name of the route. |
|
The origin of the data stream to be acted upon. Choices:
|
|
Custom endpoints. |
|
Connection string of the custom endpoint. The connection string should have send privilege. |
|
Container name of the custom endpoint when resource_type=storage. |
|
Encoding of the message when resource_type=storage. |
|
Name of the custom endpoint. |
|
Resource group of the endpoint. Default is the same as resource_group. |
|
Resource type of the custom endpoint. Choices:
|
|
Subscription id of the endpoint. Default is the same as subscription. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
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 Choices:
|
|
State of the IoT hub. Use Choices:
|
|
Your Azure subscription Id. |
|
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. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
Units in your IoT Hub. Default is |
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 message properties. Returned: success |
|
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 |
|
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” |
|
Whether file upload notifications are enabled. Returned: success Sample: true |
|
Built-in endpoint where to deliver device message. Returned: success |
|
The Event Hub-compatible endpoint. Returned: success Sample: “sb://iothub-ns-testing-1478811-9bbc4a15f0.servicebus.windows.net/” |
|
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 |
|
List of the partition id for the event endpoint. Returned: success Sample: [“0”, “1”] |
|
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 of the IoT hub. Returned: success Sample: “testing.azure-devices.net” |
|
Resource ID of the IoT hub. Returned: success Sample: “/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/Testing” |
|
Configure rules for rejecting or accepting traffic from specific IPv4 addresses. Returned: success |
|
The desired action for requests captured by this rule. Returned: success Sample: “Reject” |
|
A string that contains the IP address range in CIDR notation for the rule. Returned: success Sample: “40.54.7.3” |
|
Name of the filter. Returned: success Sample: “filter” |
|
Location of the IoT hub. Returned: success Sample: “eastus” |
|
Name of the IoT hub. Returned: success Sample: “Testing” |
|
Resource group of the IoT hub. Returned: success Sample: “myResourceGroup.” |
|
Route device-to-cloud messages to service-facing endpoints. Returned: success |
|
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” |
|
Whether to enable the route. Returned: success Sample: true |
|
The name of the endpoint in Returned: success Sample: “foo” |
|
Name of the route. Returned: success Sample: “route1” |
|
The origin of the data stream to be acted upon. Returned: success Sample: “device_messages” |
|
Custom endpoints. Returned: success |
|
List of custom endpoints of event hubs. Returned: success |
|
Connection string of the custom endpoint. Returned: success Sample: “Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo” |
|
Name of the custom endpoint. Returned: success Sample: “foo” |
|
Resource group of the endpoint. Returned: success Sample: “bar” |
|
Subscription id of the endpoint. Returned: success Sample: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX” |
|
List of custom endpoints of service bus queue. Returned: always |
|
Connection string of the custom endpoint. Returned: success Sample: “Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo” |
|
Name of the custom endpoint. Returned: success Sample: “foo” |
|
Resource group of the endpoint. Returned: success Sample: “bar” |
|
Subscription ID of the endpoint. Returned: success Sample: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX” |
|
List of custom endpoints of service bus topic. Returned: success |
|
Connection string of the custom endpoint. Returned: success Sample: “Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo” |
|
Name of the custom endpoint. Returned: success Sample: “foo” |
|
Resource group of the endpoint. Returned: success Sample: “bar” |
|
Subscription ID of the endpoint. Returned: success Sample: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX” |
|
List of custom endpoints of storage Returned: success |
|
Connection string of the custom endpoint. Returned: success Sample: “Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo” |
|
Name of the custom endpoint. Returned: success Sample: “foo” |
|
Resource group of the endpoint. Returned: success Sample: “bar” |
|
Subscription ID of the endpoint. Returned: success Sample: “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX” |
|
Pricing tier for Azure IoT Hub. Returned: success Sample: “f1” |
|
Units in the IoT Hub. Returned: success Sample: 1 |
Authors
Yuwei Zhou (@yuwzho)