Usages - List

  • Reference
Service:
Virtual Networks
API Version:
2023-09-01

List network usages for a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/usages?api-version=2023-09-01

URI Parameters

Name In Required Type Description
location
 path True

string

The location where resource usage is queried.

Regex pattern: ^[-\w\._ ]+$
subscriptionId
 path True

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version
 query True

string

Client API version.

Responses

Name Type Description
200 OK

UsagesListResult

Request successful. The operation returns a list of Usage resources.
Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

List usages
List usages spaced location

List usages

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages?api-version=2023-09-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "currentValue": 8,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/VirtualNetworks",
      "limit": 50,
      "name": {
        "localizedValue": "Virtual Networks",
        "value": "VirtualNetworks"
      },
      "unit": "Count"
    },
    {
      "currentValue": 3,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/StaticPublicIPAddresses",
      "limit": 20,
      "name": {
        "localizedValue": "Static Public IP Addresses",
        "value": "StaticPublicIPAddresses"
      },
      "unit": "Count"
    },
    {
      "currentValue": 1,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkSecurityGroups",
      "limit": 100,
      "name": {
        "localizedValue": "Network Security Groups",
        "value": "NetworkSecurityGroups"
      },
      "unit": "Count"
    },
    {
      "currentValue": 8,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PublicIPAddresses",
      "limit": 60,
      "name": {
        "localizedValue": "Public IP Addresses",
        "value": "PublicIPAddresses"
      },
      "unit": "Count"
    },
    {
      "currentValue": 2,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkInterfaces",
      "limit": 350,
      "name": {
        "localizedValue": "Network Interfaces",
        "value": "NetworkInterfaces"
      },
      "unit": "Count"
    },
    {
      "currentValue": 2,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/LoadBalancers",
      "limit": 100,
      "name": {
        "localizedValue": "Load Balancers",
        "value": "LoadBalancers"
      },
      "unit": "Count"
    },
    {
      "currentValue": 1,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/ApplicationGateways",
      "limit": 50,
      "name": {
        "localizedValue": "Application Gateways",
        "value": "ApplicationGateways"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteTables",
      "limit": 100,
      "name": {
        "localizedValue": "Route Tables",
        "value": "RouteTables"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilters",
      "limit": 1000,
      "name": {
        "localizedValue": "Route Filters",
        "value": "RouteFilters"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkWatchers",
      "limit": 1,
      "name": {
        "localizedValue": "Network Watchers",
        "value": "NetworkWatchers"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PacketCaptures",
      "limit": 10,
      "name": {
        "localizedValue": "Packet Captures",
        "value": "PacketCaptures"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/DnsServersPerVirtualNetwork",
      "limit": 9,
      "name": {
        "localizedValue": "DNS servers per Virtual Network",
        "value": "DnsServersPerVirtualNetwork"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SubnetsPerVirtualNetwork",
      "limit": 1000,
      "name": {
        "localizedValue": "Subnets per Virtual Network",
        "value": "SubnetsPerVirtualNetwork"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/IPConfigurationsPerVirtualNetwork",
      "limit": 4096,
      "name": {
        "localizedValue": "IP Configurations per Virtual Network",
        "value": "IPConfigurationsPerVirtualNetwork"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PeeringsPerVirtualNetwork",
      "limit": 10,
      "name": {
        "localizedValue": "Peerings per Virtual Network",
        "value": "PeeringsPerVirtualNetwork"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRulesPerNetworkSecurityGroup",
      "limit": 200,
      "name": {
        "localizedValue": "Security rules per Network Security Group",
        "value": "SecurityRulesPerNetworkSecurityGroup"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRuleAddressesOrPortsPerNetworkSecurityGroup",
      "limit": 2000,
      "name": {
        "localizedValue": "Security rules addresses or ports per Network Security Group",
        "value": "SecurityRuleAddressesOrPortsPerNetworkSecurityGroup"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerLoadBalancer",
      "limit": 150,
      "name": {
        "localizedValue": "Inbound Rules per Load Balancer",
        "value": "InboundRulesPerLoadBalancer"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/FrontendIPConfigurationPerLoadBalancer",
      "limit": 10,
      "name": {
        "localizedValue": "Frontend IP Configurations per Load Balancer",
        "value": "FrontendIPConfigurationPerLoadBalancer"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/outboundRulesPerLoadBalancer",
      "limit": 5,
      "name": {
        "localizedValue": "Outbound Rules per Load Balancer",
        "value": "outboundRulesPerLoadBalancer"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RoutesPerRouteTable",
      "limit": 100,
      "name": {
        "localizedValue": "Routes per Route Table",
        "value": "RoutesPerRouteTable"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecondaryIPConfigurationsPerNetworkInterface",
      "limit": 256,
      "name": {
        "localizedValue": "Secondary IP Configurations per Network Interface",
        "value": "SecondaryIPConfigurationsPerNetworkInterface"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerNetworkInterface",
      "limit": 500,
      "name": {
        "localizedValue": "Inbound rules per Network Interface",
        "value": "InboundRulesPerNetworkInterface"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilterRulesPerRouteFilter",
      "limit": 1,
      "name": {
        "localizedValue": "Route filter rules per Route Filter",
        "value": "RouteFilterRulesPerRouteFilter"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFiltersPerExpressRouteBgpPeering",
      "limit": 1,
      "name": {
        "localizedValue": "Route filters per Express route BGP Peering",
        "value": "RouteFiltersPerExpressRouteBgpPeering"
      },
      "unit": "Count"
    }
  ]
}

List usages spaced location

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages?api-version=2023-09-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "currentValue": 12,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/VirtualNetworks",
      "limit": 50,
      "name": {
        "localizedValue": "Virtual Networks",
        "value": "VirtualNetworks"
      },
      "unit": "Count"
    },
    {
      "currentValue": 1,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/StaticPublicIPAddresses",
      "limit": 20,
      "name": {
        "localizedValue": "Static Public IP Addresses",
        "value": "StaticPublicIPAddresses"
      },
      "unit": "Count"
    },
    {
      "currentValue": 3,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkSecurityGroups",
      "limit": 100,
      "name": {
        "localizedValue": "Network Security Groups",
        "value": "NetworkSecurityGroups"
      },
      "unit": "Count"
    },
    {
      "currentValue": 12,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PublicIPAddresses",
      "limit": 60,
      "name": {
        "localizedValue": "Public IP Addresses",
        "value": "PublicIPAddresses"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PublicIpPrefixes",
      "limit": 2147483647,
      "name": {
        "localizedValue": "Public Ip Prefixes",
        "value": "PublicIpPrefixes"
      },
      "unit": "Count"
    },
    {
      "currentValue": 2,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkInterfaces",
      "limit": 24000,
      "name": {
        "localizedValue": "Network Interfaces",
        "value": "NetworkInterfaces"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/LoadBalancers",
      "limit": 100,
      "name": {
        "localizedValue": "Load Balancers",
        "value": "LoadBalancers"
      },
      "unit": "Count"
    },
    {
      "currentValue": 3,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ApplicationGateways",
      "limit": 50,
      "name": {
        "localizedValue": "Application Gateways",
        "value": "ApplicationGateways"
      },
      "unit": "Count"
    },
    {
      "currentValue": 5,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteTables",
      "limit": 100,
      "name": {
        "localizedValue": "Route Tables",
        "value": "RouteTables"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFilters",
      "limit": 1000,
      "name": {
        "localizedValue": "Route Filters",
        "value": "RouteFilters"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkWatchers",
      "limit": 1,
      "name": {
        "localizedValue": "Network Watchers",
        "value": "NetworkWatchers"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PacketCaptures",
      "limit": 100,
      "name": {
        "localizedValue": "Packet Captures",
        "value": "PacketCaptures"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ApplicationSecurityGroups",
      "limit": 500,
      "name": {
        "localizedValue": "Application Security Groups.",
        "value": "ApplicationSecurityGroups"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/DdosProtectionPlans",
      "limit": 1,
      "name": {
        "localizedValue": "DDoS Protection Plans.",
        "value": "DdosProtectionPlans"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ServiceEndpointPolicies",
      "limit": 200,
      "name": {
        "localizedValue": "Service Endpoint Policies",
        "value": "ServiceEndpointPolicies"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkIntentPolicies",
      "limit": 200,
      "name": {
        "localizedValue": "Network Intent Policies",
        "value": "NetworkIntentPolicies"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/DnsServersPerVirtualNetwork",
      "limit": 9,
      "name": {
        "localizedValue": "DNS servers per Virtual Network",
        "value": "DnsServersPerVirtualNetwork"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SubnetsPerVirtualNetwork",
      "limit": 1000,
      "name": {
        "localizedValue": "Subnets per Virtual Network",
        "value": "SubnetsPerVirtualNetwork"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/IPConfigurationsPerVirtualNetwork",
      "limit": 16384,
      "name": {
        "localizedValue": "IP Configurations per Virtual Network",
        "value": "IPConfigurationsPerVirtualNetwork"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PeeringsPerVirtualNetwork",
      "limit": 50,
      "name": {
        "localizedValue": "Peerings per Virtual Network",
        "value": "PeeringsPerVirtualNetwork"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRulesPerNetworkSecurityGroup",
      "limit": 1000,
      "name": {
        "localizedValue": "Security rules per Network Security Group",
        "value": "SecurityRulesPerNetworkSecurityGroup"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRulesPerNetworkIntentPolicy",
      "limit": 100,
      "name": {
        "localizedValue": "Security rules per Network Intent Policy",
        "value": "SecurityRulesPerNetworkIntentPolicy"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RoutesPerNetworkIntentPolicy",
      "limit": 100,
      "name": {
        "localizedValue": "Routes per Network Intent Policy",
        "value": "RoutesPerNetworkIntentPolicy"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRuleAddressesOrPortsPerNetworkSecurityGroup",
      "limit": 2000,
      "name": {
        "localizedValue": "Security rules addresses or ports per Network Security Group",
        "value": "SecurityRuleAddressesOrPortsPerNetworkSecurityGroup"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/InboundRulesPerLoadBalancer",
      "limit": 150,
      "name": {
        "localizedValue": "Inbound Rules per Load Balancer",
        "value": "InboundRulesPerLoadBalancer"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/FrontendIPConfigurationPerLoadBalancer",
      "limit": 10,
      "name": {
        "localizedValue": "Frontend IP Configurations per Load Balancer",
        "value": "FrontendIPConfigurationPerLoadBalancer"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/OutboundRulesPerLoadBalancer",
      "limit": 5,
      "name": {
        "localizedValue": "Outbound Rules per Load Balancer",
        "value": "OutboundRulesPerLoadBalancer"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RoutesPerRouteTable",
      "limit": 400,
      "name": {
        "localizedValue": "Routes per Route Table",
        "value": "RoutesPerRouteTable"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecondaryIPConfigurationsPerNetworkInterface",
      "limit": 256,
      "name": {
        "localizedValue": "Secondary IP Configurations per Network Interface",
        "value": "SecondaryIPConfigurationsPerNetworkInterface"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/InboundRulesPerNetworkInterface",
      "limit": 500,
      "name": {
        "localizedValue": "Inbound rules per Network Interface",
        "value": "InboundRulesPerNetworkInterface"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFilterRulesPerRouteFilter",
      "limit": 1,
      "name": {
        "localizedValue": "Route filter rules per Route Filter",
        "value": "RouteFilterRulesPerRouteFilter"
      },
      "unit": "Count"
    },
    {
      "currentValue": 0,
      "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFiltersPerExpressRouteBgpPeering",
      "limit": 1,
      "name": {
        "localizedValue": "Route filters per Express route BGP Peering",
        "value": "RouteFiltersPerExpressRouteBgpPeering"
      },
      "unit": "Count"
    }
  ]
}

Definitions

Name Description
CloudError

An error response from the service.
CloudErrorBody

An error response from the service.
Usage

The network resource usage.
UsageName

The usage names.
UsagesListResult

The list usages operation response.
UsageUnit

An enum describing the unit of measurement.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details

CloudErrorBody[]

A list of additional details about the error.
message

string

A message describing the error, intended to be suitable for display in a user interface.
target

string

The target of the particular error. For example, the name of the property in error.

Usage

The network resource usage.

Name Type Description
currentValue

integer

The current value of the usage.
id

string

Resource identifier.
limit

integer

The limit of usage.
name

UsageName

The name of the type of usage.
unit

UsageUnit

An enum describing the unit of measurement.

UsageName

The usage names.

Name Type Description
localizedValue

string

A localized string describing the resource name.
value

string

A string describing the resource name.

UsagesListResult

The list usages operation response.

Name Type Description
nextLink

string

URL to get the next set of results.
value

Usage[]

The list network resource usages.

UsageUnit

An enum describing the unit of measurement.

Name Type Description
Count

string