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
factoryName
path True

string

The factory name.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

integrationRuntimeName
path True

string

The integration runtime name.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

resourceGroupName
path True

string

The resource group name.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True

string

The subscription identifier.

api-version
query True

string

The API version.

Request Body

Name Type Description
autoUpdate

IntegrationRuntimeAutoUpdate

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

IntegrationRuntimeResource

OK.

Other Status Codes

CloudError

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
CloudError

The object that defines the structure of an Azure Data Factory error response.

CopyComputeScaleProperties

CopyComputeScale properties for managed integration runtime.

CredentialReference

Credential reference type.

CredentialReferenceType

Credential reference type.

CustomProperties

Custom properties are used to tune the data flow runtime performance.

DataFlowComputeType

Compute type of the cluster which will execute data flow job.

EntityReference

The entity reference.

IntegrationRuntimeAutoUpdate

The state of integration runtime auto update.

IntegrationRuntimeComputeProperties

The compute resource properties for managed integration runtime.

IntegrationRuntimeCustomerVirtualNetwork

The definition and properties of virtual network to which Azure-SSIS integration runtime will join.

IntegrationRuntimeCustomSetupScriptProperties

Custom setup script properties for a managed dedicated integration runtime.

IntegrationRuntimeDataFlowProperties

Data flow properties for managed integration runtime.

IntegrationRuntimeDataProxyProperties

Data proxy properties for a managed dedicated integration runtime.

IntegrationRuntimeEdition

The edition for the SSIS Integration Runtime

IntegrationRuntimeEntityReferenceType

The type of this referenced entity.

IntegrationRuntimeLicenseType

License type for bringing your own license scenario.

IntegrationRuntimeResource

Integration runtime resource type.

IntegrationRuntimeSsisCatalogInfo

Catalog information for managed dedicated integration runtime.

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/

IntegrationRuntimeSsisProperties

SSIS properties for managed integration runtime.

IntegrationRuntimeState

The state of integration runtime.

IntegrationRuntimeType

The type of integration runtime.

IntegrationRuntimeVNetProperties

VNet properties for managed integration runtime.

LinkedIntegrationRuntimeKeyAuthorization

The key authorization type integration runtime.

LinkedIntegrationRuntimeRbacAuthorization

The role based access control (RBAC) authorization type integration runtime.

ManagedIntegrationRuntime

Managed integration runtime, including managed elastic and managed dedicated integration runtimes.

ManagedVirtualNetworkReference

Managed Virtual Network reference type.

ManagedVirtualNetworkReferenceType

Managed Virtual Network reference type.

PackageStore

Package store for the SSIS integration runtime.

PipelineExternalComputeScaleProperties

PipelineExternalComputeScale properties for managed integration runtime.

SecureString

Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.

SelfHostedIntegrationRuntime

Self-hosted integration runtime.

UpdateIntegrationRuntimeRequest

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

CloudError[]

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

CredentialReferenceType

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

IntegrationRuntimeEntityReferenceType

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

CopyComputeScaleProperties

CopyComputeScale properties for managed integration runtime.

dataFlowProperties

IntegrationRuntimeDataFlowProperties

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

PipelineExternalComputeScaleProperties

PipelineExternalComputeScale properties for managed integration runtime.

vNetProperties

IntegrationRuntimeVNetProperties

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

SecureString

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

DataFlowComputeType

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

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

EntityReference

The self-hosted integration runtime reference.

path

string

The path to contain the staged data in the Blob storage.

stagingLinkedService

EntityReference

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

SecureString

The password of the administrator user account of the catalog database.

catalogAdminUserName

string

The administrator user name of catalog database.

catalogPricingTier

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/

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

IntegrationRuntimeSsisCatalogInfo

Catalog information for managed dedicated integration runtime.

credential

CredentialReference

The credential reference containing authentication information.

customSetupScriptProperties

IntegrationRuntimeCustomSetupScriptProperties

Custom setup script properties for a managed dedicated integration runtime.

dataProxyProperties

IntegrationRuntimeDataProxyProperties

Data proxy properties for a managed dedicated integration runtime.

edition

IntegrationRuntimeEdition

The edition for the SSIS Integration Runtime

expressCustomSetupProperties

CustomSetupBase[]

Custom setup without script properties for a SSIS integration runtime.

licenseType

IntegrationRuntimeLicenseType

License type for bringing your own license scenario.

packageStores

PackageStore[]

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

SecureString

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

CredentialReference

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

ManagedVirtualNetworkReference

Managed Virtual Network reference.

state

IntegrationRuntimeState

Integration runtime state, only valid for managed dedicated integration runtime.

type string:

Managed

Type of integration runtime.

typeProperties.computeProperties

IntegrationRuntimeComputeProperties

The compute resource for managed integration runtime.

typeProperties.customerVirtualNetwork

IntegrationRuntimeCustomerVirtualNetwork

The name of virtual network to which Azure-SSIS integration runtime will join

typeProperties.ssisProperties

IntegrationRuntimeSsisProperties

SSIS properties for managed integration runtime.

ManagedVirtualNetworkReference

Managed Virtual Network reference type.

Name Type Description
referenceName

string

Reference ManagedVirtualNetwork name.

type

ManagedVirtualNetworkReferenceType

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

EntityReference

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:

SecureString

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:

SelfHosted

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

IntegrationRuntimeAutoUpdate

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.