< Back
Update-AzureRmDataFactoryV2IntegrationRuntime
Post
NAME Update-AzureRmDataFactoryV2IntegrationRuntime
SYNOPSIS
Updates an integration runtime.
SYNTAX
Update-AzureRmDataFactoryV2IntegrationRuntime [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [-AutoUpdate {On | Off}]
[-AutoUpdateDelayOffset <TimeSpan>] [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Update-AzureRmDataFactoryV2IntegrationRuntime [-InputObject] <PSIntegrationRuntime> [-AutoUpdate {On | Off}] [-AutoUpdateDelayOffset <TimeSpan>]
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Update-AzureRmDataFactoryV2IntegrationRuntime [-ResourceId] <String> [-AutoUpdate {On | Off}] [-AutoUpdateDelayOffset <TimeSpan>] [-DefaultProfile
<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Update-AzureRmDataFactoryV2IntegrationRuntime cmdlet updates integration runtime properties. Currently the cmdlet only supports updating
'AutoUpdate' and 'AutoUpdateDelayOffset' for self-hosted integration runtime.
PARAMETERS
-AutoUpdate <String>
Enable or disable the self-hosted integration runtime auto-update.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-AutoUpdateDelayOffset <TimeSpan>
The time in hour of the day for the self-hosted integration runtime auto-update.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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? true
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
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
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
Microsoft.Azure.Commands.DataFactoryV2.Models.PSSelfHostedIntegrationRuntimeStatus
NOTES
Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime
Example 1: Updates an integration runtime
PS C:\\> $ts = New-TimeSpan -Hours 3
PS C:\\> Update-AzureRmDataFactoryV2IntegrationRuntime `
-ResourceGroupName 'rg-test-dfv2' `
-DataFactoryName 'test-df-eu2' `
-Name 'test-selfhost-ir' `
-AutoUpdate Off `
-AutoUpdateDelayOffset $ts
Nodes : {Node_1}
CreateTime : 11/18/2017 2:45:38 PM
InternalChannelEncryption :
Version : 3.2.6519.3
Capabilities : {[serviceBusConnected, True], [httpsPortEnabled, True], [credentialInSync, True], [connectedToResourceManager,
True]...}
ScheduledUpdateDate :
UpdateDelayOffset :
LocalTimeZoneOffset :
AutoUpdate : Off
ServiceUrls : {wu.frontend.int.clouddatahub-int.net, *.servicebus.windows.net}
State : Online
Id : /subscriptions/41fcbc45-c594-4152-a8f1-fcbcd6452aea/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factori
es/test-df-eu2/integrationruntimes/test-selfhost-ir
Type : SelfHosted
ResourceGroupName : rg-test-dfv2
DataFactoryName : test-df-eu2
Name : test-selfhost-ir
Description : New 2 description
The cmdlet updates self-hosted integration runtime named 'test-selfhost-ir'.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ionruntime
Set-AzureRmDataFactoryV2IntegrationRuntime
Get-AzureRmDataFactoryV2IntegrationRuntime
SYNOPSIS
Updates an integration runtime.
SYNTAX
Update-AzureRmDataFactoryV2IntegrationRuntime [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [-AutoUpdate {On | Off}]
[-AutoUpdateDelayOffset <TimeSpan>] [-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Update-AzureRmDataFactoryV2IntegrationRuntime [-InputObject] <PSIntegrationRuntime> [-AutoUpdate {On | Off}] [-AutoUpdateDelayOffset <TimeSpan>]
[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
Update-AzureRmDataFactoryV2IntegrationRuntime [-ResourceId] <String> [-AutoUpdate {On | Off}] [-AutoUpdateDelayOffset <TimeSpan>] [-DefaultProfile
<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Update-AzureRmDataFactoryV2IntegrationRuntime cmdlet updates integration runtime properties. Currently the cmdlet only supports updating
'AutoUpdate' and 'AutoUpdateDelayOffset' for self-hosted integration runtime.
PARAMETERS
-AutoUpdate <String>
Enable or disable the self-hosted integration runtime auto-update.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-AutoUpdateDelayOffset <TimeSpan>
The time in hour of the day for the self-hosted integration runtime auto-update.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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? true
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
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
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
Microsoft.Azure.Commands.DataFactoryV2.Models.PSSelfHostedIntegrationRuntimeStatus
NOTES
Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime
Example 1: Updates an integration runtime
PS C:\\> $ts = New-TimeSpan -Hours 3
PS C:\\> Update-AzureRmDataFactoryV2IntegrationRuntime `
-ResourceGroupName 'rg-test-dfv2' `
-DataFactoryName 'test-df-eu2' `
-Name 'test-selfhost-ir' `
-AutoUpdate Off `
-AutoUpdateDelayOffset $ts
Nodes : {Node_1}
CreateTime : 11/18/2017 2:45:38 PM
InternalChannelEncryption :
Version : 3.2.6519.3
Capabilities : {[serviceBusConnected, True], [httpsPortEnabled, True], [credentialInSync, True], [connectedToResourceManager,
True]...}
ScheduledUpdateDate :
UpdateDelayOffset :
LocalTimeZoneOffset :
AutoUpdate : Off
ServiceUrls : {wu.frontend.int.clouddatahub-int.net, *.servicebus.windows.net}
State : Online
Id : /subscriptions/41fcbc45-c594-4152-a8f1-fcbcd6452aea/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factori
es/test-df-eu2/integrationruntimes/test-selfhost-ir
Type : SelfHosted
ResourceGroupName : rg-test-dfv2
DataFactoryName : test-df-eu2
Name : test-selfhost-ir
Description : New 2 description
The cmdlet updates self-hosted integration runtime named 'test-selfhost-ir'.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ionruntime
Set-AzureRmDataFactoryV2IntegrationRuntime
Get-AzureRmDataFactoryV2IntegrationRuntime