swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SupportPackages API
schemes:
- https
tags:
- name: SupportPackages
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggerSupportPackage
  : post:
      tags:
      - SupportPackages
      summary: Microsoft Azure Triggers Support Package On The Device
      operationId: microsoftAzureSupportpackagesTriggersupportpackage
      parameters:
      - name: deviceName
        in: path
        description: The device name.
        required: true
        type: string
      - name: triggerSupportPackageRequest
        in: body
        description: The trigger support package request object
        required: true
        schema:
          $ref: '#/definitions/TriggerSupportPackageRequest'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: Successfully triggered support package on the device.
        '202':
          description: Accepted the request to trigger support package on the device.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        TriggerSupportPackage:
          $ref: ./examples/TriggerSupportPackage.json
      description: Needs a more full description created.
definitions:
  TriggerSupportPackageRequest:
    description: The request object for trigger support package.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/ARMBaseModel'
    properties:
      properties:
        $ref: '#/definitions/SupportPackageRequestProperties'
        description: The TriggerSupportPackageRequest properties.
        x-ms-client-flatten: 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
  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
  SupportPackageRequestProperties:
    description: The share properties.
    type: object
    properties:
      minimumTimeStamp:
        format: date-time
        description: MinimumTimeStamp from where logs need to be collected
        type: string
      maximumTimeStamp:
        format: date-time
        description: Start of the timespan of the log collection
        type: string
      include:
        description: "Type of files, which need to be included in the logs\r\nThis will contain the type of logs (Default/DefaultWithDumps/None/All/DefaultWithArchived)\r\nor a comma separated list of log types that are required"
        type: string
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'