Update-AzDataFactoryV2IntegrationRuntime
Updates an integration runtime.
Syntax
ByIntegrationRuntimeName (Default)
Update-AzDataFactoryV2IntegrationRuntime
[-Name] <String>
[-ResourceGroupName] <String>
[-DataFactoryName] <String>
[-AutoUpdate <String>]
[-AutoUpdateDelayOffset <TimeSpan>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByResourceId
Update-AzDataFactoryV2IntegrationRuntime
[-ResourceId] <String>
[-AutoUpdate <String>]
[-AutoUpdateDelayOffset <TimeSpan>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByIntegrationRuntimeObject
Update-AzDataFactoryV2IntegrationRuntime
[-InputObject] <PSIntegrationRuntime>
[-AutoUpdate <String>]
[-AutoUpdateDelayOffset <TimeSpan>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Update-AzDataFactoryV2IntegrationRuntime cmdlet updates integration runtime properties. Currently the cmdlet only supports updating 'AutoUpdate' and 'AutoUpdateDelayOffset' for self-hosted integration runtime.
Examples
Example 1: Updates an integration runtime
$ts = New-TimeSpan -Hours 3
Update-AzDataFactoryV2IntegrationRuntime `
-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/factories/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'.
Parameters
-AutoUpdate
Enable or disable the self-hosted integration runtime auto-update.
Parameter properties
Type: String
Default value: None Accepted values: On, Off 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
-AutoUpdateDelayOffset
The time in hour of the day for the self-hosted integration runtime auto-update.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
The integration runtime object.
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: True 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
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
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 .
Outputs
Notes
Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime
