IotHubResource | @azure/arm-iothub

Class representing a IotHubResource.

Hierarchy

IotHubResource

Index

Constructors

constructor

Methods

Constructors

constructor

new IotHubResource(client: IotHubClientContext): IotHubResource

- Defined in operations/iotHubResource.ts:20
Create a IotHubResource.

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

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: Models.IotHubResourceBeginCreateOrUpdateOptionalParams): Promise<msRestAzure.LROPoller>

- Defined in operations/iotHubResource.ts:798
Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub.

summary

Create or update the metadata of an IoT hub.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- iotHubDescription: IotHubDescription
  
  The IoT hub metadata and security metadata.
- Optional options: Models.IotHubResourceBeginCreateOrUpdateOptionalParams
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod

beginDeleteMethod(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/iotHubResource.ts:837
Delete an IoT hub.

summary

Delete an IoT hub

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginUpdate

beginUpdate(resourceGroupName: string, resourceName: string, options?: Models.IotHubResourceBeginUpdateOptionalParams): Promise<msRestAzure.LROPoller>

- Defined in operations/iotHubResource.ts:818
Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method

summary

Update an existing IoT Hubs tags.

Parameters
- resourceGroupName: string
  
  Resource group identifier.
- resourceName: string
  
  Name of iot hub to update.
- Optional options: Models.IotHubResourceBeginUpdateOptionalParams
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

checkNameAvailability

checkNameAvailability(name: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceCheckNameAvailabilityResponse>
checkNameAvailability(name: string, callback: msRest.ServiceCallback<IotHubNameAvailabilityInfo>): void
checkNameAvailability(name: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<IotHubNameAvailabilityInfo>): void

- Defined in operations/iotHubResource.ts:535
Check if an IoT hub name is available.

summary

Check if an IoT hub name is available

Parameters
- name: string
  
  The name of the IoT hub to check.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceCheckNameAvailabilityResponse>

Promise<Models.IotHubResourceCheckNameAvailabilityResponse>
- Defined in operations/iotHubResource.ts:540
Parameters
- name: string
  
  The name of the IoT hub to check.
- callback: msRest.ServiceCallback<IotHubNameAvailabilityInfo>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:546
Parameters
- name: string
  
  The name of the IoT hub to check.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<IotHubNameAvailabilityInfo>
  
  The callback
Returns void

createEventHubConsumerGroup

createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceCreateEventHubConsumerGroupResponse>
createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, callback: msRest.ServiceCallback<EventHubConsumerGroupInfo>): void
createEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<EventHubConsumerGroupInfo>): void

- Defined in operations/iotHubResource.ts:316
Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.

summary

Add a consumer group to an Event Hub-compatible endpoint in an IoT hub

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- eventHubEndpointName: string
  
  The name of the Event Hub-compatible endpoint in the IoT hub.
- name: string
  
  The name of the consumer group to add.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceCreateEventHubConsumerGroupResponse>

Promise<Models.IotHubResourceCreateEventHubConsumerGroupResponse>
- Defined in operations/iotHubResource.ts:324
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- eventHubEndpointName: string
  
  The name of the Event Hub-compatible endpoint in the IoT hub.
- name: string
  
  The name of the consumer group to add.
- callback: msRest.ServiceCallback<EventHubConsumerGroupInfo>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:333
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- eventHubEndpointName: string
  
  The name of the Event Hub-compatible endpoint in the IoT hub.
- name: string
  
  The name of the consumer group to add.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<EventHubConsumerGroupInfo>
  
  The callback
Returns void

createOrUpdate

createOrUpdate(resourceGroupName: string, resourceName: string, iotHubDescription: IotHubDescription, options?: Models.IotHubResourceCreateOrUpdateOptionalParams): Promise<Models.IotHubResourceCreateOrUpdateResponse>

- Defined in operations/iotHubResource.ts:74
Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub.

summary

Create or update the metadata of an IoT hub.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- iotHubDescription: IotHubDescription
  
  The IoT hub metadata and security metadata.
