System.Fabric.Description Namespace

Classes

AddRemoveIncrementalNamedPartitionScalingMechanism

Represents a scaling mechanism for adding or removing named partitions of a service. When this mechanism is used there will be new named partitions added or removed from this service. The expected schema of named partitions is "0","1",..."N-1" when N partitions are needed. Should be used with AverageServiceLoadScalingTrigger.

ApplicationDescription

Describes an application to be created by using CreateApplicationAsync(ApplicationDescription).

ApplicationHealthQueryDescription

Represents the query input for getting application health. Used by GetApplicationHealthAsync(ApplicationHealthQueryDescription).

ApplicationMetricDescription

Specifies the application capacity for one metric.

ApplicationNetworkQueryDescription

Represents the query input used by GetApplicationNetworkListAsync(ApplicationNetworkQueryDescription).

ApplicationParameter

Provides an application parameter override to be applied when creating or upgrading an application. Note, overridden application parameter values are not preserved across application upgrades. To retain the overridden parameter values across application upgrades, the user should first fetch the list of overridden application parameters through GetApplicationListAsync(Uri) query and then pass that list of overridden parameters to UpgradeApplicationAsync(ApplicationUpgradeDescription).

ApplicationParameterList

Represents the list of application parameters applied to the current version of the application. Retrieved using GetApplicationListAsync(Uri).

This class derives from a KeyedCollection whose string key is the name of the associated ApplicationParameter.

ApplicationPrincipalsDescription

Describes the application principals of the service.

ApplicationQueryDescription

Represents the query input used by GetApplicationPagedListAsync(ApplicationQueryDescription, TimeSpan, CancellationToken).

ApplicationUpdateDescription

Describes an update of application capacity that will be updated using UpdateApplicationAsync(ApplicationUpdateDescription)

ApplicationUpgradeDescription

Describes the upgrade policy and the application to be upgraded.

ApplicationUpgradeUpdateDescription

Used to modify the upgrade parameters describing the behavior of application upgrades. See UpdateApplicationUpgradeAsync(ApplicationUpgradeUpdateDescription).

AveragePartitionLoadScalingTrigger

Represents a scaling policy related to an average load of a metric/resource of a partition. When this policy is used the service fabric platform will trigger scaling if the average load of a partition does not fit inside the limits specified for a particular metric. Should be used with PartitionInstanceCountScaleMechanism.

AverageServiceLoadScalingTrigger

Represents a scaling policy related to an average load of a metric/resource of a service. When this policy is used the service fabric platform will trigger scaling if the average load of a service does not fit inside the limits specified for a particular metric. Should be used with AddRemoveIncrementalNamedPartitionScalingMechanism.

ClusterHealthChunkQueryDescription

Describes the cluster health chunk query input.

ClusterHealthQueryDescription

Provides query input for getting ClusterHealth. Used by GetClusterHealthAsync(ClusterHealthQueryDescription).

ClusterManifestQueryDescription

Describes the query parameters for use with GetClusterManifestAsync(ClusterManifestQueryDescription, TimeSpan, CancellationToken).

CodePackageDescription

Describes a code package that includes its entry point.

ConfigParameterOverride

Specifies a named collection of configuration override.

ConfigParameterOverrideList

Specifies a named collection of configuration overrides.

ConfigurationPackageDescription

Describes a configuration package.

ConfigurationProperty

Specifies a configuration setting and its value that can be used to configure a service or application.

The settings are specified in the settings.xml file in the service manifest. For more information see https://docs.microsoft.com/azure/service-fabric/service-fabric-application-model

ConfigurationSection

Specifies a named collection of configuration properties.

ConfigurationSettings

Describes the configuration settings.

ConfigurationUpgradeDescription

Represents a class to encapsulate parameters describing a Service Fabric cluster configuration upgrade.

ContainerHostEntryPointDescription

Provides information about the executable entry point.

DataPackageDescription

Describes a data package.

DeleteApplicationDescription

Describes an application to be deleted by using DeleteApplicationAsync(DeleteApplicationDescription, TimeSpan, CancellationToken).

DeleteNetworkDescription

Describes a container network to be deleted by using DeleteNetworkAsync(DeleteNetworkDescription, TimeSpan, CancellationToken).

DeleteServiceDescription

Describes an service to be deleted by using DeleteServiceAsync(DeleteServiceDescription, TimeSpan, CancellationToken).

DeployedApplicationHealthQueryDescription

Describes query input for getting DeployedApplicationHealth. Used by GetDeployedApplicationHealthAsync(DeployedApplicationHealthQueryDescription).

DeployedNetworkCodePackageQueryDescription

