Edit

Share via

Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade

Module:
Az.DataFactory Module

Upgrades self-hosted integration runtime.

Syntax

ByIntegrationRuntimeName (Default) 

Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade
    [-Name] <String>
    [-ResourceGroupName] <String>
    [-DataFactoryName] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByResourceId 

Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade
    [-ResourceId] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIntegrationRuntimeObject 

Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade
    [-InputObject] <PSIntegrationRuntime>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade cmdlet upgrades self-hosted integration runtime if the new version is available.

Examples

Example 1: Upgrades a self-hosted integration runtime

Invoke-AzDataFactoryV2IntegrationRuntimeUpgrade -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir'

The cmdlet upgrades self-hosted integration runtime named 'test-selfhost-ir' in data factory 'test-df-eu2'.

Parameters

-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

-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: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.

Inputs

String

PSIntegrationRuntime

Outputs

Void

Notes

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