次の方法で共有


Microsoft。Synapse workspaces/integrationRuntimes

Bicepリソースの定義

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

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

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

リソース形式

Microsoftを作るために。Synapse/workspaces/integrationRuntimesリソースで、テンプレートに以下のBicepを追加してください。

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

SecretBase オブジェクト

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

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

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

LinkedIntegrationRuntimeType オブジェクト

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

[キー] には、次を使用します。

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

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

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

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'
  }
}

IntegrationRuntime オブジェクト

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

[ 管理対象] の場合は、次を使用します。

{
  managedVirtualNetwork: {
    id: 'string'
    referenceName: 'string'
    type: 'string'
  }
  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'
      }
    }
    customerVirtualNetwork: {
      subnetId: '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
    }
  }
}

プロパティ値

Microsoft。Synapse/workspaces/integrationRuntimes

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

詳細については、Child resource outside parent resourceをご覧ください。
タイプのリソースのシンボリック名: workspaces
properties Integration runtimeプロパティ。 IntegrationRuntime (必須)

CmdkeySetup

Name Description Value
カスタム セットアップの種類。 'CmdkeySetup' (必須)
typeProperties Cmdkey コマンドのカスタム セットアップの種類のプロパティ。 CmdkeySetupTypeProperties (必須)

CmdkeySetupTypeProperties

Name Description Value
パスワード データソースaccessのパスワード。 SecretBase (必須)
targetName データソースaccessのサーバー名。 any (必須)
userName データソースaccessのユーザー名。 any (必須)

ComponentSetup

Name Description Value
カスタム セットアップの種類。 'ComponentSetup' (必須)
typeProperties サード パーティ製コンポーネントの種類のプロパティをインストールします。 LicensedComponentSetupTypeProperties (必須)

CustomSetupBase

Name Description Value
CmdkeySetup 型の場合は 'CmdkeySetup' に設定します。 タイプ ComponentSetup を 'ComponentSetup' に設定します。 EnvironmentVariableSetup 型の 'EnvironmentVariableSetup' に設定します。 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (必須)

EntityReference

Name Description Value
referenceName この参照先エンティティの名前。 文字列
この参照先エンティティの型。 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Name Description Value
カスタム セットアップの種類。 'EnvironmentVariableSetup' (必須)
typeProperties 環境変数の型プロパティを追加します。 EnvironmentVariableSetupTypeProperties (必須)

EnvironmentVariableSetupTypeProperties

Name Description Value
variableName 環境変数の名前。 string (必須)
variableValue 環境変数の値。 string (必須)

IntegrationRuntime

Name Description Value
description Integration runtime の説明。 文字列
ManagedIntegrationRuntime 型を 'Managed' に設定します。 SelfHostedIntegrationRuntime 型の 'SelfHosted' に設定します。 'Managed'
'SelfHosted' (必須)

IntegrationRuntimeComputeProperties

Name Description Value
dataFlowProperties 管理されたintegration runtime用のData flowプロパティ。 IntegrationRuntimeDataFlowProperties
位置 管理された統合ランタイム(Managed integration runtime)の場所です。 サポートされているリージョンは /azure/data-factory/data-factory-data-movement-activities で見つけられます 文字列
maxParallelExecutionsPerNode マネージドintegration runtimeのノードあたりの最大並列実行数がカウントされます。 int

Constraints:
最小値 = 1
nodeSize マネージドintegration runtimeのノードサイズ要件。 文字列
numberOfNodes マネージドintegration runtimeに必要なノード数。 int

Constraints:
最小値 = 1
vNetProperties 管理されたintegration runtime用のVNetプロパティ。 IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomerVirtualNetwork

Name Description Value
subnetId Azure-SSIS統合ランタイムが参加するサブネットのIDです。 文字列

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri カスタムセットアップスクリプトを含むAzure BlobコンテナのURIです。 文字列
sasToken Azure BlobコンテナのSASトークンです。 SecureString

IntegrationRuntimeDataFlowProperties

Name Description Value
computeType data flowジョブを実行するクラスタの計算タイプ。 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount data flowジョブを実行するクラスタのコア数。 サポートされる値は、8、16、32、48、80、144、272 です。 int
timeToLive data flowジョブを実行するクラスタの設定で、ライフタイム(分単位)を設定します。 int

