Resource Provider Common - Get Subscription Quota

Get the number of iot hubs in the subscription
Get the number of free and paid iot hubs in the subscription

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/usages?api-version=2023-06-30

URI Parameters

Name In Required Type Description
subscriptionId
path True

string

The subscription identifier.

api-version
query True

string

The version of the API.

Responses

Name Type Description
200 OK

UserSubscriptionQuotaListResult

OK

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

ResourceProviderCommon_GetSubscriptionQuota

Sample request

GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages?api-version=2023-06-30

Sample response

{
  "value": [
    {
      "id": "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages/freeHubCount",
      "type": "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages",
      "unit": "count",
      "currentValue": 1,
      "limit": 1,
      "name": {
        "value": "FreeHubCount",
        "localizedValue": "Free Hub Count"
      }
    }
  ]
}

Definitions

Name Description
ErrorDetails

Error details.

Name

Name of Iot Hub type

UserSubscriptionQuota

User subscription quota response

UserSubscriptionQuotaListResult

Json-serialized array of User subscription quota response

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.

Name

Name of Iot Hub type

Name Type Description
localizedValue

string

Localized value of name

value

string

IotHub type

UserSubscriptionQuota

User subscription quota response

Name Type Description
currentValue

integer

Current number of IotHub type

id

string

IotHub type id

limit

integer

Numerical limit on IotHub type

name

Name

IotHub type

type

string

Response type

unit

string

Unit of IotHub type

UserSubscriptionQuotaListResult

Json-serialized array of User subscription quota response

Name Type Description
nextLink

string

value

UserSubscriptionQuota[]

User subscription quota response