System.Fabric Namespace

Contains classes, structs, and interfaces that support access to attributes of Service Fabric resources.

Classes

ApplicationUpgradeProgress

Represents the upgrade status of the application instance.

ByteSerializable

A class that needs to be serialized/deserialized to/from a byte array should inherit from this base class

CheckExistsPropertyOperation

Represents a PropertyBatchOperation that compares the Boolean existence of a property with the ExistenceCheck argument.

CheckSequencePropertyOperation

Compares the SequenceNumber of a property with the SequenceNumber argument.

CheckValuePropertyOperation

Represents a PropertyBatchOperation that compares the value of the property with the expected value.

ClaimsCredentials

Represents the claim based security credential acquired from STS (security token service).

CodePackage

Represents the code package definition.

CodePackageActivationContext

Represents the activation which contains information about a running code package in a Service Fabric application.

The GetActivationContext() and GetActivationContextAsync(TimeSpan, CancellationToken) methods can be used to get an instance of the activation context.

CodePackageDebugParameters

Class for code package debug parameters.

ComposeDeploymentUpgradeProgress

Represents the upgrade progress of the compose deployment.

ConfigurationPackage

Represents a configuration package.

ContainerDebugParameters

Class for container debug parameters.

DataPackage

This class represents a data package in the application. A data package consists of static data (that can be upgraded) that is consumed by the application. For more information see https://docs.microsoft.com/azure/service-fabric/service-fabric-application-model

DeletePropertyOperation

Represents a PropertyBatchOperation that deletes a specified property if it exists.

FabricBackupDirectoryNotEmptyException

The exception that is thrown when a user-provided backup directory is not empty.

FabricBackupInProgressException

The exception that is thrown when an attempt is made to initiate a backup while a previously initiated backup is still in progress.

FabricCannotConnectException

The exception that indicates that there is CannotConnect Error.

FabricChaosAlreadyRunningException

The exception that is thrown when there is an attempt to create a new instance of Service Fabric's built-in Chaos Test service, while the service is already running in the cluster.

FabricChaosEngineException

The exception that is thrown when Service Fabric's built-in Chaos Test service has encountered something unexpected.

FabricClient

Creates and manages Service Fabric services and other entities.

FabricClient.ApplicationManagementClient

Provides the functionality to manage Service Fabric applications.

FabricClient.ClaimsRetrievalEventArgs

Represents the event arguments for a claims token retrieval event

FabricClient.ClusterManagementClient

Represents the cluster management client for performing cluster maintenance operations.

FabricClient.ComposeDeploymentClient

Provides the functionality to manage Service Fabric compose deployments.

FabricClient.FaultManagementClient

Provides functionality to introduce faults in a Service Fabric cluster.

FabricClient.GatewayInformationEventArgs

Represents the event arguments for gateway related events, like connect and disconnect.

FabricClient.HealthClient

Provides functionality to perform health related operations, like report and query health.

FabricClient.InfrastructureServiceClient

Provides methods for performing infrastructure-specific operations.

This class supports the Service Fabric platform; it is not meant to be called directly from your code.

FabricClient.PropertyManagementClient

Represents the property management client used to perform management of names and properties.

FabricClient.QueryClient

Represents the fabric client that can be used to issue queries.

FabricClient.RepairManagementClient

Provides methods for managing repair tasks.

This class supports the Service Fabric platform; it is not meant to be called directly from your code.

FabricClient.ServiceGroupManagementClient

Allows client side creation, deletion, and inspection of service groups inside the cluster, just like the FabricClient.ServiceManagementClient for regular services.

FabricClient.ServiceManagementClient

Represents the enabling of the services to be managed.

FabricClient.ServiceManagementClient.ServiceNotificationEventArgs

The event arguments for a ServiceNotificationFilterMatched event.

FabricClient.TestManagementClient

Provides methods for issuing and controlling test commands.

FabricClientSettings

Represents the configuration settings for the FabricClient class.

FabricConnectionDeniedException

