Iot Hub Resource - Get Valid Skus

Service:
IoT Hub
API Version:
2017-01-19

Get the list of valid SKUs for an IoT hub.

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

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 a JSON-serialized array of the valid SKUs for this IoT hub.
Other Status Codes

DefaultErrorResponse

Definitions

ErrorDetails
IotHubCapacity

IoT Hub capacity information.
IotHubSkuDescription

SKU properties.
IotHubSkuDescriptionListResult
IotHubSkuInfo

Information about the SKU of the IoT hub.
Name Type Description
Code
  • string

The error code.
Details
  • string

The error details.
HttpStatusCode
  • string

The HTTP status code.
Message
  • string

The error message.

IoT Hub capacity information.

Name Type Description
default
  • integer
    int64

The default number of units.
maximum
  • integer
    int64

The maximum number of units.
minimum
  • integer
    int64

The minimum number of units.
scaleType
  • enum:
    • Automatic
    • Manual
    • None

The type of the scaling enabled.

SKU properties.

Name Type Description
capacity

IoT Hub capacity information.
resourceType
  • string

The type of the resource.
sku

Information about the SKU of the IoT hub.
Name Type Description
nextLink
  • string

The next link.
value

The array of IotHubSkuDescription.

Information about the SKU of the IoT hub.

Name Type Description
capacity
  • integer
    int64

The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
name
  • enum:
    • F1
    • S1
    • S2
    • S3

The name of the SKU.
tier
  • enum:
    • Free
    • Standard

The billing tier for the IoT hub.