CustomIPPrefixCollection.GetAsync(String, String, CancellationToken) 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. : 2025-07-01.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.CustomIPPrefixResource>> GetAsync(string customIpPrefixName, string expand = default, System.Threading.CancellationToken cancellationToken = default);
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.CustomIPPrefixResource>> GetAsync(string customIPPrefixName, string expand = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.CustomIPPrefixResource>>
override this.GetAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.CustomIPPrefixResource>>
abstract member GetAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.CustomIPPrefixResource>>
override this.GetAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Network.CustomIPPrefixResource>>
Public Overridable Function GetAsync (customIpPrefixName As String, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CustomIPPrefixResource))
Public Overridable Function GetAsync (customIPPrefixName As String, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CustomIPPrefixResource))

Parameters

customIpPrefixNamecustomIPPrefixName
String

The name of the custom IP prefix.

expand
String

Expands referenced resources.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

customIpPrefixName is null.

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

Applies to