Integration Runtimes - Start

Service:

Data Factory

API-versie:

2018-06-01

Hiermee start u een Integratieruntime van het type ManagedReserved.

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

URI-parameters

Name	In	Vereist	Type	Description
factoryName	path	True	string	De fabrieksnaam. Regex-patroon: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
integrationRuntimeName	path	True	string	De naam van de integratieruntime. Regex-patroon: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	De naam van de resourcegroep. Regex-patroon: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	De abonnements-id.
api-version	query	True	string	De API-versie.

Antwoorden

Name	Type	Description
200 OK	IntegrationRuntimeStatusResponse	OK.
202 Accepted		Aanvaard.
Other Status Codes	CloudError	Een foutbericht ontvangen van de Azure Data Factory-service.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

IntegrationRuntimes_Start

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

202

Statuscode:

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"
    }
  }
}

Definities

Name	Description
CloudError	Het object dat de structuur van een Azure Data Factory foutreactie definieert.
IntegrationRuntimeAutoUpdate	De status van automatische update van Integration Runtime.
IntegrationRuntimeInternalChannelEncryptionMode	Het wordt gebruikt om de versleutelingsmodus in te stellen voor het communicatiekanaal knooppunt-knooppunt (wanneer er meer dan twee zelf-hostende Integration Runtime-knooppunten bestaan).
IntegrationRuntimeState	De status van integration runtime.
IntegrationRuntimeStatusResponse	Antwoord op status van integratieruntime.
IntegrationRuntimeType	Het type integration runtime.
IntegrationRuntimeUpdateResult	Het resultaat van de laatste update van het Integratieruntime-knooppunt.
LinkedIntegrationRuntime	De gekoppelde integration runtime-informatie.
ManagedIntegrationRuntimeError	Foutdefinitie voor beheerde integratieruntime.
ManagedIntegrationRuntimeNode	Eigenschappen van het Integratieruntime-knooppunt.
ManagedIntegrationRuntimeNodeStatus	De status van het beheerde Integration Runtime-knooppunt.
ManagedIntegrationRuntimeOperationResult	Eigenschappen van bewerkingsresultaat van beheerde integratieruntime.
ManagedIntegrationRuntimeStatus	Runtimestatus van beheerde integratie.
SelfHostedIntegrationRuntimeNode	Eigenschappen van zelf-hostend Integration Runtime-knooppunt.
SelfHostedIntegrationRuntimeNodeStatus	Status van het Integratieruntime-knooppunt.
SelfHostedIntegrationRuntimeStatus	Status van zelf-hostende Integration Runtime.

CloudError

Het object dat de structuur van een Azure Data Factory foutreactie definieert.

Name	Type	Description
error.code	string	Foutcode.
error.details	CloudError[]	Matrix met aanvullende foutdetails.
error.message	string	Foutbericht.
error.target	string	De naam/het pad van de eigenschap in de aanvraag die is gekoppeld aan een fout.

IntegrationRuntimeAutoUpdate

De status van automatische update van Integration Runtime.

Name	Type	Description
Off	string
On	string

IntegrationRuntimeInternalChannelEncryptionMode

Het wordt gebruikt om de versleutelingsmodus in te stellen voor het communicatiekanaal knooppunt-knooppunt (wanneer er meer dan twee zelf-hostende Integration Runtime-knooppunten bestaan).

Name	Type	Description
NotEncrypted	string
NotSet	string
SslEncrypted	string

IntegrationRuntimeState

De status van 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

IntegrationRuntimeStatusResponse

Antwoord op status van integratieruntime.

Name	Type	Description
name	string	De naam van de integratieruntime.
properties	IntegrationRuntimeStatus: ManagedIntegrationRuntimeStatus SelfHostedIntegrationRuntimeStatus	Eigenschappen van Integratieruntime.

IntegrationRuntimeType

Het type integration runtime.

Name	Type	Description
Managed	string
SelfHosted	string

IntegrationRuntimeUpdateResult

Het resultaat van de laatste update van het Integratieruntime-knooppunt.

Name	Type	Description
Fail	string
None	string
Succeed	string

LinkedIntegrationRuntime

De gekoppelde integration runtime-informatie.

Name	Type	Description
createTime	string	De aan te maken tijd van de gekoppelde integration runtime.
dataFactoryLocation	string	De locatie van de data factory waartoe de gekoppelde Integration Runtime behoort.
dataFactoryName	string	De naam van de gegevensfactory waartoe de gekoppelde integration runtime behoort.
name	string	De naam van de gekoppelde Integration Runtime.
subscriptionId	string	De abonnements-id waartoe de gekoppelde integration runtime behoort.

ManagedIntegrationRuntimeError

Foutdefinitie voor beheerde integratieruntime.

Name	Type	Description
code	string	Foutcode.
message	string	Foutbericht.
parameters	string[]	Foutparameters voor beheerde integratieruntime.
time	string	Het tijdstip waarop de fout is opgetreden.

ManagedIntegrationRuntimeNode

Eigenschappen van het Integratieruntime-knooppunt.

Name	Type	Description
errors	ManagedIntegrationRuntimeError[]	De fouten die zijn opgetreden op dit Integratieruntime-knooppunt.
nodeId	string	De knooppunt-id van de beheerde integratieruntime.
status	ManagedIntegrationRuntimeNodeStatus	De status van het beheerde Integration Runtime-knooppunt.

ManagedIntegrationRuntimeNodeStatus

De status van het beheerde Integration Runtime-knooppunt.

Name	Type	Description
Available	string
Recycling	string
Starting	string
Unavailable	string

ManagedIntegrationRuntimeOperationResult

Eigenschappen van bewerkingsresultaat van beheerde integratieruntime.

Name	Type	Description
activityId	string	De activiteits-id voor de bewerkingsaanvraag.
errorCode	string	De foutcode.
parameters	string[]	Foutparameters voor beheerde integratieruntime.
result	string	Het bewerkingsresultaat.
startTime	string	De begintijd van de bewerking.
type	string	Het bewerkingstype. Kan starten of stoppen zijn.

ManagedIntegrationRuntimeStatus

Runtimestatus van beheerde integratie.

Name	Type	Description
dataFactoryName	string	De naam van de data factory waartoe de integratieruntime behoort.
state	IntegrationRuntimeState	De status van integration runtime.
type	string: Managed	Type Integration Runtime.
typeProperties.createTime	string	Het tijdstip waarop de Integration Runtime is gemaakt, in ISO8601 indeling.
typeProperties.lastOperation	ManagedIntegrationRuntimeOperationResult	Het laatste bewerkingsresultaat dat is opgetreden bij deze integratieruntime.
typeProperties.nodes	ManagedIntegrationRuntimeNode[]	De lijst met knooppunten voor beheerde integratieruntime.
typeProperties.otherErrors	ManagedIntegrationRuntimeError[]	De fouten die zijn opgetreden in deze integratieruntime.

SelfHostedIntegrationRuntimeNode

Eigenschappen van zelf-hostend Integration Runtime-knooppunt.

