Integration Runtime Nodes - Update

Reference

Service:: Data Factory

API Version:: 2018-06-01

Updates a self-hosted integration runtime node.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}?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]+)*$`
nodeName	path	True	string	The integration runtime node name. Regex pattern: `^[a-z0-9A-Z][a-z0-9A-Z_-]{0,149}$`
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
concurrentJobsLimit	integer	The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed.

Responses

Name	Type	Description
200 OK	SelfHostedIntegrationRuntimeNode	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

IntegrationRuntimeNodes_Update

Sample Request

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

{
  "concurrentJobsLimit": 2
}


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

/**
 * Samples for IntegrationRuntimeNodes Update.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/
     * IntegrationRuntimeNodes_Update.json
     */
    /**
     * Sample code: IntegrationRuntimeNodes_Update.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void integrationRuntimeNodesUpdate(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.integrationRuntimeNodes().updateWithResponse("exampleResourceGroup", "exampleFactoryName",
            "exampleIntegrationRuntime", "Node_1", new UpdateIntegrationRuntimeNodeRequest().withConcurrentJobsLimit(2),
            com.azure.core.util.Context.NONE);
    }
}

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

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_runtime_nodes_update.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_runtime_nodes.update(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        integration_runtime_name="exampleIntegrationRuntime",
        node_name="Node_1",
        update_integration_runtime_node_request={"concurrentJobsLimit": 2},
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeNodes_Update.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

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/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeNodes_Update.json
func ExampleIntegrationRuntimeNodesClient_Update() {
	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.NewIntegrationRuntimeNodesClient().Update(ctx, "exampleResourceGroup", "exampleFactoryName", "exampleIntegrationRuntime", "Node_1", armdatafactory.UpdateIntegrationRuntimeNodeRequest{
		ConcurrentJobsLimit: to.Ptr[int32](2),
	}, 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.SelfHostedIntegrationRuntimeNode = armdatafactory.SelfHostedIntegrationRuntimeNode{
	// 	Capabilities: map[string]*string{
	// 		"connectedToResourceManager": to.Ptr("True"),
	// 		"credentialInSync": to.Ptr("True"),
	// 		"httpsPortEnabled": to.Ptr("True"),
	// 		"nodeEnabled": to.Ptr("True"),
	// 		"serviceBusConnected": to.Ptr("True"),
	// 	},
	// 	ConcurrentJobsLimit: to.Ptr[int32](2),
	// 	HostServiceURI: to.Ptr("https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/"),
	// 	IsActiveDispatcher: to.Ptr(true),
	// 	LastConnectTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T15:00:35.754Z"); return t}()),
	// 	LastStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T14:52:59.893Z"); return t}()),
	// 	LastUpdateResult: to.Ptr(armdatafactory.IntegrationRuntimeUpdateResultNone),
	// 	MachineName: to.Ptr("YANZHANG-DT"),
	// 	MaxConcurrentJobs: to.Ptr[int32](56),
	// 	NodeName: to.Ptr("Node_1"),
	// 	RegisterTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T14:51:44.923Z"); return t}()),
	// 	Status: to.Ptr(armdatafactory.SelfHostedIntegrationRuntimeNodeStatusOnline),
	// 	Version: to.Ptr("3.8.6730.2"),
	// 	VersionStatus: to.Ptr("UpToDate"),
	// }
}

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

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

/**
 * This sample demonstrates how to Updates a self-hosted integration runtime node.
 *
 * @summary Updates a self-hosted integration runtime node.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeNodes_Update.json
 */
async function integrationRuntimeNodesUpdate() {
  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 nodeName = "Node_1";
  const updateIntegrationRuntimeNodeRequest = { concurrentJobsLimit: 2 };
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.integrationRuntimeNodes.update(
    resourceGroupName,
    factoryName,
    integrationRuntimeName,
    nodeName,
    updateIntegrationRuntimeNodeRequest,
  );
  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

using System;
using System.Threading.Tasks;
using System.Xml;
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/IntegrationRuntimeNodes_Update.json
// this example is just showing the usage of "IntegrationRuntimeNodes_Update" 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 DataFactoryIntegrationRuntimeResource created on azure
// for more information of creating DataFactoryIntegrationRuntimeResource, please refer to the document of DataFactoryIntegrationRuntimeResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
string integrationRuntimeName = "exampleIntegrationRuntime";
ResourceIdentifier dataFactoryIntegrationRuntimeResourceId = DataFactoryIntegrationRuntimeResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, integrationRuntimeName);
DataFactoryIntegrationRuntimeResource dataFactoryIntegrationRuntime = client.GetDataFactoryIntegrationRuntimeResource(dataFactoryIntegrationRuntimeResourceId);

// invoke the operation
string nodeName = "Node_1";
UpdateIntegrationRuntimeNodeContent content = new UpdateIntegrationRuntimeNodeContent()
{
    ConcurrentJobsLimit = 2,
};
SelfHostedIntegrationRuntimeNode result = await dataFactoryIntegrationRuntime.UpdateIntegrationRuntimeNodeAsync(nodeName, content);

Console.WriteLine($"Succeeded: {result}");

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: Thu, 14 Jun 2018 15:01:00 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1199
x-ms-request-id: cf0d05fa-afbe-4fac-aa10-227885658c83
x-ms-correlation-request-id: cf0d05fa-afbe-4fac-aa10-227885658c83

Response Body

{
  "nodeName": "Node_1",
  "machineName": "YANZHANG-DT",
  "hostServiceUri": "https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/",
  "status": "Online",
  "capabilities": {
    "serviceBusConnected": "True",
    "httpsPortEnabled": "True",
    "credentialInSync": "True",
    "connectedToResourceManager": "True",
    "nodeEnabled": "True"
  },
  "versionStatus": "UpToDate",
  "version": "3.8.6730.2",
  "registerTime": "2018-06-14T14:51:44.9237069Z",
  "lastConnectTime": "2018-06-14T15:00:35.7544322Z",
  "lastStartTime": "2018-06-14T14:52:59.8933313Z",
  "lastUpdateResult": "None",
  "isActiveDispatcher": true,
  "concurrentJobsLimit": 2,
  "maxConcurrentJobs": 56
}

Definitions

Name	Description
CloudError	The object that defines the structure of an Azure Data Factory error response.
IntegrationRuntimeUpdateResult	The result of the last integration runtime node update.
SelfHostedIntegrationRuntimeNode	Properties of Self-hosted integration runtime node.
SelfHostedIntegrationRuntimeNodeStatus	Status of the integration runtime node.
UpdateIntegrationRuntimeNodeRequest	Update integration runtime node 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.

IntegrationRuntimeUpdateResult

The result of the last integration runtime node update.

Name	Type	Description
Fail	string
None	string
Succeed	string

SelfHostedIntegrationRuntimeNode

Properties of Self-hosted integration runtime node.

Name	Type	Description
capabilities	object	The integration runtime capabilities dictionary
concurrentJobsLimit	integer	Maximum concurrent jobs on the integration runtime node.
expiryTime	string	The time at which the integration runtime will expire in ISO8601 format.
hostServiceUri	string	URI for the host machine of the integration runtime.
isActiveDispatcher	boolean	Indicates whether this node is the active dispatcher for integration runtime requests.
lastConnectTime	string	The most recent time at which the integration runtime was connected in ISO8601 format.
lastEndUpdateTime	string	The last time for the integration runtime node update end.
lastStartTime	string	The time the node last started up.
lastStartUpdateTime	string	The last time for the integration runtime node update start.
lastStopTime	string	The integration runtime node last stop time.
lastUpdateResult	IntegrationRuntimeUpdateResult	The result of the last integration runtime node update.
machineName	string	Machine name of the integration runtime node.
maxConcurrentJobs	integer	The maximum concurrent jobs in this integration runtime.
nodeName	string	Name of the integration runtime node.
registerTime	string	The time at which the integration runtime node was registered in ISO8601 format.
status	SelfHostedIntegrationRuntimeNodeStatus	Status of the integration runtime node.
version	string	Version of the integration runtime node.
versionStatus	string	Status of the integration runtime node version.

SelfHostedIntegrationRuntimeNodeStatus

Status of the integration runtime node.

Name	Type	Description
InitializeFailed	string
Initializing	string
Limited	string
NeedRegistration	string
Offline	string
Online	string
Upgrading	string

UpdateIntegrationRuntimeNodeRequest

Update integration runtime node request.

Name	Type	Description
concurrentJobsLimit	integer	The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed.