Replication Jobs - Cancel

Anuluje określone zadanie.
Operacja anulowania zadania Site Recovery platformy Azure.

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

Parametry identyfikatora URI

Name In Required Type Description
jobName
path True
  • string

Identyfikator zadania.

resourceGroupName
path True
  • string

Nazwa grupy zasobów, w której znajduje się magazyn usługi Recovery Services.

resourceName
path True
  • string

Nazwa magazynu usługi Recovery Services.

subscriptionId
path True
  • string

Identyfikator subskrypcji.

api-version
query True
  • string

Wersja interfejsu API klienta.

Odpowiedzi

Name Type Description
200 OK

OK

202 Accepted

Zaakceptowano

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personifikuj konto użytkownika.

Przykłady

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"
      }
    }
  }
}

Definicje

AsrJobDetails

Ta klasa reprezentuje szczegóły zadania na podstawie określonego typu zadania.

ASRTask

Zadanie zadania.

AutomationRunbookTaskDetails

Ta klasa reprezentuje szczegóły zadania dla elementu Runbook automatyzacji.

ConsistencyCheckTaskDetails

Ta klasa zawiera szczegóły monitorowania wszystkich niespójnych chronionych jednostek w programie Vmm.

ExportJobDetails

Ta klasa reprezentuje szczegóły przepływu pracy zadań eksportu.

FailoverJobDetails

Ta klasa reprezentuje szczegóły zadania trybu failover.

FailoverReplicationProtectedItemDetails

Szczegóły trybu failover dla chronionego elementu replikacji.

InconsistentVmDetails

Ta klasa przechowuje szczegóły monitorowania pod kątem sprawdzania spójności niespójnej jednostki chronionej.

InlineWorkflowTaskDetails

Ta klasa reprezentuje szczegóły zadania przepływu pracy wbudowanego.

Job

Szczegóły zadania.

JobErrorDetails

Ta klasa zawiera szczegóły błędu dla każdego obiektu.

JobProperties

Szczegóły danych niestandardowych zadania.

ManualActionTaskDetails

Ta klasa reprezentuje szczegóły zadania akcji ręcznej.

ProviderError

Ta klasa zawiera szczegóły błędu dla każdego obiektu.

ScriptActionTaskDetails

Ta klasa reprezentuje szczegóły zadania akcji skryptu.

ServiceError

Model błędów usługi ASR.

SwitchProtectionJobDetails

Ta klasa reprezentuje szczegóły zadania ochrony przełącznika.

TestFailoverJobDetails

Ta klasa reprezentuje szczegóły zadania testowego trybu failover.

VmNicUpdatesTaskDetails

Ta klasa reprezentuje szczegóły zadania nicUpdates maszyny wirtualnej.

AsrJobDetails

Ta klasa reprezentuje szczegóły zadania na podstawie określonego typu zadania.

Name Type Description
affectedObjectDetails
  • object

Właściwości obiektu, których dotyczy problem, takie jak serwer źródłowy, chmura źródłowa, serwer docelowy, chmura docelowa itp. na podstawie szczegółów obiektu przepływu pracy.

instanceType string:

Pobiera typ szczegółów zadania (zobacz wyliczenie JobDetailsTypes, aby uzyskać możliwe wartości).

ASRTask

Zadanie zadania.

Name Type Description
allowedActions
  • string[]

Stan/akcje stosowane w tym zadaniu.

customDetails TaskTypeDetails:

Niestandardowe szczegóły zadania na podstawie typu zadania.

endTime
  • string

Godzina zakończenia.

errors

Szczegóły błędu zadania.

friendlyName
  • string

Nazwa.

groupTaskCustomDetails GroupTaskDetails:

Niestandardowe szczegóły zadania na podstawie typu zadania, jeśli typ zadania to GroupTaskDetails lub jeden z typów pochodnych.

name
  • string

Unikatowa nazwa zadania.

startTime
  • string

Godzina rozpoczęcia.

state
  • string

Stan. Jest to jedna z tych wartości : NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended lub Other.

stateDescription
  • string

Opis stanu zadania. Na przykład — w przypadku stanu Powodzenie opis można wykonać, częściowoSucceeded, CompletedWithInformation lub Skipped.

taskId
  • string

Identyfikator.

taskType
  • string

Typ zadania. Szczegóły właściwości CustomDetails zależą od tego typu.

AutomationRunbookTaskDetails

Ta klasa reprezentuje szczegóły zadania dla elementu Runbook automatyzacji.

Name Type Description
accountName
  • string

