NetworkExtensions.GetPublicIPPrefixAsync 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 prefix in a specified resource group. <item> Mocking. To mock this method, please mock GetPublicIPPrefixAsync(String, String, CancellationToken) instead. </item>

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

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

<Extension()>
Public Function GetPublicIPPrefixAsync (resourceGroupResource As ResourceGroupResource, publicIpPrefixName As String, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PublicIPPrefixResource))

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource the method will execute against.

publicIpPrefixName

String

The name of the public IP prefix.

expand

String

Expands referenced resources.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<PublicIPPrefixResource>>

Exceptions

ArgumentException

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

ArgumentNullException

resourceGroupResource is null.