Update-AzDataFactoryV2IntegrationRuntime

Module:

Az.DataFactory

Updates an integration runtime.

Syntax

Update-AzDataFactoryV2IntegrationRuntime
      [-AutoUpdate <String>]
      [-AutoUpdateDelayOffset <TimeSpan>]
      [-Name] <String>
      [-ResourceGroupName] <String>
      [-DataFactoryName] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzDataFactoryV2IntegrationRuntime
      [-AutoUpdate <String>]
      [-AutoUpdateDelayOffset <TimeSpan>]
      [-ResourceId] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzDataFactoryV2IntegrationRuntime
      [-AutoUpdate <String>]
      [-AutoUpdateDelayOffset <TimeSpan>]
      [-InputObject] <PSIntegrationRuntime>
      [-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.

Type:	String
Accepted values:	On, Off
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AutoUpdateDelayOffset

The time in hour of the day for the self-hosted integration runtime auto-update.

Type:	Nullable<T>[TimeSpan]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

PSIntegrationRuntime

Outputs

PSSelfHostedIntegrationRuntimeStatus

Notes

Keywords: azure, azurerm, arm, resource, management, manager, data, factories, copy, activities, integration runtime