Microsoft Azure

Azure Synapse Analytics: Integration Runtime

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 23

IntegrationRuntime

  • GETGet integration runtime/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeNameGet an integration runtime
  • PUTCreate integration runtime/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeNameCreate an integration runtime
  • DELETEDelete integration runtime/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeNameDelete an integration runtime
  • PATCHUpdate integration runtime/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeNameUpdate an integration runtime
  • POSTGet integration runtime node IP address/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/nodes/:nodeName/ipAddressGet the IP address of an integration runtime node
  • POSTUpgrade integration runtime/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/upgradeUpgrade an integration runtime
  • POSTGet integration runtime object metadata/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/getObjectMetadataGet object metadata from an integration runtime
  • GETGet integration runtime node/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/nodes/:nodeNameGet an integration runtime node
  • DELETEDelete integration runtime node/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/nodes/:nodeNameDelete an integration runtime node
  • PATCHCreate integration runtime node/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/nodes/:nodeNameCreate an integration runtime node
  • POSTSync integration runtime credentials/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/syncCredentialsForce the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with…
  • GETList integration runtimes/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimesList all integration runtimes
  • POSTGet integration runtime connection info/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/getConnectionInfoGet connection info for an integration runtime
  • POSTStart integration runtime/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/startStart an integration runtime
  • POSTRegenerate integration runtime authentication key/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/regenerateAuthKeyRegenerate the authentication key for an integration runtime
  • POSTList integration runtime authentication keys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/listAuthKeysList authentication keys in an integration runtime
  • POSTGet integration runtime monitoring data/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/monitoringDataGet monitoring data for an integration runtime
  • POSTStop integration runtime/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/stopStop an integration runtime
  • POSTRefresh integration runtime object metadata/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/refreshObjectMetadataRefresh the object metadata in an integration runtime
  • POSTGet integration runtime status/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/getStatusGet the integration runtime status
  • POSTIntegrationRuntimes_EnableInteractiveQuery/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/enableInteractiveQueryEnable interactive query in integration runtime
  • POSTIntegrationRuntimes_DisableInteractiveQuery/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/disableInteractiveQueryDisable interactive query in integration runtime

integrationRuntimes

  • GETGets list of outbound network dependencies for a given Azure-SSIS integration runtime./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName/outboundNetworkDependenciesEndpointsGets the list of outbound network dependencies for a given Azure-SSIS integration runtime.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
23 operations on 18 pathsPOST 14GET 4PATCH 2DELETE 2PUT 1
Main resources
IntegrationRuntime 22integrationRuntimes 1
Description format
Swagger 2.0, API version 2021-06-01

How to test the Azure Synapse Analytics: Integration Runtime 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: Integration Runtime 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 “Get integration runtime” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Synapse/workspaces/:workspaceName/integrationRuntimes/:integrationRuntimeName), 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: Integration Runtime?

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

Who publishes the Azure Synapse Analytics: Integration Runtime?

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: Integration Runtime?

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

How do I authenticate with the Azure Synapse Analytics: Integration Runtime?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Synapse Analytics: Integration Runtime have?

23 operations on 18 paths (14 POST, 4 GET, 2 PATCH, 2 DELETE, 1 PUT). The largest groups are IntegrationRuntime, integrationRuntimes.

Is forking the Azure Synapse Analytics: Integration Runtime 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.