Replication Jobs - Cancel

指定したジョブを取り消します。
Azure Site Recovery ジョブを取り消す操作。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/cancel?api-version=2021-08-01

URI パラメーター

Name In Required Type Description
jobName
path True
  • string

ジョブ識別子。

resourceGroupName
path True
  • string

Recovery Services コンテナーが存在するリソース グループの名前。

resourceName
path True
  • string

Recovery Services コンテナーの名前。

subscriptionId
path True
  • string

サブスクリプション ID。

api-version
query True
  • string

クライアント API のバージョン。

応答

Name Type Description
200 OK

OK

202 Accepted

承認済み

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装します。

Cancels the specified job.

Sample Request

POST https://management.azure.com/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/2653c648-fc72-4316-86f3-fdf8eaa0066b/cancel?api-version=2021-08-01

Sample Response

{
  "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationJobs/2653c648-fc72-4316-86f3-fdf8eaa0066b",
  "name": "2653c648-fc72-4316-86f3-fdf8eaa0066b",
  "properties": {
    "activityId": "bfbbf6dd-9cbb-4cbc-98a6-faecc8891579 ActivityId: 07cc35ca-b63f-4e42-83c9-81ae0191c322",
    "scenarioName": "PlannedFailover",
    "friendlyName": "Planned failover",
    "state": "Cancelling",
    "stateDescription": "Cancelling",
    "tasks": [],
    "errors": [],
    "startTime": "2017-05-03T06:16:06.3235186Z",
    "allowedActions": [],
    "targetObjectId": "f8491e4f-817a-40dd-a90c-af773978c75b",
    "targetObjectName": "vm1",
    "targetInstanceType": "ProtectionEntity",
    "customDetails": {
      "instanceType": "AsrJobDetails",
      "affectedObjectDetails": {
        "PrimaryVmId": "f8491e4f-817a-40dd-a90c-af773978c75b",
        "PrimaryVmName": "vm1",
        "RecoveryVmId": "",
        "RecoveryVmName": "vm1",
        "ProtectionProfileId": "af095a1e-1f1b-5365-87c9-99162ebcfaf0",
        "PrimaryCloudId": "cloud_6d224fc6-f326-5d35-96de-fbf51efb3179",
        "PrimaryCloudName": "cloud1",
        "RecoveryCloudId": "d38048d4-b460-4791-8ece-108395ee8478",
        "RecoveryCloudName": "Microsoft Azure",
        "PrimaryVmmId": "6d224fc6-f326-5d35-96de-fbf51efb3179",
        "PrimaryVmmName": "cloud1",
        "RecoveryVmmId": "21a9403c-6ec1-44f2-b744-b4e50b792387",
        "RecoveryVmmName": "Microsoft Azure",
        "PrimaryFabricProviderId": "HyperVSite",
        "RecoveryFabricProviderId": "Azure"
      }
    }
  }
}

定義

AsrJobDetails

このクラスは、特定のジョブの種類に基づいてジョブの詳細を表します。

ASRTask

ジョブのタスク。

AutomationRunbookTaskDetails

このクラスは、Automation Runbook のタスクの詳細を表します。

ConsistencyCheckTaskDetails

このクラスには、Vmm で一貫性のない保護されたエンティティの監視の詳細がすべて含まれています。

ExportJobDetails

このクラスは、エクスポート ジョブ ワークフローの詳細を表します。

FailoverJobDetails

このクラスは、フェールオーバー ジョブの詳細を表します。

FailoverReplicationProtectedItemDetails

レプリケーションで保護された項目のフェールオーバーの詳細。

InconsistentVmDetails

このクラスは、一貫性のない保護されたエンティティの整合性チェックの監視の詳細を格納します。

InlineWorkflowTaskDetails

このクラスは、インライン ワークフロー タスクの詳細を表します。

Job

ジョブの詳細。

JobErrorDetails

このクラスには、オブジェクトごとのエラーの詳細が含まれています。

JobProperties

ジョブ カスタム データの詳細。

ManualActionTaskDetails

このクラスは、手動アクション タスクの詳細を表します。

ProviderError

このクラスには、オブジェクトごとのエラーの詳細が含まれています。

ScriptActionTaskDetails

このクラスは、スクリプト アクション タスクの詳細を表します。

ServiceError

ASR エラー モデル。

SwitchProtectionJobDetails

このクラスは、スイッチ保護ジョブの詳細を表します。

TestFailoverJobDetails

このクラスは、テスト フェールオーバー ジョブの詳細を表します。

VmNicUpdatesTaskDetails

このクラスは、vm NicUpdates タスクの詳細を表します。

AsrJobDetails

このクラスは、特定のジョブの種類に基づいてジョブの詳細を表します。

Name Type Description
affectedObjectDetails
  • object

