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
The below requirements are needed on the host that executes this module.
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 |
| 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_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 variablesWhen 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. | |
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. | |
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. | |
enable_file_upload_notifications boolean |
| File upload notifications are enabled if set to True . | |
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. Default is 2 . | ||
retention_time_in_days integer | The retention time for device-to-cloud messages in days. Default is 1 . | ||
ip_filters list / elements=string | Configure rules for rejecting or accepting traffic from specific IPv4 addresses. | ||
action string / required |
| The desired action for requests captured by this rule. | |
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=string | 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. | |
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. | |
routing_endpoints list / elements=string | 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. | |
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. | |
state string |
| State of the IoT hub. Use present to create or update an IoT hub and absent to delete an IoT hub. | |
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 . |
Note
az login
.See also
How to authenticate using the az login
command.
- 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
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
cloud_to_device complex | success | Cloud to device message properties. | ||
max_delivery_count integer | success | The number of times the IoT hub attempts to deliver a message on the feedback queue. Sample: 10 | ||
ttl_as_iso8601 string | success | The period of time for which a message is available to consume before it is expired by the IoT hub. Sample: 1:00:00 | ||
enable_file_upload_notifications boolean | success | Whether file upload notifications are enabled. Sample: True | ||
event_endpoints complex | success | Built-in endpoint where to deliver device message. | ||
endpoint string | success | The Event Hub-compatible endpoint. Sample: sb://iothub-ns-testing-1478811-9bbc4a15f0.servicebus.windows.net/ | ||
partition_count integer | success | The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. Sample: 2 | ||
partition_ids list / elements=string | success | List of the partition id for the event endpoint. Sample: ['0', '1'] | ||
retention_time_in_days integer | success | The retention time for device-to-cloud messages in days. Sample: 1 | ||
host_name string | success | Host of the IoT hub. Sample: testing.azure-devices.net | ||
id string | success | Resource ID of the IoT hub. Sample: /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/Testing | ||
ip_filters complex | success | Configure rules for rejecting or accepting traffic from specific IPv4 addresses. | ||
action string | success | The desired action for requests captured by this rule. Sample: Reject | ||
ip_mask string | success | A string that contains the IP address range in CIDR notation for the rule. Sample: 40.54.7.3 | ||
name string | success | Name of the filter. Sample: filter | ||
location string | success | Location of the IoT hub. Sample: eastus | ||
name string | success | Name of the IoT hub. Sample: Testing | ||
resource_group string | success | Resource group of the IoT hub. Sample: myResourceGroup. | ||
routes complex | success | Route device-to-cloud messages to service-facing endpoints. | ||
condition boolean | 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
Sample: true | ||
enabled string | success | Whether to enable the route. Sample: True | ||
endpoint_name string | success | The name of the endpoint in routing_endpoints where IoT Hub sends messages that match the query.Sample: foo | ||
name string | success | Name of the route. Sample: route1 | ||
source string | success | The origin of the data stream to be acted upon. Sample: device_messages | ||
routing_endpoints complex | success | Custom endpoints. | ||
event_hubs complex | success | List of custom endpoints of event hubs. | ||
connection_string string | success | Connection string of the custom endpoint. Sample: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo | ||
name string | success | Name of the custom endpoint. Sample: foo | ||
resource_group string | success | Resource group of the endpoint. Sample: bar | ||
subscription string | success | Subscription id of the endpoint. Sample: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | ||
service_bus_queues complex | always | List of custom endpoints of service bus queue. | ||
connection_string string | success | Connection string of the custom endpoint. Sample: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo | ||
name string | success | Name of the custom endpoint. Sample: foo | ||
resource_group string | success | Resource group of the endpoint. Sample: bar | ||
subscription string | success | Subscription ID of the endpoint. Sample: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | ||
service_bus_topics complex | success | List of custom endpoints of service bus topic. | ||
connection_string string | success | Connection string of the custom endpoint. Sample: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo | ||
name string | success | Name of the custom endpoint. Sample: foo | ||
resource_group string | success | Resource group of the endpoint. Sample: bar | ||
subscription string | success | Subscription ID of the endpoint. Sample: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | ||
storage_containers complex | success | List of custom endpoints of storage | ||
connection_string string | success | Connection string of the custom endpoint. Sample: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo | ||
name string | success | Name of the custom endpoint. Sample: foo | ||
resource_group string | success | Resource group of the endpoint. Sample: bar | ||
subscription string | success | Subscription ID of the endpoint. Sample: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | ||
sku string | success | Pricing tier for Azure IoT Hub. Sample: f1 | ||
unit integer | success | Units in the IoT Hub. Sample: 1 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_iothub_module.html