Share via

Integration Runtimes - Stop

Service:
Synapse
API Version:
2021-06-01

Stop integration runtime
Stop an integration runtime

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/stop?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

OK.
202 Accepted

Accepted.
Other Status Codes

ErrorResponse

An error response received from the Azure Synapse service.

Examples

Stop integration runtime

Sample request

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

Sample response

Status code:
200
Status code:
202
Status code:
default 
{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response

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.