ワークフロー オブジェクトの詳細に基づいて、ソース サーバー、ソース クラウド、ターゲット サーバー、ターゲット クラウドなどの影響を受けるオブジェクトプロパティ。

instanceType string:

ジョブの詳細の種類を取得します (可能な値については、JobDetailsTypes 列挙型を参照してください)。

ASRTask

ジョブのタスク。

Name Type Description
allowedActions
  • string[]

このタスクに適用できる状態/アクション。

customDetails TaskTypeDetails:

タスクの種類に基づくカスタム タスクの詳細。

endTime
  • string

終了時刻です。

errors

タスク エラーの詳細。

friendlyName
  • string

名前。

groupTaskCustomDetails GroupTaskDetails:

タスクの種類が GroupTaskDetails またはそこから派生した型の 1 つである場合、タスクの種類に基づくカスタム タスクの詳細。

name
  • string

一意のタスク名。

startTime
  • string

開始時刻です。

state
  • string

状態。 これは、NotStarted、InProgress、Succeeded、Failed、Cancelled、Suspended などの値のいずれかです。

stateDescription
  • string

タスクの状態の説明。 たとえば、成功した状態の場合、説明は Completed、PartiallySucceeded、CompletedWithInformation、またはスキップできます。

taskId
  • string

ID。

taskType
  • string

タスクの種類。 CustomDetails プロパティの詳細は、この型によって異なります。

AutomationRunbookTaskDetails

このクラスは、Automation Runbook のタスクの詳細を表します。

Name Type Description
accountName
  • string

Runbook の Automation アカウント名。

cloudServiceName
  • string

Automation Runbook アカウントのクラウド サービス。

instanceType string:

タスクの詳細の種類。

isPrimarySideScript
  • boolean

プライマリ側スクリプトかどうかを示す値。

jobId
  • string

Runbook 実行のジョブ ID。

jobOutput
  • string

Runbook の実行出力。

name
  • string

復旧計画タスク名。

runbookId
  • string

Runbook ID。

runbookName
  • string

Runbook 名。

subscriptionId
  • string

Automation Runbook アカウントのサブスクリプション ID。

ConsistencyCheckTaskDetails

このクラスには、Vmm で一貫性のない保護されたエンティティの監視の詳細がすべて含まれています。

Name Type Description
instanceType string:

タスクの詳細の種類。

vmDetails

一貫性のない VM の詳細の一覧。

ExportJobDetails

このクラスは、エクスポート ジョブ ワークフローの詳細を表します。

Name Type Description
affectedObjectDetails
  • object

ワークフロー オブジェクトの詳細に基づいて、ソース サーバー、ソース クラウド、ターゲット サーバー、ターゲット クラウドなどの影響を受けるオブジェクトプロパティ。

blobUri
  • string

エクスポートされたジョブの BlobUri。

instanceType string:

ジョブの詳細の種類を取得します (可能な値については、JobDetailsTypes 列挙型を参照してください)。

sasToken
  • string

BLOB にアクセスするための sas トークン。

FailoverJobDetails

このクラスは、フェールオーバー ジョブの詳細を表します。

Name Type Description
affectedObjectDetails
  • object

ワークフロー オブジェクトの詳細に基づいて、ソース サーバー、ソース クラウド、ターゲット サーバー、ターゲット クラウドなどの影響を受けるオブジェクトプロパティ。

instanceType string:

ジョブの詳細の種類を取得します (可能な値については、JobDetailsTypes 列挙型を参照してください)。

protectedItemDetails

テスト VM の詳細。

FailoverReplicationProtectedItemDetails

レプリケーションで保護された項目のフェールオーバーの詳細。

Name Type Description
friendlyName
  • string

フレンドリ名。

name
  • string

名前。

networkConnectionStatus
  • string

ネットワーク接続の状態。

networkFriendlyName
  • string

ネットワーク フレンドリ名。

recoveryPointId
  • string

復旧ポイント ID。

recoveryPointTime
  • string

復旧ポイントの時刻。

subnet
  • string

ネットワーク サブネット。

testVmFriendlyName
  • string

テスト Vm のフレンドリ名。

testVmName
  • string

テスト VM 名。

InconsistentVmDetails

このクラスは、一貫性のない保護されたエンティティの整合性チェックの監視の詳細を格納します。

Name Type Description
cloudName
  • string

クラウド名。

details
  • string[]

SRS および On prem の保護対象エンティティの状態に関する詳細の一覧。

errorIds
  • string[]

エラー ID の一覧。

vmName
  • string

Vm 名。

InlineWorkflowTaskDetails

このクラスは、インライン ワークフロー タスクの詳細を表します。

Name Type Description
childTasks

子タスク。

instanceType string:

タスクの詳細の種類。

