Azure Networking Services · Schema
VirtualNetworkPropertiesFormat
Properties of the virtual network.
AzureCloudInfrastructureMicrosoftNetworking
Properties
| Name | Type | Description |
|---|---|---|
| addressSpace | object | The AddressSpace that contains an array of IP address ranges that can be used by subnets. |
| bgpCommunities | object | Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. |
| ddosProtectionPlan | object | Reference to another subresource. |
| dhcpOptions | object | The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. |
| enableDdosProtection | boolean | Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource. |
| enableVmProtection | boolean | Indicates if VM protection is enabled for all the subnets in the virtual network. |
| provisioningState | string | The current provisioning state. |
| resourceGuid | string | The resourceGuid property of the Virtual Network resource. |
| subnets | array | A list of subnets in a Virtual Network. |
| virtualNetworkPeerings | array | A list of peerings in a Virtual Network. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/azure-networking-services/refs/heads/main/json-schema/azure-networking-services-virtual-network-properties-format-schema.json",
"title": "VirtualNetworkPropertiesFormat",
"description": "Properties of the virtual network.",
"properties": {
"addressSpace": {
"$ref": "#/definitions/AddressSpace",
"description": "The AddressSpace that contains an array of IP address ranges that can be used by subnets."
},
"bgpCommunities": {
"$ref": "#/definitions/VirtualNetworkBgpCommunities",
"description": "Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET."
},
"ddosProtectionPlan": {
"description": "Reference to another subresource.",
"properties": {
"id": {
"description": "Resource ID.",
"type": "string"
}
},
"x-ms-azure-resource": true
},
"dhcpOptions": {
"$ref": "#/definitions/DhcpOptions",
"description": "The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network."
},
"enableDdosProtection": {
"default": false,
"description": "Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.",
"type": "boolean"
},
"enableVmProtection": {
"default": false,
"description": "Indicates if VM protection is enabled for all the subnets in the virtual network.",
"type": "boolean"
},
"provisioningState": {
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"readOnly": true,
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
}
},
"resourceGuid": {
"description": "The resourceGuid property of the Virtual Network resource.",
"type": "string"
},
"subnets": {
"description": "A list of subnets in a Virtual Network.",
"items": {
"$ref": "#/definitions/Subnet"
},
"type": "array"
},
"virtualNetworkPeerings": {
"description": "A list of peerings in a Virtual Network.",
"items": {
"$ref": "#/definitions/VirtualNetworkPeering"
},
"type": "array"
}
},
"type": "object"
}