Azure functions: how to bind query string parameters of http trigger function to SQL query of Cosmos DB

Question

I am trying to run an http trigger Azure function with Cosmos DB input binding. I would like the url of the http trigger to include several parameters on the query string that become bound to the SQL query of the input Cosmos DB binding. I am trying the following bindings in function.json, but it does not work (the function does not even get triggered):

{
  "direction": "in",
  "type": "httpTrigger",
  "authLevel": "anonymous",
  "name": "req",
  "methods": [ "get" ],
  "route": "users/{age=age?}/{gender=gender?}"
},
{
  "direction": "in",
  "type": "documentDB",
  "name": "users",
  "databaseName": "Database",
  "collectionName": "Users",
  "sqlQuery": "SELECT * FROM x where x.age = {age} and x.gender = {gender}",
  "connection": "COSMOSDB_CONNECTION_STRING"
},

According to this answer the route constraint users/{age=age?}/{gender=gender?} is valid for Web API, and according to the documentation you can use any Web API Route Constraint with your parameters. Ultimately I would to like make a GET request to the Azure function that looks like api/users?age=30&gender=male. How should this be done then?

score 6 · Accepted Answer · answered Aug 21 '17 at 02:09

6

I don't think you can configure a Cosmos DB binding to values defined in query parameters e.g. ?age=30. At least I haven't seen any examples like that in the functions documentation.

But you can bind them to the route parameters to achieve the same outcome, which you have pretty much done already.

Keeping that route of users/{age}/{gender}, your Cosmos SqlQuery will then pick up those route parameters when invoking a GET on http://yourfunctionhost/yourfunction/users/30/male

answered Aug 21 '17 at 02:09

Garth Mason

7,611
3
30
39

I was afraid that would be the case, since I also could not find any examples binding to parameters in the query string. Thank you for confirming. – Carlos Rodriguez Aug 21 '17 at 19:05
that is not true GET parameter will be bound and they can be used in the sqlQuery. Maybe this has changed in the past – cinatic May 24 '18 at 07:10

score 1 · Answer 2 · answered May 24 '18 at 07:13

1

GET and POST parameter will be bound, so they can be used inside the sqlQuery without any additional configuration. Just give it a try, this has definitely changed in the past

answered May 24 '18 at 07:13

cinatic

861
12
19

score 0 · Answer 3 · edited Jan 28 '21 at 11:57

0

You can bind the Query-Values to CosmosDB Input Binding:
Azure Cosmos DB input binding for Azure Functions 2.x and higher

[FunctionName("DocByIdFromQueryString")]
public static IActionResult Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)]
        HttpRequest req,
    [CosmosDB(
        databaseName: "ToDoItems",
        collectionName: "Items",
        ConnectionStringSetting = "CosmosDBConnection",
        Id = "{Query.id}",
        PartitionKey = "{Query.partitionKey}")] ToDoItem toDoItem,
    ILogger log)
{
    log.LogInformation("C# HTTP trigger function processed a request.");

    if (toDoItem == null)
    {
        log.LogInformation($"ToDo item not found");
    }
    else
    {
        log.LogInformation($"Found ToDo item, Description={toDoItem.Description}");
    }
    return new OkResult();
}

edited Jan 28 '21 at 11:57

lukaszberwid

1,097
7
19

answered Jan 08 '21 at 13:51

Markus Meyer

3,327
10
22
35

One doubt! if the `Route` is set to `null`, then what would be the final API endpoint? – rehman_00001 Jul 07 '22 at 11:47
1

It's the FunctionName 'DocByIdFromQueryString'. On local environment: http://localhost:7071/api/DocByIdFromQueryString MS Docs: https://learn.microsoft.com/en-us/azure/azure-functions/functions-create-your-first-function-visual-studio?tabs=in-process#rename-the-function – Markus Meyer Jul 07 '22 at 11:55

Azure functions: how to bind query string parameters of http trigger function to SQL query of Cosmos DB

3 Answers3