Microsoft.Synapse ワークスペース/integrationRuntimes 2021-03-01
Bicep リソース定義
workspaces/integrationRuntimes リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Synapse/workspaces/integrationRuntimes リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Synapse/workspaces/integrationRuntimes@2021-03-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
type: 'string'
// For remaining properties, see IntegrationRuntime objects
}
}
IntegrationRuntime オブジェクト
type プロパティを設定して、オブジェクトの種類を指定します。
[マネージド] には、次の値を使用します。
type: 'Managed'
typeProperties: {
computeProperties: {
dataFlowProperties: {
computeType: 'string'
coreCount: int
timeToLive: int
}
location: 'string'
maxParallelExecutionsPerNode: int
nodeSize: 'string'
numberOfNodes: 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
}
}
CustomSetupBase オブジェクト
type プロパティを設定して、オブジェクトの種類を指定します。
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'
}
SecretBase オブジェクト
type プロパティを設定して、オブジェクトの種類を指定します。
SecureString の場合は、次の値を使用します。
type: 'SecureString'
value: 'string'
LinkedIntegrationRuntimeType オブジェクト
authorizationType プロパティを設定して、オブジェクトの種類を指定します。
[キー] には、次の値を使用します。
authorizationType: 'Key'
key: {
type: 'string'
value: 'string'
}
RBAC の場合は、次の値を使用します。
authorizationType: 'RBAC'
resourceId: 'string'
プロパティ値
workspaces/integrationRuntimes
名前 | 説明 | 値 |
---|---|---|
name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部にある子リソース」を参照してください。 |
種類のリソースのシンボル名: ワークスペース |
properties | 統合ランタイムのプロパティ。 | IntegrationRuntime (必須) |
IntegrationRuntime
名前 | 説明 | 値 |
---|---|---|
description | 統合ランタイムの説明。 | string |
type | オブジェクトの種類を設定する | マネージド SelfHosted (必須) |
ManagedIntegrationRuntime
名前 | 説明 | 値 |
---|---|---|
type | 統合ランタイムの種類。 | 'Managed' (必須) |
typeProperties | マネージド統合ランタイムのプロパティ。 | ManagedIntegrationRuntimeTypeProperties (必須) |
ManagedIntegrationRuntimeTypeProperties
名前 | 説明 | 値 |
---|---|---|
computeProperties | マネージド統合ランタイムのコンピューティング リソース。 | IntegrationRuntimeComputeProperties |
ssisProperties | マネージド統合ランタイムの SSIS プロパティ。 | IntegrationRuntimeSsisProperties |
IntegrationRuntimeComputeProperties
名前 | 説明 | 値 |
---|---|---|
dataFlowProperties | マネージド統合ランタイムのデータ フロー プロパティ。 | IntegrationRuntimeDataFlowProperties |
location | マネージド統合ランタイムの場所。 サポートされているリージョンは、/azure/data-factory/data-factory-data-movement-activities にあります | string |
maxParallelExecutionsPerNode | マネージド統合ランタイムのノードあたりの並列実行の最大数。 | INT |
nodeSize | マネージド統合ランタイムに対するノード サイズの要件。 | string |
numberOfNodes | マネージド統合ランタイムに必要なノード数。 | INT |
vNetProperties | マネージド統合ランタイムの VNet プロパティ。 | IntegrationRuntimeVNetProperties |
IntegrationRuntimeDataFlowProperties
名前 | 説明 | 値 |
---|---|---|
computeType | データ フロー ジョブを実行するクラスターのコンピューティングの種類。 | 'ComputeOptimized' 'General' 'MemoryOptimized' |
coreCount | データ フロー ジョブを実行するクラスターのコア数。 サポートされる値は、8、16、32、48、80、144、272 です。 | INT |
timeToLive | データ フロー ジョブを実行するクラスターの有効期間 (分単位) 設定。 | INT |
IntegrationRuntimeVNetProperties
名前 | 説明 | 値 |
---|---|---|
publicIP | この統合ランタイムが使用するパブリック IP アドレスのリソース ID。 | string[] |
サブネット | この統合ランタイムが参加するサブネットの名前。 | string |
subnetId | この Azure-SSIS 統合ランタイムが参加するサブネットの ID。 | string |
vNetId | この統合ランタイムが参加する VNet の ID。 | string |
IntegrationRuntimeSsisProperties
名前 | 説明 | 値 |
---|---|---|
catalogInfo | マネージド専用統合ランタイムのカタログ情報。 | IntegrationRuntimeSsisCatalogInfo |
customSetupScriptProperties | マネージド専用統合ランタイムのカスタム セットアップ スクリプト プロパティ。 | IntegrationRuntimeCustomSetupScriptProperties |
dataProxyProperties | マネージド専用統合ランタイムのデータ プロキシ プロパティ。 | IntegrationRuntimeDataProxyProperties |
edition | SSIS Integration Runtimeのエディション | 'Enterprise' 'Standard' |
expressCustomSetupProperties | SSIS 統合ランタイムのスクリプト プロパティを使用しないカスタム セットアップ。 | CustomSetupBase[] |
licenseType | 独自のライセンスシナリオを持ち込むためのライセンスの種類。 | 'BasePrice' 'LicenseIncluded' |
IntegrationRuntimeSsisCatalogInfo
Name | 説明 | 値 |
---|---|---|
catalogAdminPassword | カタログ データベースの管理者ユーザー アカウントのパスワード。 | SecureString |
catalogAdminUserName | カタログ データベースの管理者ユーザー名。 | string |
catalogPricingTier | カタログ データベースの価格レベル。 有効な値は、 https://azure.microsoft.com/pricing/details/sql-database/ |
'Basic' 'Premium' 'PremiumRS' 'Standard' |
catalogServerEndpoint | カタログ データベース サーバーの URL。 | string |
SecureString
名前 | 説明 | 値 |
---|---|---|
type | シークレットの種類。 | string (必須) |
value | セキュリティで保護された文字列の値。 | string (必須) |
IntegrationRuntimeCustomSetupScriptProperties
名前 | 説明 | 値 |
---|---|---|
blobContainerUri | カスタム セットアップ スクリプトを含む Azure BLOB コンテナーの URI。 | string |
sasToken | Azure BLOB コンテナーの SAS トークン。 | SecureString |
IntegrationRuntimeDataProxyProperties
Name | 説明 | 値 |
---|---|---|
connectVia | セルフホステッド統合ランタイムリファレンス。 | EntityReference |
path | BLOB ストレージにステージング されたデータを格納するパス。 | string |
stagingLinkedService | ステージングリンクされたサービス参照。 | EntityReference |
EntityReference
名前 | 説明 | 値 |
---|---|---|
referenceName | この参照先エンティティの名前。 | string |
type | この参照先エンティティの型。 | 'IntegrationRuntimeReference' 'LinkedServiceReference' |
CustomSetupBase
名前 | 説明 | 値 |
---|---|---|
type | オブジェクトの種類を設定する | CmdkeySetup ComponentSetup EnvironmentVariableSetup (必須) |
CmdkeySetup
名前 | 説明 | 値 |
---|---|---|
type | カスタム セットアップの種類。 | 'CmdkeySetup' (必須) |
typeProperties | Cmdkey コマンドのカスタム セットアップの種類のプロパティ。 | CmdkeySetupTypeProperties (必須) |
CmdkeySetupTypeProperties
Name | 説明 | 値 |
---|---|---|
password | データ ソース アクセスのパスワード。 | SecretBase (必須) |
targetName | データ ソース アクセスのサーバー名。 | Bicep の場合は、 any() 関数を使用できます。(必須) |
userName | データ ソース アクセスのユーザー名。 | Bicep の場合は、 any() 関数を使用できます。(必須) |
SecretBase
Name | 説明 | 値 |
---|---|---|
type | オブジェクトの種類を設定する | SecureString (必須) |
ComponentSetup
Name | 説明 | 値 |
---|---|---|
type | カスタム セットアップの種類。 | 'ComponentSetup' (必須) |
typeProperties | サード パーティ製コンポーネントの種類のプロパティをインストールします。 | LicensedComponentSetupTypeProperties (必須) |
LicensedComponentSetupTypeProperties
Name | 説明 | 値 |
---|---|---|
componentName | サード パーティコンポーネントの名前。 | string (必須) |
licenseKey | コンポーネントをアクティブにするライセンス キー。 | SecretBase |
EnvironmentVariableSetup
Name | 説明 | 値 |
---|---|---|
type | カスタム セットアップの種類。 | 'EnvironmentVariableSetup' (必須) |
typeProperties | 環境変数の型プロパティを追加します。 | EnvironmentVariableSetupTypeProperties (必須) |
EnvironmentVariableSetupTypeProperties
名前 | 説明 | 値 |
---|---|---|
variableName | 環境変数の名前。 | string (必須) |
variableValue | 環境変数の値。 | string (必須) |
SelfHostedIntegrationRuntime
Name | 説明 | 値 |
---|---|---|
type | 統合ランタイムの種類。 | 'SelfHosted' (必須) |
typeProperties | このプロパティが null でない場合、これはリンクされた統合ランタイムであることを意味します。 プロパティは、元の統合ランタイムにアクセスするために使用されます。 | SelfHostedIntegrationRuntimeTypeProperties |
SelfHostedIntegrationRuntimeTypeProperties
Name | 説明 | 値 |
---|---|---|
linkedInfo | データ ファクトリからのリンクされた統合ランタイムの種類 | LinkedIntegrationRuntimeType |
LinkedIntegrationRuntimeType
名前 | 説明 | 値 |
---|---|---|
authorizationType | オブジェクトの種類を設定する | キー RBAC (必須) |
LinkedIntegrationRuntimeKeyAuthorization
Name | 説明 | 値 |
---|---|---|
authorizationType | 統合ランタイム共有の承認の種類。 | 'Key' (必須) |
key | 承認に使用されるキー。 | SecureString (必須) |
LinkedIntegrationRuntimeRbacAuthorization
Name | 説明 | 値 |
---|---|---|
authorizationType | 統合ランタイム共有の承認の種類。 | 'RBAC' (必須) |
resourceId | 共有する統合ランタイムのリソース識別子。 | string (必須) |
ARM テンプレート リソース定義
workspaces/integrationRuntimes リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Synapse/workspaces/integrationRuntimes リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Synapse/workspaces/integrationRuntimes",
"apiVersion": "2021-03-01",
"name": "string",
"properties": {
"description": "string",
"type": "string"
// For remaining properties, see IntegrationRuntime objects
}
}
IntegrationRuntime オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
Managed の場合は、次の値を使用します。
"type": "Managed",
"typeProperties": {
"computeProperties": {
"dataFlowProperties": {
"computeType": "string",
"coreCount": "int",
"timeToLive": "int"
},
"location": "string",
"maxParallelExecutionsPerNode": "int",
"nodeSize": "string",
"numberOfNodes": "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
}
}
CustomSetupBase オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
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"
}
SecretBase オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
SecureString の場合は、次の値を使用します。
"type": "SecureString",
"value": "string"
LinkedIntegrationRuntimeType オブジェクト
authorizationType プロパティを設定して、オブジェクトの種類を指定します。
[キー] には、次の値を使用します。
"authorizationType": "Key",
"key": {
"type": "string",
"value": "string"
}
RBAC の場合は、次を使用します。
"authorizationType": "RBAC",
"resourceId": "string"
プロパティ値
workspaces/integrationRuntimes
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.Synapse/workspaces/integrationRuntimes' |
apiVersion | リソース API のバージョン | '2021-03-01' |
name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
properties | 統合ランタイムのプロパティ。 | IntegrationRuntime (必須) |
IntegrationRuntime
名前 | 説明 | 値 |
---|---|---|
description | 統合ランタイムの説明。 | string |
type | オブジェクトの種類を設定する | マネージド SelfHosted (必須) |
ManagedIntegrationRuntime
Name | 説明 | 値 |
---|---|---|
type | 統合ランタイムの種類。 | 'Managed' (必須) |
typeProperties | マネージド統合ランタイムのプロパティ。 | ManagedIntegrationRuntimeTypeProperties (必須) |
ManagedIntegrationRuntimeTypeProperties
Name | 説明 | 値 |
---|---|---|
computeProperties | マネージド統合ランタイムのコンピューティング リソース。 | IntegrationRuntimeComputeProperties |
ssisProperties | マネージド統合ランタイムの SSIS プロパティ。 | IntegrationRuntimeSsisProperties |
IntegrationRuntimeComputeProperties
名前 | 説明 | 値 |
---|---|---|
dataFlowProperties | マネージド統合ランタイムのデータ フロー プロパティ。 | IntegrationRuntimeDataFlowProperties |
location | マネージド統合ランタイムの場所。 サポートされているリージョンは、/azure/data-factory/data-factory-data-movement-activities にあります | string |
maxParallelExecutionsPerNode | マネージド統合ランタイムのノードあたりの並列実行の最大数。 | INT |
nodeSize | マネージド統合ランタイムに対するノード サイズの要件。 | string |
numberOfNodes | マネージド統合ランタイムに必要なノード数。 | INT |
vNetProperties | マネージド統合ランタイムの VNet プロパティ。 | IntegrationRuntimeVNetProperties |
IntegrationRuntimeDataFlowProperties
名前 | 説明 | 値 |
---|---|---|
computeType | データ フロー ジョブを実行するクラスターのコンピューティングの種類。 | 'ComputeOptimized' 'General' 'MemoryOptimized' |
coreCount | データ フロー ジョブを実行するクラスターのコア数。 サポートされる値は、8、16、32、48、80、144、272 です。 | INT |
timeToLive | データ フロー ジョブを実行するクラスターの有効期間 (分単位) の設定。 | INT |
IntegrationRuntimeVNetProperties
名前 | 説明 | 値 |
---|---|---|
publicIPs | この統合ランタイムが使用するパブリック IP アドレスのリソース ID。 | string[] |
サブネット | この統合ランタイムが参加するサブネットの名前。 | string |
subnetId | この Azure-SSIS 統合ランタイムが参加するサブネットの ID。 | string |
vNetId | この統合ランタイムが参加する VNet の ID。 | string |
IntegrationRuntimeSsisProperties
名前 | 説明 | 値 |
---|---|---|
catalogInfo | マネージド専用統合ランタイムのカタログ情報。 | IntegrationRuntimeSsisCatalogInfo |
customSetupScriptProperties | マネージド専用統合ランタイムのカスタム セットアップ スクリプト プロパティ。 | IntegrationRuntimeCustomSetupScriptProperties |
dataProxyProperties | マネージド専用統合ランタイムのデータ プロキシ プロパティ。 | IntegrationRuntimeDataProxyProperties |
edition | SSIS Integration Runtimeのエディション | 'Enterprise' 'Standard' |
expressCustomSetupProperties | SSIS 統合ランタイムのスクリプト プロパティを使用しないカスタム セットアップ。 | CustomSetupBase[] |
licenseType | 独自のライセンス シナリオを持ち込むためのライセンスの種類。 | 'BasePrice' 'LicenseIncluded' |
IntegrationRuntimeSsisCatalogInfo
Name | 説明 | 値 |
---|---|---|
catalogAdminPassword | カタログ データベースの管理者ユーザー アカウントのパスワード。 | SecureString |
catalogAdminUserName | カタログ データベースの管理者ユーザー名。 | string |
catalogPricingTier | カタログ データベースの価格レベル。 有効な値は、 https://azure.microsoft.com/pricing/details/sql-database/ |
'Basic' 'Premium' 'PremiumRS' 'Standard' |
catalogServerEndpoint | カタログ データベース サーバーの URL。 | string |
SecureString
Name | 説明 | 値 |
---|---|---|
type | シークレットの種類。 | string (必須) |
value | セキュリティで保護された文字列の値。 | string (必須) |
IntegrationRuntimeCustomSetupScriptProperties
名前 | 説明 | 値 |
---|---|---|
blobContainerUri | カスタム セットアップ スクリプトを含む Azure BLOB コンテナーの URI。 | string |
sasToken | Azure BLOB コンテナーの SAS トークン。 | SecureString |
IntegrationRuntimeDataProxyProperties
Name | 説明 | 値 |
---|---|---|
connectVia | セルフホステッド統合ランタイムリファレンス。 | EntityReference |
path | Blob Storage にステージング されたデータを格納するパス。 | string |
stagingLinkedService | ステージングリンクされたサービス参照。 | EntityReference |
EntityReference
名前 | 説明 | 値 |
---|---|---|
referenceName | この参照先エンティティの名前。 | string |
type | この参照先エンティティの型。 | 'IntegrationRuntimeReference' 'LinkedServiceReference' |
CustomSetupBase
名前 | 説明 | 値 |
---|---|---|
type | オブジェクトの種類を設定する | CmdkeySetup ComponentSetup EnvironmentVariableSetup (必須) |
CmdkeySetup
名前 | 説明 | 値 |
---|---|---|
type | カスタム セットアップの種類。 | 'CmdkeySetup' (必須) |
typeProperties | Cmdkey コマンドのカスタム セットアップの種類のプロパティ。 | CmdkeySetupTypeProperties (必須) |
CmdkeySetupTypeProperties
名前 | 説明 | 値 |
---|---|---|
password | データ ソース アクセスのパスワード。 | SecretBase (必須) |
targetName | データ ソース アクセスのサーバー名。 | |
userName | データ ソース アクセスのユーザー名。 |
SecretBase
名前 | 説明 | 値 |
---|---|---|
type | オブジェクトの種類を設定する | SecureString (必須) |
ComponentSetup
Name | 説明 | 値 |
---|---|---|
type | カスタム セットアップの種類。 | 'ComponentSetup' (必須) |
typeProperties | サード パーティのコンポーネントの種類のプロパティをインストールします。 | LicensedComponentSetupTypeProperties (必須) |
LicensedComponentSetupTypeProperties
名前 | 説明 | 値 |
---|---|---|
componentName | サード パーティ製コンポーネントの名前。 | string (必須) |
licenseKey | コンポーネントをアクティブ化するためのライセンス キー。 | SecretBase |
EnvironmentVariableSetup
名前 | 説明 | 値 |
---|---|---|
type | カスタム セットアップの種類。 | 'EnvironmentVariableSetup' (必須) |
typeProperties | 環境変数の型プロパティを追加します。 | EnvironmentVariableSetupTypeProperties (必須) |
EnvironmentVariableSetupTypeProperties
Name | 説明 | 値 |
---|---|---|
variableName | 環境変数の名前。 | string (必須) |
variableValue | 環境変数の値。 | string (必須) |
SelfHostedIntegrationRuntime
Name | 説明 | 値 |
---|---|---|
type | 統合ランタイムの種類。 | 'SelfHosted' (必須) |
typeProperties | このプロパティが null でない場合、これはリンクされた統合ランタイムであることを意味します。 プロパティは、元の統合ランタイムにアクセスするために使用されます。 | SelfHostedIntegrationRuntimeTypeProperties |
SelfHostedIntegrationRuntimeTypeProperties
Name | 説明 | 値 |
---|---|---|
linkedInfo | データ ファクトリからのリンクされた統合ランタイムの種類 | LinkedIntegrationRuntimeType |
LinkedIntegrationRuntimeType
Name | 説明 | 値 |
---|---|---|
authorizationType | オブジェクトの種類を設定する | キー RBAC (必須) |
LinkedIntegrationRuntimeKeyAuthorization
Name | 説明 | 値 |
---|---|---|
authorizationType | 統合ランタイム共有の承認の種類。 | 'Key' (必須) |
key | 承認に使用されるキー。 | SecureString (必須) |
LinkedIntegrationRuntimeRbacAuthorization
Name | 説明 | 値 |
---|---|---|
authorizationType | 統合ランタイム共有の承認の種類。 | 'RBAC' (必須) |
resourceId | 共有する統合ランタイムのリソース識別子。 | string (必須) |
Terraform (AzAPI プロバイダー) リソース定義
workspaces/integrationRuntimes リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Synapse/workspaces/integrationRuntimes リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Synapse/workspaces/integrationRuntimes@2021-03-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
type = "string"
// For remaining properties, see IntegrationRuntime objects
}
})
}
IntegrationRuntime オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
Managed の場合は、次の値を使用します。
type = "Managed"
typeProperties = {
computeProperties = {
dataFlowProperties = {
computeType = "string"
coreCount = int
timeToLive = int
}
location = "string"
maxParallelExecutionsPerNode = int
nodeSize = "string"
numberOfNodes = 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
}
}
CustomSetupBase オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
CmdkeySetup の場合は、次を使用します。
type = "CmdkeySetup"
typeProperties = {
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
}
ComponentSetup の場合は、次を使用します。
type = "ComponentSetup"
typeProperties = {
componentName = "string"
licenseKey = {
type = "string"
// For remaining properties, see SecretBase objects
}
}
EnvironmentVariableSetup の場合は、次を使用します。
type = "EnvironmentVariableSetup"
typeProperties = {
variableName = "string"
variableValue = "string"
}
SecretBase オブジェクト
type プロパティを設定して、オブジェクトの種類を指定します。
SecureString の場合は、次の値を使用します。
type = "SecureString"
value = "string"
LinkedIntegrationRuntimeType オブジェクト
authorizationType プロパティを設定して、オブジェクトの種類を指定します。
[キー] には、次の値を使用します。
authorizationType = "Key"
key = {
type = "string"
value = "string"
}
RBAC の場合は、次の値を使用します。
authorizationType = "RBAC"
resourceId = "string"
プロパティ値
workspaces/integrationRuntimes
Name | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.Synapse/workspaces/integrationRuntimes@2021-03-01" |
name | リソース名 | string (必須) |
parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: ワークスペース |
properties | 統合ランタイムのプロパティ。 | IntegrationRuntime (必須) |
IntegrationRuntime
名前 | 説明 | 値 |
---|---|---|
description | 統合ランタイムの説明。 | string |
type | オブジェクトの種類を設定する | マネージド SelfHosted (必須) |
ManagedIntegrationRuntime
名前 | 説明 | 値 |
---|---|---|
type | 統合ランタイムの種類。 | "マネージド" (必須) |
typeProperties | マネージド統合ランタイムのプロパティ。 | ManagedIntegrationRuntimeTypeProperties (必須) |
ManagedIntegrationRuntimeTypeProperties
Name | 説明 | 値 |
---|---|---|
computeProperties | マネージド統合ランタイムのコンピューティング リソース。 | IntegrationRuntimeComputeProperties |
ssisProperties | マネージド統合ランタイムの SSIS プロパティ。 | IntegrationRuntimeSsisProperties |
IntegrationRuntimeComputeProperties
名前 | 説明 | 値 |
---|---|---|
dataFlowProperties | マネージド統合ランタイムのデータ フロー プロパティ。 | IntegrationRuntimeDataFlowProperties |
location | マネージド統合ランタイムの場所。 サポートされているリージョンは、/azure/data-factory/data-factory-data-movement-activities にあります | string |
maxParallelExecutionsPerNode | マネージド統合ランタイムのノードあたりの並列実行の最大数。 | INT |
nodeSize | マネージド統合ランタイムに対するノード サイズの要件。 | string |
numberOfNodes | マネージド統合ランタイムに必要なノード数。 | INT |
vNetProperties | マネージド統合ランタイムの VNet プロパティ。 | IntegrationRuntimeVNetProperties |
IntegrationRuntimeDataFlowProperties
名前 | 説明 | 値 |
---|---|---|
computeType | データ フロー ジョブを実行するクラスターのコンピューティングの種類。 | "ComputeOptimized" "全般" "MemoryOptimized" |
coreCount | データ フロー ジョブを実行するクラスターのコア数。 サポートされる値は、8、16、32、48、80、144、272 です。 | INT |
timeToLive | データ フロー ジョブを実行するクラスターの有効期間 (分単位) の設定。 | INT |
IntegrationRuntimeVNetProperties
名前 | 説明 | 値 |
---|---|---|
publicIP | この統合ランタイムが使用するパブリック IP アドレスのリソース ID。 | string[] |
サブネット | この統合ランタイムが参加するサブネットの名前。 | string |
subnetId | この Azure-SSIS 統合ランタイムが参加するサブネットの ID。 | string |
vNetId | この統合ランタイムが参加する VNet の ID。 | string |
IntegrationRuntimeSsisProperties
Name | 説明 | 値 |
---|---|---|
catalogInfo | マネージド専用統合ランタイムのカタログ情報。 | IntegrationRuntimeSsisCatalogInfo |
customSetupScriptProperties | マネージド専用統合ランタイムのカスタム セットアップ スクリプト プロパティ。 | IntegrationRuntimeCustomSetupScriptProperties |
dataProxyProperties | マネージド専用統合ランタイムのデータ プロキシ プロパティ。 | IntegrationRuntimeDataProxyProperties |
edition | SSIS Integration Runtimeのエディション | "エンタープライズ" "Standard" |
expressCustomSetupProperties | SSIS 統合ランタイムのスクリプト プロパティを使用しないカスタム セットアップ。 | CustomSetupBase[] |
licenseType | 独自のライセンスシナリオを持ち込むためのライセンスの種類。 | "BasePrice" "LicenseIncluded" |
IntegrationRuntimeSsisCatalogInfo
名前 | 説明 | 値 |
---|---|---|
catalogAdminPassword | カタログ データベースの管理者ユーザー アカウントのパスワード。 | SecureString |
catalogAdminUserName | カタログ データベースの管理者ユーザー名。 | string |
catalogPricingTier | カタログ データベースの価格レベル。 有効な値は、 https://azure.microsoft.com/pricing/details/sql-database/ |
"Basic" "Premium" "PremiumRS" "Standard" |
catalogServerEndpoint | カタログ データベース サーバーの URL。 | string |
SecureString
名前 | 説明 | 値 |
---|---|---|
type | シークレットの種類。 | string (必須) |
value | セキュリティで保護された文字列の値。 | string (必須) |
IntegrationRuntimeCustomSetupScriptProperties
Name | 説明 | 値 |
---|---|---|
blobContainerUri | カスタム セットアップ スクリプトを含む Azure BLOB コンテナーの URI。 | string |
sasToken | Azure BLOB コンテナーの SAS トークン。 | SecureString |
IntegrationRuntimeDataProxyProperties
Name | 説明 | 値 |
---|---|---|
connectVia | セルフホステッド統合ランタイムリファレンス。 | EntityReference |
path | Blob Storage にステージング されたデータを格納するパス。 | string |
stagingLinkedService | ステージングリンクされたサービス参照。 | EntityReference |
EntityReference
Name | 説明 | 値 |
---|---|---|
referenceName | この参照先エンティティの名前。 | string |
type | この参照先エンティティの型。 | "IntegrationRuntimeReference" "LinkedServiceReference" |
CustomSetupBase
Name | 説明 | 値 |
---|---|---|
type | オブジェクトの種類を設定する | CmdkeySetup ComponentSetup EnvironmentVariableSetup (必須) |
CmdkeySetup
名前 | 説明 | 値 |
---|---|---|
type | カスタム セットアップの種類。 | "CmdkeySetup" (必須) |
typeProperties | Cmdkey コマンドのカスタム セットアップの種類のプロパティ。 | CmdkeySetupTypeProperties (必須) |
CmdkeySetupTypeProperties
名前 | 説明 | 値 |
---|---|---|
password | データ ソース アクセスのパスワード。 | SecretBase (必須) |
targetName | データ ソース アクセスのサーバー名。 | |
userName | データ ソース アクセスのユーザー名。 |
SecretBase
名前 | 説明 | 値 |
---|---|---|
type | オブジェクトの種類を設定する | SecureString (必須) |
ComponentSetup
名前 | 説明 | 値 |
---|---|---|
type | カスタム セットアップの種類。 | "ComponentSetup" (必須) |
typeProperties | サード パーティ製コンポーネントの種類のプロパティをインストールします。 | LicensedComponentSetupTypeProperties (必須) |
LicensedComponentSetupTypeProperties
名前 | 説明 | 値 |
---|---|---|
componentName | サード パーティコンポーネントの名前。 | string (必須) |
licenseKey | コンポーネントをアクティブにするライセンス キー。 | SecretBase |
EnvironmentVariableSetup
Name | 説明 | 値 |
---|---|---|
type | カスタム セットアップの種類。 | "EnvironmentVariableSetup" (必須) |
typeProperties | 環境変数の型プロパティを追加します。 | EnvironmentVariableSetupTypeProperties (必須) |
EnvironmentVariableSetupTypeProperties
名前 | 説明 | 値 |
---|---|---|
variableName | 環境変数の名前。 | string (必須) |
variableValue | 環境変数の値。 | string (必須) |
SelfHostedIntegrationRuntime
名前 | 説明 | 値 |
---|---|---|
type | 統合ランタイムの種類。 | "SelfHosted" (必須) |
typeProperties | このプロパティが null でない場合、これはリンクされた統合ランタイムであることを意味します。 プロパティは、元の統合ランタイムにアクセスするために使用されます。 | SelfHostedIntegrationRuntimeTypeProperties |
SelfHostedIntegrationRuntimeTypeProperties
名前 | 説明 | 値 |
---|---|---|
linkedInfo | データ ファクトリからのリンクされた統合ランタイムの種類 | LinkedIntegrationRuntimeType |
LinkedIntegrationRuntimeType
Name | 説明 | 値 |
---|---|---|
authorizationType | オブジェクトの種類を設定する | キー RBAC (必須) |
LinkedIntegrationRuntimeKeyAuthorization
名前 | 説明 | 値 |
---|---|---|
authorizationType | 統合ランタイム共有の承認の種類。 | "Key" (必須) |
key | 承認に使用されるキー。 | SecureString (必須) |
LinkedIntegrationRuntimeRbacAuthorization
名前 | 説明 | 値 |
---|---|---|
authorizationType | 統合ランタイム共有の承認の種類。 | "RBAC" (必須) |
resourceId | 共有する統合ランタイムのリソース識別子。 | string (必須) |