Integration Runtimes - Get

サービス:: Synapse

API バージョン:: 2021-06-01

統合ランタイムを取得する
統合ランタイムを取得する

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}?api-version=2021-06-01

URI パラメーター

名前	/	必須	型	説明
integrationRuntimeName	path	True	string	統合ランタイム名
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
workspaceName	path	True	string	ワークスペースの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
If-None-Match		string	統合ランタイムエンティティの ETag。 get にのみ指定する必要があります。 ETag が既存のエンティティタグと一致する場合、または * が指定された場合、コンテンツは返されません。

応答

名前	型	説明
200 OK	IntegrationRuntimeResource	わかりました。
Other Status Codes		変更されていません。
Other Status Codes	ErrorResponse	GET 統合ランタイム操作から受信したエラー応答。

例

Get integration runtime

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationRuntimes/exampleIntegrationRuntime?api-version=2021-06-01

応答のサンプル

状態コード:: 200

Date: Mon, 22 Apr 2019 18:33:47 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 11997
x-ms-request-id: ad824326-e577-4a47-a092-2e621c4d59d9
x-ms-correlation-request-id: ad824326-e577-4a47-a092-2e621c4d59d9

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationruntimes/exampleIntegrationRuntime",
  "name": "exampleIntegrationRuntime",
  "type": "Microsoft.Synapse/workspaces/integrationruntimes",
  "properties": {
    "type": "SelfHosted",
    "description": "A selfhosted integration runtime"
  },
  "etag": "15003c4f-0000-0200-0000-5cbe090b0000"
}

状態コード:: 304

状態コード:: default

