AzureFunctionConnectionResolver

Implements: IConfigurable, IReferenceable

Description

Helper class to retrieve Azure connection and credential parameters, validate them and compose a AzureFunctionConnectionParams value.

Configuration parameters

• connections:
  • uri: full connection uri with specific app and function name
  • protocol: connection protocol
  • project_id: is your Google Cloud Platform project ID
  • region: is the region where your function is deployed
  • function_name: is the name of the HTTP function you deployed
• credentials:
  • auth_token: Google-generated ID token or null if using custom auth

References

• *:discovery:*:*:1.0 - (optional) IDiscovery services to resolve connection.
• *:credential-store:*:*:1.0 - (optional) credential stores to resolve credentials.

Fields

Instance methods

configure

Configures a component by passing its configuration parameters.

public configure(config: ConfigParams): void

• config: ConfigParams - configuration parameters to be set.

resolve

Resolves connection and credential parameters and generates a single AzureFunctionConnectionParams value.

public resolve(correlationId: string): Promise<AzureFunctionConnectionParams>

• correlationId: string - (optional) transaction id used to trace execution through the call chain.
• returns: Promise<AzureFunctionConnectionParams> - receives an AzureFunctionConnectionParams value or error.

setReferences

Sets references to dependent components.

public setReferences(references: IReferences): void

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

Examples

let config = ConfigParams.fromTuples(
    "connection.uri", "http://myapp.azurewebsites.net/api/myfunction",
    "connection.app_name", "myapp",
    "connection.function_name", "myfunction",
    "credential.auth_code", "XXXXXXXXXX",
);

let connectionResolver = new AzureFunctionConnectionResolver();
connectionResolver.configure(config);
connectionResolver.setReferences(references);

const connectionParams = await connectionResolver.resolve("123");

See also

• ConnectionParams

• IDiscovery