Constraints:
最小値 = 0

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia セルフホスト型integration runtime参照。 エンティティ参照
パス ステージ化されたデータをBlob storageに格納するパス。 文字列
stagingLinkedService ステージングのリンクされたサービス参照。 エンティティ参照

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword カタログ データベースの管理者ユーザー アカウントのパスワード。 SecureString
catalogAdminUserName カタログ データベースの管理者ユーザー名。 string

Constraints:
最小長 = 1
最大長 = 128
catalogPricingTier カタログ データベースの価格レベル。 有効な値はhttps://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint カタログ データベース サーバーの URL。 文字列

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo マネージド専用integration runtimeのカタログ情報。 IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties 管理型専用integration runtime用のカスタムスクリプトプロパティ。 IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties 管理された専用integration runtimeのためのData Proxyプロパティ。 IntegrationRuntimeDataProxyProperties
edition SSIS Integration Runtimeのエディション 'Enterprise'
'Standard'
expressCustomSetupProperties SSISのintegration runtime用にスクリプトプロパティを使わないカスタム設定。 CustomSetupBase[]
licenseType ライセンスを持ち込むシナリオのライセンスの種類。 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Name Description Value
publicIPs このintegration runtimeが使用するパブリックIPアドレスのリソースID。 string[]
サブネット このintegration runtimeが参加するサブネットの名前です。 文字列
subnetId このAzure-SSIS統合ランタイムが接続されるサブネットのIDです。 文字列
vNetId このintegration runtimeが参加するVNetのIDです。 文字列

LicensedComponentSetupTypeProperties

Name Description Value
componentName サード パーティコンポーネントの名前。 string (必須)
licenseKey コンポーネントをアクティブ化するためのライセンス キー。 SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Name Description Value
authorizationType integration runtime sharingの認可タイプ。 'Key' (必須)
キー 承認に使用されるキー。 SecureString (必須)

LinkedIntegrationRuntimeRbacAuthorization

Name Description Value
authorizationType integration runtime sharingの認可タイプ。 'RBAC' (必須)
resourceId 共有するintegration runtimeのリソース識別子。 string (必須)

LinkedIntegrationRuntimeType

Name Description Value
authorizationType LinkedIntegrationRuntimeKeyAuthorization 型を 'Key' に設定します。 LinkedIntegrationRuntimeRbacAuthorization 型の 'RBAC' に設定します。 'Key'
'RBAC' (必須)

ManagedIntegrationRuntime

Name Description Value
managedVirtualNetwork マネージド・インテグレーション・ランタイム(Managed integration runtime)マネージド・virtual network。 ManagedIntegrationRuntimeManagedVirtualNetworkReference
integration runtimeの種類。 「管理対象」(必須)
typeProperties 管理されたintegration runtimeプロパティ。 ManagedIntegrationRuntimeTypeProperties (必須)

ManagedIntegrationRuntimeManagedVirtualNetworkReference

Name Description Value
id 管理されているvirtual networkのid。 文字列
referenceName 管理型virtual networkの参照名 文字列
管理型のvirtual networkの種類。 文字列

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties 管理されたintegration runtimeの計算リソースです。 IntegrationRuntimeComputeProperties
customerVirtualNetwork Azure-SSIS統合ランタイムが接続される仮想ネットワークの名前 IntegrationRuntimeCustomerVirtualNetwork
ssisProperties 管理されたintegration runtime用のSSISプロパティ。 IntegrationRuntimeSsisProperties

SecretBase

Name Description Value
SecureString 型の場合は 'SecureString' に設定します。 'SecureString' (必須)

SecureString

Name Description Value
シークレットの種類。 string (必須)
value セキュリティで保護された文字列の値。 string (必須)

SecureString

Name Description Value
シークレットの種類。 'SecureString' (必須)
value セキュリティで保護された文字列の値。 string (必須)

SelfHostedIntegrationRuntime

Name Description Value
integration runtimeの種類。 'SelfHosted' (必須)
typeProperties この性質がnullでない場合、それはリンクされたintegration runtimeであることを意味します。 この物件は元のintegration runtime accessに使用されています。 SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo Data FactoryのLinked integration runtime型 LinkedIntegrationRuntimeType

使用例

Bicep サンプル

Synapse Azure Integration Runtimeの基本的な例です。