- Optional options: Models.IotHubResourceCreateOrUpdateOptionalParams
Returns Promise<Models.IotHubResourceCreateOrUpdateResponse>

Promise<Models.IotHubResourceCreateOrUpdateResponse>

deleteEventHubConsumerGroup

deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, callback: msRest.ServiceCallback<void>): void
deleteEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

- Defined in operations/iotHubResource.ts:357
Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.

summary

Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- eventHubEndpointName: string
  
  The name of the Event Hub-compatible endpoint in the IoT hub.
- name: string
  
  The name of the consumer group to delete.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>
- Defined in operations/iotHubResource.ts:365
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- eventHubEndpointName: string
  
  The name of the Event Hub-compatible endpoint in the IoT hub.
- name: string
  
  The name of the consumer group to delete.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:374
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- eventHubEndpointName: string
  
  The name of the Event Hub-compatible endpoint in the IoT hub.
- name: string
  
  The name of the consumer group to delete.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

deleteMethod

deleteMethod(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceDeleteMethodResponse>

- Defined in operations/iotHubResource.ts:100
Delete an IoT hub.

summary

Delete an IoT hub

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceDeleteMethodResponse>

Promise<Models.IotHubResourceDeleteMethodResponse>

exportDevices

exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: ExportDevicesRequest, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceExportDevicesResponse>
exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: ExportDevicesRequest, callback: msRest.ServiceCallback<JobResponse>): void
exportDevices(resourceGroupName: string, resourceName: string, exportDevicesParameters: ExportDevicesRequest, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<JobResponse>): void

- Defined in operations/iotHubResource.ts:718
Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

summary

Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- exportDevicesParameters: ExportDevicesRequest
  
  The parameters that specify the export devices operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceExportDevicesResponse>

Promise<Models.IotHubResourceExportDevicesResponse>
- Defined in operations/iotHubResource.ts:725
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- exportDevicesParameters: ExportDevicesRequest
  
  The parameters that specify the export devices operation.
- callback: msRest.ServiceCallback<JobResponse>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:733
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- exportDevicesParameters: ExportDevicesRequest
  
  The parameters that specify the export devices operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<JobResponse>
  
  The callback
Returns void

get

get(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceGetResponse>
get(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<IotHubDescription>): void
get(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<IotHubDescription>): void

- Defined in operations/iotHubResource.ts:38
Get the non-security related metadata of an IoT hub.

summary

Get the non-security related metadata of an IoT hub

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceGetResponse>

Promise<Models.IotHubResourceGetResponse>
- Defined in operations/iotHubResource.ts:44
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- callback: msRest.ServiceCallback<IotHubDescription>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:51
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<IotHubDescription>
  
  The callback
Returns void

getEndpointHealth

getEndpointHealth(resourceGroupName: string, iotHubName: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceGetEndpointHealthResponse>
getEndpointHealth(resourceGroupName: string, iotHubName: string, callback: msRest.ServiceCallback<EndpointHealthDataListResult>): void
getEndpointHealth(resourceGroupName: string, iotHubName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<EndpointHealthDataListResult>): void

- Defined in operations/iotHubResource.ts:503
Get the health for routing endpoints.

summary

Get the health for routing endpoints

Parameters
- resourceGroupName: string
- iotHubName: string
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceGetEndpointHealthResponse>

Promise<Models.IotHubResourceGetEndpointHealthResponse>
- Defined in operations/iotHubResource.ts:509
Parameters
- resourceGroupName: string
- iotHubName: string
- callback: msRest.ServiceCallback<EndpointHealthDataListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:516
Parameters
- resourceGroupName: string
- iotHubName: string
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<EndpointHealthDataListResult>
  
  The callback
Returns void

getEndpointHealthNext

getEndpointHealthNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceGetEndpointHealthNextResponse>
getEndpointHealthNext(nextPageLink: string, callback: msRest.ServiceCallback<EndpointHealthDataListResult>): void
getEndpointHealthNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<EndpointHealthDataListResult>): void

- Defined in operations/iotHubResource.ts:1033
Get the health for routing endpoints.

summary

Get the health for routing endpoints

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceGetEndpointHealthNextResponse>

Promise<Models.IotHubResourceGetEndpointHealthNextResponse>
- Defined in operations/iotHubResource.ts:1038
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<EndpointHealthDataListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:1044
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<EndpointHealthDataListResult>
  
  The callback
Returns void

getEventHubConsumerGroup

getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceGetEventHubConsumerGroupResponse>
getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, callback: msRest.ServiceCallback<EventHubConsumerGroupInfo>): void
getEventHubConsumerGroup(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, name: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<EventHubConsumerGroupInfo>): void

