iot_hubs
Creates, updates, deletes, gets or lists an iot_hubs resource.
Overview
| Name | iot_hubs |
| Type | Resource |
| Id | azure.iot_hub.iot_hubs |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
manual_failover | exec | iotHubName, subscriptionId, resourceGroupName, failoverRegion | api-version | Manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
iotHubName | string | Name of the IoT hub to failover |
resourceGroupName | string | Name of the resource group containing the IoT hub resource |
subscriptionId | string | The subscription identifier. |
api-version | string | The version of the API. |
Lifecycle Methods
- manual_failover
Manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover
EXEC azure.iot_hub.iot_hubs.manual_failover
@iotHubName='{{ iotHubName }}' --required,
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@api-version='{{ api-version }}'
@@json=
'{
"failoverRegion": "{{ failoverRegion }}"
}'
;