Replication Jobs - Cancel

Cancela el trabajo especificado.
Operación para cancelar un trabajo de 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

Parámetros de identificador URI

Name In Required Type Description
jobName
path True
  • string

Identificador del trabajo.

resourceGroupName
path True
  • string

Nombre del grupo de recursos donde está presente el almacén de Recovery Services.

resourceName
path True
  • string

Nombre del almacén de Recovery Services.

subscriptionId
path True
  • string

Identificador de suscripción.

api-version
query True
  • string

Versión de api de cliente.

Respuestas

Name Type Description
200 OK

Aceptar

202 Accepted

Aceptado

Seguridad

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario.

Ejemplos

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

Definiciones

AsrJobDetails

Esta clase representa los detalles del trabajo en función del tipo de trabajo específico.

ASRTask

Tarea del trabajo.

AutomationRunbookTaskDetails

Esta clase representa los detalles de la tarea de un runbook de automatización.

ConsistencyCheckTaskDetails

Esta clase contiene detalles de supervisión de todas las entidades protegidas incoherentes en Vmm.

ExportJobDetails

Esta clase representa los detalles del flujo de trabajo de exportación de trabajos.

FailoverJobDetails

Esta clase representa los detalles de un trabajo de conmutación por error.

FailoverReplicationProtectedItemDetails

Detalles de conmutación por error de un elemento protegido de replicación.

InconsistentVmDetails

Esta clase almacena los detalles de supervisión para comprobar la coherencia de la entidad protegida incoherente.

InlineWorkflowTaskDetails

Esta clase representa los detalles de la tarea de flujo de trabajo insertado.

Job

Detalles del trabajo.

JobErrorDetails

Esta clase contiene los detalles de error por objeto.

JobProperties

Detalles de datos personalizados del trabajo.

ManualActionTaskDetails

Esta clase representa los detalles de la tarea de acción manual.

ProviderError

Esta clase contiene los detalles de error por objeto.

ScriptActionTaskDetails

Esta clase representa los detalles de la tarea de acción de script.

ServiceError

Modelo de error de ASR.

SwitchProtectionJobDetails

Esta clase representa los detalles del trabajo de protección de conmutadores.

TestFailoverJobDetails

Esta clase representa los detalles de un trabajo de conmutación por error de prueba.

VmNicUpdatesTaskDetails

Esta clase representa los detalles de la tarea vm NicUpdates.

AsrJobDetails

Esta clase representa los detalles del trabajo en función del tipo de trabajo específico.

Name Type Description
affectedObjectDetails
  • object

Las propiedades de objeto afectadas, como el servidor de origen, la nube de origen, el servidor de destino, la nube de destino, etc. en función de los detalles del objeto de flujo de trabajo.

instanceType string:

Obtiene el tipo de detalles del trabajo (vea Enumeración JobDetailsTypes para conocer los valores posibles).

ASRTask

Tarea del trabajo.

Name Type Description
allowedActions
  • string[]

El estado o las acciones aplicables en esta tarea.

customDetails TaskTypeDetails:

Detalles de la tarea personalizada en función del tipo de tarea.

endTime
  • string

Hora de finalización.

errors

Detalles del error de tarea.

friendlyName
  • string

Nombre.

groupTaskCustomDetails GroupTaskDetails:

Los detalles de la tarea personalizada basados en el tipo de tarea, si el tipo de tarea es GroupTaskDetails o uno de los tipos derivados de ella.

name
  • string

Nombre único de la tarea.

startTime
  • string

Hora de inicio.

state
  • string

Estado. Es uno de estos valores: NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended u Other.

stateDescription
  • string

Descripción del estado de la tarea. Por ejemplo: para el estado Succeeded, description puede ser Completed, ParcialmenteSucceeded, CompletedWithInformation o Skipped.

taskId
  • string

Identificador.

taskType
  • string

Tipo de tarea. Los detalles de la propiedad CustomDetails dependen de este tipo.

AutomationRunbookTaskDetails

Esta clase representa los detalles de la tarea de un runbook de automatización.

Name Type Description
accountName
  • string