- Defined in operations/iotHubResource.ts:275
Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.

summary

Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- eventHubEndpointName: string
  
  The name of the Event Hub-compatible endpoint in the IoT hub.
- name: string
  
  The name of the consumer group to retrieve.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceGetEventHubConsumerGroupResponse>

Promise<Models.IotHubResourceGetEventHubConsumerGroupResponse>
- Defined in operations/iotHubResource.ts:283
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- eventHubEndpointName: string
  
  The name of the Event Hub-compatible endpoint in the IoT hub.
- name: string
  
  The name of the consumer group to retrieve.
- callback: msRest.ServiceCallback<EventHubConsumerGroupInfo>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:292
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- eventHubEndpointName: string
  
  The name of the Event Hub-compatible endpoint in the IoT hub.
- name: string
  
  The name of the consumer group to retrieve.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<EventHubConsumerGroupInfo>
  
  The callback
Returns void

getJob

getJob(resourceGroupName: string, resourceName: string, jobId: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceGetJobResponse>
getJob(resourceGroupName: string, resourceName: string, jobId: string, callback: msRest.ServiceCallback<JobResponse>): void
getJob(resourceGroupName: string, resourceName: string, jobId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<JobResponse>): void

- Defined in operations/iotHubResource.ts:434
Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

summary

Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- jobId: string
  
  The job identifier.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceGetJobResponse>

Promise<Models.IotHubResourceGetJobResponse>
- Defined in operations/iotHubResource.ts:441
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- jobId: string
  
  The job identifier.
- callback: msRest.ServiceCallback<JobResponse>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:449
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- jobId: string
  
  The job identifier.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<JobResponse>
  
  The callback
Returns void

getKeysForKeyName

getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceGetKeysForKeyNameResponse>
getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, callback: msRest.ServiceCallback<SharedAccessSignatureAuthorizationRule>): void
getKeysForKeyName(resourceGroupName: string, resourceName: string, keyName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<SharedAccessSignatureAuthorizationRule>): void

- Defined in operations/iotHubResource.ts:677
Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

summary

Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- keyName: string
  
  The name of the shared access policy.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceGetKeysForKeyNameResponse>

Promise<Models.IotHubResourceGetKeysForKeyNameResponse>
- Defined in operations/iotHubResource.ts:684
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- keyName: string
  
  The name of the shared access policy.
- callback: msRest.ServiceCallback<SharedAccessSignatureAuthorizationRule>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:692
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- keyName: string
  
  The name of the shared access policy.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<SharedAccessSignatureAuthorizationRule>
  
  The callback
Returns void

getQuotaMetrics

getQuotaMetrics(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceGetQuotaMetricsResponse>
getQuotaMetrics(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<IotHubQuotaMetricInfoListResult>): void
getQuotaMetrics(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<IotHubQuotaMetricInfoListResult>): void

- Defined in operations/iotHubResource.ts:470
Get the quota metrics for an IoT hub.

summary

Get the quota metrics for an IoT hub

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceGetQuotaMetricsResponse>

Promise<Models.IotHubResourceGetQuotaMetricsResponse>
- Defined in operations/iotHubResource.ts:476
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- callback: msRest.ServiceCallback<IotHubQuotaMetricInfoListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:483
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<IotHubQuotaMetricInfoListResult>
  
  The callback
Returns void

getQuotaMetricsNext

getQuotaMetricsNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceGetQuotaMetricsNextResponse>
getQuotaMetricsNext(nextPageLink: string, callback: msRest.ServiceCallback<IotHubQuotaMetricInfoListResult>): void
getQuotaMetricsNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<IotHubQuotaMetricInfoListResult>): void

