swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SqlCollectorOperations API
schemes:
- https
tags:
- name: SqlCollectorOperations
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors
  : get:
      operationId: microsoftAzureSqlcollectoroperationsListbyassessmentproject
      tags:
      - SqlCollectorOperations
      description: List SqlCollector resources by AssessmentProject
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: projectName
        in: path
        description: Assessment Project Name
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/SqlCollectorListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen:
          $ref: ./examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Sqlcollectors
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors/{collectorName}
  : get:
      operationId: microsoftAzureSqlcollectoroperationsGet
      tags:
      - SqlCollectorOperations
      description: Get a SqlCollector
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: projectName
        in: path
        description: Assessment Project Name
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      - name: collectorName
        in: path
        description: Sql collector ARM name.
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/SqlCollector'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        SqlCollectorOperations_Get_MaximumSet_Gen:
          $ref: ./examples/SqlCollectorOperations_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Sqlcollectors Collectorname
    put:
      operationId: microsoftAzureSqlcollectoroperationsCreate
      tags:
      - SqlCollectorOperations
      description: Create a SqlCollector
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: projectName
        in: path
        description: Assessment Project Name
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      - name: collectorName
        in: path
        description: Sql collector ARM name.
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/SqlCollector'
      responses:
        '200':
          description: Resource 'SqlCollector' update operation succeeded
          schema:
            $ref: '#/definitions/SqlCollector'
        '201':
          description: Resource 'SqlCollector' create operation succeeded
          schema:
            $ref: '#/definitions/SqlCollector'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      x-ms-examples:
        SqlCollectorOperations_Create_MaximumSet_Gen:
          $ref: ./examples/SqlCollectorOperations_Create_MaximumSet_Gen.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Sqlcollectors Collectorname
    delete:
      operationId: microsoftAzureSqlcollectoroperationsDelete
      tags:
      - SqlCollectorOperations
      description: Delete a SqlCollector
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: projectName
        in: path
        description: Assessment Project Name
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      - name: collectorName
        in: path
        description: Sql collector ARM name.
        required: true
        type: string
        pattern: ^[^<>&:\?/#]{1,260}$
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource deleted successfully.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        SqlCollectorOperations_Delete_MaximumSet_Gen:
          $ref: ./examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Assessmentprojects Projectname Sqlcollectors Collectorname
definitions:
  CollectorPropertiesBaseWithAgent:
    type: object
    description: Collector properties class.
    properties:
      agentProperties:
        $ref: '#/definitions/CollectorAgentPropertiesBase'
        description: Gets or sets the collector agent properties.
      discoverySiteId:
        type: string
        description: Gets the discovery site id.
      createdTimestamp:
        type: string
        format: date-time
        description: Gets the Timestamp when collector was created.
        readOnly: true
      updatedTimestamp:
        type: string
        format: date-time
        description: Timestamp when collector was last updated.
        readOnly: true
    allOf:
    - $ref: '#/definitions/AzureResourceProperties'
  CollectorAgentPropertiesBase:
    type: object
    description: Collector agent property class.
    properties:
      id:
        type: string
        description: Gets the collector agent id.
      version:
        type: string
        description: Gets the collector agent version.
      lastHeartbeatUtc:
        type: string
        format: date-time
        description: Gets the collector last heartbeat time.
      spnDetails:
        $ref: '#/definitions/CollectorAgentSpnPropertiesBase'
        description: Gets or sets the SPN details.
  AzureResourceProperties:
    type: object
    description: Common properties for all azure tracked and proxy resources.
    properties:
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
  ProvisioningState:
    type: string
    description: The status of the current operation.
    enum:
    - Succeeded
    - Failed
    - Canceled
    - Provisioning
    - Updating
    - Deleting
    - Accepted
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
      values:
      - name: Succeeded
        value: Succeeded
        description: Resource has been created.
      - name: Failed
        value: Failed
        description: Resource creation failed.
      - name: Canceled
        value: Canceled
        description: Resource creation was canceled.
      - name: Provisioning
        value: Provisioning
        description: Resource is being Provisioned.
      - name: Updating
        value: Updating
        description: Resource is being Updated.
      - name: Deleting
        value: Deleting
        description: Resource is being Deleted.
      - name: Accepted
        value: Accepted
        description: Resource is being Accepted.
  SqlCollector:
    type: object
    description: The SQL collector REST object.
    properties:
      properties:
        $ref: '#/definitions/CollectorPropertiesBaseWithAgent'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
    allOf:
    - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
  SqlCollectorListResult:
    type: object
    description: The response of a SqlCollector list operation.
    properties:
      value:
        type: array
        description: The SqlCollector items on this page
        items:
          $ref: '#/definitions/SqlCollector'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  CollectorAgentSpnPropertiesBase:
    type: object
    description: Collector agent SPN details class.
    properties:
      authority:
        type: string
        description: Gets the AAD authority endpoint.
      applicationId:
        type: string
        description: Gets the AAD application id.
      audience:
        type: string
        description: Gets the AAD audience url.
      objectId:
        type: string
        description: Gets the object id of the AAD application.
      tenantId:
        type: string
        description: Gets the tenant id of the AAD application.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'