Virtual Networks - Check IP Address Availability

Service:

Virtual Networks

API Version:

2025-09-01

Checks whether a private IP address is available for use.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/checkIPAddressAvailability?api-version=2025-09-01&ipAddress={ipAddress}

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualNetworkName	path	True	string	The name of the virtual network.
api-version	query	True	string minLength: 1	The API version to use for this operation.
ipAddress	query	True	string	The private IP address to be verified.

Responses

Name	Type	Description
200 OK	IPAddressAvailabilityResult	Azure operation completed successfully.
Other Status Codes	CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Check IP address availability

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/checkIPAddressAvailability?api-version=2025-09-01&ipAddress=10.0.1.4

Java

/**
 * Samples for VirtualNetworks CheckIpAddressAvailability.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-09-01/VirtualNetworkCheckIPAddressAvailability.json
     */
    /**
     * Sample code: Check IP address availability.
     * 
     * @param manager Entry point to NetworkManager.
     */
    public static void checkIPAddressAvailability(com.azure.resourcemanager.network.NetworkManager manager) {
        manager.serviceClient().getVirtualNetworks().checkIpAddressAvailabilityWithResponse("rg1", "test-vnet",
            "10.0.1.4", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python virtual_network_check_ip_address_availability.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.virtual_networks.check_ip_address_availability(
        resource_group_name="rg1",
        virtual_network_name="test-vnet",
        ip_address="10.0.1.4",
    )
    print(response)


# x-ms-original-file: 2025-09-01/VirtualNetworkCheckIPAddressAvailability.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v11"
)

// Generated from example definition: 2025-09-01/VirtualNetworkCheckIPAddressAvailability.json
func ExampleVirtualNetworksClient_CheckIPAddressAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualNetworksClient().CheckIPAddressAvailability(ctx, "rg1", "test-vnet", "10.0.1.4", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armnetwork.VirtualNetworksClientCheckIPAddressAvailabilityResponse{
	// 	IPAddressAvailabilityResult: armnetwork.IPAddressAvailabilityResult{
	// 		Available: to.Ptr(false),
	// 		AvailableIPAddresses: []*string{
	// 			to.Ptr("10.0.1.5"),
	// 			to.Ptr("10.0.1.6"),
	// 			to.Ptr("10.0.1.7"),
	// 			to.Ptr("10.0.1.8"),
	// 			to.Ptr("10.0.1.9"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to checks whether a private IP address is available for use.
 *
 * @summary checks whether a private IP address is available for use.
 * x-ms-original-file: 2025-09-01/VirtualNetworkCheckIPAddressAvailability.json
 */
async function checkIPAddressAvailability() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworks.checkIPAddressAvailability(
    "rg1",
    "test-vnet",
    "10.0.1.4",
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "available": false,
  "availableIPAddresses": [
    "10.0.1.5",
    "10.0.1.6",
    "10.0.1.7",
    "10.0.1.8",
    "10.0.1.9"
  ]
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
IPAddressAvailabilityResult	Response for CheckIPAddressAvailability API service call.

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

Object

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

IPAddressAvailabilityResult

Object

Response for CheckIPAddressAvailability API service call.

Name	Type	Description
available	boolean	Private IP address availability.
availableIPAddresses	string[]	Contains other available private IP addresses if the asked for address is taken.
isPlatformReserved	boolean	Private IP address platform reserved.