Name	Type	Description
capabilities	object	De woordenlijst met mogelijkheden voor integratieruntime
concurrentJobsLimit	integer	Maximum aantal gelijktijdige taken op het Integratieruntime-knooppunt.
expiryTime	string	Het tijdstip waarop de Integration Runtime verloopt in ISO8601 indeling.
hostServiceUri	string	URI voor de hostcomputer van de Integration Runtime.
isActiveDispatcher	boolean	Geeft aan of dit knooppunt de actieve dispatcher is voor integratieruntime-aanvragen.
lastConnectTime	string	Het meest recente tijdstip waarop de Integration Runtime is verbonden in ISO8601 indeling.
lastEndUpdateTime	string	De laatste keer dat het integratieruntime-knooppunt is bijgewerkt.
lastStartTime	string	De tijd waarop het knooppunt voor het laatst is opgestart.
lastStartUpdateTime	string	De laatste keer dat de update van het Integratieruntime-knooppunt wordt gestart.
lastStopTime	string	De laatste stoptijd van het Integration Runtime-knooppunt.
lastUpdateResult	IntegrationRuntimeUpdateResult	Het resultaat van de laatste update van het Integratieruntime-knooppunt.
machineName	string	Computernaam van het Integratieruntime-knooppunt.
maxConcurrentJobs	integer	De maximale gelijktijdige taken in deze integratieruntime.
nodeName	string	Naam van het Integratieruntime-knooppunt.
registerTime	string	Het tijdstip waarop het Integration Runtime-knooppunt is geregistreerd in ISO8601 indeling.
status	SelfHostedIntegrationRuntimeNodeStatus	Status van het Integratieruntime-knooppunt.
version	string	Versie van het Integratieruntime-knooppunt.
versionStatus	string	Status van de versie van het Integration Runtime-knooppunt.

SelfHostedIntegrationRuntimeNodeStatus

Status van het Integratieruntime-knooppunt.

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

SelfHostedIntegrationRuntimeStatus

Status van zelf-hostende Integration Runtime.

Name	Type	Description
dataFactoryName	string	De naam van de data factory waartoe de integratieruntime behoort.
state	IntegrationRuntimeState	De status van integration runtime.
type	string: SelfHosted	Type Integration Runtime.
typeProperties.autoUpdate	IntegrationRuntimeAutoUpdate	Of automatisch bijwerken van zelf-hostende Integration Runtime is ingeschakeld.
typeProperties.autoUpdateETA	string	De geschatte tijd waarop de zelf-hostende Integration Runtime wordt bijgewerkt.
typeProperties.capabilities	object	Object met aanvullende informatie over de mogelijkheden van Integratieruntime.
typeProperties.createTime	string	Het tijdstip waarop de Integration Runtime is gemaakt, in ISO8601 indeling.
typeProperties.internalChannelEncryption	IntegrationRuntimeInternalChannelEncryptionMode	Het wordt gebruikt om de versleutelingsmodus in te stellen voor het communicatiekanaal knooppunt-knooppunt (wanneer er meer dan twee zelf-hostende Integration Runtime-knooppunten bestaan).
typeProperties.latestVersion	string	De nieuwste versie in het downloadcentrum.
typeProperties.links	LinkedIntegrationRuntime[]	De lijst met gekoppelde integratieruntimes die zijn gemaakt om te delen met deze integratieruntime.
typeProperties.localTimeZoneOffset	string	De verschuiving van de lokale tijdzone in uren.
typeProperties.nodes	SelfHostedIntegrationRuntimeNode[]	De lijst met knooppunten voor deze integratieruntime.
typeProperties.pushedVersion	string	De versie waarnaar de Integration Runtime wordt bijgewerkt.
typeProperties.scheduledUpdateDate	string	De datum waarop de integration runtime wordt gepland om bij te werken, in ISO8601 indeling.
typeProperties.selfContainedInteractiveAuthoringEnabled	boolean	Een alternatieve optie om een interactieve ontwerpfunctie te garanderen wanneer uw zelf-hostende Integration Runtime geen verbinding kan maken met Azure Relay.
typeProperties.serviceUrls	string[]	De URL's voor de services die worden gebruikt in de back-endservice van Integration Runtime.
typeProperties.taskQueueId	string	De taakwachtrij-id van de Integration Runtime.
typeProperties.updateDelayOffset	string	De tijd in de datum die door de service is gepland voor het bijwerken van de integratieruntime, bijvoorbeeld PT03H, is 3 uur
typeProperties.version	string	Versie van de Integration Runtime.
typeProperties.versionStatus	string	Status van de versie van de Integratieruntime.