- Defined in operations/iotHubResource.ts:1004
Get the quota metrics for an IoT hub.

summary

Get the quota metrics for an IoT hub

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceGetQuotaMetricsNextResponse>

Promise<Models.IotHubResourceGetQuotaMetricsNextResponse>
- Defined in operations/iotHubResource.ts:1009
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<IotHubQuotaMetricInfoListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:1015
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<IotHubQuotaMetricInfoListResult>
  
  The callback
Returns void

getStats

getStats(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceGetStatsResponse>
getStats(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<RegistryStatistics>): void
getStats(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RegistryStatistics>): void

- Defined in operations/iotHubResource.ts:167
Get the statistics from an IoT hub.

summary

Get the statistics from an IoT hub

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceGetStatsResponse>

Promise<Models.IotHubResourceGetStatsResponse>
- Defined in operations/iotHubResource.ts:173
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- callback: msRest.ServiceCallback<RegistryStatistics>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:180
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<RegistryStatistics>
  
  The callback
Returns void

getValidSkus

getValidSkus(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceGetValidSkusResponse>
getValidSkus(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<IotHubSkuDescriptionListResult>): void
getValidSkus(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<IotHubSkuDescriptionListResult>): void

- Defined in operations/iotHubResource.ts:200
Get the list of valid SKUs for an IoT hub.

summary

Get the list of valid SKUs for an IoT hub

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceGetValidSkusResponse>

Promise<Models.IotHubResourceGetValidSkusResponse>
- Defined in operations/iotHubResource.ts:206
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- callback: msRest.ServiceCallback<IotHubSkuDescriptionListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:213
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<IotHubSkuDescriptionListResult>
  
  The callback
Returns void

getValidSkusNext

getValidSkusNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceGetValidSkusNextResponse>
getValidSkusNext(nextPageLink: string, callback: msRest.ServiceCallback<IotHubSkuDescriptionListResult>): void
getValidSkusNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<IotHubSkuDescriptionListResult>): void

- Defined in operations/iotHubResource.ts:913
Get the list of valid SKUs for an IoT hub.

summary

Get the list of valid SKUs for an IoT hub

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceGetValidSkusNextResponse>

Promise<Models.IotHubResourceGetValidSkusNextResponse>
- Defined in operations/iotHubResource.ts:918
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<IotHubSkuDescriptionListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:924
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<IotHubSkuDescriptionListResult>
  
  The callback
Returns void

importDevices

importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: ImportDevicesRequest, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceImportDevicesResponse>
importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: ImportDevicesRequest, callback: msRest.ServiceCallback<JobResponse>): void
importDevices(resourceGroupName: string, resourceName: string, importDevicesParameters: ImportDevicesRequest, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<JobResponse>): void

- Defined in operations/iotHubResource.ts:759
Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

summary

Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- importDevicesParameters: ImportDevicesRequest
  
  The parameters that specify the import devices operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceImportDevicesResponse>

Promise<Models.IotHubResourceImportDevicesResponse>
- Defined in operations/iotHubResource.ts:766
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- importDevicesParameters: ImportDevicesRequest
  
  The parameters that specify the import devices operation.
- callback: msRest.ServiceCallback<JobResponse>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:774
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- importDevicesParameters: ImportDevicesRequest
  
  The parameters that specify the import devices operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<JobResponse>
  
  The callback
Returns void

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceListByResourceGroupResponse>
listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<IotHubDescriptionListResult>): void
listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<IotHubDescriptionListResult>): void

