Integration Runtimes - Get

Service:: Synapse

API Version:: 2021-06-01

Get integration runtime
Get an integration runtime

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

URI Parameters

Name	In	Required	Type	Description
integrationRuntimeName	path	True	string	Integration runtime name
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
workspaceName	path	True	string	The name of the workspace.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Header

Name	Required	Type	Description
If-None-Match		string	ETag of the integration runtime entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

Responses

Name	Type	Description
200 OK	IntegrationRuntimeResource	OK.
Other Status Codes		Not modified.
Other Status Codes	ErrorResponse	An error response received from GET integration runtime operation.

Examples

Get integration runtime

Sample request

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

Sample response

Status code:: 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"
}

Status code:: 304

Status code:: default

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

Definitions

Name	Description
DataFlowComputeType	Compute type of the cluster which will execute data flow job.
EntityReference	The entity reference.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IntegrationRuntimeComputeProperties	The compute resource properties for managed integration runtime.
IntegrationRuntimeCustomerVirtualNetwork	The definition and properties of virtual network to which Azure-SSIS integration runtime will join.
IntegrationRuntimeCustomSetupScriptProperties	Custom setup script properties for a managed dedicated integration runtime.
IntegrationRuntimeDataFlowProperties	Data flow properties for managed integration runtime.
IntegrationRuntimeDataProxyProperties	Data proxy properties for a managed dedicated integration runtime.
IntegrationRuntimeEdition	The edition for the SSIS Integration Runtime
IntegrationRuntimeEntityReferenceType	The type of this referenced entity.
IntegrationRuntimeLicenseType	License type for bringing your own license scenario.
IntegrationRuntimeResource	Integration runtime resource type.
IntegrationRuntimeSsisCatalogInfo	Catalog information for managed dedicated integration runtime.
IntegrationRuntimeSsisCatalogPricingTier	The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/
IntegrationRuntimeSsisProperties	SSIS properties for managed integration runtime.
IntegrationRuntimeState	The state of integration runtime.
IntegrationRuntimeType	The type of integration runtime.
IntegrationRuntimeVNetProperties	VNet properties for managed integration runtime.
LinkedIntegrationRuntimeKeyAuthorization	The key authorization type integration runtime.
LinkedIntegrationRuntimeRbacAuthorization	The role based access control (RBAC) authorization type integration runtime.
ManagedIntegrationRuntime	Managed integration runtime, including managed elastic and managed dedicated integration runtimes.
SecureString	Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.
SelfHostedIntegrationRuntime	Self-hosted integration runtime.

DataFlowComputeType

Enumeration

Compute type of the cluster which will execute data flow job.

Value	Description
General
MemoryOptimized
ComputeOptimized

EntityReference

Object

The entity reference.

Name	Type	Description
referenceName	string	The name of this referenced entity.
type	IntegrationRuntimeEntityReferenceType	The type of this referenced entity.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

IntegrationRuntimeComputeProperties

Object

The compute resource properties for managed integration runtime.

Name	Type	Description
dataFlowProperties	IntegrationRuntimeDataFlowProperties	Data flow properties for managed integration runtime.
location	string	The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities
maxParallelExecutionsPerNode	integer (int32) minimum: 1	Maximum parallel executions count per node for managed integration runtime.
nodeSize	string	The node size requirement to managed integration runtime.
numberOfNodes	integer (int32) minimum: 1	The required number of nodes for managed integration runtime.
vNetProperties	IntegrationRuntimeVNetProperties	VNet properties for managed integration runtime.

IntegrationRuntimeCustomerVirtualNetwork

Object

The definition and properties of virtual network to which Azure-SSIS integration runtime will join.

Name	Type	Description
subnetId	string	The ID of subnet to which Azure-SSIS integration runtime will join.

IntegrationRuntimeCustomSetupScriptProperties

Object

Custom setup script properties for a managed dedicated integration runtime.

Name	Type	Description
blobContainerUri	string	The URI of the Azure blob container that contains the custom setup script.
sasToken	SecureString	The SAS token of the Azure blob container.

IntegrationRuntimeDataFlowProperties

Object

Data flow properties for managed integration runtime.

Name	Type	Description
computeType	DataFlowComputeType	Compute type of the cluster which will execute data flow job.
coreCount	integer (int32)	Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272.
timeToLive	integer (int32) minimum: 0	Time to live (in minutes) setting of the cluster which will execute data flow job.

IntegrationRuntimeDataProxyProperties

Object

Data proxy properties for a managed dedicated integration runtime.

Name	Type	Description
connectVia	EntityReference	The self-hosted integration runtime reference.
path	string	The path to contain the staged data in the Blob storage.
stagingLinkedService	EntityReference	The staging linked service reference.

IntegrationRuntimeEdition

Enumeration

The edition for the SSIS Integration Runtime

Value	Description
Standard
Enterprise

IntegrationRuntimeEntityReferenceType

Enumeration

The type of this referenced entity.

Value	Description
IntegrationRuntimeReference
LinkedServiceReference

IntegrationRuntimeLicenseType

Enumeration

License type for bringing your own license scenario.

Value	Description
BasePrice
LicenseIncluded

IntegrationRuntimeResource

Object

Integration runtime resource type.

