Virtual Networks - List Usage

Servicio:

Virtual Networks

Versión de la API:

2025-05-01

Enumera las estadísticas de uso.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
virtualNetworkName	path	True	string	El nombre de la red virtual.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	VirtualNetworkListUsageResult	La operación de Azure se completó correctamente.
Other Status Codes	Common.CloudError	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

VnetGetUsage

Solicitud de ejemplo

HTTP

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python virtual_network_list_usage.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 = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.virtual_networks.list_usage(
        resource_group_name="rg1",
        virtual_network_name="vnetName",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-05-01/VirtualNetworkListUsage.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

JavaScript

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
Common.CloudError	Una respuesta de error del servicio.
Common.CloudErrorBody	Una respuesta de error del servicio.
VirtualNetworkListUsageResult	Respuesta para la llamada al servicio getUsage API de redes virtuales.
VirtualNetworkUsage	Detalles de uso de la subred.
VirtualNetworkUsageName	Contenedor de cadenas de uso.

Common.CloudError

Objeto

Una respuesta de error del servicio.

Nombre	Tipo	Description
error	Common.CloudErrorBody	Cuerpo de error de nube.

Common.CloudErrorBody

Objeto

Una respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	Common.CloudErrorBody[]	Una lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

VirtualNetworkListUsageResult

Objeto

Respuesta para la llamada al servicio getUsage API de redes virtuales.

Nombre	Tipo	Description
nextLink	string (uri)	El enlace a la siguiente página de artículos
value	VirtualNetworkUsage[]	Los elementos de VirtualNetworkUsage en esta página

VirtualNetworkUsage

Objeto

Detalles de uso de la subred.

Nombre	Tipo	Description
currentValue	number (double)	Indica el número de direcciones IP utilizadas desde la subred.
id	string	Identificador de subred.
limit	number (double)	Indica el tamaño de la subred.
name	VirtualNetworkUsageName	El nombre que contiene el valor común y localizado para su uso.
unit	string	Unidades de uso. Devuelve 'Count'.

VirtualNetworkUsageName

Objeto

Contenedor de cadenas de uso.

Nombre	Tipo	Description
localizedValue	string	Tamaño de subred localizado y cadena de uso.
value	string	Tamaño de subred y cadena de uso.