Integration Runtimes - Start

Tjänst:

Data Factory

API-version:

2018-06-01

Startar en ManagedReserved-typintegreringskörning.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Fabriksnamnet.
integrationRuntimeName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Namnet på integrationskörningen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Resursgruppens namn.
subscriptionId	path	True	string	Prenumerationsidentifieraren.
api-version	query	True	string	API-versionen.

Svar

Name	Typ	Description
200 OK	IntegrationRuntimeStatusResponse	OKEJ.
202 Accepted		Accepterad.
Other Status Codes	CloudError	Ett felsvar som togs emot från Azure Data Factory-tjänsten.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

IntegrationRuntimes_Start

Exempelbegäran

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

Exempelsvar

Statuskod:

202

Statuskod:

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

Definitioner

Name	Description
CloudError	Objektet som definierar strukturen för ett Azure Data Factory-felsvar.
IntegrationRuntimeAutoUpdate	Tillståndet för automatisk uppdatering av integration runtime.
IntegrationRuntimeInternalChannelEncryptionMode	Det används för att ange krypteringsläget för nodnodens kommunikationskanal (när det finns fler än 2 lokalt installerade integrationskörningsnoder).
IntegrationRuntimeState	Tillståndet för integrationskörning.
IntegrationRuntimeStatusResponse	Statussvar för integrationskörning.
IntegrationRuntimeType	Typ av integrationskörning.
IntegrationRuntimeUpdateResult	Resultatet av den senaste uppdateringen av integrationskörningsnoden.
LinkedIntegrationRuntime	Den länkade integrationskörningsinformationen.
ManagedIntegrationRuntimeError	Feldefinition för hanterad integrationskörning.
ManagedIntegrationRuntimeNode	Egenskaper för integreringskörningsnod.
ManagedIntegrationRuntimeNodeStatus	Status för den hanterade integreringskörningsnoden.
ManagedIntegrationRuntimeOperationResult	Egenskaper för resultatet av den hanterade integrationskörningen.
ManagedIntegrationRuntimeStatus	Status för hanterad integrationskörning.
SelfHostedIntegrationRuntimeNode	Egenskaper för lokalt installerad integrationskörningsnod.
SelfHostedIntegrationRuntimeNodeStatus	Status för integreringskörningsnoden.
SelfHostedIntegrationRuntimeStatus	Status för lokalt installerad integrationskörning.

CloudError

Objekt

Objektet som definierar strukturen för ett Azure Data Factory-felsvar.

Name	Typ	Description
error.code	string	Felkod.
error.details	CloudError[]	Matris med ytterligare felinformation.
error.message	string	Felmeddelande.
error.target	string	Egenskapsnamn/sökväg i begäran som är associerad med fel.

IntegrationRuntimeAutoUpdate

Uppräkning

Tillståndet för automatisk uppdatering av integration runtime.

Värde	Description
Off
On

IntegrationRuntimeInternalChannelEncryptionMode

Uppräkning

Det används för att ange krypteringsläget för nodnodens kommunikationskanal (när det finns fler än 2 lokalt installerade integrationskörningsnoder).

Värde	Description
NotEncrypted
NotSet
SslEncrypted

IntegrationRuntimeState

Uppräkning

Tillståndet för integrationskörning.

Värde	Description
AccessDenied
Initial
Limited
NeedRegistration
Offline
Online
Started
Starting
Stopped
Stopping

IntegrationRuntimeStatusResponse

Objekt

Statussvar för integrationskörning.

Name	Typ	Description
name	string	Namnet på integrationskörningen.
properties	IntegrationRuntimeStatus: ManagedIntegrationRuntimeStatus SelfHostedIntegrationRuntimeStatus	Egenskaper för integrationskörning.

IntegrationRuntimeType

Uppräkning

Typ av integrationskörning.

Värde	Description
Managed
SelfHosted

IntegrationRuntimeUpdateResult

Uppräkning

Resultatet av den senaste uppdateringen av integrationskörningsnoden.

Värde	Description
Fail
None
Succeed

LinkedIntegrationRuntime

Objekt

Den länkade integrationskörningsinformationen.

Name	Typ	Description
createTime	string (date-time)	Skapandetiden för den länkade integrationskörningen.
dataFactoryLocation	string	Platsen för datafabriken som den länkade integrationskörningen tillhör.
dataFactoryName	string	Namnet på datafabriken som den länkade integrationskörningen tillhör.
name	string	Namnet på den länkade integrationskörningen.
subscriptionId	string	Prenumerations-ID som den länkade integrationskörningen tillhör.

ManagedIntegrationRuntimeError

Objekt

Feldefinition för hanterad integrationskörning.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande.
parameters	string[]	Felparametrar för hanterad integrationskörning.
time	string (date-time)	Den tid då felet inträffade.

ManagedIntegrationRuntimeNode

Objekt

Egenskaper för integreringskörningsnod.

Name	Typ	Description
errors	ManagedIntegrationRuntimeError[]	Felen som inträffade på den här integrationskörningsnoden.
nodeId	string	Nod-ID:t för den hanterade integreringskörningen.
status	ManagedIntegrationRuntimeNodeStatus	Status för den hanterade integreringskörningsnoden.

ManagedIntegrationRuntimeNodeStatus

Uppräkning

Status för den hanterade integreringskörningsnoden.

Värde	Description
Available
Recycling
Starting
Unavailable

ManagedIntegrationRuntimeOperationResult

Objekt

Egenskaper för resultatet av den hanterade integrationskörningen.

