Microsoft Azure Discovery Groups API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Discovery Groups API
schemes:
- https
tags:
- name: Discovery Groups
paths:
  /discoGroups:
    get:
      operationId: microsoftAzureDiscoverygroupsListdiscogroup
      tags:
      - Discovery Groups
      description: Retrieve a list of discovery group for the provided search parameters.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/Azure.Core.FilterQueryParameter'
      - $ref: '#/parameters/Azure.Core.SkipQueryParameter'
      - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedDiscoGroup'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        DiscoveryGroups_ListDiscoGroup:
          $ref: ./examples/DiscoveryGroups_ListDiscoGroup_MaximumSet_Gen.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Discogroups
  /discoGroups/{groupName}:
    get:
      operationId: microsoftAzureDiscoverygroupsGetdiscogroup
      tags:
      - Discovery Groups
      description: Retrieve a discovery group with a given groupName.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: groupName
        in: path
        description: The caller provided unique name for the resource.
        required: true
        type: string
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/DiscoGroup'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        DiscoveryGroups_GetDiscoGroup:
          $ref: ./examples/DiscoveryGroups_GetDiscoGroup_MaximumSet_Gen.json
      summary: Microsoft Azure Get Discogroups Groupname
    put:
      operationId: microsoftAzureDiscoverygroupsCreateorreplacediscogroup
      tags:
      - Discovery Groups
      description: Create a discovery group with a given groupName.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: groupName
        in: path
        description: The caller provided unique name for the resource.
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/DiscoGroupData'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/DiscoGroup'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        DiscoveryGroups_CreateOrReplaceDiscoGroup:
          $ref: ./examples/DiscoveryGroups_CreateOrReplaceDiscoGroup_MaximumSet_Gen.json
      summary: Microsoft Azure Put Discogroups Groupname
  /discoGroups/{groupName}:run:
    post:
      operationId: microsoftAzureDiscoverygroupsRundiscogroup
      tags:
      - Discovery Groups
      description: Run a discovery group with a given groupName.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: groupName
        in: path
        description: The caller provided unique name for the resource.
        required: true
        type: string
      responses:
        '204':
          description: 'There is no content to send for this request, but the headers may be useful. '
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        DiscoveryGroups_RunDiscoGroup:
          $ref: ./examples/DiscoveryGroups_RunDiscoGroup_MaximumSet_Gen.json
      summary: Microsoft Azure Post Discogroups Groupname:run
  /discoGroups/{groupName}/runs:
    get:
      operationId: microsoftAzureDiscoverygroupsListruns
      tags:
      - Discovery Groups
      description: Retrieve a collection of discovery run results for a discovery group with a given groupName.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/Azure.Core.FilterQueryParameter'
      - $ref: '#/parameters/Azure.Core.SkipQueryParameter'
      - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter'
      - $ref: '#/parameters/DiscoGroupNameParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/DiscoRunPageResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        DiscoveryGroups_ListRuns:
          $ref: ./examples/DiscoveryGroups_ListRuns_MaximumSet_Gen.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Discogroups Groupname Runs
  /discoGroups:validate:
    post:
      operationId: microsoftAzureDiscoverygroupsValidatediscogroup
      tags:
      - Discovery Groups
      description: Validate a discovery group with a given groupName.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/DiscoGroupData'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/ValidateResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        DiscoveryGroups_ValidateDiscoGroup:
          $ref: ./examples/DiscoveryGroups_ValidateDiscoGroup_MaximumSet_Gen.json
      summary: Microsoft Azure Post Discogroups:validate
