Azure Synapse Analytics · Arazzo Workflow

Azure Synapse Analytics Publish and Verify Notebook

Version 1.0.0

Create or update a Synapse notebook, then read it back to verify it.

1 workflow 1 source API 1 provider
View Spec View on GitHub AnalyticsApache SparkBig DataData IntegrationData WarehouseETLSQLArazzoWorkflows

Provider

microsoft-azure-synapse-analytics

Workflows

publish-and-verify-notebook
Publish a notebook into the workspace and confirm it was stored.
Creates or updates a notebook resource and then reads it back, capturing the persisted identifier and the big data pool the notebook is bound to.
2 steps inputs: apiVersion, notebook, notebookName outputs: bigDataPool, notebookId
1
publishNotebook
Create or update the notebook definition, including its cells, attached big data pool, and session properties.
2
verifyNotebook
Read the notebook back from the workspace to confirm the definition and its big data pool binding were persisted.

Source API Descriptions

Arazzo Workflow Specification

Raw ↑
arazzo: 1.0.1
info:
  title: Azure Synapse Analytics Publish and Verify Notebook
  summary: Create or update a Synapse notebook, then read it back to verify it.
  description: >-
    Synapse notebooks bind Spark code to a big data pool for interactive and
    scheduled data analytics. This workflow publishes a notebook definition into
    the workspace and then retrieves it to confirm the definition, attached big
    data pool, and session properties were persisted as expected. Every step
    spells out its request inline so the flow can be read and executed without
    opening the underlying OpenAPI description.
  version: 1.0.0
sourceDescriptions:
- name: notebookApi
  url: ../openapi/microsoft-azure-synapse-analytics-notebook-api-openapi.yml
  type: openapi
workflows:
- workflowId: publish-and-verify-notebook
  summary: Publish a notebook into the workspace and confirm it was stored.
  description: >-
    Creates or updates a notebook resource and then reads it back, capturing the
    persisted identifier and the big data pool the notebook is bound to.
  inputs:
    type: object
    required:
    - apiVersion
    - notebookName
    - notebook
    properties:
      apiVersion:
        type: string
        description: The Synapse data plane API version (e.g. 2020-12-01).
      notebookName:
        type: string
        description: The name of the notebook to create or update.
      notebook:
        type: object
        description: The NotebookResource definition to publish.
  steps:
  - stepId: publishNotebook
    description: >-
      Create or update the notebook definition, including its cells, attached
      big data pool, and session properties.
    operationId: Notebook_CreateOrUpdateNotebook
    parameters:
    - name: api-version
      in: query
      value: $inputs.apiVersion
    - name: notebookName
      in: path
      value: $inputs.notebookName
    requestBody:
      contentType: application/json
      payload: $inputs.notebook
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      notebookId: $response.body#/id
      notebookEtag: $response.body#/etag
  - stepId: verifyNotebook
    description: >-
      Read the notebook back from the workspace to confirm the definition and
      its big data pool binding were persisted.
    operationId: Notebook_GetNotebook
    parameters:
    - name: api-version
      in: query
      value: $inputs.apiVersion
    - name: notebookName
      in: path
      value: $inputs.notebookName
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      confirmedName: $response.body#/name
      bigDataPool: $response.body#/properties/bigDataPool/referenceName
  outputs:
    notebookId: $steps.publishNotebook.outputs.notebookId
    bigDataPool: $steps.verifyNotebook.outputs.bigDataPool

Work with this as data

Every workflow 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 arazzo workflows

4 MCP tools reach this
  • find_arazzoBrowse and filter every workflow in the catalog.
  • 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 workflow
curl "https://apis.io/api/v1/arazzo/microsoft-azure-synapse-analytics-publish-and-verify-notebook-workflow"
All arazzo workflows
curl "https://apis.io/api/v1/arazzo?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.

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