- Defined in operations/iotHubResource.ts:137
Get all the IoT hubs in a resource group.

summary

Get all the IoT hubs in a resource group

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceListByResourceGroupResponse>

Promise<Models.IotHubResourceListByResourceGroupResponse>
- Defined in operations/iotHubResource.ts:142
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- callback: msRest.ServiceCallback<IotHubDescriptionListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:148
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<IotHubDescriptionListResult>
  
  The callback
Returns void

listByResourceGroupNext

listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceListByResourceGroupNextResponse>
listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<IotHubDescriptionListResult>): void
listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<IotHubDescriptionListResult>): void

- Defined in operations/iotHubResource.ts:884
Get all the IoT hubs in a resource group.

summary

Get all the IoT hubs in a resource group

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceListByResourceGroupNextResponse>

Promise<Models.IotHubResourceListByResourceGroupNextResponse>
- Defined in operations/iotHubResource.ts:889
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<IotHubDescriptionListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:895
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<IotHubDescriptionListResult>
  
  The callback
Returns void

listBySubscription

listBySubscription(options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceListBySubscriptionResponse>
listBySubscription(callback: msRest.ServiceCallback<IotHubDescriptionListResult>): void
listBySubscription(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<IotHubDescriptionListResult>): void

- Defined in operations/iotHubResource.ts:111
Get all the IoT hubs in a subscription.

summary

Get all the IoT hubs in a subscription

Parameters
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceListBySubscriptionResponse>

Promise<Models.IotHubResourceListBySubscriptionResponse>
- Defined in operations/iotHubResource.ts:115
Parameters
- callback: msRest.ServiceCallback<IotHubDescriptionListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:120
Parameters
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<IotHubDescriptionListResult>
  
  The callback
Returns void

listBySubscriptionNext

listBySubscriptionNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceListBySubscriptionNextResponse>
listBySubscriptionNext(nextPageLink: string, callback: msRest.ServiceCallback<IotHubDescriptionListResult>): void
listBySubscriptionNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<IotHubDescriptionListResult>): void

- Defined in operations/iotHubResource.ts:855
Get all the IoT hubs in a subscription.

summary

Get all the IoT hubs in a subscription

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceListBySubscriptionNextResponse>

Promise<Models.IotHubResourceListBySubscriptionNextResponse>
- Defined in operations/iotHubResource.ts:860
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<IotHubDescriptionListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:866
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<IotHubDescriptionListResult>
  
  The callback
Returns void

listEventHubConsumerGroups

listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceListEventHubConsumerGroupsResponse>
listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, callback: msRest.ServiceCallback<EventHubConsumerGroupsListResult>): void
listEventHubConsumerGroups(resourceGroupName: string, resourceName: string, eventHubEndpointName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<EventHubConsumerGroupsListResult>): void

- Defined in operations/iotHubResource.ts:236
Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.

summary

Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- eventHubEndpointName: string
  
  The name of the Event Hub-compatible endpoint.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceListEventHubConsumerGroupsResponse>

Promise<Models.IotHubResourceListEventHubConsumerGroupsResponse>
- Defined in operations/iotHubResource.ts:243
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- eventHubEndpointName: string
  
  The name of the Event Hub-compatible endpoint.
- callback: msRest.ServiceCallback<EventHubConsumerGroupsListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:251
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- eventHubEndpointName: string
  
  The name of the Event Hub-compatible endpoint.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<EventHubConsumerGroupsListResult>
  
  The callback
Returns void

listEventHubConsumerGroupsNext

listEventHubConsumerGroupsNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceListEventHubConsumerGroupsNextResponse>
listEventHubConsumerGroupsNext(nextPageLink: string, callback: msRest.ServiceCallback<EventHubConsumerGroupsListResult>): void
listEventHubConsumerGroupsNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<EventHubConsumerGroupsListResult>): void

- Defined in operations/iotHubResource.ts:944
Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.

summary

Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceListEventHubConsumerGroupsNextResponse>

