Integration Runtimes - Start

Service:

Data Factory

Version d'API:

2018-06-01

Démarre un runtime d’intégration de type ManagedReserved.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start?api-version=2018-06-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
factoryName	path	True	string	Nom de la fabrique. Modèle d’expression régulière: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
integrationRuntimeName	path	True	string	Nom du runtime d’intégration. Modèle d’expression régulière: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	Nom du groupe de ressources. Modèle d’expression régulière: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Identificateur de l’abonnement.
api-version	query	True	string	Version de l'API.

Réponses

Nom	Type	Description
200 OK	IntegrationRuntimeStatusResponse	OK.
202 Accepted		Accepté.
Other Status Codes	CloudError	Réponse d’erreur reçue du service Azure Data Factory.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

IntegrationRuntimes_Start

Exemple de requête

HTTP

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

Java

/**
 * Samples for IntegrationRuntimes Start.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/
     * IntegrationRuntimes_Start.json
     */
    /**
     * Sample code: IntegrationRuntimes_Start.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void integrationRuntimesStart(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.integrationRuntimes().start("exampleResourceGroup", "exampleFactoryName",
            "exampleManagedIntegrationRuntime", 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

Python

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_start.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.begin_start(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        integration_runtime_name="exampleManagedIntegrationRuntime",
    ).result()
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Start.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/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datafactory/armdatafactory/v9"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Start.json
func ExampleIntegrationRuntimesClient_BeginStart() {
	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)
	}
	poller, err := clientFactory.NewIntegrationRuntimesClient().BeginStart(ctx, "exampleResourceGroup", "exampleFactoryName", "exampleManagedIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.IntegrationRuntimeStatusResponse = armdatafactory.IntegrationRuntimeStatusResponse{
	// 	Name: to.Ptr("exampleManagedIntegrationRuntime"),
	// 	Properties: &armdatafactory.ManagedIntegrationRuntimeStatus{
	// 		Type: to.Ptr(armdatafactory.IntegrationRuntimeTypeManaged),
	// 		DataFactoryName: to.Ptr("exampleFactoryName"),
	// 		State: to.Ptr(armdatafactory.IntegrationRuntimeStateStarted),
	// 		TypeProperties: &armdatafactory.ManagedIntegrationRuntimeStatusTypeProperties{
	// 			CreateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-13T21:11:01.869Z"); return t}()),
	// 			Nodes: []*armdatafactory.ManagedIntegrationRuntimeNode{
	// 			},
	// 			OtherErrors: []*armdatafactory.ManagedIntegrationRuntimeError{
	// 			},
	// 		},
	// 	},
	// }
}

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 Starts a ManagedReserved type integration runtime.
 *
 * @summary Starts a ManagedReserved type integration runtime.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Start.json
 */
async function integrationRuntimesStart() {
  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 = "exampleManagedIntegrationRuntime";
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.integrationRuntimes.beginStartAndWait(
    resourceGroupName,
    factoryName,
    integrationRuntimeName,
  );
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Start.json
// this example is just showing the usage of "IntegrationRuntimes_Start" 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 = "exampleManagedIntegrationRuntime";
ResourceIdentifier dataFactoryIntegrationRuntimeResourceId = DataFactoryIntegrationRuntimeResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, integrationRuntimeName);
DataFactoryIntegrationRuntimeResource dataFactoryIntegrationRuntime = client.GetDataFactoryIntegrationRuntimeResource(dataFactoryIntegrationRuntimeResourceId);

// invoke the operation
ArmOperation<DataFactoryIntegrationRuntimeStatusResult> lro = await dataFactoryIntegrationRuntime.StartAsync(WaitUntil.Completed);
DataFactoryIntegrationRuntimeStatusResult result = lro.Value;

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

Exemple de réponse

Code d’état:

202

Code d’état:

200

Date: Wed, 13 Jun 2018 21:33:00 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14912
x-ms-request-id: 2af47f9f-5625-4b01-a3a5-bccb576a4677
x-ms-correlation-request-id: 2af47f9f-5625-4b01-a3a5-bccb576a4677

{
  "name": "exampleManagedIntegrationRuntime",
  "properties": {
    "dataFactoryName": "exampleFactoryName",
    "type": "Managed",
    "state": "Started",
    "typeProperties": {
      "nodes": [],
      "otherErrors": [],
      "createTime": "2018-06-13T21:11:01.8695494Z"
    }
  }
}

Définitions

