pip_services3_azure.clients.CommandableAzureFunctionClient module

class pip_services3_azure.clients.CommandableAzureFunctionClient.CommandableAzureFunctionClient(name: str)

Bases: pip_services3_azure.clients.AzureFunctionClient.AzureFunctionClient

Abstract client that calls commandable Azure Functions.

Commandable services are generated automatically for ICommandable objects. Each command is exposed as action determined by “cmd” parameter.

### 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

  • 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 connection

  • *:credential-store:*:*:1.0 (optional) Credential stores to resolve credentials

class MyCommandableAzureClient(CommandableAzureFunctionClient, IMyClient):
    ...

    def get_data(self, correlation_id: Optional[str], id: str) -> Any:
        return self.call_command('get_data', correlation_id, {'id': id})

    ...

client = MyCommandableAzureClient('client_name')
client.configure(ConfigParams.from_еuples(
    "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.get_data("123", "1")
call_command(cmd: str, correlation_id: Optional[str], params: dict) → Any

Calls a remote action in Azure Function. The name of the action is added as “cmd” parameter to the action parameters.

Parameters

  • cmd – an action name

  • correlation_id – (optional) transaction id to trace execution through call chain.

  • params – command parameters.

Returns

action result.