NSX-T Data Center REST API

Returns the configuration of the compute VNet. The configuration contains quarantine policy and fall back security group of compute VNet and the information related to transit VNet.

Request:

Method:

GET

URI Path(s):

/api/v1/csm/azure/compute-vnets

Request Headers:

n/a

Query Parameters:

AzureComputeVNetListRequestParameters+

AzureComputeVNetListRequestParameters (schema)

Name	Description	Type	Notes
account_id	Azure Account ID Identifier for account based on which compute VNets are to 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
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
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
vnet_id	VNet ID Optional identifier for virtual network based on which compute virtual networks list can be filtered. It consists of resourceGuid of Azure VNet.	string

Request Body:

n/a

Example Request:

GET https://<nsx-csm>/api/v1/csm/azure/compute-vnets { "cursor": "00011", "sort_ascending": true, "result_count": 1, "results": [ { "resource_type": "AzureComputeVNetConfig", "id": "41e9e760-1c60-4b35-89c2", "display_name": "41e9e760-1c60-4b35-89c2", "default_quarantine_policy_enabled": false, "managed_without_agents": false, "account_id": "fa043e3d-256d-446f-9c5c-665dcfdb33c9", "configuration": { "account_id": "fa043e3d-256d-446f-9c5c-665dcfdb33c9", "vnet_id": "41e9e760-1c60-4b35-89" }, "_create_user": "system", "_create_time": 1540475272491, "_last_modified_user": "admin", "_last_modified_time": 1540475431491, "_system_owned": false, "_revision": 2 } ] }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AzureComputeVNetListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List of Compute VNets Array of Azure compute virtual networks.	array of AzureComputeVNetConfig
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Required Permissions:

read

Feature:

gateway_deployment