Azure Site Recovery Replication Jobs API

openapi: 3.2.0
info:
  title: Microsoft Azure Site Recovery Replication Jobs API
  version: '2026-11-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged ReplicationJobs across 2 of this provider''s published API definitions: microsoft-azure-site-recovery-service-2026-11-01.json, microsoft-azure-site-recovery-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ReplicationJobs
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs
  : get:
      operationId: ReplicationJobs_List
      tags:
      - ReplicationJobs
      summary: Gets the list of jobs
      description: Gets the list of Azure Site Recovery Jobs for the vault.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: $filter
        in: query
        description: OData filter options.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobCollection'
      x-ms-examples:
        Gets the list of jobs.:
          $ref: ./examples/ReplicationJobs_List.json
      x-ms-pageable:
        nextLinkName: nextLink
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}
  : get:
      operationId: ReplicationJobs_Get
      tags:
      - ReplicationJobs
      summary: Gets the job details
      description: Get the details of an Azure Site Recovery job.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: jobName
        in: path
        description: Job identifier.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
      x-ms-examples:
        Gets the job details.:
          $ref: ./examples/ReplicationJobs_Get.json
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/cancel
  : post:
      operationId: ReplicationJobs_Cancel
      tags:
      - ReplicationJobs
      summary: Cancels the specified job
      description: The operation to cancel an Azure Site Recovery job.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: jobName
        in: path
        description: Job identifier.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
      x-ms-examples:
        Cancels the specified job.:
          $ref: ./examples/ReplicationJobs_Cancel.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Job'
      x-ms-long-running-operation: true
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/restart
  : post:
      operationId: ReplicationJobs_Restart
      tags:
      - ReplicationJobs
      summary: Restarts the specified job
      description: The operation to restart an Azure Site Recovery job.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: jobName
        in: path
        description: Job identifier.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
      x-ms-examples:
        Restarts the specified job.:
          $ref: ./examples/ReplicationJobs_Restart.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Job'
      x-ms-long-running-operation: true
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/resume
  : post:
      operationId: ReplicationJobs_Resume
      tags:
      - ReplicationJobs
      summary: Resumes the specified job
      description: The operation to resume an Azure Site Recovery job.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the Vault
        required: true
        schema:
          type: string
      - name: jobName
        in: path
        description: Job identifier.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
      x-ms-examples:
        Resumes the specified job.:
          $ref: ./examples/ReplicationJobs_Resume.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Job'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResumeJobParams'
        description: Resume rob comments.
        required: true
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/export
  : post:
      operationId: ReplicationJobs_Export
      tags:
      - ReplicationJobs
      summary: Exports the details of the Azure Site Recovery jobs of the vault
      description: The operation to export the details of the Azure Site Recovery jobs of the vault.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: resourceName
        in: path
        description: The name of the recovery services vault.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
      x-ms-examples:
        Exports the details of the Azure Site Recovery jobs of the vault.:
          $ref: ./examples/ReplicationJobs_Export.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/Job'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobQueryParameter'
        description: The request body
        required: true
    servers:
    - url: https://management.azure.com
