Set-AzSynapseIntegrationRuntime

モジュール:

Az.Synapse

統合ランタイムを更新します。

構文

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

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

型:	SecureString
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-CatalogAdminCredential

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

型:	PSCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-CatalogPricingTier

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-CatalogServerEndpoint

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DataFlowComputeType

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DataFlowCoreCount

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

型:	Nullable<T>[Int32]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DataFlowTimeToLive

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

型:	Nullable<T>[Int32]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DataProxyIntegrationRuntimeName

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DataProxyStagingLinkedServiceName

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DataProxyStagingPath

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

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

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Description

統合ランタイムの説明。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Edition

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

型:	String
指定可能な値:	Standard, Enterprise
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ExpressCustomSetup

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

型:	ArrayList
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Force

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

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

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

型:	PSIntegrationRuntime
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-LicenseType

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

型:	String
指定可能な値:	LicenseIncluded, BasePrice
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Location

統合ランタイムの説明。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-MaxParallelExecutionsPerNode

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

型:	Nullable<T>[Int32]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Name

統合ランタイム名。

型:	String
Aliases:	IntegrationRuntimeName
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-NodeCount

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

型:	Nullable<T>[Int32]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-NodeSize

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PublicIP

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

型:	String[]
Aliases:	PublicIPs
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

リソース グループ名。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceId

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

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SetupScriptContainerSasUri

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SharedIntegrationRuntimeResourceId

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

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Subnet

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

型:	String
Aliases:	SubnetName
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Type

統合ランタイムの種類。

型:	String
指定可能な値:	Managed, SelfHosted
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-VNetId

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

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

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

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WorkspaceName

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

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WorkspaceObject

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

型:	PSSynapseWorkspace
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

入力

PSSynapseWorkspace

PSIntegrationRuntime

出力

PSIntegrationRuntime