Azure Networking · Schema
VirtualNetworkPeering
Peerings in a virtual network resource.
AzureCloudInfrastructureMicrosoftNetworking
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Resource ID. |
| name | string | The name of the resource. |
| properties | object | Properties of the virtual network peering. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/VirtualNetworkPeering",
"title": "VirtualNetworkPeering",
"type": "object",
"description": "Peerings in a virtual network resource.",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "Resource ID."
},
"name": {
"type": "string",
"description": "The name of the resource."
},
"properties": {
"type": "object",
"description": "Properties of the virtual network peering.",
"properties": {
"allowVirtualNetworkAccess": {
"type": "boolean",
"description": "Whether the VMs in the local virtual network can access the VMs in the remote virtual network."
},
"allowForwardedTraffic": {
"type": "boolean",
"description": "Whether the forwarded traffic from the VMs in the local virtual network will be allowed or disallowed in the remote virtual network."
},
"allowGatewayTransit": {
"type": "boolean",
"description": "If gateway links can be used in remote virtual networking to link to this virtual network."
},
"useRemoteGateways": {
"type": "boolean",
"description": "If remote gateways can be used on this virtual network."
},
"remoteVirtualNetwork": {
"type": "object",
"description": "The reference to the remote virtual network.",
"properties": {
"id": {
"type": "string",
"description": "Resource ID."
}
}
},
"peeringState": {
"type": "string",
"readOnly": true,
"description": "The status of the virtual network peering.",
"enum": [
"Initiated",
"Connected",
"Disconnected"
]
},
"provisioningState": {
"type": "string",
"readOnly": true,
"description": "The provisioning state of the virtual network peering resource."
}
}
}
}
}