param resourceName string = 'acctest0001'
param location string = 'westeurope'
@description('The SQL administrator login for the Synapse workspace')
param sqlAdministratorLogin string
@secure()
@description('The SQL administrator login password for the Synapse workspace')
param sqlAdministratorLoginPassword string

resource blobService 'Microsoft.Storage/storageAccounts/blobServices@2022-09-01' existing = {
  parent: storageAccount
  name: 'default'
}

resource storageAccount 'Microsoft.Storage/storageAccounts@2021-09-01' = {
  name: resourceName
  location: location
  kind: 'StorageV2'
  properties: {}
  sku: {
    name: 'Standard_LRS'
  }
}

resource workspace 'Microsoft.Synapse/workspaces@2021-06-01' = {
  name: resourceName
  location: location
  properties: {
    defaultDataLakeStorage: {
      accountUrl: storageAccount.properties.primaryEndpoints.dfs
      filesystem: container.name
    }

    managedVirtualNetwork: 'default'
    publicNetworkAccess: 'Enabled'
    sqlAdministratorLogin: sqlAdministratorLogin
    sqlAdministratorLoginPassword: sqlAdministratorLoginPassword
  }
}

resource integrationRuntime 'Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01-preview' = {
  parent: workspace
  name: resourceName
  properties: {
    description: 'test'
    type: 'SelfHosted'
  }
}

resource container 'Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01' = {
  parent: blobService
  name: resourceName
  properties: {
    metadata: {
      key: 'value'
    }
  }
}

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

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

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

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

リソース形式

Microsoftを作るために。Synapse/workspaces/integrationRuntimes リソースで、テンプレートに以下のJSONを追加してください。

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

SecretBase オブジェクト

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

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

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

LinkedIntegrationRuntimeType オブジェクト

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

[キー] には、次を使用します。

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

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

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

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"
  }
}

IntegrationRuntime オブジェクト

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

[ 管理対象] の場合は、次を使用します。

{
  "managedVirtualNetwork": {
    "id": "string",
    "referenceName": "string",
    "type": "string"
  },
  "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"
      }
    },
    "customerVirtualNetwork": {
      "subnetId": "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
    }
  }
}

プロパティ値

Microsoft。Synapse/workspaces/integrationRuntimes

Name Description Value
apiVersion API のバージョン '2021-06-01'
name リソース名 string (必須)
properties Integration runtimeプロパティ。 IntegrationRuntime (必須)
リソースの種類 「Microsoft。Synapse/workspaces/integrationRuntimes'

CmdkeySetup

Name Description Value
カスタム セットアップの種類。 'CmdkeySetup' (必須)
typeProperties Cmdkey コマンドのカスタム セットアップの種類のプロパティ。 CmdkeySetupTypeProperties (必須)

CmdkeySetupTypeProperties

Name Description Value
パスワード データソースaccessのパスワード。 SecretBase (必須)
targetName データソースaccessのサーバー名。 any (必須)
userName データソースaccessのユーザー名。 any (必須)

ComponentSetup

Name Description Value
カスタム セットアップの種類。 'ComponentSetup' (必須)
typeProperties サード パーティ製コンポーネントの種類のプロパティをインストールします。 LicensedComponentSetupTypeProperties (必須)

CustomSetupBase

Name Description Value
CmdkeySetup 型の場合は 'CmdkeySetup' に設定します。 タイプ ComponentSetup を 'ComponentSetup' に設定します。 EnvironmentVariableSetup 型の 'EnvironmentVariableSetup' に設定します。 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (必須)

EntityReference

Name Description Value
referenceName この参照先エンティティの名前。 文字列
この参照先エンティティの型。 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Name Description Value
カスタム セットアップの種類。 'EnvironmentVariableSetup' (必須)
typeProperties 環境変数の型プロパティを追加します。 EnvironmentVariableSetupTypeProperties (必須)

EnvironmentVariableSetupTypeProperties

Name Description Value
variableName 環境変数の名前。 string (必須)
variableValue 環境変数の値。 string (必須)

IntegrationRuntime

Name Description Value
description Integration runtime の説明。 文字列
ManagedIntegrationRuntime 型を 'Managed' に設定します。 SelfHostedIntegrationRuntime 型の 'SelfHosted' に設定します。 'Managed'
'SelfHosted' (必須)

