次の方法で共有

Microsoft.Synapse ワークスペース/統合ランタイム 2021-06-01-preview

Bicep リソース定義

ワークスペース/integrationRuntimes リソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Synapse/workspaces/integrationRuntimes リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    type: 'string'
    // For remaining properties, see IntegrationRuntime objects
  }
}

IntegrationRuntime オブジェクト

型 プロパティを設定して、オブジェクトの型を指定します。

マネージドの場合は、次を使用します。

{
  managedVirtualNetwork: {
    id: 'string'
    referenceName: 'string'
    type: 'string'
  }
  type: 'Managed'
  typeProperties: {
    computeProperties: {
      copyComputeScaleProperties: {
        dataIntegrationUnit: int
        timeToLive: int
      }
      dataFlowProperties: {
        cleanup: bool
        computeType: 'string'
        coreCount: int
        timeToLive: int
      }
      location: 'string'
      maxParallelExecutionsPerNode: int
      nodeSize: 'string'
      numberOfNodes: int
      pipelineExternalComputeScaleProperties: {
        numberOfExternalNodes: int
        numberOfPipelineNodes: int
        timeToLive: int
      }
      vNetProperties: {
        publicIPs: [
          'string'
        ]
        subnet: 'string'
        subnetId: 'string'
        vNetId: 'string'
      }
    }
    ssisProperties: {
      catalogInfo: {
        catalogAdminPassword: {
          type: 'string'
          value: 'string'
        }
        catalogAdminUserName: 'string'
        catalogPricingTier: 'string'
        catalogServerEndpoint: 'string'
      }
      customSetupScriptProperties: {
        blobContainerUri: 'string'
        sasToken: {
          type: 'string'
          value: 'string'
        }
      }
      dataProxyProperties: {
        connectVia: {
          referenceName: 'string'
          type: 'string'
        }
        path: 'string'
        stagingLinkedService: {
          referenceName: 'string'
          type: 'string'
        }
      }
      edition: 'string'
      expressCustomSetupProperties: [
        {
          type: 'string'
          // For remaining properties, see CustomSetupBase objects
        }
      ]
      licenseType: 'string'
    }
  }
}

SelfHosted の場合は、次を使用します。

{
  type: 'SelfHosted'
  typeProperties: {
    linkedInfo: {
      authorizationType: 'string'
      // For remaining properties, see LinkedIntegrationRuntimeType objects
    }
    selfContainedInteractiveAuthoringEnabled: bool
  }
}

CustomSetupBase オブジェクト

型 プロパティを設定して、オブジェクトの型を指定します。

CmdkeySetup の場合は、次のコマンドを使用します。

{
  type: 'CmdkeySetup'
  typeProperties: {
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    targetName: any(...)
    userName: any(...)
  }
}

ComponentSetup の場合は、次のコマンドを使用します。

{
  type: 'ComponentSetup'
  typeProperties: {
    componentName: 'string'
    licenseKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
  }
}

EnvironmentVariableSetup の場合は、次を使用します。

{
  type: 'EnvironmentVariableSetup'
  typeProperties: {
    variableName: 'string'
    variableValue: 'string'
  }
}

LinkedIntegrationRuntimeType オブジェクト

authorizationType プロパティを設定して、オブジェクトの種類を指定します。

キーの場合は、次を使用します。

{
  authorizationType: 'Key'
  key: {
    type: 'string'
    value: 'string'
  }
}

RBAC の場合は、次を使用します。

{
  authorizationType: 'RBAC'
  resourceId: 'string'
}

SecretBase オブジェクト

型 プロパティを設定して、オブジェクトの型を指定します。

SecureString の場合は、次を使用します。

{
  type: 'SecureString'
  value: 'string'
}

プロパティ値

Microsoft.Synapse/workspaces/integrationRuntimes

名前 説明 価値
名前 リソース名 string (必須)
親 Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。		 種類のリソースのシンボリック名: ワークスペース
プロパティ 統合ランタイムのプロパティ。 IntegrationRuntime (必須)

Cmdkeyセットアップ

名前 説明 価値
型 カスタム セットアップの種類。 'CmdkeySetup' (必須)
タイププロパティ Cmdkey コマンドのカスタム セットアップの種類のプロパティ。 CmdkeySetupTypeProperties (必須)

CmdkeySetupTypeProperties (英語)

名前 説明 価値
パスワード データ ソース アクセスのパスワード。 SecretBase (必須)
ターゲット名 データ ソース アクセスのサーバー名。 any (必須)
ユーザー名 データ ソース アクセスのユーザー名。 any (必須)

コンポーネントのセットアップ

名前 説明 価値
型 カスタム セットアップの種類。 'ComponentSetup' (必須)
タイププロパティ サード パーティ製コンポーネントの種類のプロパティをインストールします。 LicensedComponentSetupTypeProperties (必須)

CopyComputeScaleProperties (英語)

名前 説明 価値
データインテグレーションユニット コピー アクティビティの実行用に予約されている DIU 番号の設定。 サポートされる値は、4 から 256 の範囲の 4 の倍数です。 int

制約：
最小値 = 4
timeToLive (タイム・トゥ・ライブ) コピー アクティビティを実行する統合ランタイムの Time to Live (分単位) 設定。 int

制約：
最小値 = 5

カスタムセットアップベース

名前 説明 価値
型 CmdkeySetup 型の場合は 、' CmdkeySetup' に設定します。 ComponentSetup 型の場合は 、' ComponentSetup' に設定します。 EnvironmentVariableSetup 型の場合は、' EnvironmentVariableSetup' に設定します。 「CmdkeySetup」
「コンポーネントセットアップ」
'EnvironmentVariableSetup' (必須)

エンティティ参照

