DeviceUpdateClient.DeleteUpdateAsync Method

Reference

Definition

Namespace:: Azure.IoT.DeviceUpdate

Assembly:: Azure.IoT.DeviceUpdate.dll

Package:: Azure.IoT.DeviceUpdate v1.0.0

Source:: DeviceUpdateClient.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.

Delete a specific update version. This is a long-running-operation; use Operation-Location response header value to check for operation status.

public virtual System.Threading.Tasks.Task<Azure.Operation> DeleteUpdateAsync (Azure.WaitUntil waitUntil, string provider, string name, string version, Azure.RequestContext context = default);

abstract member DeleteUpdateAsync : Azure.WaitUntil * string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
override this.DeleteUpdateAsync : Azure.WaitUntil * string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>

Public Overridable Function DeleteUpdateAsync (waitUntil As WaitUntil, provider As String, name As String, version As String, Optional context As RequestContext = Nothing) As Task(Of Operation)

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.

provider: String

Update provider.

name: String

Update name.

version: String

Update version.

context: RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Operation>

The Operation representing an asynchronous operation on the service.

Exceptions

ArgumentNullException

provider, name or version is null.

ArgumentException

provider, name or version is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call DeleteUpdateAsync with required parameters.

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new DeviceUpdateClient(endpoint, "<instanceId>", credential);

var operation = await client.DeleteUpdateAsync(WaitUntil.Completed, "<provider>", "<name>", "<version>");

var response = await operation.WaitForCompletionResponseAsync();
Console.WriteLine(response.Status)

Applies to

Share via