swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BackupSchedules API
schemes:
- https
tags:
- name: BackupSchedules
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies/{backupPolicyName}/schedules
  : get:
      tags:
      - BackupSchedules
      description: Gets all the backup schedules in a backup policy.
      operationId: microsoftAzureBackupschedulesListbybackuppolicy
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - name: backupPolicyName
        in: path
        description: The backup policy name.
        required: true
        type: string
        x-ms-skip-url-encoding: true
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The collection of backup schedules.
          schema:
            $ref: '#/definitions/BackupScheduleList'
      deprecated: false
      x-ms-pageable:
        nextLinkName: null
      x-ms-examples:
        BackupSchedulesListByBackupPolicy:
          $ref: ./examples/BackupSchedulesListByBackupPolicy.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Backuppolicies Backuppolicyname Schedules
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/backupPolicies/{backupPolicyName}/schedules/{backupScheduleName}
  : get:
      tags:
      - BackupSchedules
      description: Gets the properties of the specified backup schedule name.
      operationId: microsoftAzureBackupschedulesGet
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - name: backupPolicyName
        in: path
        description: The backup policy name.
        required: true
        type: string
        x-ms-skip-url-encoding: true
      - name: backupScheduleName
        in: path
        description: The name of the backup schedule to be fetched
        required: true
        type: string
        x-ms-skip-url-encoding: true
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The backup schedule.
          schema:
            $ref: '#/definitions/BackupSchedule'
      deprecated: false
      x-ms-examples:
        BackupSchedulesGet:
          $ref: ./examples/BackupSchedulesGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Backuppolicies Backuppolicyname Schedules Backupschedulename
    put:
      tags:
      - BackupSchedules
      description: Creates or updates the backup schedule.
      operationId: microsoftAzureBackupschedulesCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - name: backupPolicyName
        in: path
        description: The backup policy name.
        required: true
        type: string
        x-ms-skip-url-encoding: true
      - name: backupScheduleName
        in: path
        description: The backup schedule name.
        required: true
        type: string
        x-ms-skip-url-encoding: true
      - name: parameters
        in: body
        description: The backup schedule.
        required: true
        schema:
          $ref: '#/definitions/BackupSchedule'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the backup schedule.
          schema:
            $ref: '#/definitions/BackupSchedule'
        '202':
          description: Accepted the request to create or update the backup schedule.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        BackupSchedulesCreateOrUpdate:
          $ref: ./examples/BackupSchedulesCreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Backuppolicies Backuppolicyname Schedules Backupschedulename
    delete:
      tags:
      - BackupSchedules
      description: Deletes the backup schedule.
      operationId: microsoftAzureBackupschedulesDelete
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/deviceNameParameter'
      - name: backupPolicyName
        in: path
        description: The backup policy name.
        required: true
        type: string
        x-ms-skip-url-encoding: true
      - name: backupScheduleName
        in: path
        description: The name the backup schedule.
        required: true
        type: string
        x-ms-skip-url-encoding: true
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/managerNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '202':
          description: Accepted the request to delete the backup schedule.
        '204':
          description: Successfully deleted the backup schedule.
      deprecated: false
      x-ms-long-running-operation: true
      x-ms-examples:
        BackupSchedulesDelete:
          $ref: ./examples/BackupSchedulesDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Backuppolicies Backuppolicyname Schedules Backupschedulename
definitions:
  BackupScheduleList:
    description: The backup schedule list.
    required:
    - value
    type: object
    properties:
      value:
        description: The value.
        type: array
        items:
          $ref: '#/definitions/BackupSchedule'
  ScheduleRecurrence:
    description: The schedule recurrence.
    required:
    - recurrenceType
    - recurrenceValue
    type: object
    properties:
      recurrenceType:
        description: The recurrence type.
        enum:
        - Minutes
        - Hourly
        - Daily
        - Weekly
        type: string
        x-ms-enum:
          name: RecurrenceType
          modelAsString: false
      recurrenceValue:
        format: int32
        description: The recurrence value.
        type: integer
      weeklyDaysList:
        description: The week days list. Applicable only for schedules of recurrence type 'weekly'.
        type: array
        items:
          enum:
          - Sunday
          - Monday
          - Tuesday
          - Wednesday
          - Thursday
          - Friday
          - Saturday
          type: string
          x-ms-enum:
            name: DayOfWeek
            modelAsString: false
  BaseModel:
    description: Represents the base class for all other ARM object models
    type: object
    properties:
      id:
        description: The path ID that uniquely identifies the object.
        type: string
        readOnly: true
      name:
        description: The name of the object.
        type: string
        readOnly: true
      type:
        description: The hierarchical type of the object.
        type: string
        readOnly: true
      kind:
        description: The Kind of the object. Currently only Series8000 is supported
        enum:
        - Series8000
        type: string
        x-ms-enum:
          name: Kind
          modelAsString: false
  BackupScheduleProperties:
    description: The properties of the backup schedule.
    required:
    - scheduleRecurrence
    - backupType
    - retentionCount
    - startTime
    - scheduleStatus
    type: object
    properties:
      scheduleRecurrence:
        $ref: '#/definitions/ScheduleRecurrence'
        description: The schedule recurrence.
      backupType:
        description: The type of backup which needs to be taken.
        enum:
        - LocalSnapshot
        - CloudSnapshot
        type: string
        x-ms-enum:
          name: BackupType
          modelAsString: false
      retentionCount:
        format: int64
        description: The number of backups to be retained.
        type: integer
      startTime:
        format: date-time
        description: The start time of the schedule.
        type: string
      scheduleStatus:
        description: The schedule status.
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: ScheduleStatus
          modelAsString: false
      lastSuccessfulRun:
        format: date-time
        description: The last successful backup run which was triggered for the schedule.
        type: string
        readOnly: true
  BackupSchedule:
    description: The backup schedule.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/BaseModel'
    properties:
      properties:
        $ref: '#/definitions/BackupScheduleProperties'
        description: The properties of the backup schedule.
        x-ms-client-flatten: true
parameters:
  managerNameParameter:
    name: managerName
    in: path
    description: The manager name
    required: true
    type: string
    maxLength: 50
    minLength: 2
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription id
    required: true
    type: string
    x-ms-skip-url-encoding: true
  apiVersionParameter:
    name: api-version
    in: query
    description: The api version
    required: true
    type: string
    x-ms-skip-url-encoding: true
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The resource group name
    required: true
    type: string
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
  deviceNameParameter:
    name: deviceName
    in: path
    description: The device name
    required: true
    type: string
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'