Integration Runtimes - Get Status

Serviço:

Data Factory

Versão da API:

2018-06-01

Obtém informações detalhadas sobre o estado de um runtime de integração.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
factoryName	path	True	string	O nome da fábrica. Padrão Regex: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
integrationRuntimeName	path	True	string	O nome do runtime de integração. Padrão Regex: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	O nome do grupo de recursos. Padrão Regex: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	O identificador da subscrição.
api-version	query	True	string	A versão da API.

Respostas

Name	Tipo	Description
200 OK	IntegrationRuntimeStatusResponse	OK.
Other Status Codes	CloudError	Uma resposta de erro recebida do serviço Azure Data Factory.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

IntegrationRuntimes_GetStatus

Pedido de amostra

HTTP

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

Java

/**
 * Samples for IntegrationRuntimes GetStatus.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/
     * IntegrationRuntimes_GetStatus.json
     */
    /**
     * Sample code: IntegrationRuntimes_GetStatus.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void integrationRuntimesGetStatus(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.integrationRuntimes().getStatusWithResponse("exampleResourceGroup", "exampleFactoryName",
            "exampleIntegrationRuntime", 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_get_status.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.get_status(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        integration_runtime_name="exampleIntegrationRuntime",
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetStatus.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_GetStatus.json
func ExampleIntegrationRuntimesClient_GetStatus() {
	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().GetStatus(ctx, "exampleResourceGroup", "exampleFactoryName", "exampleIntegrationRuntime", 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.IntegrationRuntimeStatusResponse = armdatafactory.IntegrationRuntimeStatusResponse{
	// 	Name: to.Ptr("exampleIntegrationRuntime"),
	// 	Properties: &armdatafactory.SelfHostedIntegrationRuntimeStatus{
	// 		Type: to.Ptr(armdatafactory.IntegrationRuntimeTypeSelfHosted),
	// 		State: to.Ptr(armdatafactory.IntegrationRuntimeStateOnline),
	// 		TypeProperties: &armdatafactory.SelfHostedIntegrationRuntimeStatusTypeProperties{
	// 			AutoUpdate: to.Ptr(armdatafactory.IntegrationRuntimeAutoUpdateOff),
	// 			Capabilities: map[string]*string{
	// 				"connectedToResourceManager": to.Ptr("True"),
	// 				"credentialInSync": to.Ptr("True"),
	// 				"httpsPortEnabled": to.Ptr("True"),
	// 				"nodeEnabled": to.Ptr("True"),
	// 				"serviceBusConnected": to.Ptr("True"),
	// 			},
	// 			CreateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T09:17:45.183Z"); return t}()),
	// 			LatestVersion: to.Ptr("3.7.6711.1"),
	// 			LocalTimeZoneOffset: to.Ptr("PT8H"),
	// 			Nodes: []*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"),
	// 					},
	// 					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-14T14:52:59.893Z"); 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"),
	// 			}},
	// 			ServiceUrls: []*string{
	// 				to.Ptr("wu.frontend.int.clouddatahub-int.net"),
	// 				to.Ptr("*.servicebus.windows.net")},
	// 				TaskQueueID: to.Ptr("1a6296ab-423c-4346-9bcc-85a78c2c0582"),
	// 				UpdateDelayOffset: to.Ptr("PT3H"),
	// 				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

JavaScript

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

/**
 * This sample demonstrates how to Gets detailed status information for an integration runtime.
 *
 * @summary Gets detailed status information for an integration runtime.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetStatus.json
 */