Name	Typ	Description
activityId	string	Aktivitets-ID för åtgärdsbegäran.
errorCode	string	Felkoden.
parameters	string[]	Felparametrar för hanterad integrationskörning.
result	string	Åtgärdsresultatet.
startTime	string (date-time)	Starttiden för åtgärden.
type	string	Åtgärdstypen. Kan vara start eller stopp.

ManagedIntegrationRuntimeStatus

Objekt

Status för hanterad integrationskörning.

Name	Typ	Description
dataFactoryName	string	Namnet på datafabriken som integrationskörningen tillhör.
state	IntegrationRuntimeState	Tillståndet för integrationskörning.
type	string: Managed	Typ av integrationskörning.
typeProperties.createTime	string (date-time)	Tidpunkten då integreringskörningen skapades i ISO8601 format.
typeProperties.lastOperation	ManagedIntegrationRuntimeOperationResult	Det senaste åtgärdsresultatet som inträffade på den här integreringskörningen.
typeProperties.nodes	ManagedIntegrationRuntimeNode[]	Listan över noder för hanterad integreringskörning.
typeProperties.otherErrors	ManagedIntegrationRuntimeError[]	De fel som inträffade på den här integrationskörningen.

SelfHostedIntegrationRuntimeNode

Objekt

Egenskaper för lokalt installerad integrationskörningsnod.

Name	Typ	Description
capabilities	object	Ordlistan för integreringskörningsfunktioner
concurrentJobsLimit	integer	Maximalt antal samtidiga jobb på integrationskörningsnoden.
expiryTime	string (date-time)	Tiden då integreringskörningen upphör att gälla i ISO8601 format.
hostServiceUri	string	URI för värddatorn för integrationskörningen.
isActiveDispatcher	boolean	Anger om den här noden är aktiv dispatcher för integreringskörningsbegäranden.
lastConnectTime	string (date-time)	Den senaste gången integreringskörningen var ansluten i ISO8601 format.
lastEndUpdateTime	string (date-time)	Sista gången för integreringskörningens noduppdateringsslut.
lastStartTime	string (date-time)	Den tid då noden senast startades.
lastStartUpdateTime	string (date-time)	Senaste gången för uppdateringen av integrationskörningsnoden startar.
lastStopTime	string (date-time)	Den senaste stopptiden för integrationskörningsnoden.
lastUpdateResult	IntegrationRuntimeUpdateResult	Resultatet av den senaste uppdateringen av integrationskörningsnoden.
machineName	string	Datornamn för integreringskörningsnoden.
maxConcurrentJobs	integer	Maximalt antal samtidiga jobb i den här integreringskörningen.
nodeName	string	Namnet på integreringskörningsnoden.
registerTime	string (date-time)	Tidpunkten då integreringskörningsnoden registrerades i ISO8601 format.
status	SelfHostedIntegrationRuntimeNodeStatus	Status för integreringskörningsnoden.
version	string	Version av integreringskörningsnoden.
versionStatus	string	Status för integreringskörningsnodversionen.

SelfHostedIntegrationRuntimeNodeStatus

Uppräkning

Status för integreringskörningsnoden.

Värde	Description
InitializeFailed
Initializing
Limited
NeedRegistration
Offline
Online
Upgrading

SelfHostedIntegrationRuntimeStatus

Objekt

Status för lokalt installerad integrationskörning.

Name	Typ	Description
dataFactoryName	string	Namnet på datafabriken som integrationskörningen tillhör.
state	IntegrationRuntimeState	Tillståndet för integrationskörning.
type	string: SelfHosted	Typ av integrationskörning.
typeProperties.autoUpdate	IntegrationRuntimeAutoUpdate	Om automatisk uppdatering av lokalt installerad integrationskörning har aktiverats.
typeProperties.autoUpdateETA	string (date-time)	Den uppskattade tiden då den lokalt installerade integrationskörningen uppdateras.
typeProperties.capabilities	object	Objekt med ytterligare information om integreringskörningsfunktioner.
typeProperties.createTime	string (date-time)	Tidpunkten då integreringskörningen skapades i ISO8601 format.
typeProperties.internalChannelEncryption	IntegrationRuntimeInternalChannelEncryptionMode	Det används för att ange krypteringsläget för nodnodens kommunikationskanal (när det finns fler än 2 lokalt installerade integrationskörningsnoder).
typeProperties.latestVersion	string	Den senaste versionen på Download Center.
typeProperties.links	LinkedIntegrationRuntime[]	Listan över länkade integrationskörningar som skapas för att dela med den här integreringskörningen.
typeProperties.localTimeZoneOffset	string	Den lokala tidszonsförskjutningen i timmar.
typeProperties.nodes	SelfHostedIntegrationRuntimeNode[]	Listan över noder för den här integreringskörningen.
typeProperties.pushedVersion	string	Den version som integreringskörningen ska uppdateras till.
typeProperties.scheduledUpdateDate	string (date-time)	Det datum då integreringskörningen schemaläggs att uppdateras i ISO8601 format.
typeProperties.selfContainedInteractiveAuthoringEnabled	boolean	Ett alternativt alternativ för att säkerställa interaktiv redigeringsfunktion när din lokala integrationskörning inte kan upprätta en anslutning till Azure Relay.
typeProperties.serviceUrls	string[]	URL:er för de tjänster som används i serverdelstjänsten för integrationskörning.
typeProperties.taskQueueId	string	Aktivitetskö-ID:t för integrationskörningen.
typeProperties.updateDelayOffset	string	Tiden i det datum som schemaläggs av tjänsten för att uppdatera integrationskörningen, t.ex. PT03H är 3 timmar
typeProperties.version	string	Version av integrationskörningen.
typeProperties.versionStatus	string	Status för integreringskörningsversionen.