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 參數

名稱	位於	必要	類型	Description
integrationRuntimeName	path	True	string	整合運行時間名稱
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
workspaceName	path	True	string	工作區的名稱。
api-version	query	True	string	要用於這項作業的 API 版本。

要求標頭

名稱	必要	類型	Description
If-None-Match		string	整合運行時間實體的 ETag。應該只指定 get。如果 ETag 符合現有的實體標記，或提供 *，則不會傳回任何內容。

回應

名稱	類型	Description
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"
  }
}

定義

名稱	Description
DataFlowComputeType	將執行數據流作業之叢集的計算類型。
EntityReference	實體參考。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
IntegrationRuntimeComputeProperties	受控整合運行時間的計算資源屬性。
IntegrationRuntimeCustomerVirtualNetwork	Azure-SSIS 整合運行時間加入的虛擬網路定義和屬性。
IntegrationRuntimeCustomSetupScriptProperties	受控專用整合運行時間的自定義安裝腳本屬性。
IntegrationRuntimeDataFlowProperties	受控整合運行時間的數據流屬性。
IntegrationRuntimeDataProxyProperties	受控專用整合運行時間的數據 Proxy 屬性。
IntegrationRuntimeEdition	SSIS Integration Runtime 的版本
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 安全字串定義。在取得或清單 API 呼叫期間，字串值會以星號『*』遮罩。
SelfHostedIntegrationRuntime	自我裝載整合運行時間。

DataFlowComputeType

將執行數據流作業之叢集的計算類型。

名稱	類型	Description
ComputeOptimized	string
General	string
MemoryOptimized	string

EntityReference

實體參考。

名稱	類型	Description
referenceName	string	這個參考實體的名稱。
type	IntegrationRuntimeEntityReferenceType	這個參考實體的類型。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

IntegrationRuntimeComputeProperties

受控整合運行時間的計算資源屬性。

名稱	類型	Description
dataFlowProperties	IntegrationRuntimeDataFlowProperties	受控整合運行時間的數據流屬性。
location	string	受控整合運行時間的位置。可以在 https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities 找到支持的區域
maxParallelExecutionsPerNode	integer	受控整合運行時間每個節點的平行執行計數上限。
nodeSize	string	受控整合運行時間的節點大小需求。
numberOfNodes	integer	受控整合運行時間所需的節點數目。
vNetProperties	IntegrationRuntimeVNetProperties	受控整合運行時間的 VNet 屬性。

IntegrationRuntimeCustomerVirtualNetwork

Azure-SSIS 整合運行時間加入的虛擬網路定義和屬性。

名稱	類型	Description
subnetId	string	Azure-SSIS 整合運行時間要加入的子網標識碼。

IntegrationRuntimeCustomSetupScriptProperties

受控專用整合運行時間的自定義安裝腳本屬性。

名稱	類型	Description
blobContainerUri	string	包含自訂安裝文本的 Azure Blob 容器 URI。
sasToken	SecureString	Azure Blob 容器的 SAS 令牌。

IntegrationRuntimeDataFlowProperties

受控整合運行時間的數據流屬性。

名稱	類型	Description
computeType	DataFlowComputeType	將執行數據流作業之叢集的計算類型。
coreCount	integer	將執行數據流作業之叢集的核心計數。支援的值為：8、16、32、48、80、144 和 272。
timeToLive	integer	將執行數據流作業的叢集存留時間（以分鐘為單位）設定。

IntegrationRuntimeDataProxyProperties

受控專用整合運行時間的數據 Proxy 屬性。

名稱	類型	Description
connectVia	EntityReference	自我裝載整合運行時間參考。
path	string	包含 Blob 記憶體中暫存資料的路徑。
stagingLinkedService	EntityReference	暫存連結服務參考。

IntegrationRuntimeEdition

SSIS Integration Runtime 的版本

名稱	類型	Description
Enterprise	string
Standard	string

IntegrationRuntimeEntityReferenceType

這個參考實體的類型。

名稱	類型	Description
IntegrationRuntimeReference	string
LinkedServiceReference	string

IntegrationRuntimeLicenseType

攜帶您自己的授權案例的授權類型。

名稱	類型	Description
BasePrice	string
LicenseIncluded	string

IntegrationRuntimeResource

整合運行時間資源類型。

