DeviceManagementClient.DeleteDeploymentAsync メソッド

  • リファレンス

定義

名前空間:
Azure.IoT.DeviceUpdate
アセンブリ:
Azure.IoT.DeviceUpdate.dll
パッケージ:
Azure.IoT.DeviceUpdate v1.0.0
ソース:
DeviceManagementClient.cs

デプロイを削除します。

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteDeploymentAsync (string groupId, string deploymentId, Azure.RequestContext context = default);
abstract member DeleteDeploymentAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteDeploymentAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function DeleteDeploymentAsync (groupId As String, deploymentId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

パラメーター

groupId
String

グループ識別子。

deploymentId
String

デプロイ識別子。

context
RequestContext

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

戻り値

Task<Response>

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

例外

ArgumentNullException

groupId または deploymentId が null です。

ArgumentException

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

RequestFailedException

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

例

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

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

Response response = await client.DeleteDeploymentAsync("<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)
              }
            }

適用対象