Integration Runtimes - Get
統合ランタイムを取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}?api-version=2018-06-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
factory
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ |
ファクトリ名。 |
integration
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ |
統合ランタイム名。 |
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+$ |
リソース グループ名。 |
subscription
|
path | True |
string |
サブスクリプション識別子。 |
api-version
|
query | True |
string |
API のバージョン。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
If-None-Match |
string |
統合ランタイム エンティティの ETag。 get にのみ指定する必要があります。 ETag が既存のエンティティ タグと一致する場合、または * が指定された場合、コンテンツは返されません。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
わかりました。 |
|
Other Status Codes |
変更されていません。 |
|
Other Status Codes |
GET 統合ランタイム操作から受信したエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントを偽装する |
例
IntegrationRuntimes_Get
要求のサンプル
応答のサンプル
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.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime",
"name": "exampleIntegrationRuntime",
"type": "Microsoft.DataFactory/factories/integrationruntimes",
"properties": {
"type": "SelfHosted",
"description": "A selfhosted integration runtime"
},
"etag": "15003c4f-0000-0200-0000-5cbe090b0000"
}
定義
CloudError
Azure Data Factory エラー応答の構造を定義するオブジェクト。
名前 | 型 | 説明 |
---|---|---|
error.code |
string |
エラー コード。 |
error.details |
追加のエラーの詳細を含む配列。 |
|
error.message |
string |
エラーメッセージ。 |
error.target |
string |
エラーに関連付けられている要求のプロパティ名/パス。 |
CopyComputeScaleProperties
マネージド統合ランタイムの CopyComputeScale プロパティ。
名前 | 型 | 説明 |
---|---|---|
dataIntegrationUnit |
integer (int32) minimum: 4 |
コピー アクティビティの実行用に予約されている DIU 番号の設定。 サポートされる値は、4 から 256 の範囲の 4 の倍数です。 |
timeToLive |
integer (int32) minimum: 5 |
コピー アクティビティを実行する統合ランタイムの Time to Live (分単位) 設定。 |
CredentialReference
資格情報参照の種類。
名前 | 型 | 説明 |
---|---|---|
referenceName |
string |
参照資格情報名。 |
type |
資格情報参照の種類。 |
CredentialReferenceType
資格情報参照の種類。
値 | 説明 |
---|---|
CredentialReference |
CustomProperties
カスタム プロパティは、データ フロー ランタイムのパフォーマンスを調整するために使用されます。
名前 | 型 | 説明 |
---|---|---|
name |
string |
カスタム プロパティの名前。 |
value |
string |
カスタム プロパティの値。 |
DataFlowComputeType
データ フロー ジョブを実行するクラスターのコンピューティングの種類。
値 | 説明 |
---|---|
ComputeOptimized | |
General | |
MemoryOptimized |
EntityReference
エンティティ参照。
名前 | 型 | 説明 |
---|---|---|
referenceName |
string |
この参照先エンティティの名前。 |
type |
この参照先エンティティの型。 |
IntegrationRuntimeComputeProperties
マネージド統合ランタイムのコンピューティング リソースのプロパティ。
名前 | 型 | 説明 |
---|---|---|
copyComputeScaleProperties |
マネージド統合ランタイムの CopyComputeScale プロパティ。 |
|
dataFlowProperties |
マネージド統合ランタイムのデータ フロー プロパティ。 |
|
location |
string |
マネージド統合ランタイムの場所。 サポートされているリージョンは、https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities にあります |
maxParallelExecutionsPerNode |
integer minimum: 1 |
マネージド統合ランタイムのノードあたりの並列実行の最大数。 |
nodeSize |
string |
マネージド統合ランタイムのノード サイズ要件。 |
numberOfNodes |
integer minimum: 1 |
マネージド統合ランタイムに必要なノード数。 |
pipelineExternalComputeScaleProperties |
マネージド統合ランタイムの PipelineExternalComputeScale プロパティ。 |
|
vNetProperties |
マネージド統合ランタイムの VNet プロパティ。 |
IntegrationRuntimeCustomerVirtualNetwork
Azure-SSIS 統合ランタイムが参加する仮想ネットワークの定義とプロパティ。
名前 | 型 | 説明 |
---|---|---|
subnetId |
string |
Azure-SSIS 統合ランタイムが参加するサブネットの ID。 |
IntegrationRuntimeCustomSetupScriptProperties
マネージド専用統合ランタイムのカスタム セットアップ スクリプト プロパティ。
名前 | 型 | 説明 |
---|---|---|
blobContainerUri |
string |
カスタム セットアップ スクリプトを含む Azure BLOB コンテナーの URI。 |
sasToken |
Azure BLOB コンテナーの SAS トークン。 |
IntegrationRuntimeDataFlowProperties
マネージド統合ランタイムのデータ フロー プロパティ。
名前 | 型 | 説明 |
---|---|---|
cleanup |
boolean |
クラスターはリサイクルされず、これが false に設定されている場合、TTL (有効期間) に達するまで、次のデータ フロー アクティビティの実行で使用されます。 既定値は true です。 |
computeType |
データ フロー ジョブを実行するクラスターのコンピューティングの種類。 |
|
coreCount |
integer |
データ フロー ジョブを実行するクラスターのコア数。 サポートされる値は、8、16、32、48、80、144、272 です。 |
customProperties |
カスタム プロパティは、データ フロー ランタイムのパフォーマンスを調整するために使用されます。 |
|
timeToLive |
integer minimum: 0 |
データ フロー ジョブを実行するクラスターの Time to Live (分単位) 設定。 |
IntegrationRuntimeDataProxyProperties
マネージド専用統合ランタイムのデータ プロキシ プロパティ。
名前 | 型 | 説明 |
---|---|---|
connectVia |
セルフホステッド統合ランタイムリファレンス。 |
|
path |
string |
BLOB ストレージにステージング データを格納するパス。 |
stagingLinkedService |
ステージングのリンクされたサービス参照。 |
IntegrationRuntimeEdition
SSIS 統合ランタイムのエディション
値 | 説明 |
---|---|
Enterprise | |
Standard |
IntegrationRuntimeEntityReferenceType
この参照先エンティティの型。
値 | 説明 |
---|---|
IntegrationRuntimeReference | |
LinkedServiceReference |
IntegrationRuntimeLicenseType
ライセンスを持ち込むシナリオのライセンスの種類。
値 | 説明 |
---|---|
BasePrice | |
LicenseIncluded |
IntegrationRuntimeResource
統合ランタイム リソースの種類。
名前 | 型 | 説明 |
---|---|---|
etag |
string |
Etag は、リソース内の変更を識別します。 |
id |
string |
リソース識別子。 |
name |
string |
リソース名。 |
properties | IntegrationRuntime: |
統合ランタイムのプロパティ。 |
type |
string |
リソースの種類。 |
IntegrationRuntimeSsisCatalogInfo
マネージド専用統合ランタイムのカタログ情報。
名前 | 型 | 説明 |
---|---|---|
catalogAdminPassword |
カタログ データベースの管理者ユーザー アカウントのパスワード。 |
|
catalogAdminUserName |
string minLength: 1maxLength: 128 |
カタログ データベースの管理者ユーザー名。 |
catalogPricingTier |
カタログ データベースの価格レベル。 有効な値は、https://azure.microsoft.com/en-us/pricing/details/sql-database/ |
|
catalogServerEndpoint |
string |
カタログ データベース サーバーの URL。 |
dualStandbyPairName |
string |
SSISDB フェールオーバーをサポート Azure-SSIS 統合ランタイムのデュアル スタンバイ ペア名。 |
IntegrationRuntimeSsisCatalogPricingTier
カタログ データベースの価格レベル。 有効な値は、https://azure.microsoft.com/en-us/pricing/details/sql-database/
値 | 説明 |
---|---|
Basic | |
Premium | |
PremiumRS | |
Standard |
IntegrationRuntimeSsisProperties
マネージド統合ランタイムの SSIS プロパティ。
名前 | 型 | 説明 |
---|---|---|
catalogInfo |
マネージド専用統合ランタイムのカタログ情報。 |
|
credential |
認証情報を含む資格情報参照。 |
|
customSetupScriptProperties |
マネージド専用統合ランタイムのカスタム セットアップ スクリプト プロパティ。 |
|
dataProxyProperties |
マネージド専用統合ランタイムのデータ プロキシ プロパティ。 |
|
edition |
SSIS 統合ランタイムのエディション |
|
expressCustomSetupProperties |
Custom |
SSIS 統合ランタイムのスクリプト プロパティを使用しないカスタム セットアップ。 |
licenseType |
ライセンスを持ち込むシナリオのライセンスの種類。 |
|
packageStores |
SSIS 統合ランタイムのパッケージ ストア。 |
IntegrationRuntimeState
統合ランタイムの状態。
値 | 説明 |
---|---|
AccessDenied | |
Initial | |
Limited | |
NeedRegistration | |
Offline | |
Online | |
Started | |
Starting | |
Stopped | |
Stopping |
IntegrationRuntimeType
統合ランタイムの種類。
値 | 説明 |
---|---|
Managed | |
SelfHosted |
IntegrationRuntimeVNetProperties
マネージド統合ランタイムの VNet プロパティ。
名前 | 型 | 説明 |
---|---|---|
publicIPs |
string[] |
この統合ランタイムが使用するパブリック IP アドレスのリソース ID。 |
subnet |
string |
この統合ランタイムが参加するサブネットの名前。 |
subnetId |
string |
この Azure-SSIS 統合ランタイムが参加するサブネットの ID。 |
vNetId |
string |
この統合ランタイムが参加する VNet の ID。 |
LinkedIntegrationRuntimeKeyAuthorization
キー承認タイプ統合ランタイム。
名前 | 型 | 説明 |
---|---|---|
authorizationType |
string:
Key |
統合ランタイム共有の承認の種類。 |
key |
承認に使用されるキー。 |
LinkedIntegrationRuntimeRbacAuthorization
ロール ベースのアクセス制御 (RBAC) 承認の種類の統合ランタイム。
名前 | 型 | 説明 |
---|---|---|
authorizationType |
string:
RBAC |
統合ランタイム共有の承認の種類。 |
credential |
認証情報を含む資格情報参照。 |
|
resourceId |
string |
共有する統合ランタイムのリソース識別子。 |
ManagedIntegrationRuntime
マネージド統合ランタイム (マネージド エラスティックおよびマネージド専用統合ランタイムを含む)。
名前 | 型 | 説明 |
---|---|---|
description |
string |
統合ランタイムの説明。 |
managedVirtualNetwork |
マネージド仮想ネットワーク リファレンス。 |
|
state |
統合ランタイムの状態。マネージド専用統合ランタイムに対してのみ有効です。 |
|
type |
string:
Managed |
統合ランタイムの種類。 |
typeProperties.computeProperties |
マネージド統合ランタイムのコンピューティング リソース。 |
|
typeProperties.customerVirtualNetwork |
Azure-SSIS 統合ランタイムが参加する仮想ネットワークの名前 |
|
typeProperties.ssisProperties |
マネージド統合ランタイムの SSIS プロパティ。 |
ManagedVirtualNetworkReference
マネージド仮想ネットワークの参照の種類。
名前 | 型 | 説明 |
---|---|---|
referenceName |
string |
ManagedVirtualNetwork 名を参照します。 |
type |
マネージド仮想ネットワークの参照の種類。 |
ManagedVirtualNetworkReferenceType
マネージド仮想ネットワークの参照の種類。
値 | 説明 |
---|---|
ManagedVirtualNetworkReference |
PackageStore
SSIS 統合ランタイムのパッケージ ストア。
名前 | 型 | 説明 |
---|---|---|
name |
string |
パッケージ ストアの名前 |
packageStoreLinkedService |
パッケージ ストアのリンクされたサービス参照。 |
PipelineExternalComputeScaleProperties
マネージド統合ランタイムの PipelineExternalComputeScale プロパティ。
名前 | 型 | 説明 |
---|---|---|
numberOfExternalNodes |
integer (int32) minimum: 1maximum: 10 |
外部ノードの数。0 より大きく、11 未満である必要があります。 |
numberOfPipelineNodes |
integer (int32) minimum: 1maximum: 10 |
パイプライン ノードの数。0 より大きく、11 未満である必要があります。 |
timeToLive |
integer (int32) minimum: 5 |
パイプラインと外部アクティビティを実行する統合ランタイムの有効期間 (分単位) 設定。 |
SecureString
Azure Data Factory のセキュリティで保護された文字列定義。 文字列値は、Get または List API 呼び出し中にアスタリスク '*' でマスクされます。
名前 | 型 | 説明 |
---|---|---|
type | string: |
シークレットの種類。 |
value |
string |
セキュリティで保護された文字列の値。 |
SelfHostedIntegrationRuntime
セルフホステッド統合ランタイム。
名前 | 型 | 説明 |
---|---|---|
description |
string |
統合ランタイムの説明。 |
type |
string:
Self |
統合ランタイムの種類。 |
typeProperties.linkedInfo | LinkedIntegrationRuntimeType: |
リンクされた統合ランタイムの基本定義。 |
typeProperties.selfContainedInteractiveAuthoringEnabled |
boolean |
セルフホステッド統合ランタイムが Azure Relay との接続を確立できない場合に、対話型の作成機能を確保する別のオプション。 |