Try SpotterFacts of Azure IoT hub device
| "added in version" 2.9 of ansible.builtin"
Authors: Yuwei Zhou (@yuwzho)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Query, get Azure IoT hub device.
- name: Get the details of a device
azure_rm_iotdevice_info:
name: Testing
hub: MyIoTHub
hub_policy_name: registryRead
hub_policy_key: XXXXXXXXXXXXXXXXXXXX
- name: Query all device modules in an IoT Hub
azure_rm_iotdevice_info:
query: "SELECT * FROM devices.modules"
hub: MyIoTHub
hub_policy_name: registryRead
hub_policy_key: XXXXXXXXXXXXXXXXXXXX
- name: List all devices in an IoT Hub
azure_rm_iotdevice_info:
hub: MyIoTHub
hub_policy_name: registryRead
hub_policy_key: XXXXXXXXXXXXXXXXXXXX
hub:
description:
- Name of IoT Hub.
required: true
type: str
top:
description:
- Used when I(name) not defined.
- List the top n devices in the query.
type: int
name:
aliases:
- device_id
description:
- Name of the IoT hub device identity.
type: str
tags:
description:
- 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.
type: dict
query:
description:
- Query an IoT hub to retrieve information regarding device twins using a SQL-like
language.
- See U(https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language).
type: str
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
module_id:
description:
- Name of the IoT hub device module.
- Must use with I(device_id) defined.
type: str
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
append_tags:
default: true
description:
- 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.
type: bool
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
hub_policy_key:
description:
- Key of the I(hub_policy_name).
required: true
type: str
hub_policy_name:
description:
- Policy name of the IoT Hub which will be used to query from IoT hub.
- This policy should have at least 'Registry Read' access.
required: true
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
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
iot_devices:
description:
- IoT Hub device.
returned: always
sample:
authentication:
symmetricKey:
primaryKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
secondaryKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
type: sas
x509Thumbprint:
primaryThumbprint: null
secondaryThumbprint: null
capabilities:
iotEdge: false
changed: true
cloudToDeviceMessageCount: 0
connectionState: Disconnected
connectionStateUpdatedTime: '0001-01-01T00:00:00'
deviceId: Testing
etag: NzA2NjU2ODc=
failed: false
generationId: '636903014505613307'
lastActivityTime: '0001-01-01T00:00:00'
modules:
- authentication:
symmetricKey:
primaryKey: XXXXXXXXXXXXXXXXXXX
secondaryKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
type: sas
x509Thumbprint:
primaryThumbprint: null
secondaryThumbprint: null
cloudToDeviceMessageCount: 0
connectionState: Disconnected
connectionStateUpdatedTime: '0001-01-01T00:00:00'
deviceId: testdevice
etag: MjgxOTE5ODE4
generationId: '636903840872788074'
lastActivityTime: '0001-01-01T00:00:00'
managedBy: null
moduleId: test
properties:
desired:
$metadata:
$lastUpdated: '2019-04-10T05:00:46.2702079Z'
$lastUpdatedVersion: 8
period:
$lastUpdated: '2019-04-10T05:00:46.2702079Z'
$lastUpdatedVersion: 8
$version: 1
period: 100
reported:
$metadata:
$lastUpdated: '2019-04-08T06:24:10.5613307Z'
$version: 1
status: enabled
statusReason: null
statusUpdatedTime: '0001-01-01T00:00:00'
tags:
location:
city: Redmond
country: us
sensor: humidity
type: dict