Azure Synapse Analytics

Azure Synapse Analytics Keys API

The Keys API from Azure Synapse Analytics — 2 operation(s) for keys.

Documentation GitHub OpenAPI

Operations 4

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys Azure Synapse Analytics List workspace keys #

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName} Azure Synapse Analytics Get a workspace key #

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName} Azure Synapse Analytics Create or update a workspace key #

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName} Azure Synapse Analytics Delete a workspace key #

Documentation

https://learn.microsoft.com/en-us/rest/api/synapse/workspace

https://learn.microsoft.com/en-us/rest/api/synapse/sqlpools

https://learn.microsoft.com/en-us/rest/api/synapse/bigdatapool

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/pipeline

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/spark

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/monitoring

https://learn.microsoft.com/en-us/azure/synapse-analytics/synapse-link/

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/role-assignments

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/notebook

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/dataset

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/linked-service

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/data-flow

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/sql-script

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/trigger

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/spark-job-definition

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/managed-private-endpoints

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/integration-runtimes

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/library

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/git-integration

https://learn.microsoft.com/en-us/rest/api/synapse/ip-firewall-rules

https://learn.microsoft.com/en-us/rest/api/synapse/keys

https://learn.microsoft.com/en-us/rest/api/synapse/private-endpoint-connections

https://learn.microsoft.com/en-us/rest/api/synapse/private-link-hubs

https://learn.microsoft.com/en-us/rest/api/synapse/kusto-pools

https://learn.microsoft.com/en-us/rest/api/synapse/azure-ad-only-authentications

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/spark-configuration

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/data-flow-debug-session

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/credential

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/kql-script

https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/link-connection

Specifications

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-synapse-analytics/refs/heads/main/openapi/microsoft-azure-synapse-analytics-keys-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-synapse-analytics/refs/heads/main/json-schema/azure-synapse-analytics-workspace-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-synapse-analytics/refs/heads/main/json-schema/azure-synapse-analytics-sql-pool-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-synapse-analytics/refs/heads/main/json-schema/azure-synapse-analytics-spark-pool-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-synapse-analytics/refs/heads/main/json-schema/azure-synapse-analytics-pipeline-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-synapse-analytics/refs/heads/main/json-schema/azure-synapse-analytics-spark-batch-job-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-synapse-analytics/refs/heads/main/json-schema/azure-synapse-analytics-role-assignment-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-synapse-analytics/refs/heads/main/json-schema/azure-synapse-analytics-notebook-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-synapse-analytics/refs/heads/main/json-schema/azure-synapse-analytics-dataset-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-synapse-analytics/refs/heads/main/json-schema/azure-synapse-analytics-linked-service-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-synapse-analytics/refs/heads/main/json-schema/azure-synapse-analytics-trigger-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-synapse-analytics/refs/heads/main/json-schema/azure-synapse-analytics-firewall-rule-schema.json

Other Resources

https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/workspace.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-synapse-analytics/refs/heads/main/json-ld/azure-synapse-analytics-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure-synapse-analytics-keys-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Azure Synapse Analytics Keys API
  description: Manage workspace encryption keys for data protection at rest. Supports customer-managed key configuration for dedicated SQL pools and workspace-level encryption.
  version: '2021-06-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://management.azure.com
  description: Azure Resource Manager
security:
- azure_auth:
  - user_impersonation
tags:
- name: Keys
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys
  : get:
      operationId: Keys_ListByWorkspace
      summary: Azure Synapse Analytics List workspace keys
      description: Returns a list of keys in a workspace.
      tags:
      - Keys
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      responses:
        '200':
          description: Successfully retrieved the list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyInfoListResult'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName}
  : get:
      operationId: Keys_Get
      summary: Azure Synapse Analytics Get a workspace key
      description: Gets a workspace key.
      tags:
      - Keys
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      - name: keyName
        in: path
        required: true
        description: The name of the workspace key.
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved the key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Key'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: Keys_CreateOrUpdate
      summary: Azure Synapse Analytics Create or update a workspace key
      description: Creates or updates a workspace key.
      tags:
      - Keys
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      - name: keyName
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Key'
      responses:
        '200':
          description: Successfully updated the key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Key'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: Keys_Delete
      summary: Azure Synapse Analytics Delete a workspace key
      description: Deletes a workspace key.
      tags:
      - Keys
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      - name: keyName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Key'
        '204':
          description: Not found.
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
    KeyInfoListResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Key'
        nextLink:
          type: string
    Key:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        type:
          type: string
          readOnly: true
        properties:
          type: object
          properties:
            isActiveCMK:
              type: boolean
              description: Used to activate the workspace after a customer managed key is provided.
            keyVaultUrl:
              type: string
              description: The Key Vault Url of the workspace key.
  parameters:
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      schema:
        type: string
        default: '2021-06-01'
    WorkspaceNameParameter:
      name: workspaceName
      in: path
      required: true
      schema:
        type: string
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      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