NSX-T Data Center REST API

AzureComputeVNetConfig (type)

{
  "additionalProperties": false, 
  "description": "Stores the parameters required for linking compute VNet with the Transit VNet.", 
  "extends": {
    "$ref": "AzureVNetConfig
  }, 
  "id": "AzureComputeVNetConfig", 
  "module_id": "AzureVnetInformation", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "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.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "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.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "account_id": {
      "deprecated": true, 
      "description": "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/<vnet-id> API returns associated_account_ids. Hence, this field is optional.", 
      "required": false, 
      "title": "Azure Account ID", 
      "type": "string"
    }, 
    "auto_agent_install_enabled": {
      "default": false, 
      "description": "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.", 
      "required": false, 
      "title": "Auto Agent Install Enabled", 
      "type": "boolean"
    }, 
    "cloud_fallback_security_group_id": {
      "description": "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.", 
      "title": "Id of Cloud Security Group", 
      "type": "string"
    }, 
    "configuration": {
      "$ref": "AzureTransitVnetConfig, 
      "description": "All the required informations regarding a transit VNet will be absorbed as a part of this field.", 
      "required": true, 
      "title": "Azure Transit VNet Configuration"
    }, 
    "default_quarantine_policy_enabled": {
      "default": false, 
      "description": "Flag to convey if virtual machines belonging to the compute virtual private cloud should be quarantined or not.", 
      "title": "Flag to Identify if Default Quarantine Policy is Enabled", 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "managed_without_agents": {
      "default": false, 
      "description": "This flag determines if this compute virtual private cloud is managed with or without NSX agents.", 
      "required": false, 
      "title": "Managed Without NSX Agents", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Azure Compute VNet Configuration", 
  "type": "object"
}