swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Disco Groups API
  description: Provides access to discovery resources.
schemes:
- https
tags:
- description: Provides access to discovery resources.
  name: Disco Groups
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/discoGroups:
    get:
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/SkipParameter'
      - $ref: '#/parameters/MaxPageSizeParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DiscoGroupPageResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - Disco Groups
      operationId: microsoftAzureDiscogroupsList
      summary: Microsoft Azure Retrieve A List Of Disco Group For The Provided Search Parameters
      x-ms-examples:
        DiscoGroups:
          $ref: ./examples/DiscoGroups_List.json
      x-ms-pageable:
        itemName: content
        nextLinkName: nextLink
      description: Needs a more full description created.
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/discoGroups/{discoGroupName}:
    delete:
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/DiscoGroupNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '204':
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - Disco Groups
      operationId: microsoftAzureDiscogroupsRemove
      summary: Microsoft Azure Remove A Disco Group With A Given Discogroupname
      x-ms-examples:
        DiscoGroups:
          $ref: ./examples/DiscoGroups_Remove.json
      description: Needs a more full description created.
    get:
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/DiscoGroupNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DiscoGroupResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - Disco Groups
      operationId: microsoftAzureDiscogroupsGet
      summary: Microsoft Azure Retrieve A Disco Group With A Given Discogroupname
      x-ms-examples:
        DiscoGroups:
          $ref: ./examples/DiscoGroups_Get.json
      description: Needs a more full description created.
    put:
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/DiscoGroupNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/DiscoGroupRequest'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DiscoGroupResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - Disco Groups
      operationId: microsoftAzureDiscogroupsPut
      summary: Microsoft Azure Create A Disco Group With A Given Discogroupname
      x-ms-examples:
        DiscoGroups:
          $ref: ./examples/DiscoGroups_Put.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/discoGroups/{discoGroupName}/runs
  : get:
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/DiscoGroupNameParameter'
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/SkipParameter'
      - $ref: '#/parameters/MaxPageSizeParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DiscoRunPageResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - Disco Groups
      operationId: microsoftAzureDiscogroupsListruns
      summary: Microsoft Azure Retrieve A Collection Of Disco Run Results For A Disco Group With A Given Discogroupname
      x-ms-examples:
        DiscoGroups:
          $ref: ./examples/DiscoGroups_ListRuns.json
      x-ms-pageable:
        itemName: content
        nextLinkName: nextLink
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/discoGroups/{discoGroupName}:run
  : post:
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/DiscoGroupNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '204':
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
      tags:
      - Disco Groups
      operationId: microsoftAzureDiscogroupsRun
      summary: Microsoft Azure Run A Disco Group With A Given Discogroupname
      x-ms-examples:
        DiscoGroups:
          $ref: ./examples/DiscoGroups_Run.json
      description: Needs a more full description created.
