Usage - List

Referens

Tjänst:: Compute

API-version:: 2024-03-01

Hämtar, för den angivna platsen, aktuell information om användning av beräkningsresurser samt gränserna för beräkningsresurser under prenumerationen.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages?api-version=2024-03-01

URI-parametrar

Name I Obligatorisk Typ Description

Name	I	Obligatorisk	Typ	Description
location	path	True	string	Den plats där resursanvändning efterfrågas. Reguljärt uttrycksmönster: `^[-\w\._]+$`
subscriptionId	path	True	string	Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

location

path

True

string

Den plats där resursanvändning efterfrågas.

Reguljärt uttrycksmönster: ^[-\w\._]+$

subscriptionId

path

True

string

Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.

api-version

query

True

string

Klient-API-version.

Svar

Name	Typ	Description
200 OK	ListUsagesResult	OKEJ
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Usage_List_MaximumSet_Gen

Usage_List_MinimumSet_Gen

Usage_List_MaximumSet_Gen

Exempelbegäran

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/4_./usages?api-version=2024-03-01


/**
 * Samples for Usage List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * computeRPCommonExamples/Usage_List_MaximumSet_Gen.json
     */
    /**
     * Sample code: Usage_List_MaximumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void usageListMaximumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getUsages().list("4_.", 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.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python usage_list_maximum_set_gen.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 = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.usage.list(
        location="4_.",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/computeRPCommonExamples/Usage_List_MaximumSet_Gen.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 armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/computeRPCommonExamples/Usage_List_MaximumSet_Gen.json
func ExampleUsageClient_NewListPager_usageListMaximumSetGen() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewUsageClient().NewListPager("4_.", 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.ListUsagesResult = armcompute.ListUsagesResult{
		// 	Value: []*armcompute.Usage{
		// 		{
		// 			Name: &armcompute.UsageName{
		// 				LocalizedValue: to.Ptr("aaaaaaaaaaaaaa"),
		// 				Value: to.Ptr("aaaaaaaaaaaaaaaaaa"),
		// 			},
		// 			CurrentValue: to.Ptr[int32](17),
		// 			Limit: to.Ptr[int64](19),
		// 			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 { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.
 *
 * @summary Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/computeRPCommonExamples/Usage_List_MaximumSet_Gen.json
 */
async function usageListMaximumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const location = "4_.";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.usageOperations.list(location)) {
    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

Exempelsvar

Statuskod:: 200

{
  "value": [
    {
      "unit": "Count",
      "currentValue": 17,
      "limit": 19,
      "name": {
        "value": "aaaaaaaaaaaaaaaaaa",
        "localizedValue": "aaaaaaaaaaaaaa"
      }
    }
  ],
  "nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

Usage_List_MinimumSet_Gen

Exempelbegäran

GET https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/_--/usages?api-version=2024-03-01


/**
 * Samples for Usage List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * computeRPCommonExamples/Usage_List_MinimumSet_Gen.json
     */
    /**
     * Sample code: Usage_List_MinimumSet_Gen.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void usageListMinimumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getUsages().list("_--", 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.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python usage_list_minimum_set_gen.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 = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.usage.list(
        location="_--",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/computeRPCommonExamples/Usage_List_MinimumSet_Gen.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 armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/computeRPCommonExamples/Usage_List_MinimumSet_Gen.json
func ExampleUsageClient_NewListPager_usageListMinimumSetGen() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewUsageClient().NewListPager("_--", 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.ListUsagesResult = armcompute.ListUsagesResult{
		// 	Value: []*armcompute.Usage{
		// 		{
		// 			Name: &armcompute.UsageName{
		// 			},
		// 			CurrentValue: to.Ptr[int32](17),
		// 			Limit: to.Ptr[int64](19),
		// 			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 { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.
 *
 * @summary Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/computeRPCommonExamples/Usage_List_MinimumSet_Gen.json
 */
async function usageListMinimumSetGen() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const location = "_--";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.usageOperations.list(location)) {
    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

Exempelsvar

Statuskod:: 200

{
  "value": [
    {
      "unit": "Count",
      "currentValue": 17,
      "limit": 19,
      "name": {}
    }
  ]
}

Definitioner

Name	Description
ApiError	Api-fel.
ApiErrorBase	Api-felbas.
CloudError	Ett felsvar från Compute-tjänsten.
InnerError	Inre felinformation.
ListUsagesResult	Åtgärdssvaret Lista användningar.
Usage	Beskriver beräkningsresursanvändning.
UsageName	Användningsnamnen.
UsageUnit	En uppräkning som beskriver enheten för användningsmätning.

ApiError

Api-fel.

Name	Typ	Description
code	string	Felkoden.
details	ApiErrorBase[]	Api-felinformationen
innererror	InnerError	Api:ets inre fel
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

ApiErrorBase

Api-felbas.

Name	Typ	Description
code	string	Felkoden.
message	string	Felmeddelandet.
target	string	Målet för det specifika felet.

CloudError

Ett felsvar från Compute-tjänsten.

Name	Typ	Description
error	ApiError	Api-fel.

InnerError

Inre felinformation.

Name	Typ	Description
errordetail	string	Det interna felmeddelandet eller undantagsdumpen.
exceptiontype	string	Undantagstypen.

ListUsagesResult

Åtgärdssvaret Lista användningar.

Name	Typ	Description
nextLink	string	URI:n för att hämta nästa sida med information om användning av beräkningsresurser. Anropa ListNext() med detta för att hämta nästa sida med information om användning av beräkningsresurser.
value	Usage[]	Listan över användning av beräkningsresurser.

Usage

Beskriver beräkningsresursanvändning.

Name	Typ	Description
currentValue	integer	Den aktuella användningen av resursen.
limit	integer	Maximal tillåten användning av resursen.
name	UsageName	Namnet på användningstypen.
unit	UsageUnit	En uppräkning som beskriver enheten för användningsmätning.

UsageName

Användningsnamnen.

Name	Typ	Description
localizedValue	string	Resursens lokaliserade namn.
value	string	Namnet på resursen.

UsageUnit

En uppräkning som beskriver enheten för användningsmätning.

Name	Typ	Description
Count	string

Dela via

Usage - List

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Usage_List_MaximumSet_Gen

Exempelbegäran

Exempelsvar

Usage_List_MinimumSet_Gen

Exempelbegäran

Exempelsvar

Definitioner

ApiError

ApiErrorBase

CloudError

InnerError

ListUsagesResult

Usage

UsageName

UsageUnit

Ytterligare resurser