NetworkExtensions.GetPrivateEndpointAsync Method

Definition

Gets the specified private endpoint by resource group. <item> Mocking. To mock this method, please mock GetPrivateEndpointAsync(String, String, CancellationToken) instead. </item>

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 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

Exceptions

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

resourceGroupResource is null.

Applies to