NetworkExtensions.GetCustomIPPrefixAsync Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.16.1

Source:

NetworkExtensions.cs

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

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

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

<Extension()>
Public Function GetCustomIPPrefixAsync (resourceGroupResource As ResourceGroupResource, customIpPrefixName As String, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CustomIPPrefixResource))

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource the method will execute against.

customIpPrefixName

String

The name of the custom IP prefix.

expand

String

Expands referenced resources.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<CustomIPPrefixResource>>

Exceptions

ArgumentException

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

ArgumentNullException

resourceGroupResource is null.