< Back
Set-AzureRmDataFactoryV2IntegrationRuntime
Post
NAME Set-AzureRmDataFactoryV2IntegrationRuntime
SYNOPSIS
Updates an integration runtime.
SYNTAX
Set-AzureRmDataFactoryV2IntegrationRuntime [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [-AuthKey <SecureString>]
[-CatalogAdminCredential <PSCredential>] [-CatalogPricingTier <String>] [-CatalogServerEndpoint <String>] [-DefaultProfile
<IAzureContextContainer>] [-Description <String>] [-Edition {Standard | Enterprise}] [-Force] [-LicenseType {LicenseIncluded | BasePrice}]
[-Location <String>] [-MaxParallelExecutionsPerNode <Int32>] [-NodeCount <Int32>] [-NodeSize <String>] [-SetupScriptContainerSasUri <String>]
[-Subnet <String>] [-Type {Managed | SelfHosted}] [-VNetId <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmDataFactoryV2IntegrationRuntime [-InputObject] <PSIntegrationRuntime> [-AuthKey <SecureString>] [-CatalogAdminCredential
<PSCredential>] [-CatalogPricingTier <String>] [-CatalogServerEndpoint <String>] [-DefaultProfile <IAzureContextContainer>] [-Description
<String>] [-Edition {Standard | Enterprise}] [-Force] [-LicenseType {LicenseIncluded | BasePrice}] [-Location <String>]
[-MaxParallelExecutionsPerNode <Int32>] [-NodeCount <Int32>] [-NodeSize <String>] [-SetupScriptContainerSasUri <String>] [-Subnet <String>] [-Type
{Managed | SelfHosted}] [-VNetId <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmDataFactoryV2IntegrationRuntime [-ResourceId] <String> [-AuthKey <SecureString>] [-CatalogAdminCredential <PSCredential>]
[-CatalogPricingTier <String>] [-CatalogServerEndpoint <String>] [-DefaultProfile <IAzureContextContainer>] [-Description <String>] [-Edition
{Standard | Enterprise}] [-Force] [-LicenseType {LicenseIncluded | BasePrice}] [-Location <String>] [-MaxParallelExecutionsPerNode <Int32>]
[-NodeCount <Int32>] [-NodeSize <String>] [-SetupScriptContainerSasUri <String>] [-Subnet <String>] [-Type {Managed | SelfHosted}] [-VNetId
<String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmDataFactoryV2IntegrationRuntime cmdlet updates an integration runtime with specific parameters.
PARAMETERS
-AuthKey <SecureString>
The authentication key of the self-hosted integration runtime.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CatalogAdminCredential <PSCredential>
The catalog database administrator credential of the integration runtime.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CatalogPricingTier <String>
The catalog database pricing tier of the integration runtime.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CatalogServerEndpoint <String>
The catalog database server endpoint of the integration runtime.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DataFactoryName <String>
The data factory name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
The integration runtime description.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Edition <String>
The edition for SSIS integration runtime which could be Standard or Enterprise, default is Standard if it is not specified.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Runs the cmdlet without prompting for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSIntegrationRuntime>
The integration runtime object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-LicenseType <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Location <String>
The integration runtime location.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MaxParallelExecutionsPerNode <Int32>
Maximum parallel execution count per node for a managed dedicated integration runtime.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
The integration runtime name.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NodeCount <Int32>
Target nodes count of the integration runtime.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-NodeSize <String>
The integration runtime node size.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
The resource group name.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceId <String>
The Azure resource ID.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SetupScriptContainerSasUri <String>
The SAS URI of the Azure blob container that contains the custom setup script.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Subnet <String>
The name of the subnet in the VNet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Type <String>
The integration runtime type.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VNetId <String>
The ID of the VNet that the integration runtime joins.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what happens if the cmdlet runs, but doesn't run the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime
OUTPUTS
Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime
NOTES
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/t
est-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'.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ionruntime
Set-AzureRmDataFactoryV2IntegrationRuntime
SYNOPSIS
Updates an integration runtime.
SYNTAX
Set-AzureRmDataFactoryV2IntegrationRuntime [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [-AuthKey <SecureString>]
[-CatalogAdminCredential <PSCredential>] [-CatalogPricingTier <String>] [-CatalogServerEndpoint <String>] [-DefaultProfile
<IAzureContextContainer>] [-Description <String>] [-Edition {Standard | Enterprise}] [-Force] [-LicenseType {LicenseIncluded | BasePrice}]
[-Location <String>] [-MaxParallelExecutionsPerNode <Int32>] [-NodeCount <Int32>] [-NodeSize <String>] [-SetupScriptContainerSasUri <String>]
[-Subnet <String>] [-Type {Managed | SelfHosted}] [-VNetId <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmDataFactoryV2IntegrationRuntime [-InputObject] <PSIntegrationRuntime> [-AuthKey <SecureString>] [-CatalogAdminCredential
<PSCredential>] [-CatalogPricingTier <String>] [-CatalogServerEndpoint <String>] [-DefaultProfile <IAzureContextContainer>] [-Description
<String>] [-Edition {Standard | Enterprise}] [-Force] [-LicenseType {LicenseIncluded | BasePrice}] [-Location <String>]
[-MaxParallelExecutionsPerNode <Int32>] [-NodeCount <Int32>] [-NodeSize <String>] [-SetupScriptContainerSasUri <String>] [-Subnet <String>] [-Type
{Managed | SelfHosted}] [-VNetId <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-AzureRmDataFactoryV2IntegrationRuntime [-ResourceId] <String> [-AuthKey <SecureString>] [-CatalogAdminCredential <PSCredential>]
[-CatalogPricingTier <String>] [-CatalogServerEndpoint <String>] [-DefaultProfile <IAzureContextContainer>] [-Description <String>] [-Edition
{Standard | Enterprise}] [-Force] [-LicenseType {LicenseIncluded | BasePrice}] [-Location <String>] [-MaxParallelExecutionsPerNode <Int32>]
[-NodeCount <Int32>] [-NodeSize <String>] [-SetupScriptContainerSasUri <String>] [-Subnet <String>] [-Type {Managed | SelfHosted}] [-VNetId
<String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmDataFactoryV2IntegrationRuntime cmdlet updates an integration runtime with specific parameters.
PARAMETERS
-AuthKey <SecureString>
The authentication key of the self-hosted integration runtime.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CatalogAdminCredential <PSCredential>
The catalog database administrator credential of the integration runtime.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CatalogPricingTier <String>
The catalog database pricing tier of the integration runtime.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CatalogServerEndpoint <String>
The catalog database server endpoint of the integration runtime.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DataFactoryName <String>
The data factory name.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
The integration runtime description.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Edition <String>
The edition for SSIS integration runtime which could be Standard or Enterprise, default is Standard if it is not specified.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Runs the cmdlet without prompting for confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSIntegrationRuntime>
The integration runtime object.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-LicenseType <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Location <String>
The integration runtime location.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MaxParallelExecutionsPerNode <Int32>
Maximum parallel execution count per node for a managed dedicated integration runtime.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
The integration runtime name.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NodeCount <Int32>
Target nodes count of the integration runtime.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-NodeSize <String>
The integration runtime node size.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
The resource group name.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceId <String>
The Azure resource ID.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SetupScriptContainerSasUri <String>
The SAS URI of the Azure blob container that contains the custom setup script.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Subnet <String>
The name of the subnet in the VNet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Type <String>
The integration runtime type.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VNetId <String>
The ID of the VNet that the integration runtime joins.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what happens if the cmdlet runs, but doesn't run the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime
OUTPUTS
Microsoft.Azure.Commands.DataFactoryV2.Models.PSIntegrationRuntime
NOTES
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/t
est-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'.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ionruntime
Set-AzureRmDataFactoryV2IntegrationRuntime