swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: 'Microsoft Azure AccessControlClient AccessConnector Service Health: API'
schemes:
- https
tags:
- name: 'Service Health:'
paths:
  /healthstatus:
    get:
      tags:
      - 'Service Health:'
      summary: Microsoft Azure Returns The Overall Health Of The Service And Optionally Of The Different Subcomponents
      operationId: microsoftAzureGethealthstatus
      produces:
      - application/json
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ServiceHealth'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        Gets the health status:
          $ref: examples/get_healthstatus.json
      description: Needs a more full description created.
definitions:
  ErrorCode:
    title: ErrorCode
    description: High level error codes.
    enum:
    - InvalidRequest
    - InvalidArgument
    - InternalServerError
    - ServiceUnavailable
    - NotFound
    - PipelineError
    - Conflict
    - InternalCommunicationFailed
    - Forbidden
    - NotAllowed
    - Unauthorized
    - UnsupportedMediaType
    - TooManyRequests
    - UnprocessableEntity
    type: string
    x-ms-enum:
      name: ErrorCode
      modelAsString: true
      values:
      - value: InvalidRequest
        description: Representing the invalid request error code.
      - value: InvalidArgument
        description: Representing the invalid argument error code.
      - value: InternalServerError
        description: Representing the internal server error error code.
      - value: ServiceUnavailable
        description: Representing the service unavailable error code.
      - value: NotFound
        description: Representing the not found error code.
      - value: PipelineError
        description: Representing the pipeline error error code.
      - value: Conflict
        description: Representing the conflict error code.
      - value: InternalCommunicationFailed
        description: Representing the internal communication failed error code.
      - value: Forbidden
        description: Representing the forbidden error code.
      - value: NotAllowed
        description: Representing the not allowed error code.
      - value: Unauthorized
        description: Representing the unauthorized error code.
      - value: UnsupportedMediaType
        description: Representing the unsupported media type error code.
      - value: TooManyRequests
        description: Representing the too many requests error code.
      - value: UnprocessableEntity
        description: Representing the unprocessable entity error code.
  Component:
    title: Component
    type: object
    properties:
      message:
        description: Additional messages about the current service health.
        type: string
        readOnly: true
      name:
        description: The name of the component.
        type: string
        readOnly: true
      status:
        $ref: '#/definitions/HealthStatus'
      type:
        description: The type of this component.
        type: string
        readOnly: true
  DetailedErrorCode:
    title: DetailedErrorCode
    description: Detailed error code enum.
    enum:
    - InvalidParameterValue
    - InvalidRequestBodyFormat
    - EmptyRequest
    - MissingInputRecords
    - InvalidDocument
    - ModelVersionIncorrect
    - InvalidDocumentBatch
    - UnsupportedLanguageCode
    - DataImportFailed
    - InUseViolation
    - InvalidLocale
    - InvalidBaseModel
    - InvalidAdaptationMapping
    - InvalidDataset
    - InvalidTest
    - FailedDataset
    - InvalidModel
    - InvalidTranscription
    - InvalidPayload
    - InvalidParameter
    - EndpointWithoutLogging
    - InvalidPermissions
    - InvalidPrerequisite
    - InvalidProductId
    - InvalidSubscription
    - InvalidProject
    - InvalidProjectKind
    - InvalidRecordingsUri
    - OnlyOneOfUrlsOrContainerOrDataset
    - ExceededNumberOfRecordingsUris
    - ModelMismatch
    - ProjectGenderMismatch
    - ModelDeprecated
    - ModelExists
    - ModelNotDeployable
    - EndpointNotUpdatable
    - SingleDefaultEndpoint
    - EndpointCannotBeDefault
    - InvalidModelUri
    - SubscriptionNotFound
    - QuotaViolation
    - UnsupportedDelta
    - UnsupportedFilter
    - UnsupportedPagination
    - UnsupportedDynamicConfiguration
    - UnsupportedOrderBy
    - NoUtf8WithBom
    - ModelDeploymentNotCompleteState
    - SkuLimitsExist
    - DeployingFailedModel
    - UnsupportedTimeRange
    - InvalidLogDate
    - InvalidLogId
    - InvalidLogStartTime
    - InvalidLogEndTime
    - InvalidTopForLogs
    - InvalidSkipTokenForLogs
    - DeleteNotAllowed
    - Forbidden
    - DeployNotAllowed
    - UnexpectedError
    - InvalidCollection
    - InvalidCallbackUri
    - InvalidSasValidityDuration
    - InaccessibleCustomerStorage
    - UnsupportedClassBasedAdaptation
    - InvalidWebHookEventKind
    - InvalidTimeToLive
    type: string
    x-ms-enum:
      name: DetailedErrorCode
      modelAsString: true
      values:
      - value: InvalidParameterValue
        description: Invalid parameter value.
      - value: InvalidRequestBodyFormat
        description: Invalid request body format.
      - value: EmptyRequest
        description: Empty Request.
      - value: MissingInputRecords
        description: Missing Input Records.
      - value: InvalidDocument
        description: Invalid Document.
      - value: ModelVersionIncorrect
        description: Model Version Incorrect.
      - value: InvalidDocumentBatch
        description: Invalid Document Batch.
      - value: UnsupportedLanguageCode
        description: Unsupported language code.
      - value: DataImportFailed
        description: Data import failed.
      - value: InUseViolation
        description: In use violation.
      - value: InvalidLocale
        description: Invalid locale.
      - value: InvalidBaseModel
        description: Invalid base model.
      - value: InvalidAdaptationMapping
        description: Invalid adaptation mapping.
      - value: InvalidDataset
        description: Invalid dataset.
      - value: InvalidTest
        description: Invalid test.
      - value: FailedDataset
        description: Failed dataset.
      - value: InvalidModel
        description: Invalid model.
      - value: InvalidTranscription
        description: Invalid transcription.
      - value: InvalidPayload
        description: Invalid payload.
      - value: InvalidParameter
        description: Invalid parameter.
      - value: EndpointWithoutLogging
        description: Endpoint without logging.
      - value: InvalidPermissions
        description: Invalid permissions.
      - value: InvalidPrerequisite
        description: Invalid prerequisite.
      - value: InvalidProductId
        description: Invalid product id.
      - value: InvalidSubscription
        description: Invalid subscription.
      - value: InvalidProject
        description: Invalid project.
      - value: InvalidProjectKind
        description: Invalid project kind.
      - value: InvalidRecordingsUri
        description: Invalid recordings uri.
      - value: OnlyOneOfUrlsOrContainerOrDataset
        description: Only one of urls or container or dataset.
      - value: ExceededNumberOfRecordingsUris
        description: Exceeded number of recordings uris.
      - value: ModelMismatch
        description: Model mismatch.
      - value: ProjectGenderMismatch
        description: Project gender mismatch.
      - value: ModelDeprecated
        description: Model deprecated.
      - value: ModelExists
        description: Model exists.
      - value: ModelNotDeployable
        description: Model not deployable.
      - value: EndpointNotUpdatable
        description: Endpoint not updatable.
      - value: SingleDefaultEndpoint
        description: Single default endpoint.
      - value: EndpointCannotBeDefault
        description: Endpoint cannot be default.
      - value: InvalidModelUri
        description: Invalid model uri.
      - value: SubscriptionNotFound
        description: Subscription not found.
      - value: QuotaViolation
        description: Quota violation.
      - value: UnsupportedDelta
        description: Unsupported delta.
      - value: UnsupportedFilter
        description: Unsupported filter.
      - value: UnsupportedPagination
        description: Unsupported pagination.
      - value: UnsupportedDynamicConfiguration
        description: Unsupported dynamic configuration.
      - value: UnsupportedOrderBy
        description: Unsupported order by.
      - value: NoUtf8WithBom
        description: No utf8 with bom.
      - value: ModelDeploymentNotCompleteState
        description: Model deployment not complete state.
      - value: SkuLimitsExist
        description: Sku limits exist.
      - value: DeployingFailedModel
        description: Deploying failed model.
      - value: UnsupportedTimeRange
        description: Unsupported time range.
      - value: InvalidLogDate
        description: Invalid log date.
      - value: InvalidLogId
        description: Invalid log id.
      - value: InvalidLogStartTime
        description: Invalid log start time.
      - value: InvalidLogEndTime
        description: Invalid log end time.
      - value: InvalidTopForLogs
        description: Invalid top for logs.
      - value: InvalidSkipTokenForLogs
        description: Invalid skip token for logs.
      - value: DeleteNotAllowed
        description: Delete not allowed.
      - value: Forbidden
        description: Forbidden.
      - value: DeployNotAllowed
        description: Deploy not allowed.
      - value: UnexpectedError
        description: Unexpected error.
      - value: InvalidCollection
        description: Invalid collection.
      - value: InvalidCallbackUri
        description: Invalid callback uri.
      - value: InvalidSasValidityDuration
        description: Invalid sas validity duration.
      - value: InaccessibleCustomerStorage
        description: Inaccessible customer storage.
      - value: UnsupportedClassBasedAdaptation
        description: Unsupported class based adaptation.
      - value: InvalidWebHookEventKind
        description: Invalid web hook event kind.
      - value: InvalidTimeToLive
        description: Invalid time to live.
  ServiceHealth:
    title: ServiceHealth
    type: object
    properties:
      status:
        $ref: '#/definitions/HealthStatus'
      message:
        description: Additional messages about the current service health.
        type: string
        readOnly: true
      components:
        description: Optional subcomponents of this service and their status.
        type: array
        items:
          $ref: '#/definitions/Component'
        readOnly: true
  HealthStatus:
    title: HealthStatus
    description: Health status of the service.
    enum:
    - Unhealthy
    - Degraded
    - Healthy
    type: string
    readOnly: true
    x-ms-enum:
      name: HealthStatus
      modelAsString: false
      values:
      - value: Unhealthy
        description: Unhealthy.
      - value: Degraded
        description: Degraded.
      - value: Healthy
        description: Healthy.
  InnerError:
    title: InnerError
    description: "New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested)."
    type: object
    properties:
      code:
        $ref: '#/definitions/DetailedErrorCode'
      details:
        description: Additional supportive details regarding the error and/or expected policies.
        type: object
        additionalProperties:
          type: string
      message:
        description: High level error message.
        type: string
      target:
        description: "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document."
        type: string
      innerError:
        $ref: '#/definitions/InnerError'
  Error:
    title: Error
    description: "New format which conforms to the new Cognitive Services API guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains an outer error with error code, message, details, target and an inner error with more descriptive details."
    type: object
    properties:
      code:
        $ref: '#/definitions/ErrorCode'
      details:
        description: Additional supportive details regarding the error and/or expected policies.
        type: array
        items:
          $ref: '#/definitions/Error'
      message:
        description: High level error message.
        type: string
      target:
        description: "The source of the error.\r\nFor example it would be \"documents\" or \"document id\" in case of invalid document."
        type: string
      innerError:
        $ref: '#/definitions/InnerError'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'