Integration Runtimes - Regenerate Auth Key

Regenerates the authentication key for an integration runtime.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey?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.

Request Body

Name Type Description
keyName

IntegrationRuntimeAuthKeyName

The name of the authentication key to regenerate.

Responses

Name Type Description
200 OK

IntegrationRuntimeAuthKeys

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_RegenerateAuthKey

Sample Request

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

{
  "keyName": "authKey2"
}

Sample Response

Date: Thu, 14 Jun 2018 14:50:41 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1198
x-ms-request-id: 25af6d34-52c6-40a4-a882-16052af85c99
x-ms-correlation-request-id: 25af6d34-52c6-40a4-a882-16052af85c99
{
  "authKey2": "**********"
}

Definitions

Name Description
CloudError

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

IntegrationRuntimeAuthKeyName

The name of the authentication key to regenerate.

IntegrationRuntimeAuthKeys

The integration runtime authentication keys.

IntegrationRuntimeRegenerateKeyParameters

Parameters to regenerate the authentication key.

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.

IntegrationRuntimeAuthKeyName

The name of the authentication key to regenerate.

Name Type Description
authKey1

string

authKey2

string

IntegrationRuntimeAuthKeys

The integration runtime authentication keys.

Name Type Description
authKey1

string

The primary integration runtime authentication key.

authKey2

string

The secondary integration runtime authentication key.

IntegrationRuntimeRegenerateKeyParameters

Parameters to regenerate the authentication key.

Name Type Description
keyName

IntegrationRuntimeAuthKeyName

The name of the authentication key to regenerate.