ansible / ansible.builtin / v2.9.17 / module / azure_rm_iothub_info Get IoT Hub facts | "added in version" 2.9 of ansible.builtin" Authors: Yuwei Zhou (@yuwzho) preview | supported by communityansible.builtin.azure_rm_iothub_info (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Get facts for a specific IoT Hub or all IoT Hubs.
- 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
name: description: - Limit results to a specific resource group. type: str tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. type: list secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal. type: str list_keys: description: - List the keys of IoT Hub. - Note this will have network overhead for each IoT Hub. type: bool show_stats: description: - Show the statistics for IoT Hub. - Note this will have network overhead for each IoT Hub. type: bool api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection resource_group: description: - The resource group to search for the desired IoT Hub. type: str subscription_id: description: - Your Azure subscription Id. type: str cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection show_quota_metrics: description: - Get the quota metrics for an IoT hub. - Note this will have network overhead for each IoT Hub. type: bool test_route_message: description: - Test routes message. It will be used to test all routes. type: str cert_validation_mode: choices: - ignore - validate description: - 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection list_consumer_groups: description: - List the consumer group of the built-in event hub. type: bool show_endpoint_health: description: - Get the health for routing endpoints. - Note this will have network overhead for each IoT Hub. type: bool
azure_iothubs: contains: cloud_to_device: contains: max_delivery_count: description: - The number of times the IoT hub attempts to deliver a message on the feedback queue. - See U(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages). returned: always sample: 10 type: int ttl_as_iso8601: description: - The period of time for which a message is available to consume before it is expired by the IoT hub. - See U(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages). returned: always sample: '1:00:00' type: str description: - Cloud to device message properties. returned: always type: complex enable_file_upload_notifications: description: - Whether file upload notifications are enabled. returned: always sample: true type: str event_endpoints: contains: endpoint: description: - The Event Hub-compatible endpoint. returned: always sample: sb://iothub-ns-testing-1478811-9bbc4a15f0.servicebus.windows.net/ type: str partition_count: description: - The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. - See U(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages). returned: always sample: 2 type: int partition_ids: description: - List of the partition id for the event endpoint. returned: always sample: - '0' - '1' type: list retention_time_in_days: description: - The retention time for device-to-cloud messages in days. - See U(https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages). returned: always sample: 1 type: int description: - Built-in endpoint where to deliver device message. returned: always type: complex host_name: description: - Host of the IoT hub. returned: always sample: testing.azure-devices.net type: str id: description: - Resource ID of the IoT hub. returned: always sample: /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/Testing type: str ip_filters: contains: action: description: - The desired action for requests captured by this rule. returned: always sample: Reject type: str ip_mask: description: - A string that contains the IP address range in CIDR notation for the rule. returned: always sample: 40.54.7.3 type: str name: description: - Name of the filter. returned: always sample: filter type: str description: - Configure rules for rejecting or accepting traffic from specific IPv4 addresses. returned: always type: complex location: description: - Location of the IoT hub. returned: always sample: eastus type: str name: description: - Name of the IoT hub. returned: always sample: Testing type: str resource_group: description: - Resource group of the IoT hub. returned: always sample: myResourceGroup. type: str routes: contains: condition: description: - 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 U(https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-routing-query-syntax) returned: always sample: 'true' type: bool enabled: description: - Whether to enable the route. returned: always sample: true type: bool endpoint_name: description: - The name of the endpoint in I(routing_endpoints) where IoT Hub sends messages that match the query. returned: always sample: foo type: str name: description: - Name of the route. returned: always sample: route1 type: str source: description: - The origin of the data stream to be acted upon. returned: always sample: device_messages type: str description: - Route device-to-cloud messages to service-facing endpoints. returned: always type: complex routing_endpoints: contains: event_hubs: contains: connection_string: description: - Connection string of the custom endpoint. returned: always sample: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo type: str name: description: - Name of the custom endpoint. returned: always sample: foo type: str resource_group: description: - Resource group of the endpoint. returned: always sample: bar type: str subscription: description: - Subscription ID of the endpoint. returned: always sample: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX type: str description: - List of custom endpoints of event hubs. returned: always type: complex service_bus_queues: contains: connection_string: description: - Connection string of the custom endpoint. returned: always sample: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo type: str name: description: - Name of the custom endpoint. returned: always sample: foo type: str resource_group: description: - Resource group of the endpoint. returned: always sample: bar type: str subscription: description: - Subscription ID of the endpoint. returned: always sample: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX type: str description: - List of custom endpoints of service bus queue. returned: always type: complex service_bus_topics: contains: connection_string: description: - Connection string of the custom endpoint. returned: always sample: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo type: str name: description: - Name of the custom endpoint. returned: always sample: foo type: str resource_group: description: - Resource group of the endpoint. returned: always sample: bar type: str subscription: description: - Subscription ID of the endpoint. returned: always sample: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX type: str description: - List of custom endpoints of service bus topic. returned: always type: complex storage_containers: contains: connection_string: description: - Connection string of the custom endpoint. returned: always sample: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo type: str name: description: - Name of the custom endpoint. returned: always sample: foo type: str resource_group: description: - Resource group of the endpoint. returned: always sample: bar type: str subscription: description: - Subscription ID of the endpoint. returned: always sample: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX type: str description: - List of custom endpoints of storage. returned: always type: complex description: - Custom endpoints. returned: always type: complex sku: description: - Pricing tier for Azure IoT Hub. returned: always sample: f1 type: str tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. returned: always sample: key1: value1 type: dict unit: description: - Units in the IoT Hub. returned: always sample: 1 type: int description: - List of IoT Hub dicts. returned: always type: complex