Integration Runtimes - Get Monitoring Data

Dienst:

Data Factory

API-Version:

2018-06-01

Rufen Sie die Überwachungsdaten der Integration Runtime ab, die die Überwachungsdaten für alle Knoten unter dieser Integration Runtime enthalten.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
factoryName	path	True	string	Der Werksname. RegEx-Muster: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
integrationRuntimeName	path	True	string	Der Name der Integration Runtime. RegEx-Muster: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. RegEx-Muster: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Die API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	IntegrationRuntimeMonitoringData	OK.
Other Status Codes	CloudError	Eine Vom Azure Data Factory-Dienst empfangene Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

IntegrationRuntimes_GetMonitoringData

Beispielanforderung

HTTP

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

Java

/**
 * Samples for IntegrationRuntimes GetMonitoringData.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/
     * IntegrationRuntimes_GetMonitoringData.json
     */
    /**
     * Sample code: IntegrationRuntimes_GetMonitoringData.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void
        integrationRuntimesGetMonitoringData(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.integrationRuntimes().getMonitoringDataWithResponse("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_monitoring_data.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_monitoring_data(
        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_GetMonitoringData.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_GetMonitoringData.json
func ExampleIntegrationRuntimesClient_GetMonitoringData() {
	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().GetMonitoringData(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.IntegrationRuntimeMonitoringData = armdatafactory.IntegrationRuntimeMonitoringData{
	// 	Name: to.Ptr("exampleIntegrationRuntime"),
	// 	Nodes: []*armdatafactory.IntegrationRuntimeNodeMonitoringData{
	// 		{
	// 			AvailableMemoryInMB: to.Ptr[int32](16740),
	// 			ConcurrentJobsLimit: to.Ptr[int32](28),
	// 			ConcurrentJobsRunning: to.Ptr[int32](0),
	// 			CPUUtilization: to.Ptr[int32](15),
	// 			NodeName: to.Ptr("Node_1"),
	// 			ReceivedBytes: to.Ptr[float32](6.731423377990723),
	// 			SentBytes: to.Ptr[float32](2.647491693496704),
	// 	}},
	// }
}

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 Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
 *
 * @summary Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetMonitoringData.json
 */
async function integrationRuntimesGetMonitoringData() {
  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.getMonitoringData(
    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_GetMonitoringData.json
// this example is just showing the usage of "IntegrationRuntimes_GetMonitoringData" 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
IntegrationRuntimeMonitoringData result = await dataFactoryIntegrationRuntime.GetMonitoringDataAsync();

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

Beispiel für eine Antwort

Statuscode:

200

Date: Thu, 14 Jun 2018 15:27:44 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14999
x-ms-request-id: 39277952-edbe-4336-ae94-f6f42b50b5f7
x-ms-correlation-request-id: 39277952-edbe-4336-ae94-f6f42b50b5f7

{
  "name": "exampleIntegrationRuntime",
  "nodes": [
    {
      "nodeName": "Node_1",
      "availableMemoryInMB": 16740,
      "cpuUtilization": 15,
      "concurrentJobsLimit": 28,
      "concurrentJobsRunning": 0,
      "sentBytes": 2.647491693496704,
      "receivedBytes": 6.731423377990723
    }
  ]
}

Definitionen

Name	Beschreibung
CloudError	Das -Objekt, das die Struktur eines Azure Data Factory Fehlerantwort definiert.
IntegrationRuntimeMonitoringData	Rufen Sie die Antwort auf Überwachungsdaten ab.
IntegrationRuntimeNodeMonitoringData	Überwachen von Daten für den Integration Runtime-Knoten.

CloudError

Das -Objekt, das die Struktur eines Azure Data Factory Fehlerantwort definiert.

Name	Typ	Beschreibung
error.code	string	Fehlercode
error.details	CloudError[]	Array mit zusätzlichen Fehlerdetails.
error.message	string	Fehlermeldung.
error.target	string	Eigenschaftsname/Pfad in der Anforderung, die einem Fehler zugeordnet ist.

IntegrationRuntimeMonitoringData

Rufen Sie die Antwort auf Überwachungsdaten ab.

Name	Typ	Beschreibung
name	string	Name der Integration Runtime.
nodes	IntegrationRuntimeNodeMonitoringData[]	Überwachungsdaten des Integration Runtime-Knotens.

IntegrationRuntimeNodeMonitoringData

Überwachen von Daten für den Integration Runtime-Knoten.

Name	Typ	Beschreibung
availableMemoryInMB	integer	Verfügbarer Arbeitsspeicher (MB) auf dem Integration Runtime-Knoten.
concurrentJobsLimit	integer	Maximale Anzahl gleichzeitiger Aufträge auf dem Integration Runtime-Knoten.
concurrentJobsRunning	integer	Die Anzahl der Aufträge, die derzeit auf dem Integration Runtime-Knoten ausgeführt werden.
cpuUtilization	integer	CPU-Prozentsatz auf dem Integration Runtime-Knoten.
maxConcurrentJobs	integer	Die maximale Anzahl gleichzeitiger Aufträge in dieser Integration Runtime.
nodeName	string	Name des Integration Runtime-Knotens.
receivedBytes	number	Empfangene Bytes auf dem Integration Runtime-Knoten.
sentBytes	number	Gesendete Bytes auf dem Integration Runtime-Knoten.