swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector VirtualMachineSchedules API
schemes:
- https
tags:
- name: VirtualMachineSchedules
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules
  : get:
      tags:
      - VirtualMachineSchedules
      description: List schedules in a given virtual machine.
      operationId: microsoftAzureVirtualmachineschedulesList
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: virtualMachineName
        in: path
        description: The name of the virtual machine.
        required: true
        type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=status)'''
        type: string
      - name: $filter
        in: query
        description: 'The filter to apply to the operation. Example: ''$filter=contains(name,''myName'')'
        type: string
      - name: $top
        in: query
        description: 'The maximum number of resources to return from the operation. Example: ''$top=10'''
        type: integer
        format: int32
      - name: $orderby
        in: query
        description: 'The ordering expression for the results, using OData notation. Example: ''$orderby=name desc'''
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ScheduleList'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/Schedule'
      x-ms-examples:
        VirtualMachineSchedules_List:
          $ref: ./examples/VirtualMachineSchedules_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Virtualmachinename Schedules
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}
  : get:
      tags:
      - VirtualMachineSchedules
      description: Get schedule.
      operationId: microsoftAzureVirtualmachineschedulesGet
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: virtualMachineName
        in: path
        description: The name of the virtual machine.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the schedule.
        required: true
        type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=status)'''
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Schedule'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        VirtualMachineSchedules_Get:
          $ref: ./examples/VirtualMachineSchedules_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Virtualmachinename Schedules Name
    put:
      tags:
      - VirtualMachineSchedules
      description: Create or replace an existing schedule.
      operationId: microsoftAzureVirtualmachineschedulesCreateorupdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: virtualMachineName
        in: path
        description: The name of the virtual machine.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the schedule.
        required: true
        type: string
      - name: schedule
        in: body
        description: A schedule.
        required: true
        schema:
          $ref: '#/definitions/Schedule'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Schedule'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/Schedule'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        VirtualMachineSchedules_CreateOrUpdate:
          $ref: ./examples/VirtualMachineSchedules_CreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Virtualmachinename Schedules Name
    delete:
      tags:
      - VirtualMachineSchedules
      description: Delete schedule.
      operationId: microsoftAzureVirtualmachineschedulesDelete
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: virtualMachineName
        in: path
        description: The name of the virtual machine.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the schedule.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
        '204':
          description: No Content
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        VirtualMachineSchedules_Delete:
          $ref: ./examples/VirtualMachineSchedules_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Virtualmachinename Schedules Name
    patch:
      tags:
      - VirtualMachineSchedules
      description: Allows modifying tags of schedules. All other properties will be ignored.
      operationId: microsoftAzureVirtualmachineschedulesUpdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: virtualMachineName
        in: path
        description: The name of the virtual machine.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the schedule.
        required: true
        type: string
      - name: schedule
        in: body
        description: A schedule.
        required: true
        schema:
          $ref: '#/definitions/ScheduleFragment'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Schedule'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        VirtualMachineSchedules_Update:
          $ref: ./examples/VirtualMachineSchedules_Update.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Virtualmachinename Schedules Name
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}/execute
  : post:
      tags:
      - VirtualMachineSchedules
      description: Execute a schedule. This operation can take a while to complete.
      operationId: microsoftAzureVirtualmachineschedulesExecute
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: virtualMachineName
        in: path
        description: The name of the virtual machine.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the schedule.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        VirtualMachineSchedules_Execute:
          $ref: ./examples/VirtualMachineSchedules_Execute.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Virtualmachinename Schedules Name Execute
definitions:
  ScheduleProperties:
    description: Properties of a schedule.
    type: object
    properties:
      status:
        description: The status of the schedule (i.e. Enabled, Disabled)
        default: Disabled
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: EnableStatus
          modelAsString: true
      taskType:
        description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
        type: string
      weeklyRecurrence:
        $ref: '#/definitions/WeekDetails'
        description: If the schedule will occur only some days of the week, specify the weekly recurrence.
      dailyRecurrence:
        $ref: '#/definitions/DayDetails'
        description: If the schedule will occur once each day of the week, specify the daily recurrence.
      hourlyRecurrence:
        $ref: '#/definitions/HourDetails'
        description: If the schedule will occur multiple times a day, specify the hourly recurrence.
      timeZoneId:
        description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
        type: string
      notificationSettings:
        $ref: '#/definitions/NotificationSettings'
        description: Notification settings.
      createdDate:
        format: date-time
        description: The creation date of the schedule.
        type: string
        readOnly: true
      targetResourceId:
        description: The resource ID to which the schedule belongs
        type: string
      provisioningState:
        description: The provisioning status of the resource.
        type: string
        readOnly: true
      uniqueIdentifier:
        description: The unique immutable identifier of a resource (Guid).
        type: string
        readOnly: true
  Resource:
    description: An Azure resource.
    type: object
    properties:
      id:
        description: The identifier of the resource.
        type: string
        readOnly: true
      name:
        description: The name of the resource.
        type: string
        readOnly: true
      type:
        description: The type of the resource.
        type: string
        readOnly: true
      location:
        description: The location of the resource.
        type: string
      tags:
        description: The tags of the resource.
        type: object
        additionalProperties:
          type: string
    x-ms-azure-resource: true
  ScheduleFragment:
    description: A schedule.
    type: object
    allOf:
    - $ref: '#/definitions/UpdateResource'
    properties: {}
  CloudError:
    description: Error from a REST request.
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: The cloud error that occurred
    x-ms-external: true
  ScheduleList:
    description: The response of a list operation.
    type: object
    properties:
      value:
        description: Results of the list operation.
        type: array
        items:
          $ref: '#/definitions/Schedule'
      nextLink:
        description: Link for next set of results.
        type: string
  WeekDetails:
    description: Properties of a weekly schedule.
    type: object
    properties:
      weekdays:
        description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).
        type: array
        items:
          type: string
      time:
        description: The time of the day the schedule will occur.
        type: string
  NotificationSettings:
    description: Notification settings for a schedule.
    type: object
    properties:
      status:
        description: If notifications are enabled for this schedule (i.e. Enabled, Disabled).
        default: Disabled
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: EnableStatus
          modelAsString: true
      timeInMinutes:
        format: int32
        description: Time in minutes before event at which notification will be sent.
        type: integer
      webhookUrl:
        description: The webhook URL to which the notification will be sent.
        type: string
      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
  CloudErrorBody:
    description: Body of an error from a REST request.
    type: object
    properties:
      code:
        description: The error code.
        type: string
      message:
        description: The error message.
        type: string
      target:
        description: The error target.
        type: string
      details:
        description: Inner errors.
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
    x-ms-external: true
  UpdateResource:
    description: Represents an update resource
    type: object
    properties:
      tags:
        description: The tags of the resource.
        type: object
        additionalProperties:
          type: string
  Schedule:
    description: A schedule.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/ScheduleProperties'
        description: The properties of the resource.
        x-ms-client-flatten: true
  DayDetails:
    description: Properties of a daily schedule.
    type: object
    properties:
      time:
        description: The time of day the schedule will occur.
        type: string
  HourDetails:
    description: Properties of an hourly schedule.
    type: object
    properties:
      minute:
        format: int32
        description: Minutes of the hour the schedule will run.
        type: integer
parameters:
  resourceGroupName:
    name: resourceGroupName
    in: path
    description: The name of the resource group.
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionId:
    name: subscriptionId
    in: path
    description: The subscription ID.
    required: true
    type: string
  api-version:
    name: api-version
    in: query
    description: Client API version.
    required: true
    type: string
    default: '2018-09-15'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'