Azure Automation Source Control API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Source Control API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged SourceControl 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: Source Control
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls
  : get:
      operationId: SourceControl_ListByAutomationAccount
      tags:
      - Source Control
      description: Retrieve a list of source controls.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/sourcecontroloperations
      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: $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/SourceControlListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List sourceControls:
          $ref: ./examples/sourceControl/getAllSourceControls.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Source control 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}
  : get:
      operationId: SourceControl_Get
      tags:
      - Source Control
      description: Retrieve the source control identified by source control name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/sourcecontroloperations
      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
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceControl'
        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:
          $ref: ./examples/sourceControl/getSourceControl.json
      summary: Source control get
      x-summary-source: derived
    put:
      operationId: SourceControl_CreateOrUpdate
      tags:
      - Source Control
      description: Create a source control.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/sourcecontroloperations
      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
      responses:
        '200':
          description: Resource 'SourceControl' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceControl'
        '201':
          description: Resource 'SourceControl' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceControl'
        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:
          $ref: ./examples/sourceControl/createOrUpdateSourceControl.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourceControlCreateOrUpdateParameters'
        description: The parameters supplied to the create or update source control operation.
        required: true
      summary: Source control create or update
      x-summary-source: derived
    patch:
      operationId: SourceControl_Update
      tags:
      - Source Control
      description: Update a source control.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/sourcecontroloperations
      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
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceControl'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Update a source control:
          $ref: ./examples/sourceControl/updateSourceControl_patch.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourceControlUpdateParameters'
        description: The parameters supplied to the update source control operation.
        required: true
      summary: Source control update
      x-summary-source: derived
    delete:
      operationId: SourceControl_Delete
      tags:
      - Source Control
      description: Delete the source control.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/sourcecontroloperations
      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
      responses:
        '200':
          description: Resource deleted successfully.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete a source control:
          $ref: ./examples/sourceControl/deleteSourceControl.json
      summary: Source control delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    SourceControlUpdateProperties:
      type: object
      description: The properties of the update source control
      properties:
        branch:
          type: string
          description: The repo branch of the source control.
        folderPath:
          type: string
          description: The folder path of the source control. Path must be relative.
        autoSync:
          type: boolean
          description: The auto sync of the source control. Default is false.
        publishRunbook:
          type: boolean
          description: The auto publish of the source control. Default is true.
        securityToken:
          $ref: '#/components/schemas/SourceControlSecurityTokenProperties'
          description: The authorization token for the repo of the source control.
        description:
          type: string
          description: The user description of the source control.
    SourceControl:
      type: object
      description: Definition of the source control.
      properties:
        properties:
          $ref: '#/components/schemas/SourceControlProperties'
          description: The properties of the source control.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    SourceControlListResult:
      type: object
      description: The response of a SourceControl list operation.
      properties:
        value:
          type: array
          description: The SourceControl items on this page
          items:
            $ref: '#/components/schemas/SourceControl'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    SourceControlUpdateParameters:
      type: object
      description: The parameters supplied to the update source control operation.
      properties:
        properties:
          $ref: '#/components/schemas/SourceControlUpdateProperties'
          description: The value of the source control.
          x-ms-client-flatten: true
    SourceControlCreateOrUpdateParameters:
      type: object
      description: The parameters supplied to the create or update source control operation.
      properties:
        properties:
          $ref: '#/components/schemas/SourceControlCreateOrUpdateProperties'
          description: The properties of the source control.
          x-ms-client-flatten: true
      required:
      - properties
    TokenType:
      type: string
      description: The token type. Must be either PersonalAccessToken or Oauth.
      enum:
      - PersonalAccessToken
      - Oauth
      x-ms-enum:
        name: TokenType
        modelAsString: true
        values:
        - name: PersonalAccessToken
          value: PersonalAccessToken
          description: PersonalAccessToken
        - name: Oauth
          value: Oauth
          description: Oauth
    SourceControlSecurityTokenProperties:
      type: object
      properties:
        accessToken:
          type: string
          description: The access token.
          maxLength: 1024
        refreshToken:
          type: string
          description: The refresh token.
          maxLength: 1024
        tokenType:
          $ref: '#/components/schemas/TokenType'
          description: The token type. Must be either PersonalAccessToken or Oauth.
    SourceControlCreateOrUpdateProperties:
      type: object
      description: The properties of the create source control operation.
      properties:
        repoUrl:
          type: string
          description: The repo url of the source control.
          maxLength: 2000
        branch:
          type: string
          description: The repo branch of the source control. Include branch as empty string for VsoTfvc.
          maxLength: 255
        folderPath:
          type: string
          description: The folder path of the source control. Path must be relative.
          maxLength: 255
        autoSync:
          type: boolean
          description: The auto async of the source control. Default is false.
        publishRunbook:
          type: boolean
          description: The auto publish of the source control. Default is true.
        sourceType:
          $ref: '#/components/schemas/SourceType'
          description: The source type. Must be one of VsoGit, VsoTfvc, GitHub, case sensitive.
        securityToken:
          $ref: '#/components/schemas/SourceControlSecurityTokenProperties'
          description: The authorization token for the repo of the source control.
        description:
          type: string
          description: The user description of the source control.
          maxLength: 512
    SourceControlProperties:
      type: object
      description: Definition of the source control properties
      properties:
        repoUrl:
          type: string
          description: The repo url of the source control.
        branch:
          type: string
          description: The repo branch of the source control. Include branch as empty string for VsoTfvc.
        folderPath:
          type: string
          description: The folder path of the source control.
        autoSync:
          type: boolean
          description: The auto sync of the source control. Default is false.
        publishRunbook:
          type: boolean
          description: The auto publish of the source control. Default is true.
        sourceType:
          $ref: '#/components/schemas/SourceType'
          description: The source type. Must be one of VsoGit, VsoTfvc, GitHub.
        description:
          type: string
          description: The description.
        creationTime:
          type: string
          format: date-time
          description: The creation time.
        lastModifiedTime:
          type: string
          format: date-time
          description: The last modified time.
    SourceType:
      type: string
      description: The source type. Must be one of VsoGit, VsoTfvc, GitHub.
      enum:
      - VsoGit
      - VsoTfvc
      - GitHub
      x-ms-enum:
        name: SourceType
        modelAsString: true
        values:
        - name: VsoGit
          value: VsoGit
          description: VsoGit
        - name: VsoTfvc
          value: VsoTfvc
          description: VsoTfvc
        - name: GitHub
          value: GitHub
          description: GitHub
  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