MockableIotHubResourceGroupResource.GetIotHubDescriptionAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.IotHub.Mocking

Assembly:: Azure.ResourceManager.IotHub.dll

Package:: Azure.ResourceManager.IotHub v1.1.1

Package:: Azure.ResourceManager.IotHub v1.2.0-beta.1

Source:: MockableIotHubResourceGroupResource.cs

Source:: MockableIotHubResourceGroupResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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 virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.IotHubDescriptionResource>> GetIotHubDescriptionAsync (string resourceName, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetIotHubDescriptionAsync (resourceName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IotHubDescriptionResource))

Parameters

resourceName: String

The name of the IoT hub.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<IotHubDescriptionResource>>

Exceptions

ArgumentNullException

resourceName is null.

ArgumentException

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

Applies to

Share via