IntegrationRuntimeComputeProperties

Name Description Value
dataFlowProperties 管理されたintegration runtime用のData flowプロパティ。 IntegrationRuntimeDataFlowProperties
位置 管理された統合ランタイム(Managed integration runtime)の場所です。 サポートされているリージョンは /azure/data-factory/data-factory-data-movement-activities で見つけられます 文字列
maxParallelExecutionsPerNode マネージドintegration runtimeのノードあたりの最大並列実行数がカウントされます。 int

Constraints:
最小値 = 1
nodeSize マネージドintegration runtimeのノードサイズ要件。 文字列
numberOfNodes マネージドintegration runtimeに必要なノード数。 int

Constraints:
最小値 = 1
vNetProperties 管理されたintegration runtime用のVNetプロパティ。 IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomerVirtualNetwork

Name Description Value
subnetId Azure-SSIS統合ランタイムが参加するサブネットのIDです。 文字列

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri カスタムセットアップスクリプトを含むAzure BlobコンテナのURIです。 文字列
sasToken Azure BlobコンテナのSASトークンです。 SecureString

IntegrationRuntimeDataFlowProperties

Name Description Value
computeType data flowジョブを実行するクラスタの計算タイプ。 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount data flowジョブを実行するクラスタのコア数。 サポートされる値は、8、16、32、48、80、144、272 です。 int
timeToLive data flowジョブを実行するクラスタの設定で、ライフタイム(分単位)を設定します。 int

Constraints:
最小値 = 0

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia セルフホスト型integration runtime参照。 エンティティ参照
パス ステージ化されたデータをBlob storageに格納するパス。 文字列
stagingLinkedService ステージングのリンクされたサービス参照。 エンティティ参照

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword カタログ データベースの管理者ユーザー アカウントのパスワード。 SecureString
catalogAdminUserName カタログ データベースの管理者ユーザー名。 string

Constraints:
最小長 = 1
最大長 = 128
catalogPricingTier カタログ データベースの価格レベル。 有効な値はhttps://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint カタログ データベース サーバーの URL。 文字列

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo マネージド専用integration runtimeのカタログ情報。 IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties 管理型専用integration runtime用のカスタムスクリプトプロパティ。 IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties 管理された専用integration runtimeのためのData Proxyプロパティ。 IntegrationRuntimeDataProxyProperties
edition SSIS Integration Runtimeのエディション 'Enterprise'
'Standard'
expressCustomSetupProperties SSISのintegration runtime用にスクリプトプロパティを使わないカスタム設定。 CustomSetupBase[]
licenseType ライセンスを持ち込むシナリオのライセンスの種類。 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Name Description Value
publicIPs このintegration runtimeが使用するパブリックIPアドレスのリソースID。 string[]
サブネット このintegration runtimeが参加するサブネットの名前です。 文字列
subnetId このAzure-SSIS統合ランタイムが接続されるサブネットのIDです。 文字列
vNetId このintegration runtimeが参加するVNetのIDです。 文字列

LicensedComponentSetupTypeProperties

Name Description Value
componentName サード パーティコンポーネントの名前。 string (必須)
licenseKey コンポーネントをアクティブ化するためのライセンス キー。 SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Name Description Value
authorizationType integration runtime sharingの認可タイプ。 'Key' (必須)
キー 承認に使用されるキー。 SecureString (必須)

LinkedIntegrationRuntimeRbacAuthorization

Name Description Value
authorizationType integration runtime sharingの認可タイプ。 'RBAC' (必須)
resourceId 共有するintegration runtimeのリソース識別子。 string (必須)

LinkedIntegrationRuntimeType

Name Description Value
authorizationType LinkedIntegrationRuntimeKeyAuthorization 型を 'Key' に設定します。 LinkedIntegrationRuntimeRbacAuthorization 型の 'RBAC' に設定します。 'Key'
'RBAC' (必須)

ManagedIntegrationRuntime

Name Description Value
managedVirtualNetwork マネージド・インテグレーション・ランタイム(Managed integration runtime)マネージド・virtual network。 ManagedIntegrationRuntimeManagedVirtualNetworkReference
integration runtimeの種類。 「管理対象」(必須)
typeProperties 管理されたintegration runtimeプロパティ。 ManagedIntegrationRuntimeTypeProperties (必須)

