(This post refers to Azure Functions v2)
There are different ways to access both the request data and also request metadata when a HTTP-triggered Azure Function is executed.
Getting Query String Data in Azure Functions
Suppose we have the following class (e.g. in table storage):
public class PhotoMetadata
{
public string PartitionKey { get; set; }
public string RowKey { get; set; }
public string FileName { get; set; }
public string Keywords { get; set; }
}
We could write an Azure Function triggered by a HTTP GET that returns an item from a database by a querystring parameter called “id”:
[FunctionName("GetPhotoMetadata")]
public static IActionResult GetPhotoMetadata(
[HttpTrigger(AuthorizationLevel.Function, "get")] HttpRequest req,
ILogger log)
{
log.LogInformation("C# HTTP trigger function processed a request.");
string id = req.Query["id"];
if (string.IsNullOrWhiteSpace(id))
{
return new NotFoundResult();
}
PhotoMetadata metadata = LoadFromDatabase(id);
return new OkObjectResult(metadata);
}
In the preceding code, to access querystring parameters use req.Query and specify the key you are looking for, in this example “id”.
If there is no value in the incoming request, id will be null and we return a NotFoundResult (404).
Getting HTTP POST JSON Request Data in Azure Functions
When it comes to accessing POSTed data, there are a number of options.
Manually Convert JSON Request Strings
The first option is to take control of the process at a lower level and read the posted data from the request body and parse the JSON into a dynamic C# object. [If you’re not familiar with dynamic C# check out my Dynamic C# Fundamentals Pluralsight course]
First we define a model that will represent the posted data (we don’t want to use the PhotoMetadata class as we don’t want clients specifying partition and row keys):
public class PhotoMetadataAdditionRequest
{
public string FileName { get; set; }
public string Keywords { get; set; }
}
Next we can write a function that will parse this incoming data:
[FunctionName("AddPhotoMetadata")]
public static async Task<IActionResult> AddPhotoMetadata(
[HttpTrigger(AuthorizationLevel.Function, "post")] HttpRequest req,
ILogger log)
{
log.LogInformation("C# HTTP trigger function processed a request.");
log.LogInformation("You can get additional information about the request such as:");
log.LogInformation($" length : {req.ContentLength}");
log.LogInformation($" type : {req.ContentType}");
log.LogInformation($" https : {req.IsHttps}");
log.LogInformation($" host : {req.Host}");
// read the contents of the posted data into a string
string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
// use Json.NET to deserialize the posted JSON into a C# dynamic object
dynamic data = JsonConvert.DeserializeObject(requestBody);
// data validation omitted for demo purposes
// extract data from the dynamic object into strongly typed object
PhotoMetadata metadata = new PhotoMetadata
{
FileName = data.fileName, // notice the camel case (lowercase f)
PartitionKey = "landscapes",
RowKey = Guid.NewGuid().ToString(),
Keywords = data.keywords // notice the camel case (lowercase k)
};
SaveToDatabase(metadata);
return new OkObjectResult(metadata.RowKey);
}
Notice in the preceding code that you can also access information about the request such as req.ContentLength. Also note the lowercase f and k in data.fileName and data.keywords.
We can post the following JSON to the function:
{
"fileName": "IMG0382435.jpg",
"keywords": "landscape, sky, sunset"
}
Automatically Bind to Strongly Types POCOs in Azure HTTP Functions
You can also let the runtime auto-convert the POSTed JSON into a specified C# type:
[FunctionName("AddPhotoMetadata")]
public static IActionResult AddPhotoMetadata(
[HttpTrigger(AuthorizationLevel.Function, "post")] PhotoMetadataAdditionRequest metadataAdditionRequest,
ILogger log)
{
log.LogInformation("C# HTTP trigger function processed a request.");
log.LogInformation($" FileName : {metadataAdditionRequest.FileName}");
log.LogInformation($" Keywords : { metadataAdditionRequest.Keywords}");
PhotoMetadata metadata = new PhotoMetadata
{
FileName = metadataAdditionRequest.FileName,
PartitionKey = "landscapes",
RowKey = Guid.NewGuid().ToString(),
Keywords = metadataAdditionRequest.Keywords
};
SaveToDatabase(metadata);
return new OkObjectResult(metadata.RowKey);
}
In the preceding code, instead of binding to a HttpRequest object, we bind to the PhotoMetadataAdditionRequest. Behind the scenes the JSON will be automatically deserialized into a PhotoMetadataAdditionRequest object.
Note that if you have malformed JSON you may get errors. For example if the “fileName” item in the JSON was misspelt as “file” then the FileName property of the PhotoMetadata would end up being set to null but the function body would still execute. If you had an int in the POCO but the POSTed JSON had a string (e.g. “hello”) instead of a number, then the runtime cannot bind a “hello” to an int – in this case your function body code will not even execute and you get an error from the runtime such as: “System.Private.CoreLib: Exception while executing function: AddPhotoMetadata. Microsoft.Azure.WebJobs.Host: Exception binding parameter 'metadataAdditionRequest'. System.Private.CoreLib: Input string was not in a correct format.” (and a 500 will status be returned to the client).
If you were handling things at a lower level (e.g. with the dynamic approach) you could perhaps provide a default value, do some extra logging, etc.
Accessing HTTP Request Metadata When Auto-binding to POCOs
If you want to do automatic binding and also want to get request metadata, you can simply add an extra parameter of type HttpRequest:
[FunctionName("AddPhotoMetadata")]
public static IActionResult AddPhotoMetadata(
[HttpTrigger(AuthorizationLevel.Function, "post")] PhotoMetadataAdditionRequest metadataAdditionRequest,
HttpRequest req,
ILogger log)
{
log.LogInformation("C# HTTP trigger function processed a request.");
log.LogInformation("You can get additional information about the request such as:");
log.LogInformation($" length : {req.ContentLength}");
log.LogInformation($" type : {req.ContentType}");
log.LogInformation($" https : {req.IsHttps}");
log.LogInformation($" host : {req.Host}");
log.LogInformation($" FileName : {metadataAdditionRequest.FileName}");
log.LogInformation($" Keywords : { metadataAdditionRequest.Keywords}");
PhotoMetadata metadata = new PhotoMetadata
{
FileName = metadataAdditionRequest.FileName,
PartitionKey = "landscapes",
RowKey = Guid.NewGuid().ToString(),
Keywords = metadataAdditionRequest.Keywords
};
SaveToDatabase(metadata);
return new OkObjectResult(metadata.RowKey);
}
Posting Form Data to Azure Functions
In addition to POSTing JSON content to an Azure Function, you can also POST form data and access the HttpRequest.Form property:
[FunctionName("AddPhotoMetadata")]
public static IActionResult AddPhotoMetadata(
[HttpTrigger(AuthorizationLevel.Function, "post")] HttpRequest req,
ILogger log)
{
log.LogInformation("C# HTTP trigger function processed a request.");
log.LogInformation("You can get additional information about the request such as:");
log.LogInformation($" length : {req.ContentLength}");
log.LogInformation($" type : {req.ContentType}");
log.LogInformation($" https : {req.IsHttps}");
log.LogInformation($" host : {req.Host}");
PhotoMetadata metadata = new PhotoMetadata
{
FileName = req.Form["fileName"], // access form data
PartitionKey = "landscapes",
RowKey = Guid.NewGuid().ToString(),
Keywords = req.Form["keywords"] // access form data
};
SaveToDatabase(metadata);
return new OkObjectResult(metadata.RowKey);
}
If you want to fill in the gaps in your C# knowledge be sure to check out my C# Tips and Traps training course from Pluralsight – get started with a free trial.
SHARE: