Azure Synapse Analytics Subscriptions API

The Subscriptions API from Azure Synapse Analytics — 1 operation(s) for subscriptions.

GitHub OpenAPI

Operations 2

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/managedIdentitySqlControlSettings/default Get Managed Identity Sql Control Settings #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/managedIdentitySqlControlSettings/default Create or update Managed Identity Sql Control Settings #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/sqlpools
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/pipeline
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/monitoring
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/role-assignments
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/notebook
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/dataset
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/linked-service
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/data-flow
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/sql-script
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/trigger
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/spark-job-definition
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/managed-private-endpoints
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/integration-runtimes
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/library
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/ip-firewall-rules
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/keys
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/private-endpoint-connections
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/private-link-hubs
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/azure-ad-only-authentications
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/spark-configuration
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/data-flow-debug-session
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/credential
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/kql-script
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/synapse/data-plane/link-connection

Specifications

Schemas & Data

Other Resources

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:microsoft-azure-synapse-analytics-subscriptions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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

OpenAPI Specification

microsoft-azure-synapse-analytics-subscriptions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: '2021-06-01'
  title: SynapseManagementClient Subscriptions API
  description: Azure Synapse Analytics APIs
servers:
- url: https://management.azure.com
tags:
- name: Subscriptions
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/managedIdentitySqlControlSettings/default
  : get:
      operationId: WorkspaceManagedIdentitySqlControlSettings_Get
      summary: Get Managed Identity Sql Control Settings
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedIdentitySqlControlSettingsModel'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Subscriptions
    put:
      operationId: WorkspaceManagedIdentitySqlControlSettings_CreateOrUpdate
      summary: Create or update Managed Identity Sql Control Settings
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/WorkspaceNameParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedIdentitySqlControlSettingsModel'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedIdentitySqlControlSettingsModel'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagedIdentitySqlControlSettingsModel'
        description: Managed Identity Sql Control Settings
        required: true
      tags:
      - Subscriptions
components:
  schemas:
    ManagedIdentitySqlControlSettingsModel:
      type: object
      title: Managed Identity Sql Control Settings
      description: Sql Control Settings for workspace managed identity
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
      properties:
        properties:
          type: object
          title: Managed Identity Sql Control Settings
          description: Sql Control Settings for workspace managed identity
          properties:
            grantSqlControlToManagedIdentity:
              type: object
              description: Grant sql control to managed identity
              properties:
                desiredState:
                  description: Desired state
                  type: string
                  enum:
                  - Enabled
                  - Disabled
                  x-ms-enum:
                    name: DesiredState
                    modelAsString: false
                actualState:
                  description: Actual state
                  type: string
                  enum:
                  - Enabling
                  - Enabled
                  - Disabling
                  - Disabled
                  - Unknown
                  x-ms-enum:
                    name: ActualState
                    modelAsString: false
                  readOnly: true
          x-ms-client-flatten: true
    ErrorResponse:
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      type: object
      properties:
        error:
          description: The error object.
          $ref: '#/components/schemas/ErrorDetail'
    ProxyResource:
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
  parameters:
    WorkspaceNameParameter:
      name: workspaceName
      in: path
      description: The name of the workspace.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: The ID of the target subscription.
      schema:
        type: string
        minLength: 1
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation.
      schema:
        type: string
        minLength: 1
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      required: true
      description: The name of the resource group. The name is case insensitive.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow