Share via


NetworkExtensions.GetCustomIPPrefixAsync Method

Definition

Gets the specified custom IP prefix in a specified resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes/{customIpPrefixName}
  • Operation Id: CustomIPPrefixes_Get
  • Default Api Version: 2024-03-01
  • Resource: CustomIPPrefixResource
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 instance 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

Exceptions

resourceGroupResource or customIPPrefixName is null.

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

Applies to