Promise<Models.IotHubResourceListEventHubConsumerGroupsNextResponse>
- Defined in operations/iotHubResource.ts:949
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<EventHubConsumerGroupsListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:955
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<EventHubConsumerGroupsListResult>
  
  The callback
Returns void

listJobs

listJobs(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceListJobsResponse>
listJobs(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<JobResponseListResult>): void
listJobs(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<JobResponseListResult>): void

- Defined in operations/iotHubResource.ts:398
Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

summary

Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceListJobsResponse>

Promise<Models.IotHubResourceListJobsResponse>
- Defined in operations/iotHubResource.ts:404
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- callback: msRest.ServiceCallback<JobResponseListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:411
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<JobResponseListResult>
  
  The callback
Returns void

listJobsNext

listJobsNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceListJobsNextResponse>
listJobsNext(nextPageLink: string, callback: msRest.ServiceCallback<JobResponseListResult>): void
listJobsNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<JobResponseListResult>): void

- Defined in operations/iotHubResource.ts:975
Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.

summary

Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceListJobsNextResponse>

Promise<Models.IotHubResourceListJobsNextResponse>
- Defined in operations/iotHubResource.ts:980
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<JobResponseListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:986
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<JobResponseListResult>
  
  The callback
Returns void

listKeys

listKeys(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceListKeysResponse>
listKeys(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<SharedAccessSignatureAuthorizationRuleListResult>): void
listKeys(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<SharedAccessSignatureAuthorizationRuleListResult>): void

- Defined in operations/iotHubResource.ts:641
Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

summary

Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceListKeysResponse>

Promise<Models.IotHubResourceListKeysResponse>
- Defined in operations/iotHubResource.ts:647
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- callback: msRest.ServiceCallback<SharedAccessSignatureAuthorizationRuleListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:654
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the IoT hub.
- resourceName: string
  
  The name of the IoT hub.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<SharedAccessSignatureAuthorizationRuleListResult>
  
  The callback
Returns void

listKeysNext

listKeysNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceListKeysNextResponse>
listKeysNext(nextPageLink: string, callback: msRest.ServiceCallback<SharedAccessSignatureAuthorizationRuleListResult>): void
listKeysNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<SharedAccessSignatureAuthorizationRuleListResult>): void

- Defined in operations/iotHubResource.ts:1064
Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

summary

Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceListKeysNextResponse>

Promise<Models.IotHubResourceListKeysNextResponse>
- Defined in operations/iotHubResource.ts:1069
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<SharedAccessSignatureAuthorizationRuleListResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:1075
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<SharedAccessSignatureAuthorizationRuleListResult>
  
  The callback
Returns void

testAllRoutes