ManagedIntegrationRuntimeManagedVirtualNetworkReference

Name Description Value
id 管理されているvirtual networkのid。 文字列
referenceName 管理型virtual networkの参照名 文字列
管理型のvirtual networkの種類。 文字列

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties 管理されたintegration runtimeの計算リソースです。 IntegrationRuntimeComputeProperties
customerVirtualNetwork Azure-SSIS統合ランタイムが接続される仮想ネットワークの名前 IntegrationRuntimeCustomerVirtualNetwork
ssisProperties 管理されたintegration runtime用のSSISプロパティ。 IntegrationRuntimeSsisProperties

SecretBase

Name Description Value
SecureString 型の場合は 'SecureString' に設定します。 'SecureString' (必須)

SecureString

Name Description Value
シークレットの種類。 string (必須)
value セキュリティで保護された文字列の値。 string (必須)

SecureString

Name Description Value
シークレットの種類。 'SecureString' (必須)
value セキュリティで保護された文字列の値。 string (必須)

SelfHostedIntegrationRuntime

Name Description Value
integration runtimeの種類。 'SelfHosted' (必須)
typeProperties この性質がnullでない場合、それはリンクされたintegration runtimeであることを意味します。 この物件は元のintegration runtime accessに使用されています。 SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo Data FactoryのLinked integration runtime型 LinkedIntegrationRuntimeType

使用例

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

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

  • リソース グループ

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

リソース形式

Microsoftを作るために。Synapse/workspaces/integrationRuntimesリソースで、以下のTerraformをテンプレートに追加してください。

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

SecretBase オブジェクト

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

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

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

LinkedIntegrationRuntimeType オブジェクト

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

[キー] には、次を使用します。

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

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

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

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"
  }
}

IntegrationRuntime オブジェクト

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

[ 管理対象] の場合は、次を使用します。

{
  managedVirtualNetwork = {
    id = "string"
    referenceName = "string"
    type = "string"
  }
  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"
      }
    }
    customerVirtualNetwork = {
      subnetId = "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
    }
  }
}

プロパティ値

Microsoft。Synapse/workspaces/integrationRuntimes

Name Description Value
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 タイプ: workspaces のリソースの ID
properties Integration runtimeプロパティ。 IntegrationRuntime (必須)
リソースの種類 「Microsoft。Synapse/workspaces/integrationRuntimes@2021-06-01"

CmdkeySetup

Name Description Value
カスタム セットアップの種類。 'CmdkeySetup' (必須)
typeProperties Cmdkey コマンドのカスタム セットアップの種類のプロパティ。 CmdkeySetupTypeProperties (必須)

CmdkeySetupTypeProperties

Name Description Value
パスワード データソースaccessのパスワード。 SecretBase (必須)
targetName データソースaccessのサーバー名。 any (必須)
userName データソースaccessのユーザー名。 any (必須)

ComponentSetup

Name Description Value
カスタム セットアップの種類。 'ComponentSetup' (必須)
typeProperties サード パーティ製コンポーネントの種類のプロパティをインストールします。 LicensedComponentSetupTypeProperties (必須)

CustomSetupBase

Name Description Value
CmdkeySetup 型の場合は 'CmdkeySetup' に設定します。 タイプ ComponentSetup を 'ComponentSetup' に設定します。 EnvironmentVariableSetup 型の 'EnvironmentVariableSetup' に設定します。 'CmdkeySetup'
'ComponentSetup'
'EnvironmentVariableSetup' (必須)

EntityReference

Name Description Value
referenceName この参照先エンティティの名前。 文字列
この参照先エンティティの型。 'IntegrationRuntimeReference'
'LinkedServiceReference'

EnvironmentVariableSetup

Name Description Value
カスタム セットアップの種類。 'EnvironmentVariableSetup' (必須)
typeProperties 環境変数の型プロパティを追加します。 EnvironmentVariableSetupTypeProperties (必須)

EnvironmentVariableSetupTypeProperties

Name Description Value
variableName 環境変数の名前。 string (必須)
variableValue 環境変数の値。 string (必須)

IntegrationRuntime

