Integration Runtimes - Get Monitoring Data
Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData?api-version=2018-06-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
factory
|
path | True |
string |
The factory name. Regex pattern: |
integration
|
path | True |
string |
The integration runtime name. Regex pattern: |
resource
|
path | True |
string |
The resource group name. Regex pattern: |
subscription
|
path | True |
string |
The subscription identifier. |
api-version
|
query | True |
string |
The API version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
An error response received from the Azure Data Factory service. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
IntegrationRuntimes_GetMonitoringData
Sample request
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
Sample response
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
}
]
}
Definitions
Name | Description |
---|---|
Cloud |
The object that defines the structure of an Azure Data Factory error response. |
Integration |
Get monitoring data response. |
Integration |
Monitoring data for integration runtime node. |
CloudError
The object that defines the structure of an Azure Data Factory error response.
Name | Type | Description |
---|---|---|
error.code |
string |
Error code. |
error.details |
Array with additional error details. |
|
error.message |
string |
Error message. |
error.target |
string |
Property name/path in request associated with error. |
IntegrationRuntimeMonitoringData
Get monitoring data response.
Name | Type | Description |
---|---|---|
name |
string |
Integration runtime name. |
nodes |
Integration runtime node monitoring data. |
IntegrationRuntimeNodeMonitoringData
Monitoring data for integration runtime node.
Name | Type | Description |
---|---|---|
availableMemoryInMB |
integer |
Available memory (MB) on the integration runtime node. |
concurrentJobsLimit |
integer |
Maximum concurrent jobs on the integration runtime node. |
concurrentJobsRunning |
integer |
The number of jobs currently running on the integration runtime node. |
cpuUtilization |
integer |
CPU percentage on the integration runtime node. |
maxConcurrentJobs |
integer |
The maximum concurrent jobs in this integration runtime. |
nodeName |
string |
Name of the integration runtime node. |
receivedBytes |
number |
Received bytes on the integration runtime node. |
sentBytes |
number |
Sent bytes on the integration runtime node. |