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/<vnet-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AzureComputeVNetConfig+

AzureComputeVNetConfig (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
account_id	Azure Account ID Azure account ID related to the compute VNet. This field is deprecated. Field account_id can be learnt using vnet_id. GET /csm/azure/vnets/ API returns associated_account_ids. Hence, this field is optional.	string	Deprecated
auto_agent_install_enabled	Auto Agent Install Enabled Flag to identify if NSX agent installation will be done automatically or not. As of now this is supported for Azure Cloud only. If the flag managed_without_agents is set to true, this property will be ignored.	boolean	Default: "False"
cloud_fallback_security_group_id	Id of Cloud Security Group Id of security group where the VMs should be moved after last gateway undeployed. This field is required only when default_quarantine_policy_enabled field is set to false.	string
configuration	Azure Transit VNet Configuration All the required informations regarding a transit VNet will be absorbed as a part of this field.	AzureTransitVnetConfig	Required
default_quarantine_policy_enabled	Flag to Identify if Default Quarantine Policy is Enabled Flag to convey if virtual machines belonging to the compute virtual private cloud should be quarantined or not.	boolean	Default: "False"
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
managed_without_agents	Managed Without NSX Agents This flag determines if this compute virtual private cloud is managed with or without NSX agents.	boolean	Default: "False"
resource_type	Must be set to the value AzureComputeVNetConfig	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

GET https://<nsx-csm>/api/v1/csm/azure/compute-vnets/ { "resource_type": "AzureComputeVNetConfig", "id": "41e9e760-1c60-4b35-89c2", "display_name": "41e9e760-1c60-4b35-89c2", "default_quarantine_policy_enabled": false, "managed_without_agents": false, "configuration": { "vnet_id": "41e9e760-1c60-4b35-89d4" }, "_create_user": "system", "_create_time": 1540475272491, "_last_modified_user": "admin", "_last_modified_time": 1540475431491, "_system_owned": false, "_revision": 2 }

Required Permissions:

read

Feature:

gateway_deployment

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable