Skip to main content

Retrieve network extended information

GET /azure/vsa/metadata/vnets

Retrieves network extended information.

Parameters

Name Type In Required Description

region

string

query

False

subscriptionId

string

query

False

cloudProviderAccountId

string

query

False

Error

Status: Default, Default response
Name Type Required Description

virtualNetworks

array[AzureVirtualNetworkResponse]

False

securityGroups

array[AzureSecurityGroupResponse]

False
Example error response 
{
  "virtualNetworks": [
    {
      "name": "string",
      "id": "string",
      "cidrs": [
        {
          "cidr": "string",
          "subnets": [
            {}
          ]
        }
      ],
      "resourceGroup": "string",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "securityGroups": [
    {
      "id": "string",
      "name": "string",
      "resourceGroup": "string"
    }
  ]
}

Definitions

See Definitions

AzureSubnetResponse

Name Type Required Description

id

string

True

cidr

string

False

name

string

True

availableIps

integer

True

minimumRequiredIps

integer

True

AzureVirtualNetworkCidrData

Name Type Required Description

cidr

string

True

subnets

array[AzureSubnetResponse]

True

TagResponse

Name Type Required Description

key

string

True

value

string

True

AzureVirtualNetworkResponse

Name Type Required Description

name

string

True

id

string

True

cidrs

array[AzureVirtualNetworkCidrData]

True

resourceGroup

string

True

tags

array[TagResponse]

True

AzureSecurityGroupResponse

Name Type Required Description

id

string

True

name

string

True

resourceGroup

string

False