名前 説明 価値
referenceName(リファレンスネーム) この参照先エンティティの名前。 文字列
型 この参照先エンティティの型。 「IntegrationRuntimeReference」
'LinkedServiceReference'

EnvironmentVariableSetup (環境変数のセットアップ)

名前 説明 価値
型 カスタム セットアップの種類。 'EnvironmentVariableSetup' (必須)
タイププロパティ 環境変数の型プロパティを追加します。 EnvironmentVariableSetupTypeProperties (必須)

EnvironmentVariableSetupTypeProperties (環境変数SetupTypeProperties)

名前 説明 価値
変数名 環境変数の名前。 string (必須)
変数値 環境変数の値。 string (必須)

統合ランタイム

名前 説明 価値
説明 統合ランタイムの説明。 文字列
型 ManagedIntegrationRuntime 型の場合は 、'Managed' に設定します。 SelfHostedIntegrationRuntime 型の場合は 'SelfHosted' に設定します。 「管理」
'SelfHosted' (必須)

インテグレーションランタイムコンピュートプロパティ

名前 説明 価値
copyComputeScaleProperties の マネージド統合ランタイムの CopyComputeScale プロパティ。 CopyComputeScaleProperties (英語)
dataFlowプロパティ マネージド統合ランタイムのデータ フロー プロパティ。 統合RuntimeDataFlowProperties
位置 マネージド統合ランタイムの場所。 サポートされているリージョンは、/azure/data-factory/data-factory-data-movement-activities にあります。 文字列
maxParallelExecutionsPerNode マネージド統合ランタイムのノードあたりの並列実行の最大数。 int

制約：
最小値 = 1
ノードサイズ マネージド統合ランタイムのノード サイズ要件。 文字列
numberOfNodes の マネージド統合ランタイムに必要なノード数。 int

制約：
最小値 = 1
パイプライン外部計算スケールプロパティ マネージド統合ランタイムの PipelineExternalComputeScale プロパティ。 パイプライン外部コンピューティング スケール プロパティ
vNetプロパティ マネージド統合ランタイムの VNet プロパティ。 統合ランタイムVNetプロパティ

統合RuntimeCustomSetupScriptProperties

名前 説明 価値
ブロブコンテナURI カスタム セットアップ スクリプトを含む Azure BLOB コンテナーの URI。 文字列
sasトークン Azure BLOB コンテナーの SAS トークン。 SecureString の

統合RuntimeDataFlowProperties

名前 説明 価値
クリーンアップ クラスターはリサイクルされず、これが false に設定されている場合、TTL (有効期間) に達するまで、次のデータ フロー アクティビティの実行で使用されます。 既定値は True です。 ブール (bool)
コンピュートタイプ データ フロー ジョブを実行するクラスターのコンピューティングの種類。 'ComputeOptimized' (コンピューティング最適化)
「全般」
「メモリ最適化」
コアカウント データ フロー ジョブを実行するクラスターのコア数。 サポートされる値は、8、16、32、48、80、144、272 です。 整数 (int)
timeToLive (タイム・トゥ・ライブ) データ フロー ジョブを実行するクラスターの Time to Live (分単位) 設定。 int

制約：
最小値 = 0

インテグレーションランタイムデータプロキシプロパティ

名前 説明 価値
connectVia (接続ビア) セルフホステッド統合ランタイムリファレンス。 エンティティ参照
パス BLOB ストレージにステージング データを格納するパス。 文字列
ステージングLinkedService ステージングのリンクされたサービス参照。 エンティティ参照

統合RuntimeSsisCatalogInfo

名前 説明 価値
catalogAdminパスワード カタログ データベースの管理者ユーザー アカウントのパスワード。 SecureString の
catalogAdminUserName (カタログ管理者ユーザー名) カタログ データベースの管理者ユーザー名。 糸

制約：
最小長 = 1
最大長 = 128
catalog価格層 カタログ データベースの価格レベル。 有効な値は、https://azure.microsoft.com/en-us/pricing/details/sql-database/ 「ベーシック」
「プレミアム」
「プレミアムRS」
「スタンダード」
catalogServerエンドポイント カタログ データベース サーバーの URL。 文字列

統合RuntimeSsisProperties

名前 説明 価値
カタログ情報 マネージド専用統合ランタイムのカタログ情報。 統合RuntimeSsisCatalogInfo
customSetupScriptプロパティ マネージド専用統合ランタイムのカスタム セットアップ スクリプト プロパティ。 統合RuntimeCustomSetupScriptProperties
データプロキシプロパティ マネージド専用統合ランタイムのデータ プロキシ プロパティ。 インテグレーションランタイムデータプロキシプロパティ
エディション SSIS 統合ランタイムのエディション 「エンタープライズ」
「スタンダード」
expressCustomSetupプロパティ SSIS 統合ランタイムのスクリプト プロパティを使用しないカスタム セットアップ。 CustomSetupBase[]
ライセンスの種類 ライセンスを持ち込むシナリオのライセンスの種類。 「基準価格」
「ライセンスが含まれています」

統合ランタイムVNetプロパティ

名前 説明 価値
パブリックIP この統合ランタイムが使用するパブリック IP アドレスのリソース ID。 文字列[]
サブネット この統合ランタイムが参加するサブネットの名前。 文字列
サブネットID この Azure-SSIS 統合ランタイムが参加するサブネットの ID。 文字列
vNetId (英語) この統合ランタイムが参加する VNet の ID。 文字列

LicensedComponentSetupTypeProperties (ライセンスコンポーネント設定タイププロパティ)

名前 説明 価値
コンポーネント名 サード パーティコンポーネントの名前。 string (必須)
ライセンスキー コンポーネントをアクティブ化するためのライセンス キー。 シークレットベース