名稱	類型	Description
etag	string	資源 Etag。
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties	IntegrationRuntime: ManagedIntegrationRuntime SelfHostedIntegrationRuntime	整合運行時間屬性。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

IntegrationRuntimeSsisCatalogInfo

受控專用整合運行時間的目錄資訊。

名稱	類型	Description
catalogAdminPassword	SecureString	目錄資料庫的系統管理員用戶帳戶密碼。
catalogAdminUserName	string	目錄資料庫的系統管理員用戶名稱。
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/ 中找到有效的值

名稱	類型	Description
Basic	string
Premium	string
PremiumRS	string
Standard	string

IntegrationRuntimeSsisProperties

受控整合運行時間的 SSIS 屬性。

名稱	類型	Description
catalogInfo	IntegrationRuntimeSsisCatalogInfo	受控專用整合運行時間的目錄資訊。
customSetupScriptProperties	IntegrationRuntimeCustomSetupScriptProperties	受控專用整合運行時間的自定義安裝腳本屬性。
dataProxyProperties	IntegrationRuntimeDataProxyProperties	受控專用整合運行時間的數據 Proxy 屬性。
edition	IntegrationRuntimeEdition	SSIS Integration Runtime 的版本
expressCustomSetupProperties	CustomSetupBase[]	沒有 SSIS 整合運行時間文本屬性的自訂設定。
licenseType	IntegrationRuntimeLicenseType	攜帶您自己的授權案例的授權類型。

IntegrationRuntimeState

整合運行時間的狀態。

名稱	類型	Description
AccessDenied	string
Initial	string
Limited	string
NeedRegistration	string
Offline	string
Online	string
Started	string
Starting	string
Stopped	string
Stopping	string

IntegrationRuntimeType

整合運行時間的類型。

名稱	類型	Description
Managed	string
SelfHosted	string

IntegrationRuntimeVNetProperties

受控整合運行時間的 VNet 屬性。

名稱	類型	Description
publicIPs	string[]	此整合運行時間將使用之公用IP位址的資源識別碼。
subnet	string	此整合運行時間將加入的子網名稱。
subnetId	string	要加入此 Azure-SSIS 整合運行時間的子網標識碼。
vNetId	string	此整合運行時間將加入之 VNet 的識別碼。

LinkedIntegrationRuntimeKeyAuthorization

金鑰授權類型整合運行時間。

名稱	類型	Description
authorizationType	string: Key	整合運行時間共享的授權類型。
key	SecureString	用於授權的金鑰。

LinkedIntegrationRuntimeRbacAuthorization

角色型訪問控制（RBAC）授權類型整合運行時間。

名稱	類型	Description
authorizationType	string: RBAC	整合運行時間共享的授權類型。
resourceId	string	要共用之整合運行時間的資源標識碼。

ManagedIntegrationRuntime

受控整合運行時間，包括受控彈性和受控專用整合運行時間。

名稱	類型	Description
description	string	整合運行時間描述。
managedVirtualNetwork.id	string	受控虛擬網路的標識碼。
managedVirtualNetwork.referenceName	string	受控虛擬網路的參考名稱
managedVirtualNetwork.type	string	受控虛擬網路的類型。
provisioningState	IntegrationRuntimeState	整合運行時間狀態，僅適用於受控專用整合運行時間。
type	string: Managed	整合運行時間的類型。
typeProperties.computeProperties	IntegrationRuntimeComputeProperties	受控整合運行時間的計算資源。
typeProperties.customerVirtualNetwork	IntegrationRuntimeCustomerVirtualNetwork	Azure-SSIS 整合運行時間將加入的虛擬網路名稱
typeProperties.ssisProperties	IntegrationRuntimeSsisProperties	受控整合運行時間的 SSIS 屬性。

SecureString

Azure Synapse 安全字串定義。在取得或清單 API 呼叫期間，字串值會以星號『*』遮罩。

名稱	類型	Description
type	string: SecureString	秘密的類型。
value	string	安全字串的值。

SelfHostedIntegrationRuntime

自我裝載整合運行時間。

名稱	類型	Description
description	string	整合運行時間描述。
type	string: SelfHosted	整合運行時間的類型。
typeProperties.linkedInfo	LinkedIntegrationRuntimeType: LinkedIntegrationRuntimeKeyAuthorization LinkedIntegrationRuntimeRbacAuthorization	Data Factory 的連結整合運行時間類型

共用方式為