The exception that is thrown when a connection request is denied by Service Fabric cluster or server.

FabricConstants

These are constants used by ServiceFabric for various OS Related resources.

FabricDeleteBackupFileFailedException

The exception that is thrown when deletion of a file or a directory fails during backup.

FabricElementAlreadyExistsException

The exception that indicates failure due to the existence of a conflicting entity.

FabricElementNotFoundException

The exception that is thrown when a Service Fabric element is not available.

FabricEndpointNotFoundException

The exception that is thrown when the specified endpoint is not found.

FabricException

The base Service Fabric exception class.

FabricImageStoreException

The exception that is thrown when perform ImageStore operations.

FabricInvalidAddressException

The exception that is thrown when an address is not recognized by Service Fabric.

FabricInvalidAtomicGroupException

The exception that is thrown when the Service Fabric atomic group is invalid.

FabricInvalidForStatefulServicesException

The exception that is thrown when an operation is only valid for stateless services.

FabricInvalidForStatelessServicesException

The exception that is thrown when an operation is only valid for stateful services.

FabricInvalidPartitionKeyException

The exception that indicates failure due to the use of a service partition key that is not valid.

FabricInvalidPartitionSelectorException

The exception that is thrown when a PartitionSelector is invalid.

FabricInvalidReplicaSelectorException

The exception that is thrown when a ReplicaSelector is invalid.

FabricInvalidTestCommandStateException

The exception that is thrown when an operation is not valid for a test command in a particular state.

FabricMessageTooLargeException

The exception that indicates the message is too large.

FabricMissingFullBackupException

The exception that is thrown when an attempt is made to create an incremental backup of the key-value store before an initial full backup is created.

FabricNotPrimaryException

The exception that is thrown when the callee is not a primary.

FabricNotReadableException

The exception that is thrown when a service partition or a replica cannot accept reads.

FabricObjectClosedException

The exception that is thrown when the Service Fabric object is currently in a closed state due to one of the following conditions: 1. The Service Fabric object is being deleted. 2. The Service Fabric object is not reachable due to a failover.

FabricOnlyValidForStatefulPersistentServicesException

The exception that is thrown when an operation is only valid for stateful persistent services.

FabricOrchestrationUpgradeProgress

Encapsulates the progress of a Service Fabric upgrade.

FabricPeriodicBackupNotEnabledException

The exception that is thrown trying to get backup scheduling policy for a partition for which backup is not enabled

FabricReplicationOperationTooLargeException

The exception that is thrown when the replication operation is larger than the configured limit.

FabricReplicator

Replicates state for high availability and reliability.

FabricRestoreSafeCheckFailedException

The exception that is thrown when Backup is too old to be used for restore

FabricRuntime

Allows user created hosts to obtain their CodePackageActivationContext, well as to register the necessary service factories [ IStatelessServiceFactory, IStatefulServiceFactory, or ServiceGroupFactory] or service types directly.

FabricServerAuthenticationFailedException

The exception that indicates a failed authentication of cluster or server identity.

FabricServiceNotFoundException

The exception that is thrown when there is no service found by the specified name.

FabricTestCommandOperationIdAlreadyExistsException

The exception that is thrown when a test command already exists, i.e. when there is a duplicate operation identifier.

FabricTransientException

The exception that indicates failure of an operation due to a transient environmental or runtime circumstance.

Handling FabricTransientException for Reliable Collections : The user is suggested to catch this exception, abort the transaction and retry all operations with a new Transaction

FabricUpgradeOrchestrationServiceState

Encapsulates the service state of Upgrade Orchestration Service.

FabricUpgradeProgress

Encapsulates the progress of a Service Fabric upgrade.

FabricValidationException

Exception thrown by validation APIs in testability

FabricWorkerEntryPoint

Reserved for future use.

GatewayInformation

Contains information identifying a Service Fabric node in the cluster.

GetPropertyOperation

Represents a PropertyBatchOperation that gets the specified property if it exists.

Int64RangePartitionInformation

