IotHubExtensions.GetIotHubDescriptionAsync Method
Definition
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. <item> Mocking. To mock this method, please mock GetIotHubDescriptionAsync(String, CancellationToken) instead. </item>
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 the method will execute against.
- resourceName
- String
The name of the IoT hub.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
resourceName is an empty string, and was expected to be non-empty.
resourceGroupResource is null.
