Skip to main content

NetworkPublicIpResponse

The public IP associated with a network.

idstring<uuid>

Id of the public IP.

ip IPAddress (string)

The IP address itself, in dotted-decimal form.

addressFamilyAddressFamily (string)

Address family of the address (IPv4 or IPv6).

Possible values: [Unknown, Unspecified, Unix, InterNetwork, ImpLink, Pup, Chaos, NS, Ipx, Iso, Osi, Ecma, DataKit, Ccitt, Sna, DecNet, DataLink, Lat, HyperChannel, AppleTalk, NetBios, VoiceView, FireFox, Banyan, Atm, InterNetworkV6, Cluster, Ieee12844, Irda, NetworkDesigners, Max, Packet, ControllerAreaNetwork]

scopeIdinteger<int64>

IPv6 scope identifier of the address.

isIPv6Multicastboolean

Whether the address is an IPv6 multicast address.

isIPv6LinkLocalboolean

Whether the address is an IPv6 link-local address.

isIPv6SiteLocalboolean

Whether the address is an IPv6 site-local address.

isIPv6Teredoboolean

Whether the address is an IPv6 Teredo address.

isIPv6UniqueLocalboolean

Whether the address is an IPv6 unique-local address.

isIPv4MappedToIPv6boolean

Whether the address is an IPv4 address mapped into the IPv6 space.

addressinteger<int64>deprecated

IP address value.

geolocationstringnullable

The geographic location associated with the public IP.

portForwardRules object[]nullable

Port forwarding rules configured on the public IP.

  • Array [
    • 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

    Parameters of the rule: protocol, mode and ports.

    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.

  • ]
    • NetworkPublicIpResponse
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "ip": "192.168.0.1",
      "geolocation": "string",
      "portForwardRules": [
        {
          "vmId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "vmName": "string",
          "status": "Created",
          "rule": {
            "mode": "SpecificPorts",
            "protocol": "Tcp",
            "externalPort": 0,
            "internalPort": 0
          }
        }
      ]
    }