Integration Runtime Object Metadata - Refresh

Service:

Synapse

API Version:

2021-06-01

Refresh integration runtime object metadata
Refresh the object metadata in an integration runtime

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/refreshObjectMetadata?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	SsisObjectMetadataStatusResponse	OK.
202 Accepted		Accepted.
Other Status Codes	ErrorResponse	An error response received from the Azure Synapse service.

Examples

Refresh object metadata

Sample request

HTTP

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

Sample response

Status code:

200

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
}

Status code:

202

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
SsisObjectMetadataStatusResponse	The status of the operation.

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.

SsisObjectMetadataStatusResponse

Object

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.