swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Triggers API
schemes:
- https
tags:
- name: Triggers
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers
  : get:
      tags:
      - Triggers
      description: Lists all the triggers configured in the device.
      operationId: microsoftAzureTriggersListbydataboxedgedevice
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - name: $filter
        in: query
        description: Specify $filter='CustomContextTag eq <tag>' to filter on custom context tag property
        required: false
        type: string
      responses:
        '200':
          description: List all the triggers configured in the device
          schema:
            $ref: '#/definitions/TriggerList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        TriggerGetAllInDevice:
          $ref: ./examples/TriggerGetAllInDevice.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Triggers
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}
  : get:
      tags:
      - Triggers
      description: Get a specific trigger by name.
      operationId: microsoftAzureTriggersGet
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: name
        in: path
        description: The trigger name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: The trigger.
          schema:
            $ref: '#/definitions/Trigger'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        TriggerGet:
          $ref: ./examples/TriggerGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Triggers Name
    put:
      tags:
      - Triggers
      description: Creates or updates a trigger.
      operationId: microsoftAzureTriggersCreateorupdate
      parameters:
      - name: deviceName
        in: path
        description: Creates or updates a trigger
        required: true
        type: string
      - name: name
        in: path
        description: The trigger name.
        required: true
        type: string
      - name: trigger
        in: body
        description: The trigger.
        required: true
        schema:
          $ref: '#/definitions/Trigger'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully created or updated the trigger.
          schema:
            $ref: '#/definitions/Trigger'
        '202':
          description: Accepted the request to create or update the trigger.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        TriggerPut:
          $ref: ./examples/TriggerPut.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Triggers Name
    delete:
      tags:
      - Triggers
      description: Deletes the trigger on the gateway device.
      operationId: microsoftAzureTriggersDelete
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: name
        in: path
        description: The trigger name.
        required: true
        type: string
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully deleted the trigger.
        '202':
          description: Accepted the request to delete the trigger.
        '204':
          description: The trigger is already deleted.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        TriggerDelete:
          $ref: ./examples/TriggerDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databoxedge Databoxedgedevices Devicename Triggers Name
  /datasources/{dataSourceName}/scans/{scanName}/triggers/default:
    get:
      tags:
      - Triggers
      description: Gets trigger information
      operationId: microsoftAzureTriggersGettrigger
      produces:
      - application/json
      parameters:
      - in: path
        name: dataSourceName
        required: true
        type: string
      - in: path
        name: scanName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Trigger_2'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Triggers_GetTrigger:
          $ref: ./examples/Triggers_GetTrigger.json
      summary: Microsoft Azure Get Datasources Datasourcename Scans Scanname Triggers Default
    put:
      tags:
      - Triggers
      description: Creates an instance of a trigger
      operationId: microsoftAzureTriggersCreatetrigger
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: dataSourceName
        required: true
        type: string
      - in: path
        name: scanName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/Trigger_2'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Trigger_2'
        '201':
          description: Success
          schema:
            $ref: '#/definitions/Trigger_2'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Triggers_CreateTrigger:
          $ref: ./examples/Triggers_CreateTrigger.json
      summary: Microsoft Azure Put Datasources Datasourcename Scans Scanname Triggers Default
    delete:
      tags:
      - Triggers
      description: Deletes the trigger associated with the scan
      operationId: microsoftAzureTriggersDeletetrigger
      produces:
      - application/json
      parameters:
      - in: path
        name: dataSourceName
        required: true
        type: string
      - in: path
        name: scanName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Trigger_2'
        '204':
          description: Success
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Triggers_DeleteTrigger:
          $ref: ./examples/Triggers_DeleteTrigger.json
      summary: Microsoft Azure Delete Datasources Datasourcename Scans Scanname Triggers Default
definitions:
  ProxyResource:
    type: object
    properties:
      id:
        type: string
        readOnly: true
      name:
        type: string
        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
  Trigger:
    description: Trigger details.
    required:
    - kind
    type: object
    allOf:
    - $ref: '#/definitions/ARMBaseModel'
    properties:
      kind:
        description: Trigger Kind.
        enum:
        - FileEvent
        - PeriodicTimerEvent
        type: string
        x-ms-enum:
          name: TriggerEventType
          modelAsString: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Metadata pertaining to creation and last modification of Trigger
        readOnly: true
    discriminator: kind
  TriggerRecurrence:
    type: object
    properties:
      frequency:
        enum:
        - Week
        - Month
        - Day
        - Hour
        type: string
        x-ms-enum:
          name: TriggerFrequency
          modelAsString: true
      interval:
        format: int32
        type: integer
      startTime:
        format: date-time
        type: string
      endTime:
        format: date-time
        type: string
      schedule:
        allOf:
        - $ref: '#/definitions/RecurrenceSchedule'
      timeZone:
        type: string
  RecurrenceScheduleOccurrence:
    type: object
    properties:
      additionalProperties:
        type: object
        additionalProperties:
          type: object
      day:
        enum:
        - Sunday
        - Monday
        - Tuesday
        - Wednesday
        - Thursday
        - Friday
        - Saturday
        type: string
        x-ms-enum:
          name: DayOfWeek
          modelAsString: true
      occurrence:
        format: int32
        type: integer
  ErrorResponseModel:
    type: object
    properties:
      error:
        allOf:
        - $ref: '#/definitions/ErrorModel'
  ErrorModel:
    type: object
    properties:
      code:
        type: string
      message:
        type: string
      target:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/ErrorModel'
  CloudError:
    description: An error response from the service.
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: The error details.
    x-ms-external: true
  Trigger_2:
    type: object
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      properties:
        allOf:
        - $ref: '#/definitions/TriggerProperties'
  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
  TriggerList:
    description: Collection of all trigger on the data box edge device.
    type: object
    properties:
      value:
        description: The list of triggers.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/Trigger'
        readOnly: true
        x-ms-identifiers: []
      nextLink:
        description: Link to the next set of results.
        type: string
        readOnly: true
  RecurrenceSchedule:
    type: object
    properties:
      additionalProperties:
        type: object
        additionalProperties:
          type: object
      minutes:
        type: array
        items:
          format: int32
          type: integer
      hours:
        type: array
        items:
          format: int32
          type: integer
      weekDays:
        type: array
        items:
          enum:
          - Sunday
          - Monday
          - Tuesday
          - Wednesday
          - Thursday
          - Friday
          - Saturday
          type: string
          x-ms-enum:
            name: DaysOfWeek
            modelAsString: true
      monthDays:
        type: array
        items:
          format: int32
          type: integer
      monthlyOccurrences:
        type: array
        items:
          $ref: '#/definitions/RecurrenceScheduleOccurrence'
  TriggerProperties:
    type: object
    properties:
      recurrence:
        allOf:
        - $ref: '#/definitions/TriggerRecurrence'
      recurrenceInterval:
        type: string
      createdAt:
        format: date-time
        type: string
        readOnly: true
      lastModifiedAt:
        format: date-time
        type: string
        readOnly: true
      lastScheduled:
        format: date-time
        type: string
        readOnly: true
      scanLevel:
        enum:
        - Full
        - Incremental
        type: string
        x-ms-enum:
          name: ScanLevelType
          modelAsString: true
      incrementalScanStartTime:
        format: date-time
        type: string
parameters:
  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
  api-version:
    in: query
    name: api-version
    description: The api version to use.
    required: true
    type: string
    x-ms-client-name: ApiVersion
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: The subscription ID.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'