Set-AzSynapseIntegrationRuntime

Reference

Module:: Az.Synapse

Updates an integration runtime.

Syntax

Set-AzSynapseIntegrationRuntime
   [-ResourceGroupName <String>]
   -WorkspaceName <String>
   -Name <String>
   [-Type <String>]
   [-Description <String>]
   [-Location <String>]
   [-NodeSize <String>]
   [-NodeCount <Int32>]
   [-CatalogServerEndpoint <String>]
   [-CatalogAdminCredential <PSCredential>]
   [-CatalogPricingTier <String>]
   [-VNetId <String>]
   [-Subnet <String>]
   [-PublicIP <String[]>]
   [-DataFlowComputeType <String>]
   [-DataFlowCoreCount <Int32>]
   [-DataFlowTimeToLive <Int32>]
   [-SetupScriptContainerSasUri <String>]
   [-Edition <String>]
   [-ExpressCustomSetup <ArrayList>]
   [-DataProxyIntegrationRuntimeName <String>]
   [-DataProxyStagingLinkedServiceName <String>]
   [-DataProxyStagingPath <String>]
   [-MaxParallelExecutionsPerNode <Int32>]
   [-LicenseType <String>]
   [-AuthKey <SecureString>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseIntegrationRuntime
   [-ResourceGroupName <String>]
   -WorkspaceName <String>
   -Name <String>
   [-Type <String>]
   [-Description <String>]
   -SharedIntegrationRuntimeResourceId <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseIntegrationRuntime
   -Name <String>
   -WorkspaceObject <PSSynapseWorkspace>
   [-Type <String>]
   [-Description <String>]
   [-Location <String>]
   [-NodeSize <String>]
   [-NodeCount <Int32>]
   [-CatalogServerEndpoint <String>]
   [-CatalogAdminCredential <PSCredential>]
   [-CatalogPricingTier <String>]
   [-VNetId <String>]
   [-Subnet <String>]
   [-PublicIP <String[]>]
   [-DataFlowComputeType <String>]
   [-DataFlowCoreCount <Int32>]
   [-DataFlowTimeToLive <Int32>]
   [-SetupScriptContainerSasUri <String>]
   [-Edition <String>]
   [-ExpressCustomSetup <ArrayList>]
   [-DataProxyIntegrationRuntimeName <String>]
   [-DataProxyStagingLinkedServiceName <String>]
   [-DataProxyStagingPath <String>]
   [-MaxParallelExecutionsPerNode <Int32>]
   [-LicenseType <String>]
   [-AuthKey <SecureString>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseIntegrationRuntime
   -Name <String>
   -WorkspaceObject <PSSynapseWorkspace>
   [-Type <String>]
   [-Description <String>]
   -SharedIntegrationRuntimeResourceId <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseIntegrationRuntime
   -ResourceId <String>
   [-Type <String>]
   [-Description <String>]
   [-Location <String>]
   [-NodeSize <String>]
   [-NodeCount <Int32>]
   [-CatalogServerEndpoint <String>]
   [-CatalogAdminCredential <PSCredential>]
   [-CatalogPricingTier <String>]
   [-VNetId <String>]
   [-Subnet <String>]
   [-PublicIP <String[]>]
   [-DataFlowComputeType <String>]
   [-DataFlowCoreCount <Int32>]
   [-DataFlowTimeToLive <Int32>]
   [-SetupScriptContainerSasUri <String>]
   [-Edition <String>]
   [-ExpressCustomSetup <ArrayList>]
   [-DataProxyIntegrationRuntimeName <String>]
   [-DataProxyStagingLinkedServiceName <String>]
   [-DataProxyStagingPath <String>]
   [-MaxParallelExecutionsPerNode <Int32>]
   [-LicenseType <String>]
   [-AuthKey <SecureString>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseIntegrationRuntime
   -ResourceId <String>
   [-Type <String>]
   [-Description <String>]
   -SharedIntegrationRuntimeResourceId <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseIntegrationRuntime
   -InputObject <PSIntegrationRuntime>
   [-Type <String>]
   [-Description <String>]
   [-Location <String>]
   [-NodeSize <String>]
   [-NodeCount <Int32>]
   [-CatalogServerEndpoint <String>]
   [-CatalogAdminCredential <PSCredential>]
   [-CatalogPricingTier <String>]
   [-VNetId <String>]
   [-Subnet <String>]
   [-PublicIP <String[]>]
   [-DataFlowComputeType <String>]
   [-DataFlowCoreCount <Int32>]
   [-DataFlowTimeToLive <Int32>]
   [-SetupScriptContainerSasUri <String>]
   [-Edition <String>]
   [-ExpressCustomSetup <ArrayList>]
   [-DataProxyIntegrationRuntimeName <String>]
   [-DataProxyStagingLinkedServiceName <String>]
   [-DataProxyStagingPath <String>]
   [-MaxParallelExecutionsPerNode <Int32>]
   [-LicenseType <String>]
   [-AuthKey <SecureString>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseIntegrationRuntime
   -InputObject <PSIntegrationRuntime>
   [-Type <String>]
   [-Description <String>]
   -SharedIntegrationRuntimeResourceId <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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

Examples

Example 1

Set-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -Name 'test-selfhost-ir' -Description 'New description'

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

Example 2

Set-AzSynapseIntegrationRuntime -WorkspaceName ContosoWorkspace -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"

The cmdlet adds the workspace to use the shared integration runtime. When using -SharedIntegrationRuntimeResourceId parameter the -Type must also be included. Note that the workspace 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
Required:	False
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
Required:	False
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
Required:	False
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
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

-DataFlowComputeType

Compute type of the data flow cluster which will execute data flow job.

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

-DataFlowCoreCount

Core count of the data flow cluster which will execute data flow job.

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

-DataFlowTimeToLive

Time to live (in minutes) setting of the data flow cluster which will execute data flow job.

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

-DataProxyIntegrationRuntimeName

The Self-Hosted Integration Runtime name which is used as a proxy.

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

-DataProxyStagingLinkedServiceName

The Azure Blob Storage Linked Service name that references the staging data store to be used when moving data between Self-Hosted and Azure-SSIS Integration Runtime.

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

-DataProxyStagingPath

The path in staging data store to be used when moving data between Self-Hosted and Azure-SSIS Integration Runtimes, a default container will be used if unspecified.

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

-Description

The integration runtime description.

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

-ExpressCustomSetup

The express custom setup for SSIS integration runtime which could be used to setup configurations and 3rd party components without custom setup script.

Type:	ArrayList
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Don't ask for confirmation.

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

-InputObject

The integration runtime object.

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

-Location

The integration runtime description.

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

-MaxParallelExecutionsPerNode

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

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

-Name

The integration runtime name.

Type:	String
Aliases:	IntegrationRuntimeName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NodeCount

Target nodes count of the integration runtime.

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

-NodeSize

The integration runtime node size.

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

-PublicIP

The static public IP addresses which the integration runtime will use.

Type:	String[]
Aliases:	PublicIPs
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Resource group name.

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

-ResourceId

Resource identifier of Synapse integration runtime.

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

-Type

The integration runtime type.

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

-VNetId

The ID of the VNet which the integration runtime will join.

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

-WorkspaceName

Name of Synapse workspace.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Type:	PSSynapseWorkspace
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

PSSynapseWorkspace

PSIntegrationRuntime

Outputs