你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Set-AzSynapseIntegrationRuntime

更新集成运行时。

语法

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>]

说明

Set-AzSynapseIntegrationRuntime cmdlet 使用特定参数更新集成运行时。

示例

示例 1

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

该 cmdlet 更新名为“test-selfhost-ir”的集成运行时的说明。

示例 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"

该 cmdlet 将添加工作区以使用共享集成运行时。 使用 -SharedIntegrationRuntimeResourceId 参数 -Type 时,还必须包含该参数。 请注意,在运行 cmdlet 之前,需要向工作区授予使用集成运行时的权限。

参数

-AuthKey

自承载集成运行时的身份验证密钥。

类型:SecureString
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-CatalogAdminCredential

集成运行时的目录数据库管理员凭据。

类型:PSCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-CatalogPricingTier

集成运行时的目录数据库定价层。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-CatalogServerEndpoint

集成运行时的目录数据库服务器终结点。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DataFlowComputeType

将执行数据流作业的数据流群集的计算类型。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DataFlowCoreCount

将执行数据流作业的数据流群集的核心计数。

类型:Nullable<T>[Int32]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DataFlowTimeToLive

数据流群集的生存时间(以分钟为单位)设置,该群集将执行数据流作业。

类型:Nullable<T>[Int32]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DataProxyIntegrationRuntimeName

用作代理的自承载集成运行时名称。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DataProxyStagingLinkedServiceName

Azure Blob 存储链接服务名称,该名称引用在自承载和 Azure-SSIS Integration Runtime 之间移动数据时要使用的暂存数据存储。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DataProxyStagingPath

在自承载运行时和 Azure-SSIS Integration Runtime 之间移动数据时要使用的暂存数据存储中的路径,如果未指定,将使用默认容器。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:IAzureContextContainer
别名:AzContext, AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Description

集成运行时说明。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Edition

SSIS 集成运行时(可以是标准或企业版)的版本,如果未指定,则默认值为 Standard。

类型:String
接受的值:Standard, Enterprise
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ExpressCustomSetup

SSIS 集成运行时的快速自定义设置,可用于在没有自定义安装脚本的情况下设置配置和第三方组件。

类型:ArrayList
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Force

不要要求确认。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-InputObject

集成运行时对象。

类型:PSIntegrationRuntime
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-LicenseType

要为 SSIS IR 选择的许可证类型。 有两种类型:LicenseIncluded 或 BasePrice。 如果有资格获得 Azure 混合使用权益(AHUB)定价,请选择 BasePrice。 如果没有,请选择 LicenseIncluded。

类型:String
接受的值:LicenseIncluded, BasePrice
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Location

集成运行时说明。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-MaxParallelExecutionsPerNode

托管专用集成运行时每个节点的最大并行执行计数。

类型:Nullable<T>[Int32]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Name

集成运行时名称。

类型:String
别名:IntegrationRuntimeName
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-NodeCount

集成运行时的目标节点计数。

类型:Nullable<T>[Int32]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-NodeSize

集成运行时节点大小。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-PublicIP

集成运行时将使用的静态公共 IP 地址。

类型:String[]
别名:PublicIPs
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ResourceGroupName

资源组名称。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ResourceId

Synapse 集成运行时的资源标识符。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-SetupScriptContainerSasUri

包含自定义安装脚本的 Azure Blob 容器的 SAS URI。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-SharedIntegrationRuntimeResourceId

共享自承载集成运行时的资源 ID。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-Subnet

VNet 中子网的名称。

类型:String
别名:SubnetName
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Type

集成运行时类型。

类型:String
接受的值:Managed, SelfHosted
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-VNetId

集成运行时将加入的 VNet 的 ID。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-WorkspaceName

Synapse 工作区的名称。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-WorkspaceObject

工作区输入对象,通常通过管道传递。

类型:PSSynapseWorkspace
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

输入

PSSynapseWorkspace

PSIntegrationRuntime

输出

PSIntegrationRuntime