Class IotHub

Package version

Class representing a IotHub.

Hierarchy

IotHub

Index

Constructors

constructor

Methods

Constructors

constructor

new IotHub(client: IotHubClientContext): IotHub

- Defined in operations/iotHub.ts:19
Create a IotHub.

Parameters
- client: IotHubClientContext
  
  Reference to the service client.
Returns IotHub

Methods

beginManualFailover

beginManualFailover(iotHubName: string, resourceGroupName: string, failoverRegion: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/iotHub.ts:52
Perform manual fail over of given hub

summary

Manual Failover Fail over

Parameters
- iotHubName: string
  
  IotHub to fail over
- resourceGroupName: string
  
  resource group which Iot Hub belongs to
- failoverRegion: string
  
  Region the hub will be failed over to
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

manualFailover

manualFailover(iotHubName: string, resourceGroupName: string, failoverRegion: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/iotHub.ts:38
Perform manual fail over of given hub

summary

Manual Failover Fail over

Parameters
- iotHubName: string
  
  IotHub to fail over
- resourceGroupName: string
  
  resource group which Iot Hub belongs to
- failoverRegion: string
  
  Region the hub will be failed over to
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

Generated using TypeDoc