Skip to main content

NetworkPublicIpResponse

The public IP associated with a network.

idstring<uuid>

Id of the public IP.

ip IPAddress (string)

Allowed value for ip.

addressFamilyAddressFamily (string)

Allowed value for address family.

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>

Unique identifier of the scope.

isIPv6Multicastboolean

Boolean flag that controls is ipv6 multicast.

isIPv6LinkLocalboolean

Boolean flag that controls is ipv6 link local.

isIPv6SiteLocalboolean

Boolean flag that controls is ipv6 site local.

isIPv6Teredoboolean

Boolean flag that controls is ipv6 teredo.

isIPv6UniqueLocalboolean

Boolean flag that controls is ipv6 unique local.

isIPv4MappedToIPv6boolean

Boolean flag that controls is ipv4 mapped to ipv6.

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

    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.

  • ]
    • 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
          }
        }
      ]
    }