VMNetworkGateway [SPFSDK][VMMREF]
Applies To: Windows Azure Pack
The VMNetworkGateway entity represents a virtual machine network gateway in Virtual Machine Manager (VMM).
Inheritance Hierarchy
VMM
VMNetworkGateway
Entity Properties
For more information about how the properties of an entity interact with HTTP operations, see Entity Basics.
When querying the VMNetworkGateways Collection [SPFSDK][VMMREF] using the HTTP GET operation, you must pass the StampId property along with either the ID or VMNetworkId property. See Read (GET) a VMNetworkGateway [SPFSDK][VMMREF] for more information.
Name |
Create (POST) |
Read (GET) |
Update (PUT) |
Delete (DELETE) |
Type |
Nullable |
Description |
|---|---|---|---|---|---|---|---|
ID |
- |
Required |
Required |
Required |
Edm.Guid |
False |
Key Property The identifier of the entity. |
StampId |
Required |
Required |
Required |
Required |
Edm.Guid |
False |
Key Property The identifier of the stamp that contains the entity. |
AutonomousSystemNumber |
Optional |
Optional |
Optional |
- |
Edm.Int64 |
True |
Autonomous System Number (ASN) used for routing in Border Gateway Protocol (BGP). A valid number within 1-65534. |
Description |
Optional |
Optional |
Optional |
- |
Edm.String |
True |
The description of the entity. |
EnableBGP |
Optional |
Optional |
Optional* |
- |
Edm.Boolean |
True |
Whether Border Gateway Protocol (BGP) is enabled. Update (PUT): When updating this value to true, the AutonomousSystemNumber property must be set to a valid number within 1-65534. |
IPSubnets |
Optional |
Optional |
- |
- |
Collection(Edm.String) |
False |
The Subnets to which the IP addresses assigned to the gateway belong. |
Name |
Required |
Optional |
Optional |
- |
Edm.String |
True |
The name of the VM network gateway. |
RequiresNAT |
Optional |
Optional |
- |
- |
Edm.Boolean |
True |
Indicates that the connection requires network address translation (NAT). |
RequiresVPN |
Optional |
Optional |
- |
- |
Edm.Boolean |
True |
Whether a virtual private network (VPN) is required. |
VMNetworkId |
Required |
Required |
- |
- |
Edm.Guid |
True |
The identifier of a virtual machine network the gateway is created for. |
Relationships
For more information about how the relationships of an entity are used, see Entity Basics.
Name |
Relationship Type |
From Property |
To Entity |
To Property |
|---|---|---|---|---|
BGPPeers |
Many |
Not specified |
Not specified |
|
NATConnections |
Many |
Not specified |
Not specified |
|
VPNConnections |
Many |
Not specified |
Not specified |
OData Operations
None
Examples
See Also
Entities [SPFSDK][VMMREF]
VMNetworkGateways Collection [SPFSDK][VMMREF]
Create (POST) a VMNetworkGateway [SPFSDK][VMMREF]
Read (GET) a VMNetworkGateway [SPFSDK][VMMREF]
Update (PUT) a VMNetworkGateway [SPFSDK][VMMREF]
Delete (DELETE) a VMNetworkGateway [SPFSDK][VMMREF]
VMNetwork [SPFSDK][VMMREF]