Azure Synapse Analytics

Azure Synapse Analytics is an enterprise analytics service that accelerates time to insight across data warehouses and big data systems. It brings together the best of SQL technologies used in enterprise data warehousing, Spark technologies for big data, and Pipelines for data integration and ETL/ELT.

30 APIs 0 Features

AnalyticsApache SparkBig DataData IntegrationData WarehouseETLSQL

APIs

Synapse Workspace API

Manage Synapse workspaces including creation, configuration, and lifecycle management of analytics environments through Azure Resource Manager.

Synapse SQL Pools API

Manage dedicated SQL pools for enterprise data warehousing workloads including provisioning, scaling, pausing, and resuming compute resources.

Synapse Spark Pools API

Manage Apache Spark pools for big data processing including pool creation, auto-scaling configuration, and Spark runtime version management.

Synapse Pipeline API

Create and manage data integration pipelines for ETL/ELT workflows. Supports orchestrating data movement and transformation activities across diverse data stores.

Synapse Spark Job API

Submit and manage Apache Spark batch jobs and interactive sessions. Provides operations for monitoring job status, retrieving logs, and cancelling running applications.

Synapse Monitoring API

Monitor pipeline runs, Spark jobs, and SQL requests within a Synapse workspace. Provides visibility into execution status, performance metrics, and operational health.

Synapse Link API

Manage Azure Synapse Link for real-time analytics over operational data. Enables hybrid transactional and analytical processing without impacting operational workloads.

Synapse Access Control API

Manage role assignments, role definitions, and access control for Synapse workspace resources. Supports Synapse role-based access control for fine-grained permissions.

Synapse Notebook API

Create, update, list, and delete notebooks within a Synapse workspace. Notebooks support interactive data exploration using Python, Scala, SQL, and .NET languages.

Synapse Dataset API

Create and manage datasets that represent data structures within linked data stores. Datasets define the schema and location of data used in pipelines and data flows.

Synapse Linked Service API

Create and manage linked services that define connection information to external data sources. Linked services act as connection strings for integrating with databases, storage,...

Synapse Data Flow API

Create and manage data flows for visual data transformation logic. Data flows enable code-free data transformation at scale within Synapse pipelines.

Synapse SQL Script API

Create, update, list, and delete SQL scripts within a Synapse workspace. SQL scripts can target both dedicated and serverless SQL pools for querying and data management.

Synapse Trigger API

Create and manage triggers that orchestrate pipeline execution. Supports schedule-based, tumbling window, and event-based triggers for automated workflow execution.

Synapse Spark Job Definition API

Create and manage Spark job definitions as reusable templates for batch processing. Spark job definitions encapsulate configuration, code, and dependencies for repeatable execut...

Synapse Managed Private Endpoints API

Create and manage managed private endpoints within a Synapse managed virtual network. Enables secure, private connectivity to Azure resources without exposing traffic to the pub...

Synapse Integration Runtimes API

Manage integration runtimes that provide the compute infrastructure for data integration activities. Supports Azure-hosted, self-hosted, and Azure-SSIS integration runtime types.

Synapse Library API

Manage workspace libraries including JAR files, Python wheels, and other packages used by Spark pools. Supports uploading, listing, and deleting library resources.

Synapse Git Integration API

Manage Git repository integration for Synapse workspaces. Enables source control for workspace artifacts including pipelines, notebooks, and data flows through Git-based version...

Synapse Firewall Rules API

Manage IP firewall rules for Synapse workspaces to control network access. Supports creating, updating, and deleting server-level IP firewall rules for workspace security.

Synapse Keys API

Manage workspace encryption keys for data protection at rest. Supports customer-managed key configuration for dedicated SQL pools and workspace-level encryption.

Synapse Private Endpoint Connections API

Manage private endpoint connections to Synapse workspaces. Enables approval and management of private link connections for secure access from virtual networks.

Synapse Private Link Hubs API

Manage private link hubs that enable connecting to Synapse Studio through Azure Private Link. Provides centralized private connectivity for workspace management operations.

Synapse Kusto Pools API

Manage Data Explorer (Kusto) pools within a Synapse workspace for real-time log and telemetry analytics. Supports creating pools, databases, and managing data connections.

Synapse Azure AD Only Authentication API

Manage Azure Active Directory only authentication settings for Synapse workspaces. Enables enforcing Azure AD authentication and disabling SQL authentication for enhanced security.

Synapse Spark Configuration API

Create and manage reusable Spark configuration artifacts for Synapse Spark pools. Supports defining Spark properties, environment variables, and package requirements as shareabl...

Synapse Data Flow Debug Session API

Manage data flow debug sessions for interactive testing and debugging of data flow transformations. Enables previewing data and validating transformation logic before deployment.

Synapse Credential API

Manage credential artifacts used for authenticating with external data sources in Synapse workspaces. Supports creating and managing credentials referenced by linked services an...

Synapse KQL Script API

Create and manage KQL (Kusto Query Language) scripts for querying Data Explorer pools. Supports authoring and storing KQL queries as workspace artifacts.

Synapse Link Connection API

Manage Synapse Link connections for continuous data replication from operational databases. Supports configuring and monitoring real-time data synchronization from sources like ...

ARAZZO

Pricing Plans

Microsoft Azure Synapse Analytics Plans Pricing

5 plans

PLANS

Rate Limits

Microsoft Azure Synapse Analytics Rate Limits

7 limits

RATE LIMITS

FinOps

Microsoft Azure Synapse Analytics Finops

FINOPS

Semantic Vocabularies

Azure Synapse Analytics Context

0 classes · 25 properties

