Virtual Networks - List Usage

服務:

Virtual Networks

API 版本:

2025-05-01

列出使用統計資料。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。
subscriptionId	path	True	string	唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
virtualNetworkName	path	True	string	虛擬網路的名稱。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	VirtualNetworkListUsageResult	vnet 的使用量統計資料。
Other Status Codes	CloudError	說明作業為何失敗的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

VnetGetUsage

範例要求

HTTP

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

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

範例回覆

狀態碼:

200

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

定義

名稱	Description
CloudError	來自服務的錯誤回應。
CloudErrorBody	來自服務的錯誤回應。
VirtualNetworkListUsageResult	虛擬網路 GetUsage API 服務呼叫的回應。
VirtualNetworkUsage	子網的使用詳細數據。
VirtualNetworkUsageName	使用字串容器。

CloudError

Object

來自服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	雲端錯誤內文。

CloudErrorBody

Object

來自服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	有關錯誤的其他詳細資料清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。 例如，錯誤中的屬性名稱。

VirtualNetworkListUsageResult

Object

虛擬網路 GetUsage API 服務呼叫的回應。

名稱	類型	Description
nextLink	string	取得下一組結果的 URL。
value	VirtualNetworkUsage[]	VirtualNetwork 使用量統計資料。

VirtualNetworkUsage

Object

子網的使用詳細數據。

名稱	類型	Description
currentValue	number (double)	指出從子網路使用的 IP 數目。
id	string	子網路識別碼。
limit	number (double)	指出子網路的大小。
name	VirtualNetworkUsageName	包含通用和當地語系化值的名稱。
unit	string	使用單位。 傳回 'Count'。

VirtualNetworkUsageName

Object

使用字串容器。

名稱	類型	Description
localizedValue	string	當地語系化的子網路大小和使用方式字串。
value	string	子網路大小和使用方式字串。