azure_rm_iothub_info – Get IoT Hub facts¶
New in version 2.9.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.7
- azure >= 2.0.0
Parameters¶
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 logincommand.
Examples¶
- name: Get facts for one IoT Hub
azure_rm_iothub_info:
name: Testing
resource_group: myResourceGroup
- name: Get facts for all IoT Hubs
azure_rm_iothub_info:
- name: Get facts for all IoT Hubs in a specific resource group
azure_rm_iothub_info:
resource_group: myResourceGroup
- name: Get facts by tags
azure_rm_iothub_info:
tags:
- testing
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |||
|---|---|---|---|---|---|
|
azure_iothubs
complex
|
always |
List of IoT Hub dicts.
|
|||
|
cloud_to_device
complex
|
always |
Cloud to device message properties.
|
|||
|
max_delivery_count
integer
|
always |
The number of times the IoT hub attempts to deliver a message on the feedback queue.
Sample:
10
|
|||
|
ttl_as_iso8601
string
|
always |
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
string
|
always |
Whether file upload notifications are enabled.
Sample:
True
|
|||
|
event_endpoints
complex
|
always |
Built-in endpoint where to deliver device message.
|
|||
|
endpoint
string
|
always |
The Event Hub-compatible endpoint.
Sample:
sb://iothub-ns-testing-1478811-9bbc4a15f0.servicebus.windows.net/
|
|||
|
partition_count
integer
|
always |
The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint.
Sample:
2
|
|||
|
partition_ids
list
|
always |
List of the partition id for the event endpoint.
Sample:
['0', '1']
|
|||
|
retention_time_in_days
integer
|
always |
The retention time for device-to-cloud messages in days.
Sample:
1
|
|||
|
host_name
string
|
always |
Host of the IoT hub.
Sample:
testing.azure-devices.net
|
|||
|
id
string
|
always |
Resource ID of the IoT hub.
Sample:
/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/Testing
|
|||
|
ip_filters
complex
|
always |
Configure rules for rejecting or accepting traffic from specific IPv4 addresses.
|
|||
|
action
string
|
always |
The desired action for requests captured by this rule.
Sample:
Reject
|
|||
|
ip_mask
string
|
always |
A string that contains the IP address range in CIDR notation for the rule.
Sample:
40.54.7.3
|
|||
|
name
string
|
always |
Name of the filter.
Sample:
filter
|
|||
|
location
string
|
always |
Location of the IoT hub.
Sample:
eastus
|
|||
|
name
string
|
always |
Name of the IoT hub.
Sample:
Testing
|
|||
|
resource_group
string
|
always |
Resource group of the IoT hub.
Sample:
myResourceGroup.
|
|||
|
routes
complex
|
always |
Route device-to-cloud messages to service-facing endpoints.
|
|||
|
condition
boolean
|
always |
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
boolean
|
always |
Whether to enable the route.
Sample:
True
|
|||
|
endpoint_name
string
|
always |
The name of the endpoint in routing_endpoints where IoT Hub sends messages that match the query.
Sample:
foo
|
|||
|
name
string
|
always |
Name of the route.
Sample:
route1
|
|||
|
source
string
|
always |
The origin of the data stream to be acted upon.
Sample:
device_messages
|
|||
|
routing_endpoints
complex
|
always |
Custom endpoints.
|
|||
|
event_hubs
complex
|
always |
List of custom endpoints of event hubs.
|
|||
|
connection_string
string
|
always |
Connection string of the custom endpoint.
Sample:
Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo
|
|||
|
name
string
|
always |
Name of the custom endpoint.
Sample:
foo
|
|||
|
resource_group
string
|
always |
Resource group of the endpoint.
Sample:
bar
|
|||
|
subscription
string
|
always |
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
|
always |
Connection string of the custom endpoint.
Sample:
Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo
|
|||
|
name
string
|
always |
Name of the custom endpoint.
Sample:
foo
|
|||
|
resource_group
string
|
always |
Resource group of the endpoint.
Sample:
bar
|
|||
|
subscription
string
|
always |
Subscription ID of the endpoint.
Sample:
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|
|||
|
service_bus_topics
complex
|
always |
List of custom endpoints of service bus topic.
|
|||
|
connection_string
string
|
always |
Connection string of the custom endpoint.
Sample:
Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo
|
|||
|
name
string
|
always |
Name of the custom endpoint.
Sample:
foo
|
|||
|
resource_group
string
|
always |
Resource group of the endpoint.
Sample:
bar
|
|||
|
subscription
string
|
always |
Subscription ID of the endpoint.
Sample:
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|
|||
|
storage_containers
complex
|
always |
List of custom endpoints of storage.
|
|||
|
connection_string
string
|
always |
Connection string of the custom endpoint.
Sample:
Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo
|
|||
|
name
string
|
always |
Name of the custom endpoint.
Sample:
foo
|
|||
|
resource_group
string
|
always |
Resource group of the endpoint.
Sample:
bar
|
|||
|
subscription
string
|
always |
Subscription ID of the endpoint.
Sample:
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
|
|||
|
sku
string
|
always |
Pricing tier for Azure IoT Hub.
Sample:
f1
|
|||
|
tags
dictionary
|
always |
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
Sample:
{'key1': 'value1'}
|
|||
|
unit
integer
|
always |
Units in the IoT Hub.
Sample:
1
|
|||
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Yuwei Zhou (@yuwzho)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.