DeviceManagementClient.DeleteDeployment Method

Reference

Definition

Namespace:: Azure.IoT.DeviceUpdate

Assembly:: Azure.IoT.DeviceUpdate.dll

Package:: Azure.IoT.DeviceUpdate v1.0.0

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

Deletes a deployment.

public virtual Azure.Response DeleteDeployment (string groupId, string deploymentId, Azure.RequestContext context = default);

abstract member DeleteDeployment : string * string * Azure.RequestContext -> Azure.Response
override this.DeleteDeployment : string * string * Azure.RequestContext -> Azure.Response

Public Overridable Function DeleteDeployment (groupId As String, deploymentId As String, Optional context As RequestContext = Nothing) As Response

Parameters

groupId: String

Group identifier.

deploymentId: String

Deployment identifier.

context: RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

groupId or deploymentId is null.

ArgumentException

groupId or deploymentId 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 DeleteDeployment with required parameters.

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

Response response = client.DeleteDeployment("<groupId>", "<deploymentId>");
Console.WriteLine(response.Status);

Remarks

Schema for Response Error:

{
              error: {
                code: string,
                message: string,
                target: string,
                details: [Error],
                innererror: {
                  code: string,
                  message: string,
                  errorDetail: string,
                  innerError: InnerError
                },
                occurredDateTime: string (ISO 8601 Format)
              }
            }

Applies to

Share via