IotHubPrivateEndpointGroupInformationCollection.GetIfExistsAsync Method

Definition

Namespace:

Azure.ResourceManager.IotHub

Assembly:

Azure.ResourceManager.IotHub.dll

Package:

Azure.ResourceManager.IotHub v1.1.1

Source:

IotHubPrivateEndpointGroupInformationCollection.cs

Tries to get details for this resource from the service.

• 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.NullableResponse<Azure.ResourceManager.IotHub.IotHubPrivateEndpointGroupInformationResource>> GetIfExistsAsync (string groupId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.IotHub.IotHubPrivateEndpointGroupInformationResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.IotHub.IotHubPrivateEndpointGroupInformationResource>>

Public Overridable Function GetIfExistsAsync (groupId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of IotHubPrivateEndpointGroupInformationResource))

Parameters

groupId

String

The name of the private link resource.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<IotHubPrivateEndpointGroupInformationResource>>

Exceptions

ArgumentException

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

ArgumentNullException

groupId is null.