Represents the query input used by GetDeployedNetworkCodePackageListAsync(DeployedNetworkCodePackageQueryDescription).

DeployedNetworkQueryDescription

Represents the query input used by GetDeployedNetworkListAsync(DeployedNetworkQueryDescription).

DeployedServicePackageHealthQueryDescription

Describes the query input for getting DeployedServicePackageHealth. Used by GetDeployedServicePackageHealthAsync(DeployedServicePackageHealthQueryDescription).

DllHostEntryPointDescription

Reserved for future use.

DllHostHostedDllDescription

Reserved for future use.

DllHostHostedManagedDllDescription

Reserved for future use.

DllHostHostedUnmanagedDllDescription

Reserved for future use.

EndpointResourceDescription

Describes the endpoint resource.

EntryPointDescription

Describes an entry point that is associated with a code package.

ExeHostEntryPointDescription

Provides information about the executable entry point.

ExternalStoreProvisionApplicationTypeDescription

Describes a provision application type operation which uses an application package from an external store, as opposed to a package uploaded to the Service Fabric image store. The application type can be provisioned using ProvisionApplicationAsync(ProvisionApplicationTypeDescriptionBase, TimeSpan, CancellationToken).

FabricUpgradeDescription

Represents a class to encapsulate a Service Fabric upgrade description.

FabricUpgradeUpdateDescription

Used to modify the upgrade parameters describing the behavior cluster upgrades. See UpdateFabricUpgradeAsync(FabricUpgradeUpdateDescription).

ImageStoreListDescription

Provides information about how to get the image store content

InstanceLifecycleDescription

Class for describing a instance lifecycle behavior.

LoadedPartitionInformationQueryDescription

Represents a class for specifying a query to get top/least loaded partitions. GetLoadedPartitionInfoListAsync(LoadedPartitionInformationQueryDescription)

LocalNetworkConfigurationDescription

Specifies the configuration of a local container network described by LocalNetworkDescription

LocalNetworkDescription

Describes a local container network

ManagedApplicationIdentityDescription

Provides an application parameter override to be applied when creating or upgrading an application.

ManagedIdentityDescription

Represents a description of a security identity.

ManagedIdentityDescriptionList

Represents the list of application parameters applied to the current version of the application. Retrieved using GetApplicationListAsync(Uri).

This class derives from a KeyedCollection whose string key is the name of the associated ApplicationParameter.

MetricLoadDescription

Specifies metric load information.

MonitoredRollingApplicationUpgradePolicyDescription

Describes the behavior to use when performing an application upgrade.

MonitoredRollingFabricUpgradePolicyDescription

Describes the behavior to use when performing a cluster upgrade.

MonitoredRollingUpgradePolicyDescription

Specifies the behavior to use when performing a monitored application or cluster upgrade.

NamedPartitionSchemeDescription

Describes the named partition scheme of the service.

NamedRepartitionDescription

Describes partitioning changes for an existing service of partition scheme type Named.

NetworkApplicationQueryDescription

Represents the query input used by GetNetworkApplicationListAsync(NetworkApplicationQueryDescription).

NetworkDescription

Describes the base class for network descriptions.

NetworkNodeQueryDescription

Represents the query input used by GetNetworkNodeListAsync(NetworkNodeQueryDescription).

NetworkQueryDescription

Represents the query input used by GetNetworkListAsync(NetworkQueryDescription, TimeSpan, CancellationToken).

NodeHealthQueryDescription

Describes query input for getting NodeHealth. Used by GetNodeHealthAsync(NodeHealthQueryDescription).

NodeQueryDescription

Describes a set of filters used when running the query GetNodePagedListAsync(NodeQueryDescription, TimeSpan, CancellationToken).

NodeStartDescription

Describes information about how a node should be started using StartNodeTransitionAsync().

NodeStopDescription

Describes information about how a node should be stopped using StartNodeTransitionAsync().

NodeTransitionDescription

Describes information about how a node should be transitioned, and is used with StartNodeTransitionAsync().
This object should not be used directly, the derived classes should be used.

PackageDescription

Represents a base class for all package descriptions.

PagedApplicationTypeQueryDescription

Describes a set of filters used when running the query GetApplicationTypePagedListAsync().

PagedDeployedApplicationQueryDescription

Describes a set of filters used when running the query GetDeployedApplicationPagedListAsync(PagedDeployedApplicationQueryDescription).

PagedDeployedServicePackageQueryDescription

Describes a set of filters used when running the query GetDeployedServicePackagePagedListAsync(PagedDeployedServicePackageQueryDescription).

PagedQueryDescriptionBase

Represents the base class for all paged query descriptions. This class handles all functionality related to paging.

PartitionHealthQueryDescription

