swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DomainsApi API
schemes:
- https
tags:
- name: DomainsApi
paths:
  /domains:
    get:
      tags:
      - DomainsApi
      summary: Microsoft Azure Get A List Of The Available Domains
      operationId: microsoftAzureGetdomains
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters: []
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Domain'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetDomains request:
          $ref: ./examples/GetDomains.json
      description: Needs a more full description created.
  /domains/{domainId}:
    get:
      tags:
      - DomainsApi
      summary: Microsoft Azure Get Information About A Specific Domain
      operationId: microsoftAzureGetdomain
      consumes: []
      produces:
      - application/json
      - application/xml
      - text/xml
      parameters:
      - name: domainId
        in: path
        description: The id of the domain to get information about.
        required: true
        type: string
        format: uuid
        x-nullable: false
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Domain'
        default:
          description: Error response
          schema:
            $ref: '#/definitions/CustomVisionError'
      x-ms-examples:
        Successful GetDomain request:
          $ref: ./examples/GetDomain.json
      description: Needs a more full description created.
definitions:
  Domain:
    type: object
    properties:
      id:
        format: uuid
        type: string
        readOnly: true
        example: 00000000-0000-0000-0000-000000000000
        x-nullable: false
      name:
        type: string
        readOnly: true
        x-nullable: false
      type:
        enum:
        - Classification
        - ObjectDetection
        type: string
        readOnly: true
        x-nullable: false
        x-ms-enum:
          name: DomainType
          modelAsString: true
      exportable:
        type: boolean
        readOnly: true
        x-nullable: false
      enabled:
        type: boolean
        readOnly: true
        x-nullable: false
  CustomVisionError:
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: The error code.
        enum:
        - NoError
        - BadRequest
        - BadRequestExceededBatchSize
        - BadRequestNotSupported
        - BadRequestInvalidIds
        - BadRequestProjectName
        - BadRequestProjectNameNotUnique
        - BadRequestProjectDescription
        - BadRequestProjectUnknownDomain
        - BadRequestProjectUnknownClassification
        - BadRequestProjectUnsupportedDomainTypeChange
        - BadRequestProjectUnsupportedExportPlatform
        - BadRequestProjectImagePreprocessingSettings
        - BadRequestProjectDuplicated
        - BadRequestIterationName
        - BadRequestIterationNameNotUnique
        - BadRequestIterationDescription
        - BadRequestIterationIsNotTrained
        - BadRequestIterationValidationFailed
        - BadRequestWorkspaceCannotBeModified
        - BadRequestWorkspaceNotDeletable
        - BadRequestTagName
        - BadRequestTagNameNotUnique
        - BadRequestTagDescription
        - BadRequestTagType
        - BadRequestMultipleNegativeTag
        - BadRequestMultipleGeneralProductTag
        - BadRequestImageTags
        - BadRequestImageRegions
        - BadRequestNegativeAndRegularTagOnSameImage
        - BadRequestUnsupportedDomain
        - BadRequestRequiredParamIsNull
        - BadRequestIterationIsPublished
        - BadRequestInvalidPublishName
        - BadRequestInvalidPublishTarget
        - BadRequestUnpublishFailed
        - BadRequestIterationNotPublished
        - BadRequestSubscriptionApi
        - BadRequestExceedProjectLimit
        - BadRequestExceedIterationPerProjectLimit
        - BadRequestExceedTagPerProjectLimit
        - BadRequestExceedTagPerImageLimit
        - BadRequestExceededQuota
        - BadRequestCannotMigrateProjectWithName
        - BadRequestNotLimitedTrial
        - BadRequestImageBatch
        - BadRequestImageStream
        - BadRequestImageUrl
        - BadRequestImageFormat
        - BadRequestImageSizeBytes
        - BadRequestImageDimensions
        - BadRequestImageExceededCount
        - BadRequestTrainingNotNeeded
        - BadRequestTrainingNotNeededButTrainingPipelineUpdated
        - BadRequestTrainingValidationFailed
        - BadRequestClassificationTrainingValidationFailed
        - BadRequestMultiClassClassificationTrainingValidationFailed
        - BadRequestMultiLabelClassificationTrainingValidationFailed
        - BadRequestDetectionTrainingValidationFailed
        - BadRequestTrainingAlreadyInProgress
        - BadRequestDetectionTrainingNotAllowNegativeTag
        - BadRequestInvalidEmailAddress
        - BadRequestDomainNotSupportedForAdvancedTraining
        - BadRequestExportPlatformNotSupportedForAdvancedTraining
        - BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining
        - BadRequestExportValidationFailed
        - BadRequestExportAlreadyInProgress
        - BadRequestPredictionIdsMissing
        - BadRequestPredictionIdsExceededCount
        - BadRequestPredictionTagsExceededCount
        - BadRequestPredictionResultsExceededCount
        - BadRequestPredictionInvalidApplicationName
        - BadRequestPredictionInvalidQueryParameters
        - BadRequestInvalidImportToken
        - BadRequestExportWhileTraining
        - BadRequestImageMetadataKey
        - BadRequestImageMetadataValue
        - BadRequestOperationNotSupported
        - BadRequestInvalidArtifactUri
        - BadRequestCustomerManagedKeyRevoked
        - BadRequestInvalid
        - UnsupportedMediaType
        - Forbidden
        - ForbiddenUser
        - ForbiddenUserResource
        - ForbiddenUserSignupDisabled
        - ForbiddenUserSignupAllowanceExceeded
        - ForbiddenUserDoesNotExist
        - ForbiddenUserDisabled
        - ForbiddenUserInsufficientCapability
        - ForbiddenDRModeEnabled
        - ForbiddenInvalid
        - NotFound
        - NotFoundProject
        - NotFoundProjectDefaultIteration
        - NotFoundIteration
        - NotFoundIterationPerformance
        - NotFoundTag
        - NotFoundImage
        - NotFoundDomain
        - NotFoundApimSubscription
        - NotFoundInvalid
        - Conflict
        - ConflictInvalid
        - ErrorUnknown
        - ErrorIterationCopyFailed
        - ErrorPreparePerformanceMigrationFailed
        - ErrorProjectInvalidWorkspace
        - ErrorProjectInvalidPipelineConfiguration
        - ErrorProjectInvalidDomain
        - ErrorProjectTrainingRequestFailed
        - ErrorProjectImportRequestFailed
        - ErrorProjectExportRequestFailed
        - ErrorFeaturizationServiceUnavailable
        - ErrorFeaturizationQueueTimeout
        - ErrorFeaturizationInvalidFeaturizer
        - ErrorFeaturizationAugmentationUnavailable
        - ErrorFeaturizationUnrecognizedJob
        - ErrorFeaturizationAugmentationError
        - ErrorExporterInvalidPlatform
        - ErrorExporterInvalidFeaturizer
        - ErrorExporterInvalidClassifier
        - ErrorPredictionServiceUnavailable
        - ErrorPredictionModelNotFound
        - ErrorPredictionModelNotCached
        - ErrorPrediction
        - ErrorPredictionStorage
        - ErrorRegionProposal
        - ErrorUnknownBaseModel
        - ErrorInvalid
        type: string
        x-ms-enum:
          name: CustomVisionErrorCodes
          modelAsString: true
      message:
        description: A message explaining the error reported by the service.
        type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'