FabricClient.ClusterManagementClient Class

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Represents the cluster management client for performing cluster maintenance operations.

public sealed class FabricClient.ClusterManagementClient

type FabricClient.ClusterManagementClient = class

Public NotInheritable Class FabricClient.ClusterManagementClient

Inheritance

Object

FabricClient.ClusterManagementClient

Remarks

The FabricClient.ClusterManagementClient provides APIs which help to manage the cluster as a whole. These are typically administrative commands which relate to major cluster events such as the loss of nodes and the need to recover services in the case of major failures.

Methods

ActivateNodeAsync(String)	Activates a Service Fabric cluster node which is currently deactivated.
ActivateNodeAsync(String, TimeSpan, CancellationToken)	Activates a Service Fabric cluster node which is currently deactivated.
AddConfigurationParameterOverridesAsync(String, IList<ConfigParameterOverride>, Boolean)	Adds configuration override
AddConfigurationParameterOverridesAsync(String, IList<ConfigParameterOverride>, Boolean, TimeSpan, CancellationToken)	Adds configuration override
AddNodeTagsAsync(String, List<String>)	Adds tags to the node
AddNodeTagsAsync(String, List<String>, TimeSpan, CancellationToken)	Adds tags to the node
CopyClusterPackage(String, String, String, String, String)	Copies the cluster manifest file and/or Service Fabric code package to the image store.
CopyClusterPackage(String, String, String, String, String, TimeSpan)	Copies the cluster manifest file and/or Service Fabric code package to the image store.
DeactivateNodeAsync(String, NodeDeactivationIntent)	Deactivates a particular node with the specified NodeDeactivationIntent.
DeactivateNodeAsync(String, NodeDeactivationIntent, TimeSpan, CancellationToken)	Deactivates a particular node with the specified NodeDeactivationIntent.
GetClusterConfigurationAsync()	Gets the Service Fabric cluster configuration file as a string.
GetClusterConfigurationAsync(String)	Gets the Service Fabric cluster configuration file as a string.
GetClusterConfigurationAsync(String, TimeSpan, CancellationToken)	Gets the Service Fabric cluster configuration file as a string, by using the specified timeout and cancellation token.
GetClusterConfigurationAsync(TimeSpan, CancellationToken)	Gets the Service Fabric cluster configuration file as a string, by using the specified timeout and cancellation token.
GetClusterConfigurationUpgradeStatusAsync()	Obtains the status of an upgrade in progress.
GetClusterConfigurationUpgradeStatusAsync(CancellationToken)	Obtains the status of an upgrade in progress.
GetClusterConfigurationUpgradeStatusAsync(TimeSpan)	Obtains the status of an upgrade in progress.
GetClusterConfigurationUpgradeStatusAsync(TimeSpan, CancellationToken)	Obtains the status of an upgrade in progress.
GetClusterManifestAsync()	Gets the XML contents of the current running cluster manifest.
GetClusterManifestAsync(ClusterManifestQueryDescription, TimeSpan, CancellationToken)	Gets the XML contents of a cluster manifest as specified by queryDescription.
GetClusterManifestAsync(TimeSpan, CancellationToken)	Gets the XML contents of the current running cluster manifest.
GetConfigurationOverridesAsync(String)	Gets configuration override
GetConfigurationOverridesAsync(String, TimeSpan, CancellationToken)	Gets configuration override
GetFabricUpgradeProgressAsync()	Returns the progress of a Service Fabric upgrade process.
GetFabricUpgradeProgressAsync(TimeSpan, CancellationToken)	Returns the progress of a Service Fabric upgrade process.
GetUpgradeOrchestrationServiceStateAsync()	Gets the Service Fabric Upgrade Orchestration Service state as a string.
GetUpgradeOrchestrationServiceStateAsync(TimeSpan, CancellationToken)	Gets the Service Fabric Upgrade Orchestration Service state as a string, by using the specified timeout and cancellation token.
MoveNextFabricUpgradeDomainAsync(FabricUpgradeProgress)	Instructs the Service Fabric to upgrade the next upgrade domain in the cluster if the current upgrade domain has been completed.
MoveNextFabricUpgradeDomainAsync(FabricUpgradeProgress, TimeSpan, CancellationToken)	Instructs Service Fabric to upgrade the next upgrade domain in the cluster if the current upgrade domain has been completed, by using the specified timeout and cancellation token.
ProvisionFabricAsync(String, String)	Provisions the Service Fabric.
ProvisionFabricAsync(String, String, TimeSpan, CancellationToken)	Provisions the Service Fabric by using the specified timeout and cancellation token.
RecoverPartitionAsync(Guid)	Indicates to the Service Fabric cluster that it should attempt to recover a specific partition which is currently stuck in quorum loss.
RecoverPartitionAsync(Guid, TimeSpan, CancellationToken)	Indicates to the Service Fabric cluster that it should attempt to recover a specific partition which is currently stuck in quorum loss.
RecoverPartitionsAsync()	Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss.
RecoverPartitionsAsync(TimeSpan, CancellationToken)	Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss.
RecoverServicePartitionsAsync(Uri)	Indicates to the Service Fabric cluster that it should attempt to recover the specified service which is currently stuck in quorum loss.
RecoverServicePartitionsAsync(Uri, TimeSpan, CancellationToken)	Indicates to the Service Fabric cluster that it should attempt to recover the specified service which is currently stuck in quorum loss by using the specified timeout and cancellation token.
RecoverSystemPartitionsAsync()	Indicates to the Service Fabric cluster that it should attempt to recover the system services which are currently stuck in quorum loss.
RecoverSystemPartitionsAsync(TimeSpan, CancellationToken)	Indicates to the Service Fabric cluster that it should attempt to recover the system services which are currently stuck in quorum loss.
RemoveClusterPackage(String, String, String)	Deletes the cluster manifest file and/or Service Fabric code package from the image store.
RemoveConfigurationOverridesAsync(String)	Removes configuration override
RemoveConfigurationOverridesAsync(String, TimeSpan, CancellationToken)	Removes configuration override
RemoveNodeStateAsync(String)	Indicates that the persisted data of a node is lost (e.g., due to disk failure, or reimage, etc.), and that Service Fabric should treat any services or state on that node as lost and unrecoverable.
RemoveNodeStateAsync(String, TimeSpan, CancellationToken)	Indicates that a particular node (which is down) has actually been lost, and that Service Fabric should treat any services or state on that node as lost and unrecoverable.
RemoveNodeTagsAsync(String, List<String>)	Removes tags from the node
RemoveNodeTagsAsync(String, List<String>, TimeSpan, CancellationToken)	Adds tags to the node
ResetPartitionLoadAsync(Guid)	Resets a given partition's load
ResetPartitionLoadAsync(Guid, TimeSpan, CancellationToken)	Resets a given partition's load
RollbackFabricUpgradeAsync()	Rolls back the Service Fabric to upgrade the operation.
RollbackFabricUpgradeAsync(TimeSpan, CancellationToken)	Rolls back the Service Fabric to upgrade the operation.
SetUpgradeOrchestrationServiceStateAsync(String)	Sets the Service Fabric Upgrade Orchestration Service state as a string.
SetUpgradeOrchestrationServiceStateAsync(String, TimeSpan, CancellationToken)	Sets the Service Fabric Upgrade Orchestration Service state as a string, by using the specified timeout and cancellation token.
ToggleVerboseServicePlacementHealthReportingAsync(Boolean)	Toggles whether the Cluster Resource Balancer will report a health warning when it's unable to place a replica.
ToggleVerboseServicePlacementHealthReportingAsync(Boolean, TimeSpan, CancellationToken)	Toggles whether the Cluster Resource Balancer will report a health warning when it's unable to place a replica.
UnprovisionFabricAsync(String, String)	Unprovisions the Service Fabric.
UnprovisionFabricAsync(String, String, TimeSpan, CancellationToken)	Unprovisions the Service Fabric by using the specified timeout and cancellation token.
UpdateFabricUpgradeAsync(FabricUpgradeUpdateDescription)	Modifies the upgrade parameters that describe the behavior of the current cluster upgrade.
UpdateFabricUpgradeAsync(FabricUpgradeUpdateDescription, TimeSpan, CancellationToken)	Modifies the upgrade parameters that describe the behavior of the current cluster upgrade.
UpdatePartitionLoadAsync(UpdatePartitionLoadQueryDescription, TimeSpan, CancellationToken)	Updates partitions reported metric load information. If the output list of partitions do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.
UpdatePartitionMoveCostAsync(UpdatePartitionMoveCostQueryDescription, TimeSpan, CancellationToken)	Updates partitions move cost information. If the output list of partitions do not fit in a page, one page of results is returned as well as a continuation token which can be used to get the next page.
UpgradeConfigurationAsync(ConfigurationUpgradeDescription)	Initiate an Upgrade using a cluster configuration file.
UpgradeConfigurationAsync(ConfigurationUpgradeDescription, CancellationToken)	Initiate an Upgrade using a cluster configuration file.
UpgradeConfigurationAsync(ConfigurationUpgradeDescription, TimeSpan)	Initiate an Upgrade using a cluster configuration file.
UpgradeConfigurationAsync(ConfigurationUpgradeDescription, TimeSpan, CancellationToken)	Initiate an Upgrade using a cluster configuration file.
UpgradeFabricAsync(FabricUpgradeDescription)	Upgrades the Service Fabric.
UpgradeFabricAsync(FabricUpgradeDescription, TimeSpan, CancellationToken)	Upgrades the Service Fabric by using the specified timeout and cancellation token.
ValidateFabricUpgradeAsync(FabricUpgradeDescription)	Validate the supplied upgrade parameters and assess the expected impact of a code or configuration version upgrade of a Service Fabric cluster. The upgrade will not be initiated.
ValidateFabricUpgradeAsync(FabricUpgradeDescription, TimeSpan, CancellationToken)	Validate the supplied upgrade parameters and assess the expected impact of a code or configuration version upgrade of a Service Fabric cluster. The upgrade will not be initiated.