Replication Jobs - Cancel

Cancela o trabalho especificado.
A operação para cancelar um trabalho de Site Recovery do Azure.

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

Parâmetros de URI

Name In Required Type Description
jobName
path True
  • string

Job identifier.

resourceGroupName
path True
  • string

O nome do grupo de recursos em que o cofre dos serviços de recuperação está presente.

resourceName
path True
  • string

O nome do cofre dos serviços de recuperação.

subscriptionId
path True
  • string

A ID da assinatura.

api-version
query True
  • string

Versão da API do Cliente.

Respostas

Name Type Description
200 OK

OK

202 Accepted

Aceito

Segurança

azure_auth

Flow Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation representar sua conta de usuário.

Exemplos

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

Definições

AsrJobDetails

Essa classe representa os detalhes do trabalho com base no tipo de trabalho específico.

ASRTask

Tarefa do Trabalho.

AutomationRunbookTaskDetails

Essa classe representa os detalhes da tarefa de um runbook de automação.

ConsistencyCheckTaskDetails

Essa classe contém detalhes de monitoramento de todas as entidades protegidas inconsistentes no Vmm.

ExportJobDetails

Essa classe representa detalhes para o fluxo de trabalho de exportação de trabalhos.

FailoverJobDetails

Essa classe representa os detalhes de um trabalho de failover.

FailoverReplicationProtectedItemDetails

Detalhes de failover de um item protegido por replicação.

InconsistentVmDetails

Essa classe armazena os detalhes de monitoramento para verificação de consistência de entidade protegida inconsistente.

InlineWorkflowTaskDetails

Essa classe representa os detalhes da tarefa de fluxo de trabalho embutido.

Job

Detalhes do trabalho.

JobErrorDetails

Essa classe contém os detalhes de erro por objeto.

JobProperties

Detalhes de dados personalizados do trabalho.

ManualActionTaskDetails

Essa classe representa os detalhes da tarefa de ação manual.

ProviderError

Essa classe contém os detalhes de erro por objeto.

ScriptActionTaskDetails

Essa classe representa os detalhes da tarefa de ação de script.

ServiceError

Modelo de erro ASR.

SwitchProtectionJobDetails

Essa classe representa detalhes para o trabalho de proteção de comutador.

TestFailoverJobDetails

Essa classe representa os detalhes de um trabalho de failover de teste.

VmNicUpdatesTaskDetails

Essa classe representa os detalhes da tarefa vm NicUpdates.

AsrJobDetails

Essa classe representa os detalhes do trabalho com base no tipo de trabalho específico.

Name Type Description
affectedObjectDetails
  • object

As propriedades de objeto afetadas, como servidor de origem, nuvem de origem, servidor de destino, nuvem de destino etc. com base nos detalhes do objeto de fluxo de trabalho.

instanceType string:

Obtém o tipo de detalhes do trabalho (consulte JobDetailsTypes enum para obter valores possíveis).

ASRTask

Tarefa do Trabalho.

Name Type Description
allowedActions
  • string[]

O estado/ações aplicáveis a essa tarefa.

customDetails TaskTypeDetails:

Os detalhes da tarefa personalizada com base no tipo de tarefa.

endTime
  • string

A hora de término.

errors

Os detalhes do erro da tarefa.

friendlyName
  • string

O nome.

groupTaskCustomDetails GroupTaskDetails:

Os detalhes da tarefa personalizada com base no tipo de tarefa, se o tipo de tarefa for GroupTaskDetails ou um dos tipos derivados dele.

name
  • string

O nome exclusivo da Tarefa.

startTime
  • string

A hora de início.

state
  • string

O Estado. É um desses valores – NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended ou Other.

stateDescription
  • string

A descrição do estado da tarefa. Por exemplo: para estado bem-sucedido, a descrição pode ser concluída, parcialmente Succeededed, CompletedWithInformation ou Ignorada.

taskId
  • string

A ID.

taskType
  • string

O tipo de tarefa. Os detalhes na propriedade CustomDetails dependem desse tipo.

