Resource Provider Common - Get Subscription Quota

Odwołanie

Usługa:: IoT Hub

Wersja interfejsu API:: 2023-06-30

Pobieranie liczby centrów iot w subskrypcji
Pobieranie liczby bezpłatnych i płatnych centrów iot w ramach subskrypcji

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	UserSubscriptionQuotaListResult	OK
Other Status Codes	ErrorDetails	DefaultErrorResponse

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ResourceProviderCommon_GetSubscriptionQuota

Przykładowe żądanie

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

/** Samples for ResourceProviderCommon GetSubscriptionQuota. */
public final class Main {
    /*
     * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_usages.json
     */
    /**
     * Sample code: ResourceProviderCommon_GetSubscriptionQuota.
     *
     * @param manager Entry point to IotHubManager.
     */
    public static void resourceProviderCommonGetSubscriptionQuota(
        com.azure.resourcemanager.iothub.IotHubManager manager) {
        manager.resourceProviderCommons().getSubscriptionQuotaWithResponse(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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-iothub
# USAGE
    python iothub_usages.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.resource_provider_common.get_subscription_quota()
    print(response)


# x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_usages.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

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_usages.json
func ExampleResourceProviderCommonClient_GetSubscriptionQuota() {
	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)
	}
	res, err := clientFactory.NewResourceProviderCommonClient().GetSubscriptionQuota(ctx, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.UserSubscriptionQuotaListResult = armiothub.UserSubscriptionQuotaListResult{
	// 	Value: []*armiothub.UserSubscriptionQuota{
	// 		{
	// 			Name: &armiothub.Name{
	// 				LocalizedValue: to.Ptr("Free Hub Count"),
	// 				Value: to.Ptr("FreeHubCount"),
	// 			},
	// 			Type: to.Ptr("/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages"),
	// 			CurrentValue: to.Ptr[int32](1),
	// 			ID: to.Ptr("/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages/freeHubCount"),
	// 			Limit: to.Ptr[int32](1),
	// 			Unit: to.Ptr("count"),
	// 	}},
	// }
}

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

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

/**
 * This sample demonstrates how to Get the number of free and paid iot hubs in the subscription
 *
 * @summary Get the number of free and paid iot hubs in the subscription
 * x-ms-original-file: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_usages.json
 */
async function resourceProviderCommonGetSubscriptionQuota() {
  const subscriptionId =
    process.env["IOTHUB_SUBSCRIPTION_ID"] || "91d12660-3dec-467a-be2a-213b5544ddc0";
  const credential = new DefaultAzureCredential();
  const client = new IotHubClient(credential, subscriptionId);
  const result = await client.resourceProviderCommon.getSubscriptionQuota();
  console.log(result);
}

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

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

// Generated from example definition: specification/iothub/resource-manager/Microsoft.Devices/stable/2023-06-30/examples/iothub_usages.json
// this example is just showing the usage of "ResourceProviderCommon_GetSubscriptionQuota" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "91d12660-3dec-467a-be2a-213b5544ddc0";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (IotHubUserSubscriptionQuota item in subscriptionResource.GetIotHubUserSubscriptionQuotaAsync())
{
    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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
ErrorDetails	Szczegóły błędu.
Name	Nazwa typu centrum Iot Hub
UserSubscriptionQuota	Odpowiedź na limit przydziału subskrypcji użytkownika
UserSubscriptionQuotaListResult	Tablica serializacji Json odpowiedzi limitu przydziału subskrypcji użytkownika

ErrorDetails

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	string	Szczegóły błędu.
httpStatusCode	string	Kod stanu HTTP.
message	string	Komunikat o błędzie.

Name

Nazwa typu centrum Iot Hub

Nazwa	Typ	Opis
localizedValue	string	Zlokalizowana wartość nazwy
value	string	Typ usługi IotHub

UserSubscriptionQuota

Odpowiedź na limit przydziału subskrypcji użytkownika

Nazwa	Typ	Opis
currentValue	integer	Bieżąca liczba typów IotHub
id	string	Identyfikator typu usługi IotHub
limit	integer	Limit liczbowy w typie IotHub
name	Name	Typ usługi IotHub
type	string	Typ odpowiedzi
unit	string	Jednostka typu IotHub

UserSubscriptionQuotaListResult

Tablica serializacji Json odpowiedzi limitu przydziału subskrypcji użytkownika

Nazwa	Typ	Opis
nextLink	string
value	UserSubscriptionQuota[]	Odpowiedź na limit przydziału subskrypcji użytkownika