JSON-LD

JSON Structure

Microsoft Azure Synapse Analytics Structure

0 properties

JSON STRUCTURE

Resources

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Azure Synapse Analytics - Workspace API
  version: '2021-06-01'
request:
  auth:
    type: oauth2
    flow: implicit
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    credentials:
      clientId: '{{clientId}}'
items:
- info:
    name: Workspaces
    type: folder
  items:
  - info:
      name: Azure Synapse Analytics List workspaces by subscription
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/providers/Microsoft.Synapse/workspaces
      params:
      - name: api-version
        value: ''
        type: query
        description: The API version to use for this operation.
      - name: subscriptionId
        value: ''
        type: path
        description: The ID of the target subscription.
    docs: Returns a list of workspaces in a subscription.
  - info:
      name: Azure Synapse Analytics List workspaces by resource group
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces
      params:
      - name: api-version
        value: ''
        type: query
        description: The API version to use for this operation.
      - name: subscriptionId
        value: ''
        type: path
        description: The ID of the target subscription.
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group.
    docs: Returns a list of workspaces in a resource group.
  - info:
      name: Azure Synapse Analytics Get a workspace
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName
      params:
      - name: api-version
        value: ''
        type: query
        description: The API version to use for this operation.
      - name: subscriptionId
        value: ''
        type: path
        description: The ID of the target subscription.
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group.
      - name: workspaceName
        value: ''
        type: path
        description: The name of the workspace.
    docs: Gets a workspace.
  - info:
      name: Azure Synapse Analytics Create or update a workspace
      type: http
    http:
      method: PUT
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName
      params:
      - name: api-version
        value: ''
        type: query
        description: The API version to use for this operation.
      - name: subscriptionId
        value: ''
        type: path
        description: The ID of the target subscription.
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group.
      - name: workspaceName
        value: ''
        type: path
        description: The name of the workspace.
      body:
        type: json
        data: '{}'
    docs: Creates or updates a workspace.
  - info:
      name: Azure Synapse Analytics Update a workspace
      type: http
    http:
      method: PATCH
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName
      params:
      - name: api-version
        value: ''
        type: query
        description: The API version to use for this operation.
      - name: subscriptionId
        value: ''
        type: path
        description: The ID of the target subscription.
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group.
      - name: workspaceName
        value: ''
        type: path
        description: The name of the workspace.
      body:
        type: json
        data: '{}'
    docs: Updates a workspace.
  - info:
      name: Azure Synapse Analytics Delete a workspace
      type: http
    http:
      method: DELETE
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName
      params:
      - name: api-version
        value: ''
        type: query
        description: The API version to use for this operation.
      - name: subscriptionId
        value: ''
        type: path
        description: The ID of the target subscription.
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group.
      - name: workspaceName
        value: ''
        type: path
        description: The name of the workspace.
    docs: Deletes a workspace.
- info:
    name: WorkspaceAadAdmins
    type: folder
  items:
  - info:
      name: Azure Synapse Analytics Get workspace Active Directory admin
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/administrators/activeDirectory
      params:
      - name: api-version
        value: ''
        type: query
        description: The API version to use for this operation.
      - name: subscriptionId
        value: ''
        type: path
        description: The ID of the target subscription.
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group.
      - name: workspaceName
        value: ''
        type: path
        description: The name of the workspace.
    docs: Gets a workspace active directory admin.
  - info:
      name: Azure Synapse Analytics Create or update workspace Active Directory admin
      type: http
    http:
      method: PUT
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/administrators/activeDirectory
      params:
      - name: api-version
        value: ''
        type: query
        description: The API version to use for this operation.
      - name: subscriptionId
        value: ''
        type: path
        description: The ID of the target subscription.
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group.
      - name: workspaceName
        value: ''
        type: path
        description: The name of the workspace.
      body:
        type: json
        data: '{}'
    docs: Creates or updates a workspace active directory admin.
  - info:
      name: Azure Synapse Analytics Delete workspace Active Directory admin
      type: http
    http:
      method: DELETE
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/administrators/activeDirectory
      params:
      - name: api-version
        value: ''
        type: query
        description: The API version to use for this operation.
      - name: subscriptionId
        value: ''
        type: path
        description: The ID of the target subscription.
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group.
      - name: workspaceName
        value: ''
        type: path
        description: The name of the workspace.
    docs: Deletes a workspace active directory admin.
- info:
    name: WorkspaceManagedIdentity
    type: folder
  items:
  - info:
      name: Azure Synapse Analytics Get managed identity SQL control settings
      type: http
    http:
      method: GET
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/managedIdentitySqlControlSettings/default
      params:
      - name: api-version
        value: ''
        type: query
        description: The API version to use for this operation.
      - name: subscriptionId
        value: ''
        type: path
        description: The ID of the target subscription.
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group.
      - name: workspaceName
        value: ''
        type: path
        description: The name of the workspace.
    docs: Get Managed Identity Sql Control Settings.
  - info:
      name: Azure Synapse Analytics Create or update managed identity SQL control settings
      type: http
    http:
      method: PUT
      url: https://management.azure.com/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/managedIdentitySqlControlSettings/default
      params:
      - name: api-version
        value: ''
        type: query
        description: The API version to use for this operation.
      - name: subscriptionId
        value: ''
        type: path
        description: The ID of the target subscription.
      - name: resourceGroupName
        value: ''
        type: path
        description: The name of the resource group.
      - name: workspaceName
        value: ''
        type: path
        description: The name of the workspace.
      body:
        type: json
        data: '{}'
    docs: Create or update Managed Identity Sql Control Settings.
bundled: true