Microsoft Azure

Azure Synapse Analytics: Workspace (2021-06-01)

Azure Synapse Analytics APIs

Data & analytics#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Azure Synapse Analytics APIs

Endpoints 16

Workspaces

  • GETWorkspaces_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspacesReturns a list of workspaces in a resource group
  • GETWorkspaces_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceNameGets a workspace
  • PUTWorkspaces_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceNameCreates or updates a workspace
  • DELETEWorkspaces_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceNameDeletes a workspace
  • PATCHWorkspaces_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceNameUpdates a workspace
  • GETWorkspaces_List/subscriptions/:subscriptionId/providers/Microsoft.Synapse/workspacesReturns a list of workspaces in a subscription
  • GETWorkspaceAadAdmins_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/administrators/activeDirectoryGets a workspace active directory admin
  • PUTWorkspaceAadAdmins_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/administrators/activeDirectoryCreates or updates a workspace active directory admin
  • DELETEWorkspaceAadAdmins_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/administrators/activeDirectoryDeletes a workspace active directory admin
  • GETWorkspaceSqlAadAdmins_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/sqlAdministrators/activeDirectoryGets a workspace SQL active directory admin
  • PUTWorkspaceSqlAadAdmins_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/sqlAdministrators/activeDirectoryCreates or updates a workspace SQL active directory admin
  • DELETEWorkspaceSqlAadAdmins_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/sqlAdministrators/activeDirectoryDeletes a workspace SQL active directory admin

RestorableDroppedSqlPools

  • GETRestorableDroppedSqlPools_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/restorableDroppedSqlPools/:restorableDroppedSqlPoolIdGets a deleted sql pool that can be restored
  • GETRestorableDroppedSqlPools_ListByWorkspace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/restorableDroppedSqlPoolsGets a list of deleted Sql pools that can be restored
  • GETGet Managed Identity Sql Control Settings/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/managedIdentitySqlControlSettings/default
  • PUTCreate or update Managed Identity Sql Control Settings/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/managedIdentitySqlControlSettings/default

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
16 operations on 8 pathsGET 8PUT 4DELETE 3PATCH 1
Main resources
Workspaces 12RestorableDroppedSqlPools 2
Description format
Swagger 2.0, API version 2021-06-01

How to test the Azure Synapse Analytics: Workspace (2021-06-01) in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Synapse Analytics: Workspace (2021-06-01) collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Workspaces_ListByResourceGroup” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Synapse Analytics: Workspace (2021-06-01)?

Azure Synapse Analytics APIs It is listed under Data & analytics and has 16 endpoints.

Who publishes the Azure Synapse Analytics: Workspace (2021-06-01)?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Synapse Analytics: Workspace (2021-06-01)?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Synapse Analytics: Workspace (2021-06-01)?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Synapse Analytics: Workspace (2021-06-01) have?

16 operations on 8 paths (8 GET, 4 PUT, 3 DELETE, 1 PATCH). The largest groups are Workspaces, RestorableDroppedSqlPools.

Is forking the Azure Synapse Analytics: Workspace (2021-06-01) free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.