Azure Data Factory

Azure Data Factory Integration Runtime Object Metadata API

The integrationRuntimeObjectMetadata API from Azure Data Factory — 2 operation(s) for integrationruntimeobjectmetadata.

GitHub OpenAPI

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getObjectMetadata Browse SSIS object metadata on a runtime · Integration runtime object metadata get #
Ask an LLM
“How do I browse the SSIS catalog folders, projects and packages on an Azure-SSIS runtime?”
“Can I get SSIS object metadata for a specific path?”
Tell an agent
Get SSIS object metadata for runtime {ir} in factory {factory}.
Show SSIS metadata under path {path} on integration runtime {ir}.
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/refreshObjectMetadata Refresh SSIS object metadata on a runtime · Integration runtime object metadata refresh #
Ask an LLM
“How do I refresh the cached SSIS object metadata after deploying new packages?”
“Can I force an Azure-SSIS runtime to reload its catalog metadata?”
Tell an agent
Refresh SSIS object metadata on integration runtime {ir} in factory {factory}.
Reload the SSIS catalog metadata for runtime {ir}.

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/azure/data-factory/
📖
APIReference
https://learn.microsoft.com/en-us/rest/api/datafactory/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-data-factory/refs/heads/main/openapi/microsoft-azure-data-factory-integrationruntimeobjectmetadata-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/microsoft-azure-data-factory:microsoft-azure-data-factory-integrationruntimeobjectmetadata-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-data-factory-integrationruntimeobjectmetadata-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: DataFactoryManagementClient Integration Runtime Object…
  version: '2018-06-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: integrationRuntimeObjectMetadata
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getObjectMetadata
  : post:
      operationId: IntegrationRuntimeObjectMetadata_Get
      tags:
      - integrationRuntimeObjectMetadata
      description: Get a SSIS integration runtime object metadata by specified path. The return is pageable metadata list.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter
      - name: factoryName
        in: path
        description: The factory name.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
      - name: integrationRuntimeName
        in: path
        description: The integration runtime name.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SsisObjectMetadataListResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        IntegrationRuntimeObjectMetadata_Get:
          $ref: ./examples/IntegrationRuntimeObjectMetadata_Get.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSsisObjectMetadataRequest'
        description: The parameters for getting a SSIS object metadata.
      summary: Integration runtime object metadata get
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/refreshObjectMetadata
  : post:
      operationId: IntegrationRuntimeObjectMetadata_Refresh
      tags:
      - integrationRuntimeObjectMetadata
      description: Refresh a SSIS integration runtime object metadata.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter
      - name: factoryName
        in: path
        description: The factory name.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
      - name: integrationRuntimeName
        in: path
        description: The integration runtime name.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 3
          pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SsisObjectMetadataStatusResponse'
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudError'
      x-ms-examples:
        IntegrationRuntimeObjectMetadata_Refresh:
          $ref: ./examples/IntegrationRuntimeObjectMetadata_Refresh.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/SsisObjectMetadataStatusResponse'
      x-ms-long-running-operation: true
      summary: Integration runtime object metadata refresh
      x-summary-source: derived
components:
  schemas:
    CloudErrorBody:
      type: object
      description: The object that defines the structure of an Azure Data Factory error.
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Error message.
        target:
          type: string
          description: Property name/path in request associated with error.
        details:
          type: array
          description: Array with additional error details.
          items:
            $ref: '#/components/schemas/CloudError'
          x-ms-identifiers: []
      required:
      - code
      - message
      x-ms-external: true
    SsisObjectMetadataType:
      type: string
      description: The type of SSIS object metadata.
      enum:
      - Folder
      - Project
      - Package
      - Environment
      x-ms-enum:
        name: SsisObjectMetadataType
        modelAsString: true
        values:
        - name: Folder
          value: Folder
          description: Folder
        - name: Project
          value: Project
          description: Project
        - name: Package
          value: Package
          description: Package
        - name: Environment
          value: Environment
          description: Environment
    SsisObjectMetadata:
      type: object
      description: SSIS object metadata.
      properties:
        type:
          $ref: '#/components/schemas/SsisObjectMetadataType'
          description: Type of metadata.
        id:
          type: integer
          format: int64
          description: Metadata id.
        name:
          type: string
          description: Metadata name.
        description:
          type: string
          description: Metadata description.
      discriminator:
        propertyName: type
      required:
      - type
    GetSsisObjectMetadataRequest:
      type: object
      description: The request payload of get SSIS object metadata.
      properties:
        metadataPath:
          type: string
          description: Metadata path.
    SsisObjectMetadataListResponse:
      type: object
      description: A list of SSIS object metadata.
      properties:
        value:
          type: array
          description: The SsisObjectMetadata items on this page
          items:
            $ref: '#/components/schemas/SsisObjectMetadata'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    SsisObjectMetadataStatusResponse:
      type: object
      description: The status of the operation.
      properties:
        status:
          type: string
          description: The status of the operation.
        name:
          type: string
          description: The operation name.
        properties:
          type: string
          description: The operation properties.
        error:
          type: string
          description: The operation error message.
    CloudError:
      type: object
      description: The object that defines the structure of an Azure Data Factory error response.
      properties:
        error:
          $ref: '#/components/schemas/CloudErrorBody'
          description: Error data
          x-ms-client-flatten: true
      required:
      - error
      x-ms-external: true
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.