LinkedIntegrationRuntimeKeyAuthorization(リンク統合ランタイムキー認証)

名前 説明 価値
authorizationType (承認タイプ) 統合ランタイム共有の承認の種類。 'Key' (必須)
キー 承認に使用されるキー。 SecureString (必須)

LinkedIntegrationRuntimeRbacAuthorization

名前 説明 価値
authorizationType (承認タイプ) 統合ランタイム共有の承認の種類。 'RBAC' (必須)
リソースID 共有する統合ランタイムのリソース識別子。 string (必須)

LinkedIntegrationランタイムタイプ

名前 説明 価値
authorizationType (承認タイプ) LinkedIntegrationRuntimeKeyAuthorization 型の場合は 'Key' に設定されます。 LinkedIntegrationRuntimeRbacAuthorization 型の 'RBAC' に設定します。 「キー」
'RBAC' (必須)

ManagedIntegrationランタイム

名前 説明 価値
managedVirtualNetwork マネージド統合ランタイムのマネージド仮想ネットワーク。 ManagedIntegrationRuntimeManagedVirtualNetworkReference の
型 統合ランタイムの種類。 'Managed' (必須)
タイププロパティ マネージド統合ランタイムのプロパティ。 ManagedIntegrationRuntimeTypeProperties (必須)

ManagedIntegrationRuntimeManagedVirtualNetworkリファレンス

名前 説明 価値
身分証明書 マネージド仮想ネットワークの ID。 文字列
referenceName(リファレンスネーム) マネージド仮想ネットワークの参照名。 文字列
型 マネージド仮想ネットワークの種類。 文字列

ManagedIntegrationRuntimeTypeProperties (英語)

名前 説明 価値
コンピュートプロパティ マネージド統合ランタイムのコンピューティング リソース。 インテグレーションランタイムコンピュートプロパティ
ssisプロパティ マネージド統合ランタイムの SSIS プロパティ。 統合RuntimeSsisProperties

パイプライン外部コンピューティング スケール プロパティ

名前 説明 価値
numberOfExternalNodes (外部ノードの数) 外部ノードの数。0 より大きく、11 未満である必要があります。 int

制約：
最小値 = 1
最大値 = 10
パイプラインノードの数 パイプライン ノードの数。0 より大きく、11 未満である必要があります。 int

制約：
最小値 = 1
最大値 = 10
timeToLive (タイム・トゥ・ライブ) パイプラインと外部アクティビティを実行する統合ランタイムの有効期間 (分単位) 設定。 int

制約：
最小値 = 5

シークレットベース

名前 説明 価値
型 SecureString 型の場合は 、' SecureString' に設定します。 'SecureString' (必須)

セキュアストリング

名前 説明 価値
型 シークレットの種類。 string (必須)
価値 セキュリティで保護された文字列の値。 string (必須)

セキュアストリング

名前 説明 価値
型 シークレットの種類。 'SecureString' (必須)
価値 セキュリティで保護された文字列の値。 string (必須)

SelfHostedIntegrationランタイム

名前 説明 価値
型 統合ランタイムの種類。 'SelfHosted' (必須)
タイププロパティ このプロパティが null でない場合は、リンクされた統合ランタイムであることを意味します。 このプロパティは、元の統合ランタイムにアクセスするために使用されます。 SelfHostedIntegrationRuntimeTypeプロパティ

SelfHostedIntegrationRuntimeTypeプロパティ

名前 説明 価値
linkedInfo(リンク情報) データ ファクトリからのリンクされた統合ランタイムの種類 LinkedIntegrationランタイムタイプ
selfContainedInteractiveAuthoringEnabled セルフホステッド統合ランタイムが Azure Relay との接続を確立できない場合に、対話型の作成機能を確保する別のオプション。 ブール (bool)

ARM テンプレート リソース定義

ワークスペース/integrationRuntimes リソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Synapse/workspaces/integrationRuntimes リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Synapse/workspaces/integrationRuntimes",
  "apiVersion": "2021-06-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "type": "string"
    // For remaining properties, see IntegrationRuntime objects
  }
}

IntegrationRuntime オブジェクト

型 プロパティを設定して、オブジェクトの型を指定します。

マネージドの場合は、次を使用します。

{
  "managedVirtualNetwork": {
    "id": "string",
    "referenceName": "string",
    "type": "string"
  },
  "type": "Managed",
  "typeProperties": {
    "computeProperties": {
      "copyComputeScaleProperties": {
        "dataIntegrationUnit": "int",
        "timeToLive": "int"
      },
      "dataFlowProperties": {
        "cleanup": "bool",
        "computeType": "string",
        "coreCount": "int",
        "timeToLive": "int"
      },
      "location": "string",
      "maxParallelExecutionsPerNode": "int",
      "nodeSize": "string",
      "numberOfNodes": "int",
      "pipelineExternalComputeScaleProperties": {
        "numberOfExternalNodes": "int",
        "numberOfPipelineNodes": "int",
        "timeToLive": "int"
      },
      "vNetProperties": {
        "publicIPs": [ "string" ],
        "subnet": "string",
        "subnetId": "string",
        "vNetId": "string"
      }
    },
    "ssisProperties": {
      "catalogInfo": {
        "catalogAdminPassword": {
          "type": "string",
          "value": "string"
        },
        "catalogAdminUserName": "string",
        "catalogPricingTier": "string",
        "catalogServerEndpoint": "string"
      },
      "customSetupScriptProperties": {
        "blobContainerUri": "string",
        "sasToken": {
          "type": "string",
          "value": "string"
        }
      },
      "dataProxyProperties": {
        "connectVia": {
          "referenceName": "string",
          "type": "string"
        },
        "path": "string",
        "stagingLinkedService": {
          "referenceName": "string",
          "type": "string"
        }
      },
      "edition": "string",
      "expressCustomSetupProperties": [ {
        "type": "string"
        // For remaining properties, see CustomSetupBase objects
      } ],
      "licenseType": "string"
    }
  }
}

