AzureFunctionClient

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.

Contructors

NewAzureFunctionClient

Creates new instance of AzureFunctionClient

NewAzureFunctionClient() *AzureFunctionClient

Fields

Instance methods

AddFilterParams

AddFilterParams method are adds filter parameters (with the same name as they defined) to invocation parameter map.

(c *AzureFunctionClient) AddFilterParams(params *cdata.StringValueMap, filter *cdata.FilterParams) *cdata.StringValueMap

• params: *cdata.StringValueMap - invocation parameters.
• filter: *cdata.FilterParams - (optional) filter parameters
• returns: *cdata.StringValueMap

AddPagingParams

AddPagingParams method are adds paging parameters (skip, take, total) to invocation parameter map.

(c *AzureFunctionClient) AddPagingParams(params *cdata.StringValueMap, paging *cdata.PagingParams) *cdata.StringValueMap

• params: *cdata.StringValueMap - invocation parameters.
• paging: *cdata.FilterParams - (optional) paging parameters.
• returns: *cdata.StringValueMap - invocation parameters with added paging parameters.

Call

Calls a Azure Function action.

(c *AzureFunctionClient) Call(ctx context.Context, cmd string, correlationId string, args *cdata.AnyValueMap) (*http.Response, error)

• ctx: context.Context - operation context.
• cmd: string - an action name to be called.
• correlationId: string - (optional) transaction id to trace execution through call chain.
• args: *cdata.AnyValueMap - (optional) action parameters.
• returns: (*http.Response, error) - action result.

Close

Closes component and frees used resources.

(c *AzureFunctionClient) Close(ctx context.Context, correlationId string) error

• ctx: context.Context - operation context.
• correlationId: string - (optional) transaction id to trace execution through call chain.
• returns: error - error if not closed.

Configure

Configures component by passing configuration parameters.

(c *AzureFunctionClient) Configure(ctx context.Context, config *ConfigParams)

• ctx: context.Context - operation context.
• 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.

(c *AzureFunctionClient) Instrument(ctx context.Context, correlationId string, name string) *InstrumentTiming

• ctx: context.Context - operation context.
• correlationId: string - (optional) transaction id to trace execution through call chain.
• name: string - a method name.
• return: *InstrumentTiming - object to end the time measurement.

IsOpen

Checks if the component is opened.

(c *AzureFunctionClient) IsOpen() bool

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

Open

Opens the component.

(c *AzureFunctionClient) Open(ctx context.Context, correlationId string) error

• ctx: context.Context - operation context.
• correlationId: string - (optional) transaction id to trace execution through call chain.
• returns: error - error if not opened.

SetReferences

Sets references to dependent components.

(c *AzureFunctionClient) SetReferences(ctx context.Context, references IReferences)

• ctx: context.Context - operation context.
• references: IReferences - references to locate the component dependencies.

Examples

type MyAzureFunctionClient struct {
	*clients.AzureFunctionClient
}

func NewMyAzureFunctionClient() *MyAzureFunctionClient {
	return &MyAzureFunctionClient{
		AzureFunctionClient: azureclient.NewAzureFunctionClient(),
	}
}

func (c *MyAzureFunctionClient) GetData(ctx context.Context, correlationId string, id string) MyData {
	timing := c.Instrument(ctx, correlationId, "myclient.get_data")

	response, err := c.Call(ctx, "get_data", correlationId, data.NewAnyValueMapFromTuples("id", dummyId))

	defer timing.EndTiming(ctx, err)
	return rpcclients.HandleHttpResponse[MyData](response, correlationId)
}

...

client := NewMyAzureFunctionClient()
client.Configure(config.NewConfigParamsFromTuples(
	"connection.uri", "http://myapp.azurewebsites.net/api/myfunction",
	"connection.protocol", "http",
	"connection.app_name", "myapp",
	"connection.function_name", "myfunction"
	"credential.auth_code", "XXXX"
result := client.GetData("123", "1")

See also

• AzureFunction

• CommandableAzureFunctionClient