DeploymentContributor.OnApplyDeploymentConfiguration Method
Indicates a member 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.
Namespace: Microsoft.SqlServer.Dac.Deployment
Assembly: Microsoft.SqlServer.Dac.Extensions (in Microsoft.SqlServer.Dac.Extensions.dll)
Syntax
'Declaration
Protected Overridable Sub OnApplyDeploymentConfiguration ( _
context As DeploymentContributorContext, _
configurationStreams As ICollection(Of DeploymentContributorConfigurationStream) _
)
'Usage
Dim context As DeploymentContributorContext
Dim configurationStreams As ICollection(Of DeploymentContributorConfigurationStream)
Me.OnApplyDeploymentConfiguration(context, _
configurationStreams)
protected virtual void OnApplyDeploymentConfiguration(
DeploymentContributorContext context,
ICollection<DeploymentContributorConfigurationStream> configurationStreams
)
protected:
virtual void OnApplyDeploymentConfiguration(
DeploymentContributorContext^ context,
ICollection<DeploymentContributorConfigurationStream^>^ configurationStreams
)
abstract OnApplyDeploymentConfiguration :
context:DeploymentContributorContext *
configurationStreams:ICollection<DeploymentContributorConfigurationStream> -> unit
override OnApplyDeploymentConfiguration :
context:DeploymentContributorContext *
configurationStreams:ICollection<DeploymentContributorConfigurationStream> -> unit
protected function OnApplyDeploymentConfiguration(
context : DeploymentContributorContext,
configurationStreams : ICollection<DeploymentContributorConfigurationStream>
)
Parameters
- context
Type: Microsoft.SqlServer.Dac.Deployment.DeploymentContributorContext
A DeploymentContributorContext object.
- configurationStreams
Type: System.Collections.Generic.ICollection<DeploymentContributorConfigurationStream>
An ICollection<T> of DeploymentContributorConfigurationStream objects.
Exceptions
| Exception | Condition |
|---|---|
| DeploymentFailedException | If there is a critical error that should stop the deployment process from continuing, implementing contributors may throw a DeploymentFailedException. |