NATRule [SPFSDK][VMMREF]

 

Applies To: Windows Azure Pack

The NATRule entity represents a network address translation (NAT) rule.

Inheritance Hierarchy

VMM
  NATRule

Entity Properties

For more information about how the properties of an entity interact with HTTP operations, see Entity Basics.

When querying the NATRules Collection [SPFSDK][VMMREF] using the HTTP GET operation, you must pass the StampId property along with either the ID or NATConnectionId property. See Read (GET) a NATRule [SPFSDK][VMMREF] for more information.

Name	Create (POST)	Read (GET)	Update (PUT)	Delete (DELETE)	Type	Nullable	Description
ID	-	Required	-	Required	Edm.Guid	False	Key Property The identifier of the rule.
StampId	Required	Required	-	Required	Edm.Guid	False	Key Property The identifier of the stamp that contains the entity.
ExternalIPAddress	-	Optional	-	-	Edm.String	True	The external IP address.
ExternalPort	Required	Optional	-	-	Edm.Int32	True	The external port.
InternalIPAddress	Required	Optional	-	-	Edm.String	True	The internal IP address. This IP address must match a subnet provided by the backing network.
InternalPort	Required	Optional	-	-	Edm.Int32	True	The internal port.
Name	Required	Optional	-	-	Edm.String	True	The name of the rule.
NATConnectionId	Required	Optional	-	-	Edm.Guid	True	The identifier of the NAT connection to create the NAT rule on.
Protocol	Optional	Optional	-	-	Edm.String	True	The data transfer protocol that the rule applies to. The value is TCP or UDP.

Relationships

None

OData Operations

None

Examples

• Example: Create a new NAT connection rule

• Example: Delete an existing NAT connection rule

• Example: Read a NAT connection rule

• Example: Read all NAT rules of a specific NAT connection

See Also

Entities [SPFSDK][VMMREF]
NATRules Collection [SPFSDK][VMMREF]
NATConnection [SPFSDK][VMMREF]