3.1.5.14.1.2.3 Processing Details

Retrieves a publicIPAddresses resource.

The server returns a configuration state only if it has already attempted to configure settings according to the REST resource properties that were created or updated by using the PUT method. configurationState.lastUpdatedTime is set to a value that is implementation-specific.

The server returns a configuration state property configurationState.status set to Success if there were no errors. The server returns a configuration state property configurationState.status set to Failure if there were errors during the configuration of settings. configurationState.detailedInfo contains an array of objects per the specification in section 2.2.4. The property configurationState.vipEndpointStates contains both virtual IP (VIP) and dynamic IP (DIP) endpoint states with configurationState content as defined in section 2.2.4.

The following is an example of configurationState failures. The next example shows counters.

 {
     "resourceRef": "/publicIPAddresses/2c8f4adc-c0df-42d6-8045-efe0cd40f253",
     "resourceId": "2c8f4adc-c0df-42d6-8045-efe0cd40f253",
     "etag": "W/\"0ac8a579-8d85-4569-a8db-464037b4cd71\"",
     "instanceId": "e21e01a7-c8c8-4a32-b5ce-ad3c70055dce",
     "properties": {
       "provisioningState": "Succeeded",
       "counters": [],
         "configurationState": {
           "status": "Failure",
           "lastUpdatedTime": "2018-08-14T14:38:55.2804744-07:00",
           "id": "e21e01a7-c8c8-4a32-b5ce-ad3c70055dce",
           "vipEndpointStates": [
             {
               "status": "Failure",
               "lastUpdatedTime": "2018-08-14T14:38:55.2804744-07:00",
               "vipEndpoint": "All:22.0.0.6:0",
               "dipEndpointStates": [
                 {
                   "status": "Failure",
                   "detailedInfo": [
                     {
                       "source": "SoftwareLoadBalancerManager",
                       "message": "Failed to configure the policies on mux pool.",
                       "code": "PolicyConfigurationFailureOnMux"
                     }
                   ],
                   "lastUpdatedTime": "2018-08-14T14:38:55.2804744-07:00",
                   "dipEndpoint": "13.168.100.22:0",
                   "hostIPAddress": "192.153.0.21",
                   "hostId": "6e059be9-f546-47de-9db9-f9af11915118",
                   "adapterId": "005762000001",
                   "probeRule": ""
                 }
               ]
             }
            ]
           },
           "ipAddress": "22.0.0.6",
           "publicIPAddressVersion": "IPv4",
           "publicIPAllocationMethod": "Dynamic",
           "idleTimeoutInMinutes": 4,
           "ipConfiguration": {
           "resourceRef": "/networkInterfaces/3c35c29c-543e-4b37-8397-a8ea5ad6b7f5/ipConfigurations/eba25962-268b-42e8-a8fd-82ceab53d06b"
          }
     }
 }

The following example shows publicIPAddresses counters.

 {
   "resourceRef": "/publicIPAddresses/3ab403d5-0c85-423a-ac74-637d47a2127f",
   "resourceId": "3ab403d5-0c85-423a-ac74-637d47a2127f",
   "etag": "W/\"c4ed744d-a809-4a8b-b0e1-64f447c98f14\"",
   "instanceId": "ac65782e-7cbb-49db-ac20-989cd1d563b2",
   "properties": {
     "provisioningState": "Succeeded",
     "counters": [
       {
         "name": "TotalPackets",
         "currentValue": 2700966,
         "unit": "Decimal",
         "context": {
           "source": "SoftwareLoadBalancer",
           "category": "Performance"
          }
        }
      ]
    }
 }