DeviceManagementClient.DeleteDeployment メソッド

定義

名前空間:

Azure.IoT.DeviceUpdate

アセンブリ:

Azure.IoT.DeviceUpdate.dll

パッケージ:

Azure.IoT.DeviceUpdate v1.0.0

ソース:

DeviceManagementClient.cs

デプロイを削除します。

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

パラメーター

groupId

String

グループ識別子。

deploymentId

String

デプロイ識別子。

context

RequestContext

要求コンテキスト。これは、クライアント パイプラインの既定の動作を呼び出しごとにオーバーライドできます。

戻り値

Response

サービスから返された応答。

例外

ArgumentNullException

groupId または deploymentId が null です。

ArgumentException

groupId または deploymentId が空の文字列であり、空でないと想定されていました。

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、必要なパラメーターを使用して DeleteDeployment を呼び出す方法を示します。

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);

注釈

の 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)
              }
            }