Integration Runtime Object Metadata - Refresh

Refresh a SSIS integration runtime object metadata.

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

OK.

202 Accepted

Accepted.

Other Status Codes

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

IntegrationRuntimeObjectMetadata_Refresh

Sample Request

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

Sample Response

Date: Mon, 03 Dec 2018 06:24:53 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 11999
x-ms-request-id: 20708242-215c-4101-9437-44590b27cdbf
x-ms-correlation-request-id: 20708242-215c-4101-9437-44590b27cdbf
{
  "status": "Succeeded",
  "name": "ca63c855b72d44959653ffcc6eb0b96c",
  "properties": null,
  "error": null
}

Definitions

CloudError

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

SsisObjectMetadataStatusResponse

The status of the operation.

CloudError

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

Name Type Description
error.code
  • string

Error code.

error.details

Array with additional error details.

error.message
  • string

Error message.

error.target
  • string

Property name/path in request associated with error.

SsisObjectMetadataStatusResponse

The status of the operation.

Name Type Description
error
  • string

The operation error message.

name
  • string

The operation name.

properties
  • string

The operation properties.

status
  • string

The status of the operation.