Describes the partition information for the integer range that is based on partition schemes. Services observe this type of ServicePartitionInformation when the service is created with the UniformInt64RangePartitionSchemeDescription class. Int64RangePartitionInformation derives from IServicePartition and is provided to services as part of the IStatefulServicePartition or IStatelessServicePartition, which is passed in via the stateful OpenAsync(ReplicaOpenMode, IStatefulServicePartition, CancellationToken) or the stateless OpenAsync(IStatelessServicePartition, CancellationToken) methods.

KeyValueStoreEnumerator

Reads the local store contents of a secondary replica within the context of a copy completion callback.

.
KeyValueStoreItem

Represents an item in the key/value store.

KeyValueStoreItemMetadata

Represents the metadata that are associated with a KeyValueStoreItem object in the Key/Value store.

KeyValueStoreNotification

Contains all the information for a replicated operation received by a secondary replica.

KeyValueStoreReplica

Provides a transactional, replicated, associative data storage component to service writers - ready for integration into any Service Fabric service.

This is used by legacy Service Fabric services. All new services should use the Reliable Collections.
KeyValueStoreReplicaSettings

Represents the settings for a key/value store replica.

KeyValueStoreTransactionSettings

Specifies the optional settings to describe the behavior of transactions supported by KeyValueStoreReplica.

LoadMetric

Represents the name of a metric and a runtime value as a name-value pair that is reported to Service Fabric. The metric loads are used by Service Fabric to ensure that the cluster is evenly used and that nodes do not exceed their capacities for given metrics. LoadMetric reports are provided to Service Fabric via ReportLoad(IEnumerable<LoadMetric>).

LocalEseStoreSettings

Represents the optional settings for a local ESE store.

LocalStoreSettings

Represents the option settings for a local store.

NamedPartitionInformation

Describes the partition information for the name as a string that is based on partition schemes. Services observe this type of ServicePartitionInformation when the service is created with the NamedPartitionSchemeDescription. NamedPartitionInformation derives from the IServicePartition interface and is provided to services as part of the IStatefulServicePartition or IStatelessServicePartition interface, which is passed in during the stateful OpenAsync(ReplicaOpenMode, IStatefulServicePartition, CancellationToken) or the stateless OpenAsync(IStatelessServicePartition, CancellationToken).

NamedProperty

Represents a property that is managed by using the FabricClient.PropertyManagementClient.

NamedPropertyMetadata

The metadata associated with a NamedProperty, including the property’s name.

NameEnumerationResult

A collection of Service Fabric names, as returned by EnumerateSubNamesAsync(Uri, NameEnumerationResult, Boolean).

NodeConfiguration

This class contains APIs for managing the configuration of the node.

NodeContext

Specifies contextual information about a Service Fabric node such as node name, ID, node type etc.

NodeId

Class to encapsulate a node ID.

NodeTransitionProgress

Returns NodeTransitionProgress object.

NodeUpgradeProgress

Provides the outlines for the upgrade progress details of a node.

NoneSecurityCredentials

SecurityCredentials subtype for non-secure mode

OperationData

An OperationData is used to transfer copy state changes and copy context between replicas.

PackageAddedEventArgs<TPackage>

Describes a package added event.

PackageModifiedEventArgs<TPackage>

Represents the event arguments for package modification.

PackageRemovedEventArgs<TPackage>

Describes a package removed event.

PackageSharingPolicy

Represents a policy for the package sharing.

PackageSharingPolicyList

Represents a list of PackageSharingPolicy objects.

PartitionDataLossProgress

Returns Invoke data loss progress object.

PartitionQuorumLossProgress

Returns Invoke quorum loss progress object.

PartitionRestartProgress

Returns Invoke quorum loss progress object.

PartitionSafetyCheck

Represents the SafetyCheck for a partition.

PartitionSelector

This is a helper class for selecting partitions.

PartitionUpgradeSafetyCheck

Represents the UpgradeSafetyCheck for a partition.

PropertyBatchOperation

