AzureFunctionClient

Implements: IOpenable, IConfigurable, IReferenceable

Description

When making calls “cmd” parameter determines which what action shall be called, while other parameters are passed to the action itself.

Configuration parameters

• connections:
  • uri: (optional) full connection string or use protocol, app_name and function_name to build
  • protocol: (optional) connection protocol
  • app_name: (optional) Azure Function application name
  • function_name: (optional) Azure Function name
• options:
  • retries: number of retries (default: 3)
  • connect_timeout: connection timeout in milliseconds (default: 10 sec)
  • timeout: invocation timeout in milliseconds (default: 10 sec)
• credentials:
  • auth_code: Azure Function auth code if use custom authorization provide empty string

References

• *:logger:*:*:1.0 - (optional) ILogger components to pass log messages.
• *:counters:*:*:1.0 - (optional) ICounters components to pass collected measurements.
• *:discovery:*:*:1.0 - (optional) IDiscovery services to resolve connections.
• *:credential-store:*:*:1.0 - (optional) Credential stores to resolve credentials.

Fields

Instance methods

call

Calls a Azure Function action.

protected call<T>(cmd: string, correlationId: string, params: any = {}): Promise<T>

• cmd: string - an action name to be called.
• correlationId: string - (optional) transaction id to trace execution through call chain.
• params: any - (optional) action parameters.
• returns: Promise<T> - action result.

close

Closes component and frees used resources.

public close(context: IContext): Promise<void>

• context: IContext - (optional) a context to trace execution through a call chain.

configure

Configures component by passing configuration parameters.

public configure(config: ConfigParams): void

• config: ConfigParams - configuration parameters to be set.

instrument

Adds instrumentation to log calls and measure call time. It returns a CounterTiming object that is used to end the time measurement.

protected instrument(context: IContext, name: string): InstrumentTiming

• context: IContext - (optional) a context to trace execution through a call chain.
• name: string - a method name.
• return: InstrumentTiming - object to end the time measurement.

invoke

Performs Azure Function invocation.

protected invoke<T>(cmd: string, context: IContext, args: any): Promise<T>

• cmd: string - action result.
• context: IContext - (optional) a context to trace execution through a call chain.
• args: any - action result.
• returns: Promise<T> - action result.

isOpen

Checks if the component is opened.

public isOpen(): boolean

• returns: boolean - true if the component has been opened and false otherwise.

open

Opens the component.

public open(context: IContext): Promise<void>

• context: IContext - (optional) a context to trace execution through a call chain.

setReferences

Sets references to dependent components.

public setReferences(references: IReferences): void

• references: IReferences - references to locate the component dependencies.

Examples

class MyAzureFunctionClient extends AzureFunctionClient implements IMyClient {
    ...
 
    public async getData(context: IContext, id: string): Promise<MyData> {
        let timing = this.instrument(context, 'myclient.get_data');
        const result = await this.call("get_data" context, { id: id });
        timing.endTiming();
        return result;
    }
    ...
}

let client = new MyAzureFunctionClient();
client.configure(ConfigParams.fromTuples(
    "connection.uri", "http://myapp.azurewebsites.net/api/myfunction",
    "connection.protocol", "http",
    "connection.app_name", "myapp",
    "connection.function_name", "myfunction"
    "credential.auth_code", "XXXX"
));
   
const result = await client.getData("123", "1");

See also

• AzureFunction

• CommandableAzureFunctionClient