Nom	Description
CloudError	Objet qui définit la structure d’une réponse d’erreur Azure Data Factory.
IntegrationRuntimeAutoUpdate	État de la mise à jour automatique du runtime d’intégration.
IntegrationRuntimeInternalChannelEncryptionMode	Il est utilisé pour définir le mode de chiffrement pour le canal de communication nœud-nœud (lorsqu’il existe plus de 2 nœuds de runtime d’intégration auto-hébergés).
IntegrationRuntimeState	État du runtime d’intégration.
IntegrationRuntimeStatusResponse	Réponse status runtime d’intégration.
IntegrationRuntimeType	Type de runtime d’intégration.
IntegrationRuntimeUpdateResult	Résultat de la dernière mise à jour du nœud du runtime d’intégration.
LinkedIntegrationRuntime	Informations sur le runtime d’intégration lié.
ManagedIntegrationRuntimeError	Définition d’erreur pour le runtime d’intégration managée.
ManagedIntegrationRuntimeNode	Propriétés du nœud du runtime d’intégration.
ManagedIntegrationRuntimeNodeStatus	Le nœud du runtime d’intégration managée status.
ManagedIntegrationRuntimeOperationResult	Propriétés du résultat de l’opération du runtime d’intégration managée.
ManagedIntegrationRuntimeStatus	Status du runtime d’intégration managée.
SelfHostedIntegrationRuntimeNode	Propriétés du nœud du runtime d’intégration auto-hébergé.
SelfHostedIntegrationRuntimeNodeStatus	État du nœud du runtime d’intégration.
SelfHostedIntegrationRuntimeStatus	Status du runtime d’intégration auto-hébergé.

CloudError

Objet qui définit la structure d’une réponse d’erreur Azure Data Factory.

Nom	Type	Description
error.code	string	Code d’erreur.
error.details	CloudError[]	Tableau avec des détails d’erreur supplémentaires.
error.message	string	Message d’erreur.
error.target	string	Nom/chemin de propriété dans la demande associée à l’erreur.

IntegrationRuntimeAutoUpdate

État de la mise à jour automatique du runtime d’intégration.

Nom	Type	Description
Off	string
On	string

IntegrationRuntimeInternalChannelEncryptionMode

Il est utilisé pour définir le mode de chiffrement pour le canal de communication nœud-nœud (lorsqu’il existe plus de 2 nœuds de runtime d’intégration auto-hébergés).

Nom	Type	Description
NotEncrypted	string
NotSet	string
SslEncrypted	string

IntegrationRuntimeState

État du runtime d’intégration.

Nom	Type	Description
AccessDenied	string
Initial	string
Limited	string
NeedRegistration	string
Offline	string
Online	string
Started	string
Starting	string
Stopped	string
Stopping	string

IntegrationRuntimeStatusResponse

Réponse status runtime d’intégration.

Nom	Type	Description
name	string	Nom du runtime d’intégration.
properties	IntegrationRuntimeStatus: ManagedIntegrationRuntimeStatus SelfHostedIntegrationRuntimeStatus	Propriétés du runtime d’intégration.

IntegrationRuntimeType

Type de runtime d’intégration.

Nom	Type	Description
Managed	string
SelfHosted	string

IntegrationRuntimeUpdateResult

Résultat de la dernière mise à jour du nœud du runtime d’intégration.

Nom	Type	Description
Fail	string
None	string
Succeed	string

LinkedIntegrationRuntime

Informations sur le runtime d’intégration lié.

Nom	Type	Description
createTime	string	Heure de création du runtime d’intégration lié.
dataFactoryLocation	string	Emplacement de la fabrique de données à laquelle appartient le runtime d’intégration lié.
dataFactoryName	string	Nom de la fabrique de données à laquelle appartient le runtime d’intégration lié.
name	string	Nom du runtime d’intégration lié.
subscriptionId	string	ID d’abonnement auquel appartient le runtime d’intégration lié.

ManagedIntegrationRuntimeError

Définition d’erreur pour le runtime d’intégration managée.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur.
parameters	string[]	Paramètres d’erreur du runtime d’intégration managée.
time	string	Heure à laquelle l'erreur s'est produite.

ManagedIntegrationRuntimeNode

Propriétés du nœud du runtime d’intégration.

Nom	Type	Description
errors	ManagedIntegrationRuntimeError[]	Erreurs qui se sont produites sur ce nœud du runtime d’intégration.
nodeId	string	ID de nœud du runtime d’intégration managée.
status	ManagedIntegrationRuntimeNodeStatus	Le nœud du runtime d’intégration managée status.

ManagedIntegrationRuntimeNodeStatus

Le nœud du runtime d’intégration managée status.

Nom	Type	Description
Available	string
Recycling	string
Starting	string
Unavailable	string

ManagedIntegrationRuntimeOperationResult

Propriétés du résultat de l’opération du runtime d’intégration managée.

Nom	Type	Description
activityId	string	ID d’activité de la demande d’opération.
errorCode	string	Code d'erreur.
parameters	string[]	Paramètres d’erreur du runtime d’intégration managée.
result	string	Le résultat d'opération.
startTime	string	Heure de début de l'opération.
type	string	Type d'opération. Peut être démarrer ou arrêter.

ManagedIntegrationRuntimeStatus

Status du runtime d’intégration managée.

