Integration Runtimes - Start

Service:: Synapse

API Version:: 2021-06-01

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

URI Parameters

Name	In	Required	Type	Description
integrationRuntimeName	path	True	string	Integration runtime name
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
workspaceName	path	True	string	The name of the workspace.
api-version	query	True	string minLength: 1	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

HTTP

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

Sample response

Status code:: 200

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"
    }
  }
}

Status code:: 202

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IntegrationRuntimeAutoUpdate	The state of integration runtime auto update.
IntegrationRuntimeInternalChannelEncryptionMode	It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).
IntegrationRuntimeState	The state of integration runtime.
IntegrationRuntimeStatusResponse	Integration runtime status response.
IntegrationRuntimeType	The type of integration runtime.
IntegrationRuntimeUpdateResult	The result of the last integration runtime node update.
LinkedIntegrationRuntime	The linked integration runtime information.
ManagedIntegrationRuntimeError	Error definition for managed integration runtime.
ManagedIntegrationRuntimeNode	Properties of integration runtime node.
ManagedIntegrationRuntimeNodeStatus	The managed integration runtime node status.
ManagedIntegrationRuntimeOperationResult	Properties of managed integration runtime operation result.
ManagedIntegrationRuntimeStatus	Managed integration runtime status.
SelfHostedIntegrationRuntimeNode	Properties of Self-hosted integration runtime node.
SelfHostedIntegrationRuntimeNodeStatus	Status of the integration runtime node.
SelfHostedIntegrationRuntimeStatus	Self-hosted integration runtime status.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

IntegrationRuntimeAutoUpdate

Enumeration

The state of integration runtime auto update.

Value	Description
On
Off

IntegrationRuntimeInternalChannelEncryptionMode

Enumeration

It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).

Value	Description
NotSet
SslEncrypted
NotEncrypted

IntegrationRuntimeState

Enumeration

The state of integration runtime.

Value	Description
Initial
Stopped
Started
Starting
Stopping
NeedRegistration
Online
Limited
Offline
AccessDenied

IntegrationRuntimeStatusResponse

Object

Integration runtime status response.

Name	Type	Description
name	string	The integration runtime name.
properties	IntegrationRuntimeStatus: ManagedIntegrationRuntimeStatus SelfHostedIntegrationRuntimeStatus	Integration runtime properties.

IntegrationRuntimeType

Enumeration

The type of integration runtime.

Value	Description
Managed
SelfHosted

IntegrationRuntimeUpdateResult

Enumeration

The result of the last integration runtime node update.

Value	Description
None
Succeed
Fail

LinkedIntegrationRuntime

Object

The linked integration runtime information.

Name	Type	Description
createTime	string (date-time)	The creating time of the linked integration runtime.
dataFactoryLocation	string	The location of the workspace for which the linked integration runtime belong to.
dataFactoryName	string	The name of the workspace for which the linked integration runtime belong to.
name	string	The name of the linked integration runtime.
subscriptionId	string	The subscription ID for which the linked integration runtime belong to.

ManagedIntegrationRuntimeError

Object

Error definition for managed integration runtime.

Name	Type	Description
code	string	Error code.
message	string	Error message.
parameters	string[]	Managed integration runtime error parameters.
time	string (date-time)	The time when the error occurred.

ManagedIntegrationRuntimeNode

Object

Properties of integration runtime node.

Name	Type	Description
errors	ManagedIntegrationRuntimeError[]	The errors that occurred on this integration runtime node.
nodeId	string	The managed integration runtime node id.
status	ManagedIntegrationRuntimeNodeStatus	The managed integration runtime node status.

ManagedIntegrationRuntimeNodeStatus

Enumeration

The managed integration runtime node status.

Value	Description
Starting
Available
Recycling
Unavailable

ManagedIntegrationRuntimeOperationResult

Object

Properties of managed integration runtime operation result.

Name	Type	Description
activityId	string	The activity id for the operation request.
errorCode	string	The error code.
parameters	string[]	Managed integration runtime error parameters.
result	string	The operation result.
startTime	string (date-time)	The start time of the operation.
type	string	The operation type. Could be start or stop.

ManagedIntegrationRuntimeStatus

Object

Managed integration runtime status.

Name	Type	Description
dataFactoryName	string	The workspace name which the integration runtime belong to.
state	IntegrationRuntimeState	The state of integration runtime.
type	string: Managed	Type of integration runtime.
typeProperties.createTime	string (date-time)	The time at which the integration runtime was created, in ISO8601 format.
typeProperties.lastOperation	ManagedIntegrationRuntimeOperationResult	The last operation result that occurred on this integration runtime.
typeProperties.nodes	ManagedIntegrationRuntimeNode[]	The list of nodes for managed integration runtime.
typeProperties.otherErrors	ManagedIntegrationRuntimeError[]	The errors that occurred on this integration runtime.