definitions:
  DiscoRunResponse:
    properties:
      completedDate:
        description: The date for when the disco run was completed in the microservice.
        format: date-time
        type: string
      excludes:
        description: The list of excludes used for the disco run, aka assets to exclude from the discovery algorithm.
        items:
          $ref: '#/definitions/AssetId'
        type: array
      newAssetsFoundCount:
        description: The count of the new assets that were found this disco run, aka that are labeled with this runs id at this time
        format: int64
        type: integer
      seeds:
        description: The list of seeds used for the disco run.
        items:
          $ref: '#/definitions/AssetId'
        type: array
      startedDate:
        description: The date for when the disco run was actually started in the microservice.
        format: date-time
        type: string
      state:
        description: The State of the disco run
        enum:
        - pending
        - running
        - completed
        - failed
        type: string
        x-ms-enum:
          modelAsString: true
          name: discoRunResponseState
      submittedDate:
        description: The date for when the disco run was created in the microservice.
        format: date-time
        type: string
      tier:
        description: The tier which will affect the algorithm used for the disco run.
        type: string
      totalAssetsFoundCount:
        description: The total count of assets that were found this disco run.
        format: int64
        type: integer
    type: object
  ErrorResponse:
    properties:
      error:
        $ref: '#/definitions/ErrorDetail'
    required:
    - error
    type: object
  DiscoGroupResponse:
    properties:
      createdDate:
        description: The date for the disco group was created.
        format: date-time
        type: string
      description:
        description: The description for a disco group.
        type: string
      displayName:
        type: string
      excludes:
        description: The list of excludes used for the disco group runs, aka assets to exclude from the discovery algorithm.
        items:
          $ref: '#/definitions/AssetId'
        type: array
      frequencyMilliseconds:
        description: The frequency at which the disco group is supposed to be rerun in milliseconds.
        format: int64
        type: integer
      id:
        type: string
      latestRunDate:
        description: The date for the latest run of this disco group, null if the group has never been run.
        format: date-time
        type: string
      name:
        type: string
      seeds:
        description: The list of seeds used for the disco group runs.
        items:
          $ref: '#/definitions/AssetId'
        type: array
      tier:
        description: The tier for the disco group which will affect the algorithm used for the disco runs in this group.
        type: string
      totalAssetsFoundCount:
        description: The total count of assets that were found for this disco group, aka that are labeled with this groups id at this time.
        format: int64
        type: integer
    type: object
  DiscoRunPageResponse:
    properties:
      content:
        items:
          $ref: '#/definitions/DiscoRunResponse'
        type: array
      first:
        type: boolean
      last:
        type: boolean
      nextLink:
        type: string
      number:
        format: int32
        type: integer
      numberOfElements:
        format: int32
        type: integer
      size:
        format: int32
        type: integer
      totalElements:
        format: int64
        type: integer
      totalPages:
        format: int32
        type: integer
    type: object
  ErrorDetail:
    description: This is the top-level error object whose code matches the x-ms-error-code response header
    properties:
      code:
        description: This is one of a server-defined set of error codes.
        type: string
      details:
        description: This is an array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/ErrorDetail'
        type: array
      innererror:
        $ref: '#/definitions/InnerError'
      message:
        description: This is a human-readable representation of the error.
        type: string
      target:
        description: This is the error target.
        type: string
    required:
    - code
    - message
    type: object
  DiscoGroupPageResponse:
    properties:
      content:
        items:
          $ref: '#/definitions/DiscoGroupResponse'
        type: array
      first:
        type: boolean
      last:
        type: boolean
      nextLink:
        type: string
      number:
        format: int32
        type: integer
      numberOfElements:
        format: int32
        type: integer
      size:
        format: int32
        type: integer
      totalElements:
        format: int64
        type: integer
      totalPages:
        format: int32
        type: integer
    type: object
  DiscoGroupRequest:
    properties:
      description:
        description: The description for a disco group.
        type: string
      excludes:
        description: The list of excludes used for the disco group runs, aka assets to exclude from the discovery algorithm.
        items:
          $ref: '#/definitions/AssetId'
        type: array
      frequencyMilliseconds:
        description: The frequency at which the disco group is supposed to be rerun in milliseconds.
        format: int64
        type: integer
      seeds:
        description: The list of seeds used for the disco group runs.
        items:
          $ref: '#/definitions/AssetId'
        type: array
      tier:
        description: The tier for the disco group which will affect the algorithm used for the disco runs in this group.
        type: string
    required:
    - frequencyMilliseconds
    type: object
  InnerError:
    description: This is an object containing more specific information than the current object about the error.
    properties:
      code:
        description: This is a more specific error code than was provided by the containing error..
        type: string
    type: object
  AssetId:
    description: The list of excludes used for the disco group runs, aka assets to exclude from the discovery algorithm.
    properties:
      displayName:
        type: string
      id:
        type: string
      kind:
        enum:
        - as
        - contact
        - domain
        - host
        - ipAddress
        - ipBlock
        - page
        - sslCert
        type: string
        x-ms-enum:
          modelAsString: true
          name: assetIdKind
      name:
        type: string
    type: object
parameters:
  SkipParameter:
    default: 0
    description: An offset into the collection of the first resource to be returned.
    format: int32
    in: query
    name: skip
    required: false
    type: integer
    x-ms-parameter-location: method
  MaxPageSizeParameter:
    default: 20
    description: An offset into the collection of the first resource to be returned.
    format: int32
    in: query
    name: maxpagesize
    required: false
    type: integer
    x-ms-parameter-location: method
  FilterParameter:
    description: An expression on the resource type that selects the resources to be returned.
    in: query
    name: filter
    required: false
    type: string
    x-ms-parameter-location: method
  WorkspaceNameParameter:
    description: The name of the Workspace.
    in: path
    name: workspaceName
    required: true
    type: string
    x-ms-parameter-location: method
  DiscoGroupNameParameter:
    in: path
    name: discoGroupName
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'