NetworkExtensions.GetPublicIPAddressAsync Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.16.1

Source:

NetworkExtensions.cs

Gets the specified public IP address in a specified resource group. <item> Mocking. To mock this method, please mock GetPublicIPAddressAsync(String, String, CancellationToken) instead. </item>

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.PublicIPAddressResource>> GetPublicIPAddressAsync(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string publicIpAddressName, string expand = default, System.Threading.CancellationToken cancellationToken = default);

static member GetPublicIPAddressAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.PublicIPAddressResource>>

<Extension()>
Public Function GetPublicIPAddressAsync (resourceGroupResource As ResourceGroupResource, publicIpAddressName As String, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PublicIPAddressResource))

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource the method will execute against.

publicIpAddressName

String

The name of the public IP address.

expand

String

Expands referenced resources.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<PublicIPAddressResource>>

Exceptions

ArgumentException

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

ArgumentNullException

resourceGroupResource is null.