ExAzureCore.Http.Plugins.AzureHeaders (ex_azure_core v0.3.0)

Copy Markdown

Req plugin that adds standard Azure headers to requests.

Headers Added

  • x-ms-version - Azure API version (from :api_version option)
  • x-ms-date - RFC 1123 formatted timestamp
  • x-ms-return-client-request-id - Set to "true" to echo request ID

Options

  • :api_version - Azure API version string (e.g., "2024-01-01")
  • :include_date - Whether to add x-ms-date header (default: true)

Example

req = Req.new()
|> ExAzureCore.Http.Plugins.AzureHeaders.attach(api_version: "2024-01-01")

Summary

Functions

Attaches the Azure headers plugin to a Req request.

Functions

attach(request, opts \\ [])

@spec attach(
  Req.Request.t(),
  keyword()
) :: Req.Request.t()

Attaches the Azure headers plugin to a Req request.