Nombre de la cuenta de automation del runbook.

cloudServiceName
  • string

El servicio en la nube de la cuenta de runbook de Automation.

instanceType string:

Tipo de detalles de la tarea.

isPrimarySideScript
  • boolean

Valor que indica si es un script del lado principal o no.

jobId
  • string

Identificador de trabajo de la ejecución del runbook.

jobOutput
  • string

Salida de ejecución del runbook.

name
  • string

Nombre de la tarea del plan de recuperación.

runbookId
  • string

Identificador del runbook.

runbookName
  • string

Nombre del runbook.

subscriptionId
  • string

Identificador de suscripción de la cuenta de runbook de Automation.

ConsistencyCheckTaskDetails

Esta clase contiene detalles de supervisión de todas las entidades protegidas incoherentes en Vmm.

Name Type Description
instanceType string:

Tipo de detalles de la tarea.

vmDetails

Lista de detalles de máquina virtual incoherentes.

ExportJobDetails

Esta clase representa los detalles del flujo de trabajo de exportación de trabajos.

Name Type Description
affectedObjectDetails
  • object

Las propiedades de objeto afectadas, como el servidor de origen, la nube de origen, el servidor de destino, la nube de destino, etc. en función de los detalles del objeto de flujo de trabajo.

blobUri
  • string

BlobUri de los trabajos exportados.

instanceType string:

Obtiene el tipo de detalles del trabajo (vea Enumeración JobDetailsTypes para conocer los valores posibles).

sasToken
  • string

Token sas para acceder al blob.

FailoverJobDetails

Esta clase representa los detalles de un trabajo de conmutación por error.

Name Type Description
affectedObjectDetails
  • object

Las propiedades de objeto afectadas, como el servidor de origen, la nube de origen, el servidor de destino, la nube de destino, etc. en función de los detalles del objeto de flujo de trabajo.

instanceType string:

Obtiene el tipo de detalles del trabajo (vea Enumeración JobDetailsTypes para conocer los valores posibles).

protectedItemDetails

Detalles de la máquina virtual de prueba.

FailoverReplicationProtectedItemDetails

Detalles de conmutación por error de un elemento protegido de replicación.

Name Type Description
friendlyName
  • string

Nombre descriptivo.

name
  • string

Nombre.

networkConnectionStatus
  • string

Estado de conexión de red.

networkFriendlyName
  • string

Nombre descriptivo de la red.

recoveryPointId
  • string

Identificador del punto de recuperación.

recoveryPointTime
  • string

Tiempo de punto de recuperación.

subnet
  • string

Subred de red.

testVmFriendlyName
  • string

Nombre descriptivo de la máquina virtual de prueba.

testVmName
  • string

Nombre de la máquina virtual de prueba.

InconsistentVmDetails

Esta clase almacena los detalles de supervisión para comprobar la coherencia de la entidad protegida incoherente.

Name Type Description
cloudName
  • string

Nombre de la nube.

details
  • string[]

La lista de detalles relacionados con el estado de la entidad protegida en SRS y on prem.

errorIds
  • string[]

Lista de identificadores de error.

vmName
  • string

Nombre de la máquina virtual.

InlineWorkflowTaskDetails

Esta clase representa los detalles de la tarea de flujo de trabajo insertado.

Name Type Description
childTasks

Las tareas secundarias.

instanceType string:

Tipo de detalles de la tarea.

workflowIds
  • string[]

Lista de identificadores de flujo de trabajo secundarios.

Job

Detalles del trabajo.

Name Type Description
id
  • string

Id. de recurso

location
  • string

Resource Location

name
  • string

Nombre de recurso

properties

Datos personalizados.

type
  • string

Tipo de recurso

JobErrorDetails

Esta clase contiene los detalles de error por objeto.

Name Type Description
creationTime
  • string

Hora de creación del error del trabajo.

errorLevel
  • string

Nivel de error.

providerErrorDetails

Detalles del error del proveedor.

serviceErrorDetails

Detalles del error del servicio.

taskId
  • string

Identificador de la tarea.

JobProperties

