Azure Synapse Analytics Dataset API

openapi: 3.1.0
info:
  title: Azure Synapse Analytics - Access Control AzureADOnlyAuthentications Dataset API
  description: Manage role assignments, role definitions, and access control for Synapse workspace resources. Supports Synapse role-based access control for fine-grained permissions.
  version: '2020-12-01'
  contact:
    name: Microsoft Azure Support
    url: https://azure.microsoft.com/en-us/support/
  license:
    name: Microsoft
    url: https://azure.microsoft.com/en-us/support/legal/
servers:
- url: https://{workspaceName}.dev.azuresynapse.net
  description: Synapse Data Plane
  variables:
    workspaceName:
      description: The workspace name.
      default: myworkspace
security:
- azure_auth:
  - user_impersonation
tags:
- name: Dataset
paths:
  /datasets:
    get:
      operationId: Dataset_GetDatasetsByWorkspace
      summary: Azure Synapse Analytics List datasets
      description: Lists datasets in the workspace.
      tags:
      - Dataset
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the list of datasets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetListResponse'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /datasets/{datasetName}:
    get:
      operationId: Dataset_GetDataset
      summary: Azure Synapse Analytics Get a dataset
      description: Gets a dataset.
      tags:
      - Dataset
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/DatasetNameParameter'
      - name: If-None-Match
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the dataset.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetResource'
        '304':
          description: Not modified.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: Dataset_CreateOrUpdateDataset
      summary: Azure Synapse Analytics Create or update a dataset
      description: Creates or updates a dataset.
      tags:
      - Dataset
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/DatasetNameParameter'
      - name: If-Match
        in: header
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetResource'
      responses:
        '200':
          description: Successfully updated the dataset.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetResource'
        '202':
          description: Dataset creation accepted.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: Dataset_DeleteDataset
      summary: Azure Synapse Analytics Delete a dataset
      description: Deletes a dataset.
      tags:
      - Dataset
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/DatasetNameParameter'
      responses:
        '200':
          description: Successfully deleted the dataset.
        '202':
          description: Dataset deletion accepted.
        '204':
          description: Dataset not found.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /datasets/{datasetName}/rename:
    post:
      operationId: Dataset_RenameDataset
      summary: Azure Synapse Analytics Rename a dataset
      description: Renames a dataset.
      tags:
      - Dataset
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/DatasetNameParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArtifactRenameRequest'
      responses:
        '200':
          description: Successfully renamed the dataset.
        '202':
          description: Dataset rename accepted.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    DatasetListResponse:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/DatasetResource'
        nextLink:
          type: string
    ArtifactRenameRequest:
      type: object
      properties:
        newName:
          type: string
    DatasetResource:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        type:
          type: string
          readOnly: true
        etag:
          type: string
          readOnly: true
        properties:
          $ref: '#/components/schemas/Dataset'
    Dataset:
      type: object
      required:
      - type
      - linkedServiceName
      properties:
        type:
          type: string
          description: Type of dataset.
        description:
          type: string
        linkedServiceName:
          $ref: '#/components/schemas/LinkedServiceReference'
        parameters:
          type: object
          additionalProperties:
            type: object
        annotations:
          type: array
          items:
            type: string
        folder:
          type: object
          properties:
            name:
              type: string
        schema:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
        structure:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
    LinkedServiceReference:
      type: object
      properties:
        type:
          type: string
          enum:
          - LinkedServiceReference
        referenceName:
          type: string
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      schema:
        type: string
        default: '2020-12-01'
    DatasetNameParameter:
      name: datasetName
      in: path
      required: true
      description: The dataset name.
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: impersonate your user account