Integration Runtimes - Update
Updates an integration runtime.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}?api-version=2018-06-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
factory
|
path | True |
string |
The factory name. Regex pattern: |
integration
|
path | True |
string |
The integration runtime name. Regex pattern: |
resource
|
path | True |
string |
The resource group name. Regex pattern: |
subscription
|
path | True |
string |
The subscription identifier. |
api-version
|
query | True |
string |
The API version. |
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 Data Factory service. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
IntegrationRuntimes_Update
Sample request
PATCH https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleIntegrationRuntime?api-version=2018-06-01
{
"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.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime",
"name": "exampleIntegrationRuntime",
"type": "Microsoft.DataFactory/factories/integrationruntimes",
"properties": {
"type": "SelfHosted",
"description": "A selfhosted integration runtime"
},
"etag": "0400f1a1-0000-0000-0000-5b2188640000"
}
Definitions
Name | Description |
---|---|
Cloud |
The object that defines the structure of an Azure Data Factory error response. |
Copy |
CopyComputeScale properties for managed integration runtime. |
Credential |
Credential reference type. |
Credential |
Credential reference type. |
Custom |
Custom properties are used to tune the data flow runtime performance. |
Data |
Compute type of the cluster which will execute data flow job. |
Entity |
The entity reference. |
Integration |
The state of integration runtime auto update. |
Integration |
The compute resource properties for managed integration runtime. |
Integration |
The definition and properties of virtual network to which Azure-SSIS integration runtime will join. |
Integration |
Custom setup script properties for a managed dedicated integration runtime. |
Integration |
Data flow properties for managed integration runtime. |
Integration |
Data proxy properties for a managed dedicated integration runtime. |
Integration |
The edition for the SSIS Integration Runtime |
Integration |
The type of this referenced entity. |
Integration |
License type for bringing your own license scenario. |
Integration |
Integration runtime resource type. |
Integration |
Catalog information for managed dedicated integration runtime. |
Integration |
The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/ |
Integration |
SSIS properties for managed integration runtime. |
Integration |
The state of integration runtime. |
Integration |
The type of integration runtime. |
Integration |
VNet properties for managed integration runtime. |
Linked |
The key authorization type integration runtime. |
Linked |
The role based access control (RBAC) authorization type integration runtime. |
Managed |
Managed integration runtime, including managed elastic and managed dedicated integration runtimes. |
Managed |
Managed Virtual Network reference type. |
Managed |
Managed Virtual Network reference type. |
Package |
Package store for the SSIS integration runtime. |
Pipeline |
PipelineExternalComputeScale properties for managed integration runtime. |
Secure |
Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. |
Self |
Self-hosted integration runtime. |
Update |
Update integration runtime request. |
CloudError
The object that defines the structure of an Azure Data Factory error response.
Name | Type | Description |
---|---|---|
error.code |
string |
Error code. |
error.details |
Array with additional error details. |
|
error.message |
string |
Error message. |
error.target |
string |
Property name/path in request associated with error. |
CopyComputeScaleProperties
CopyComputeScale properties for managed integration runtime.
Name | Type | Description |
---|---|---|
dataIntegrationUnit |
integer |
DIU number setting reserved for copy activity execution. Supported values are multiples of 4 in range 4-256. |
timeToLive |
integer |
Time to live (in minutes) setting of integration runtime which will execute copy activity. |
CredentialReference
Credential reference type.
Name | Type | Description |
---|---|---|
referenceName |
string |
Reference credential name. |
type |
Credential reference type. |
CredentialReferenceType
Credential reference type.
Name | Type | Description |
---|---|---|
CredentialReference |
string |
CustomProperties
Custom properties are used to tune the data flow runtime performance.
Name | Type | Description |
---|---|---|
name |
string |
Name of custom property. |
value |
string |
Value of custom property. |
DataFlowComputeType
Compute type of the cluster which will execute data flow job.
Name | Type | Description |
---|---|---|
ComputeOptimized |
string |
|
General |
string |
|
MemoryOptimized |
string |
EntityReference
The entity reference.
Name | Type | Description |
---|---|---|
referenceName |
string |
The name of this referenced entity. |
type |
The type of this referenced entity. |
IntegrationRuntimeAutoUpdate
The state of integration runtime auto update.
Name | Type | Description |
---|---|---|
Off |
string |
|
On |
string |
IntegrationRuntimeComputeProperties
The compute resource properties for managed integration runtime.
Name | Type | Description |
---|---|---|
copyComputeScaleProperties |
CopyComputeScale properties for managed integration runtime. |
|
dataFlowProperties |
Data flow properties for managed integration runtime. |
|
location |
string |
The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities |
maxParallelExecutionsPerNode |
integer |
Maximum parallel executions count per node for managed integration runtime. |
nodeSize |
string |
The node size requirement to managed integration runtime. |
numberOfNodes |
integer |
The required number of nodes for managed integration runtime. |
pipelineExternalComputeScaleProperties |
PipelineExternalComputeScale properties for managed integration runtime. |
|
vNetProperties |
VNet properties for managed integration runtime. |
IntegrationRuntimeCustomerVirtualNetwork
The definition and properties of virtual network to which Azure-SSIS integration runtime will join.
Name | Type | Description |
---|---|---|
subnetId |
string |
The ID of subnet to which Azure-SSIS integration runtime will join. |
IntegrationRuntimeCustomSetupScriptProperties
Custom setup script properties for a managed dedicated integration runtime.
Name | Type | Description |
---|---|---|
blobContainerUri |
string |
The URI of the Azure blob container that contains the custom setup script. |
sasToken |
The SAS token of the Azure blob container. |
IntegrationRuntimeDataFlowProperties
Data flow properties for managed integration runtime.
Name | Type | Description |
---|---|---|
cleanup |
boolean |
Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true. |
computeType |
Compute type of the cluster which will execute data flow job. |
|
coreCount |
integer |
Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272. |
customProperties |
Custom properties are used to tune the data flow runtime performance. |
|
timeToLive |
integer |
Time to live (in minutes) setting of the cluster which will execute data flow job. |
IntegrationRuntimeDataProxyProperties
Data proxy properties for a managed dedicated integration runtime.
Name | Type | Description |
---|---|---|
connectVia |
The self-hosted integration runtime reference. |
|
path |
string |
The path to contain the staged data in the Blob storage. |
stagingLinkedService |
The staging linked service reference. |
IntegrationRuntimeEdition
The edition for the SSIS Integration Runtime
Name | Type | Description |
---|---|---|
Enterprise |
string |
|
Standard |
string |
IntegrationRuntimeEntityReferenceType
The type of this referenced entity.
Name | Type | Description |
---|---|---|
IntegrationRuntimeReference |
string |
|
LinkedServiceReference |
string |
IntegrationRuntimeLicenseType
License type for bringing your own license scenario.
Name | Type | Description |
---|---|---|
BasePrice |
string |
|
LicenseIncluded |
string |
IntegrationRuntimeResource
Integration runtime resource type.
Name | Type | Description |
---|---|---|
etag |
string |
Etag identifies change in the resource. |
id |
string |
The resource identifier. |
name |
string |
The resource name. |
properties | IntegrationRuntime: |
Integration runtime properties. |
type |
string |
The resource type. |
IntegrationRuntimeSsisCatalogInfo
Catalog information for managed dedicated integration runtime.
Name | Type | Description |
---|---|---|
catalogAdminPassword |
The password of the administrator user account of the catalog database. |
|
catalogAdminUserName |
string |
The administrator user name of catalog database. |
catalogPricingTier |
The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/ |
|
catalogServerEndpoint |
string |
The catalog database server URL. |
dualStandbyPairName |
string |
The dual standby pair name of Azure-SSIS Integration Runtimes to support SSISDB failover. |
IntegrationRuntimeSsisCatalogPricingTier
The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/
Name | Type | Description |
---|---|---|
Basic |
string |
|
Premium |
string |
|
PremiumRS |
string |
|
Standard |
string |
IntegrationRuntimeSsisProperties
SSIS properties for managed integration runtime.
Name | Type | Description |
---|---|---|
catalogInfo |
Catalog information for managed dedicated integration runtime. |
|
credential |
The credential reference containing authentication information. |
|
customSetupScriptProperties |
Custom setup script properties for a managed dedicated integration runtime. |
|
dataProxyProperties |
Data proxy properties for a managed dedicated integration runtime. |
|
edition |
The edition for the SSIS Integration Runtime |
|
expressCustomSetupProperties |
Custom |
Custom setup without script properties for a SSIS integration runtime. |
licenseType |
License type for bringing your own license scenario. |
|
packageStores |
Package stores for the SSIS Integration Runtime. |
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 |
IntegrationRuntimeType
The type of integration runtime.
Name | Type | Description |
---|---|---|
Managed |
string |
|
SelfHosted |
string |
IntegrationRuntimeVNetProperties
VNet properties for managed integration runtime.
Name | Type | Description |
---|---|---|
publicIPs |
string[] |
Resource IDs of the public IP addresses that this integration runtime will use. |
subnet |
string |
The name of the subnet this integration runtime will join. |
subnetId |
string |
The ID of subnet, to which this Azure-SSIS integration runtime will be joined. |
vNetId |
string |
The ID of the VNet that this integration runtime will join. |
LinkedIntegrationRuntimeKeyAuthorization
The key authorization type integration runtime.
Name | Type | Description |
---|---|---|
authorizationType |
string:
Key |
The authorization type for integration runtime sharing. |
key |
The key used for authorization. |
LinkedIntegrationRuntimeRbacAuthorization
The role based access control (RBAC) authorization type integration runtime.
Name | Type | Description |
---|---|---|
authorizationType |
string:
RBAC |
The authorization type for integration runtime sharing. |
credential |
The credential reference containing authentication information. |
|
resourceId |
string |
The resource identifier of the integration runtime to be shared. |
ManagedIntegrationRuntime
Managed integration runtime, including managed elastic and managed dedicated integration runtimes.
Name | Type | Description |
---|---|---|
description |
string |
Integration runtime description. |
managedVirtualNetwork |
Managed Virtual Network reference. |
|
state |
Integration runtime state, only valid for managed dedicated integration runtime. |
|
type |
string:
Managed |
Type of integration runtime. |
typeProperties.computeProperties |
The compute resource for managed integration runtime. |
|
typeProperties.customerVirtualNetwork |
The name of virtual network to which Azure-SSIS integration runtime will join |
|
typeProperties.ssisProperties |
SSIS properties for managed integration runtime. |
ManagedVirtualNetworkReference
Managed Virtual Network reference type.
Name | Type | Description |
---|---|---|
referenceName |
string |
Reference ManagedVirtualNetwork name. |
type |
Managed Virtual Network reference type. |
ManagedVirtualNetworkReferenceType
Managed Virtual Network reference type.
Name | Type | Description |
---|---|---|
ManagedVirtualNetworkReference |
string |
PackageStore
Package store for the SSIS integration runtime.
Name | Type | Description |
---|---|---|
name |
string |
The name of the package store |
packageStoreLinkedService |
The package store linked service reference. |
PipelineExternalComputeScaleProperties
PipelineExternalComputeScale properties for managed integration runtime.
Name | Type | Description |
---|---|---|
numberOfExternalNodes |
integer |
Number of the the external nodes, which should be greater than 0 and less than 11. |
numberOfPipelineNodes |
integer |
Number of the pipeline nodes, which should be greater than 0 and less than 11. |
timeToLive |
integer |
Time to live (in minutes) setting of integration runtime which will execute pipeline and external activity. |
SecureString
Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.
Name | Type | Description |
---|---|---|
type | string: |
Type of the secret. |
value |
string |
Value of secure string. |
SelfHostedIntegrationRuntime
Self-hosted integration runtime.
Name | Type | Description |
---|---|---|
description |
string |
Integration runtime description. |
type |
string:
Self |
Type of integration runtime. |
typeProperties.linkedInfo | LinkedIntegrationRuntimeType: |
The base definition of a linked integration runtime. |
typeProperties.selfContainedInteractiveAuthoringEnabled |
boolean |
An alternative option to ensure interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay. |
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. |