Represents the base class for property operations that can be put into a batch and be submitted through the SubmitPropertyBatchAsync(Uri, ICollection<PropertyBatchOperation>, TimeSpan, CancellationToken) method.

PropertyBatchResult

Specifies the batch that contains the results from the SubmitPropertyBatchAsync(Uri, ICollection<PropertyBatchOperation>, TimeSpan, CancellationToken) method call.

PropertyEnumerationResult

Represents an enumeration of properties that is returned from an operation by the property manager.

PutCustomPropertyOperation

Represents the specified property under the specified name and sets the custom type information for custom interpretation of the property value.

PutPropertyOperation

Puts the specified property under the specified name.

ReconfigurationInformation

Represents information about the replica reconfiguration.

ReplicaInformation

This supports the Service Fabric infrastructure and is not meant to be used directly from your code.

ReplicaSelector

This is a helper class for selecting replicas.

ReplicaSetConfiguration

This supports the Service Fabric infrastructure and is not meant to be used directly from your code.

ReplicatorSettings

Allows a stateful replica to configure the FabricReplicator when creating it via CreateReplicator(IStateProvider, ReplicatorSettings).

ResolvedServiceEndpoint

Represents a resolved service endpoint, which contains information about service partition replica role and the address it listens to.

ResolvedServicePartition

Contains information about the partition of the service that was resolved and the set of endpoints that can be used to access the partition.

RestoreSettings

Represents the settings for a key/value store RestoreAsync(String, RestoreSettings, CancellationToken) operation.

SafetyCheck

Represents a safety check that is currently being performed for a node.

SecurityCredentials

An abstract base class for types that represent security credentials.

SeedNodeSafetyCheck

The safety check that is currently being performed for seed nodes.

SeedNodeUpgradeSafetyCheck

The safety check that is currently being performed for seed node.during upgrade

SelectedPartition

Returns selected partition using PartitionSelector FaultManagementClient APIs.

SelectedReplica

Returns selected replica object using ReplicaSelector testability API.

ServiceContext

The service context that the service is operating under.

ServiceEndpointsVersion

Used to compare two ServiceNotification objects and determine which notification event precedes the other.

ServiceGroupFactory

Creates a service group factory that is used to create actual service groups from the provided type factories at runtime.

ServiceInitializationParameters

Represents the base class for service initialization parameters that are passed to the Initialize(StatefulServiceInitializationParameters) method of a service.

ServiceNotification

Represents a service notification containing details about a service whose replica or instance endpoints have changed. Notifications are dispatched by the ServiceNotificationFilterMatched event.

ServicePartitionInformation

Represents the base class for describing partitions.

ServicePartitionResolutionChange

This wrapper contains the updated ResolvedServicePartition.

SingletonPartitionInformation

Indicates that the service is Singleton-partitioned, effectively non-partitioned or with one partition only, and uses the partition scheme of a Singleton service.

StatefulServiceContext

Represents the service context that the stateful service is operating under.

StatefulServiceInitializationParameters

Defines service initialization parameters for a stateful service.

StatelessServiceContext

The service context that the stateless service is operating under.

StatelessServiceInitializationParameters

Defines service initialization parameters for a stateless service.

StoreBackupInfo

Provides information about the backup created by calling BackupAsync(String, StoreBackupOption, Func<StoreBackupInfo,Task<Boolean>>).

TestCommandProgress

Base class for the progress objects.

TokenServiceMetadata

For internal use only.

Transaction

Represents a transaction. KeyValueStoreReplica

TransactionBase

Provides an abstract base class for a transaction.

TransactionFaultedException

Exception that indicates a failure due to the transaction being faulted internally by the system.

UnknownSafetyCheck

The safety check that is not known to the current version of Service Fabric.

UnknownUpgradeSafetyCheck

The upgrade safety check kind is unknown. This is most likely because the client is running an older version.

UpgradeDomainProgress

Represents the upgrade progress details of nodes in the upgrade domain.

UpgradeDomainStatus

Represents the status of an upgrade domain.

UpgradeSafetyCheck

