Microsoft Azure Troubleshooter API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Troubleshooter API
schemes:
- https
tags:
- name: Troubleshooter
paths:
  /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}:
    put:
      tags:
      - Troubleshooter
      description: Creates the specific troubleshooter action under a resource or subscription using the ‘solutionId’ and  ‘properties.parameters’ as the trigger.  Azure Troubleshooters help with hard to classify issues, reducing the gap between customer observed problems and solutions by guiding the user effortlessly through the troubleshooting process. Each Troubleshooter flow represents a problem area within Azure and has a complex tree-like structure that addresses many root causes. These flows are prepared with the help of Subject Matter experts and customer support engineers by carefully considering previous support requests raised by customers. Troubleshooters terminate at a well curated solution based off of resource backend signals and customer manual selections.
      operationId: microsoftAzureTroubleshootersCreate
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/TroubleshooterNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: createTroubleshooterRequestBody
        description: The required request body for this Troubleshooter resource creation.
        in: body
        schema:
          $ref: '#/definitions/TroubleshooterResource'
      responses:
        '200':
          description: Successful Troubleshooter update invocation.
          schema:
            $ref: '#/definitions/TroubleshooterResource'
        '201':
          description: Successful Troubleshooter create invocation.
          schema:
            $ref: '#/definitions/TroubleshooterResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Troubleshooters_Create:
          $ref: ./examples/Troubleshooter_Create.json
      summary: Microsoft Azure Put Scope Providers Microsoft Help Troubleshooters Troubleshootername
    get:
      tags:
      - Troubleshooter
      description: Gets troubleshooter instance result which includes the step status/result of the troubleshooter resource name that is being executed. Get API is used to retrieve the result of a Troubleshooter instance, which includes the status and result of each step in the Troubleshooter workflow. This API requires the Troubleshooter resource name that was created using the Create API.
      operationId: microsoftAzureTroubleshootersGet
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/TroubleshooterNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Successful fetched Troubleshooter instance.
          schema:
            $ref: '#/definitions/TroubleshooterResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Troubleshooters_Get:
          $ref: ./examples/Troubleshooter_Get.json
      summary: Microsoft Azure Get Scope Providers Microsoft Help Troubleshooters Troubleshootername
  /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/continue:
    post:
      tags:
      - Troubleshooter
      description: Uses ‘stepId’ and ‘responses’ as the trigger to continue the troubleshooting steps for the respective troubleshooter resource name. Continue API is used to provide inputs that are required for the specific troubleshooter to progress into the next step in the process. This API is used after the Troubleshooter has been created using the Create API.
      operationId: microsoftAzureTroubleshootersContinue
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/TroubleshooterNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - name: continueRequestBody
        description: The required request body for going to next step in Troubleshooter resource.
        in: body
        schema:
          $ref: '#/definitions/ContinueRequestBody'
      responses:
        '204':
          description: Successfully Continued to next step
          headers:
            Location:
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Troubleshooter_Continue:
          $ref: ./examples/Troubleshooter_Continue.json
      summary: Microsoft Azure Post Scope Providers Microsoft Help Troubleshooters Troubleshootername Continue
  /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/end:
    post:
      tags:
      - Troubleshooter
      description: Ends the troubleshooter action
      operationId: microsoftAzureTroubleshootersEnd
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/TroubleshooterNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '204':
          description: Successfully ended the Troubleshooter instance
          headers:
            Location:
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Troubleshooters_End:
          $ref: ./examples/Troubleshooter_End.json
      summary: Microsoft Azure Post Scope Providers Microsoft Help Troubleshooters Troubleshootername End
  /{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/restart:
    post:
      tags:
      - Troubleshooter
      description: Restarts the troubleshooter API using applicable troubleshooter resource name as the input. It returns new resource name which should be used in subsequent request. The old resource name is obsolete after this API is invoked.
      operationId: microsoftAzureTroubleshootersRestart
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/TroubleshooterNameParameter'
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Successfully restarted troubleshooter instance.
          headers:
            Location:
              type: string
          schema:
            $ref: '#/definitions/RestartTroubleshooterResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Troubleshooters_Restart:
          $ref: ./examples/Troubleshooter_Restart.json
      summary: Microsoft Azure Post Scope Providers Microsoft Help Troubleshooters Troubleshootername Restart
definitions:
  TroubleshooterResponse:
    description: User Response for Troubleshooter continue request
    type: object
    properties:
      questionId:
        description: id of the question.
        type: string
      questionType:
        $ref: '#/definitions/QuestionType'
      response:
        description: Response key for SingleInput. For Multi-line test/open ended question it is free form text
        type: string
  ResponseOption:
    description: The status of the resource.
    type: object
    properties:
      key:
        description: Unique string.
        type: string
      value:
        description: Option description
        type: string
  AutomatedCheckResult:
    description: Only for AutomatedStep type
    type: object
    properties:
      version:
        description: Version for automated check result
        type: string
      status:
        description: Status for automated check result
        type: string
      result:
        description: Insight Article Content
        type: string
      type:
        description: Type of Result.
        type: string
        enum:
        - Success
        - Warning
        - Error
        - Information
        x-ms-enum:
          name: automatedCheckResultType
          modelAsString: true
  QuestionType:
    description: Type of Question
    type: string
    enum:
    - RadioButton
    - Dropdown
    - TextInput
    - MultiLineInfoBox
    - DateTimePicker
    - MultiSelect
    x-ms-enum:
      name: questionType
      modelAsString: true
      values:
      - value: RadioButton
        description: SingleChoice radio button
      - value: Dropdown
        description: SingleChoice dropdown.
      - value: TextInput
        description: Text Input
      - value: MultiLineInfoBox
        description: MultiLineInfoBox
      - value: DateTimePicker
        description: DateTime Picker
      - value: MultiSelect
        description: Multi Select
  ContinueRequestBody:
    description: Troubleshooter ContinueRequest body.
    type: object
    properties:
      stepId:
        description: Unique id of the result.
        type: string
      responses:
        type: array
        items:
          $ref: '#/definitions/TroubleshooterResponse'
        x-ms-identifiers: []
  RestartTroubleshooterResponse:
    description: Troubleshooter restart response
    type: object
    properties:
      troubleshooterResourceName:
        description: Updated TroubleshooterResource Name .
        type: string
        readOnly: true
  ResponseValidationProperties:
    description: Troubleshooter step input response validation properties
    type: object
    properties:
      regex:
        description: Regex used for the input validation.
        type: string
      validationScope:
        description: Validation scope
        type: string
        enum:
        - None
        - URLFormat
        - GuidFormat
        - IpAddressFormat
        - NumberOnlyFormat
        x-ms-enum:
          name: validationScope
          modelAsString: true
      isRequired:
        description: Default True
        type: boolean
      validationErrorMessage:
        description: Validation Error Message.
        type: string
      maxLength:
        description: Max text input (open Ended Text).
        type: integer
        format: int64
  TroubleshooterInstanceProperties:
    description: Troubleshooter Instance properties.
    type: object
    properties:
      solutionId:
        description: Solution Id to identify single troubleshooter.
        type: string
      parameters:
        description: Client input parameters to run Troubleshooter Resource
        type: object
        additionalProperties:
          type: string
      provisioningState:
        description: Status of troubleshooter provisioning.
        type: string
        enum:
        - Succeeded
        - Failed
        - Canceled
        - Running
        - AutoContinue
        x-ms-enum:
          name: TroubleshooterProvisioningState
          modelAsString: true
        readOnly: true
        required:
        - solutionId
        - parameters
      steps:
        description: List of step object.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/Step'
        x-ms-identifiers:
        - id
  Step:
    description: Troubleshooter step
    type: object
    properties:
      id:
        description: Unique step id.
        type: string
      title:
        description: Step title.
        type: string
      description:
        description: Step description.
        type: string
      guidance:
        description: Get or sets the Step guidance.
        type: string
      executionStatus:
        description: Status of Troubleshooter Step execution.
        type: string
        enum:
        - Success
        - Running
        - Failed
        - Warning
        x-ms-enum:
          name: executionStatus
          modelAsString: true
          values:
          - value: Success
            description: Step execution succeeded.
          - value: Running
            description: Step execution running
          - value: Failed
            description: Step execution failed
          - value: Warning
            description: Step execution warning
      executionStatusDescription:
        description: This field has more detailed status description of the execution status.
        type: string
      type:
        description: Type of Troubleshooting step.
        type: string
        enum:
        - Decision
        - Solution
        - Insight
        - AutomatedCheck
        - Input
        x-ms-enum:
          name: type
          modelAsString: true
      isLastStep:
        description: is this last step of the workflow.
        type: boolean
      inputs:
        type: array
        items:
          $ref: '#/definitions/StepInput'
        x-ms-identifiers:
        - questionId
      automatedCheckResults:
        $ref: '#/definitions/AutomatedCheckResult'
      insights:
        type: array
        items:
          $ref: '#/definitions/Insight'
        x-ms-identifiers:
        - id
      error:
        $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail
  TroubleshooterResource:
    description: Troubleshooter response.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    type: object
    x-ms-azure-resource: true
    properties:
      properties:
        $ref: '#/definitions/TroubleshooterInstanceProperties'
        x-ms-client-flatten: true
  StepInput:
    description: Details of step input.
    type: object
    properties:
      questionId:
        description: Use Index as QuestionId.
        type: string
      questionType:
        $ref: '#/definitions/QuestionType'
      questionTitle:
        description: Question title
        type: string
      questionContent:
        description: User question content.
        type: string
      questionContentType:
        description: Default is Text.
        type: string
        enum:
        - Text
        - Html
        - Markdown
        x-ms-enum:
          name: questionContentType,
          modelAsString: true
      responseHint:
        description: Place holder text for response hints.
        type: string
      recommendedOption:
        description: Result of Automate step.
        type: string
      selectedOptionValue:
        description: Text of response that was selected.
        type: string
      responseValidationProperties:
        $ref: '#/definitions/ResponseValidationProperties'
      responseOptions:
        type: array
        items:
          $ref: '#/definitions/ResponseOption'
        x-ms-identifiers:
        - key
  Insight:
    description: Detailed insights(s) obtained via the invocation of an insight diagnostic
    type: object
    properties:
      id:
        description: Article id.
        type: string
      title:
        description: This insight's title.
        type: string
      results:
        description: Detailed result content.
        type: string
      importanceLevel:
        description: Importance level of the insight.
        type: string
        enum:
        - Critical
        - Warning
        - Information
        x-ms-enum:
          name: importanceLevel
          modelAsString: true
          values:
          - value: Critical
            description: A critical insight has been found after running the diagnostic.
          - value: Warning
            description: A warning insight has been found after running the diagnostic.
          - value: Information
            description: An information insight has been found after running the diagnostic.
parameters:
  TroubleshooterNameParameter:
    name: troubleshooterName
    in: path
    required: true
    type: string
    description: Troubleshooter resource Name.
    x-ms-parameter-location: method
    minLength: 1
    maxLength: 100
    pattern: ([A-Za-z0-9]+(-[A-Za-z0-9]+)+)
  ScopeParameter:
    name: scope
    in: path
    required: true
    type: string
    description: 'scope = resourceUri of affected resource.<br/> For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read '
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'