Describes query input for getting PartitionHealth. Used by GetPartitionHealthAsync(PartitionHealthQueryDescription).

PartitionInstanceCountScaleMechanism

Represents a scaling mechanism for adding or removing instances of stateless service partition. When this mechanism is used this will affect all partitions of a service and do independent scaling of each of them. Should be used with AveragePartitionLoadScalingTrigger.

PartitionMetricLoadDescription

Specifies metric loads of a partition.

PartitionSchemeDescription

Describes how the service is partitioned. This is the parent entity from which the actual partitioning scheme descriptions are derived.

ProvisionApplicationTypeDescription

Describes a provision application type operation which uses an application package copied to a relative path in the image store. The application type can be provisioned using ProvisionApplicationAsync(ProvisionApplicationTypeDescriptionBase, TimeSpan, CancellationToken).

ProvisionApplicationTypeDescriptionBase

Represents the base class for provision application type classes. The provision description can be used to provision application types using ProvisionApplicationAsync(ProvisionApplicationTypeDescriptionBase, TimeSpan, CancellationToken).

RepartitionDescription

Describes partitioning changes for an existing service.

ReplicaHealthQueryDescription

Describes the query input for getting ReplicaHealth. Used by GetReplicaHealthAsync(ReplicaHealthQueryDescription).

ReplicaLifecycleDescription

Class for describing a replica lifecycle behavior.

ReplicaMetricLoadDescription

Specifies metric loads of a partition's specific replica or instance.

RollingUpgradeMonitoringPolicy

Represents a class to encapsulate a rolling upgrade monitoring policy.

RollingUpgradePolicyDescription

Description of the rolling upgrade policy.

RunAsPolicyDescription

Describes the RunAsPolicy associated with a CodePackage specified in application manifest.

ScalingMechanismDescription

Base class for describing different scaling mechanisms. Scaling mechanisms are a method of describing what should be done when a scaling operation is triggered. See AddRemoveIncrementalNamedPartitionScalingMechanism and PartitionInstanceCountScaleMechanism as examples of scaling mechanisms.

ScalingPolicyDescription

Class for describing a scaling policy. Every scaling policy consists of a ScalingTriggerDescription which describes when scaling should occur and a ScalingMechanismDescription which describes how is scaling performed.

ScalingTriggerDescription

Base class for describing different scaling triggers. Scaling triggers are used to describe under which conditions a scaling operation should happen. See AveragePartitionLoadScalingTrigger and AverageServiceLoadScalingTrigger as examples of scaling triggers.

SecurityGroupDescription

Represents a description of a security group.

SecurityUserDescription

Represents a description for a security user.

ServiceCorrelationDescription

Creates a particular correlation between services.

ServiceDescription

A ServiceDescription contains all of the information necessary to create a service.

ServiceFromTemplateDescription

Describes a Service Fabric service to be created from Service Template that is pre-defined in the current Application Manifest.

ServiceGroupDescription

Provides a collection of information that is necessary to create and describe a service group.

ServiceGroupFromTemplateDescription

Describes a Service Group to be created from a Service Group Template that is pre-defined in the current Application Manifest.

ServiceGroupMemberDescription

Describes a service that belongs to a service group.

ServiceGroupTypeDescription

Represents the type description of the Fabric service group.

ServiceGroupTypeMemberDescription

Represents the type of member description for the service group.

ServiceGroupUpdateDescription

Modifies the ServiceGroupDescription of an existing service group.

ServiceHealthQueryDescription

Provides query input for getting ServiceHealth. Used by GetServiceHealthAsync(ServiceHealthQueryDescription).

ServiceLoadMetricDescription

Specifies a metric to load balance a service during runtime.

ServiceNotificationFilterDescription

Represents a class that is used to describe a filter for service notification delivery, registered via RegisterServiceNotificationFilterAsync(ServiceNotificationFilterDescription).

ServicePlacementAllowMultipleStatelessInstancesOnNodePolicyDescription

Specifies the placement policy which allows placement of multiple stateless instances of a service partition on a node.

ServicePlacementInvalidDomainPolicyDescription

Represents a policy which indicates that a particular fault or upgrade domain should not be used for placement of the instances or replicas of the service this policy is applied to.

ServicePlacementNonPartiallyPlaceServicePolicyDescription

Placement policy description that describes a service placement where all replicas must be able to be placed in order for any replicas to be created.

ServicePlacementPolicyDescription

Represents the base type for all PlacementPolicyDescription types in the cluster.

ServicePlacementPreferPrimaryDomainPolicyDescription

Represents a ServicePlacementPolicyDescription which indicates that the service’s Primary replicas should optimally be placed in a particular domain.

ServicePlacementRequiredDomainPolicyDescription