Name	Type	Description
etag	string	Resource Etag.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	IntegrationRuntime: ManagedIntegrationRuntime SelfHostedIntegrationRuntime	Integration runtime properties.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

IntegrationRuntimeSsisCatalogInfo

Object

Catalog information for managed dedicated integration runtime.

Name	Type	Description
catalogAdminPassword	SecureString	The password of the administrator user account of the catalog database.
catalogAdminUserName	string minLength: 1 maxLength: 128	The administrator user name of catalog database.
catalogPricingTier	IntegrationRuntimeSsisCatalogPricingTier	The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/
catalogServerEndpoint	string	The catalog database server URL.

IntegrationRuntimeSsisCatalogPricingTier

Enumeration

The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/

Value	Description
Basic
Standard
Premium
PremiumRS

IntegrationRuntimeSsisProperties

Object

SSIS properties for managed integration runtime.

Name	Type	Description
catalogInfo	IntegrationRuntimeSsisCatalogInfo	Catalog information for managed dedicated integration runtime.
customSetupScriptProperties	IntegrationRuntimeCustomSetupScriptProperties	Custom setup script properties for a managed dedicated integration runtime.
dataProxyProperties	IntegrationRuntimeDataProxyProperties	Data proxy properties for a managed dedicated integration runtime.
edition	IntegrationRuntimeEdition	The edition for the SSIS Integration Runtime
expressCustomSetupProperties	CustomSetupBase[]	Custom setup without script properties for a SSIS integration runtime.
licenseType	IntegrationRuntimeLicenseType	License type for bringing your own license scenario.

IntegrationRuntimeState

Enumeration

The state of integration runtime.

Value	Description
Initial
Stopped
Started
Starting
Stopping
NeedRegistration
Online
Limited
Offline
AccessDenied

IntegrationRuntimeType

Enumeration

The type of integration runtime.

Value	Description
Managed
SelfHosted

IntegrationRuntimeVNetProperties

Object

VNet properties for managed integration runtime.

Name	Type	Description
publicIPs	string[]	Resource IDs of the public IP addresses that this integration runtime will use.
subnet	string	The name of the subnet this integration runtime will join.
subnetId	string	The ID of subnet, to which this Azure-SSIS integration runtime will be joined.
vNetId	string	The ID of the VNet that this integration runtime will join.

LinkedIntegrationRuntimeKeyAuthorization

Object

The key authorization type integration runtime.

Name	Type	Description
authorizationType	string: Key	The authorization type for integration runtime sharing.
key	SecureString	The key used for authorization.

LinkedIntegrationRuntimeRbacAuthorization

Object

The role based access control (RBAC) authorization type integration runtime.

Name	Type	Description
authorizationType	string: RBAC	The authorization type for integration runtime sharing.
resourceId	string	The resource identifier of the integration runtime to be shared.

ManagedIntegrationRuntime

Object

Managed integration runtime, including managed elastic and managed dedicated integration runtimes.

Name	Type	Description
description	string	Integration runtime description.
managedVirtualNetwork.id	string	The id of the managed virtual network.
managedVirtualNetwork.referenceName	string	The reference name of the managed virtual network
managedVirtualNetwork.type	string	The type of the managed virtual network.
provisioningState	IntegrationRuntimeState	Integration runtime state, only valid for managed dedicated integration runtime.
type	string: Managed	Type of integration runtime.
typeProperties.computeProperties	IntegrationRuntimeComputeProperties	The compute resource for managed integration runtime.
typeProperties.customerVirtualNetwork	IntegrationRuntimeCustomerVirtualNetwork	The name of virtual network to which Azure-SSIS integration runtime will join
typeProperties.ssisProperties	IntegrationRuntimeSsisProperties	SSIS properties for managed integration runtime.

SecureString

Object

Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.

Name	Type	Description
type	string: SecureString	Type of the secret.
value	string	Value of secure string.

SelfHostedIntegrationRuntime

Object

Self-hosted integration runtime.

Name	Type	Description
description	string	Integration runtime description.
type	string: SelfHosted	Type of integration runtime.
typeProperties.linkedInfo	LinkedIntegrationRuntimeType: LinkedIntegrationRuntimeKeyAuthorization LinkedIntegrationRuntimeRbacAuthorization	Linked integration runtime type from data factory

Share via

Integration Runtimes - Get

URI Parameters

Request Header

Responses

Examples

Get integration runtime

Sample request

Sample response

Definitions

DataFlowComputeType

EntityReference

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IntegrationRuntimeComputeProperties

IntegrationRuntimeCustomerVirtualNetwork

IntegrationRuntimeCustomSetupScriptProperties

IntegrationRuntimeDataFlowProperties

IntegrationRuntimeDataProxyProperties

IntegrationRuntimeEdition

IntegrationRuntimeEntityReferenceType

IntegrationRuntimeLicenseType

IntegrationRuntimeResource

IntegrationRuntimeSsisCatalogInfo

IntegrationRuntimeSsisCatalogPricingTier

IntegrationRuntimeSsisProperties

IntegrationRuntimeState

IntegrationRuntimeType

IntegrationRuntimeVNetProperties

LinkedIntegrationRuntimeKeyAuthorization

LinkedIntegrationRuntimeRbacAuthorization

ManagedIntegrationRuntime

SecureString

SelfHostedIntegrationRuntime