List all NICs in a set

Retrieves information about the instance view of all network interfaces in the specified virtual machine scale set.

Request

For information about getting started with Azure REST operations including request authentication, see Azure REST API Reference.

Method Request URI
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/VirtualMachineScaleSets/{vmScaleSet}/networkInterfaces?api-version={apiVersion}
Parameter Description
subscriptionId The identifier of your subscription.
resourceGroup The resource group that contains the scale set.
vmScaleSet The name of the scale set.
apiVersion The version of the API to use. The current version is 2016-04-30-preview.

Response

Status code: 200 (OK).


{    
  "value": [  {    
    "name": "nicconfig1",    
    "id": "/subscriptions/{sub-id}/resourceGroups/myrg1/providers/Microsoft.Compute/virtualMachineScaleSets/myscaleset1/virtualMachines/vm1/networkInterfaces/nicconfig1",    
    "etag": "W/\"00000000-0000-0000-0000-000000000000\"",    
    "type": Microsoft.Network/networkInterfaces",    
    "tags": {     
      "key": "value"     
    },    
    "properties": {     
      "provisioningState": "Succeeded",    
      "resourceGuid": "XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXX",    
      "ipConfigurations": [  {    
        "name":  "ipconfig1",    
        "id": "/subscriptions/{sub-id}/resourceGroups/myrg1/providers/Microsoft.Compute/virtualMachineScaleSets/myscaleset1/virtualMachines/vm1/networkInterfaces/nicconfig1/ipConfigurations/ipconfig1",    
        "etag": "W/\"00000000-0000-0000-0000-000000000000\"",    
        "properties":  {     
          "provisioningState": "Succeeded",    
          "privateIPAddress": "10.0.0.8",    
          "privateIPAllocationMethod": "Dynamic", 
          "publicIPAddress": {
                "id": "/subscriptions/{sub-id}/resourceGroups/myrg1/providers/Microsoft.Compute/virtualMachineScaleSets/myscaleset1/virtualMachines/0/networkInterfaces/mynic1/ipConfigurations/myipconfig1/publicIPAddresses/publicip1"
              }   
          "subnet":  {    
            "id": "/subscriptions/{sub-id}/resourceGroups/myrg1/providers/Microsoft.Network/virtualNetworks/myvnet1/subnets/mysub1"    
          }, 
          "primary": true,
          "privateIPAddressVersion": "IPv4",   
          "loadBalancerBackendAddressPools":  [  {    
            "id": "/subscriptions/{sub-id}/resourceGroups/myrg1/providers/Microsoft.Network/loadBalancers/mylb1/backendAddressPools/pool1"    
          } ],    
          "loadBalancerInboundNatRules":  [  {    
            "id": "/subscriptions/{sub-id}/resourceGroups/myrg1/providers/Microsoft.Network/loadBalancers/mylb1/inboundNatRules/rdp-for-myvm1"    
          },    
          {    
            "id": "/subscriptions/{sub-id}/resourceGroups/myrg1/providers/Microsoft.Network/loadBalancers/mylb1/inboundNatRules/powershell-for-myvm1"    
          } ], 
          "dnsSettings": {
          "dnsServers": [10.0.0.5, 10.0.0.6],
          "appliedDnsServers": [10.0.0.5, 10.0.0.6]
        },
        "enableAcceleratedNetworking": false,
        "enableIPForwarding": false,   
          "applicationGatewayBackendAddressPools":  [  {     
            "id": "/subscriptions/{sub-id}/resourceGroups/myrg1/providers/Microsoft.Network/applicationGateways /appgateway1/backendAddressPools/pool1"     
          }  ]    
        }     
      }  ],    
      "macAddress": "00-0D-3A-A0-AE-61",    
      "enableIPForwarding": false,
      "networkSecurityGroup": {
          "id": "/subscriptions/{sub-id}/resourceGroups/myrg1/providers/Microsoft.Network/networkSecurityGroups/nsg1"
        },  
      "primary": true,    
      "virtualMachine": {    
        "id": "/subscriptions/(sub-id}/resourceGroups/myrg1/providers/Microsoft.Compute/virtualMachines/myvmss1_0"    
      }       
    }    
  }  ]    
}    
Element name Description
name Specifies the name of the network interface configuration.
id Specifies the identifier of the network interface configuration.
location Specifies the location of the network interface configuration.
tags Specifies the tags that are assigned to the network interface configuration.
provisioningState Specifies the provisioning state of the network interface configuration.

Possible values are:

Deleting

Failed

Succeeded

Updating
resourceGuid Specifies a unique identifier of the network interface instance.
dnsSettings Specifies the DNS settings applied on the NIC
ipConfigurations Specifies the IP configurations for the network interface configuration.
virtualMachine Specifies the identifier of the virtual machine that is associated with the network interface configuration.
macAddress Specifies the media access control (MAC) address of the network interface configuration.
networkSecurityGroup Specifies the associated security policy on the network interface.

ipConfigurations

Element name Description
name Specifies name of the IP configuration.
id Specifies the identifier of the IP configuration.
provisioningState Specifies the provisioning state of the IP configuration.

Possible values are:

Deleting

Failed

Succeeded

Updating
privateIPAddress Specifies a specific private IP address. If a subnet was specified, the IP must be from the subnet. If a virtual network was specified, the IP must be from the virtual network. This value is ignored unless privateIPAllocationMethod element is set to “Static”
privateIPAllocationMethod Specifies the private IP allocation method.

Possible values are:

Dynamic

Static
subnet Specifies the identifier of the subnet. All subnets referenced by a NIC have to belong to the same virtual network. The subnet a NIC belongs to can be changed when updating the NIC.
publicIPAddress Specifies the identifier of the public IP address.
loadBalancerBackendAddressPools Specifies an array of references to backend address pools of load balancers. A network interface can reference backend address pools of one public and one internal load balancer.
loadBalancerInboundNatRules Specifies an array of references to inbound Nat rules of the load balancers. A network interface can reference inbound nat rules of one public and one internal load balancer.
applicationGatwayBackendAddressPools Specifies an array of references to backend address pools of application gateways. A network interface can reference backend address pools of multiple application gateways.