swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BandwidthSchedules API
schemes:
- https
tags:
- name: BandwidthSchedules
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules
  : get:
      tags:
      - BandwidthSchedules
      description: Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.
      operationId: microsoftAzureBandwidthschedulesListbydataboxedgedevice
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The collection of bandwidth schedules.
          schema:
            $ref: '#/definitions/BandwidthSchedulesList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        BandwidthScheduleGetAllInDevice:
          $ref: ./examples/BandwidthScheduleGetAllInDevice.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Bandwidthschedules
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}
  : get:
      tags:
      - BandwidthSchedules
      description: Gets the properties of the specified bandwidth schedule.
      operationId: microsoftAzureBandwidthschedulesGet
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: name
        in: path
        description: The bandwidth schedule name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The bandwidth schedule.
          schema:
            $ref: '#/definitions/BandwidthSchedule'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        BandwidthScheduleGet:
          $ref: ./examples/BandwidthScheduleGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Bandwidthschedules Name
    put:
      tags:
      - BandwidthSchedules
      description: Creates or updates a bandwidth schedule.
      operationId: microsoftAzureBandwidthschedulesCreateorupdate
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: name
        in: path
        description: The bandwidth schedule name which needs to be added/updated.
        required: true
        type: string
      - name: parameters
        in: body
        description: The bandwidth schedule to be added or updated.
        required: true
        schema:
          $ref: '#/definitions/BandwidthSchedule'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the bandwidth schedule.
          schema:
            $ref: '#/definitions/BandwidthSchedule'
        '202':
          description: Accepted the request to create or update the bandwidth schedule.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        BandwidthSchedulePut:
          $ref: ./examples/BandwidthSchedulePut.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Bandwidthschedules Name
    delete:
      tags:
      - BandwidthSchedules
      description: Deletes the specified bandwidth schedule.
      operationId: microsoftAzureBandwidthschedulesDelete
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: name
        in: path
        description: The bandwidth schedule name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Success
        '202':
          description: Accepted the request to delete the bandwidth schedule.
        '204':
          description: Successfully deleted the bandwidth schedule.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        BandwidthScheduleDelete:
          $ref: ./examples/BandwidthScheduleDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Bandwidthschedules Name
definitions:
  BandwidthSchedule:
    description: The bandwidth schedule details.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/ARMBaseModel'
    properties:
      properties:
        $ref: '#/definitions/BandwidthScheduleProperties'
        description: The properties of the bandwidth schedule.
        x-ms-client-flatten: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to creation and last modification of BandwidthSchedule
        readOnly: true
  ARMBaseModel:
    description: Represents the base class for all object models.
    type: object
    properties:
      id:
        description: The path ID that uniquely identifies the object.
        type: string
        readOnly: true
      name:
        description: The object name.
        type: string
        readOnly: true
      type:
        description: The hierarchical type of the object.
        type: string
        readOnly: true
    x-ms-azure-resource: true
  BandwidthScheduleProperties:
    description: The properties of the bandwidth schedule.
    required:
    - start
    - stop
    - rateInMbps
    - days
    type: object
    properties:
      start:
        description: The start time of the schedule in UTC.
        type: string
      stop:
        description: The stop time of the schedule in UTC.
        type: string
      rateInMbps:
        format: int32
        description: The bandwidth rate in Mbps.
        type: integer
      days:
        description: The days of the week when this schedule is applicable.
        uniqueItems: false
        type: array
        items:
          enum:
          - Sunday
          - Monday
          - Tuesday
          - Wednesday
          - Thursday
          - Friday
          - Saturday
          type: string
          x-ms-enum:
            name: DayOfWeek
            modelAsString: true
          x-ms-identifiers: []
  CloudError:
    description: An error response from the service.
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: The error details.
    x-ms-external: true
  CloudErrorBody:
    description: An error response from the service.
    type: object
    properties:
      code:
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
        type: string
      message:
        description: A message describing the error, intended to be suitable for display in a user interface.
        type: string
      details:
        description: A list of additional details about the error.
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        x-ms-identifiers: []
    x-ms-external: true
  BandwidthSchedulesList:
    description: The collection of bandwidth schedules.
    type: object
    properties:
      value:
        description: The list of bandwidth schedules.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/BandwidthSchedule'
        x-ms-identifiers: []
        readOnly: true
      nextLink:
        description: Link to the next set of results.
        type: string
        readOnly: true
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription ID.
    required: true
    type: string
  apiVersionParameter:
    name: api-version
    in: query
    description: The API version.
    required: true
    type: string
  resourceGroupNameParameter:
    name: resourceGroupName
    in: path
    description: The resource group name.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'