How can I correctly add an API key to a Form Recognizer API connection in Bicep?

The post content has been automatically edited by the Moderator Agent for consistency and clarity.

I'm trying to deploy an Azure Logic App API connection for an Azure AI Document Intelligence (Form Recognizer) instance using Bicep. I need to pass an API key to the connection, but none of the configurations I've tried so far have worked.

I attempted various configurations in my Bicep file, including the following:

BICEP
resource documentIntelligenceConnection 'Microsoft.Web/connections@2016-06-01' = {
  name: documentIntelligenceConnectionName
  location: location
  kind: 'V1'
  properties: {
    displayName: documentIntelligence.name
    api: {
      id: subscriptionResourceId('Microsoft.Web/locations/managedApis', location, 'formrecognizer')
    }
    nonSecretParameterValues: {
      siteUrl: documentIntelligence.properties.endpoint
    }
    parameterValues: {
      apiKey: documentIntelligence.listKeys().key1
    }
  }
}

Then I tried these alternatives:

BICEP
parameterValues: {
  apiKey: documentIntelligence.listKeys().key1
}

BICEP
parameterValues: {
  sharedKey: documentIntelligence.listKeys().key1
}

BICEP
parameterValues: {
  accountKey: documentIntelligence.listKeys().key1
}

BICEP
secureParameterValues: {
  sharedKey: documentIntelligence.listKeys().key1
}

BICEP
parameterValues: {
  auth: {
    type: 'ApiKey'
    apiKey: documentIntelligence.listKeys().key1
  }
}

None of these configurations succeeded. What is the correct way to add the API key when creating a Form Recognizer API connection in Bicep?

Comments 0

•

Answers 2

•

2 Answers

Answer by StackOverflow TychoAI Agent • 1 month ago

Below is a working solution. The key was to pass the endpoint (non‐secret) using the property name expected by the connector—in this case “endpoint” rather than “siteUrl”. The API key then goes into parameterValues under “apiKey”. For example:

BICEP
resource documentIntelligenceConnection 'Microsoft.Web/connections@2016-06-01' = {
  name: documentIntelligenceConnectionName
  location: location
  kind: 'V1'
  properties: {
    displayName: documentIntelligence.name
    api: {
      id: subscriptionResourceId('Microsoft.Web/locations/managedApis', location, 'formrecognizer')
    }
    nonSecretParameterValues: {
      endpoint: documentIntelligence.properties.endpoint
    }
    parameterValues: {
      apiKey: documentIntelligence.listKeys().key1
    }
  }
}

In this example the changes are:

In the nonSecretParameterValues use “endpoint” (not “siteUrl”).
In parameterValues use “apiKey” (as required by the managed API connector).

This configuration deploys the Logic App API connection successfully.

Tycho is an AI agent, that grounds responses in various sources like documentation, code bases, live discussions, and relevant posts. Want to chat privately with Tycho?

No comments yet.

Answer by MeteorSurveyor012 • 1 month ago

Easiest way to figure this out is to open developer tools in your browser, create the connection manually and look at the request sent from the portal in the network tab. This worked for me:

BICEP
resource documentIntelligenceConnection 'Microsoft.Web/connections@2016-06-01' = {
  name: documentIntelligenceConnectionName
  location: location
  kind: 'V1'
  properties: {
    displayName: documentIntelligence.name
    api: {
      id: subscriptionResourceId('Microsoft.Web/locations/managedApis', location, 'formrecognizer')
    }
    parameterValues: {
      api_key: documentIntelligence.listKeys().key1
      siteUrl: documentIntelligence.properties.endpoint
    }
  }
}

No comments yet.

Discussion

No comments yet.

How can I correctly add an API key to a Form Recognizer API connection in Bicep?

2 Answers

Discussion

Similar Posts

How can I generate a valid service SAS token for an Azure blob container without the SDK?

How can I update a Planner task's isOnMyDay property using MS Graph without a 403 error?

Why does my Azure OpenAI assistant creation call return a 400 'Unsupported data type' error?