SelfHostedIntegrationRuntimeNode

Object

Properties of Self-hosted integration runtime node.

Name	Type	Description
capabilities	object	The integration runtime capabilities dictionary
concurrentJobsLimit	integer (int32)	Maximum concurrent jobs on the integration runtime node.
expiryTime	string (date-time)	The time at which the integration runtime will expire in ISO8601 format.
hostServiceUri	string	URI for the host machine of the integration runtime.
isActiveDispatcher	boolean	Indicates whether this node is the active dispatcher for integration runtime requests.
lastConnectTime	string (date-time)	The most recent time at which the integration runtime was connected in ISO8601 format.
lastEndUpdateTime	string (date-time)	The last time for the integration runtime node update end.
lastStartTime	string (date-time)	The time the node last started up.
lastStartUpdateTime	string (date-time)	The last time for the integration runtime node update start.
lastStopTime	string (date-time)	The integration runtime node last stop time.
lastUpdateResult	IntegrationRuntimeUpdateResult	The result of the last integration runtime node update.
machineName	string	Machine name of the integration runtime node.
maxConcurrentJobs	integer (int32)	The maximum concurrent jobs in this integration runtime.
nodeName	string	Name of the integration runtime node.
registerTime	string (date-time)	The time at which the integration runtime node was registered in ISO8601 format.
status	SelfHostedIntegrationRuntimeNodeStatus	Status of the integration runtime node.
version	string	Version of the integration runtime node.
versionStatus	string	Status of the integration runtime node version.

SelfHostedIntegrationRuntimeNodeStatus

Enumeration

Status of the integration runtime node.

Value	Description
NeedRegistration
Online
Limited
Offline
Upgrading
Initializing
InitializeFailed

SelfHostedIntegrationRuntimeStatus

Object

Self-hosted integration runtime status.

Name	Type	Description
dataFactoryName	string	The workspace name which the integration runtime belong to.
state	IntegrationRuntimeState	The state of integration runtime.
type	string: SelfHosted	Type of integration runtime.
typeProperties.autoUpdate	IntegrationRuntimeAutoUpdate	Whether Self-hosted integration runtime auto update has been turned on.
typeProperties.autoUpdateETA	string (date-time)	The estimated time when the self-hosted integration runtime will be updated.
typeProperties.capabilities	object	Object with additional information about integration runtime capabilities.
typeProperties.createTime	string (date-time)	The time at which the integration runtime was created, in ISO8601 format.
typeProperties.internalChannelEncryption	IntegrationRuntimeInternalChannelEncryptionMode	It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).
typeProperties.latestVersion	string	The latest version on download center.
typeProperties.links	LinkedIntegrationRuntime[]	The list of linked integration runtimes that are created to share with this integration runtime.
typeProperties.localTimeZoneOffset	string	The local time zone offset in hours.
typeProperties.nodeCommunicationChannelEncryptionMode	string	The node communication Channel encryption mode
typeProperties.nodes	SelfHostedIntegrationRuntimeNode[]	The list of nodes for this integration runtime.
typeProperties.pushedVersion	string	The version that the integration runtime is going to update to.
typeProperties.scheduledUpdateDate	string (date-time)	The date at which the integration runtime will be scheduled to update, in ISO8601 format.
typeProperties.serviceUrls	string[]	The URLs for the services used in integration runtime backend service.
typeProperties.taskQueueId	string	The task queue id of the integration runtime.
typeProperties.updateDelayOffset	string	The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 hours
typeProperties.version	string	Version of the integration runtime.
typeProperties.versionStatus	string	Status of the integration runtime version.

Share via

Integration Runtimes - Start

URI Parameters

Responses

Examples

Start integration runtime

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IntegrationRuntimeAutoUpdate

IntegrationRuntimeInternalChannelEncryptionMode

IntegrationRuntimeState

IntegrationRuntimeStatusResponse

IntegrationRuntimeType

IntegrationRuntimeUpdateResult

LinkedIntegrationRuntime

ManagedIntegrationRuntimeError

ManagedIntegrationRuntimeNode

ManagedIntegrationRuntimeNodeStatus

ManagedIntegrationRuntimeOperationResult

ManagedIntegrationRuntimeStatus

SelfHostedIntegrationRuntimeNode

SelfHostedIntegrationRuntimeNodeStatus

SelfHostedIntegrationRuntimeStatus