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

Subnet ID

cidr

string

False

CIDR

name

string

True

Subnet name

availableIps

integer

True

The number of available IP addresses on the subnet

minimumRequiredIps

integer

True

The minimum needed IP addresses for the Cloud Volumes ONTAP system creation

  • format: int32

AzureVirtualNetworkCidrData

Name Type Required Description

cidr

string

True

CIDR

subnets

array[AzureSubnetResponse]

True

Subnets

TagResponse

Name Type Required Description

key

string

True

Tag key

value

string

True

Tag value

AzureVirtualNetworkResponse

Name Type Required Description

name

string

True

Virtual Network name

id

string

True

Virtual Network ID

cidrs

array[AzureVirtualNetworkCidrData]

True

CIDRs

resourceGroup

string

True

Resource Group

tags

array[TagResponse]

True

Tags

AzureSecurityGroupResponse

Name Type Required Description

id

string

True

Security group ID

name

string

True

Security group name

resourceGroup

string

False

Resource group