SelfHosted の場合は、次を使用します。

{
  "type": "SelfHosted",
  "typeProperties": {
    "linkedInfo": {
      "authorizationType": "string"
      // For remaining properties, see LinkedIntegrationRuntimeType objects
    },
    "selfContainedInteractiveAuthoringEnabled": "bool"
  }
}

CustomSetupBase オブジェクト

型 プロパティを設定して、オブジェクトの型を指定します。

CmdkeySetup の場合は、次のコマンドを使用します。

{
  "type": "CmdkeySetup",
  "typeProperties": {
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "targetName": {},
    "userName": {}
  }
}

ComponentSetup の場合は、次のコマンドを使用します。

{
  "type": "ComponentSetup",
  "typeProperties": {
    "componentName": "string",
    "licenseKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    }
  }
}

EnvironmentVariableSetup の場合は、次を使用します。

{
  "type": "EnvironmentVariableSetup",
  "typeProperties": {
    "variableName": "string",
    "variableValue": "string"
  }
}

LinkedIntegrationRuntimeType オブジェクト

authorizationType プロパティを設定して、オブジェクトの種類を指定します。

キーの場合は、次を使用します。

{
  "authorizationType": "Key",
  "key": {
    "type": "string",
    "value": "string"
  }
}

RBAC の場合は、次を使用します。

{
  "authorizationType": "RBAC",
  "resourceId": "string"
}

SecretBase オブジェクト

型 プロパティを設定して、オブジェクトの型を指定します。

SecureString の場合は、次を使用します。

{
  "type": "SecureString",
  "value": "string"
}

プロパティ値

Microsoft.Synapse/workspaces/integrationRuntimes

名前 説明 価値
apiVersion (英語) API のバージョン '2021-06-01-プレビュー'
名前 リソース名 string (必須)
プロパティ 統合ランタイムのプロパティ。 IntegrationRuntime (必須)
型 リソースの種類 'Microsoft.Synapse/workspaces/integrationRuntimes'

Cmdkeyセットアップ

名前 説明 価値
型 カスタム セットアップの種類。 'CmdkeySetup' (必須)
タイププロパティ Cmdkey コマンドのカスタム セットアップの種類のプロパティ。 CmdkeySetupTypeProperties (必須)

CmdkeySetupTypeProperties (英語)

名前 説明 価値
パスワード データ ソース アクセスのパスワード。 SecretBase (必須)
ターゲット名 データ ソース アクセスのサーバー名。 any (必須)
ユーザー名 データ ソース アクセスのユーザー名。 any (必須)

コンポーネントのセットアップ

名前 説明 価値
型 カスタム セットアップの種類。 'ComponentSetup' (必須)
タイププロパティ サード パーティ製コンポーネントの種類のプロパティをインストールします。 LicensedComponentSetupTypeProperties (必須)

CopyComputeScaleProperties (英語)

名前 説明 価値
データインテグレーションユニット コピー アクティビティの実行用に予約されている DIU 番号の設定。 サポートされる値は、4 から 256 の範囲の 4 の倍数です。 int

制約：
最小値 = 4
timeToLive (タイム・トゥ・ライブ) コピー アクティビティを実行する統合ランタイムの Time to Live (分単位) 設定。 int

制約：
最小値 = 5

カスタムセットアップベース

名前 説明 価値
型 CmdkeySetup 型の場合は 、' CmdkeySetup' に設定します。 ComponentSetup 型の場合は 、' ComponentSetup' に設定します。 EnvironmentVariableSetup 型の場合は、' EnvironmentVariableSetup' に設定します。 「CmdkeySetup」
「コンポーネントセットアップ」
'EnvironmentVariableSetup' (必須)

エンティティ参照

名前 説明 価値
referenceName(リファレンスネーム) この参照先エンティティの名前。 文字列
型 この参照先エンティティの型。 「IntegrationRuntimeReference」
'LinkedServiceReference'

EnvironmentVariableSetup (環境変数のセットアップ)

名前 説明 価値
型 カスタム セットアップの種類。 'EnvironmentVariableSetup' (必須)
タイププロパティ 環境変数の型プロパティを追加します。 EnvironmentVariableSetupTypeProperties (必須)

EnvironmentVariableSetupTypeProperties (環境変数SetupTypeProperties)

名前 説明 価値
変数名 環境変数の名前。 string (必須)
変数値 環境変数の値。 string (必須)

統合ランタイム

名前 説明 価値
説明 統合ランタイムの説明。 文字列
型 ManagedIntegrationRuntime 型の場合は 、'Managed' に設定します。 SelfHostedIntegrationRuntime 型の場合は 'SelfHosted' に設定します。 「管理」
'SelfHosted' (必須)

インテグレーションランタイムコンピュートプロパティ

名前 説明 価値
copyComputeScaleProperties の マネージド統合ランタイムの CopyComputeScale プロパティ。 CopyComputeScaleProperties (英語)
dataFlowプロパティ マネージド統合ランタイムのデータ フロー プロパティ。 統合RuntimeDataFlowProperties
位置 マネージド統合ランタイムの場所。 サポートされているリージョンは、/azure/data-factory/data-factory-data-movement-activities にあります。 文字列
maxParallelExecutionsPerNode マネージド統合ランタイムのノードあたりの並列実行の最大数。 int

制約：
最小値 = 1
ノードサイズ マネージド統合ランタイムのノード サイズ要件。 文字列
numberOfNodes の マネージド統合ランタイムに必要なノード数。 int