{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

定義

名前	説明
DataFlowComputeType	データフロージョブを実行するクラスターのコンピューティングの種類。
EntityReference	エンティティ参照。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
IntegrationRuntimeComputeProperties	マネージド統合ランタイムのコンピューティングリソースのプロパティ。
IntegrationRuntimeCustomerVirtualNetwork	Azure-SSIS 統合ランタイムが参加する仮想ネットワークの定義とプロパティ。
IntegrationRuntimeCustomSetupScriptProperties	マネージド専用統合ランタイムのカスタムセットアップスクリプトプロパティ。
IntegrationRuntimeDataFlowProperties	マネージド統合ランタイムのデータフロープロパティ。
IntegrationRuntimeDataProxyProperties	マネージド専用統合ランタイムのデータプロキシプロパティ。
IntegrationRuntimeEdition	SSIS 統合ランタイムのエディション
IntegrationRuntimeEntityReferenceType	この参照先エンティティの型。
IntegrationRuntimeLicenseType	ライセンスを持ち込むシナリオのライセンスの種類。
IntegrationRuntimeResource	統合ランタイムリソースの種類。
IntegrationRuntimeSsisCatalogInfo	マネージド専用統合ランタイムのカタログ情報。
IntegrationRuntimeSsisCatalogPricingTier	カタログデータベースの価格レベル。有効な値は、https://azure.microsoft.com/en-us/pricing/details/sql-database/
IntegrationRuntimeSsisProperties	マネージド統合ランタイムの SSIS プロパティ。
IntegrationRuntimeState	統合ランタイムの状態。
IntegrationRuntimeType	統合ランタイムの種類。
IntegrationRuntimeVNetProperties	マネージド統合ランタイムの VNet プロパティ。
LinkedIntegrationRuntimeKeyAuthorization	キー承認タイプ統合ランタイム。
LinkedIntegrationRuntimeRbacAuthorization	ロールベースのアクセス制御 (RBAC) 承認の種類の統合ランタイム。
ManagedIntegrationRuntime	マネージド統合ランタイム (マネージドエラスティックおよびマネージド専用統合ランタイムを含む)。
SecureString	Azure Synapse のセキュリティで保護された文字列定義。文字列値は、Get または List API 呼び出し中にアスタリスク '*' でマスクされます。
SelfHostedIntegrationRuntime	セルフホステッド統合ランタイム。

DataFlowComputeType

列挙

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

値	説明
General
MemoryOptimized
ComputeOptimized

EntityReference

Object

エンティティ参照。

名前	型	説明
referenceName	string	この参照先エンティティの名前。
type	IntegrationRuntimeEntityReferenceType	この参照先エンティティの型。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

IntegrationRuntimeComputeProperties

Object

マネージド統合ランタイムのコンピューティングリソースのプロパティ。

名前	型	説明
dataFlowProperties	IntegrationRuntimeDataFlowProperties	マネージド統合ランタイムのデータフロープロパティ。
location	string	マネージド統合ランタイムの場所。サポートされているリージョンは、https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities にあります
maxParallelExecutionsPerNode	integer (int32) minimum: 1	マネージド統合ランタイムのノードあたりの並列実行の最大数。
nodeSize	string	マネージド統合ランタイムのノードサイズ要件。
numberOfNodes	integer (int32) minimum: 1	マネージド統合ランタイムに必要なノード数。
vNetProperties	IntegrationRuntimeVNetProperties	マネージド統合ランタイムの VNet プロパティ。

IntegrationRuntimeCustomerVirtualNetwork

Object

Azure-SSIS 統合ランタイムが参加する仮想ネットワークの定義とプロパティ。

名前	型	説明
subnetId	string	Azure-SSIS 統合ランタイムが参加するサブネットの ID。

IntegrationRuntimeCustomSetupScriptProperties

Object

マネージド専用統合ランタイムのカスタムセットアップスクリプトプロパティ。

名前	型	説明
blobContainerUri	string	カスタムセットアップスクリプトを含む Azure BLOB コンテナーの URI。
sasToken	SecureString	Azure BLOB コンテナーの SAS トークン。

IntegrationRuntimeDataFlowProperties

Object

マネージド統合ランタイムのデータフロープロパティ。

名前	型	説明
computeType	DataFlowComputeType	データフロージョブを実行するクラスターのコンピューティングの種類。
coreCount	integer (int32)	データフロージョブを実行するクラスターのコア数。サポートされる値は、8、16、32、48、80、144、272 です。
timeToLive	integer (int32) minimum: 0	データフロージョブを実行するクラスターの Time to Live (分単位) 設定。

IntegrationRuntimeDataProxyProperties

Object

マネージド専用統合ランタイムのデータプロキシプロパティ。

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

IntegrationRuntimeEdition

列挙

SSIS 統合ランタイムのエディション

値	説明
Standard
Enterprise

IntegrationRuntimeEntityReferenceType

列挙

この参照先エンティティの型。

値	説明
IntegrationRuntimeReference
LinkedServiceReference

IntegrationRuntimeLicenseType

列挙

ライセンスを持ち込むシナリオのライセンスの種類。

値	説明
BasePrice
LicenseIncluded

IntegrationRuntimeResource

Object

統合ランタイムリソースの種類。

名前	型	説明
etag	string	リソース Etag。
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties	IntegrationRuntime: ManagedIntegrationRuntime SelfHostedIntegrationRuntime	統合ランタイムのプロパティ。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

IntegrationRuntimeSsisCatalogInfo

Object

マネージド専用統合ランタイムのカタログ情報。

名前	型	説明
catalogAdminPassword	SecureString	カタログデータベースの管理者ユーザーアカウントのパスワード。
catalogAdminUserName	string minLength: 1 maxLength: 128	カタログデータベースの管理者ユーザー名。
catalogPricingTier	IntegrationRuntimeSsisCatalogPricingTier	カタログデータベースの価格レベル。有効な値は、https://azure.microsoft.com/en-us/pricing/details/sql-database/
catalogServerEndpoint	string	カタログデータベースサーバーの URL。

IntegrationRuntimeSsisCatalogPricingTier

列挙

カタログデータベースの価格レベル。有効な値は、https://azure.microsoft.com/en-us/pricing/details/sql-database/

値	説明
Basic
Standard
Premium
PremiumRS

IntegrationRuntimeSsisProperties

Object

マネージド統合ランタイムの SSIS プロパティ。

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

IntegrationRuntimeState

列挙

統合ランタイムの状態。

値	説明
Initial
Stopped
Started
Starting
Stopping
NeedRegistration
Online
Limited
Offline
AccessDenied

IntegrationRuntimeType

列挙

統合ランタイムの種類。

値	説明
Managed
SelfHosted

IntegrationRuntimeVNetProperties

Object

マネージド統合ランタイムの VNet プロパティ。

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

LinkedIntegrationRuntimeKeyAuthorization

Object

キー承認タイプ統合ランタイム。

名前	型	説明
authorizationType	string: Key	統合ランタイム共有の承認の種類。
key	SecureString	承認に使用されるキー。

LinkedIntegrationRuntimeRbacAuthorization

Object

ロールベースのアクセス制御 (RBAC) 承認の種類の統合ランタイム。

名前	型	説明
authorizationType	string: RBAC	統合ランタイム共有の承認の種類。
resourceId	string	共有する統合ランタイムのリソース識別子。

ManagedIntegrationRuntime

Object

マネージド統合ランタイム (マネージドエラスティックおよびマネージド専用統合ランタイムを含む)。

名前	型	説明
description	string	統合ランタイムの説明。
managedVirtualNetwork.id	string	マネージド仮想ネットワークの ID。
managedVirtualNetwork.referenceName	string	マネージド仮想ネットワークの参照名
managedVirtualNetwork.type	string	マネージド仮想ネットワークの種類。
provisioningState	IntegrationRuntimeState	統合ランタイムの状態。マネージド専用統合ランタイムに対してのみ有効です。
type	string: Managed	統合ランタイムの種類。
typeProperties.computeProperties	IntegrationRuntimeComputeProperties	マネージド統合ランタイムのコンピューティングリソース。
typeProperties.customerVirtualNetwork	IntegrationRuntimeCustomerVirtualNetwork	Azure-SSIS 統合ランタイムが参加する仮想ネットワークの名前
typeProperties.ssisProperties	IntegrationRuntimeSsisProperties	マネージド統合ランタイムの SSIS プロパティ。

SecureString

Object

Azure Synapse のセキュリティで保護された文字列定義。文字列値は、Get または List API 呼び出し中にアスタリスク '*' でマスクされます。

名前	型	説明
type	string: SecureString	シークレットの種類。
value	string	セキュリティで保護された文字列の値。

SelfHostedIntegrationRuntime

Object

セルフホステッド統合ランタイム。

名前	型	説明
description	string	統合ランタイムの説明。
type	string: SelfHosted	統合ランタイムの種類。
typeProperties.linkedInfo	LinkedIntegrationRuntimeType: LinkedIntegrationRuntimeKeyAuthorization LinkedIntegrationRuntimeRbacAuthorization	データファクトリからのリンクされた統合ランタイムの種類