Share via


IotHubDescriptionResource.UpdateAsync Method

Definition

Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}
  • Operation Id: IotHubResource_Update
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.IotHub.IotHubDescriptionResource>> UpdateAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.IotHub.Models.IotHubDescriptionPatch patch, System.Threading.CancellationToken cancellationToken = default);
abstract member UpdateAsync : Azure.WaitUntil * Azure.ResourceManager.IotHub.Models.IotHubDescriptionPatch * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.IotHub.IotHubDescriptionResource>>
override this.UpdateAsync : Azure.WaitUntil * Azure.ResourceManager.IotHub.Models.IotHubDescriptionPatch * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.IotHub.IotHubDescriptionResource>>
Public Overridable Function UpdateAsync (waitUntil As WaitUntil, patch As IotHubDescriptionPatch, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of IotHubDescriptionResource))

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

patch
IotHubDescriptionPatch

Updated tag information to set into the iot hub instance.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

patch is null.

Applies to