API Reference

Paten

class paten.Paten(function_app_name: str, module_folder_list: Optional[list] = None)

Trigger-binding

paten.Paten.trigger(self, name: str, _type: str, **kwargs)

Add Trigger.

Parameters:
  • name – A name for the argument.
  • _type – A name for the trigger type.
  • **kwargs – Required parameters in each trigger type.

Returns:

paten.Paten.http_trigger(self, name: str, methods: Union[list, str], route: str, auth_level: str = 'function')

Add HttpTrigger.

Parameters:
  • name – A name for the argument, usually req.
  • methods – Accepted method name.
  • route – Route name for the Function App.
  • auth_level – Authentication level for the Function App, function, anonymous are acceptable.
paten.Paten.blob_trigger(self, name: str, path: str, connection: Optional[str] = None)

Add BlobTrigger.

Parameters:
  • name – A name for the argument, usually blob.
  • path – A path for the Blob Storage to invoke the Function App.
  • connection – A connection for the Blob Storage, by default AzureWebJobsStorage.
paten.Paten.queue_trigger(self, name: str, queue_name: str, connection: Optional[str] = None)

Add QueueTrigger.

Parameters:
  • name – A name for the argument, usually msg.
  • queue_name – A name for the Queue Storage where the msg enqueue or dequeue.
  • connection – A connection for the Queue Storage, by default AzureWebJobsStorage.
paten.Paten.timer_trigger(self, name: str, schedule: str)

Add TimerTrigger.

Parameters:
  • name – A name for the argument, usually timer.
  • schedule – The time when the Function App is invoked.

In-binding

paten.Paten.in_bind(self, name: str, _type: str, **kwargs)

Add in-bind.

Parameters:
  • name – A name for the argument.
  • _type – A name for the trigger type.
  • **kwargs – Required parameters in each trigger type.

Returns:

Out-binding

paten.Paten.out_bind(self, name: str, _type: str, is_arg_name_check: bool = True, **kwargs)
Parameters:
  • name – A name for the argument.
  • _type – A name for the trigger type.
  • is_arg_name_check – if True, check the argument-name of the function.
  • **kwargs – Required parameters in each trigger type.

Returns:

paten.Paten.out_http(self, name: Optional[str] = '$return')
paten.Paten.out_queue(self, name: str, queue_name: str, connection: Optional[str] = None)