Edit

Share via

Get-AzDataFactoryV2IntegrationRuntimeMetric

  • Reference
Module:
Az.DataFactory

Gets metric data for an integration runtime.

Syntax

PowerShell 
Get-AzDataFactoryV2IntegrationRuntimeMetric
   [-Name] <String>
   [-ResourceGroupName] <String>
   [-DataFactoryName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
PowerShell 
Get-AzDataFactoryV2IntegrationRuntimeMetric
   [-ResourceId] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
PowerShell 
Get-AzDataFactoryV2IntegrationRuntimeMetric
   [-InputObject] <PSIntegrationRuntime>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzDataFactoryV2IntegrationRuntimeMetric cmdlet gets metric data about integration runtime in a data factory.

Examples

Example 1: Get integration runtime metric

PowerShell 
Get-AzDataFactoryV2IntegrationRuntimeMetric -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir'

IntegrationRuntimeName ResourceGroupName DataFactoryName   Nodes   
---------------------- ----------------- ---------------   -----   
test-selfhost-ir       rg-test-dfv2      test-df-eu2       {Node_1}

This command displays metric data about the integration runtime named 'test-selfhost-ir' in the subscription for the resource group named 'rg-test-dfv2' and data factory named 'test-df-eu2'.

Parameters

-DataFactoryName

The data factory name.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

The integration runtime object.

Type:PSIntegrationRuntime
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The integration runtime name.

Type:String
Aliases:IntegrationRuntimeName
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

The resource group name.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

The Azure resource ID.

Type:String
Aliases:Id
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

Outputs