IotHubDescriptionResource.GetIotHubPrivateEndpointConnectionAsync Method

Definition

Namespace:

Azure.ResourceManager.IotHub

Assembly:

Azure.ResourceManager.IotHub.dll

Package:

Azure.ResourceManager.IotHub v1.1.1

Source:

IotHubDescriptionResource.cs

Get private endpoint connection properties

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
• Operation Id: PrivateEndpointConnections_Get
• Default Api Version: 2023-06-30
• Resource: IotHubPrivateEndpointConnectionResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.IotHubPrivateEndpointConnectionResource>> GetIotHubPrivateEndpointConnectionAsync (string privateEndpointConnectionName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIotHubPrivateEndpointConnectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.IotHubPrivateEndpointConnectionResource>>
override this.GetIotHubPrivateEndpointConnectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.IotHubPrivateEndpointConnectionResource>>

Public Overridable Function GetIotHubPrivateEndpointConnectionAsync (privateEndpointConnectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IotHubPrivateEndpointConnectionResource))

Parameters

privateEndpointConnectionName

String

The name of the private endpoint connection.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<IotHubPrivateEndpointConnectionResource>>

Exceptions

ArgumentNullException

privateEndpointConnectionName is null.

ArgumentException

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