Detalles de datos personalizados del trabajo.

Name Type Description
activityId
  • string

Identificador de actividad.

allowedActions
  • string[]

La acción Permitido del trabajo.

customDetails JobDetails:

Los detalles del trabajo personalizado, como los detalles del trabajo de conmutación por error de prueba.

endTime
  • string

Hora de finalización.

errors

Los errores.

friendlyName
  • string

The DisplayName.

scenarioName
  • string

The ScenarioName.

startTime
  • string

Hora de inicio.

state
  • string

Estado del trabajo. Es uno de estos valores: NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended u Other.

stateDescription
  • string

Descripción del estado del trabajo. Por ejemplo: para el estado Correcto, la descripción puede ser Completed, ParcialmenteSucceeded, CompletedWithInformation o Skipped.

targetInstanceType
  • string

Tipo del objeto afectado que es de Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType clase.

targetObjectId
  • string

Identificador de objeto afectado.

targetObjectName
  • string

Nombre del objeto afectado.

tasks

Las tareas.

ManualActionTaskDetails

Esta clase representa los detalles de la tarea de acción manual.

Name Type Description
instanceType string:

Tipo de detalles de la tarea.

instructions
  • string

Las instrucciones.

name
  • string

Nombre.

observation
  • string

La observación.

ProviderError

Esta clase contiene los detalles de error por objeto.

Name Type Description
errorCode
  • integer

Código de error.

errorId
  • string

Identificador de error del proveedor.

errorMessage
  • string

Mensaje de error.

possibleCauses
  • string

Causas posibles del error.

recommendedAction
  • string

Acción recomendada para resolver el error.

ScriptActionTaskDetails

Esta clase representa los detalles de la tarea de acción de script.

Name Type Description
instanceType string:

Tipo de detalles de la tarea.

isPrimarySideScript
  • boolean

Valor que indica si es un script del lado principal o no.

name
  • string

Nombre.

output
  • string

Salida.

path
  • string

La ruta de acceso.

ServiceError

Modelo de error de ASR.

Name Type Description
activityId
  • string

Id. de actividad.

code
  • string

Código de error.

message
  • string

Mensaje de error.

possibleCauses
  • string

Posibles causas de error.

recommendedAction
  • string

Acción recomendada para resolver el error.

SwitchProtectionJobDetails

Esta clase representa los detalles del trabajo de protección de conmutadores.

Name Type Description
affectedObjectDetails
  • object

Las propiedades de objeto afectadas, como el servidor de origen, la nube de origen, el servidor de destino, la nube de destino, etc. en función de los detalles del objeto de flujo de trabajo.

instanceType string:

Obtiene el tipo de detalles del trabajo (vea Enumeración JobDetailsTypes para conocer los valores posibles).

newReplicationProtectedItemId
  • string

Id. de ARM del nuevo elemento protegido de replicación.

TestFailoverJobDetails

Esta clase representa los detalles de un trabajo de conmutación por error de prueba.

Name Type Description
affectedObjectDetails
  • object

Las propiedades de objeto afectadas, como el servidor de origen, la nube de origen, el servidor de destino, la nube de destino, etc. en función de los detalles del objeto de flujo de trabajo.

comments
  • string

Comentarios de conmutación por error de prueba.

instanceType string:

Obtiene el tipo de detalles del trabajo (vea Enumeración JobDetailsTypes para conocer los valores posibles).

networkFriendlyName
  • string

Nombre descriptivo de la red de prueba.

networkName
  • string

Nombre de red de prueba.

networkType
  • string

El tipo de red de prueba (consulte la enumeración TestFailoverInput para ver los valores posibles).

protectedItemDetails

Detalles de la máquina virtual de prueba.

testFailoverStatus
  • string

Estado de conmutación por error de prueba.

VmNicUpdatesTaskDetails

Esta clase representa los detalles de la tarea vm NicUpdates.

Name Type Description
instanceType string:

Tipo de detalles de la tarea.

name
  • string

Nombre de la Nic.

nicId
  • string

Nic Id.

vmId
  • string

Id. de máquina virtual.