Integration Runtimes - Get Connection Info

Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo?api-version=2018-06-01

URI Parameters

Name In Required Type Description
factoryName
path True

string

The factory name.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

integrationRuntimeName
path True

string

The integration runtime name.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

resourceGroupName
path True

string

The resource group name.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True

string

The subscription identifier.

api-version
query True

string

The API version.

Responses

Name Type Description
200 OK

IntegrationRuntimeConnectionInfo

OK.

Other Status Codes

CloudError

An error response received from the Azure Data Factory service.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

IntegrationRuntimes_GetConnectionInfo

Sample request

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleIntegrationRuntime/getConnectionInfo?api-version=2018-06-01

Sample response

Date: Thu, 14 Jun 2018 14:53:21 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14998
x-ms-request-id: 05774db5-e79b-4224-9097-46714b92fbd8
x-ms-correlation-request-id: 05774db5-e79b-4224-9097-46714b92fbd8
{
  "version": "3.8.6730.2",
  "publicKey": "**********",
  "serviceToken": "**********",
  "identityCertThumbprint": "**********",
  "hostServiceUri": "https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/",
  "isIdentityCertExprired": false
}

Definitions

Name Description
CloudError

The object that defines the structure of an Azure Data Factory error response.

IntegrationRuntimeConnectionInfo

Connection information for encrypting the on-premises data source credentials.

CloudError

The object that defines the structure of an Azure Data Factory error response.

Name Type Description
error.code

string

Error code.

error.details

CloudError[]

Array with additional error details.

error.message

string

Error message.

error.target

string

Property name/path in request associated with error.

IntegrationRuntimeConnectionInfo

Connection information for encrypting the on-premises data source credentials.

Name Type Description
hostServiceUri

string

The on-premises integration runtime host URL.

identityCertThumbprint

string

The integration runtime SSL certificate thumbprint. Click-Once application uses it to do server validation.

isIdentityCertExprired

boolean

Whether the identity certificate is expired.

publicKey

string

The public key for encrypting a credential when transferring the credential to the integration runtime.

serviceToken

string

The token generated in service. Callers use this token to authenticate to integration runtime.

version

string

The integration runtime version.