< Back
Get-AzureRmDataFactoryV2IntegrationRuntime
Post
NAME Get-AzureRmDataFactoryV2IntegrationRuntime
SYNOPSIS
Gets information about integration runtime resources.
SYNTAX
Get-AzureRmDataFactoryV2IntegrationRuntime [-ResourceGroupName] <String> [-DataFactoryName] <String> [[-Name] <String>] [-DefaultProfile
<IAzureContextContainer>] [-Status] [<CommonParameters>]
Get-AzureRmDataFactoryV2IntegrationRuntime [-InputObject] <PSIntegrationRuntime> [-DefaultProfile <IAzureContextContainer>] [-Status]
[<CommonParameters>]
Get-AzureRmDataFactoryV2IntegrationRuntime [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-Status] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmDataFactoryV2IntegrationRuntime cmdlet gets information about integration runtimes in a data factory. If you specify the name of an
integration runtime, this cmdlet gets information about that integration runtime. If you do not specify a name, this cmdlet gets information about
all of the integration runtimes in a data factory.
PARAMETERS
-DataFactoryName <String>
The data factory name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSIntegrationRuntime>
The integration runtime object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String>
The integration runtime name.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
The resource group name.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceId <String>
The Azure resource ID.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Status [<SwitchParameter>]
The integration runtime detail status.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime
OUTPUTS
System.Collections.Generic.List`1[[Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime, Microsoft.Azure.Commands.DataFactoryV2,
Version=0.1.9.0, Culture=neutral, PublicKeyToken=null]]
Microsoft.Azure.Commands.DataFactoryV2.Models.PSManagedIntegrationRuntime
Microsoft.Azure.Commands.DataFactoryV2.Models.PSSelfHostedIntegrationRuntime
NOTES
Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime
Example 1: List all integration runtimes in a data factory
PS C:\\> Get-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2
ResourceGroupName DataFactoryName Name Description
----------------- --------------- ---- -----------
rg-test-dfv2 test-df-eu2 test-reserved-ir Reserved IR
rg-test-dfv2 test-df-eu2 test-dedicated-ir Reserved IR
rg-test-dfv2 test-df-eu2 test-selfhost-ir selfhost IR
List all integration runtimes in the data factory named 'test-df-eu2'.
Example 2: Get managed dedicated integration runtime
PS C:\\> Get-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 -Name test-dedicated-ir
Location : West US
NodeSize : Standard_D1_v2
NodeCount : 1
MaxParallelExecutionsPerNode : 1
CatalogServerEndpoint : test.database.windows.net
CatalogAdminUserName : test
CatalogAdminPassword : **********
CatalogPricingTier : S1
VNetId :
Subnet :
State : Starting
ResourceGroupName : rg-test-dfv2
DataFactoryName : test-df-eu2
Name : test-dedicated-ir
Description : Reserved IR
This command displays information about the integration runtime named 'test-dedicated-ir' in the subscription for the resource group named
'rg-test-dfv2' and data factory named 'test-df-eu2'.
Example 3: Get managed dedicated integration runtime with detail status
PS C:\\> Get-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 -Name test-dedicated-ir -Status
CreateTime :
Nodes :
OtherErrors :
LastOperation :
State : Initial
Location : West US
NodeSize : Standard_D1_v2
NodeCount : 1
MaxParallelExecutionsPerNode : 1
CatalogServerEndpoint : test.database.windows.net
CatalogAdminUserName : test
CatalogAdminPassword : **********
CatalogPricingTier : S1
VNetId :
Subnet :
ResourceGroupName : rg-test-dfv2
DataFactoryName : test-df-eu2
Name : test-dedicated-ir
Description : Reserved IR
This command displays information about the integration runtime named 'test-dedicated-ir' in the subscription for the resource group named
'rg-test-dfv2' and data factory named 'test-df-eu2'.
Example 4: Get self-hosted integration runtime
PS C:\\> Get-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 -Name test-selfhost-ir
ResourceGroupName DataFactoryName Name Description
----------------- --------------- ---- -----------
rg-test-dfv2 test-df-eu2 test-selfhost-ir selfhost IR
This command displays information about the integration runtime named 'test-dedicated-ir' in the subscription for the resource group named
'rg-test-dfv2' and data factory named 'test-df-eu2'.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ionruntime
Set-AzureRmDataFactoryV2IntegrationRuntime
Remove-AzureRmDataFactoryV2IntegrationRuntime
SYNOPSIS
Gets information about integration runtime resources.
SYNTAX
Get-AzureRmDataFactoryV2IntegrationRuntime [-ResourceGroupName] <String> [-DataFactoryName] <String> [[-Name] <String>] [-DefaultProfile
<IAzureContextContainer>] [-Status] [<CommonParameters>]
Get-AzureRmDataFactoryV2IntegrationRuntime [-InputObject] <PSIntegrationRuntime> [-DefaultProfile <IAzureContextContainer>] [-Status]
[<CommonParameters>]
Get-AzureRmDataFactoryV2IntegrationRuntime [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>] [-Status] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmDataFactoryV2IntegrationRuntime cmdlet gets information about integration runtimes in a data factory. If you specify the name of an
integration runtime, this cmdlet gets information about that integration runtime. If you do not specify a name, this cmdlet gets information about
all of the integration runtimes in a data factory.
PARAMETERS
-DataFactoryName <String>
The data factory name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSIntegrationRuntime>
The integration runtime object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Name <String>
The integration runtime name.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
The resource group name.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceId <String>
The Azure resource ID.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Status [<SwitchParameter>]
The integration runtime detail status.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime
OUTPUTS
System.Collections.Generic.List`1[[Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime, Microsoft.Azure.Commands.DataFactoryV2,
Version=0.1.9.0, Culture=neutral, PublicKeyToken=null]]
Microsoft.Azure.Commands.DataFactoryV2.Models.PSManagedIntegrationRuntime
Microsoft.Azure.Commands.DataFactoryV2.Models.PSSelfHostedIntegrationRuntime
NOTES
Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime
Example 1: List all integration runtimes in a data factory
PS C:\\> Get-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2
ResourceGroupName DataFactoryName Name Description
----------------- --------------- ---- -----------
rg-test-dfv2 test-df-eu2 test-reserved-ir Reserved IR
rg-test-dfv2 test-df-eu2 test-dedicated-ir Reserved IR
rg-test-dfv2 test-df-eu2 test-selfhost-ir selfhost IR
List all integration runtimes in the data factory named 'test-df-eu2'.
Example 2: Get managed dedicated integration runtime
PS C:\\> Get-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 -Name test-dedicated-ir
Location : West US
NodeSize : Standard_D1_v2
NodeCount : 1
MaxParallelExecutionsPerNode : 1
CatalogServerEndpoint : test.database.windows.net
CatalogAdminUserName : test
CatalogAdminPassword : **********
CatalogPricingTier : S1
VNetId :
Subnet :
State : Starting
ResourceGroupName : rg-test-dfv2
DataFactoryName : test-df-eu2
Name : test-dedicated-ir
Description : Reserved IR
This command displays information about the integration runtime named 'test-dedicated-ir' in the subscription for the resource group named
'rg-test-dfv2' and data factory named 'test-df-eu2'.
Example 3: Get managed dedicated integration runtime with detail status
PS C:\\> Get-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 -Name test-dedicated-ir -Status
CreateTime :
Nodes :
OtherErrors :
LastOperation :
State : Initial
Location : West US
NodeSize : Standard_D1_v2
NodeCount : 1
MaxParallelExecutionsPerNode : 1
CatalogServerEndpoint : test.database.windows.net
CatalogAdminUserName : test
CatalogAdminPassword : **********
CatalogPricingTier : S1
VNetId :
Subnet :
ResourceGroupName : rg-test-dfv2
DataFactoryName : test-df-eu2
Name : test-dedicated-ir
Description : Reserved IR
This command displays information about the integration runtime named 'test-dedicated-ir' in the subscription for the resource group named
'rg-test-dfv2' and data factory named 'test-df-eu2'.
Example 4: Get self-hosted integration runtime
PS C:\\> Get-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 -Name test-selfhost-ir
ResourceGroupName DataFactoryName Name Description
----------------- --------------- ---- -----------
rg-test-dfv2 test-df-eu2 test-selfhost-ir selfhost IR
This command displays information about the integration runtime named 'test-dedicated-ir' in the subscription for the resource group named
'rg-test-dfv2' and data factory named 'test-df-eu2'.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ionruntime
Set-AzureRmDataFactoryV2IntegrationRuntime
Remove-AzureRmDataFactoryV2IntegrationRuntime