Get-AzDataFactoryV2IntegrationRuntime
Gets information about integration runtime resources.
Syntax
ByIntegrationRuntimeName (Default)
Get-AzDataFactoryV2IntegrationRuntime
[[-Name] <String>]
[-ResourceGroupName] <String>
[-DataFactoryName] <String>
[-Status]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByResourceId
Get-AzDataFactoryV2IntegrationRuntime
[-ResourceId] <String>
[-Status]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByIntegrationRuntimeObject
Get-AzDataFactoryV2IntegrationRuntime
[-InputObject] <PSIntegrationRuntime>
[-Status]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzDataFactoryV2IntegrationRuntime 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.
Examples
Example 1: List all integration runtimes in a data factory
Get-AzDataFactoryV2IntegrationRuntime -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
Get-AzDataFactoryV2IntegrationRuntime -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 :
SubnetId :
VNetInjectionMethod : Express
PublicIPs :
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
Get-AzDataFactoryV2IntegrationRuntime -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 :
SubnetId :
VNetInjectionMethod : Standard
PublicIPs :
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
Get-AzDataFactoryV2IntegrationRuntime -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'.
Example 5: Get self-hosted integration runtime with detail status
Get-AzDataFactoryV2IntegrationRuntime -ResourceGroupName rg-test-dfv2 -DataFactoryName test-df-eu2 -Name test-selfhost-ir -Status
State : Online
Version : 4.2.7233.1
CreateTime : 9/26/2019 6:00:08 AM
AutoUpdate : Off
ScheduledUpdateDate :
UpdateDelayOffset : 03:00:00
LocalTimeZoneOffset : 08:00:00
InternalChannelEncryption :
Capabilities : {[serviceBusConnected, True], [httpsPortEnabled, True], [credentialInSync, True], [connectedToResourceManager, True]...}
ServiceUrls : {}
Nodes : {}
Links : {}
AutoUpdateETA :
LatestVersion : 4.3.7265.1
PushedVersion : 4.3.7265.1
TaskQueueId : fe2d60b5-86f5-58bf-bdae-7ef698284088
VersionStatus : UpdateAvailable
Name : test-selfhost-ir
Type : SelfHosted
ResourceGroupName : rg-test-dfv2
DataFactoryName : test-df-eu2
Description :
Id : /subscriptions/41fcbc45-c594-4152-a8f1-fcbcd6452aea/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir
Parameters
-DataFactoryName
The data factory name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByIntegrationRuntimeName
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
The integration runtime object.
Parameter properties
| Type: | PSIntegrationRuntime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByIntegrationRuntimeObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The integration runtime name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | IntegrationRuntimeName |
Parameter sets
ByIntegrationRuntimeName
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceGroupName
The resource group name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByIntegrationRuntimeName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResourceId
The Azure resource ID.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Id |
Parameter sets
ByResourceId
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Status
The integration runtime detail status.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
String
PSIntegrationRuntime
Outputs
PSIntegrationRuntime
PSManagedIntegrationRuntime
PSSelfHostedIntegrationRuntime
PSLinkedIntegrationRuntime
Notes
Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime
