Set-AzDataFactoryV2IntegrationRuntime

リファレンス

モジュール:: Az.DataFactory

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

構文

Set-AzDataFactoryV2IntegrationRuntime
   [-ResourceGroupName] <String>
   [-DataFactoryName] <String>
   [-Name] <String>
   [-Type <String>]
   [-Description <String>]
   [-Location <String>]
   [-NodeSize <String>]
   [-NodeCount <Int32>]
   [-CatalogServerEndpoint <String>]
   [-CatalogAdminCredential <PSCredential>]
   [-CatalogPricingTier <String>]
   [-VNetId <String>]
   [-Subnet <String>]
   [-SubnetId <String>]
   [-PublicIPs <String[]>]
   [-DataFlowComputeType <String>]
   [-DataFlowEnableQuickReuse]
   [-DataFlowCoreCount <Int32>]
   [-DataFlowTimeToLive <Int32>]
   [-ManagedVNetCopyComputeScaleDataIntegrationUnit <Int32>]
   [-ManagedVNetCopyComputeScaleTimeToLive <Int32>]
   [-ManagedVNetPipelineExternalComputeScaleTimeToLive <Int32>]
   [-ManagedVNetNumberOfPipelineNodeCount <Int32>]
   [-ManagedVNetNumberOfExternalNodeCount <Int32>]
   [-SelfContainedInteractiveAuthoringEnabled]
   [-SetupScriptContainerSasUri <String>]
   [-Edition <String>]
   [-VNetInjectionMethod <String>]
   [-ExpressCustomSetup <ArrayList>]
   [-DataProxyIntegrationRuntimeName <String>]
   [-DataProxyStagingLinkedServiceName <String>]
   [-DataProxyStagingPath <String>]
   [-MaxParallelExecutionsPerNode <Int32>]
   [-LicenseType <String>]
   [-AuthKey <SecureString>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzDataFactoryV2IntegrationRuntime
   [-ResourceId] <String>
   [-Type <String>]
   [-Description <String>]
   [-Location <String>]
   [-NodeSize <String>]
   [-NodeCount <Int32>]
   [-CatalogServerEndpoint <String>]
   [-CatalogAdminCredential <PSCredential>]
   [-CatalogPricingTier <String>]
   [-VNetId <String>]
   [-Subnet <String>]
   [-SubnetId <String>]
   [-PublicIPs <String[]>]
   [-DataFlowComputeType <String>]
   [-DataFlowEnableQuickReuse]
   [-DataFlowCoreCount <Int32>]
   [-DataFlowTimeToLive <Int32>]
   [-ManagedVNetCopyComputeScaleDataIntegrationUnit <Int32>]
   [-ManagedVNetCopyComputeScaleTimeToLive <Int32>]
   [-ManagedVNetPipelineExternalComputeScaleTimeToLive <Int32>]
   [-ManagedVNetNumberOfPipelineNodeCount <Int32>]
   [-ManagedVNetNumberOfExternalNodeCount <Int32>]
   [-SelfContainedInteractiveAuthoringEnabled]
   [-SetupScriptContainerSasUri <String>]
   [-Edition <String>]
   [-VNetInjectionMethod <String>]
   [-ExpressCustomSetup <ArrayList>]
   [-DataProxyIntegrationRuntimeName <String>]
   [-DataProxyStagingLinkedServiceName <String>]
   [-DataProxyStagingPath <String>]
   [-MaxParallelExecutionsPerNode <Int32>]
   [-LicenseType <String>]
   [-AuthKey <SecureString>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

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

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

Set-AzDataFactoryV2IntegrationRuntime
   [-InputObject] <PSIntegrationRuntime>
   [-Type <String>]
   [-Description <String>]
   [-Location <String>]
   [-NodeSize <String>]
   [-NodeCount <Int32>]
   [-CatalogServerEndpoint <String>]
   [-CatalogAdminCredential <PSCredential>]
   [-CatalogPricingTier <String>]
   [-VNetId <String>]
   [-Subnet <String>]
   [-SubnetId <String>]
   [-PublicIPs <String[]>]
   [-DataFlowComputeType <String>]
   [-DataFlowEnableQuickReuse]
   [-DataFlowCoreCount <Int32>]
   [-DataFlowTimeToLive <Int32>]
   [-ManagedVNetCopyComputeScaleDataIntegrationUnit <Int32>]
   [-ManagedVNetCopyComputeScaleTimeToLive <Int32>]
   [-ManagedVNetPipelineExternalComputeScaleTimeToLive <Int32>]
   [-ManagedVNetNumberOfPipelineNodeCount <Int32>]
   [-ManagedVNetNumberOfExternalNodeCount <Int32>]
   [-SelfContainedInteractiveAuthoringEnabled]
   [-SetupScriptContainerSasUri <String>]
   [-Edition <String>]
   [-VNetInjectionMethod <String>]
   [-ExpressCustomSetup <ArrayList>]
   [-DataProxyIntegrationRuntimeName <String>]
   [-DataProxyStagingLinkedServiceName <String>]
   [-DataProxyStagingPath <String>]
   [-MaxParallelExecutionsPerNode <Int32>]
   [-LicenseType <String>]
   [-AuthKey <SecureString>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

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

説明

Set-AzDataFactoryV2IntegrationRuntime コマンドレットは、特定のパラメーターを使用して統合ランタイムを更新します。

例

例 1: 統合ランタイムの説明を更新します。

Set-AzDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -Name 'test-selfhost-ir' `
                                            -Description 'New description'

Id                : /subscriptions/b3ee3a7f-7614-4644-ad07-afa832620b4b/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir
    ResourceGroupName : rg-test-dfv2
    DataFactoryName   : test-df-eu2
    Name              : test-selfhost-ir
    Description       : New description

コマンドレットは、"test-selfhost-ir" という名前の統合ランタイムの説明を更新します。

例 2: セルフホステッド統合ランタイムを共有する。

Set-AzDataFactoryV2IntegrationRuntime -ResourceGroupName 'rg-test-dfv2' -DataFactoryName 'test-df-eu2' -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"

Id                : /subscriptions/b3ee3a7f-7614-4644-ad07-afa832620b4b/resourceGroups/rg-test-dfv2/providers/Microsoft.DataFactory/factories/test-df-eu2/integrationruntimes/test-selfhost-ir
    ResourceGroupName : rg-test-dfv2
    DataFactoryName   : test-df-eu2
    Name              : test-selfhost-ir
    Description       : New description

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

例 3: ADF で Azure-SSIS IR のプロキシとしてセルフホステッド IR を構成する。

Set-AzDataFactoryV2IntegrationRuntime -ResourceGroupName testgroup `
                                           -DataFactoryName testdf `
                                           -Name SSISIRWithDataProxy `
                                           -DataProxyIntegrationRuntimeName proxySelfhostedIR `
                                           -DataProxyStagingLinkedServiceName AzureBlobStorage `
                                           -DataProxyStagingPath teststaging

Location                          : EastUS
    NodeSize                          : Standard_D8_v3
    NodeCount                         : 1
    MaxParallelExecutionsPerNode      : 8
    CatalogServerEndpoint             : 
    CatalogAdminUserName              : 
    CatalogAdminPassword              : 
    CatalogPricingTier                : 
    VNetId                            : 
    Subnet                            : 
    SubnetId                          : 
    VNetInjectionMethod               : Express
    PublicIPs                         : 
    State                             : Initial
    LicenseType                       : LicenseIncluded
    SetupScriptContainerSasUri        : 
    DataProxyIntegrationRuntimeName   : proxySelfhostedIR
    DataProxyStagingLinkedServiceName : AzureBlobStorage
    DataProxyStagingPath              : 
    Edition                           : Standard
    Name                              : SSISIRWithDataProxy
    Type                              : Managed
    ResourceGroupName                 : testgroup
    DataFactoryName                   : testdf
    Description                       : 
    Id                                : /subscriptions/cb715d05-3337-4640-8c43-4f943c50d06e/resourceGroups/testgroup/providers/Microsoft.DataFactory/factories/testdf/integrationruntimes/SSISIRWithDataProxy

このコマンドレットは、セルフホステッド統合ランタイムをデータプロキシとして使用するように Azure-SSIS 統合ランタイムを更新します。

パラメーター

-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

-DataFactoryName

データファクトリ名。

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

-DataFlowComputeType

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

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

-DataFlowCoreCount

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

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

-DataFlowEnableQuickReuse

次のデータフローアクティビティでデータフロークラスターを再利用できるかどうかを指定します。

型:	SwitchParameter
配置:	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
配置:	0
規定値:	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

-ManagedVNetCopyComputeScaleDataIntegrationUnit

コピーアクティビティの実行用に予約されている DIU 番号の設定。

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

-ManagedVNetCopyComputeScaleTimeToLive

コピーアクティビティを実行する統合ランタイムの Time to Live (分単位) 設定。

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

-ManagedVNetNumberOfExternalNodeCount

外部ノードの数。0 より大きく、11 未満である必要があります。

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

-ManagedVNetNumberOfPipelineNodeCount

パイプラインノードの数。0 より大きく、11 未満である必要があります。

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

-ManagedVNetPipelineExternalComputeScaleTimeToLive

パイプラインと外部アクティビティを実行する統合ランタイムの有効期間 (分単位) 設定。

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

-MaxParallelExecutionsPerNode

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

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

-Name

統合ランタイム名。

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

-NodeCount

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

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

-NodeSize

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

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

-PublicIPs

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

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

-ResourceGroupName

リソースグループ名。

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

-ResourceId

Azure リソース ID。

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

-SelfContainedInteractiveAuthoringEnabled

セルフホステッド統合ランタイムが Azure Relay との接続を確立できない場合に、対話型の作成機能を確保する別のオプション。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	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

-SubnetId

この Azure-SSIS 統合ランタイムが参加するサブネットの ID。

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

-Type

統合ランタイムの種類。

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

-VNetId

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

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

-VNetInjectionMethod