NetworkExtensions.GetPrivateEndpointAsync Method

Definition

Namespace:

Azure.ResourceManager.Network

Assembly:

Azure.ResourceManager.Network.dll

Package:

Azure.ResourceManager.Network v1.9.0

Source:

NetworkExtensions.cs

Gets the specified private endpoint by resource group.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}
• Operation Id: PrivateEndpoints_Get
• Default Api Version: 2024-03-01
• Resource: PrivateEndpointResource

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

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

<Extension()>
Public Function GetPrivateEndpointAsync (resourceGroupResource As ResourceGroupResource, privateEndpointName As String, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PrivateEndpointResource))

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

privateEndpointName

String

The name of the private endpoint.

expand

String

Expands referenced resources.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<PrivateEndpointResource>>

Exceptions

ArgumentNullException

resourceGroupResource or privateEndpointName is null.

ArgumentException

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