How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Azure Synapse Analytics BigDataPools API

The BigDataPools API from Azure Synapse Analytics — 2 operation(s) for bigdatapools.

Azure Synapse Analytics BigDataPools API is one of 35 APIs that Azure Synapse Analytics publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 11 JSON Schema definitions.

Tagged areas include BigDataPools. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 11 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 2021-06-01.

Requests are made against a single base URL, https://management.azure.com.

5 operations 2 paths 10 schemas 1 DELETE2 GET1 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2021-06-01
Base URL
https://management.azure.com
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Azure Synapse Analytics BigDataPools API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (azure_auth) using the implicit flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

BigDataPools 5
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/bigDataPools
Azure Synapse Analytics List Spark pools by workspace
BigDataPools_ListByWorkspace 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/bigDataPools/{bigDataPoolName}
Azure Synapse Analytics Get a Spark pool
BigDataPools_Get 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/bigDataPools/{bigDataPoolName}
Azure Synapse Analytics Create or update a Spark pool
BigDataPools_CreateOrUpdate 6 params body → 200202default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/bigDataPools/{bigDataPoolName}
Azure Synapse Analytics Update a Spark pool
BigDataPools_Update 5 params body → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/bigDataPools/{bigDataPoolName}
Azure Synapse Analytics Delete a Spark pool
BigDataPools_Delete 5 params → 200202204default

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are BigDataPoolResourceProperties (16 properties), BigDataPoolResourceInfo (6 properties), SparkConfigProperties (4 properties), LibraryInfo (4 properties). Each schema is shown below with its type and property counts.

AutoScaleProperties
object
Auto-scale properties of a Big Data pool.
3 properties
LibraryInfo
object
Library information.
4 properties
BigDataPoolResourceInfoListResult
object
Collection of Big Data pool resources.
2 properties
BigDataPoolResourceInfo
object
A Big Data pool resource.
6 properties
AutoPauseProperties
object
Auto-pause properties of a Big Data pool.
2 properties
ErrorResponse
object
1 property
DynamicExecutorAllocation
object
Dynamic executor allocation.
3 properties
BigDataPoolPatchInfo
object
Properties for updating a Big Data pool.
1 property
SparkConfigProperties
object
Spark configuration file properties.
4 properties
BigDataPoolResourceProperties
object
Properties of a Big Data pool.
16 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-synapse-analytics-bigdatapools-api-openapi.yml Raw ↑

Other APIs Azure Synapse Analytics publishes across the network.

Azure Synapse Analytics AzureADOnlyAuthentications API
Azure Synapse Analytics Credential API
Azure Synapse Analytics DataFlow API
Azure Synapse Analytics DataFlowDebugSession API
Azure Synapse Analytics Dataset API
Azure Synapse Analytics GitIntegration API
Azure Synapse Analytics IntegrationRuntimes API
Azure Synapse Analytics IpFirewallRules API
Azure Synapse Analytics Keys API
Azure Synapse Analytics KqlScripts API
Azure Synapse Analytics KustoPools API
Azure Synapse Analytics Library API
Where this information came from

This is an independent, third-party profile of Azure Synapse Analytics BigDataPools API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.