Nazwa konta automatyzacji elementu Runbook.

cloudServiceName
  • string

Usługa w chmurze konta elementu Runbook automatyzacji.

instanceType string:

Typ szczegółów zadania.

isPrimarySideScript
  • boolean

Wartość wskazująca, czy jest to skrypt po stronie głównej, czy nie.

jobId
  • string

Identyfikator zadania wykonania elementu Runbook.

jobOutput
  • string

Dane wyjściowe wykonywania elementu Runbook.

name
  • string

Nazwa zadania planu odzyskiwania.

runbookId
  • string

Identyfikator elementu Runbook.

runbookName
  • string

Nazwa elementu runbook.

subscriptionId
  • string

Identyfikator subskrypcji konta elementu runbook automatyzacji.

ConsistencyCheckTaskDetails

Ta klasa zawiera szczegóły monitorowania wszystkich niespójnych chronionych jednostek w programie Vmm.

Name Type Description
instanceType string:

Typ szczegółów zadania.

vmDetails

Lista niespójnych szczegółów maszyny wirtualnej.

ExportJobDetails

Ta klasa reprezentuje szczegóły przepływu pracy zadań eksportu.

Name Type Description
affectedObjectDetails
  • object

Właściwości obiektu, których dotyczy problem, takie jak serwer źródłowy, chmura źródłowa, serwer docelowy, chmura docelowa itp. na podstawie szczegółów obiektu przepływu pracy.

blobUri
  • string

Identyfikator BlobUri wyeksportowanych zadań.

instanceType string:

Pobiera typ szczegółów zadania (zobacz wyliczenie JobDetailsTypes, aby uzyskać możliwe wartości).

sasToken
  • string

Token sygnatury dostępu współdzielonego do uzyskiwania dostępu do obiektu blob.

FailoverJobDetails

Ta klasa reprezentuje szczegóły zadania trybu failover.

Name Type Description
affectedObjectDetails
  • object

Właściwości obiektu, których dotyczy problem, takie jak serwer źródłowy, chmura źródłowa, serwer docelowy, chmura docelowa itp. na podstawie szczegółów obiektu przepływu pracy.

instanceType string:

Pobiera typ szczegółów zadania (zobacz wyliczenie JobDetailsTypes, aby uzyskać możliwe wartości).

protectedItemDetails

Szczegóły testowej maszyny wirtualnej.

FailoverReplicationProtectedItemDetails

Szczegóły trybu failover dla chronionego elementu replikacji.

Name Type Description
friendlyName
  • string

Przyjazna nazwa.

name
  • string

Nazwa.

networkConnectionStatus
  • string

Stan połączenia sieciowego.

networkFriendlyName
  • string

Przyjazna nazwa sieci.

recoveryPointId
  • string

Identyfikator punktu odzyskiwania.

recoveryPointTime
  • string

Czas punktu odzyskiwania.

subnet
  • string

Podsieć sieci.

testVmFriendlyName
  • string

Testowa przyjazna nazwa maszyny wirtualnej.

testVmName
  • string

Testowa nazwa maszyny wirtualnej.

InconsistentVmDetails

Ta klasa przechowuje szczegóły monitorowania pod kątem sprawdzania spójności niespójnej jednostki chronionej.

Name Type Description
cloudName
  • string

Nazwa chmury.

details
  • string[]

Lista szczegółów dotyczących stanu chronionej jednostki w usługach SRS i w środowisku lokalnym.

errorIds
  • string[]

Lista identyfikatorów błędów.

vmName
  • string

Nazwa maszyny wirtualnej.

InlineWorkflowTaskDetails

Ta klasa reprezentuje szczegóły zadania przepływu pracy wbudowanego.

Name Type Description
childTasks

Podrzędne zadania.

instanceType string:

Typ szczegółów zadania.

workflowIds
  • string[]

Lista podrzędnych identyfikatorów przepływu pracy.

Job

Szczegóły zadania.

Name Type Description
id
  • string

Identyfikator zasobu

location
  • string

Resource Location

name
  • string

Nazwa zasobu

properties

Dane niestandardowe.

type
  • string

Typ zasobu

JobErrorDetails

Ta klasa zawiera szczegóły błędu dla każdego obiektu.

Name Type Description
creationTime
  • string

Czas utworzenia zadania.

errorLevel
  • string

Poziom błędu błędu.

providerErrorDetails

Szczegóły błędu dostawcy.

serviceErrorDetails

Szczegóły błędu usługi.

taskId
  • string

Identyfikator zadania.

JobProperties

