Extensions.DeleteComposeDeploymentAsync 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
| DeleteComposeDeploymentAsync(FabricClient+ComposeDeploymentClient, DeleteComposeDeploymentDescription) |
Deletes the compose deployment instance from the cluster. |
| DeleteComposeDeploymentAsync(FabricClient+ComposeDeploymentClient, DeleteComposeDeploymentDescription, TimeSpan) |
Deletes the compose deployment from the cluster. |
| DeleteComposeDeploymentAsync(FabricClient+ComposeDeploymentClient, DeleteComposeDeploymentDescription, TimeSpan, CancellationToken) |
Deletes the compose deployment from the cluster. |
DeleteComposeDeploymentAsync(FabricClient+ComposeDeploymentClient, DeleteComposeDeploymentDescription)
Deletes the compose deployment instance from the cluster.
public static System.Threading.Tasks.Task DeleteComposeDeploymentAsync (this System.Fabric.FabricClient.ComposeDeploymentClient client, Microsoft.ServiceFabric.Preview.Client.Description.DeleteComposeDeploymentDescription description);static member DeleteComposeDeploymentAsync : System.Fabric.FabricClient.ComposeDeploymentClient * Microsoft.ServiceFabric.Preview.Client.Description.DeleteComposeDeploymentDescription -> System.Threading.Tasks.Task<Extension()>
Public Function DeleteComposeDeploymentAsync (client As FabricClient.ComposeDeploymentClient, description As DeleteComposeDeploymentDescription) As TaskParameters
FabricClient object.
- description
- DeleteComposeDeploymentDescription
The DeleteComposeDeploymentDescription that determines which compose deployment should be deleted.
Returns
A Task representing the operation.
Exceptions
ApplicationUpgradeInProgress: The application is being upgraded.
The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.
ComposeDeploymentNotFound: The compose deployment does not exist.
ApplicationUpgradeInProgress: The application is being upgraded.
The request timed out but may have already been accepted for processing by the system.
The request was canceled before the timeout expired but may have already been accepted for processing by the system.
Remarks
All compose deployment state will be lost and cannot be recovered after the compose deployment is deleted.
Applies to
DeleteComposeDeploymentAsync(FabricClient+ComposeDeploymentClient, DeleteComposeDeploymentDescription, TimeSpan)
Deletes the compose deployment from the cluster.
public static System.Threading.Tasks.Task DeleteComposeDeploymentAsync (this System.Fabric.FabricClient.ComposeDeploymentClient client, Microsoft.ServiceFabric.Preview.Client.Description.DeleteComposeDeploymentDescription description, TimeSpan timeout);static member DeleteComposeDeploymentAsync : System.Fabric.FabricClient.ComposeDeploymentClient * Microsoft.ServiceFabric.Preview.Client.Description.DeleteComposeDeploymentDescription * TimeSpan -> System.Threading.Tasks.Task<Extension()>
Public Function DeleteComposeDeploymentAsync (client As FabricClient.ComposeDeploymentClient, description As DeleteComposeDeploymentDescription, timeout As TimeSpan) As TaskParameters
FabricClient object.
- description
- DeleteComposeDeploymentDescription
The DeleteComposeDeploymentDescription that determines which compose deployment should be deleted.
- timeout
- TimeSpan
Defines the maximum amount of time the system will allow this operation to continue before returning System.TimeoutException.
Returns
A Task representing the operation.
Exceptions
ApplicationUpgradeInProgress: The application is being upgraded.
The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.
ComposeDeploymentNotFound: The compose deployment does not exist.
ApplicationUpgradeInProgress: The application is being upgraded.
The request timed out but may have already been accepted for processing by the system.
The request was canceled before the timeout expired but may have already been accepted for processing by the system.
Remarks
All application state will be lost and cannot be recovered after the application is deleted.
Applies to
DeleteComposeDeploymentAsync(FabricClient+ComposeDeploymentClient, DeleteComposeDeploymentDescription, TimeSpan, CancellationToken)
Deletes the compose deployment from the cluster.
public static System.Threading.Tasks.Task DeleteComposeDeploymentAsync (this System.Fabric.FabricClient.ComposeDeploymentClient client, Microsoft.ServiceFabric.Preview.Client.Description.DeleteComposeDeploymentDescription description, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);static member DeleteComposeDeploymentAsync : System.Fabric.FabricClient.ComposeDeploymentClient * Microsoft.ServiceFabric.Preview.Client.Description.DeleteComposeDeploymentDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Extension()>
Public Function DeleteComposeDeploymentAsync (client As FabricClient.ComposeDeploymentClient, description As DeleteComposeDeploymentDescription, timeout As TimeSpan, cancellationToken As CancellationToken) As TaskParameters
FabricClient object.
- description
- DeleteComposeDeploymentDescription
The DeleteComposeDeploymentDescription that determines which compose deployment should be deleted.
- timeout
- TimeSpan
Defines the maximum amount of time the system will allow this operation to continue before returning System.TimeoutException.
- cancellationToken
- CancellationToken
The CancellationToken that the operation is observing. It can be used to propagate notification that the operation should be canceled.
Returns
A Task representing the operation.
Exceptions
ApplicationUpgradeInProgress: The application is being upgraded.
The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.
ComposeDeploymentNotFound: The compose deployment does not exist.
ApplicationUpgradeInProgress: The application is being upgraded.
The request timed out but may have already been accepted for processing by the system.
The request was canceled before the timeout expired but may have already been accepted for processing by the system.
Remarks
All application state will be lost and cannot be recovered after the application is deleted.
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for