testAllRoutes(input: TestAllRoutesInput, iotHubName: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceTestAllRoutesResponse>
testAllRoutes(input: TestAllRoutesInput, iotHubName: string, resourceGroupName: string, callback: msRest.ServiceCallback<TestAllRoutesResult>): void
testAllRoutes(input: TestAllRoutesInput, iotHubName: string, resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<TestAllRoutesResult>): void

- Defined in operations/iotHubResource.ts:566
Test all routes configured in this Iot Hub

summary

Test all routes

Parameters
- input: TestAllRoutesInput
  
  Input for testing all routes
- iotHubName: string
  
  IotHub to be tested
- resourceGroupName: string
  
  resource group which Iot Hub belongs to
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceTestAllRoutesResponse>

Promise<Models.IotHubResourceTestAllRoutesResponse>
- Defined in operations/iotHubResource.ts:573
Parameters
- input: TestAllRoutesInput
  
  Input for testing all routes
- iotHubName: string
  
  IotHub to be tested
- resourceGroupName: string
  
  resource group which Iot Hub belongs to
- callback: msRest.ServiceCallback<TestAllRoutesResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:581
Parameters
- input: TestAllRoutesInput
  
  Input for testing all routes
- iotHubName: string
  
  IotHub to be tested
- resourceGroupName: string
  
  resource group which Iot Hub belongs to
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<TestAllRoutesResult>
  
  The callback
Returns void

testRoute

testRoute(input: TestRouteInput, iotHubName: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.IotHubResourceTestRouteResponse>
testRoute(input: TestRouteInput, iotHubName: string, resourceGroupName: string, callback: msRest.ServiceCallback<TestRouteResult>): void
testRoute(input: TestRouteInput, iotHubName: string, resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<TestRouteResult>): void

- Defined in operations/iotHubResource.ts:603
Test the new route for this Iot Hub

summary

Test the new route

Parameters
- input: TestRouteInput
  
  Route that needs to be tested
- iotHubName: string
  
  IotHub to be tested
- resourceGroupName: string
  
  resource group which Iot Hub belongs to
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.IotHubResourceTestRouteResponse>

Promise<Models.IotHubResourceTestRouteResponse>
- Defined in operations/iotHubResource.ts:610
Parameters
- input: TestRouteInput
  
  Route that needs to be tested
- iotHubName: string
  
  IotHub to be tested
- resourceGroupName: string
  
  resource group which Iot Hub belongs to
- callback: msRest.ServiceCallback<TestRouteResult>
  
  The callback
Returns void
- Defined in operations/iotHubResource.ts:618
Parameters
- input: TestRouteInput
  
  Route that needs to be tested
- iotHubName: string
  
  IotHub to be tested
- resourceGroupName: string
  
  resource group which Iot Hub belongs to
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<TestRouteResult>
  
  The callback
Returns void

update

update(resourceGroupName: string, resourceName: string, options?: Models.IotHubResourceUpdateOptionalParams): Promise<Models.IotHubResourceUpdateResponse>

- Defined in operations/iotHubResource.ts:87
Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method

summary

Update an existing IoT Hubs tags.

Parameters
- resourceGroupName: string
  
  Resource group identifier.
- resourceName: string
  
  Name of iot hub to update.
- Optional options: Models.IotHubResourceUpdateOptionalParams
Returns Promise<Models.IotHubResourceUpdateResponse>

Promise<Models.IotHubResourceUpdateResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: IotHubClientContext

Returns IotHubResource

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

resourceName: string

iotHubDescription: IotHubDescription

Optional options: Models.IotHubResourceBeginCreateOrUpdateOptionalParams

Returns Promise<msRestAzure.LROPoller>

beginDeleteMethod

Parameters

resourceGroupName: string

resourceName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginUpdate

Parameters

resourceGroupName: string

resourceName: string

Optional options: Models.IotHubResourceBeginUpdateOptionalParams

Returns Promise<msRestAzure.LROPoller>

checkNameAvailability

Parameters

name: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.IotHubResourceCheckNameAvailabilityResponse>

Parameters

name: string

callback: msRest.ServiceCallback<IotHubNameAvailabilityInfo>

Returns void

Parameters

name: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<IotHubNameAvailabilityInfo>

Returns void

createEventHubConsumerGroup

Parameters

resourceGroupName: string

resourceName: string

eventHubEndpointName: string

name: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.IotHubResourceCreateEventHubConsumerGroupResponse>

Parameters

resourceGroupName: string

resourceName: string

eventHubEndpointName: string

name: string

callback: msRest.ServiceCallback<EventHubConsumerGroupInfo>

Returns void

Parameters

resourceGroupName: string

resourceName: string

eventHubEndpointName: string

name: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<EventHubConsumerGroupInfo>

Returns void

createOrUpdate

Parameters

resourceGroupName: string

resourceName: string

iotHubDescription: IotHubDescription

Optional options: Models.IotHubResourceCreateOrUpdateOptionalParams

Returns Promise<Models.IotHubResourceCreateOrUpdateResponse>

deleteEventHubConsumerGroup

Parameters

resourceGroupName: string

resourceName: string

eventHubEndpointName: string

name: string

Optional options: msRest.RequestOptionsBase