Set-AzureRmDataFactoryV2IntegrationRuntime

Updates an integration runtime.

Syntax

Set-AzureRmDataFactoryV2IntegrationRuntime
   [-Type <String>]
   [-Description <String>]
   [-Location <String>]
   [-NodeSize <String>]
   [-NodeCount <Int32>]
   [-CatalogServerEndpoint <String>]
   [-CatalogAdminCredential <PSCredential>]
   [-CatalogPricingTier <String>]
   [-VNetId <String>]
   [-Subnet <String>]
   [-MaxParallelExecutionsPerNode <Int32>]
   [-Force]
   [-Name] <String>
   [-ResourceGroupName] <String>
   [-DataFactoryName] <String>
   [-WhatIf]
   [-Confirm]
Set-AzureRmDataFactoryV2IntegrationRuntime
   [-Type <String>]
   [-Description <String>]
   [-Location <String>]
   [-NodeSize <String>]
   [-NodeCount <Int32>]
   [-CatalogServerEndpoint <String>]
   [-CatalogAdminCredential <PSCredential>]
   [-CatalogPricingTier <String>]
   [-VNetId <String>]
   [-Subnet <String>]
   [-MaxParallelExecutionsPerNode <Int32>]
   [-Force]
   [-ResourceId] <String>
   [-WhatIf]
   [-Confirm]
Set-AzureRmDataFactoryV2IntegrationRuntime
   [-Type <String>]
   [-Description <String>]
   [-Location <String>]
   [-NodeSize <String>]
   [-NodeCount <Int32>]
   [-CatalogServerEndpoint <String>]
   [-CatalogAdminCredential <PSCredential>]
   [-CatalogPricingTier <String>]
   [-VNetId <String>]
   [-Subnet <String>]
   [-MaxParallelExecutionsPerNode <Int32>]
   [-Force]
   [-InputObject] <PSIntegrationRuntime>
   [-WhatIf]
   [-Confirm]

Description

The Set-AzureRmDataFactoryV2IntegrationRuntime cmdlet updates an integration runtime with specific parameters.

Examples

Example 1: Update integration runtime description.

PS C:\> Set-AzureRmDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' `
                                            -Description 'New description'

    Id                : /subscriptions/b3ee3a7f-7614-4644-ad07-afa832620b4b/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir
    ResourceGroupName : rg-test-dfv2
    DataFactoryName   : test-df-eu2
    Name              : test-selfhost-ir
    Description       : New description

The cmdlet updates the description of integration runtime named 'test-selfhost-ir'.

Required Parameters

-DataFactoryName

The data factory name.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-InputObject

The integration runtime object.

Type:PSIntegrationRuntime
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

The integration runtime name.

Type:String
Aliases:IntegrationRuntimeName
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

The resource group name.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceId

The Azure resource ID.

Type:String
Aliases:Id
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-CatalogAdminCredential

The catalog database administrator credential of the integration runtime.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CatalogPricingTier

The catalog database pricing tier of the integration runtime.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CatalogServerEndpoint

The catalog database server endpoint of the integration runtime.

Type:String
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-Description

The integration runtime description.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Runs the cmdlet without prompting for confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Location

The integration runtime location.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MaxParallelExecutionsPerNode

Maximum parallel execution count per node for a managed dedicated integration runtime.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NodeCount

Target nodes count of the integration runtime.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NodeSize

The integration runtime node size.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Subnet

The name of the subnet in the VNet.

Type:String
Aliases:SubnetName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Type

The integration runtime type.

Type:String
Parameter Sets:Managed, SelfHosted
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VNetId

The ID of the VNet that the integration runtime joins.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what happens if the cmdlet runs, but doesn't run the cmdlet.

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

Inputs

System.String

Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime

Outputs

Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime