Share via


MockableIotHubResourceGroupResource.GetIotHubDescription Method

Definition

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 Azure.Response<Azure.ResourceManager.IotHub.IotHubDescriptionResource> GetIotHubDescription (string resourceName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIotHubDescription : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.IotHub.IotHubDescriptionResource>
override this.GetIotHubDescription : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.IotHub.IotHubDescriptionResource>
Public Overridable Function GetIotHubDescription (resourceName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IotHubDescriptionResource)

Parameters

resourceName
String

The name of the IoT hub.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceName is null.

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

Applies to