制約：
最小値 = 1
パイプライン外部計算スケールプロパティ マネージド統合ランタイムの PipelineExternalComputeScale プロパティ。 パイプライン外部コンピューティング スケール プロパティ
vNetプロパティ マネージド統合ランタイムの VNet プロパティ。 統合ランタイムVNetプロパティ

統合RuntimeCustomSetupScriptProperties

名前 説明 価値
ブロブコンテナURI カスタム セットアップ スクリプトを含む Azure BLOB コンテナーの URI。 文字列
sasトークン Azure BLOB コンテナーの SAS トークン。 SecureString の

統合RuntimeDataFlowProperties

名前 説明 価値
クリーンアップ クラスターはリサイクルされず、これが false に設定されている場合、TTL (有効期間) に達するまで、次のデータ フロー アクティビティの実行で使用されます。 既定値は True です。 ブール (bool)
コンピュートタイプ データ フロー ジョブを実行するクラスターのコンピューティングの種類。 'ComputeOptimized' (コンピューティング最適化)
「全般」
「メモリ最適化」
コアカウント データ フロー ジョブを実行するクラスターのコア数。 サポートされる値は、8、16、32、48、80、144、272 です。 整数 (int)
timeToLive (タイム・トゥ・ライブ) データ フロー ジョブを実行するクラスターの Time to Live (分単位) 設定。 int

制約：
最小値 = 0

インテグレーションランタイムデータプロキシプロパティ

名前 説明 価値
connectVia (接続ビア) セルフホステッド統合ランタイムリファレンス。 エンティティ参照
パス BLOB ストレージにステージング データを格納するパス。 文字列
ステージングLinkedService ステージングのリンクされたサービス参照。 エンティティ参照

統合RuntimeSsisCatalogInfo

名前 説明 価値
catalogAdminパスワード カタログ データベースの管理者ユーザー アカウントのパスワード。 SecureString の
catalogAdminUserName (カタログ管理者ユーザー名) カタログ データベースの管理者ユーザー名。 糸

制約：
最小長 = 1
最大長 = 128
catalog価格層 カタログ データベースの価格レベル。 有効な値は、https://azure.microsoft.com/en-us/pricing/details/sql-database/ 「ベーシック」
「プレミアム」
「プレミアムRS」
「スタンダード」
catalogServerエンドポイント カタログ データベース サーバーの URL。 文字列

統合RuntimeSsisProperties

名前 説明 価値
カタログ情報 マネージド専用統合ランタイムのカタログ情報。 統合RuntimeSsisCatalogInfo
customSetupScriptプロパティ マネージド専用統合ランタイムのカスタム セットアップ スクリプト プロパティ。 統合RuntimeCustomSetupScriptProperties
データプロキシプロパティ マネージド専用統合ランタイムのデータ プロキシ プロパティ。 インテグレーションランタイムデータプロキシプロパティ
エディション SSIS 統合ランタイムのエディション 「エンタープライズ」
「スタンダード」
expressCustomSetupプロパティ SSIS 統合ランタイムのスクリプト プロパティを使用しないカスタム セットアップ。 CustomSetupBase[]
ライセンスの種類 ライセンスを持ち込むシナリオのライセンスの種類。 「基準価格」
「ライセンスが含まれています」

統合ランタイムVNetプロパティ

名前 説明 価値
パブリックIP この統合ランタイムが使用するパブリック IP アドレスのリソース ID。 文字列[]
サブネット この統合ランタイムが参加するサブネットの名前。 文字列
サブネットID この Azure-SSIS 統合ランタイムが参加するサブネットの ID。 文字列
vNetId (英語) この統合ランタイムが参加する VNet の ID。 文字列

LicensedComponentSetupTypeProperties (ライセンスコンポーネント設定タイププロパティ)

名前 説明 価値
コンポーネント名 サード パーティコンポーネントの名前。 string (必須)
ライセンスキー コンポーネントをアクティブ化するためのライセンス キー。 シークレットベース

LinkedIntegrationRuntimeKeyAuthorization(リンク統合ランタイムキー認証)

名前 説明 価値
authorizationType (承認タイプ) 統合ランタイム共有の承認の種類。 'Key' (必須)
キー 承認に使用されるキー。 SecureString (必須)

LinkedIntegrationRuntimeRbacAuthorization

名前 説明 価値
authorizationType (承認タイプ) 統合ランタイム共有の承認の種類。 'RBAC' (必須)
リソースID 共有する統合ランタイムのリソース識別子。 string (必須)

LinkedIntegrationランタイムタイプ

名前 説明 価値
authorizationType (承認タイプ) LinkedIntegrationRuntimeKeyAuthorization 型の場合は 'Key' に設定されます。 LinkedIntegrationRuntimeRbacAuthorization 型の 'RBAC' に設定します。 「キー」
'RBAC' (必須)

ManagedIntegrationランタイム

名前 説明 価値
managedVirtualNetwork マネージド統合ランタイムのマネージド仮想ネットワーク。 ManagedIntegrationRuntimeManagedVirtualNetworkReference の
型 統合ランタイムの種類。 'Managed' (必須)
タイププロパティ マネージド統合ランタイムのプロパティ。 ManagedIntegrationRuntimeTypeProperties (必須)

ManagedIntegrationRuntimeManagedVirtualNetworkリファレンス

名前 説明 価値
身分証明書 マネージド仮想ネットワークの ID。 文字列
referenceName(リファレンスネーム) マネージド仮想ネットワークの参照名。 文字列
型 マネージド仮想ネットワークの種類。 文字列

ManagedIntegrationRuntimeTypeProperties (英語)