definitions:
  PagedDiscoGroup:
    type: object
    description: Paged collection of DiscoGroup items
    properties:
      value:
        type: array
        description: The DiscoGroup items on this page
        items:
          $ref: '#/definitions/DiscoGroup'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
      totalElements:
        type: integer
        format: int64
        description: The total number of items available in the full result set.
    required:
    - value
  ErrorDetail:
    type: object
    description: This is the top-level error object whose code matches the x-ms-error-code response header.
    properties:
      code:
        type: string
        description: This is one of a server-defined set of error codes.
      message:
        type: string
        description: This is a human-readable representation of the error.
      target:
        type: string
        description: This is the error target.
      details:
        type: array
        description: This is an array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/ErrorDetail'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/InnerError'
        description: This is an object containing more specific information than the current object about the error.
    required:
    - code
    - message
  DiscoRunResult:
    type: object
    description: The latest run of this disco group with some limited information, null if the group has never been run.
    properties:
      submittedDate:
        type: string
        format: date-time
        description: The date for when the disco run was created in the system.
      startedDate:
        type: string
        format: date-time
        description: The date for when the disco run was actually started by the system.
      completedDate:
        type: string
        format: date-time
        description: The date for when the disco run was completed by the system.
      tier:
        type: string
        description: The tier which will affect the algorithm used for the disco run.
      state:
        $ref: '#/definitions/DiscoRunState'
        description: The State of the disco run.
      totalAssetsFoundCount:
        type: integer
        format: int64
        description: The total count of assets that were found this disco run.
      seeds:
        type: array
        description: The list of seeds used for the disco run.
        items:
          $ref: '#/definitions/DiscoSource'
        x-ms-identifiers: []
      excludes:
        type: array
        description: The list of excludes used for the disco run, aka assets to exclude from the discovery algorithm.
        items:
          $ref: '#/definitions/DiscoSource'
        x-ms-identifiers: []
      names:
        type: array
        description: The list of names used for the disco run.
        items:
          type: string
  DiscoRunPageResult:
    type: object
    properties:
      totalElements:
        type: integer
        format: int64
        description: The total number of items available in the full result set.
      nextLink:
        type: string
        description: The link to access the next page of results.  Not set if at the end of the result set.
      value:
        type: array
        description: The items in the current page of results.
        items:
          $ref: '#/definitions/DiscoRunResult'
        x-ms-identifiers: []
  DiscoGroup:
    type: object
    properties:
      id:
        type: string
        description: The system generated unique id for the resource.
      name:
        type: string
        description: The caller provided unique name for the resource.
        readOnly: true
      displayName:
        type: string
        description: The name that can be used for display purposes.
      description:
        type: string
        description: The description for a disco group.
      tier:
        type: string
        description: The tier for the disco group which will affect the algorithm used for the disco runs in this group.
      frequencyMilliseconds:
        type: integer
        format: int64
        description: The frequency at which the disco group is supposed to be rerun in milliseconds.
      seeds:
        type: array
        description: The list of seeds used for the disco group runs.
        items:
          $ref: '#/definitions/DiscoSource'
        x-ms-identifiers: []
      names:
        type: array
        description: The list of names used for the disco group runs.
        items:
          type: string
      excludes:
        type: array
        description: The list of excludes used for the disco group runs, aka assets to exclude from the discovery algorithm.
        items:
          $ref: '#/definitions/DiscoSource'
        x-ms-identifiers: []
      latestRun:
        $ref: '#/definitions/DiscoRunResult'
        description: The latest run of this disco group with some limited information, null if the group has never been run.
      createdDate:
        type: string
        format: date-time
        description: The date for the disco group was created.
      templateId:
        type: string
        description: The unique identifier for the disco template used for the disco group creation.
    required:
    - name
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
  DiscoRunState:
    type: string
    description: The State of the disco run.
    enum:
    - pending
    - running
    - completed
    - failed
    x-ms-enum:
      name: DiscoRunState
      modelAsString: true
  DiscoSourceKind:
    type: string
    description: The kind of disco source.
    enum:
    - as
    - attribute
    - contact
    - domain
    - host
    - ipBlock
    x-ms-enum:
      name: DiscoSourceKind
      modelAsString: true
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing error details.
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
    - error
  ValidateResult:
    type: object
    description: Validate result for validate action endpoints
    properties:
      error:
        $ref: '#/definitions/ErrorDetail'
        description: This is the top-level error object whose code matches the x-ms-error-code response header.
  DiscoSource:
    type: object
    description: Source entity used to drive discovery.
    properties:
      kind:
        $ref: '#/definitions/DiscoSourceKind'
        description: The kind of disco source.
      name:
        type: string
        description: The name for the disco source.
  DiscoGroupData:
    type: object
    description: A request body used to create a discovery group.
    properties:
      name:
        type: string
        description: The name for a disco group.
      description:
        type: string
        description: The description for a disco group.
      tier:
        type: string
        description: The tier for the disco group which will affect the algorithm used for the disco runs in this group.
      frequencyMilliseconds:
        type: integer
        format: int64
        description: The frequency at which the disco group is supposed to be rerun in milliseconds.
      seeds:
        type: array
        description: The list of seeds used for the disco group runs.
        items:
          $ref: '#/definitions/DiscoSource'
        x-ms-identifiers: []
      names:
        type: array
        description: The list of names used for the disco group runs.
        items:
          type: string
      excludes:
        type: array
        description: The list of excludes used for the disco group runs, aka assets to exclude from the discovery algorithm.
        items:
          $ref: '#/definitions/DiscoSource'
        x-ms-identifiers: []
      templateId:
        type: string
        description: The unique identifier for the disco template used for the disco group creation.
  Azure.Core.Foundations.InnerError:
    type: object
    description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: Inner error.
  InnerError:
    type: object
    description: This is an object containing more specific information than the current object about the error.
    properties:
      code:
        type: string
        description: This is a more specific error code than was provided by the containing error.
      value:
        description: This is an additional field representing the value that caused the error to help with debugging.
parameters:
  Azure.Core.FilterQueryParameter:
    name: filter
    in: query
    description: Filter the result list using the given expression.
    required: false
    type: string
    x-ms-parameter-location: method
  DiscoGroupNameParameter:
    name: groupName
    in: path
    description: The unique identifier for the discovery group.
    required: true
    type: string
    x-ms-parameter-location: method
  Azure.Core.MaxPageSizeQueryParameter:
    name: maxpagesize
    in: query
    description: The maximum number of result items per page.
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  Azure.Core.SkipQueryParameter:
    name: skip
    in: query
    description: The number of result items to skip.
    required: false
    type: integer
    format: int32
    default: 0
    x-ms-parameter-location: method
  Azure.Core.Foundations.ApiVersionParameter:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'