Represents the safety check that is currently being performed for a node during upgrade.

WindowsCredentials

Represents the active directory domain credential.

X509Credentials

Specifies the security credentials that are based upon X.509 certificates.

X509Name

A type to identify X509 certificate with subject common name or DNS name

Structs

Epoch

Represents the current version of the partition in Service Fabric.

Interfaces

IAtomicGroupStateProvider

Describes additional methods of the IAtomicGroupStateProvider interface that a user service must implement to take advantage of the atomic group functionality of a service group.

IAtomicGroupStateReplicator

Exposes replication-related functions for atomic groups.

IByteSerializable

Exposes the methods to serialize the object into a byte[] or deserialize the object from a byte[]

ICodePackageActivationContext

Represents activation context for the Service Fabric activated service.

ICodePackageActivationContext2

Represents activation context for the Service Fabric activated service.

ICodePackageActivationContext3

Represents activation context for the Service Fabric activated service.

IImageStoreProgressHandler

Defines the behavior that a progress handler must implement to process progress information from Image Store operations

IOperation

Describes the data that is obtained from the state replicator.

IOperationData

Interface for the data being transferred.

IOperationDataStream

An IOperationDataStream encapsulates a stream of OperationData objects that are exchanged between Primary replica and Secondary replica. Objects that implement IOperationDataStream are used during the copy process. Both the copy context GetCopyContext() method that is sent from the Secondary replica to the Primary replica and the copy state GetCopyState(Int64, IOperationDataStream) method implement the IOperationDataStream interface.

IOperationStream

Represents a stream of replication or copy operations that are sent from the Primary to the Secondary replica.

IOperationStream2

This supports the Service Fabric infrastructure and is not meant to be used directly from your code.

IPrimaryReplicator

This supports the Service Fabric infrastructure and is not meant to be used directly from your code.

IReplicator

This supports the Service Fabric infrastructure and is not meant to be used directly from your code.

IReplicatorCatchupSpecificQuorum

Allows an IReplicator to indicate that it supports catching up specific quorums with the use of the MustCatchup flag in ReplicaInformation.

IServiceGroupPartition

Service group members inside a service group can cast the provided IStatefulServicePartition or IStatelessServicePartition to a IServiceGroupPartition to access the methods that are specific to members within service groups.

IServicePartition

Provides information to the service about the partition to which it belongs and provides methods for the service to interact with the system during runtime.

IStatefulServiceFactory

Represents a stateful service factory that is responsible for creating replicas of a specific type of stateful service. Stateful service factories are registered with the FabricRuntime by service hosts via RegisterStatefulServiceFactory(String, IStatefulServiceFactory) or RegisterStatefulServiceFactoryAsync(String, IStatefulServiceFactory, TimeSpan, CancellationToken).

IStatefulServicePartition

Represents a partition that is associated with a stateful service replica.

IStatefulServiceReplica

Defines behavior that governs the lifecycle of a replica, such as startup, initialization, role changes, and shutdown.

IStatelessServiceFactory

Represents a stateless service factory that is responsible for creating instances of a specific type of stateless service.

IStatelessServiceInstance

Defines behavior that governs the lifecycle of a stateless service instance, such as startup, initialization, and shutdown.

Stateless service types must implement this interface. The Reliable Stateless service implements this interface and handles instance lifecycle internally.
IStatelessServicePartition

Represents a partition that is associated with a stateless service instance.

IStateProvider

Defines the behavior that a service must implement to interact with the FabricReplicator.

IStateReplicator

Exposes replication-related functions of the FabricReplicator class that are used by IStateProvider to replicate state to ensure high availability.

IStateReplicator2

Exposes replication-related functions of the FabricReplicator class that are used by IStateProvider to replicate state to ensure high availability.

Enums

ApplicationUpgradeState

Enumerates the state of the application upgrade.

CompletionMode

This is an enum used to indicate when the API should complete.

ComposeDeploymentUpgradeState

Enumerates the state of the compose deployment upgrade.

CredentialType

Defines the valid kinds of security credentials.

