Share via


VirtualNetworkResource.CheckIPAddressAvailabilityAsync Method

Definition

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: 2024-03-01
  • Resource: VirtualNetworkResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.Models.IPAddressAvailabilityResult>> CheckIPAddressAvailabilityAsync (string ipAddress, System.Threading.CancellationToken cancellationToken = default);
abstract member CheckIPAddressAvailabilityAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.Models.IPAddressAvailabilityResult>>
override this.CheckIPAddressAvailabilityAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.Models.IPAddressAvailabilityResult>>
Public Overridable Function CheckIPAddressAvailabilityAsync (ipAddress As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IPAddressAvailabilityResult))

Parameters

ipAddress
String

The private IP address to be verified.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

ipAddress is null.

Applies to