Share via


IotHubDescriptionResource.GetIotHubPrivateEndpointGroupInformationAsync Method

Definition

Get the specified private link resource for the given IotHub

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources/{groupId}
  • Operation Id: PrivateLinkResources_Get
  • Default Api Version: 2023-06-30
  • Resource: IotHubPrivateEndpointGroupInformationResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.IotHubPrivateEndpointGroupInformationResource>> GetIotHubPrivateEndpointGroupInformationAsync (string groupId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIotHubPrivateEndpointGroupInformationAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.IotHubPrivateEndpointGroupInformationResource>>
override this.GetIotHubPrivateEndpointGroupInformationAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.IotHubPrivateEndpointGroupInformationResource>>
Public Overridable Function GetIotHubPrivateEndpointGroupInformationAsync (groupId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IotHubPrivateEndpointGroupInformationResource))

Parameters

groupId
String

The name of the private link resource.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

groupId is null.

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

Applies to