Integration Runtime Connection Infos - Get
Get integration runtime connection info
Get connection info for an integration runtime
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo?api-version=2021-06-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
integration
|
path | True |
string |
Integration runtime name |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string |
The ID of the target subscription. |
workspace
|
path | True |
string |
The name of the workspace. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
An error response received from the Azure Synapse service. |
Examples
Get connection info
Sample Request
POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationRuntimes/exampleIntegrationRuntime/getConnectionInfo?api-version=2021-06-01-preview
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 |
---|---|
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Integration |
Connection information for encrypting the on-premises data source credentials. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
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. |