Integration Runtimes - Create Or Update

Service:

Data Factory

API Version:

2018-06-01

Creates or updates an integration runtime.

PUT 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 Header

Name	Required	Type	Description
If-Match		string	ETag of the integration runtime entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Request Body

Name	Required	Type	Description
properties	True	IntegrationRuntime: ManagedIntegrationRuntime SelfHostedIntegrationRuntime	Integration runtime properties.

Responses

Name	Type	Description
200 OK	IntegrationRuntimeResource	OK.
Other Status Codes	CloudError	An error response received from PUT integration runtime operation.

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_Create

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleIntegrationRuntime?api-version=2018-06-01

{
  "properties": {
    "type": "SelfHosted",
    "description": "A selfhosted integration runtime"
  }
}

Java

import com.azure.resourcemanager.datafactory.models.SelfHostedIntegrationRuntime;

/**
 * Samples for IntegrationRuntimes CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/
     * IntegrationRuntimes_Create.json
     */
    /**
     * Sample code: IntegrationRuntimes_Create.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void integrationRuntimesCreate(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.integrationRuntimes().define("exampleIntegrationRuntime")
            .withExistingFactory("exampleResourceGroup", "exampleFactoryName")
            .withProperties(new SelfHostedIntegrationRuntime().withDescription("A selfhosted integration runtime"))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python integration_runtimes_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-12345678abc",
    )

    response = client.integration_runtimes.create_or_update(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        integration_runtime_name="exampleIntegrationRuntime",
        integration_runtime={"properties": {"description": "A selfhosted integration runtime", "type": "SelfHosted"}},
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Create.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdatafactory_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datafactory/armdatafactory/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/01a71545e82bb98b8137d3038150c436d46a59ed/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Create.json
func ExampleIntegrationRuntimesClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatafactory.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimesClient().CreateOrUpdate(ctx, "exampleResourceGroup", "exampleFactoryName", "exampleIntegrationRuntime", armdatafactory.IntegrationRuntimeResource{
		Properties: &armdatafactory.SelfHostedIntegrationRuntime{
			Type:        to.Ptr(armdatafactory.IntegrationRuntimeTypeSelfHosted),
			Description: to.Ptr("A selfhosted integration runtime"),
		},
	}, &armdatafactory.IntegrationRuntimesClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeResource = armdatafactory.IntegrationRuntimeResource{
	// 	Name: to.Ptr("exampleIntegrationRuntime"),
	// 	Type: to.Ptr("Microsoft.DataFactory/factories/integrationruntimes"),
	// 	Etag: to.Ptr("000046c4-0000-0000-0000-5b2198bf0000"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime"),
	// 	Properties: &armdatafactory.SelfHostedIntegrationRuntime{
	// 		Type: to.Ptr(armdatafactory.IntegrationRuntimeTypeSelfHosted),
	// 		Description: to.Ptr("A selfhosted integration runtime"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DataFactoryManagementClient } = require("@azure/arm-datafactory");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates an integration runtime.
 *
 * @summary Creates or updates an integration runtime.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Create.json
 */
async function integrationRuntimesCreate() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const integrationRuntimeName = "exampleIntegrationRuntime";
  const integrationRuntime = {
    properties: {
      type: "SelfHosted",
      description: "A selfhosted integration runtime",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.integrationRuntimes.createOrUpdate(
    resourceGroupName,
    factoryName,
    integrationRuntimeName,
    integrationRuntime,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataFactory;
using Azure.ResourceManager.DataFactory.Models;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Create.json
// this example is just showing the usage of "IntegrationRuntimes_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataFactoryResource created on azure
// for more information of creating DataFactoryResource, please refer to the document of DataFactoryResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
ResourceIdentifier dataFactoryResourceId = DataFactoryResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName);
DataFactoryResource dataFactory = client.GetDataFactoryResource(dataFactoryResourceId);

// get the collection of this DataFactoryIntegrationRuntimeResource
DataFactoryIntegrationRuntimeCollection collection = dataFactory.GetDataFactoryIntegrationRuntimes();

// invoke the operation
string integrationRuntimeName = "exampleIntegrationRuntime";
DataFactoryIntegrationRuntimeData data = new DataFactoryIntegrationRuntimeData(new SelfHostedIntegrationRuntime()
{
    Description = "A selfhosted integration runtime",
});
ArmOperation<DataFactoryIntegrationRuntimeResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, integrationRuntimeName, data);
DataFactoryIntegrationRuntimeResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataFactoryIntegrationRuntimeData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

Date: Wed, 13 Jun 2018 22:20:47 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1197
x-ms-request-id: 125c07fa-e39a-4541-885f-5019631a5ecd
x-ms-correlation-request-id: 125c07fa-e39a-4541-885f-5019631a5ecd

Response Body

{
  "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": "000046c4-0000-0000-0000-5b2198bf0000"
}

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.
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.

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.

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: ManagedIntegrationRuntime SelfHostedIntegrationRuntime	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: LinkedIntegrationRuntimeKeyAuthorization LinkedIntegrationRuntimeRbacAuthorization	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.