FabricClient.ClusterManagementClient.UnprovisionFabricAsync 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.
Overloads
UnprovisionFabricAsync(String, String) |
Unprovisions the Service Fabric. |
UnprovisionFabricAsync(String, String, TimeSpan, CancellationToken) |
Unprovisions the Service Fabric by using the specified timeout and cancellation token. |
UnprovisionFabricAsync(String, String)
Unprovisions the Service Fabric.
public System.Threading.Tasks.Task UnprovisionFabricAsync (string codeVersion, string configVersion);
member this.UnprovisionFabricAsync : string * string -> System.Threading.Tasks.Task
Public Function UnprovisionFabricAsync (codeVersion As String, configVersion As String) As Task
Parameters
- codeVersion
- String
The code version to unprovision.
- configVersion
- String
The configuration version to unprovision.
Returns
The unprovisioned Service Fabric.
Exceptions
The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.
Remarks
A null
value is permitted for either the codeVersion
parameter or the configVersion
parameter. A null
value cannot be used for both parameters.
This will delete the patch file and/or cluster manifest file from the image store location. The image store location is specified as a configuration setting in the cluster manifest that was provided when the cluster was created.
Applies to
UnprovisionFabricAsync(String, String, TimeSpan, CancellationToken)
Unprovisions the Service Fabric by using the specified timeout and cancellation token.
public System.Threading.Tasks.Task UnprovisionFabricAsync (string codeVersion, string configVersion, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);
member this.UnprovisionFabricAsync : string * string * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function UnprovisionFabricAsync (codeVersion As String, configVersion As String, timeout As TimeSpan, cancellationToken As CancellationToken) As Task
Parameters
- codeVersion
- String
The code version to unprovision.
- configVersion
- String
The configuration version to unprovision.
- timeout
- TimeSpan
The maximum amount of time Service Fabric will allow this operation to continue before returning a TimeoutException.
- cancellationToken
- CancellationToken
The cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled. Note that cancellation is advisory and that the operation may still be completed even if it is cancelled.
Returns
The unprovisioned Service Fabric.
Exceptions
The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.