NSX-T Data Center REST API

Returns information about a particular Azure virtual network

Returns information about Azure region like virtual network like IPv4 CIDR,
gateway information and transport zones.

Request:

Method:

GET

URI Path(s):

/api/v1/csm/azure/vnets/<vnet-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-csm>/api/v1/csm/azure/vnets/41e9e760-1c60-4b35-89c2

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AzureVnet+

AzureVnet (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
agent_info	Azure Agent Information Array of agent install and download instructions for various OS types.	array of AgentInfo	Readonly
associated_account_ids	Associated Azure Account IDs Array of associated Azure account IDs.	array of string
associated_transit_vnet	Associated Azure Transit VNet Stores the VNet ID and associated account IDs of the transit VNet. This property describes the associated transit VNet for a given Azure compute VNet.	AzureTransitVnetInfo	Readonly
capabilities	List of external capabilities that are discovered on this virtual network This parameter will list out all external services and/or any other capabilities that are discovered by NSX on this virtual network. The array is empty by default.	array of string	Readonly Enum: HORIZON
cidr_blocks	IPv4 CIDR Block IPv4 CIDR Block of the virtual network.	array of CidrBlock	Readonly
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
gateway_info	Gateway Info Gateway information of the virtual network like configuration and status.	AzureGatewayInfo	Readonly
id	Unique identifier of this resource	string	Sortable
instance_stats	Instance Statistics Stores statistics of the number of MANAGED, UNMANAGED, ERRORED and POWERED_OFF instances.	InstanceStats	Readonly
is_management_vnet	Is Management VNet? This flag indicates if this is a management virtual network.	boolean	Readonly Default: "False"
managed_vnets	Array of NSX Managed Compute VNets Array of compute VNets managed by a transit VNet. This property describes array of managed compute VNet for a given transit VNet.	array of ManagedVnetInfo	Readonly
op_status	Azure VNet Operational Status Operational status of the virtual network.	AzureVnetOpStatus	Readonly
region_id	Region ID ID of the Azure region.	string	Readonly
resource_group	Resource Group Resource Group of the Azure VNet.	string	Readonly
resource_id	Azure VNet resource id Resource Id of Azure VNet.	string	Readonly
resource_type	Must be set to the value AzureVnet	string
storage_account_name	Azure Storage Account Name Azure Storage Account where gateway image will be copied.	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_zones	Transport Zones Array of transport zones in the virtual network.	array of TransportZoneInfo	Readonly
vdi_stats	Horizon VDI Statistics Stores statistics of the number of Horizon desktops in different states such as MANAGED, UNMANAGED, ERRORED and POWERED_OFF	InstanceStats	Readonly
vnet_status	Azure Compute VNet Status Stores onboard and offboard states and corresponding error messages and error code related to Azure compute VNet. The status for a transit VNet should be obtained from gateway_info.	AzureComputeVnetStatus	Readonly

Example Response:

{ "resource_type": "AzureVnet", "id": "41e9e760-1c60-4b35-89c2", "display_name": "NSX-Vnet-1", "cidr_blocks": [ "10.59.4.80/28", "172.18.25.0/24", "172.18.26.0/24", "172.18.27.0/24", "172.18.28.0/24", "172.18.29.0/24" ], "resource_group": "NSX-Vnet-1-RG", "associated_account_ids": [ "28984eef-d296-4a40-979e" ], "region_id": "westus", "resource_id": "/subscriptions/1234567890/resourceGroups/NSX-Vnet-1-RG/providers/Microsoft.Network/virtualNetworks/NSX-Vnet-1", "instance_stats": { "total": 1, "managed": 0, "unmanaged": 1, "error": 0, "powered_off": 0 }, "op_status": "NSX_UNMANAGED", "gateway_info": { "gateway_status": { "gateway_cluster_id": "" } }, "is_management_vnet": false, "_protection": "NOT_PROTECTED" }

Required Permissions:

read

Feature:

cloud_resources

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