AzureConnectionResolver

Implements: IConfigurable, IReferenceable

Description

Helper class to retrieve Azure connection and credential parameters, validate them and compose a AzureConnectionParams 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.

configure(config: ConfigParams)

• config: ConfigParams - configuration parameters to be set.

resolve

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

resolve(correlation_id: Optional[str]): AzureConnectionParams

• correlationId: Optional[str] - (optional) transaction id used to trace execution through the call chain.
• returns: AzureConnectionParams - receives an AzureConnectionParams value or error.

set_references

Sets references to dependent components.

set_references(references: IReferences)

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

Examples

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

connection_resolver = AzureConnectionResolver()
connection_resolver.configure(config)
connection_resolver.set_references(references)
connection_params = connection_resolver.resolve("123")

See also

• ConnectionParams

• IDiscovery