Azure DevTest Labs Schedules API

openapi: 3.2.0
info:
  description: The DevTest Labs Client.
  title: DevTestLabsClient Schedules API
  version: '2018-09-15'
  x-apisguru-categories:
  - cloud
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png
  x-origin:
  - format: swagger
    url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json
    version: '2.0'
  x-preferred: true
  x-providerName: azure.com
  x-serviceName: devtestlabs-DTL
  x-tags:
  - Azure
  - Microsoft
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Schedules
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules:
    get:
      description: List schedules in a given lab.
      operationId: Schedules_List
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - description: The name of the lab.
        in: path
        name: labName
        required: true
        example: example-value
        schema:
          type: string
      - description: 'Specify the $expand query. Example: ''properties($select=status)'''
        in: query
        name: $expand
        example: example-value
        schema:
          type: string
      - description: 'The filter to apply to the operation. Example: ''$filter=contains(name,''myName'')'
        in: query
        name: $filter
        example: example-value
        schema:
          type: string
      - description: 'The maximum number of resources to return from the operation. Example: ''$top=10'''
        in: query
        name: $top
        example: example-value
        schema:
          type: integer
          format: int32
      - description: 'The ordering expression for the results, using OData notation. Example: ''$orderby=name desc'''
        in: query
        name: $orderby
        example: example-value
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleList'
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Schedules
      x-ms-odata: '#/definitions/Schedule'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Azure DevTest Labs Schedules_ List
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}
  : delete:
      description: Delete schedule.
      operationId: Schedules_Delete
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - description: The name of the lab.
        in: path
        name: labName
        required: true
        example: example-value
        schema:
          type: string
      - description: The name of the schedule.
        in: path
        name: name
        required: true
        example: example-value
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
        '204':
          description: No Content
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Schedules
      summary: Azure DevTest Labs Schedules_ Delete
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      description: Get schedule.
      operationId: Schedules_Get
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - description: The name of the lab.
        in: path
        name: labName
        required: true
        example: example-value
        schema:
          type: string
      - description: The name of the schedule.
        in: path
        name: name
        required: true
        example: example-value
        schema:
          type: string
      - description: 'Specify the $expand query. Example: ''properties($select=status)'''
        in: query
        name: $expand
        example: example-value
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Schedules
      summary: Azure DevTest Labs Schedules_ Get
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      description: Allows modifying tags of schedules. All other properties will be ignored.
      operationId: Schedules_Update
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - description: The name of the lab.
        in: path
        name: labName
        required: true
        example: example-value
        schema:
          type: string
      - description: The name of the schedule.
        in: path
        name: name
        required: true
        example: example-value
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Schedules
      summary: Azure DevTest Labs Schedules_ Update
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleFragment'
        description: A schedule.
        required: true
    put:
      description: Create or replace an existing schedule.
      operationId: Schedules_CreateOrUpdate
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - description: The name of the lab.
        in: path
        name: labName
        required: true
        example: example-value
        schema:
          type: string
      - description: The name of the schedule.
        in: path
        name: name
        required: true
        example: example-value
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Schedules
      summary: Azure DevTest Labs Schedules_ Create or Update
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Schedule'
        description: A schedule.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/execute
  : post:
      description: Execute a schedule. This operation can take a while to complete.
      operationId: Schedules_Execute
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - description: The name of the lab.
        in: path
        name: labName
        required: true
        example: example-value
        schema:
          type: string
      - description: The name of the schedule.
        in: path
        name: name
        required: true
        example: example-value
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Schedules
      x-ms-long-running-operation: true
      summary: Azure DevTest Labs Schedules_ Execute
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/listApplicable
  : post:
      description: Lists all applicable schedules
      operationId: Schedules_ListApplicable
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - description: The name of the lab.
        in: path
        name: labName
        required: true
        example: example-value
        schema:
          type: string
      - description: The name of the schedule.
        in: path
        name: name
        required: true
        example: example-value
        schema:
          type: string
      - $ref: '#/components/parameters/api-version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleList'
        default:
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      tags:
      - Schedules
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Azure DevTest Labs Schedules_ List Applicable
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    DayDetails:
      description: Properties of a daily schedule.
      properties:
        time:
          description: The time of day the schedule will occur.
          type: string
      type: object
    Schedule:
      allOf:
      - $ref: '#/components/schemas/Resource'
      description: A schedule.
      properties:
        properties:
          $ref: '#/components/schemas/ScheduleProperties'
          description: The properties of the resource.
          x-ms-client-flatten: true
      required:
      - properties
      type: object
    ScheduleList:
      description: The response of a list operation.
      properties:
        nextLink:
          description: Link for next set of results.
          type: string
        value:
          description: Results of the list operation.
          items:
            $ref: '#/components/schemas/Schedule'
          type: array
      type: object
    DayDetailsFragment:
      description: Properties of a daily schedule.
      properties:
        time:
          description: The time of day the schedule will occur.
          type: string
      type: object
    WeekDetailsFragment:
      description: Properties of a weekly schedule.
      properties:
        time:
          description: The time of the day the schedule will occur.
          type: string
        weekdays:
          description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).
          items:
            type: string
          type: array
      type: object
    NotificationSettingsFragment:
      description: Notification settings for a schedule.
      properties:
        emailRecipient:
          description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
          type: string
        notificationLocale:
          description: The locale to use when sending a notification (fallback for unsupported languages is EN).
          type: string
        status:
          description: If notifications are enabled for this schedule (i.e. Enabled, Disabled).
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            modelAsString: true
            name: EnableStatus
        timeInMinutes:
          description: Time in minutes before event at which notification will be sent.
          format: int32
          type: integer
        webhookUrl:
          description: The webhook URL to which the notification will be sent.
          type: string
      type: object
    SchedulePropertiesFragment:
      description: Properties of a schedule.
      properties:
        dailyRecurrence:
          $ref: '#/components/schemas/DayDetailsFragment'
          description: If the schedule will occur once each day of the week, specify the daily recurrence.
        hourlyRecurrence:
          $ref: '#/components/schemas/HourDetailsFragment'
          description: If the schedule will occur multiple times a day, specify the hourly recurrence.
        notificationSettings:
          $ref: '#/components/schemas/NotificationSettingsFragment'
          description: Notification settings.
        status:
          description: The status of the schedule (i.e. Enabled, Disabled)
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            modelAsString: true
            name: EnableStatus
        targetResourceId:
          description: The resource ID to which the schedule belongs
          type: string
        taskType:
          description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
          type: string
        timeZoneId:
          description: The time zone ID (e.g. Pacific Standard time).
          type: string
        weeklyRecurrence:
          $ref: '#/components/schemas/WeekDetailsFragment'
          description: If the schedule will occur only some days of the week, specify the weekly recurrence.
      type: object
    UpdateResource:
      description: Represents an update resource
      properties:
        tags:
          additionalProperties:
            type: string
          description: The tags of the resource.
          type: object
      type: object
    Resource:
      description: An Azure resource.
      properties:
        id:
          description: The identifier of the resource.
          readOnly: true
          type: string
        location:
          description: The location of the resource.
          type: string
        name:
          description: The name of the resource.
          readOnly: true
          type: string
        tags:
          additionalProperties:
            type: string
          description: The tags of the resource.
          type: object
        type:
          description: The type of the resource.
          readOnly: true
          type: string
      type: object
      x-ms-azure-resource: true
    ScheduleFragment:
      allOf:
      - $ref: '#/components/schemas/UpdateResource'
      description: A schedule.
      properties:
        properties:
          $ref: '#/components/schemas/SchedulePropertiesFragment'
          description: The properties of the resource.
          x-ms-client-flatten: true
      type: object
    ScheduleProperties:
      description: Properties of a schedule.
      properties:
        createdDate:
          description: The creation date of the schedule.
          format: date-time
          readOnly: true
          type: string
        dailyRecurrence:
          $ref: '#/components/schemas/DayDetails'
          description: If the schedule will occur once each day of the week, specify the daily recurrence.
        hourlyRecurrence:
          $ref: '#/components/schemas/HourDetails'
          description: If the schedule will occur multiple times a day, specify the hourly recurrence.
        notificationSettings:
          $ref: '#/components/schemas/NotificationSettings'
          description: Notification settings.
        provisioningState:
          description: The provisioning status of the resource.
          readOnly: true
          type: string
        status:
          description: The status of the schedule (i.e. Enabled, Disabled)
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            modelAsString: true
            name: EnableStatus
        targetResourceId:
          description: The resource ID to which the schedule belongs
          type: string
        taskType:
          description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
          type: string
        timeZoneId:
          description: The time zone ID (e.g. Pacific Standard time).
          type: string
        uniqueIdentifier:
          description: The unique immutable identifier of a resource (Guid).
          readOnly: true
          type: string
        weeklyRecurrence:
          $ref: '#/components/schemas/WeekDetails'
          description: If the schedule will occur only some days of the week, specify the weekly recurrence.
      type: object
    HourDetailsFragment:
      description: Properties of an hourly schedule.
      properties:
        minute:
          description: Minutes of the hour the schedule will run.
          format: int32
          type: integer
      type: object
    WeekDetails:
      description: Properties of a weekly schedule.
      properties:
        time:
          description: The time of the day the schedule will occur.
          type: string
        weekdays:
          description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).
          items:
            type: string
          type: array
      type: object
    HourDetails:
      description: Properties of an hourly schedule.
      properties:
        minute:
          description: Minutes of the hour the schedule will run.
          format: int32
          type: integer
      type: object
    CloudError:
      description: Error from a REST request.
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
          description: The cloud error that occurred
      type: object
      x-ms-external: true
    NotificationSettings:
      description: Notification settings for a schedule.
      properties:
        emailRecipient:
          description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
          type: string
        notificationLocale:
          description: The locale to use when sending a notification (fallback for unsupported languages is EN).
          type: string
        status:
          description: If notifications are enabled for this schedule (i.e. Enabled, Disabled).
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            modelAsString: true
            name: EnableStatus
        timeInMinutes:
          description: Time in minutes before event at which notification will be sent.
          format: int32
          type: integer
        webhookUrl:
          description: The webhook URL to which the notification will be sent.
          type: string
      type: object
    CloudErrorBody:
      description: Body of an error from a REST request.
      properties:
        code:
          description: The error code.
          type: string
        details:
          description: Inner errors.
          items:
            $ref: '#/components/schemas/CloudErrorBody'
          type: array
        message:
          description: The error message.
          type: string
        target:
          description: The error target.
          type: string
      type: object
      x-ms-external: true
  parameters:
    resourceGroupName:
      description: The name of the resource group.
      in: path
      name: resourceGroupName
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    api-version:
      description: Client API version.
      in: query
      name: api-version
      required: true
      schema:
        type: string
        default: '2018-09-15'
    subscriptionId:
      description: The subscription ID.
      in: path
      name: subscriptionId
      required: true
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: Access Microsoft Azure
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: OAuth2 Implicit Grant
x-provenance:
  method: harvested
  publisher: Azure DevTest Labs
  source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)