Pobiera, dla określonej lokalizacji, bieżące informacje o użyciu zasobów obliczeniowych, a także limity zasobów obliczeniowych w ramach subskrypcji.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages?api-version=2024-03-01
Parametry identyfikatora URI
Nazwa |
W |
Wymagane |
Typ |
Opis |
location
|
path |
True
|
string
|
Lokalizacja, dla której jest odpytywane użycie zasobów.
Wzorzec wyrażenia regularnego: ^[-\w\._]+$
|
subscriptionId
|
path |
True
|
string
|
Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
|
api-version
|
query |
True
|
string
|
Wersja interfejsu API klienta.
|
Odpowiedzi
Nazwa |
Typ |
Opis |
200 OK
|
ListUsagesResult
|
OK
|
Other Status Codes
|
CloudError
|
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.
|
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
Usage_List_MaximumSet_Gen
Przykładowe żądanie
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
Przykładowa odpowiedź
{
"value": [
{
"unit": "Count",
"currentValue": 17,
"limit": 19,
"name": {
"value": "aaaaaaaaaaaaaaaaaa",
"localizedValue": "aaaaaaaaaaaaaa"
}
}
],
"nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
Usage_List_MinimumSet_Gen
Przykładowe żądanie
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
Przykładowa odpowiedź
{
"value": [
{
"unit": "Count",
"currentValue": 17,
"limit": 19,
"name": {}
}
]
}
Definicje
ApiError
Błąd interfejsu API.
Nazwa |
Typ |
Opis |
code
|
string
|
Kod błędu.
|
details
|
ApiErrorBase[]
|
Szczegóły błędu interfejsu API
|
innererror
|
InnerError
|
Wewnętrzny błąd interfejsu API
|
message
|
string
|
Komunikat o błędzie.
|
target
|
string
|
Element docelowy określonego błędu.
|
ApiErrorBase
Baza błędów interfejsu API.
Nazwa |
Typ |
Opis |
code
|
string
|
Kod błędu.
|
message
|
string
|
Komunikat o błędzie.
|
target
|
string
|
Element docelowy określonego błędu.
|
CloudError
Odpowiedź o błędzie z usługi Compute.
Nazwa |
Typ |
Opis |
error
|
ApiError
|
Błąd interfejsu API.
|
InnerError
Szczegóły błędu wewnętrznego.
Nazwa |
Typ |
Opis |
errordetail
|
string
|
Wewnętrzny komunikat o błędzie lub zrzut wyjątku.
|
exceptiontype
|
string
|
Typ wyjątku.
|
ListUsagesResult
Odpowiedź operacji Lista użycia.
Nazwa |
Typ |
Opis |
nextLink
|
string
|
Identyfikator URI do pobrania następnej strony informacji o użyciu zasobów obliczeniowych. Wywołaj metodę ListNext(), aby pobrać następną stronę informacji o użyciu zasobów obliczeniowych.
|
value
|
Usage[]
|
Lista użycia zasobów obliczeniowych.
|
Usage
Opisuje użycie zasobów obliczeniowych.
Nazwa |
Typ |
Opis |
currentValue
|
integer
|
Bieżące użycie zasobu.
|
limit
|
integer
|
Maksymalne dozwolone użycie zasobu.
|
name
|
UsageName
|
Nazwa typu użycia.
|
unit
|
UsageUnit
|
Wyliczenie opisujące jednostkę miary użycia.
|
UsageName
Nazwy użycia.
Nazwa |
Typ |
Opis |
localizedValue
|
string
|
Zlokalizowana nazwa zasobu.
|
value
|
string
|
Nazwa zasobu.
|
UsageUnit
Wyliczenie opisujące jednostkę miary użycia.
Nazwa |
Typ |
Opis |
Count
|
string
|
|