Microsoft Azure AI Foundry

Microsoft Azure AI Foundry Connections API

The Connections API from Microsoft Azure AI Foundry — 3 operation(s) for connections.

GitHub OpenAPI

Operations 3

GET /connections Connections list #
GET /connections/{name} Connections get #
POST /connections/{name}/getConnectionWithCredentials Connections get with credentials #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/azureml/
📖
APIReference
https://learn.microsoft.com/en-us/azure/ai-foundry/
📖
Authentication
https://learn.microsoft.com/en-us/azure/ai-foundry/concepts/rbac-azure-ai-foundry
📖
Documentation
https://learn.microsoft.com/en-us/azure/foundry/foundry-models/how-to/use-foundry-models-microsoft-decision

Specifications

⚙
OpenAPI
https://artifacts.apis.io/azure-ai-foundry/openapi/azure-ai-foundry-connections-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/azure-ai-foundry/json-schema/azure-ai-foundry-connection-schema.json
📊
JSONSchema
https://artifacts.apis.io/azure-ai-foundry/json-schema/azure-ai-foundry-paged-connection-schema.json

Other Resources

🔗
SDKs
https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/ai
🔗
Blog
https://commandline.microsoft.com/microsoft-decision-1-model-foundry/

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/azure-ai-foundry:azure-ai-foundry-connections-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

azure-ai-foundry-connections-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Azure AI Connections API
  version: v1
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- OAuth2Auth:
  - https://ai.azure.com/.default
tags:
- name: Connections
paths:
  /connections:
    get:
      operationId: Connections_List
      description: List all connections in the project, without populating connection credentials
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: connectionType
        in: query
        description: List connections of this specific type
        required: false
        x-ms-enum:
          name: ConnectionType
          modelAsString: true
          values:
          - name: AzureOpenAI
            value: AzureOpenAI
            description: Azure OpenAI Service
          - name: AzureBlobStorage
            value: AzureBlob
            description: Azure Blob Storage, with specified container
          - name: AzureStorageAccount
            value: AzureStorageAccount
            description: Azure Blob Storage, with container not specified (used by Agents)
          - name: AzureAISearch
            value: CognitiveSearch
            description: Azure AI Search
          - name: CosmosDB
            value: CosmosDB
            description: CosmosDB
          - name: APIKey
            value: ApiKey
            description: Generic connection that uses API Key authentication
          - name: ApplicationConfiguration
            value: AppConfig
            description: Application Configuration
          - name: ApplicationInsights
            value: AppInsights
            description: Application Insights
          - name: Custom
            value: CustomKeys
            description: Custom Keys
        schema:
          type: string
          enum:
          - AzureOpenAI
          - AzureBlob
          - AzureStorageAccount
          - CognitiveSearch
          - CosmosDB
          - ApiKey
          - AppConfig
          - AppInsights
          - CustomKeys
      - name: defaultConnection
        in: query
        description: List connections that are default connections
        required: false
        schema:
          type: boolean
      - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          headers:
            x-ms-client-request-id:
              description: An opaque, globally-unique, client-generated string identifier for the request.
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedConnection'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Connections
      summary: Connections list
      x-summary-source: derived
  /connections/{name}:
    get:
      operationId: Connections_Get
      description: Get a connection by name, without populating connection credentials
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: The friendly name of the connection, provided by the user.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          headers:
            x-ms-client-request-id:
              description: An opaque, globally-unique, client-generated string identifier for the request.
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      tags:
      - Connections
      summary: Connections get
      x-summary-source: derived
  /connections/{name}/getConnectionWithCredentials:
    post:
      operationId: Connections_GetWithCredentials
      description: Get a connection by name, with its connection credentials
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: name
        in: path
        description: The friendly name of the connection, provided by the user.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader'
      responses:
        '200':
          description: The request has succeeded.
          headers:
            x-ms-client-request-id:
              description: An opaque, globally-unique, client-generated string identifier for the request.
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      tags:
      - Connections
      summary: Connections get with credentials
      x-summary-source: derived
