azure_rm_iothub_info – Get IoT Hub facts

New in version 2.9.

Synopsis

  • Get facts for a specific IoT Hub or all IoT Hubs.

Requirements

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

  • python >= 2.7
  • azure >= 2.0.0

Parameters

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 2.6
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile
string
added in 2.5
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.
auth_source
string
added in 2.5
    Choices:
  • auto
  • cli
  • credential_file
  • env
  • msi
Controls the source of the credentials to use for authentication.
If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.
auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.
When set to cli, the credentials will be sources from the default Azure CLI profile.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
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 2.5
    Choices:
  • ignore
  • validate
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 2.4
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.
list_consumer_groups
boolean
    Choices:
  • no
  • yes
List the consumer group of the built-in event hub.
list_keys
boolean
    Choices:
  • no
  • yes
List the keys of IoT Hub.
Note this will have network overhead for each IoT Hub.
name
string
Limit results to a specific resource group.
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
The resource group to search for the desired IoT Hub.
secret
string
Azure client secret. Use when authenticating with a Service Principal.
show_endpoint_health
boolean
    Choices:
  • no
  • yes
Get the health for routing endpoints.
Note this will have network overhead for each IoT Hub.
show_quota_metrics
boolean
    Choices:
  • no
  • yes
Get the quota metrics for an IoT hub.
Note this will have network overhead for each IoT Hub.
show_stats
boolean
    Choices:
  • no
  • yes
Show the statistics for IoT Hub.
Note this will have network overhead for each IoT Hub.
subscription_id
string
Your Azure subscription Id.
tags
list
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.
test_route_message
string
Test routes message. It will be used to test all routes.

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: 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.

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

Authors

  • Yuwei Zhou (@yuwzho)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.