Iot Hub Resource - Get Valid Skus

Dienst:

IoT Hub

API-Version:

2023-06-30

Rufen Sie die Liste der gültigen SKUs für einen IoT Hub ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die den IoT Hub enthält.
resourceName	path	True	string	Der Name des IoT-Hubs.
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Die Version der API.

Antworten

Name	Typ	Beschreibung
200 OK	IotHubSkuDescriptionListResult	Dies ist ein synchroner Vorgang. Der Text enthält ein JSON-serialisiertes Array der gültigen SKUs für diesen IoT Hub.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

IotHubResource_GetValidSkus

Beispielanforderung

HTTP

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

Java

/** Samples for IotHubResource GetValidSkus. */
public final class Main {
    /*
     * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_getskus.json
     */
    /**
     * Sample code: IotHubResource_GetValidSkus.
     *
     * @param manager Entry point to IotHubManager.
     */
    public static void iotHubResourceGetValidSkus(com.azure.resourcemanager.iothub.IotHubManager manager) {
        manager.iotHubResources().getValidSkus("myResourceGroup", "testHub", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.iothub import IotHubClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iothub
# USAGE
    python iothub_getskus.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = IotHubClient(
        credential=DefaultAzureCredential(),
        subscription_id="91d12660-3dec-467a-be2a-213b5544ddc0",
    )

    response = client.iot_hub_resource.get_valid_skus(
        resource_group_name="myResourceGroup",
        resource_name="testHub",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_getskus.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armiothub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/32c178f2467f792a322f56174be244135d2c907f/specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_getskus.json
func ExampleResourceClient_NewGetValidSKUsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armiothub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewResourceClient().NewGetValidSKUsPager("myResourceGroup", "testHub", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SKUDescriptionListResult = armiothub.SKUDescriptionListResult{
		// 	Value: []*armiothub.SKUDescription{
		// 		{
		// 			Capacity: &armiothub.Capacity{
		// 				Default: to.Ptr[int64](1),
		// 				ScaleType: to.Ptr(armiothub.IotHubScaleTypeManual),
		// 			},
		// 			ResourceType: to.Ptr("Microsoft.Devices/IotHubs"),
		// 			SKU: &armiothub.SKUInfo{
		// 				Name: to.Ptr(armiothub.IotHubSKUS1),
		// 				Tier: to.Ptr(armiothub.IotHubSKUTierStandard),
		// 			},
		// 		},
		// 		{
		// 			Capacity: &armiothub.Capacity{
		// 				Default: to.Ptr[int64](1),
		// 				Maximum: to.Ptr[int64](200),
		// 				Minimum: to.Ptr[int64](1),
		// 				ScaleType: to.Ptr(armiothub.IotHubScaleTypeManual),
		// 			},
		// 			ResourceType: to.Ptr("Microsoft.Devices/IotHubs"),
		// 			SKU: &armiothub.SKUInfo{
		// 				Name: to.Ptr(armiothub.IotHubSKUS2),
		// 				Tier: to.Ptr(armiothub.IotHubSKUTierStandard),
		// 			},
		// 		},
		// 		{
		// 			Capacity: &armiothub.Capacity{
		// 				Default: to.Ptr[int64](1),
		// 				Maximum: to.Ptr[int64](10),
		// 				Minimum: to.Ptr[int64](1),
		// 				ScaleType: to.Ptr(armiothub.IotHubScaleTypeManual),
		// 			},
		// 			ResourceType: to.Ptr("Microsoft.Devices/IotHubs"),
		// 			SKU: &armiothub.SKUInfo{
		// 				Name: to.Ptr(armiothub.IotHubSKUS3),
		// 				Tier: to.Ptr(armiothub.IotHubSKUTierStandard),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { IotHubClient } = require("@azure/arm-iothub");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the list of valid SKUs for an IoT hub.
 *
 * @summary Get the list of valid SKUs for an IoT hub.
 * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_getskus.json
 */
async function iotHubResourceGetValidSkus() {
  const subscriptionId =
    process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
  const resourceGroupName = process.env["IOTHUB_RESOURCE_GROUP"] || "myResourceGroup";
  const resourceName = "testHub";
  const credential = new DefaultAzureCredential();
  const client = new IotHubClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.iotHubResource.listValidSkus(resourceGroupName, resourceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.IotHub.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.IotHub;

// Generated from example definition: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_getskus.json
// this example is just showing the usage of "IotHubResource_GetValidSkus" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this IotHubDescriptionResource created on azure
// for more information of creating IotHubDescriptionResource, please refer to the document of IotHubDescriptionResource
string subscriptionId = "91d12660-3dec-467a-be2a-213b5544ddc0";
string resourceGroupName = "myResourceGroup";
string resourceName = "testHub";
ResourceIdentifier iotHubDescriptionResourceId = IotHubDescriptionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, resourceName);
IotHubDescriptionResource iotHubDescription = client.GetIotHubDescriptionResource(iotHubDescriptionResourceId);

// invoke the operation and iterate over the result
await foreach (IotHubSkuDescription item in iotHubDescription.GetValidSkusAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:

200

{
  "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"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorDetails	Fehlerdetails.
IotHubCapacity	IoT Hub Kapazitätsinformationen.
IotHubScaleType	Der Typ der aktivierten Skalierung.
IotHubSku	Der Name der SKU.
IotHubSkuDescription	SKU-Eigenschaften.
IotHubSkuDescriptionListResult	Das JSON-serialisierte Array von IotHubSkuDescription-Objekten mit einem nächsten Link.
IotHubSkuInfo	Informationen zur SKU des IoT Hubs.
IotHubSkuTier	Die Abrechnungsebene für den IoT Hub.

ErrorDetails

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	string	Die Fehlerdetails.
httpStatusCode	string	Der HTTP-Statuscode.
message	string	Die Fehlermeldung.

IotHubCapacity

IoT Hub Kapazitätsinformationen.

Name	Typ	Beschreibung
default	integer	Die Standardanzahl von Einheiten.
maximum	integer	Die maximale Anzahl von Einheiten.
minimum	integer	Die Mindestanzahl von Einheiten.
scaleType	IotHubScaleType	Der Typ der aktivierten Skalierung.

IotHubScaleType

Der Typ der aktivierten Skalierung.

Name	Typ	Beschreibung
Automatic	string
Manual	string
None	string

IotHubSku

Der Name der SKU.

Name	Typ	Beschreibung
B1	string
B2	string
B3	string
F1	string
S1	string
S2	string
S3	string

IotHubSkuDescription

SKU-Eigenschaften.

Name	Typ	Beschreibung
capacity	IotHubCapacity	IotHub-Kapazität
resourceType	string	Der Typ der Ressource.
sku	IotHubSkuInfo	Der Typ der Ressource.

IotHubSkuDescriptionListResult

Das JSON-serialisierte Array von IotHubSkuDescription-Objekten mit einem nächsten Link.

Name	Typ	Beschreibung
nextLink	string	Der nächste Link.
value	IotHubSkuDescription[]	Das Array von IotHubSkuDescription.

IotHubSkuInfo

Informationen zur SKU des IoT Hubs.

Name	Typ	Beschreibung
capacity	integer	Die Anzahl der bereitgestellten IoT Hub Einheiten. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.
name	IotHubSku	Der Name der SKU.
tier	IotHubSkuTier	Die Abrechnungsebene für den IoT Hub.

IotHubSkuTier

Die Abrechnungsebene für den IoT Hub.

Name	Typ	Beschreibung
Basic	string
Free	string
Standard	string