Placement policy description that requires a replica to be placed in a particular domain.

ServicePlacementRequireDomainDistributionPolicyDescription

Specifies the placement policy which indicates that two replicas from the same partition should never be placed in the same fault or upgrade domain. While this is not common it can expose the service to an increased risk of concurrent failures due to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider a case where replicas are deployed across different data center, with one replica per location. In the event that one of the datacenters goes offline, normally the replica that was placed in that datacenter will be packed into one of the remaining datacenters. If this is not desirable then this policy should be set.

ServiceQueryDescription

Represents the multiple filters that can be specified to refine the return. Used by GetServicePagedListAsync(ServiceQueryDescription, TimeSpan, CancellationToken).

ServiceTagsCollection

Class for describing a service tags. Every tags collection consists of tags required for placement, and tags required for service running.

ServiceTypeDescription

Describes the service type.

ServiceUpdateDescription

Describes changes to the ServiceDescription of an existing service.

SingletonPartitionSchemeDescription

Describes the partition scheme of a singleton-partitioned, or non-partitioned service.

StatefulServiceDescription

Represents the extend ServiceDescription to provide additional information necessary to create stateful services.

StatefulServiceLoadMetricDescription

Specifies a metric for a stateful service.

StatefulServiceTypeDescription

Describes the stateful service type.

StatefulServiceUpdateDescription

Describes changes to the StatefulServiceDescription of a running service performed via UpdateServiceAsync(Uri, ServiceUpdateDescription).

StatelessServiceDescription

Extends ServiceDescription to provide additional necessary information to create a stateless service.

StatelessServiceLoadMetricDescription

Specifies a metric for a stateless service.

StatelessServiceTypeDescription

Describes the type of stateless service.

StatelessServiceUpdateDescription

Describes changes to the StatelessServiceDescription of a running service performed via UpdateServiceAsync(Uri, ServiceUpdateDescription).

UniformInt64RangePartitionSchemeDescription

Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.

UnprovisionApplicationTypeDescription

Describes an application type to be unprovisioned by using UnprovisionApplicationAsync(UnprovisionApplicationTypeDescription, TimeSpan, CancellationToken).

UpdatePartitionLoadQueryDescription

Represents the query input used by UpdatePartitionLoadAsync(UpdatePartitionLoadQueryDescription, TimeSpan, CancellationToken).

UpgradePolicyDescription

Describes the upgrade policy of the service.

UpgradeUpdateDescriptionBase

Represents the abstract base class for ApplicationUpgradeUpdateDescription and FabricUpgradeUpdateDescription. This class can be used to modify the upgrade parameters describing the behavior of the application or cluster upgrades. Visit UpdateApplicationUpgradeAsync(ApplicationUpgradeUpdateDescription) and UpdateFabricUpgradeAsync(FabricUpgradeUpdateDescription) to see the usage.

Enums

ApplicationDefinitionKindFilter

Enumerates the filters used for matching the definition kind of applications that should be returned by query.

ApplicationPackageCleanupPolicy

Enumerates the options for the cleanup of application package policy.

ApplicationTypeDefinitionKindFilter

Enumerates the filters used for matching the definition kind of applications type that should be returned by query.

CodePackageEntryPointKind

Enumerates the possible types of entry points.

DllHostHostedDllKind

Reserved for future use.

DllHostIsolationPolicy

Reserved for future use.

EndpointProtocol

Enumerates the kinds of endpoint protocols.

EndpointType

Enumerates the kinds of endpoint types.

ExeHostWorkingFolder

Enumerates the possible start folder types.

PartitionScheme

Enumerates the ways that a service can be partitioned.

ProvisionApplicationTypeKind

Represents the provision application type kind, which gives information about how the application package is provisioned to image store.

ScalingMechanismKind

Enumerates the available mechanisms for scaling.

ScalingTriggerKind

Enumerates the available triggers for scaling.

ServiceCorrelationScheme

Indicates that this service is associated with another service, and describes the relationship with that service.

ServiceDescriptionKind

Enumerates the kinds of service descriptions.

ServiceLoadMetricWeight

Describes the weight of a metric.

ServicePackageActivationMode

Describes service package activation mode for a Service Fabric service. This is specified at the time of creating the Service (using CreateServiceAsync(ServiceDescription)) or ServiceGroup (using CreateServiceGroupAsync(ServiceGroupDescription)) via ServicePackageActivationMode.

If no value is specified while creating the Service or ServiceGroup, then it defaults to SharedProcess mode.

ServicePlacementPolicyType

Indicates the type of the specific ServicePlacementPolicyDescription.

UpgradeKind

Enumerates the possible kinds of upgrade.