Azure Automation Schedule API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Schedule API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged Schedule 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: Schedule
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/schedules
  : get:
      operationId: Schedule_ListByAutomationAccount
      tags:
      - Schedule
      description: Retrieve a list of schedules.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/scheduleoperations
      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
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List schedules by automation account, first 100:
          $ref: ./examples/listSchedulesByAutomationAccount_First100.json
        List schedules by automation account, next 100:
          $ref: ./examples/listSchedulesByAutomationAccount_Next100.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Schedule list by automation account
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/schedules/{scheduleName}
  : get:
      operationId: Schedule_Get
      tags:
      - Schedule
      description: Retrieve the schedule identified by schedule name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/scheduleoperations
      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: scheduleName
        in: path
        description: The schedule name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
        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 schedule:
          $ref: ./examples/getSchedule.json
      summary: Schedule get
      x-summary-source: derived
    put:
      operationId: Schedule_CreateOrUpdate
      tags:
      - Schedule
      description: Create a schedule.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/scheduleoperations
      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: scheduleName
        in: path
        description: The schedule name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'Schedule' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
        '201':
          description: Resource 'Schedule' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
        '409':
          description: The request conflicts with the current state of the server.
        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 schedule:
          $ref: ./examples/createOrUpdateSchedule.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleCreateOrUpdateParameters'
        description: The parameters supplied to the create or update schedule operation.
        required: true
      summary: Schedule create or update
      x-summary-source: derived
    patch:
      operationId: Schedule_Update
      tags:
      - Schedule
      description: Update the schedule identified by schedule name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/scheduleoperations
      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: scheduleName
        in: path
        description: The schedule name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
        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 schedule:
          $ref: ./examples/updateSchedule.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleUpdateParameters'
        description: The parameters supplied to the update schedule operation.
        required: true
      summary: Schedule update
      x-summary-source: derived
    delete:
      operationId: Schedule_Delete
      tags:
      - Schedule
      description: Delete the schedule identified by schedule name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/scheduleoperations
      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: scheduleName
        in: path
        description: The schedule name.
        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 schedule:
          $ref: ./examples/deleteSchedule.json
      summary: Schedule delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    ScheduleCreateOrUpdateProperties:
      type: object
      description: The parameters supplied to the create or update schedule operation.
      properties:
        description:
          type: string
          description: Gets or sets the description of the schedule.
        startTime:
          type: string
          format: date-time
          description: Gets or sets the start time of the schedule.
        expiryTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the end time of the schedule.
        interval:
          description: Gets or sets the interval of the schedule.
        frequency:
          $ref: '#/components/schemas/ScheduleFrequency'
          description: Gets or sets the frequency of the schedule.
        timeZone:
          type: string
          description: Gets or sets the time zone of the schedule.
        advancedSchedule:
          $ref: '#/components/schemas/AdvancedSchedule'
          description: Gets or sets the AdvancedSchedule.
      required:
      - startTime
      - frequency
    Schedule:
      type: object
      description: Definition of the schedule.
      properties:
        properties:
          $ref: '#/components/schemas/ScheduleProperties'
          description: Gets or sets the properties of the schedule.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    ScheduleProperties:
      type: object
      description: Definition of schedule parameters.
      properties:
        startTime:
          type: string
          format: date-time
          description: Gets or sets the start time of the schedule.
        startTimeOffsetMinutes:
          type: number
          format: double
          description: Gets the start time's offset in minutes.
          readOnly: true
        expiryTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the end time of the schedule.
        expiryTimeOffsetMinutes:
          type: number
          format: double
          description: Gets or sets the expiry time's offset in minutes.
        isEnabled:
          type: boolean
          description: Gets or sets a value indicating whether this schedule is enabled.
        nextRun:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the next run time of the schedule.
        nextRunOffsetMinutes:
          type: number
          format: double
          description: Gets or sets the next run time's offset in minutes.
        interval:
          description: Gets or sets the interval of the schedule.
        frequency:
          $ref: '#/components/schemas/ScheduleFrequency'
          description: Gets or sets the frequency of the schedule.
        timeZone:
          type: string
          description: Gets or sets the time zone of the schedule.
        advancedSchedule:
          $ref: '#/components/schemas/AdvancedSchedule'
          description: Gets or sets the advanced schedule.
        creationTime:
          type: string
          format: date-time
          description: Gets or sets the creation time.
        lastModifiedTime:
          type: string
          format: date-time
          description: Gets or sets the last modified time.
        description:
          type: string
          description: Gets or sets the description.
    AdvancedScheduleMonthlyOccurrence:
      type: object
      description: The properties of the create advanced schedule monthly occurrence.
      properties:
        occurrence:
          type: integer
          format: int32
          description: Occurrence of the week within the month. Must be between 1 and 5
        day:
          $ref: '#/components/schemas/ScheduleDay'
          description: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
    ScheduleUpdateParameters:
      type: object
      description: The parameters supplied to the update schedule operation.
      properties:
        name:
          type: string
          description: Gets or sets the name of the Schedule.
        properties:
          $ref: '#/components/schemas/ScheduleUpdateProperties'
          description: Gets or sets the list of schedule properties.
          x-ms-client-flatten: true
    ScheduleListResult:
      type: object
      description: The response of a Schedule list operation.
      properties:
        value:
          type: array
          description: The Schedule items on this page
          items:
            $ref: '#/components/schemas/Schedule'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ScheduleFrequency:
      type: string
      description: Gets or sets the frequency of the schedule.
      enum:
      - OneTime
      - Day
      - Hour
      - Week
      - Month
      - Minute
      x-ms-enum:
        name: ScheduleFrequency
        modelAsString: true
        values:
        - name: OneTime
          value: OneTime
          description: OneTime
        - name: Day
          value: Day
          description: Day
        - name: Hour
          value: Hour
          description: Hour
        - name: Week
          value: Week
          description: Week
        - name: Month
          value: Month
          description: Month
        - name: Minute
          value: Minute
          description: The minimum allowed interval for Minute schedules is 15 minutes.
    ScheduleCreateOrUpdateParameters:
      type: object
      description: The parameters supplied to the create or update schedule operation.
      properties:
        name:
          type: string
          description: Gets or sets the name of the Schedule.
        properties:
          $ref: '#/components/schemas/ScheduleCreateOrUpdateProperties'
          description: Gets or sets the list of schedule properties.
          x-ms-client-flatten: true
      required:
      - name
      - properties
    AdvancedSchedule:
      type: object
      description: The properties of the create Advanced Schedule.
      properties:
        weekDays:
          type: array
          description: Days of the week that the job should execute on.
          items:
            type: string
        monthDays:
          type: array
          description: Days of the month that the job should execute on. Must be between 1 and 31.
          items:
            type: integer
            format: int32
        monthlyOccurrences:
          type: array
          description: Occurrences of days within a month.
          items:
            $ref: '#/components/schemas/AdvancedScheduleMonthlyOccurrence'
          x-ms-identifiers: []
    ScheduleUpdateProperties:
      type: object
      description: The parameters supplied to the update schedule operation.
      properties:
        description:
          type: string
          description: Gets or sets the description of the schedule.
        isEnabled:
          type: boolean
          description: Gets or sets a value indicating whether this schedule is enabled.
    ScheduleDay:
      type: string
      description: Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
      enum:
      - Monday
      - Tuesday
      - Wednesday
      - Thursday
      - Friday
      - Saturday
      - Sunday
      x-ms-enum:
        name: ScheduleDay
        modelAsString: true
        values:
        - name: Monday
          value: Monday
          description: Monday
        - name: Tuesday
          value: Tuesday
          description: Tuesday
        - name: Wednesday
          value: Wednesday
          description: Wednesday
        - name: Thursday
          value: Thursday
          description: Thursday
        - name: Friday
          value: Friday
          description: Friday
        - name: Saturday
          value: Saturday
          description: Saturday
        - name: Sunday
          value: Sunday
          description: Sunday
  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