AutomationRunbookTaskDetails

Essa classe representa os detalhes da tarefa de um runbook de automação.

Name Type Description
accountName
  • string

O nome da conta de automação do runbook.

cloudServiceName
  • string

O serviço de nuvem da conta de runbook de automação.

instanceType string:

O tipo de detalhes da tarefa.

isPrimarySideScript
  • boolean

Um valor que indica se é um script do lado primário ou não.

jobId
  • string

A ID do trabalho da execução do runbook.

jobOutput
  • string

A saída de execução do runbook.

name
  • string

O nome da tarefa do plano de recuperação.

runbookId
  • string

A ID do runbook.

runbookName
  • string

O nome do runbook.

subscriptionId
  • string

A ID da assinatura da conta do runbook de automação.

ConsistencyCheckTaskDetails

Essa classe contém detalhes de monitoramento de todas as entidades protegidas inconsistentes no Vmm.

Name Type Description
instanceType string:

O tipo de detalhes da tarefa.

vmDetails

A lista de detalhes inconsistentes da VM.

ExportJobDetails

Essa classe representa detalhes para o fluxo de trabalho de exportação de trabalhos.

Name Type Description
affectedObjectDetails
  • object

As propriedades de objeto afetadas, como servidor de origem, nuvem de origem, servidor de destino, nuvem de destino etc. com base nos detalhes do objeto de fluxo de trabalho.

blobUri
  • string

BlobUri dos trabalhos exportados.

instanceType string:

Obtém o tipo de detalhes do trabalho (consulte JobDetailsTypes enum para obter valores possíveis).

sasToken
  • string

O token sas para acessar o blob.

FailoverJobDetails

Essa classe representa os detalhes de um trabalho de failover.

Name Type Description
affectedObjectDetails
  • object

As propriedades de objeto afetadas, como servidor de origem, nuvem de origem, servidor de destino, nuvem de destino etc. com base nos detalhes do objeto de fluxo de trabalho.

instanceType string:

Obtém o tipo de detalhes do trabalho (consulte JobDetailsTypes enum para obter valores possíveis).

protectedItemDetails

Os detalhes da VM de teste.

FailoverReplicationProtectedItemDetails

Detalhes de failover de um item protegido por replicação.

Name Type Description
friendlyName
  • string

O nome amigável.

name
  • string

O nome.

networkConnectionStatus
  • string

O status da conexão de rede.

networkFriendlyName
  • string

O nome amigável da rede.

recoveryPointId
  • string

A ID do ponto de recuperação.

recoveryPointTime
  • string

A hora do ponto de recuperação.

subnet
  • string

A sub-rede de rede.

testVmFriendlyName
  • string

O nome amigável da VM de teste.

testVmName
  • string

O nome da VM de teste.

InconsistentVmDetails

Essa classe armazena os detalhes de monitoramento para verificação de consistência de entidade protegida inconsistente.

Name Type Description
cloudName
  • string

O nome da nuvem.

details
  • string[]

A lista de detalhes sobre o estado da Entidade Protegida no SRS e no prem On.

errorIds
  • string[]

A lista de IDs de erro.

vmName
  • string

O nome da VM.

InlineWorkflowTaskDetails

Essa classe representa os detalhes da tarefa de fluxo de trabalho embutido.

Name Type Description
childTasks

As tarefas filho.

instanceType string:

O tipo de detalhes da tarefa.

workflowIds
  • string[]

A lista de IDs de fluxo de trabalho filho.

Job

Detalhes do trabalho.

Name Type Description
id
  • string

ID do recurso

location
  • string

Local do recurso

name
  • string

Nome do Recurso

properties

Os dados personalizados.

type
  • string

Tipo de recurso

JobErrorDetails

Essa classe contém os detalhes de erro por objeto.

Name Type Description
creationTime
  • string

O tempo de criação do erro de trabalho.

errorLevel
  • string

Nível de erro.

providerErrorDetails

Os detalhes do erro do Provedor.

serviceErrorDetails

Os detalhes do erro do Serviço.

