IotHubExtensions.GetIotHubDescriptionAsync Method

Definition

Namespace:

Azure.ResourceManager.IotHub

Assembly:

Azure.ResourceManager.IotHub.dll

Package:

Azure.ResourceManager.IotHub v1.1.1

Source:

IotHubExtensions.cs

Get the non-security related metadata of an IoT hub.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}
• Operation Id: IotHubResource_Get
• Default Api Version: 2023-06-30
• Resource: IotHubDescriptionResource

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.IotHubDescriptionResource>> GetIotHubDescriptionAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string resourceName, System.Threading.CancellationToken cancellationToken = default);

static member GetIotHubDescriptionAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.IotHubDescriptionResource>>

<Extension()>
Public Function GetIotHubDescriptionAsync (resourceGroupResource As ResourceGroupResource, resourceName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IotHubDescriptionResource))

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

resourceName

String

The name of the IoT hub.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<IotHubDescriptionResource>>

Exceptions

ArgumentNullException

resourceGroupResource or resourceName is null.

ArgumentException

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