workflowIds
  • string[]

子ワークフロー ID の一覧。

Job

ジョブの詳細。

Name Type Description
id
  • string

リソース ID

location
  • string

リソースの場所

name
  • string

リソース名

properties

カスタム データ。

type
  • string

リソースの種類

JobErrorDetails

このクラスには、オブジェクトごとのエラーの詳細が含まれています。

Name Type Description
creationTime
  • string

ジョブ エラーの作成時刻。

errorLevel
  • string

エラーのエラー レベル。

providerErrorDetails

プロバイダー エラーの詳細。

serviceErrorDetails

サービス エラーの詳細。

taskId
  • string

タスクの ID。

JobProperties

ジョブ カスタム データの詳細。

Name Type Description
activityId
  • string

アクティビティ ID。

allowedActions
  • string[]

ジョブで許可されるアクション。

customDetails JobDetails:

テスト フェールオーバー ジョブの詳細などのカスタム ジョブの詳細。

endTime
  • string

終了時刻です。

errors

エラー。

friendlyName
  • string

DisplayName。

scenarioName
  • string

ScenarioName。

startTime
  • string

開始時刻です。

state
  • string

ジョブの状態。 これは、NotStarted、InProgress、Succeeded、Failed、Cancelled、Suspended などの値のいずれかです。

stateDescription
  • string

ジョブの状態の説明。 たとえば、成功した状態の場合、説明は完了、部分的にSucceeded、CompletedWithInformation、またはスキップできます。

targetInstanceType
  • string

Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType クラスの影響を受けるオブジェクトの型。

targetObjectId
  • string

影響を受けるオブジェクト ID。

targetObjectName
  • string

影響を受けるオブジェクトの名前。

tasks

タスク。

ManualActionTaskDetails

このクラスは、手動アクション タスクの詳細を表します。

Name Type Description
instanceType string:

タスクの詳細の種類。

instructions
  • string

手順。

name
  • string

名前。

observation
  • string

観測値。

ProviderError

このクラスには、オブジェクトごとのエラーの詳細が含まれています。

Name Type Description
errorCode
  • integer

エラー コード。

errorId
  • string

プロバイダー エラー ID。

errorMessage
  • string

エラー メッセージ。

possibleCauses
  • string

エラーの考えられる原因。

recommendedAction
  • string

エラーを解決するための推奨されるアクション。

ScriptActionTaskDetails

このクラスは、スクリプト アクション タスクの詳細を表します。

Name Type Description
instanceType string:

タスクの詳細の種類。

isPrimarySideScript
  • boolean

プライマリ側スクリプトかどうかを示す値。

name
  • string

名前。

output
  • string

出力。

path
  • string

パス。

ServiceError

ASR エラー モデル。

Name Type Description
activityId
  • string

アクティビティ ID。

code
  • string

エラー コード。

message
  • string

エラー メッセージ。

possibleCauses
  • string

エラーの原因として考えられます。

recommendedAction
  • string

エラーを解決するための推奨されるアクション。

SwitchProtectionJobDetails

このクラスは、スイッチ保護ジョブの詳細を表します。

Name Type Description
affectedObjectDetails
  • object

ワークフロー オブジェクトの詳細に基づいて、ソース サーバー、ソース クラウド、ターゲット サーバー、ターゲット クラウドなどの影響を受けるオブジェクトプロパティ。

instanceType string:

ジョブの詳細の種類を取得します (可能な値については、JobDetailsTypes 列挙型を参照してください)。

newReplicationProtectedItemId
  • string

新しいレプリケーションで保護された項目の ARM ID。

TestFailoverJobDetails

このクラスは、テスト フェールオーバー ジョブの詳細を表します。

Name Type Description
affectedObjectDetails
  • object

ワークフロー オブジェクトの詳細に基づいて、ソース サーバー、ソース クラウド、ターゲット サーバー、ターゲット クラウドなどの影響を受けるオブジェクトプロパティ。

comments
  • string

テスト フェールオーバーのコメント。

instanceType string:

ジョブの詳細の種類を取得します (可能な値については、JobDetailsTypes 列挙型を参照してください)。

networkFriendlyName
  • string

テスト ネットワーク フレンドリ名。

networkName
  • string

テスト ネットワーク名。

networkType
  • string

テスト ネットワークの種類 (使用可能な値については、TestFailoverInput 列挙型を参照してください)。

protectedItemDetails

テスト VM の詳細。

testFailoverStatus
  • string

テスト フェールオーバーの状態。

VmNicUpdatesTaskDetails

このクラスは、vm NicUpdates タスクの詳細を表します。

Name Type Description
instanceType string:

タスクの詳細の種類。

name
  • string

Nic の名前。

nicId
  • string

Nic ID。

vmId
  • string

仮想マシン ID。