Name Description Value
description Integration runtime の説明。 文字列
ManagedIntegrationRuntime 型を 'Managed' に設定します。 SelfHostedIntegrationRuntime 型の 'SelfHosted' に設定します。 'Managed'
'SelfHosted' (必須)

IntegrationRuntimeComputeProperties

Name Description Value
dataFlowProperties 管理されたintegration runtime用のData flowプロパティ。 IntegrationRuntimeDataFlowProperties
位置 管理された統合ランタイム(Managed integration runtime)の場所です。 サポートされているリージョンは /azure/data-factory/data-factory-data-movement-activities で見つけられます 文字列
maxParallelExecutionsPerNode マネージドintegration runtimeのノードあたりの最大並列実行数がカウントされます。 int

Constraints:
最小値 = 1
nodeSize マネージドintegration runtimeのノードサイズ要件。 文字列
numberOfNodes マネージドintegration runtimeに必要なノード数。 int

Constraints:
最小値 = 1
vNetProperties 管理されたintegration runtime用のVNetプロパティ。 IntegrationRuntimeVNetProperties

IntegrationRuntimeCustomerVirtualNetwork

Name Description Value
subnetId Azure-SSIS統合ランタイムが参加するサブネットのIDです。 文字列

IntegrationRuntimeCustomSetupScriptProperties

Name Description Value
blobContainerUri カスタムセットアップスクリプトを含むAzure BlobコンテナのURIです。 文字列
sasToken Azure BlobコンテナのSASトークンです。 SecureString

IntegrationRuntimeDataFlowProperties

Name Description Value
computeType data flowジョブを実行するクラスタの計算タイプ。 'ComputeOptimized'
'General'
'MemoryOptimized'
coreCount data flowジョブを実行するクラスタのコア数。 サポートされる値は、8、16、32、48、80、144、272 です。 int
timeToLive data flowジョブを実行するクラスタの設定で、ライフタイム(分単位)を設定します。 int

Constraints:
最小値 = 0

IntegrationRuntimeDataProxyProperties

Name Description Value
connectVia セルフホスト型integration runtime参照。 エンティティ参照
パス ステージ化されたデータをBlob storageに格納するパス。 文字列
stagingLinkedService ステージングのリンクされたサービス参照。 エンティティ参照

IntegrationRuntimeSsisCatalogInfo

Name Description Value
catalogAdminPassword カタログ データベースの管理者ユーザー アカウントのパスワード。 SecureString
catalogAdminUserName カタログ データベースの管理者ユーザー名。 string

Constraints:
最小長 = 1
最大長 = 128
catalogPricingTier カタログ データベースの価格レベル。 有効な値はhttps://azure.microsoft.com/pricing/details/sql-database/ 'Basic'
'Premium'
'PremiumRS'
'Standard'
catalogServerEndpoint カタログ データベース サーバーの URL。 文字列

IntegrationRuntimeSsisProperties

Name Description Value
catalogInfo マネージド専用integration runtimeのカタログ情報。 IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties 管理型専用integration runtime用のカスタムスクリプトプロパティ。 IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties 管理された専用integration runtimeのためのData Proxyプロパティ。 IntegrationRuntimeDataProxyProperties
edition SSIS Integration Runtimeのエディション 'Enterprise'
'Standard'
expressCustomSetupProperties SSISのintegration runtime用にスクリプトプロパティを使わないカスタム設定。 CustomSetupBase[]
licenseType ライセンスを持ち込むシナリオのライセンスの種類。 'BasePrice'
'LicenseIncluded'

IntegrationRuntimeVNetProperties

Name Description Value
publicIPs このintegration runtimeが使用するパブリックIPアドレスのリソースID。 string[]
サブネット このintegration runtimeが参加するサブネットの名前です。 文字列
subnetId このAzure-SSIS統合ランタイムが接続されるサブネットのIDです。 文字列
vNetId このintegration runtimeが参加するVNetのIDです。 文字列

LicensedComponentSetupTypeProperties

Name Description Value
componentName サード パーティコンポーネントの名前。 string (必須)
licenseKey コンポーネントをアクティブ化するためのライセンス キー。 SecretBase

LinkedIntegrationRuntimeKeyAuthorization

Name Description Value
authorizationType integration runtime sharingの認可タイプ。 'Key' (必須)
キー 承認に使用されるキー。 SecureString (必須)

LinkedIntegrationRuntimeRbacAuthorization