async function integrationRuntimesGetStatus() {
  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 credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.integrationRuntimes.getStatus(
    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_GetStatus.json
// this example is just showing the usage of "IntegrationRuntimes_GetStatus" 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
DataFactoryIntegrationRuntimeStatusResult result = await dataFactoryIntegrationRuntime.GetStatusAsync();

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

Resposta da amostra

Código de estado:

200

Date: Thu, 14 Jun 2018 14:53:22 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14997
x-ms-request-id: 19efe790-074f-4241-ae94-0422935d0f46
x-ms-correlation-request-id: 19efe790-074f-4241-ae94-0422935d0f46

{
  "name": "exampleIntegrationRuntime",
  "properties": {
    "state": "Online",
    "type": "SelfHosted",
    "typeProperties": {
      "autoUpdate": "Off",
      "taskQueueId": "1a6296ab-423c-4346-9bcc-85a78c2c0582",
      "version": "3.8.6730.2",
      "nodes": [
        {
          "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-14T14:52:59.8933313Z",
          "lastStartTime": "2018-06-14T14:52:59.8933313Z",
          "lastUpdateResult": "None",
          "isActiveDispatcher": true,
          "maxConcurrentJobs": 56
        }
      ],
      "updateDelayOffset": "PT3H",
      "localTimeZoneOffset": "PT8H",
      "serviceUrls": [
        "wu.frontend.int.clouddatahub-int.net",
        "*.servicebus.windows.net"
      ],
      "versionStatus": "UpToDate",
      "capabilities": {
        "serviceBusConnected": "True",
        "httpsPortEnabled": "True",
        "credentialInSync": "True",
        "connectedToResourceManager": "True",
        "nodeEnabled": "True"
      },
      "latestVersion": "3.7.6711.1",
      "createTime": "2018-06-14T09:17:45.1839685Z"
    }
  }
}

Definições

Name	Description
CloudError	O objeto que define a estrutura de uma resposta de erro Azure Data Factory.
IntegrationRuntimeAutoUpdate	O estado da atualização automática do runtime de integração.
IntegrationRuntimeInternalChannelEncryptionMode	É utilizado para definir o modo de encriptação para o canal de comunicação nó-nó (quando existem mais de dois nós de runtime de integração autoalojados).
IntegrationRuntimeState	O estado do runtime de integração.
IntegrationRuntimeStatusResponse	Resposta do estado do runtime de integração.
IntegrationRuntimeType	O tipo de runtime de integração.
IntegrationRuntimeUpdateResult	O resultado da última atualização do nó do runtime de integração.
LinkedIntegrationRuntime	As informações do runtime de integração ligado.
ManagedIntegrationRuntimeError	Definição de erro para o runtime de integração gerido.
ManagedIntegrationRuntimeNode	Propriedades do nó do runtime de integração.
ManagedIntegrationRuntimeNodeStatus	O estado do nó do runtime de integração gerido.
ManagedIntegrationRuntimeOperationResult	Propriedades do resultado da operação de runtime de integração gerida.
ManagedIntegrationRuntimeStatus	Estado do runtime de integração gerido.
SelfHostedIntegrationRuntimeNode	Propriedades do nó runtime de integração autoalojado.
SelfHostedIntegrationRuntimeNodeStatus	Estado do nó do runtime de integração.
SelfHostedIntegrationRuntimeStatus	Estado do runtime de integração autoalojado.

CloudError

O objeto que define a estrutura de uma resposta de erro Azure Data Factory.

Name	Tipo	Description
error.code	string	Código de erro.
error.details	CloudError[]	Matriz com detalhes de erro adicionais.
error.message	string	Mensagem de erro.
error.target	string	Nome/caminho da propriedade no pedido associado ao erro.

IntegrationRuntimeAutoUpdate

O estado da atualização automática do runtime de integração.

Name	Tipo	Description
Off	string
On	string

IntegrationRuntimeInternalChannelEncryptionMode

É utilizado para definir o modo de encriptação para o canal de comunicação nó-nó (quando existem mais de dois nós de runtime de integração autoalojados).

Name	Tipo	Description
NotEncrypted	string
NotSet	string
SslEncrypted	string

IntegrationRuntimeState

O estado do runtime de integração.

Name	Tipo	Description
AccessDenied	string
Initial	string
Limited	string
NeedRegistration	string
Offline	string
Online	string
Started	string
Starting	string
Stopped	string
Stopping	string

IntegrationRuntimeStatusResponse

Resposta do estado do runtime de integração.

Name	Tipo	Description
name	string	O nome do runtime de integração.
properties	IntegrationRuntimeStatus: ManagedIntegrationRuntimeStatus SelfHostedIntegrationRuntimeStatus	Propriedades do runtime de integração.

IntegrationRuntimeType

O tipo de runtime de integração.

Name	Tipo	Description
Managed	string
SelfHosted	string

IntegrationRuntimeUpdateResult

O resultado da última atualização do nó do runtime de integração.

Name	Tipo	Description
Fail	string
None	string
Succeed	string

LinkedIntegrationRuntime

As informações do runtime de integração ligado.

Name	Tipo	Description
createTime	string	O tempo de criação do runtime de integração ligado.
dataFactoryLocation	string	A localização da fábrica de dados à qual pertence o runtime de integração ligado.
dataFactoryName	string	O nome da fábrica de dados à qual pertence o runtime de integração ligado.
name	string	O nome do runtime de integração ligado.
subscriptionId	string	O ID da subscrição ao qual o runtime de integração ligado pertence.

ManagedIntegrationRuntimeError

Definição de erro para o runtime de integração gerido.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro.
parameters	string[]	Parâmetros de erro do runtime de integração gerido.
time	string	A hora em que ocorreu o erro.

ManagedIntegrationRuntimeNode

Propriedades do nó do runtime de integração.

Name	Tipo	Description
errors	ManagedIntegrationRuntimeError[]	Os erros que ocorreram neste nó de runtime de integração.
nodeId	string	O ID do nó do runtime de integração gerido.
status	ManagedIntegrationRuntimeNodeStatus	O estado do nó do runtime de integração gerido.

ManagedIntegrationRuntimeNodeStatus

O estado do nó do runtime de integração gerido.

Name	Tipo	Description
Available	string
Recycling	string
Starting	string
Unavailable	string

ManagedIntegrationRuntimeOperationResult

Propriedades do resultado da operação de runtime de integração gerida.

Name	Tipo	Description
activityId	string	O ID da atividade do pedido de operação.
errorCode	string	O código de erro.
parameters	string[]	Parâmetros de erro do runtime de integração gerido.
result	string	O resultado da operação.
startTime	string	A hora de início da operação.
type	string	O tipo de operação. Pode ser iniciar ou parar.

ManagedIntegrationRuntimeStatus

Estado do runtime de integração gerido.

Name	Tipo	Description
dataFactoryName	string	O nome da fábrica de dados ao qual pertence o runtime de integração.
state	IntegrationRuntimeState	O estado do runtime de integração.
type	string: Managed	Tipo de runtime de integração.
typeProperties.createTime	string	A hora em que o runtime de integração foi criado, no formato ISO8601.
typeProperties.lastOperation	ManagedIntegrationRuntimeOperationResult	O último resultado da operação que ocorreu neste runtime de integração.
typeProperties.nodes	ManagedIntegrationRuntimeNode[]	A lista de nós para o runtime de integração gerido.
typeProperties.otherErrors	ManagedIntegrationRuntimeError[]	Os erros que ocorreram neste runtime de integração.

SelfHostedIntegrationRuntimeNode

Propriedades do nó runtime de integração autoalojado.

Name	Tipo	Description
capabilities	object	O dicionário de capacidades do runtime de integração
concurrentJobsLimit	integer	Máximo de tarefas simultâneas no nó do runtime de integração.
expiryTime	string	O momento em que o runtime de integração irá expirar no formato ISO8601.
hostServiceUri	string	URI para o computador anfitrião do runtime de integração.
isActiveDispatcher	boolean	Indica se este nó é o dispatcher ativo para pedidos de runtime de integração.
lastConnectTime	string	A hora mais recente em que o runtime de integração foi ligado no formato ISO8601.
lastEndUpdateTime	string	A última vez para o fim da atualização do nó do runtime de integração.
lastStartTime	string	A hora em que o nó começou pela última vez.
lastStartUpdateTime	string	A última vez que a atualização do nó do runtime de integração é iniciada.
lastStopTime	string	A hora da última paragem do nó do runtime de integração.
lastUpdateResult	IntegrationRuntimeUpdateResult	O resultado da última atualização do nó do runtime de integração.
machineName	string	Nome do computador do nó do runtime de integração.
maxConcurrentJobs	integer	As tarefas simultâneas máximas neste runtime de integração.
nodeName	string	Nome do nó do runtime de integração.
registerTime	string	O momento em que o nó do runtime de integração foi registado no formato ISO8601.
status	SelfHostedIntegrationRuntimeNodeStatus	Estado do nó do runtime de integração.
version	string	Versão do nó do runtime de integração.
versionStatus	string	Estado da versão do nó do runtime de integração.

SelfHostedIntegrationRuntimeNodeStatus

Estado do nó do runtime de integração.

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

SelfHostedIntegrationRuntimeStatus

Estado do runtime de integração autoalojado.

Name	Tipo	Description
dataFactoryName	string	O nome da fábrica de dados ao qual pertence o runtime de integração.
state	IntegrationRuntimeState	O estado do runtime de integração.
type	string: SelfHosted	Tipo de runtime de integração.
typeProperties.autoUpdate	IntegrationRuntimeAutoUpdate	Se a atualização automática do runtime de integração autoalojado foi ativada.
typeProperties.autoUpdateETA	string	O tempo estimado em que o runtime de integração autoalojado será atualizado.
typeProperties.capabilities	object	Objeto com informações adicionais sobre as capacidades do runtime de integração.
typeProperties.createTime	string	A hora em que o runtime de integração foi criado, no formato ISO8601.
typeProperties.internalChannelEncryption	IntegrationRuntimeInternalChannelEncryptionMode	É utilizado para definir o modo de encriptação para o canal de comunicação nó-nó (quando existem mais de dois nós de runtime de integração autoalojados).
typeProperties.latestVersion	string	A versão mais recente do centro de transferências.
typeProperties.links	LinkedIntegrationRuntime[]	A lista de runtimes de integração ligados que são criados para partilhar com este runtime de integração.
typeProperties.localTimeZoneOffset	string	O desvio do fuso horário local em horas.
typeProperties.nodes	SelfHostedIntegrationRuntimeNode[]	A lista de nós para este runtime de integração.
typeProperties.pushedVersion	string	A versão para a qual o runtime de integração vai ser atualizado.
typeProperties.scheduledUpdateDate	string	A data em que o runtime de integração será agendado para atualização, no formato ISO8601.
typeProperties.selfContainedInteractiveAuthoringEnabled	boolean	Uma opção alternativa para garantir a função de criação interativa quando o runtime de integração autoalojado não consegue estabelecer uma ligação com o Azure Relay.
typeProperties.serviceUrls	string[]	Os URLs dos serviços utilizados no serviço de back-end do runtime de integração.
typeProperties.taskQueueId	string	O ID da fila de tarefas do runtime de integração.
typeProperties.updateDelayOffset	string	A hora na data agendada pelo serviço para atualizar o runtime de integração, por exemplo, PT03H é de 3 horas
typeProperties.version	string	Versão do runtime de integração.
typeProperties.versionStatus	string	Estado da versão do runtime de integração.