proxies.json

Azure Function Proxies proxies.json files

Type object
File match proxies.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/proxies-json/latest.json
Source https://www.schemastore.org/proxies.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

proxies Record<string, object> required

The proxies object defines the proxies that will be used by the function app

1 nested properties
<ProxyName> object
Default:
{
  "matchCondition": {
    "route": ""
  },
  "backendUri": ""
}
7 nested properties
matchCondition object required
2 nested properties
route string required

Required - This defines the route template, controlling to which request URLs your proxy will respond. Unlike in HTTP triggers, there is no default value

methods http-method-schema[]

This is an array of the HTTP methods to which the proxy will respond. If not specified, the proxy will respond to all HTTP methods on the route.

minItems=1uniqueItems=true
desc string[]
backendUri string

The URL of the backend resource to which the request should be proxied. This value may be templated. If this property is not included, Azure Functions will respond with an HTTP 200 OK

requestOverrides object
3 nested properties
backend.request.method http-method-schema | request-overrides-value-expression-schema

This is the HTTP method which will be used to call the backend.

backend.request.querystring.<ParameterName> string
backend.request.headers.<HeaderName> string
responseOverrides object
4 nested properties
response.statusCode string
response.statusReason string
response.body string | object | object[]

The string representation of the body to be returned to the client.

response.headers.<HeaderName> string
debug boolean
disabled boolean
$schema string

Definitions

proxy-schema object
matchCondition object required
2 nested properties
route string required

Required - This defines the route template, controlling to which request URLs your proxy will respond. Unlike in HTTP triggers, there is no default value

methods http-method-schema[]

This is an array of the HTTP methods to which the proxy will respond. If not specified, the proxy will respond to all HTTP methods on the route.

minItems=1uniqueItems=true
desc string[]
backendUri string

The URL of the backend resource to which the request should be proxied. This value may be templated. If this property is not included, Azure Functions will respond with an HTTP 200 OK

requestOverrides object
3 nested properties
backend.request.method http-method-schema | request-overrides-value-expression-schema

This is the HTTP method which will be used to call the backend.

backend.request.querystring.<ParameterName> string
backend.request.headers.<HeaderName> string
responseOverrides object
4 nested properties
response.statusCode string
response.statusReason string
response.body string | object | object[]

The string representation of the body to be returned to the client.

response.headers.<HeaderName> string
debug boolean
disabled boolean
match-condition-schema object
route string required

Required - This defines the route template, controlling to which request URLs your proxy will respond. Unlike in HTTP triggers, there is no default value

methods http-method-schema[]

This is an array of the HTTP methods to which the proxy will respond. If not specified, the proxy will respond to all HTTP methods on the route.

minItems=1uniqueItems=true
requestOverrides-schema object
backend.request.method http-method-schema | request-overrides-value-expression-schema

This is the HTTP method which will be used to call the backend.

backend.request.querystring.<ParameterName> string
backend.request.headers.<HeaderName> string
responseOverrides-schema object
response.statusCode string
response.statusReason string
response.body string | object | object[]

The string representation of the body to be returned to the client.

response.headers.<HeaderName> string
request-overrides-value-expression-schema string
response-overrides-value-expression-schema string
http-method-schema enum