components:
  schemas:
    ResumeJobParams:
      type: object
      description: Resume job params.
      properties:
        properties:
          $ref: '#/components/schemas/ResumeJobParamsProperties'
          description: Resume job properties.
    JobErrorDetails:
      type: object
      description: This class contains the error details per object.
      properties:
        serviceErrorDetails:
          $ref: '#/components/schemas/ServiceError'
          description: The Service error details.
        providerErrorDetails:
          $ref: '#/components/schemas/ProviderError'
          description: The Provider error details.
        errorLevel:
          type: string
          description: Error level of error.
        creationTime:
          type: string
          format: date-time
          description: The creation time of job error.
        taskId:
          type: string
          description: The Id of the task.
    ProviderError:
      type: object
      description: This class contains the error details per object.
      properties:
        errorCode:
          type: integer
          format: int32
          description: The Error code.
        errorMessage:
          type: string
          description: The Error message.
        errorId:
          type: string
          description: The Provider error Id.
        possibleCauses:
          type: string
          description: The possible causes for the error.
        recommendedAction:
          type: string
          description: The recommended action to resolve the error.
    ASRTask:
      type: object
      description: Task of the Job.
      properties:
        taskId:
          type: string
          description: The Id.
        name:
          type: string
          description: The unique Task name.
        startTime:
          type: string
          format: date-time
          description: The start time.
        endTime:
          type: string
          format: date-time
          description: The end time.
        allowedActions:
          type: array
          description: The state/actions applicable on this task.
          items:
            type: string
        friendlyName:
          type: string
          description: The name.
        state:
          type: string
          description: The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.
        stateDescription:
          type: string
          description: The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.
        taskType:
          type: string
          description: The type of task. Details in CustomDetails property depend on this type.
        customDetails:
          $ref: '#/components/schemas/TaskTypeDetails'
          description: The custom task details based on the task type.
        groupTaskCustomDetails:
          $ref: '#/components/schemas/GroupTaskDetails'
          description: The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it.
        errors:
          type: array
          description: The task error details.
          items:
            $ref: '#/components/schemas/JobErrorDetails'
    ServiceError:
      type: object
      description: ASR error model.
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Error message.
        possibleCauses:
          type: string
          description: Possible causes of error.
        recommendedAction:
          type: string
          description: Recommended action to resolve error.
        activityId:
          type: string
          description: Activity Id.
    Job:
      type: object
      description: Job details.
      properties:
        properties:
          $ref: '#/components/schemas/JobProperties'
          description: The custom data.
        location:
          type: string
          description: Resource Location
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    JobDetails:
      type: object
      description: Job details based on specific job type.
      properties:
        instanceType:
          type: string
          description: Gets the type of job details (see JobDetailsTypes enum for possible values).
        affectedObjectDetails:
          type: object
          description: The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details.
          additionalProperties:
            type: string
      discriminator:
        propertyName: instanceType
      required:
      - instanceType
    GroupTaskDetails:
      type: object
      description: This class represents the group task details when parent child relationship exists in the drill down.
      properties:
        instanceType:
          type: string
          description: The type of task details.
        childTasks:
          type: array
          description: The child tasks.
          items:
            $ref: '#/components/schemas/ASRTask'
      discriminator:
        propertyName: instanceType
      required:
      - instanceType
    TaskTypeDetails:
      type: object
      description: Task details based on specific task type.
      properties:
        instanceType:
          type: string
          description: The type of task details.
      discriminator:
        propertyName: instanceType
      required:
      - instanceType
    JobCollection:
      type: object
      description: Collection of jobs.
      properties:
        value:
          type: array
          description: The Job items on this page
          items:
            $ref: '#/components/schemas/Job'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    JobProperties:
      type: object
      description: Job custom data details.
      properties:
        activityId:
          type: string
          description: The activity id.
        scenarioName:
          type: string
          description: The ScenarioName.
        friendlyName:
          type: string
          description: The DisplayName.
        state:
          type: string
          description: The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.
        stateDescription:
          type: string
          description: The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.
        tasks:
          type: array
          description: The tasks.
          items:
            $ref: '#/components/schemas/ASRTask'
        errors:
          type: array
          description: The errors.
          items:
            $ref: '#/components/schemas/JobErrorDetails'
        startTime:
          type: string
          format: date-time
          description: The start time.
        endTime:
          type: string
          format: date-time
          description: The end time.
        allowedActions:
          type: array
          description: The Allowed action the job.
          items:
            type: string
        targetObjectId:
          type: string
          description: The affected Object Id.
        targetObjectName:
          type: string
          description: The name of the affected object.
        targetInstanceType:
          type: string
          description: The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class.
        customDetails:
          $ref: '#/components/schemas/JobDetails'
          description: The custom job details like test failover job details.
    ResumeJobParamsProperties:
      type: object
      description: Resume job properties.
      properties:
        comments:
          type: string
          description: Resume job comments.
    ExportJobOutputSerializationType:
      type: string
      description: The output type of the jobs.
      enum:
      - Json
      - Xml
      - Excel
      x-ms-enum:
        name: ExportJobOutputSerializationType
        modelAsString: true
        values:
        - name: Json
          value: Json
          description: Json
        - name: Xml
          value: Xml
          description: Xml
        - name: Excel
          value: Excel
          description: Excel
    JobQueryParameter:
      type: object
      description: Query parameter to enumerate jobs.
      properties:
        startTime:
          type: string
          description: Date time to get jobs from.
        endTime:
          type: string
          description: Date time to get jobs upto.
        fabricId:
          type: string
          description: The Id of the fabric to search jobs under.
        affectedObjectTypes:
          type: string
          description: The type of objects.
        jobStatus:
          type: string
          description: The states of the job to be filtered can be in.
        jobOutputType:
          $ref: '#/components/schemas/ExportJobOutputSerializationType'
          description: The output type of the jobs.
        jobName:
          type: string
          description: The job Name.
        timezoneOffset:
          type: number
          format: double
          description: The timezone offset for the location of the request (in minutes).
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- microsoft-azure-site-recovery-service-2026-11-01.json
- microsoft-azure-site-recovery-openapi.yml