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 コマンドレットは、特定のパラメーターを使用して統合ランタイムを更新します。

例 1

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

コマンドレットは、"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"

コマンドレットは、共有統合ランタイムを使用するワークスペースを追加します。 パラメーターを使用 -SharedIntegrationRuntimeResourceId する場合は、 -Type このパラメーターも含まれている必要があります。 コマンドレットを実行する前に、統合ランタイムを使用するためのアクセス許可をワークスペースに付与する必要があることに注意してください。

パラメーター

-AuthKey

セルフホステッド統合ランタイムの認証キー。

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

-CatalogAdminCredential

統合ランタイムのカタログ データベース管理者の資格情報。

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

-CatalogPricingTier

統合ランタイムのカタログ データベース価格レベル。

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

-CatalogServerEndpoint

統合ランタイムのカタログ データベース サーバー エンドポイント。

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-DataFlowComputeType

データ フロー ジョブを実行するデータ フロー クラスターのコンピューティングの種類。

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

-DataFlowCoreCount

データ フロー ジョブを実行するデータ フロー クラスターのコア数。

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

-DataFlowTimeToLive

データ フロー ジョブを実行するデータ フロー クラスターの Time to Live (分単位) 設定。

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

-DataProxyIntegrationRuntimeName

プロキシとして使用されるセルフホステッド統合ランタイム名。

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

-DataProxyStagingLinkedServiceName

セルフホステッドと Azure-SSIS 統合ランタイムの間でデータを移動するときに使用するステージング データ ストアを参照する Azure Blob Storage のリンクされたサービス名。

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

-DataProxyStagingPath

セルフホステッドと Azure-SSIS 統合ランタイムの間でデータを移動するときに使用するステージング データ ストア内のパス。指定されていない場合は、既定のコンテナーが使用されます。

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

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

統合ランタイムの説明。

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

-Edition

SSIS 統合ランタイムのエディション (Standard または Enterprise の場合があります)、既定値は Standard (指定されていない場合) です。

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

-ExpressCustomSetup

カスタム セットアップ スクリプトなしで構成とサード パーティ製コンポーネントをセットアップするために使用できる、SSIS 統合ランタイムの高速カスタム セットアップ。

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

-Force

確認を求めないでください。

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

-InputObject

統合ランタイム オブジェクト。

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

-LicenseType

SSIS IR に対して選択するライセンスの種類。 LicenseIncluded と BasePrice の 2 種類があります。 Azure ハイブリッド使用特典 (AHUB) の価格の対象となる場合は、BasePrice を選択してください。 そうでない場合は、LicenseIncluded を選択してください。

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

-Location

統合ランタイムの説明。

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

-MaxParallelExecutionsPerNode

マネージド専用統合ランタイムのノードあたりの並列実行の最大数。

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

-Name

統合ランタイム名。

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

-NodeCount

統合ランタイムのターゲット ノード数。

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

-NodeSize

統合ランタイム ノードのサイズ。

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

-PublicIP

統合ランタイムが使用する静的パブリック IP アドレス。

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

-ResourceGroupName

リソース グループ名。

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

-ResourceId

Synapse 統合ランタイムのリソース識別子。

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

-SetupScriptContainerSasUri

カスタム セットアップ スクリプトを含む Azure BLOB コンテナーの SAS URI。

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

-SharedIntegrationRuntimeResourceId

共有セルフホステッド統合ランタイムのリソース ID。

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

-Subnet

VNet 内のサブネットの名前。

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

-Type

統合ランタイムの種類。

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

-VNetId

統合ランタイムが参加する VNet の ID。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

-WorkspaceName

Synapse ワークスペースの名前。

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

-WorkspaceObject

ワークスペース入力オブジェクト。通常はパイプラインを介して渡されます。

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

入力

PSSynapseWorkspace

PSIntegrationRuntime

出力

PSIntegrationRuntime