NetworkExtensions.GetCustomIPPrefixAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.Network

Assembly:: Azure.ResourceManager.Network.dll

Package:: Azure.ResourceManager.Network v1.7.0

Package:: Azure.ResourceManager.Network v1.6.0-beta.1

Source:: NetworkExtensions.cs

Source:: NetworkExtensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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: 2023-09-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

Task<Response<CustomIPPrefixResource>>

Exceptions

ArgumentNullException

resourceGroupResource or customIPPrefixName is null.

ArgumentException

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

Applies to