Set-AzDataFactoryV2IntegrationRuntime

Updates an integration runtime.

Syntax

Set-AzDataFactoryV2IntegrationRuntime
   [-ResourceGroupName] <String>
   [-DataFactoryName] <String>
   [-Name] <String>
   [-Type <String>]
   [-Description <String>]
   [-Location <String>]
   [-NodeSize <String>]
   [-NodeCount <Int32>]
   [-CatalogServerEndpoint <String>]
   [-CatalogAdminCredential <PSCredential>]
   [-CatalogPricingTier <String>]
   [-VNetId <String>]
   [-Subnet <String>]
   [-SetupScriptContainerSasUri <String>]
   [-Edition <String>]
   [-MaxParallelExecutionsPerNode <Int32>]
   [-LicenseType <String>]
   [-AuthKey <SecureString>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDataFactoryV2IntegrationRuntime
   [-ResourceId] <String>
   [-Type <String>]
   [-Description <String>]
   [-Location <String>]
   [-NodeSize <String>]
   [-NodeCount <Int32>]
   [-CatalogServerEndpoint <String>]
   [-CatalogAdminCredential <PSCredential>]
   [-CatalogPricingTier <String>]
   [-VNetId <String>]
   [-Subnet <String>]
   [-SetupScriptContainerSasUri <String>]
   [-Edition <String>]
   [-MaxParallelExecutionsPerNode <Int32>]
   [-LicenseType <String>]
   [-AuthKey <SecureString>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDataFactoryV2IntegrationRuntime
   [-ResourceId] <String>
   [-Type <String>]
   [-Description <String>]
   -SharedIntegrationRuntimeResourceId <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDataFactoryV2IntegrationRuntime
   [-ResourceGroupName] <String>
   [-DataFactoryName] <String>
   [-Name] <String>
   [-Type <String>]
   [-Description <String>]
   -SharedIntegrationRuntimeResourceId <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDataFactoryV2IntegrationRuntime
   [-InputObject] <PSIntegrationRuntime>
   [-Type <String>]
   [-Description <String>]
   [-Location <String>]
   [-NodeSize <String>]
   [-NodeCount <Int32>]
   [-CatalogServerEndpoint <String>]
   [-CatalogAdminCredential <PSCredential>]
   [-CatalogPricingTier <String>]
   [-VNetId <String>]
   [-Subnet <String>]
   [-SetupScriptContainerSasUri <String>]
   [-Edition <String>]
   [-MaxParallelExecutionsPerNode <Int32>]
   [-LicenseType <String>]
   [-AuthKey <SecureString>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzDataFactoryV2IntegrationRuntime
   [-InputObject] <PSIntegrationRuntime>
   [-Type <String>]
   [-Description <String>]
   -SharedIntegrationRuntimeResourceId <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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

Examples

Example 1: Update integration runtime description.

PS C:\> Set-AzDataFactoryV2IntegrationRuntime -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'.

Example 2: Share Self-hosted integration runtime.

PS C:\> Set-AzDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' `
                                            -SharedIntegrationRuntimeResourceId '/subscriptions/b3ee3a7f-7614-4644-ad07-afa832620b4b/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir' -Type "SelfHosted"

    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 adds the ADF to use the shared integration runtime. When using -SharedIntegrationRuntimeResourceId parameter the -Type must also be included. Note that the data factory need to be granted permission to use the integration runtime before running cmdlet.

Parameters

-AuthKey

The authentication key of the self-hosted integration runtime.

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

The data factory name.

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

The credentials, account, tenant, and subscription used for communication with azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
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
-Edition

The edition for SSIS integration runtime which could be Standard or Enterprise, default is Standard if it is not specified.

Type:String
Accepted values:Standard, Enterprise
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
-InputObject

The integration runtime object.

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

The license type that you want to select for the SSIS IR. There are two types: LicenseIncluded or BasePrice. If you are qualified for the Azure Hybrid Use Benefit (AHUB) pricing, please select BasePrice. If not, please select LicenseIncluded.

Type:String
Accepted values:LicenseIncluded, BasePrice
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:System.Nullable`1[System.Int32]
Position:Named
Default value:None
Accept pipeline input:False
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
-NodeCount

Target nodes count of the integration runtime.

Type:System.Nullable`1[System.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
-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
-SetupScriptContainerSasUri

The SAS URI of the Azure blob container that contains the custom setup script.

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

The resource id of the shared self-hosted integration runtime.

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
Accepted values: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

String

PSIntegrationRuntime

Outputs

PSIntegrationRuntime