Iot Hub Resource - Get Stats

Get the statistics from an IoT hub
Get the statistics from an IoT hub.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats?api-version=2018-04-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription identifier.

resourceGroupName
path True
  • string

The name of the resource group that contains the IoT hub.

resourceName
path True
  • string

The name of the IoT hub.

api-version
query True
  • string

The version of the API.

Responses

Name Type Description
200 OK

This is a synchronous operation. The body contains JSON-serialized statistics from the identity registry in the IoT hub.

Other Status Codes

DefaultErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

IotHubResource_GetStats

Sample Request

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/IotHubStats?api-version=2018-04-01

Sample Response

{
  "totalDeviceCount": 0,
  "enabledDeviceCount": 0,
  "disabledDeviceCount": 0
}

Definitions

ErrorDetails

Error details.

RegistryStatistics

Identity registry statistics.

ErrorDetails

Error details.

Name Type Description
code
  • string

The error code.

details
  • string

The error details.

httpStatusCode
  • string

The HTTP status code.

message
  • string

The error message.

RegistryStatistics

Identity registry statistics.

Name Type Description
disabledDeviceCount
  • integer

The count of disabled devices in the identity registry.

enabledDeviceCount
  • integer

The count of enabled devices in the identity registry.

totalDeviceCount
  • integer

The total count of devices in the identity registry.