Proposed Pull Request Change

📄 Document Links

View on GitHub View on Microsoft Learn

--- title: Retrieve load balancer and virtual machine IP metadata using Azure Instance Metadata Service (IMDS) titleSuffix: Azure Load Balancer description: Get started learning how to retrieve load balancer metadata using Azure Instance Metadata Service. services: load-balancer author: mbender-ms ms.service: azure-load-balancer ms.topic: how-to ms.date: 06/28/2024 ms.author: mbender ms.custom: template-how-to # Customer intent: As a cloud operator, I want to retrieve load balancer metadata using the Instance Metadata Service, so that I can analyze network traffic and manage IP configurations for virtual machines effectively. --- # Retrieve load balancer metadata using Azure Instance Metadata Service (IMDS) ## Prerequisites * Use the [latest API version](/azure/virtual-machines/windows/instance-metadata-service?tabs=windows#supported-api-versions) for your request. ## Sample request and response > [!IMPORTANT] > This example bypasses proxies. You **must** bypass proxies when querying IMDS. For more information, see [Proxies](/azure/virtual-machines/windows/instance-metadata-service?tabs=windows#proxies). ## Schema breakdown | **Data** | **Description** | **Version introduced** | |------|-------------|--------------------| | `publicIpAddresses` | The instance level Public or Private IP of the specific Virtual Machine instance | 2020-10-01 | `inboundRules` | List of load balancing rules or inbound NAT rules using which the Load Balancer directs traffic to the specific Virtual Machine instance. Frontend IP addresses and the Private IP addresses listed here belong to the Load Balancer. | 2020-10-01 | `outboundRules` | List of outbound rules by which the Virtual Machine behind Load Balancer sends outbound traffic. Frontend IP addresses and the Private IP addresses listed here belong to the Load Balancer. | 2020-10-01 ### [Windows](#tab/windows/) ```powershell Invoke-RestMethod -Headers @{"Metadata"="true"} -Method GET -NoProxy -Uri "http://169.254.169.254:80/metadata/loadbalancer?api-version=2020-10-01" | ConvertTo-Json ``` > [!NOTE] > The -NoProxy parameter was introduced in PowerShell 6.0. If you are using an older version of PowerShell, remove -NoProxy in the request body and make sure you are not using a proxy while retrieving IMDS info. Learn more [here](/azure/virtual-machines/windows/instance-metadata-service?tabs=windows#proxies). > ### [Linux](#tab/linux/) ```bash curl -H "Metadata:true" --noproxy "*" "http://169.254.169.254:80/metadata/loadbalancer?api-version=2020-10-01" ``` --- ### Sample response ```json { "loadbalancer": { "publicIpAddresses":[ { "frontendIpAddress":"51.0.0.1", "privateIpAddress":"10.1.0.4" } ], "inboundRules":[ { "frontendIpAddress":"50.0.0.1", "protocol":"tcp", "frontendPort":80, "backendPort":443, "privateIpAddress":"10.1.0.4" }, { "frontendIpAddress":"2603:10e1:100:2::1:1", "protocol":"tcp", "frontendPort":80, "backendPort":443, "privateIpAddress":"ace:cab:deca:deed::1" } ], "outboundRules":[ { "frontendIpAddress":"50.0.0.1", "privateIpAddress":"10.1.0.4" }, { "frontendIpAddress":"2603:10e1:100:2::1:1", "privateIpAddress":"ace:cab:deca:deed::1" } ] } } ``` ## Next steps [Common error codes and troubleshooting steps](troubleshoot-load-balancer-imds.md) Learn more about [Azure Instance Metadata Service](/azure/virtual-machines/windows/instance-metadata-service) [Retrieve all metadata for an instance](/azure/virtual-machines/windows/instance-metadata-service?tabs=windows#access-azure-instance-metadata-service) [Deploy a standard load balancer](quickstart-load-balancer-standard-public-portal.md)