Integration Runtimes - Start

Start integration runtime
Start an integration runtime

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/start?api-version=2021-06-01-preview

URI Parameters

Name In Required Type Description
integrationRuntimeName
path True

string

Integration runtime name

resourceGroupName
path True

string

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

The ID of the target subscription.

workspaceName
path True

string

The name of the workspace.

api-version
query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

IntegrationRuntimeStatusResponse

OK.

202 Accepted

Accepted.

Other Status Codes

ErrorResponse

An error response received from the Azure Synapse service.

Examples

Start integration runtime

Sample request

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationRuntimes/exampleManagedIntegrationRuntime/start?api-version=2021-06-01-preview

Sample response

Date: Wed, 13 Jun 2018 21:33:00 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14912
x-ms-request-id: 2af47f9f-5625-4b01-a3a5-bccb576a4677
x-ms-correlation-request-id: 2af47f9f-5625-4b01-a3a5-bccb576a4677
{
  "name": "exampleManagedIntegrationRuntime",
  "properties": {
    "dataFactoryName": "exampleWorkspaceName",
    "type": "Managed",
    "state": "Started",
    "typeProperties": {
      "nodes": [],
      "otherErrors": [],
      "createTime": "2018-06-13T21:11:01.8695494Z"
    }
  }
}
azure-asyncoperation: https://ms.web.azuresynapse.net

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

IntegrationRuntimeState

The state of integration runtime.

IntegrationRuntimeStatusResponse

Integration runtime status response.

IntegrationRuntimeType

The type of integration runtime.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

IntegrationRuntimeState

The state of integration runtime.

Name Type Description
AccessDenied

string

Initial

string

Limited

string

NeedRegistration

string

Offline

string

Online

string

Started

string

Starting

string

Stopped

string

Stopping

string

IntegrationRuntimeStatusResponse

Integration runtime status response.

Name Type Description
name

string

The integration runtime name.

properties.dataFactoryName

string

The workspace name which the integration runtime belong to.

properties.state

IntegrationRuntimeState

The state of integration runtime.

properties.type

IntegrationRuntimeType

Type of integration runtime.

IntegrationRuntimeType

The type of integration runtime.

Name Type Description
Managed

string

SelfHosted

string