ParameterProcessor Methods
Class Methods 4 members
Handles processing of parameter resources during application orchestration.
DeleteParameterAsync(ParameterResource, CancellationToken) Section titled DeleteParameterAsync(ParameterResource, CancellationToken) Task Deletes a parameter value from the deployment state and marks it as unresolved.
public sealed class ParameterProcessor{ public Task DeleteParameterAsync( ParameterResource parameterResource, CancellationToken cancellationToken = default(CancellationToken)) { // ... }}Parameters
parameterResource ParameterResource The parameter resource to delete the value for. cancellationToken CancellationToken optional A cancellation token. Returns
Task A task that completes when the value has been deleted. InitializeParametersAsync(IEnumerable<ParameterResource>, bool) Section titled InitializeParametersAsync(IEnumerable<ParameterResource>, bool) Task Initializes parameter resources and handles unresolved parameters if interaction service is available.
public sealed class ParameterProcessor{ public Task InitializeParametersAsync( IEnumerable<ParameterResource> parameterResources, bool waitForResolution = false) { // ... }}Parameters
parameterResources IEnumerable<ParameterResource> The parameter resources to initialize. waitForResolution bool optional Whether to wait for all parameters to be resolved before completing the returned Task. Returns
Task A task that completes when all parameters are resolved (if waitForResolution is true) or when initialization is complete. InitializeParametersAsync(DistributedApplicationModel, bool, CancellationToken) Section titled InitializeParametersAsync(DistributedApplicationModel, bool, CancellationToken) Task Initializes parameter resources by collecting dependent parameters from the distributed application model and handles unresolved parameters if interaction service is available.
public sealed class ParameterProcessor{ public Task InitializeParametersAsync( DistributedApplicationModel model, bool waitForResolution = false, CancellationToken cancellationToken = default(CancellationToken)) { // ... }}Parameters
model DistributedApplicationModel The distributed application model to collect parameters from. waitForResolution bool optional Whether to wait for all parameters to be resolved before completing the returned Task. cancellationToken CancellationToken optional The cancellation token to observe while waiting for parameters to be resolved. Returns
Task A task that completes when all parameters are resolved (if waitForResolution is true) or when initialization is complete. SetParameterAsync(ParameterResource, CancellationToken) Section titled SetParameterAsync(ParameterResource, CancellationToken) Task Prompts the user to set a value for a single parameter.
public sealed class ParameterProcessor{ public Task SetParameterAsync( ParameterResource parameterResource, CancellationToken cancellationToken = default(CancellationToken)) { // ... }}Parameters
parameterResource ParameterResource The parameter resource to set the value for. cancellationToken CancellationToken optional A cancellation token. Returns
Task A task that completes when the user has set the value or cancelled.