Replication Jobs - Cancel

Referência

Service:: Recovery Services - Site Recovery

API Version:: 2023-02-01

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=2023-02-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	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

Nome	Tipo	Description
200 OK	Job	OK
202 Accepted		Aceito

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	represente sua conta de usuário.

Exemplos

Cancels the specified job.

Sample Request

HTTP

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=2023-02-01

Sample Response

Status code:: 200

Azure-AsyncOperation: https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-02-01

Response Body

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

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2023-02-01
Retry-After: 30

Definições

Nome	Description
AsrJobDetails	Essa classe representa detalhes do trabalho com base em um 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 trabalho de exportação.
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 marcar 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 do 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 do 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 nicUpdates da vm.

AsrJobDetails

Essa classe representa detalhes do trabalho com base em um tipo de trabalho específico.

Nome	Tipo	Description
affectedObjectDetails	object	As propriedades do 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: AsrJobDetails	Obtém o tipo de detalhes do trabalho (confira enumeração JobDetailsTypes para obter valores possíveis).

ASRTask

Tarefa do Trabalho.

Nome	Tipo	Description
allowedActions	string[]	O estado/ações aplicáveis a essa tarefa.
customDetails	TaskTypeDetails: AutomationRunbookTaskDetails ConsistencyCheckTaskDetails ManualActionTaskDetails ScriptActionTaskDetails VmNicUpdatesTaskDetails	Os detalhes da tarefa personalizada com base no tipo de tarefa.
endTime	string	A hora de término.
errors	JobErrorDetails[]	Os detalhes do erro da tarefa.
friendlyName	string	O nome.
groupTaskCustomDetails	GroupTaskDetails: InlineWorkflowTaskDetails	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 o estado Bem-sucedido, a descrição pode ser Concluída, ParcialmenteSucceedida, 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.

Nome	Tipo	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: AutomationRunbookTaskDetails	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.

Nome	Tipo	Description
instanceType	string: ConsistencyCheckTaskDetails	O tipo de detalhes da tarefa.
vmDetails	InconsistentVmDetails[]	A lista de detalhes inconsistentes da VM.

ExportJobDetails

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

Nome	Tipo	Description
affectedObjectDetails	object	As propriedades do 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: ExportJobDetails	Obtém o tipo de detalhes do trabalho (confira enumeração JobDetailsTypes 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.

Nome	Tipo	Description
affectedObjectDetails	object	As propriedades do 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: FailoverJobDetails	Obtém o tipo de detalhes do trabalho (confira enumeração JobDetailsTypes para obter valores possíveis).
protectedItemDetails	FailoverReplicationProtectedItemDetails[]	Os detalhes da VM de teste.

FailoverReplicationProtectedItemDetails

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

Nome	Tipo	Description
friendlyName	string	O nome amigável.
name	string	O nome.
networkConnectionStatus	string	A conexão de rede status.
networkFriendlyName	string	O nome amigável da rede.
recoveryPointId	string	A ID do ponto de recuperação.
recoveryPointTime	string	O tempo 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 marcar de consistência de Entidade Protegida inconsistente.

Nome	Tipo	Description
cloudName	string	O nome da nuvem.
details	string[]	A lista de detalhes sobre o estado da Entidade Protegida no SRS e No local.
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.

Nome	Tipo	Description
childTasks	ASRTask[]	As tarefas filho.
instanceType	string: InlineWorkflowTaskDetails	O tipo de detalhes da tarefa.
workflowIds	string[]	A lista de IDs de fluxo de trabalho filho.

Job

Detalhes do trabalho.

Nome	Tipo	Description
id	string	ID do recurso
location	string	Local do recurso
name	string	Nome do Recurso
properties	JobProperties	Os dados personalizados.
type	string	Tipo de recurso

JobErrorDetails

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

Nome	Tipo	Description
creationTime	string	O tempo de criação do erro de trabalho.
errorLevel	string	Nível de erro de erro.
providerErrorDetails	ProviderError	Os detalhes do erro provedor.
serviceErrorDetails	ServiceError	Os detalhes do erro de serviço.
taskId	string	A ID da tarefa.

JobProperties

Detalhes de dados personalizados do trabalho.

Nome	Tipo	Description
activityId	string	A ID da atividade.
allowedActions	string[]	A ação Permitido do trabalho.
customDetails	JobDetails: AsrJobDetails ExportJobDetails FailoverJobDetails SwitchProtectionJobDetails TestFailoverJobDetails	Os detalhes do trabalho personalizado, como detalhes do trabalho de failover de teste.
endTime	string	A hora de término.
errors	JobErrorDetails[]	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 estado bem-sucedido, a descrição pode ser Concluída, ParcialmenteSucceedida, ConcluídaComInformação 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	ASRTask[]	As tarefas.

ManualActionTaskDetails

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

Nome	Tipo	Description
instanceType	string: ManualActionTaskDetails	O tipo de detalhes da tarefa.
instructions	string	As instruções.
name	string	O nome.
observation	string	A observação.

ProviderError