Share via


Virtual Network Subnet Usage - Execute

Get virtual network subnet usage for a given vNet resource id.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/checkVirtualNetworkSubnetUsage?api-version=2024-08-01

URI Parameters

Name In Required Type Description
locationName
path True

string

minLength: 1
pattern: ^[-\w\._]+$

The name of the location.

subscriptionId
path True

string (uuid)

The ID of the target subscription. The value must be an UUID.

api-version
query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Type Description
virtualNetworkArmResourceId

string

Virtual network resource id.

Responses

Name Type Description
200 OK

VirtualNetworkSubnetUsageResult

OK

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Microsoft Entra 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

VirtualNetworkSubnetUsageList

Sample request

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westus/checkVirtualNetworkSubnetUsage?api-version=2024-08-01

{
  "virtualNetworkArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/exampleresourcegroup/providers/Microsoft.Network/virtualNetworks/examplevirtualnetwork"
}

Sample response

{
  "delegatedSubnetsUsage": [
    {
      "subnetName": "examplesubnet1",
      "usage": 2
    },
    {
      "subnetName": "examplesubnet2",
      "usage": 3
    }
  ],
  "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff",
  "location": "westus"
}

Definitions

Name Description
DelegatedSubnetUsage

Delegated subnet usage data.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

VirtualNetworkSubnetUsageParameter

Virtual network subnet usage parameter

VirtualNetworkSubnetUsageResult

Virtual network subnet usage data.

DelegatedSubnetUsage

Delegated subnet usage data.

Name Type Description
subnetName

string

Name of the delegated subnet for which IP addresses are in use

usage

integer (int64)

Number of IP addresses used by the delegated subnet

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

VirtualNetworkSubnetUsageParameter

Virtual network subnet usage parameter

Name Type Description
virtualNetworkArmResourceId

string

Virtual network resource id.

VirtualNetworkSubnetUsageResult

Virtual network subnet usage data.

Name Type Description
delegatedSubnetsUsage

DelegatedSubnetUsage[]

Delegated subnet usage data.

location

string

location of the delegated subnet usage

subscriptionId

string

subscriptionId of the delegated subnet usage