名前 説明 価値
コンピュートプロパティ マネージド統合ランタイムのコンピューティング リソース。 インテグレーションランタイムコンピュートプロパティ
ssisプロパティ マネージド統合ランタイムの SSIS プロパティ。 統合RuntimeSsisProperties

パイプライン外部コンピューティング スケール プロパティ

名前 説明 価値
numberOfExternalNodes (外部ノードの数) 外部ノードの数。0 より大きく、11 未満である必要があります。 int

制約：
最小値 = 1
最大値 = 10
パイプラインノードの数 パイプライン ノードの数。0 より大きく、11 未満である必要があります。 int

制約：
最小値 = 1
最大値 = 10
timeToLive (タイム・トゥ・ライブ) パイプラインと外部アクティビティを実行する統合ランタイムの有効期間 (分単位) 設定。 int

制約：
最小値 = 5

シークレットベース

名前 説明 価値
型 SecureString 型の場合は 、' SecureString' に設定します。 'SecureString' (必須)

セキュアストリング

名前 説明 価値
型 シークレットの種類。 string (必須)
価値 セキュリティで保護された文字列の値。 string (必須)

セキュアストリング

名前 説明 価値
型 シークレットの種類。 'SecureString' (必須)
価値 セキュリティで保護された文字列の値。 string (必須)

SelfHostedIntegrationランタイム

名前 説明 価値
型 統合ランタイムの種類。 'SelfHosted' (必須)
タイププロパティ このプロパティが null でない場合は、リンクされた統合ランタイムであることを意味します。 このプロパティは、元の統合ランタイムにアクセスするために使用されます。 SelfHostedIntegrationRuntimeTypeプロパティ

SelfHostedIntegrationRuntimeTypeプロパティ

名前 説明 価値
linkedInfo(リンク情報) データ ファクトリからのリンクされた統合ランタイムの種類 LinkedIntegrationランタイムタイプ
selfContainedInteractiveAuthoringEnabled セルフホステッド統合ランタイムが Azure Relay との接続を確立できない場合に、対話型の作成機能を確保する別のオプション。 ブール (bool)

使用例

Terraform (AzAPI プロバイダー) リソース定義

ワークスペース/integrationRuntimes リソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループ

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.Synapse/workspaces/integrationRuntimes リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
      type = "string"
      // For remaining properties, see IntegrationRuntime objects
    }
  }
}

IntegrationRuntime オブジェクト

型 プロパティを設定して、オブジェクトの型を指定します。

マネージドの場合は、次を使用します。

{
  managedVirtualNetwork = {
    id = "string"
    referenceName = "string"
    type = "string"
  }
  type = "Managed"
  typeProperties = {
    computeProperties = {
      copyComputeScaleProperties = {
        dataIntegrationUnit = int
        timeToLive = int
      }
      dataFlowProperties = {
        cleanup = bool
        computeType = "string"
        coreCount = int
        timeToLive = int
      }
      location = "string"
      maxParallelExecutionsPerNode = int
      nodeSize = "string"
      numberOfNodes = int
      pipelineExternalComputeScaleProperties = {
        numberOfExternalNodes = int
        numberOfPipelineNodes = int
        timeToLive = int
      }
      vNetProperties = {
        publicIPs = [
          "string"
        ]
        subnet = "string"
        subnetId = "string"
        vNetId = "string"
      }
    }
    ssisProperties = {
      catalogInfo = {
        catalogAdminPassword = {
          type = "string"
          value = "string"
        }
        catalogAdminUserName = "string"
        catalogPricingTier = "string"
        catalogServerEndpoint = "string"
      }
      customSetupScriptProperties = {
        blobContainerUri = "string"
        sasToken = {
          type = "string"
          value = "string"
        }
      }
      dataProxyProperties = {
        connectVia = {
          referenceName = "string"
          type = "string"
        }
        path = "string"
        stagingLinkedService = {
          referenceName = "string"
          type = "string"
        }
      }
      edition = "string"
      expressCustomSetupProperties = [
        {
          type = "string"
          // For remaining properties, see CustomSetupBase objects
        }
      ]
      licenseType = "string"
    }
  }
}

SelfHosted の場合は、次を使用します。

{
  type = "SelfHosted"
  typeProperties = {
    linkedInfo = {
      authorizationType = "string"
      // For remaining properties, see LinkedIntegrationRuntimeType objects
    }
    selfContainedInteractiveAuthoringEnabled = bool
  }
}

CustomSetupBase オブジェクト

型 プロパティを設定して、オブジェクトの型を指定します。

CmdkeySetup の場合は、次のコマンドを使用します。

{
  type = "CmdkeySetup"
  typeProperties = {
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
    targetName = ?
    userName = ?
  }
}

ComponentSetup の場合は、次のコマンドを使用します。

{
  type = "ComponentSetup"
  typeProperties = {
    componentName = "string"
    licenseKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }
}

EnvironmentVariableSetup の場合は、次を使用します。

{
  type = "EnvironmentVariableSetup"
  typeProperties = {
    variableName = "string"
    variableValue = "string"
  }
}

LinkedIntegrationRuntimeType オブジェクト

authorizationType プロパティを設定して、オブジェクトの種類を指定します。

キーの場合は、次を使用します。

{
  authorizationType = "Key"
  key = {
    type = "string"
    value = "string"
  }
}

RBAC の場合は、次を使用します。

{
  authorizationType = "RBAC"
  resourceId = "string"
}

SecretBase オブジェクト

型 プロパティを設定して、オブジェクトの型を指定します。

SecureString の場合は、次を使用します。

{
  type = "SecureString"
  value = "string"
}

プロパティ値

Microsoft.Synapse/workspaces/integrationRuntimes