taskId
  • string

A ID da tarefa.

JobProperties

Detalhes de dados personalizados do trabalho.

Name Type Description
activityId
  • string

A ID da atividade.

allowedActions
  • string[]

A ação permitida do trabalho.

customDetails JobDetails:

Os detalhes do trabalho personalizado, como detalhes do trabalho de failover de teste.

endTime
  • string

A hora de término.

errors

Os erros.

friendlyName
  • string

O DisplayName.

scenarioName
  • string

O ScenarioName.

startTime
  • string

A hora de início.

state
  • string

O status do trabalho. É um desses valores – NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended ou Other.

stateDescription
  • string

A descrição do estado do Trabalho. Por exemplo, para o estado bem-sucedido, a descrição pode ser concluída, parcialmente Succeeded, CompletedWithInformation ou Ignorada.

targetInstanceType
  • string

O tipo do objeto afetado que é da classe Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType.

targetObjectId
  • string

A ID do Objeto afetada.

targetObjectName
  • string

O nome do objeto afetado.

tasks

As tarefas.

ManualActionTaskDetails

Essa classe representa os detalhes da tarefa de ação manual.

Name Type Description
instanceType string:

O tipo de detalhes da tarefa.

instructions
  • string

As instruções.

name
  • string

O nome.

observation
  • string

A observação.

ProviderError

Essa classe contém os detalhes de erro por objeto.

Name Type Description
errorCode
  • integer

O código de erro.

errorId
  • string

A ID de erro do provedor.

errorMessage
  • string

A mensagem de erro.

possibleCauses
  • string

As possíveis causas para o erro.

recommendedAction
  • string

A ação recomendada para resolver o erro.

ScriptActionTaskDetails

Essa classe representa os detalhes da tarefa de ação de script.

Name Type Description
instanceType string:

O tipo de detalhes da tarefa.

isPrimarySideScript
  • boolean

Um valor que indica se é um script do lado primário ou não.

name
  • string

O nome.

output
  • string

A saída.

path
  • string

O caminho.

ServiceError

Modelo de erro ASR.

Name Type Description
activityId
  • string

ID da atividade.

code
  • string

Código do erro.

message
  • string

Mensagem de erro.

possibleCauses
  • string

Possíveis causas de erro.

recommendedAction
  • string

Ação recomendada para resolver o erro.

SwitchProtectionJobDetails

Essa classe representa detalhes para o trabalho de proteção de comutador.

Name Type Description
affectedObjectDetails
  • object

As propriedades de objeto afetadas, como servidor de origem, nuvem de origem, servidor de destino, nuvem de destino etc. com base nos detalhes do objeto de fluxo de trabalho.

instanceType string:

Obtém o tipo de detalhes do trabalho (consulte JobDetailsTypes enum para obter valores possíveis).

newReplicationProtectedItemId
  • string

ID do ARM do novo item protegido por replicação.

TestFailoverJobDetails

Essa classe representa os detalhes de um trabalho de failover de teste.

Name Type Description
affectedObjectDetails
  • object

As propriedades de objeto afetadas, como servidor de origem, nuvem de origem, servidor de destino, nuvem de destino etc. com base nos detalhes do objeto de fluxo de trabalho.

comments
  • string

Os comentários de failover de teste.

instanceType string:

Obtém o tipo de detalhes do trabalho (consulte JobDetailsTypes enum para obter valores possíveis).

networkFriendlyName
  • string

O nome amigável da rede de teste.

networkName
  • string

O nome da rede de teste.

networkType
  • string

O tipo de rede de teste (consulte TestFailoverInput enumeração para valores possíveis).

protectedItemDetails

Os detalhes da VM de teste.

testFailoverStatus
  • string

O status de failover de teste.

VmNicUpdatesTaskDetails

Essa classe representa os detalhes da tarefa vm NicUpdates.

Name Type Description
instanceType string:

O tipo de detalhes da tarefa.

name
  • string

Nome da Nic.

nicId
  • string

ID nic.

vmId
  • string

ID da máquina virtual.