NSX-T Data Center REST API

AzureVnetListRequestParameters (schema)

Azure VNet List Request Parameters

A set of optional filter parameters to list Azure virtual networks.
Multiple parameters can be given as input to 'AND' them.

Name Description Type Notes
account_id Account ID

Optional identifier for account based on which virtual networks list
can be filtered.
string
associated_transit_vnet_id Transit VNet ID

Identifier for filtering all the compute VNets which are NSX managed
by the given transit VNet.
string
cidr IPv4 CIDR Block

Optional identifier for IPv4 CIDR Block based on which virtual networks
list can be filtered.
CidrBlock
cursor Opaque cursor to be used for getting next page of records (supplied by current result page) string
included_fields Comma separated list of fields that should be included in query result

Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.
string
op_status Azure VNet Operational Status

Operational status of the virtual network.
AzureVnetOpStatus Readonly
page_size Maximum number of results to return in this page (server may return fewer) integer Minimum: 0
Maximum: 1000
Default: "1000"
region_id Region ID

Optional identifier for region based on which virtual networks list can
be filtered.
string
sort_ascending boolean
sort_by Field by which records are sorted string
status_filter Filter by overall VNet status

MANAGED - VNet is managed by NSX
UNMANAGED - VNet is not managed by NSX
ERRORED - VNet is in error state
string Readonly
Enum: MANAGED, UNMANAGED, ERRORED
vnet_id Virtual Network ID

Optional identifier for virtual network based on which virtual networks
list can be filtered. It consists of resourceGuid of Azure VNet.
string