名前 説明 価値
名前 リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: ワークスペース
プロパティ 統合ランタイムのプロパティ。 IntegrationRuntime (必須)
型 リソースの種類 「Microsoft.Synapse/ワークスペース/integrationRuntimes@2021-06-01-preview」

Cmdkeyセットアップ

名前 説明 価値
型 カスタム セットアップの種類。 'CmdkeySetup' (必須)
タイププロパティ Cmdkey コマンドのカスタム セットアップの種類のプロパティ。 CmdkeySetupTypeProperties (必須)

CmdkeySetupTypeProperties (英語)

名前 説明 価値
パスワード データ ソース アクセスのパスワード。 SecretBase (必須)
ターゲット名 データ ソース アクセスのサーバー名。 any (必須)
ユーザー名 データ ソース アクセスのユーザー名。 any (必須)

コンポーネントのセットアップ

名前 説明 価値
型 カスタム セットアップの種類。 'ComponentSetup' (必須)
タイププロパティ サード パーティ製コンポーネントの種類のプロパティをインストールします。 LicensedComponentSetupTypeProperties (必須)

CopyComputeScaleProperties (英語)

名前 説明 価値
データインテグレーションユニット コピー アクティビティの実行用に予約されている DIU 番号の設定。 サポートされる値は、4 から 256 の範囲の 4 の倍数です。 int

制約：
最小値 = 4
timeToLive (タイム・トゥ・ライブ) コピー アクティビティを実行する統合ランタイムの Time to Live (分単位) 設定。 int

制約：
最小値 = 5

カスタムセットアップベース

名前 説明 価値
型 CmdkeySetup 型の場合は 、' CmdkeySetup' に設定します。 ComponentSetup 型の場合は 、' ComponentSetup' に設定します。 EnvironmentVariableSetup 型の場合は、' EnvironmentVariableSetup' に設定します。 「CmdkeySetup」
「コンポーネントセットアップ」
'EnvironmentVariableSetup' (必須)

エンティティ参照

名前 説明 価値
referenceName(リファレンスネーム) この参照先エンティティの名前。 文字列
型 この参照先エンティティの型。 「IntegrationRuntimeReference」
'LinkedServiceReference'

EnvironmentVariableSetup (環境変数のセットアップ)

名前 説明 価値
型 カスタム セットアップの種類。 'EnvironmentVariableSetup' (必須)
タイププロパティ 環境変数の型プロパティを追加します。 EnvironmentVariableSetupTypeProperties (必須)

EnvironmentVariableSetupTypeProperties (環境変数SetupTypeProperties)

名前 説明 価値
変数名 環境変数の名前。 string (必須)
変数値 環境変数の値。 string (必須)

統合ランタイム

名前 説明 価値
説明 統合ランタイムの説明。 文字列
型 ManagedIntegrationRuntime 型の場合は 、'Managed' に設定します。 SelfHostedIntegrationRuntime 型の場合は 'SelfHosted' に設定します。 「管理」
'SelfHosted' (必須)

インテグレーションランタイムコンピュートプロパティ

名前 説明 価値
copyComputeScaleProperties の マネージド統合ランタイムの CopyComputeScale プロパティ。 CopyComputeScaleProperties (英語)
dataFlowプロパティ マネージド統合ランタイムのデータ フロー プロパティ。 統合RuntimeDataFlowProperties
位置 マネージド統合ランタイムの場所。 サポートされているリージョンは、/azure/data-factory/data-factory-data-movement-activities にあります。 文字列
maxParallelExecutionsPerNode マネージド統合ランタイムのノードあたりの並列実行の最大数。 int

制約：
最小値 = 1
ノードサイズ マネージド統合ランタイムのノード サイズ要件。 文字列
numberOfNodes の マネージド統合ランタイムに必要なノード数。 int

制約：
最小値 = 1
パイプライン外部計算スケールプロパティ マネージド統合ランタイムの PipelineExternalComputeScale プロパティ。 パイプライン外部コンピューティング スケール プロパティ
vNetプロパティ マネージド統合ランタイムの VNet プロパティ。 統合ランタイムVNetプロパティ

統合RuntimeCustomSetupScriptProperties

名前 説明 価値
ブロブコンテナURI カスタム セットアップ スクリプトを含む Azure BLOB コンテナーの URI。 文字列
sasトークン Azure BLOB コンテナーの SAS トークン。 SecureString の

統合RuntimeDataFlowProperties

名前 説明 価値
クリーンアップ クラスターはリサイクルされず、これが false に設定されている場合、TTL (有効期間) に達するまで、次のデータ フロー アクティビティの実行で使用されます。 既定値は True です。 ブール (bool)
コンピュートタイプ データ フロー ジョブを実行するクラスターのコンピューティングの種類。 'ComputeOptimized' (コンピューティング最適化)
「全般」
「メモリ最適化」
コアカウント データ フロー ジョブを実行するクラスターのコア数。 サポートされる値は、8、16、32、48、80、144、272 です。 整数 (int)
timeToLive (タイム・トゥ・ライブ) データ フロー ジョブを実行するクラスターの Time to Live (分単位) 設定。 int

制約：
最小値 = 0

インテグレーションランタイムデータプロキシプロパティ

名前 説明 価値
connectVia (接続ビア) セルフホステッド統合ランタイムリファレンス。 エンティティ参照
パス BLOB ストレージにステージング データを格納するパス。 文字列
ステージングLinkedService ステージングのリンクされたサービス参照。 エンティティ参照

統合RuntimeSsisCatalogInfo

名前 説明 価値
catalogAdminパスワード カタログ データベースの管理者ユーザー アカウントのパスワード。 SecureString の
catalogAdminUserName (カタログ管理者ユーザー名) カタログ データベースの管理者ユーザー名。 糸