Szczegóły danych niestandardowych zadania.

Name Type Description
activityId
  • string

Identyfikator działania.

allowedActions
  • string[]

Dozwolona akcja zadania.

customDetails JobDetails:

Szczegóły zadania niestandardowego, takie jak szczegóły zadania testowego trybu failover.

endTime
  • string

Godzina zakończenia.

errors

Błędy.

friendlyName
  • string

The DisplayName.

scenarioName
  • string

Nazwa scenariusza.

startTime
  • string

Godzina rozpoczęcia.

state
  • string

Stan zadania. Jest to jedna z tych wartości : NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended lub Other.

stateDescription
  • string

Opis stanu zadania. Na przykład — w przypadku stanu Powodzenie opis można wykonać, częściowoSucceeded, CompletedWithInformation lub Skipped.

targetInstanceType
  • string

Typ obiektu, którego dotyczy problem, jest klasy Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType.

targetObjectId
  • string

Identyfikator obiektu, którego dotyczy problem.

targetObjectName
  • string

Nazwa obiektu, którego dotyczy problem.

tasks

Zadania.

ManualActionTaskDetails

Ta klasa reprezentuje szczegóły zadania akcji ręcznej.

Name Type Description
instanceType string:

Typ szczegółów zadania.

instructions
  • string

Instrukcje.

name
  • string

Nazwa.

observation
  • string

Obserwacja.

ProviderError

Ta klasa zawiera szczegóły błędu dla każdego obiektu.

Name Type Description
errorCode
  • integer

Kod błędu.

errorId
  • string

Identyfikator błędu dostawcy.

errorMessage
  • string

Komunikat o błędzie.

possibleCauses
  • string

Możliwe przyczyny błędu.

recommendedAction
  • string

Zalecana akcja w celu usunięcia błędu.

ScriptActionTaskDetails

Ta klasa reprezentuje szczegóły zadania akcji skryptu.

Name Type Description
instanceType string:

Typ szczegółów zadania.

isPrimarySideScript
  • boolean

Wartość wskazująca, czy jest to skrypt po stronie głównej, czy nie.

name
  • string

Nazwa.

output
  • string

Produkt wyjściowy.

path
  • string

Ścieżka.

ServiceError

Model błędów usługi ASR.

Name Type Description
activityId
  • string

Identyfikator działania.

code
  • string

Kod błędu.

message
  • string

Komunikat o błędzie.

possibleCauses
  • string

Możliwe przyczyny błędu.

recommendedAction
  • string

Zalecana akcja w celu usunięcia błędu.

SwitchProtectionJobDetails

Ta klasa reprezentuje szczegóły zadania ochrony przełącznika.

Name Type Description
affectedObjectDetails
  • object

Właściwości obiektu, których dotyczy problem, takie jak serwer źródłowy, chmura źródłowa, serwer docelowy, chmura docelowa itp. na podstawie szczegółów obiektu przepływu pracy.

instanceType string:

Pobiera typ szczegółów zadania (zobacz wyliczenie JobDetailsTypes, aby uzyskać możliwe wartości).

newReplicationProtectedItemId
  • string

Identyfikator usługi ARM nowego elementu chronionego przez replikację.

TestFailoverJobDetails

Ta klasa reprezentuje szczegóły zadania testowego trybu failover.

Name Type Description
affectedObjectDetails
  • object

Właściwości obiektu, których dotyczy problem, takie jak serwer źródłowy, chmura źródłowa, serwer docelowy, chmura docelowa itp. na podstawie szczegółów obiektu przepływu pracy.

comments
  • string

Komentarze testowego trybu failover.

instanceType string:

Pobiera typ szczegółów zadania (zobacz wyliczenie JobDetailsTypes, aby uzyskać możliwe wartości).

networkFriendlyName
  • string

Przyjazna nazwa sieci testowej.

networkName
  • string

Nazwa sieci testowej.

networkType
  • string

Testowy typ sieci (zobacz wyliczenie TestFailoverInput, aby uzyskać możliwe wartości).

protectedItemDetails

Szczegóły testowej maszyny wirtualnej.

testFailoverStatus
  • string

Stan testu pracy w trybie failover.

VmNicUpdatesTaskDetails

Ta klasa reprezentuje szczegóły zadania nicUpdates maszyny wirtualnej.

Name Type Description
instanceType string:

Typ szczegółów zadania.

name
  • string

Nazwa karty sieciowej.

nicId
  • string

Identyfikator karty sieciowej.

vmId
  • string

Identyfikator maszyny wirtualnej.