Set-AzSynapseIntegrationRuntime
Updates an integration runtime.
Syntax
SetByIntegrationRuntimeName (Default)
Set-AzSynapseIntegrationRuntime
-WorkspaceName <String>
-Name <String>
[-ResourceGroupName <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>]
[-ManagedVNetCopyComputeScaleDataIntegrationUnit <Int32>]
[-ManagedVNetCopyComputeScaleTimeToLive <Int32>]
[-ManagedVNetPipelineExternalComputeScaleTimeToLive <Int32>]
[-ManagedVNetNumberOfPipelineNodeCount <Int32>]
[-ManagedVNetNumberOfExternalNodeCount <Int32>]
[-SelfContainedInteractiveAuthoringEnabled]
[-SetupScriptContainerSasUri <String>]
[-Edition <String>]
[-ExpressCustomSetup <ArrayList>]
[-DataProxyIntegrationRuntimeName <String>]
[-DataProxyStagingLinkedServiceName <String>]
[-DataProxyStagingPath <String>]
[-MaxParallelExecutionsPerNode <Int32>]
[-LicenseType <String>]
[-AuthKey <SecureString>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByLinkedIntegrationRuntimeName
Set-AzSynapseIntegrationRuntime
-WorkspaceName <String>
-Name <String>
-SharedIntegrationRuntimeResourceId <String>
[-ResourceGroupName <String>]
[-Type <String>]
[-Description <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByParentObject
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>]
[-ManagedVNetCopyComputeScaleDataIntegrationUnit <Int32>]
[-ManagedVNetCopyComputeScaleTimeToLive <Int32>]
[-ManagedVNetPipelineExternalComputeScaleTimeToLive <Int32>]
[-ManagedVNetNumberOfPipelineNodeCount <Int32>]
[-ManagedVNetNumberOfExternalNodeCount <Int32>]
[-SelfContainedInteractiveAuthoringEnabled]
[-SetupScriptContainerSasUri <String>]
[-Edition <String>]
[-ExpressCustomSetup <ArrayList>]
[-DataProxyIntegrationRuntimeName <String>]
[-DataProxyStagingLinkedServiceName <String>]
[-DataProxyStagingPath <String>]
[-MaxParallelExecutionsPerNode <Int32>]
[-LicenseType <String>]
[-AuthKey <SecureString>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByLinkedIntegrationRuntimeParentObject
Set-AzSynapseIntegrationRuntime
-Name <String>
-WorkspaceObject <PSSynapseWorkspace>
-SharedIntegrationRuntimeResourceId <String>
[-Type <String>]
[-Description <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByResourceId
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>]
[-ManagedVNetCopyComputeScaleDataIntegrationUnit <Int32>]
[-ManagedVNetCopyComputeScaleTimeToLive <Int32>]
[-ManagedVNetPipelineExternalComputeScaleTimeToLive <Int32>]
[-ManagedVNetNumberOfPipelineNodeCount <Int32>]
[-ManagedVNetNumberOfExternalNodeCount <Int32>]
[-SelfContainedInteractiveAuthoringEnabled]
[-SetupScriptContainerSasUri <String>]
[-Edition <String>]
[-ExpressCustomSetup <ArrayList>]
[-DataProxyIntegrationRuntimeName <String>]
[-DataProxyStagingLinkedServiceName <String>]
[-DataProxyStagingPath <String>]
[-MaxParallelExecutionsPerNode <Int32>]
[-LicenseType <String>]
[-AuthKey <SecureString>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByLinkedIntegrationRuntimeResourceId
Set-AzSynapseIntegrationRuntime
-ResourceId <String>
-SharedIntegrationRuntimeResourceId <String>
[-Type <String>]
[-Description <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByIntegrationRuntimeObject
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>]
SetByLinkedIntegrationRuntimeObject
Set-AzSynapseIntegrationRuntime
-InputObject <PSIntegrationRuntime>
-SharedIntegrationRuntimeResourceId <String>
[-Type <String>]
[-Description <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.
Parameter properties
Type: SecureString
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CatalogAdminCredential
The catalog database administrator credential of the integration runtime.
Parameter properties
Type: PSCredential
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CatalogPricingTier
The catalog database pricing tier of the integration runtime.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CatalogServerEndpoint
The catalog database server endpoint of the integration runtime.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
-DataFlowComputeType
Compute type of the data flow cluster which will execute data flow job.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DataFlowCoreCount
Core count of the data flow cluster which will execute data flow job.
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DataFlowTimeToLive
Time to live (in minutes) setting of the data flow cluster which will execute data flow job.
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DataProxyIntegrationRuntimeName
The Self-Hosted Integration Runtime name which is used as a proxy.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False 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
-Description
The integration runtime description.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Edition
The edition for SSIS integration runtime which could be Standard or Enterprise, default is Standard if it is not specified.
Parameter properties
Type: String
Default value: None Accepted values: Standard, Enterprise Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: ArrayList
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Force
Don't ask for confirmation.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
The integration runtime object.
SetByIntegrationRuntimeObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
SetByLinkedIntegrationRuntimeObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: String
Default value: None Accepted values: LicenseIncluded, BasePrice Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
The integration runtime description.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedVNetCopyComputeScaleDataIntegrationUnit
DIU number setting reserved for copy activity execution.
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedVNetCopyComputeScaleTimeToLive
Time to live (in minutes) setting of integration runtime which will execute copy activity.
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedVNetNumberOfExternalNodeCount
Number of the the external nodes, which should be greater than 0 and less than 11.
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedVNetNumberOfPipelineNodeCount
Number of the pipeline nodes, which should be greater than 0 and less than 11.
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedVNetPipelineExternalComputeScaleTimeToLive
Time to live (in minutes) setting of integration runtime which will execute pipeline and external activity.
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MaxParallelExecutionsPerNode
Maximum parallel execution count per node for a managed dedicated integration runtime.
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False 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
SetByIntegrationRuntimeName
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByLinkedIntegrationRuntimeName
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByLinkedIntegrationRuntimeParentObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NodeCount
Target nodes count of the integration runtime.
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NodeSize
The integration runtime node size.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PublicIP
The static public IP addresses which the integration runtime will use.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False Aliases: PublicIPs
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
Resource group name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByLinkedIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceId
Resource identifier of Synapse integration runtime.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByResourceId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByLinkedIntegrationRuntimeResourceId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SelfContainedInteractiveAuthoringEnabled
An alternative option to ensure interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SetupScriptContainerSasUri
The SAS URI of the Azure blob container that contains the custom setup script.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SharedIntegrationRuntimeResourceId
The resource id of the shared self-hosted integration runtime.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByLinkedIntegrationRuntimeName
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByLinkedIntegrationRuntimeParentObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByLinkedIntegrationRuntimeResourceId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByLinkedIntegrationRuntimeObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Subnet
The name of the subnet in the VNet.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: SubnetName
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Type
The integration runtime type.
Parameter properties
Type: String
Default value: None Accepted values: Managed, SelfHosted Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-VNetId
The ID of the VNet which the integration runtime will join.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByIntegrationRuntimeObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False 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
-WorkspaceName
Name of Synapse workspace.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SetByIntegrationRuntimeName
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SetByLinkedIntegrationRuntimeName
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WorkspaceObject
workspace input object, usually passed through the pipeline.
Parameter properties
Parameter sets
SetByParentObject
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
SetByLinkedIntegrationRuntimeParentObject
Position: Named Mandatory: True Value from pipeline: True 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 .
Outputs
