azure.functions.HttpRequest.yml

### YamlMime:PythonClass
uid: azure.functions.HttpRequest
name: HttpRequest
fullName: azure.functions.HttpRequest
module: azure.functions
summary: An HTTP request object.
constructor:
  syntax: 'HttpRequest(method: str, url: str, *, headers: Mapping[str, str] | None
    = None, params: Mapping[str, str] | None = None, route_params: Mapping[str, str]
    | None = None, body: bytes)'
  parameters:
  - name: method
    description: HTTP request method name.
    isRequired: true
    types:
    - <xref:str>
  - name: url
    description: HTTP URL.
    isRequired: true
    types:
    - <xref:str>
  - name: headers
    description: An optional mapping containing HTTP request headers.
    isRequired: true
    types:
    - <xref:dict>
  - name: params
    description: An optional mapping containing HTTP request params.
    isRequired: true
    types:
    - <xref:dict>
  - name: route_params
    description: An optional mapping containing HTTP request route params.
    isRequired: true
    types:
    - <xref:dict>
  - name: body
    description: HTTP request body.
    isRequired: true
    types:
    - <xref:bytes>
  keywordOnlyParameters:
  - name: headers
    defaultValue: None
  - name: params
    defaultValue: None
  - name: route_params
    defaultValue: None
  - name: body
    isRequired: true
methods:
- uid: azure.functions.HttpRequest.get_body
  name: get_body
  signature: get_body() -> bytes
- uid: azure.functions.HttpRequest.get_json
  name: get_json
  signature: get_json() -> Any
attributes:
- uid: azure.functions.HttpRequest.files
  name: files
- uid: azure.functions.HttpRequest.form
  name: form
- uid: azure.functions.HttpRequest.headers
  name: headers
- uid: azure.functions.HttpRequest.method
  name: method
- uid: azure.functions.HttpRequest.params
  name: params
- uid: azure.functions.HttpRequest.route_params
  name: route_params
- uid: azure.functions.HttpRequest.url
  name: url