Iot Hub Resource - Get Quota Metrics

Reference

Service:: IoT Hub

API Version:: 2018-04-01

Get the quota metrics for an IoT hub.

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

URI Parameters

Name	In	Required	Type	Description
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.
subscriptionId	path	True	string	The subscription identifier.
api-version	query	True	string	The version of the API.

Responses

Name	Type	Description
200 OK	IotHubQuotaMetricInfoListResult	This is a synchronous operation. The response contains a JSON-serialized array of the quota metrics for the IoT hub.
Other Status Codes	ErrorDetails	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_GetQuotaMetrics

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "name": "TotalMessages",
      "currentValue": 0,
      "maxValue": 400000
    },
    {
      "name": "TotalDeviceCount",
      "currentValue": 0,
      "maxValue": 500000
    }
  ]
}

Definitions

Name	Description
ErrorDetails	Error details.
IotHubQuotaMetricInfo	Quota metrics properties.
IotHubQuotaMetricInfoListResult	The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.

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.

IotHubQuotaMetricInfo

Quota metrics properties.

Name	Type	Description
currentValue	integer	The current value for the quota metric.
maxValue	integer	The maximum value of the quota metric.
name	string	The name of the quota metric.

IotHubQuotaMetricInfoListResult

The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.

Name	Type	Description
nextLink	string	The next link.
value	IotHubQuotaMetricInfo[]	The array of quota metrics objects.