Nom	Type	Description
dataFactoryName	string	Nom de la fabrique de données à laquelle appartient le runtime d’intégration.
state	IntegrationRuntimeState	État du runtime d’intégration.
type	string: Managed	Type de runtime d’intégration.
typeProperties.createTime	string	Heure à laquelle le runtime d’intégration a été créé, au format ISO8601.
typeProperties.lastOperation	ManagedIntegrationRuntimeOperationResult	Résultat de la dernière opération qui s’est produite sur ce runtime d’intégration.
typeProperties.nodes	ManagedIntegrationRuntimeNode[]	Liste des nœuds pour le runtime d’intégration managée.
typeProperties.otherErrors	ManagedIntegrationRuntimeError[]	Erreurs qui se sont produites sur ce runtime d’intégration.

SelfHostedIntegrationRuntimeNode

Propriétés du nœud du runtime d’intégration auto-hébergé.

Nom	Type	Description
capabilities	object	Dictionnaire des fonctionnalités du runtime d’intégration
concurrentJobsLimit	integer	Nombre maximal de travaux simultanés sur le nœud du runtime d’intégration.
expiryTime	string	Heure à laquelle le runtime d’intégration expire au format ISO8601.
hostServiceUri	string	URI de l’ordinateur hôte du runtime d’intégration.
isActiveDispatcher	boolean	Indique si ce nœud est le répartiteur actif pour les demandes du runtime d’intégration.
lastConnectTime	string	Heure la plus récente à laquelle le runtime d’intégration a été connecté au format ISO8601.
lastEndUpdateTime	string	Dernière fois pour la fin de la mise à jour du nœud du runtime d’intégration.
lastStartTime	string	Heure du dernier démarrage du nœud.
lastStartUpdateTime	string	Dernière fois que la mise à jour du nœud du runtime d’intégration démarre.
lastStopTime	string	Heure du dernier arrêt du nœud du runtime d’intégration.
lastUpdateResult	IntegrationRuntimeUpdateResult	Résultat de la dernière mise à jour du nœud du runtime d’intégration.
machineName	string	Nom de l’ordinateur du nœud du runtime d’intégration.
maxConcurrentJobs	integer	Nombre maximal de travaux simultanés dans ce runtime d’intégration.
nodeName	string	Nom du nœud du runtime d’intégration.
registerTime	string	Heure à laquelle le nœud du runtime d’intégration a été inscrit au format ISO8601.
status	SelfHostedIntegrationRuntimeNodeStatus	État du nœud du runtime d’intégration.
version	string	Version du nœud du runtime d’intégration.
versionStatus	string	État de la version du nœud du runtime d’intégration.

SelfHostedIntegrationRuntimeNodeStatus

État du nœud du runtime d’intégration.

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

SelfHostedIntegrationRuntimeStatus

Status du runtime d’intégration auto-hébergé.

Nom	Type	Description
dataFactoryName	string	Nom de la fabrique de données à laquelle appartient le runtime d’intégration.
state	IntegrationRuntimeState	État du runtime d’intégration.
type	string: SelfHosted	Type de runtime d’intégration.
typeProperties.autoUpdate	IntegrationRuntimeAutoUpdate	Indique si la mise à jour automatique du runtime d’intégration auto-hébergé a été activée.
typeProperties.autoUpdateETA	string	Heure estimée à laquelle le runtime d’intégration auto-hébergé sera mis à jour.
typeProperties.capabilities	object	Objet avec des informations supplémentaires sur les fonctionnalités du runtime d’intégration.
typeProperties.createTime	string	Heure à laquelle le runtime d’intégration a été créé, au format ISO8601.
typeProperties.internalChannelEncryption	IntegrationRuntimeInternalChannelEncryptionMode	Il est utilisé pour définir le mode de chiffrement pour le canal de communication nœud-nœud (lorsqu’il existe plus de 2 nœuds de runtime d’intégration auto-hébergés).
typeProperties.latestVersion	string	Dernière version dans le centre de téléchargement.
typeProperties.links	LinkedIntegrationRuntime[]	Liste des runtimes d’intégration liés qui sont créés pour partager avec ce runtime d’intégration.
typeProperties.localTimeZoneOffset	string	Décalage de fuseau horaire local en heures.
typeProperties.nodes	SelfHostedIntegrationRuntimeNode[]	Liste des nœuds pour ce runtime d’intégration.
typeProperties.pushedVersion	string	Version vers laquelle le runtime d’intégration va être mis à jour.
typeProperties.scheduledUpdateDate	string	Date à laquelle la mise à jour du runtime d’intégration sera planifiée, au format ISO8601.
typeProperties.selfContainedInteractiveAuthoringEnabled	boolean	Une autre option pour garantir la fonction de création interactive lorsque votre runtime d’intégration auto-hébergé n’est pas en mesure d’établir une connexion avec Azure Relay.
typeProperties.serviceUrls	string[]	URL des services utilisés dans le service principal du runtime d’intégration.
typeProperties.taskQueueId	string	ID de file d’attente de tâches du runtime d’intégration.
typeProperties.updateDelayOffset	string	L’heure de la date planifiée par le service pour mettre à jour le runtime d’intégration, par exemple, PT03H est de 3 heures
typeProperties.version	string	Version du runtime d’intégration.
typeProperties.versionStatus	string	État de la version du runtime d’intégration.