components:
  schemas:
    CredentialType:
      type: string
      description: The credential type used by the connection
      enum:
      - ApiKey
      - AAD
      - SAS
      - CustomKeys
      - None
      x-ms-enum:
        name: CredentialType
        modelAsString: true
        values:
        - name: apiKey
          value: ApiKey
          description: API Key credential
        - name: entraId
          value: AAD
          description: Entra ID credential (formerly known as AAD)
        - name: SAS
          value: SAS
          description: Shared Access Signature (SAS) credential
        - name: custom
          value: CustomKeys
          description: Custom credential
        - name: None
          value: None
          description: No credential
    Azure.Core.Foundations.InnerError:
      type: object
      description: An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: Inner error.
    Azure.Core.Foundations.Error:
      type: object
      description: The error object.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        message:
          type: string
          description: A human-readable representation of the error.
        target:
          type: string
          description: The target of the error.
        details:
          type: array
          description: An array of details about specific errors that led to this reported error.
          items:
            $ref: '#/components/schemas/Azure.Core.Foundations.Error'
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: An object containing more specific information than the current object about the error.
      required:
      - code
      - message
    ConnectionType:
      type: string
      description: The Type (or category) of the connection
      enum:
      - AzureOpenAI
      - AzureBlob
      - AzureStorageAccount
      - CognitiveSearch
      - CosmosDB
      - ApiKey
      - AppConfig
      - AppInsights
      - CustomKeys
      x-ms-enum:
        name: ConnectionType
        modelAsString: true
        values:
        - name: AzureOpenAI
          value: AzureOpenAI
          description: Azure OpenAI Service
        - name: AzureBlobStorage
          value: AzureBlob
          description: Azure Blob Storage, with specified container
        - name: AzureStorageAccount
          value: AzureStorageAccount
          description: Azure Blob Storage, with container not specified (used by Agents)
        - name: AzureAISearch
          value: CognitiveSearch
          description: Azure AI Search
        - name: CosmosDB
          value: CosmosDB
          description: CosmosDB
        - name: APIKey
          value: ApiKey
          description: Generic connection that uses API Key authentication
        - name: ApplicationConfiguration
          value: AppConfig
          description: Application Configuration
        - name: ApplicationInsights
          value: AppInsights
          description: Application Insights
        - name: Custom
          value: CustomKeys
          description: Custom Keys
    BaseCredentials:
      type: object
      description: A base class for connection credentials
      properties:
        type:
          $ref: '#/components/schemas/CredentialType'
          description: The type of credential used by the connection
          readOnly: true
      discriminator:
        propertyName: type
      required:
      - type
    PagedConnection:
      type: object
      description: Paged collection of Connection items
      properties:
        value:
          type: array
          description: The Connection items on this page
          items:
            $ref: '#/components/schemas/Connection'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    Azure.Core.Foundations.ErrorResponse:
      type: object
      description: A response containing error details.
      properties:
        error:
          $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          description: The error object.
      required:
      - error
    Connection:
      type: object
      description: Response from the list and get connections operations
      properties:
        name:
          type: string
          description: The friendly name of the connection, provided by the user.
          readOnly: true
        id:
          type: string
          description: A unique identifier for the connection, generated by the service
          readOnly: true
        type:
          $ref: '#/components/schemas/ConnectionType'
          description: Category of the connection
          readOnly: true
        target:
          type: string
          description: The connection URL to be used for this service
          readOnly: true
        isDefault:
          type: boolean
          description: Whether the connection is tagged as the default connection of its type
          readOnly: true
        credentials:
          $ref: '#/components/schemas/BaseCredentials'
          description: The credentials used by the connection
          readOnly: true
        metadata:
          type: object
          description: Metadata of the connection
          additionalProperties:
            type: string
          readOnly: true
      required:
      - name
      - id
      - type
      - target
      - isDefault
      - credentials
      - metadata
  parameters:
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
    Azure.Core.ClientRequestIdHeader:
      name: x-ms-client-request-id
      in: header
      description: An opaque, globally-unique, client-generated string identifier for the request.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: clientRequestId
      schema:
        type: string
        format: uuid
  securitySchemes:
    OAuth2Auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://ai.azure.com/.default: ''
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: 'Foundry Project endpoint in the form

      "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}".

      If you only have one Project in your Foundry Hub, or to target the default Project

      in your Hub, use the form

      "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"'
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true