Skip to main content

CreatePortForwardsRequest

Request to create a port forwarding rule on a public IP.

vmIdstring<uuid>

Id of the VM to forward traffic to. Required.

modePortForwardMode (string)

Mode that defines how the resource should behave.

Possible values: [SpecificPorts, AllPorts]

protocolPortForwardProtocol (string)

Protocol used by the resource or forwarding rule.

Possible values: [Tcp, Udp, TcpUdp]

externalPortinteger<int32>nullable

The externally exposed port. Required and in the range 1-65535 when Mode is SpecificPorts; must be omitted when Mode is AllPorts.

internalPortinteger<int32>nullable

The internal (VM-side) port traffic is forwarded to. Required and in the range 1-65535 when Mode is SpecificPorts; must be omitted when Mode is AllPorts.

CreatePortForwardsRequest
{
  "vmId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "mode": "SpecificPorts",
  "protocol": "Tcp",
  "externalPort": 0,
  "internalPort": 0
}