制約：
最小長 = 1
最大長 = 128
catalog価格層 カタログ データベースの価格レベル。 有効な値は、https://azure.microsoft.com/en-us/pricing/details/sql-database/ 「ベーシック」
「プレミアム」
「プレミアムRS」
「スタンダード」
catalogServerエンドポイント カタログ データベース サーバーの URL。 文字列

統合RuntimeSsisProperties

名前 説明 価値
カタログ情報 マネージド専用統合ランタイムのカタログ情報。 統合RuntimeSsisCatalogInfo
customSetupScriptプロパティ マネージド専用統合ランタイムのカスタム セットアップ スクリプト プロパティ。 統合RuntimeCustomSetupScriptProperties
データプロキシプロパティ マネージド専用統合ランタイムのデータ プロキシ プロパティ。 インテグレーションランタイムデータプロキシプロパティ
エディション SSIS 統合ランタイムのエディション 「エンタープライズ」
「スタンダード」
expressCustomSetupプロパティ SSIS 統合ランタイムのスクリプト プロパティを使用しないカスタム セットアップ。 CustomSetupBase[]
ライセンスの種類 ライセンスを持ち込むシナリオのライセンスの種類。 「基準価格」
「ライセンスが含まれています」

統合ランタイムVNetプロパティ

名前 説明 価値
パブリックIP この統合ランタイムが使用するパブリック IP アドレスのリソース ID。 文字列[]
サブネット この統合ランタイムが参加するサブネットの名前。 文字列
サブネットID この Azure-SSIS 統合ランタイムが参加するサブネットの ID。 文字列
vNetId (英語) この統合ランタイムが参加する VNet の ID。 文字列

LicensedComponentSetupTypeProperties (ライセンスコンポーネント設定タイププロパティ)

名前 説明 価値
コンポーネント名 サード パーティコンポーネントの名前。 string (必須)
ライセンスキー コンポーネントをアクティブ化するためのライセンス キー。 シークレットベース

LinkedIntegrationRuntimeKeyAuthorization(リンク統合ランタイムキー認証)

名前 説明 価値
authorizationType (承認タイプ) 統合ランタイム共有の承認の種類。 'Key' (必須)
キー 承認に使用されるキー。 SecureString (必須)

LinkedIntegrationRuntimeRbacAuthorization

名前 説明 価値
authorizationType (承認タイプ) 統合ランタイム共有の承認の種類。 'RBAC' (必須)
リソースID 共有する統合ランタイムのリソース識別子。 string (必須)

LinkedIntegrationランタイムタイプ

名前 説明 価値
authorizationType (承認タイプ) LinkedIntegrationRuntimeKeyAuthorization 型の場合は 'Key' に設定されます。 LinkedIntegrationRuntimeRbacAuthorization 型の 'RBAC' に設定します。 「キー」
'RBAC' (必須)

ManagedIntegrationランタイム

名前 説明 価値
managedVirtualNetwork マネージド統合ランタイムのマネージド仮想ネットワーク。 ManagedIntegrationRuntimeManagedVirtualNetworkReference の
型 統合ランタイムの種類。 'Managed' (必須)
タイププロパティ マネージド統合ランタイムのプロパティ。 ManagedIntegrationRuntimeTypeProperties (必須)

ManagedIntegrationRuntimeManagedVirtualNetworkリファレンス

名前 説明 価値
身分証明書 マネージド仮想ネットワークの ID。 文字列
referenceName(リファレンスネーム) マネージド仮想ネットワークの参照名。 文字列
型 マネージド仮想ネットワークの種類。 文字列

ManagedIntegrationRuntimeTypeProperties (英語)

名前 説明 価値
コンピュートプロパティ マネージド統合ランタイムのコンピューティング リソース。 インテグレーションランタイムコンピュートプロパティ
ssisプロパティ マネージド統合ランタイムの SSIS プロパティ。 統合RuntimeSsisProperties

パイプライン外部コンピューティング スケール プロパティ

名前 説明 価値
numberOfExternalNodes (外部ノードの数) 外部ノードの数。0 より大きく、11 未満である必要があります。 int

制約：
最小値 = 1
最大値 = 10
パイプラインノードの数 パイプライン ノードの数。0 より大きく、11 未満である必要があります。 int

制約：
最小値 = 1
最大値 = 10
timeToLive (タイム・トゥ・ライブ) パイプラインと外部アクティビティを実行する統合ランタイムの有効期間 (分単位) 設定。 int

制約：
最小値 = 5

シークレットベース

名前 説明 価値
型 SecureString 型の場合は 、' SecureString' に設定します。 'SecureString' (必須)

セキュアストリング

名前 説明 価値
型 シークレットの種類。 string (必須)
価値 セキュリティで保護された文字列の値。 string (必須)

セキュアストリング

名前 説明 価値
型 シークレットの種類。 'SecureString' (必須)
価値 セキュリティで保護された文字列の値。 string (必須)

SelfHostedIntegrationランタイム

名前 説明 価値
型 統合ランタイムの種類。 'SelfHosted' (必須)
タイププロパティ このプロパティが null でない場合は、リンクされた統合ランタイムであることを意味します。 このプロパティは、元の統合ランタイムにアクセスするために使用されます。 SelfHostedIntegrationRuntimeTypeプロパティ

SelfHostedIntegrationRuntimeTypeプロパティ

名前 説明 価値
linkedInfo(リンク情報) データ ファクトリからのリンクされた統合ランタイムの種類 LinkedIntegrationランタイムタイプ
selfContainedInteractiveAuthoringEnabled セルフホステッド統合ランタイムが Azure Relay との接続を確立できない場合に、対話型の作成機能を確保する別のオプション。 ブール (bool)