pip_services3_azure.connect.AzureConnectionResolver module

class pip_services3_azure.connect.AzureConnectionResolver.AzureConnectionResolver

Bases: pip_services3_commons.config.IConfigurable.IConfigurable, pip_services3_commons.refer.IReferenceable.IReferenceable

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

  • app_name: alternative app name

  • function_name: application function name

• credentials:

  • auth_code: authorization code or null if using custom auth

### References ###

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

See ConnectionParams (in the Pip.Services components package), IDiscovery (in the Pip.Services components package)

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")

configure(config: pip_services3_commons.config.ConfigParams.ConfigParams)

Configures component by passing configuration parameters.

Parameters

config – configuration parameters to be set.

resolve(correlation_id: Optional[str]) → pip_services3_azure.connect.AzureConnectionParams.AzureConnectionParams

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

Parameters

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

Returns

receives AzureConnectionParams value or raise error.

set_references(references: pip_services3_commons.refer.IReferences.IReferences)

Sets references to dependent components.

Parameters

references – references to locate the component dependencies.