swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Data Connections API
schemes:
- https
tags:
- name: Data Connections
paths:
  /dataConnections:
    get:
      operationId: microsoftAzureDataconnectionsListdataconnection
      tags:
      - Data Connections
      description: Retrieve a list of data connections.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/Azure.Core.SkipQueryParameter'
      - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedDataConnection'
        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:
        DataConnections_ListDataConnection:
          $ref: ./examples/DataConnections_ListDataConnection_MaximumSet_Gen.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Dataconnections
  /dataConnections/{dataConnectionName}:
    get:
      operationId: microsoftAzureDataconnectionsGetdataconnection
      tags:
      - Data Connections
      description: Retrieve a data connection with a given dataConnectionName.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: dataConnectionName
        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/DataConnection'
        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:
        DataConnections_GetDataConnection:
          $ref: ./examples/DataConnections_GetDataConnection_MaximumSet_Gen.json
      summary: Microsoft Azure Get Dataconnections Dataconnectionname
    put:
      operationId: microsoftAzureDataconnectionsCreateorreplacedataconnection
      tags:
      - Data Connections
      description: Create or replace a data connection with a given dataConnectionName.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: dataConnectionName
        in: path
        description: The caller provided unique name for the resource.
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/DataConnectionData'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/DataConnection'
        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:
        DataConnections_CreateOrReplaceDataConnection:
          $ref: ./examples/DataConnections_CreateOrReplaceDataConnection_MaximumSet_Gen.json
      summary: Microsoft Azure Put Dataconnections Dataconnectionname
    delete:
      operationId: microsoftAzureDataconnectionsDeletedataconnection
      tags:
      - Data Connections
      description: Delete a data connection with a given dataConnectionName.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: dataConnectionName
        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:
        DataConnections_DeleteDataConnection:
          $ref: ./examples/DataConnections_DeleteDataConnection_MaximumSet_Gen.json
      summary: Microsoft Azure Delete Dataconnections Dataconnectionname
  /dataConnections:validate:
    post:
      operationId: microsoftAzureDataconnectionsValidatedataconnection
      tags:
      - Data Connections
      description: Validate a data connection with a given dataConnectionName.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/DataConnectionData'
      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:
        DataConnections_ValidateDataConnection:
          $ref: ./examples/DataConnections_ValidateDataConnection_MaximumSet_Gen.json
      summary: Microsoft Azure Post Dataconnections:validate
definitions:
  DataConnection:
    type: object
    properties:
      kind:
        type: string
        description: Discriminator property for DataConnection.
      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.
      content:
        $ref: '#/definitions/DataConnectionContent'
        description: The type of data the data connection will transfer
      createdDate:
        type: string
        format: date-time
        description: The date the data connection was created.
        readOnly: true
      frequency:
        $ref: '#/definitions/DataConnectionFrequency'
        description: The rate at which the data connection will receive updates.
      frequencyOffset:
        type: integer
        format: int32
        description: The day to update the data connection on.
      updatedDate:
        type: string
        format: date-time
        description: The date the data connection was last updated.
        readOnly: true
      userUpdatedAt:
        type: string
        format: date-time
        description: The date the data connection was last updated by user.
        readOnly: true
      active:
        type: boolean
        description: An indicator of whether the data connection is active.
      inactiveMessage:
        type: string
        description: A message that specifies details about data connection if inactive.
        readOnly: true
    discriminator: kind
    required:
    - kind
    - name
  DataConnectionData:
    type: object
    properties:
      kind:
        type: string
        description: Discriminator property for DataConnectionData.
      name:
        type: string
        description: The name of data connection
      content:
        $ref: '#/definitions/DataConnectionContent'
        description: The type of data the data connection will transfer.
      frequency:
        $ref: '#/definitions/DataConnectionFrequency'
        description: The rate at which the data connection will receive updates.
      frequencyOffset:
        type: integer
        format: int32
        description: The day to update the data connection on. (1-7 for weekly, 1-31 for monthly)
    discriminator: kind
    required:
    - kind
  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
  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
  DataConnectionContent:
    type: string
    description: The type of data the data connection will transfer
    enum:
    - assets
    - attackSurfaceInsights
    x-ms-enum:
      name: DataConnectionContent
      modelAsString: true
  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.
  PagedDataConnection:
    type: object
    description: Paged collection of DataConnection items
    properties:
      value:
        type: array
        description: The DataConnection items on this page
        items:
          $ref: '#/definitions/DataConnection'
      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
  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.
  DataConnectionFrequency:
    type: string
    description: The rate at which the data connection will receive updates.
    enum:
    - daily
    - weekly
    - monthly
    x-ms-enum:
      name: DataConnectionFrequency
      modelAsString: true
  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.
  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
parameters:
  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'