Virtual Networks - List Usage

Dienst:: Virtual Networks

API-Version:: 2025-05-01

Listet Nutzungsstatistiken auf.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
virtualNetworkName	path	True	string	Den Namen des virtuellen Netzwerks.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualNetworkListUsageResult	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	Common.CloudError	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

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

Beispiel für eine Antwort

Statuscode:: 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"
    }
  ]
}

Definitionen

Name	Beschreibung
Common.CloudError	Eine Fehlerantwort vom Dienst.
Common.CloudErrorBody	Eine Fehlerantwort vom Dienst.
VirtualNetworkListUsageResult	Antwort für den Aufruf des GetUsage-API-Diensts für virtuelle Netzwerke.
VirtualNetworkUsage	Nutzungsdetails für Subnetz.
VirtualNetworkUsageName	Container für Verwendungszeichenfolgen.

Common.CloudError

Objekt

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
error	Common.CloudErrorBody	Cloud-Fehlertext.

Common.CloudErrorBody

Objekt

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	Common.CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

VirtualNetworkListUsageResult

Objekt

Antwort für den Aufruf des GetUsage-API-Diensts für virtuelle Netzwerke.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite der Elemente
value	VirtualNetworkUsage[]	Die VirtualNetworkUsage-Elemente auf dieser Seite

VirtualNetworkUsage

Objekt

Nutzungsdetails für Subnetz.

Name	Typ	Beschreibung
currentValue	number (double)	Gibt die Anzahl der IP-Adressen an, die aus dem Subnetz verwendet werden.
id	string	Subnetz-ID.
limit	number (double)	Gibt die Größe des Subnetzes an.
name	VirtualNetworkUsageName	Der Name, der den allgemeinen und lokalisierten Wert für die Verwendung enthält.
unit	string	Nutzungseinheiten. Gibt 'Count' zurück.

VirtualNetworkUsageName

Objekt

Container für Verwendungszeichenfolgen.

Name	Typ	Beschreibung
localizedValue	string	Lokalisierte Subnetzgröße und Verwendungszeichenfolge.
value	string	Subnetzgröße und Verwendungszeichenfolge.