Name Description Value
authorizationType integration runtime sharingの認可タイプ。 'RBAC' (必須)
resourceId 共有するintegration runtimeのリソース識別子。 string (必須)

LinkedIntegrationRuntimeType

Name Description Value
authorizationType LinkedIntegrationRuntimeKeyAuthorization 型を 'Key' に設定します。 LinkedIntegrationRuntimeRbacAuthorization 型の 'RBAC' に設定します。 'Key'
'RBAC' (必須)

ManagedIntegrationRuntime

Name Description Value
managedVirtualNetwork マネージド・インテグレーション・ランタイム(Managed integration runtime)マネージド・virtual network。 ManagedIntegrationRuntimeManagedVirtualNetworkReference
integration runtimeの種類。 「管理対象」(必須)
typeProperties 管理されたintegration runtimeプロパティ。 ManagedIntegrationRuntimeTypeProperties (必須)

ManagedIntegrationRuntimeManagedVirtualNetworkReference

Name Description Value
id 管理されているvirtual networkのid。 文字列
referenceName 管理型virtual networkの参照名 文字列
管理型のvirtual networkの種類。 文字列

ManagedIntegrationRuntimeTypeProperties

Name Description Value
computeProperties 管理されたintegration runtimeの計算リソースです。 IntegrationRuntimeComputeProperties
customerVirtualNetwork Azure-SSIS統合ランタイムが接続される仮想ネットワークの名前 IntegrationRuntimeCustomerVirtualNetwork
ssisProperties 管理されたintegration runtime用のSSISプロパティ。 IntegrationRuntimeSsisProperties

SecretBase

Name Description Value
SecureString 型の場合は 'SecureString' に設定します。 'SecureString' (必須)

SecureString

Name Description Value
シークレットの種類。 string (必須)
value セキュリティで保護された文字列の値。 string (必須)

SecureString

Name Description Value
シークレットの種類。 'SecureString' (必須)
value セキュリティで保護された文字列の値。 string (必須)

SelfHostedIntegrationRuntime

Name Description Value
integration runtimeの種類。 'SelfHosted' (必須)
typeProperties この性質がnullでない場合、それはリンクされたintegration runtimeであることを意味します。 この物件は元のintegration runtime accessに使用されています。 SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Name Description Value
linkedInfo Data FactoryのLinked integration runtime型 LinkedIntegrationRuntimeType

使用例

Terraformサンプル

Synapse Azure Integration Runtimeの基本的な例です。

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

variable "sql_administrator_login" {
  type        = string
  description = "The SQL administrator login for the Synapse workspace"
}

variable "sql_administrator_login_password" {
  type        = string
  description = "The SQL administrator login password for the Synapse workspace"
  sensitive   = true
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "StorageV2"
    properties = {
    }
    sku = {
      name = "Standard_LRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azapi_resource_action" "listKeys" {
  type                   = "Microsoft.Storage/storageAccounts@2022-09-01"
  resource_id            = azapi_resource.storageAccount.id
  action                 = "listKeys"
  response_export_values = ["*"]
}

data "azapi_resource" "blobService" {
  type      = "Microsoft.Storage/storageAccounts/blobServices@2022-09-01"
  parent_id = azapi_resource.storageAccount.id
  name      = "default"
}

resource "azapi_resource" "container" {
  type      = "Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01"
  name      = var.resource_name
  parent_id = data.azapi_resource.blobService.id
  body = {
    properties = {
      metadata = {
        key = "value"
      }
    }
  }
  response_export_values = ["*"]
}

resource "azapi_resource" "workspace" {
  type      = "Microsoft.Synapse/workspaces@2021-06-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    properties = {
      defaultDataLakeStorage = {
        accountUrl = azapi_resource.storageAccount.output.properties.primaryEndpoints.dfs
        filesystem = azapi_resource.container.name
      }

      managedVirtualNetwork         = "default"
      publicNetworkAccess           = "Enabled"
      sqlAdministratorLogin         = var.sql_administrator_login
      sqlAdministratorLoginPassword = var.sql_administrator_login_password
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "integrationRuntime" {
  type      = "Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01-preview"
  parent_id = azapi_resource.workspace.id
  name      = var.resource_name
  body = {
    properties = {
      description = "test"
      type        = "SelfHosted"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}