ansible / ansible.builtin / v2.9.17 / module / azure_rm_iotdevice Manage Azure IoT hub device | "added in version" 2.9 of ansible.builtin" Authors: Yuwei Zhou (@yuwzho) preview | supported by communityansible.builtin.azure_rm_iotdevice (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Create, delete an Azure IoT hub device.
- name: Create simplest Azure IoT Hub device azure_rm_iotdevice: hub: myHub name: Testing hub_policy_name: iothubowner hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
- name: Create Azure IoT Edge device azure_rm_iotdevice: hub: myHub name: Testing hub_policy_name: iothubowner hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" edge_enabled: yes
- name: Create Azure IoT Hub device with device twin properties and tag azure_rm_iotdevice: hub: myHub name: Testing hub_policy_name: iothubowner hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" twin_tags: location: country: US city: Redmond sensor: humidity desired: period: 100
hub: description: - Name of IoT Hub. required: true type: str name: description: - Name of the IoT hub device identity. required: true 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 state: choices: - absent - present default: present description: - State of the IoT hub. Use C(present) to create or update an IoT hub device and C(absent) to delete an IoT hub device. type: str secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str status: description: - Set device status upon creation. type: bool 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 desired: description: - Used along with reported properties to synchronize device configuration or conditions. - The tag can be nested dictionary, '.', '$', '#', ' ' is not allowed in the key. - List is not supported. - Not supported in IoT Hub with Basic tier. type: dict 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 twin_tags: description: - A section that the solution back end can read from and write to. - Tags are not visible to device apps. - The tag can be nested dictionary, '.', '$', '#', ' ' is not allowed in the key. - List is not supported. - Not supported in IoT Hub with Basic tier. type: dict 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_method: choices: - sas - certificate_authority - self_signed default: sas description: - The authorization type an entity is to be created with. type: str 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 primary_key: aliases: - primary_thumbprint description: - Explicit self-signed certificate thumbprint to use for primary key. - Explicit Shared Private Key to use for primary key. type: str edge_enabled: description: - Flag indicating edge enablement. - Not supported in IoT Hub with Basic tier. type: bool secondary_key: aliases: - secondary_thumbprint description: - Explicit self-signed certificate thumbprint to use for secondary key. - Explicit Shared Private Key to use for secondary key. type: str 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 'RegistryWrite, ServiceConnect, DeviceConnect' accesses. You may get 401 error when you lack any of these. 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
device: 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