Azure Automation Source Control Sync Job API

The SourceControlSyncJob API from Azure Automation — 2 operation(s) for sourcecontrolsyncjob.

Documentation GitHub OpenAPI

Operations 3

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs Source control sync job list by automation account #

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs/{sourceControlSyncJobId} Source control sync job get #

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs/{sourceControlSyncJobId} Source control sync job create #

Documentation

📖

Documentation

https://learn.microsoft.com/en-us/rest/api/automation/

Specifications

⚙

OpenAPI

https://artifacts.apis.io/microsoft-azure-automation/openapi/microsoft-azure-automation-sourcecontrolsyncjob-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure-automation:microsoft-azure-automation-sourcecontrolsyncjob-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Source Control Sync Job API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged SourceControlSyncJob across 2 of this provider''s published API definitions: microsoft-azure-automation-openapi.json, microsoft-azure-automation-management-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: SourceControlSyncJob
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs
  : get:
      operationId: SourceControlSyncJob_ListByAutomationAccount
      tags:
      - SourceControlSyncJob
      description: Retrieve a list of source control sync jobs.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations
      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: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: sourceControlName
        in: path
        description: The name of source control.
        required: true
        schema:
          type: string
      - name: $filter
        in: query
        description: The filter to apply on the operation.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceControlSyncJobListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get a list of source control sync jobs:
          $ref: ./examples/sourceControlSyncJob/getAllSourceControlSyncJobs.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Source control sync job list by automation account
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName}/sourceControlSyncJobs/{sourceControlSyncJobId}
  : get:
      operationId: SourceControlSyncJob_Get
      tags:
      - SourceControlSyncJob
      description: Retrieve the source control sync job identified by job id.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations
      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: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: sourceControlName
        in: path
        description: The name of source control.
        required: true
        schema:
          type: string
      - name: sourceControlSyncJobId
        in: path
        description: The source control sync job id.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceControlSyncJobById'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get a source control sync job by job id:
          $ref: ./examples/sourceControlSyncJob/getSourceControlSyncJob.json
      summary: Source control sync job get
      x-summary-source: derived
    put:
      operationId: SourceControlSyncJob_Create
      tags:
      - SourceControlSyncJob
      description: Creates the sync job for a source control.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations
      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: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: sourceControlName
        in: path
        description: The name of source control.
        required: true
        schema:
          type: string
      - name: sourceControlSyncJobId
        in: path
        description: The source control sync job id.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '201':
          description: Resource 'SourceControlSyncJob' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceControlSyncJob'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create or update a source control sync job:
          $ref: ./examples/sourceControlSyncJob/createSourceControlSyncJob.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourceControlSyncJobCreateParameters'
        description: The parameters supplied to the create source control sync job operation.
        required: true
      summary: Source control sync job create
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    SourceControlSyncJobById:
      type: object
      description: Definition of the source control sync job.
      properties:
        id:
          type: string
          description: The id of the job.
        properties:
          $ref: '#/components/schemas/SourceControlSyncJobByIdProperties'
          description: The properties of the source control sync job.
          x-ms-client-flatten: true
    SyncType:
      type: string
      description: The sync type.
      enum:
      - PartialSync
      - FullSync
      x-ms-enum:
        name: SyncType
        modelAsString: true
        values:
        - name: PartialSync
          value: PartialSync
          description: PartialSync
        - name: FullSync
          value: FullSync
          description: FullSync
    SourceControlSyncJobCreateParameters:
      type: object
      description: The parameters supplied to the create source control sync job operation.
      properties:
        properties:
          $ref: '#/components/schemas/SourceControlSyncJobCreateProperties'
          description: The properties of the source control sync job.
          x-ms-client-flatten: true
      required:
      - properties
    SourceControlSyncJob:
      type: object
      description: Definition of the source control sync job.
      properties:
        name:
          type: string
          description: Resource name.
          readOnly: true
        type:
          type: string
          description: Resource type.
          readOnly: true
        id:
          type: string
          description: Resource id.
          readOnly: true
        properties:
          $ref: '#/components/schemas/SourceControlSyncJobProperties'
          description: The properties of the source control sync job.
          x-ms-client-flatten: true
    SourceControlSyncJobListResult:
      type: object
      description: The response of a SourceControlSyncJob list operation.
      properties:
        value:
          type: array
          description: The SourceControlSyncJob items on this page
          items:
            $ref: '#/components/schemas/SourceControlSyncJob'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    SourceControlSyncJobProperties:
      type: object
      description: Definition of source control sync job properties.
      properties:
        sourceControlSyncJobId:
          type: string
          description: The source control sync job id.
        creationTime:
          type: string
          format: date-time
          description: The creation time of the job.
          readOnly: true
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The provisioning state of the job.
        startTime:
          type:
          - string
          - 'null'
          format: date-time
          description: The start time of the job.
          readOnly: true
        endTime:
          type:
          - string
          - 'null'
          format: date-time
          description: The end time of the job.
          readOnly: true
        syncType:
          $ref: '#/components/schemas/SyncType'
          description: The sync type.
    SourceControlSyncJobCreateProperties:
      type: object
      description: Definition of create source control sync job properties.
      properties:
        commitId:
          type: string
          description: The commit id of the source control sync job. If not syncing to a commitId, enter an empty string.
          minLength: 0
      required:
      - commitId
    SourceControlSyncJobByIdProperties:
      type: object
      description: Definition of source control sync job properties.
      properties:
        sourceControlSyncJobId:
          type: string
          description: The source control sync job id.
        creationTime:
          type: string
          format: date-time
          description: The creation time of the job.
          readOnly: true
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The provisioning state of the job.
        startTime:
          type:
          - string
          - 'null'
          format: date-time
          description: The start time of the job.
          readOnly: true
        endTime:
          type:
          - string
          - 'null'
          format: date-time
          description: The end time of the job.
          readOnly: true
        syncType:
          $ref: '#/components/schemas/SyncType'
          description: The sync type.
        exception:
          type: string
          description: The exceptions that occurred while running the sync job.
    ProvisioningState:
      type: string
      description: The provisioning state of the job.
      enum:
      - Completed
      - Failed
      - Running
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
        values:
        - name: Completed
          value: Completed
          description: Completed
        - name: Failed
          value: Failed
          description: Failed
        - name: Running
          value: Running
          description: Running
  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-automation-openapi.json
- microsoft-azure-automation-management-openapi.yml