DeploymentContributor.OnApplyDeploymentConfiguration Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Called by the deployment process in DacFx to give your code an opportunity to collect configuration information from the provided files. At the end of the method all streams will be disposed. Contributors that need to obtain data from the streams must read and cache the data during this method - attempts to read from the stream during a later method such as the OnExecute(DeploymentPlanContributorContext) method will fail.
protected virtual void OnApplyDeploymentConfiguration (Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext context, System.Collections.Generic.ICollection<Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream> configurationStreams);abstract member OnApplyDeploymentConfiguration : Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext * System.Collections.Generic.ICollection<Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream> -> unit
override this.OnApplyDeploymentConfiguration : Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext * System.Collections.Generic.ICollection<Microsoft.SqlServer.Dac.Deployment.DeploymentContributorConfigurationStream> -> unitProtected Overridable Sub OnApplyDeploymentConfiguration (context As DeploymentContributorContext, configurationStreams As ICollection(Of DeploymentContributorConfigurationStream))Parameters
- context
- DeploymentContributorContext
A DeploymentContributorContext object
- configurationStreams
- ICollection<DeploymentContributorConfigurationStream>
An ICollection<T> of DeploymentContributorConfigurationStream objects
Exceptions
If there is a critical error that should stop the deployment process from continuing, implementing contributors may throw a DeploymentFailedException.