CommandableAzureFunction

Extends: AzureFunction

Description

The CommandableAzureFunction allows you to create an abstract Azure Function function that acts as a container to instantiate and run components and expose them via an external entry point.

Important points

• All actions are automatically generated for commands defined in ICommandable components. Each command is exposed as an action defined by the “cmd” parameter.

• Container configuration for this Azure Function is stored in "./config/config.yml" file. But this path can be overridden by the CONFIG_PATH environment variable.

• Note: This component has been deprecated. Use AzureFunctionController instead.

References

• *:logger:*:*:1.0: (optional) ILogger components to pass log messages
• *:counters:*:*:1.0: (optional) ICounters components to pass collected measurements
• *:controller:azure-function:*:1.0: (optional) IAzureFunctionController controllers to handle action requests.
• *:controller:commandable-azure-function:*:1.0: (optional) IAzureFunctionController controllers to handle action requests.

Constructors

Creates a new instance of this Azure Function.

public CommandableAzureFunction(string name, string description)

• name: string - (optional) container’s name (accessible via ContextInfo)
• description: string - (optional) container’s description (accessible via ContextInfo)

Instance methods

GetParameters

Returns body from Azure Function context. This method can be overloaded in child classes

protected Parameters GetParameters(HttpRequest context)

• context: HttpRequest - Azure Function context.
• returns: Parameters - Returns Parameters from context

Register

Registers all actions in this Azure Function.

protected override void Register()

Examples

class MyAzureFunction : CommandableAzureFunction
{
    private IMyController _controller;
    ...
    public MyAzureFunction() : base("mygroup", "MyGroup AzureFunction")
    {

        this._dependencyResolver.Put(
            "controller",
            new Descriptor("mygroup", "controller", "*", "*", "1.0")
        );
    }
}

...

var AzureFunction = new MyAzureFunction();

await AzureFunction.RunAsync();
Console.WriteLine("MyAzureFunction is started");