VirtualNetworkResource.CheckIPAddressAvailability Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.16.0

Source:

VirtualNetworkResource.cs

Checks whether a private IP address is available for use.

• Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/checkIPAddressAvailability.
• Operation Id. : VirtualNetworks_CheckIPAddressAvailability.
• Default Api Version. : 2025-07-01.
• Resource. : VirtualNetworkResource.

public virtual Azure.Response<Azure.ResourceManager.Network.Models.IPAddressAvailabilityResult> CheckIPAddressAvailability(string ipAddress, System.Threading.CancellationToken cancellationToken = default);

abstract member CheckIPAddressAvailability : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Network.Models.IPAddressAvailabilityResult>
override this.CheckIPAddressAvailability : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Network.Models.IPAddressAvailabilityResult>

Public Overridable Function CheckIPAddressAvailability (ipAddress As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IPAddressAvailabilityResult)

Parameters

ipAddress

String

The private IP address to be verified.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<IPAddressAvailabilityResult>

Exceptions

ArgumentNullException

ipAddress is null.

ArgumentException

ipAddress is an empty string, and was expected to be non-empty.