Skip to main content

PortForwardsResponse

A port forwarding rule and its current state.

idstring<uuid>

Id of the rule.

vmIdstring<uuid>

Id of the VM the rule targets.

vmNamestringnullable

Name of the target VM, when known.

statusPortForwardStatus (string)

Current status of the resource.

Possible values: [Created, Creating, Updating, Deleting]

rule object

Allowed value for rule.

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, when applicable for the selected mode.

internalPortinteger<int32>nullable

The internal (VM-side) port the traffic is forwarded to, when applicable for the selected mode.

PortForwardsResponse
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vmId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vmName": "string",
"status": "Created",
"rule": {
"mode": "SpecificPorts",
"protocol": "Tcp",
"externalPort": 0,
"internalPort": 0
}
}