Integration Runtimes - Update
Update integration runtime
Update an integration runtime
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}?api-version=2021-06-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
integration
|
path | True |
string |
Integration runtime name |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string |
The ID of the target subscription. |
workspace
|
path | True |
string |
The name of the workspace. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Body
Name | Type | Description |
---|---|---|
autoUpdate |
Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189. |
|
updateDelayOffset |
string |
The time offset (in hours) in the day, e.g., PT03H is 3 hours. The integration runtime auto update will happen on that time. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
An error response received from the Azure Synapse service. |
Examples
Update integration runtime
Sample Request
PATCH https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationRuntimes/exampleIntegrationRuntime?api-version=2021-06-01-preview
{
"autoUpdate": "Off",
"updateDelayOffset": "\"PT3H\""
}
Sample Response
Date: Wed, 13 Jun 2018 21:33:04 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1192
x-ms-request-id: eb1c35f8-4b37-4d08-b5dd-d6a0ad8b182d
x-ms-correlation-request-id: eb1c35f8-4b37-4d08-b5dd-d6a0ad8b182d
{
"id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationruntimes/exampleIntegrationRuntime",
"name": "exampleIntegrationRuntime",
"type": "Microsoft.Synapse/workspaces/integrationruntimes",
"properties": {
"type": "SelfHosted",
"description": "A selfhosted integration runtime"
},
"etag": "0400f1a1-0000-0000-0000-5b2188640000"
}
Definitions
Name | Description |
---|---|
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Integration |
The state of integration runtime auto update. |
Integration |
Integration runtime resource type. |
Integration |
The type of integration runtime. |
Update |
Update integration runtime request. |
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 |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
IntegrationRuntimeAutoUpdate
The state of integration runtime auto update.
Name | Type | Description |
---|---|---|
Off |
string |
|
On |
string |
IntegrationRuntimeResource
Integration runtime resource type.
Name | Type | Description |
---|---|---|
etag |
string |
Resource Etag. |
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties.description |
string |
Integration runtime description. |
properties.type |
Type of integration runtime. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
IntegrationRuntimeType
The type of integration runtime.
Name | Type | Description |
---|---|---|
Managed |
string |
|
SelfHosted |
string |
UpdateIntegrationRuntimeRequest
Update integration runtime request.
Name | Type | Description |
---|---|---|
autoUpdate |
Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189. |
|
updateDelayOffset |
string |
The time offset (in hours) in the day, e.g., PT03H is 3 hours. The integration runtime auto update will happen on that time. |