Integration Runtimes - Start

サービス:: Synapse

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

統合ランタイムを開始する
統合ランタイムを開始する

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/start?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 バージョン。

応答

名前	型	説明
200 OK	IntegrationRuntimeStatusResponse	わかりました。
202 Accepted		受け入れられる。
Other Status Codes	ErrorResponse	Azure Synapse サービスから受信したエラー応答。

例

Start integration runtime

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

Date: Wed, 13 Jun 2018 21:33:00 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14912
x-ms-request-id: 2af47f9f-5625-4b01-a3a5-bccb576a4677
x-ms-correlation-request-id: 2af47f9f-5625-4b01-a3a5-bccb576a4677

{
  "name": "exampleManagedIntegrationRuntime",
  "properties": {
    "dataFactoryName": "exampleWorkspaceName",
    "type": "Managed",
    "state": "Started",
    "typeProperties": {
      "nodes": [],
      "otherErrors": [],
      "createTime": "2018-06-13T21:11:01.8695494Z"
    }
  }
}

状態コード:: 202

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
IntegrationRuntimeAutoUpdate	統合ランタイムの自動更新の状態。
IntegrationRuntimeInternalChannelEncryptionMode	ノードノード通信チャネルの暗号化モードを設定するために使用されます (2 つ以上のセルフホステッド統合ランタイムノードが存在する場合)。
IntegrationRuntimeState	統合ランタイムの状態。
IntegrationRuntimeStatusResponse	統合ランタイムの状態の応答。
IntegrationRuntimeType	統合ランタイムの種類。
IntegrationRuntimeUpdateResult	最後の統合ランタイムノード更新の結果。
LinkedIntegrationRuntime	リンクされた統合ランタイム情報。
ManagedIntegrationRuntimeError	マネージド統合ランタイムのエラー定義。
ManagedIntegrationRuntimeNode	統合ランタイムノードのプロパティ。
ManagedIntegrationRuntimeNodeStatus	マネージド統合ランタイムノードの状態。
ManagedIntegrationRuntimeOperationResult	マネージド統合ランタイム操作の結果のプロパティ。
ManagedIntegrationRuntimeStatus	マネージド統合ランタイムの状態。
SelfHostedIntegrationRuntimeNode	セルフホステッド統合ランタイムノードのプロパティ。
SelfHostedIntegrationRuntimeNodeStatus	統合ランタイムノードの状態。
SelfHostedIntegrationRuntimeStatus	セルフホステッド統合ランタイムの状態。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

IntegrationRuntimeAutoUpdate

列挙

統合ランタイムの自動更新の状態。

値	説明
On
Off

IntegrationRuntimeInternalChannelEncryptionMode

列挙

ノードノード通信チャネルの暗号化モードを設定するために使用されます (2 つ以上のセルフホステッド統合ランタイムノードが存在する場合)。

値	説明
NotSet
SslEncrypted
NotEncrypted

IntegrationRuntimeState

列挙

統合ランタイムの状態。

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

IntegrationRuntimeStatusResponse

Object

統合ランタイムの状態の応答。

名前	型	説明
name	string	統合ランタイム名。
properties	IntegrationRuntimeStatus: ManagedIntegrationRuntimeStatus SelfHostedIntegrationRuntimeStatus	統合ランタイムのプロパティ。

IntegrationRuntimeType

列挙

統合ランタイムの種類。

値	説明
Managed
SelfHosted

IntegrationRuntimeUpdateResult

列挙

最後の統合ランタイムノード更新の結果。

値	説明
None
Succeed
Fail

LinkedIntegrationRuntime

Object

リンクされた統合ランタイム情報。

名前	型	説明
createTime	string (date-time)	リンクされた統合ランタイムの作成時刻。
dataFactoryLocation	string	リンクされた統合ランタイムが属するワークスペースの場所。
dataFactoryName	string	リンクされた統合ランタイムが属するワークスペースの名前。
name	string	リンクされた統合ランタイムの名前。
subscriptionId	string	リンクされた統合ランタイムが属するサブスクリプション ID。

ManagedIntegrationRuntimeError

Object

マネージド統合ランタイムのエラー定義。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。
parameters	string[]	マネージド統合ランタイムのエラーパラメーター。
time	string (date-time)	エラーが発生した時刻。

ManagedIntegrationRuntimeNode

Object

統合ランタイムノードのプロパティ。

名前	型	説明
errors	ManagedIntegrationRuntimeError[]	この統合ランタイムノードで発生したエラー。
nodeId	string	マネージド統合ランタイムノード ID。
status	ManagedIntegrationRuntimeNodeStatus	マネージド統合ランタイムノードの状態。

ManagedIntegrationRuntimeNodeStatus

列挙

マネージド統合ランタイムノードの状態。

値	説明
Starting
Available
Recycling
Unavailable

ManagedIntegrationRuntimeOperationResult

Object

マネージド統合ランタイム操作の結果のプロパティ。

名前	型	説明
activityId	string	操作要求のアクティビティ ID。
errorCode	string	エラーコード。
parameters	string[]	マネージド統合ランタイムのエラーパラメーター。
result	string	操作の結果。
startTime	string (date-time)	操作の開始時刻。
type	string	操作の種類。開始または停止できます。

