NetworkExtensions.GetPublicIPPrefixAsync Method

Definition

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}
  • Operation Id: PublicIPPrefixes_Get
  • Default Api Version: 2023-09-01
  • Resource: PublicIPPrefixResource
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 instance 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

Exceptions

resourceGroupResource or publicIPPrefixName is null.

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

Applies to