DataLossMode

This enum is passed to the DataLoss testability API to indicate what type of data loss to induce.

DeploymentStatus

Specifies the status of the package on the node.

EntryPointStatus

Specifies the status of the CodePackage EntryPoint deployed on a node.

FabricClientRole

Represents the fabric client security role.

FabricErrorCode

Defines error codes that can be associated with a FabricException.

FabricUpgradeState

Specifies the upgrade state when upgrading Service Fabric.

FaultType

Indicates the type of fault that a service reports: invalid, transient or permanent.

HostIsolationMode

Indicates isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest.

For host type other than ContainerHost, its value is None.
HostType

The type of host for main entry point of a code package as specified in service manifest.

KeyValueStoreReplica.FullCopyMode

Specifies the behavior to use when building new secondary replicas (full copy).

KeyValueStoreReplica.SecondaryNotificationMode

Specifies the behavior of OnCopyComplete(KeyValueStoreEnumerator) and OnReplicationOperation(IEnumerator<KeyValueStoreNotification>) for replicas in the secondary role.

LocalStoreKind

Specifies the local store provider type.

MoveCost

Describes the move cost of a replica.

NodeDeactivationIntent

Describes the reason why the node is being deactivated.

NodeDeactivationStatus

Specified the status for a node deactivation task.

NodeDeactivationTaskType

Specifies the different types of node deactivation tasks.

NodeTransitionType

Describes the type of node transition

NodeUpgradePhase

Describes the upgrade phase of the corresponding node.

OperationType

Specifies the type of operation that is received via the copy or replication stream.

PackageSharingPolicyScope

Represents the scope for the PackageSharingPolicy.

PartitionAccessStatus

Enumerates the access status of the partition.

ProgressUnitType

Describes the unit of measurement for each UpdateProgress(Int64, Int64, ProgressUnitType) callback.

PropertyBatchOperationKind

Specifies the kind of the BatchPropertyOperation.

PropertyTypeId

Enumerates the possible property types.

ProtectionLevel

Enumerates how communication is protected.

QuorumLossMode

Type of QuorumLoss that will be invoked.

ReconfigurationPhase

Represents replica reconfiguration phase.

ReconfigurationType

Represents replica reconfiguration type.

ReplicaOpenMode

This supports the Service Fabric infrastructure and is not meant to be used directly from your code.

ReplicaRole

Indicates the role of a stateful service replica.

ReplicaSetQuorumMode

This supports the Service Fabric infrastructure and is not meant to be used directly from your code.

ReplicaStatus

This supports the Service Fabric infrastructure and is not meant to be used directly from your code.

RestartPartitionMode

The enum passed into the RestartPartition API to specify what replicas need to be restarted

RollingUpgradeMode

Specifies the type of rolling upgrade when upgrading an application instance or cluster.

SafetyCheckKind

A Service Fabric enumeration that indicates the upgrade safety check performed.

ServiceEndpointRole

Enumerates the kinds of possible roles of a service endpoint.

ServicePartitionKind

Indicates the type of partitioning scheme that is used.

StoreBackupOption

The backup option for the key-value store.

TestCommandProgressState

This enum indicates the state of a test command.

TestCommandType

The test command type of the queried test command.

TransactionIsolationLevel

Enumerates the set of possible isolation levels for a Transaction.

UpgradeDomainState

Enumerates the states of an upgrade domain.

UpgradeFailureAction

Enumerates the actions for Service Fabric to take if the upgrade fails.

UpgradeFailureReason

Describes possible upgrade failure reasons.

UpgradeSafetyCheckKind

Enumerates the UpgradeSafetyCheck that is being performed for a node during upgrade.

Delegates

FabricClient.ClaimsRetrievalEventHandler

Delegate for handling a claims token retrieval callback by registering for the ClaimsRetrieval event

ServicePartitionResolutionChangeHandler

A delegate type for client-side callbacks that are made to user code when the endpoints of a service change or an exception is encountered during the process of updating endpoint information at runtime.