Microsoft.Synapse workspaces/integrationRuntimes

[アーティクル]
12/17/2024

Bicep リソース定義

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

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

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

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

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(Azure.Bicep.Types.Concrete.AnyType)
    userName: any(Azure.Bicep.Types.Concrete.AnyType)
  }
}

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

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

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

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

プロパティ値

CmdkeySetup

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

CmdkeySetupTypeProperties

名前	形容	価値
パスワード	データソースアクセスのパスワード。	SecretBase (必須)
targetName	データソースアクセスのサーバー名。	any (必須)
userName	データソースアクセスのユーザー名。	any (必須)

ComponentSetup

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

CustomSetupBase

名前	形容	価値
種類	CmdkeySetupの種類 'CmdkeySetup' に設定します。 ComponentSetupの型 'ComponentSetup' に設定します。 EnvironmentVariableSetupの種類 "EnvironmentVariableSetup" に設定します。	'CmdkeySetup' 'ComponentSetup' 'EnvironmentVariableSetup' (必須)

EntityReference

名前	形容	価値
referenceName	この参照先エンティティの名前。	糸
種類	この参照先エンティティの型。	'IntegrationRuntimeReference' 'LinkedServiceReference'

EnvironmentVariableSetup

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

EnvironmentVariableSetupTypeProperties

名前	形容	価値
variableName	環境変数の名前。	string (必須)
variableValue	環境変数の値。	string (必須)

IntegrationRuntime

名前	形容	価値
形容	統合ランタイムの説明。	糸
種類	ManagedIntegrationRuntime型 'Managed' に設定します。 SelfHostedIntegrationRuntimeの型 'SelfHosted' に設定します。	'Managed' 'SelfHosted' (必須)

IntegrationRuntimeComputeProperties

名前	形容	価値
dataFlowProperties	マネージド統合ランタイムのデータフロープロパティ。	IntegrationRuntimeDataFlowProperties の
場所	マネージド統合ランタイムの場所。サポートされているリージョンは、/azure/data-factory/data-factory-data-movement-activities にあります。	糸
maxParallelExecutionsPerNode	マネージド統合ランタイムのノードあたりの並列実行の最大数。	int 制約：最小値 = 1
nodeSize	マネージド統合ランタイムのノードサイズ要件。	糸
numberOfNodes	マネージド統合ランタイムに必要なノード数。	int 制約：最小値 = 1
vNetProperties	マネージド統合ランタイムの VNet プロパティ。	IntegrationRuntimeVNetProperties の

IntegrationRuntimeCustomerVirtualNetwork

名前	形容	価値
subnetId	Azure-SSIS 統合ランタイムが参加するサブネットの ID。	糸

IntegrationRuntimeCustomSetupScriptProperties

名前	形容	価値
blobContainerUri	カスタムセットアップスクリプトを含む Azure BLOB コンテナーの URI。	糸
sasToken	Azure BLOB コンテナーの SAS トークン。	SecureString の

IntegrationRuntimeDataFlowProperties

名前	形容	価値
computeType	データフロージョブを実行するクラスターのコンピューティングの種類。	'ComputeOptimized' 'General' 'MemoryOptimized'
coreCount	データフロージョブを実行するクラスターのコア数。サポートされる値は、8、16、32、48、80、144、272 です。	int
timeToLive	データフロージョブを実行するクラスターの Time to Live (分単位) 設定。	int 制約：最小値 = 0

IntegrationRuntimeDataProxyProperties

名前	形容	価値
connectVia	セルフホステッド統合ランタイムリファレンス。	EntityReference
パス	BLOB ストレージにステージングデータを格納するパス。	糸
stagingLinkedService	ステージングのリンクされたサービス参照。	EntityReference

IntegrationRuntimeSsisCatalogInfo

名前	形容	価値
catalogAdminPassword	カタログデータベースの管理者ユーザーアカウントのパスワード。	SecureString の
catalogAdminUserName	カタログデータベースの管理者ユーザー名。	糸制約：最小長 = 1 最大長 = 1
catalogPricingTier	カタログデータベースの価格レベル。有効な値は、https://azure.microsoft.com/en-us/pricing/details/sql-database/	'Basic' 'Premium' 'PremiumRS' 'Standard'
catalogServerEndpoint	カタログデータベースサーバーの URL。	糸

IntegrationRuntimeSsisProperties

名前	形容	価値
catalogInfo	マネージド専用統合ランタイムのカタログ情報。	IntegrationRuntimeSsisCatalogInfo の
customSetupScriptProperties	マネージド専用統合ランタイムのカスタムセットアップスクリプトプロパティ。	IntegrationRuntimeCustomSetupScriptProperties の
dataProxyProperties	マネージド専用統合ランタイムのデータプロキシプロパティ。	IntegrationRuntimeDataProxyProperties の
版	SSIS 統合ランタイムのエディション	'Enterprise' 'Standard'
expressCustomSetupProperties	SSIS 統合ランタイムのスクリプトプロパティを使用しないカスタムセットアップ。	CustomSetupBase[]
licenseType	ライセンスを持ち込むシナリオのライセンスの種類。	'BasePrice' 'LicenseIncluded'

IntegrationRuntimeVNetProperties

名前	形容	価値
publicIPs	この統合ランタイムが使用するパブリック IP アドレスのリソース ID。	string[]
サブネット	この統合ランタイムが参加するサブネットの名前。	糸
subnetId	この Azure-SSIS 統合ランタイムが参加するサブネットの ID。	糸
vNetId	この統合ランタイムが参加する VNet の ID。	糸

LicensedComponentSetupTypeProperties

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

LinkedIntegrationRuntimeKeyAuthorization

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

LinkedIntegrationRuntimeRbacAuthorization

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

LinkedIntegrationRuntimeType

名前	形容	価値
authorizationType	LinkedIntegrationRuntimeKeyAuthorizationの型 'Key' に設定します。 LinkedIntegrationRuntimeRbacAuthorization種類として 'RBAC' に設定します。	'Key' 'RBAC' (必須)

ManagedIntegrationRuntime

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

ManagedIntegrationRuntimeManagedVirtualNetworkReference

名前	形容	価値
身分証明書	マネージド仮想ネットワークの ID。	糸
referenceName	マネージド仮想ネットワークの参照名	糸
種類	マネージド仮想ネットワークの種類。	糸

ManagedIntegrationRuntimeTypeProperties

名前	形容	価値
computeProperties	マネージド統合ランタイムのコンピューティングリソース。	IntegrationRuntimeComputeProperties の
customerVirtualNetwork	Azure-SSIS 統合ランタイムが参加する仮想ネットワークの名前	IntegrationRuntimeCustomerVirtualNetwork の
ssisProperties	マネージド統合ランタイムの SSIS プロパティ。	IntegrationRuntimeSsisProperties の