Virtual Networks - List Usage

Usługa:: Virtual Networks

Wersja interfejsu API:: 2025-05-01

Wyświetla statystyki użycia.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/usages?api-version=2025-05-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
virtualNetworkName	path	True	string	Nazwa sieci wirtualnej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	VirtualNetworkListUsageResult	Operacja platformy Azure została zakończona pomyślnie.
Other Status Codes	Common.CloudError	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze 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

VnetGetUsage

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetName/usages?api-version=2025-05-01

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Lists usage stats.
 *
 * @summary Lists usage stats.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/VirtualNetworkListUsage.json
 */
async function vnetGetUsage() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkName = "vnetName";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.virtualNetworks.listUsage(
    resourceGroupName,
    virtualNetworkName,
  )) {
    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ź

Kod stanu:: 200

{
  "value": [
    {
      "name": {
        "localizedValue": "Subnet size and usage",
        "value": "SubnetSpace"
      },
      "currentValue": -1,
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetName/subnets/GatewaySubnet",
      "limit": -1,
      "unit": "Count"
    },
    {
      "name": {
        "localizedValue": "Subnet size and usage",
        "value": "SubnetSpace"
      },
      "currentValue": 2,
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetName/subnets/newSubnet",
      "limit": 3,
      "unit": "Count"
    }
  ]
}

Definicje

Nazwa	Opis
Common.CloudError	Odpowiedź o błędzie z usługi.
Common.CloudErrorBody	Odpowiedź o błędzie z usługi.
VirtualNetworkListUsageResult	Odpowiedź na wywołanie usługi interfejsu API GetUsage dla sieci wirtualnych.
VirtualNetworkUsage	Szczegóły użycia podsieci.
VirtualNetworkUsageName	Kontener ciągów użycia.

Common.CloudError

Objekt

Odpowiedź o błędzie z usługi.

Nazwa	Typ	Opis
error	Common.CloudErrorBody	Ciało błędu chmury.

Common.CloudErrorBody

Objekt

Odpowiedź o błędzie z usługi.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	Common.CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

VirtualNetworkListUsageResult

Objekt

Odpowiedź na wywołanie usługi interfejsu API GetUsage dla sieci wirtualnych.

Nazwa	Typ	Opis
nextLink	string (uri)	Link do następnej strony elementów
value	VirtualNetworkUsage[]	Elementy VirtualNetworkUsage na tej stronie

VirtualNetworkUsage

Objekt

Szczegóły użycia podsieci.

Nazwa	Typ	Opis
currentValue	number (double)	Wskazuje liczbę adresów IP używanych z podsieci.
id	string	Identyfikator podsieci.
limit	number (double)	Wskazuje rozmiar podsieci.
name	VirtualNetworkUsageName	Nazwa zawierająca typową i zlokalizowaną wartość użycia.
unit	string	Jednostki użycia. Zwraca wartość "Liczba".

VirtualNetworkUsageName

Objekt

Kontener ciągów użycia.

Nazwa	Typ	Opis
localizedValue	string	Zlokalizowany rozmiar podsieci i ciąg użycia.
value	string	Rozmiar podsieci i ciąg użycia.