ManagedIntegrationRuntimeStatus

Object

マネージド統合ランタイムの状態。

名前	型	説明
dataFactoryName	string	統合ランタイムが属するワークスペース名。
state	IntegrationRuntimeState	統合ランタイムの状態。
type	string: Managed	統合ランタイムの種類。
typeProperties.createTime	string (date-time)	統合ランタイムが作成された時刻 (ISO8601形式)。
typeProperties.lastOperation	ManagedIntegrationRuntimeOperationResult	この統合ランタイムで発生した最後の操作の結果。
typeProperties.nodes	ManagedIntegrationRuntimeNode[]	マネージド統合ランタイムのノードの一覧。
typeProperties.otherErrors	ManagedIntegrationRuntimeError[]	この統合ランタイムで発生したエラー。

SelfHostedIntegrationRuntimeNode

Object

セルフホステッド統合ランタイムノードのプロパティ。

名前	型	説明
capabilities	object	統合ランタイム機能ディクショナリ
concurrentJobsLimit	integer (int32)	統合ランタイムノードでの最大同時実行ジョブ数。
expiryTime	string (date-time)	統合ランタイムがISO8601形式で期限切れになる時刻。
hostServiceUri	string	統合ランタイムのホストマシンの URI。
isActiveDispatcher	boolean	このノードが統合ランタイム要求のアクティブディスパッチャーであるかどうかを示します。
lastConnectTime	string (date-time)	統合ランタイムがISO8601形式で接続された最新の時刻。
lastEndUpdateTime	string (date-time)	統合ランタイムノードの更新が最後に終了した時刻。
lastStartTime	string (date-time)	ノードが最後に起動した時刻。
lastStartUpdateTime	string (date-time)	統合ランタイムノードの更新が最後に開始された時刻。
lastStopTime	string (date-time)	統合ランタイムノードの最終停止時刻。
lastUpdateResult	IntegrationRuntimeUpdateResult	最後の統合ランタイムノード更新の結果。
machineName	string	統合ランタイムノードのマシン名。
maxConcurrentJobs	integer (int32)	この統合ランタイムの最大同時実行ジョブ数。
nodeName	string	統合ランタイムノードの名前。
registerTime	string (date-time)	統合ランタイムノードがISO8601形式で登録された時刻。
status	SelfHostedIntegrationRuntimeNodeStatus	統合ランタイムノードの状態。
version	string	統合ランタイムノードのバージョン。
versionStatus	string	統合ランタイムノードのバージョンの状態。

SelfHostedIntegrationRuntimeNodeStatus

列挙

統合ランタイムノードの状態。

値	説明
NeedRegistration
Online
Limited
Offline
Upgrading
Initializing
InitializeFailed

SelfHostedIntegrationRuntimeStatus

Object

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

名前	型	説明
dataFactoryName	string	統合ランタイムが属するワークスペース名。
state	IntegrationRuntimeState	統合ランタイムの状態。
type	string: SelfHosted	統合ランタイムの種類。
typeProperties.autoUpdate	IntegrationRuntimeAutoUpdate	セルフホステッド統合ランタイムの自動更新が有効になっているかどうか。
typeProperties.autoUpdateETA	string (date-time)	セルフホステッド統合ランタイムが更新される推定時間。
typeProperties.capabilities	object	統合ランタイム機能に関する追加情報を含むオブジェクト。
typeProperties.createTime	string (date-time)	統合ランタイムが作成された時刻 (ISO8601形式)。
typeProperties.internalChannelEncryption	IntegrationRuntimeInternalChannelEncryptionMode	ノードノード通信チャネルの暗号化モードを設定するために使用されます (2 つ以上のセルフホステッド統合ランタイムノードが存在する場合)。
typeProperties.latestVersion	string	ダウンロードセンターの最新バージョン。
typeProperties.links	LinkedIntegrationRuntime[]	この統合ランタイムと共有するために作成されたリンクされた統合ランタイムの一覧。
typeProperties.localTimeZoneOffset	string	ローカルタイムゾーンオフセット (時間単位)。
typeProperties.nodeCommunicationChannelEncryptionMode	string	ノード通信チャネル暗号化モード
typeProperties.nodes	SelfHostedIntegrationRuntimeNode[]	この統合ランタイムのノードの一覧。
typeProperties.pushedVersion	string	統合ランタイムが更新されるバージョン。
typeProperties.scheduledUpdateDate	string (date-time)	統合ランタイムの更新がスケジュールされる日付 (ISO8601形式)。
typeProperties.serviceUrls	string[]	統合ランタイムバックエンドサービスで使用されるサービスの URL。
typeProperties.taskQueueId	string	統合ランタイムのタスクキュー ID。
typeProperties.updateDelayOffset	string	統合ランタイムを更新するようにサービスによってスケジュールされた日付の時刻 (PT03H など) は 3 時間です
typeProperties.version	string	統合ランタイムのバージョン。
typeProperties.versionStatus	string	統合ランタイムバージョンの状態。