Iot Hub Resource - Get Valid Skus

Get the list of valid SKUs for an IoT hub
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=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 a JSON-serialized array of the valid SKUs for this 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_GetValidSkus

Sample Request

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

Sample Response

{
  "value": [
    {
      "resourceType": "Microsoft.Devices/IotHubs",
      "sku": {
        "name": "S1",
        "tier": "Standard"
      },
      "capacity": {
        "default": 1,
        "scaleType": "Manual"
      }
    },
    {
      "resourceType": "Microsoft.Devices/IotHubs",
      "sku": {
        "name": "S2",
        "tier": "Standard"
      },
      "capacity": {
        "minimum": 1,
        "maximum": 200,
        "default": 1,
        "scaleType": "Manual"
      }
    },
    {
      "resourceType": "Microsoft.Devices/IotHubs",
      "sku": {
        "name": "S3",
        "tier": "Standard"
      },
      "capacity": {
        "minimum": 1,
        "maximum": 10,
        "default": 1,
        "scaleType": "Manual"
      }
    }
  ]
}

Definitions

ErrorDetails

Error details.

IotHubCapacity

IoT Hub capacity information.

IotHubScaleType

The type of the scaling enabled.

IotHubSku

The name of the SKU.

IotHubSkuDescription

SKU properties.

IotHubSkuDescriptionListResult

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

IotHubSkuInfo

Information about the SKU of the IoT hub.

IotHubSkuTier

The billing tier for the IoT hub.

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.

IotHubCapacity

IoT Hub capacity information.

Name Type Description
default
  • integer

The default number of units.

maximum
  • integer

The maximum number of units.

minimum
  • integer

The minimum number of units.

scaleType

The type of the scaling enabled.

IotHubScaleType

The type of the scaling enabled.

Name Type Description
Automatic
  • string
Manual
  • string
None
  • string

IotHubSku

The name of the SKU.

Name Type Description
B1
  • string
B2
  • string
B3
  • string
F1
  • string
S1
  • string
S2
  • string
S3
  • string

IotHubSkuDescription

SKU properties.

Name Type Description
capacity

IotHub capacity

resourceType
  • string

The type of the resource.

sku

The type of the resource.

IotHubSkuDescriptionListResult

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

Name Type Description
nextLink
  • string

The next link.

value

The array of IotHubSkuDescription.

IotHubSkuInfo

Information about the SKU of the IoT hub.

Name Type Description
capacity
  • integer

The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.

name

The name of the SKU.

tier

The billing tier for the IoT hub.

IotHubSkuTier

The billing tier for the IoT hub.

Name Type Description
Basic
  • string
Free
  • string
Standard
  • string