Share via

Integration Runtime Auth Keys - List

Service:
Synapse
API Version:
2021-06-01

List integration runtime authentication keys
List authentication keys in an integration runtime

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys?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.

Responses

Name Type Description
200 OK

IntegrationRuntimeAuthKeys

OK.
Other Status Codes

ErrorResponse

An error response received from the Azure Synapse service.

Examples

List auth keys

Sample request

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationRuntimes/exampleIntegrationRuntime/listAuthKeys?api-version=2021-06-01

Sample response

Status code:
200 
Date: Thu, 14 Jun 2018 14:51:00 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14999
x-ms-request-id: 2ea25426-9d1d-49f3-88b6-fb853eb02cb9
x-ms-correlation-request-id: 2ea25426-9d1d-49f3-88b6-fb853eb02cb9
{
  "authKey1": "**********",
  "authKey2": "**********"
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
IntegrationRuntimeAuthKeys

The integration runtime authentication keys.

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.

IntegrationRuntimeAuthKeys

Object

The integration runtime authentication keys.

Name Type Description
authKey1

string

The primary integration runtime authentication key.
authKey2

string

The secondary integration runtime authentication key.