System.Fabric.Description Namespace

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.

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

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

Specifies the application capacity for one metric.

Represents the query input used by GetApplicationNetworkListAsync(ApplicationNetworkQueryDescription).

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 GetApplication query and then pass that list of overridden parameters to UpgradeApplicationAsync(ApplicationUpgradeDescription).

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.

Describes the application principals of the service.

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

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

Describes the upgrade policy and the application to be upgraded.

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

Class definition of an Authorized Connection Request that can setup an mTLS channel.

Class definition of the Authorized Connection response that can set up an mTLS channel.

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.

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.

Describes the cluster health chunk query input.

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

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

Describes a code package that includes its entry point.

Specifies a named collection of configuration override.

Specifies a named collection of configuration overrides.

Describes a configuration package.

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

Specifies a named collection of configuration properties.

Describes the configuration settings.

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

Provides information about the executable entry point.

Describes a data package.

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

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

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

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

Represents the query input used by GetDeployedNetworkCodePackageListAsync(DeployedNetworkCodePackageQueryDescription).

Represents the query input used by GetDeployedNetworkListAsync(DeployedNetworkQueryDescription).

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

Reserved for future use.

Reserved for future use.

Reserved for future use.

Reserved for future use.

Describes the endpoint resource.

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

Provides information about the executable entry point.

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).

Represents a class to encapsulate a Service Fabric upgrade description.

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

Provides information about how to get the image store content

Class for describing a instance lifecycle behavior.

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

Specifies the configuration of a local container network described by LocalNetworkDescription

Describes a local container network

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

Represents a description of a security identity.

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.

Specifies metric load information.

Describes the behavior to use when performing an application upgrade.

Describes the behavior to use when performing a cluster upgrade.

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

Describes the named partition scheme of the service.

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

Represents the query input used by GetNetworkApplicationListAsync(NetworkApplicationQueryDescription).

Describes the base class for network descriptions.

Represents the query input used by GetNetworkNodeListAsync(NetworkNodeQueryDescription).

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

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

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

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

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

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.

Represents a base class for all package descriptions.

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

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

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

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

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

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.

Specifies metric loads of a partition.

Specifies move cost of a partition.

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

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).

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

Describes partitioning changes for an existing service.

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

Class for describing a replica lifecycle behavior.

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

Specifies move cost of a partition's specific replica or instance.

Represents a class to encapsulate a rolling upgrade monitoring policy.

Description of the rolling upgrade policy.

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

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.

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.

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.

Represents a description of a security group.

Represents a description for a security user.

Creates a particular correlation between services.

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

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

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

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

Describes a service that belongs to a service group.

Represents the type description of the Fabric service group.

Represents the type of member description for the service group.

Modifies the ServiceGroupDescription of an existing service group.

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

Specifies a metric to load balance a service during runtime.

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

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

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.

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.

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

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

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

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.

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

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

Describes the service type.

Describes changes to the ServiceDescription of an existing service.

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

Describes information about which node should be poisoned, and is used with StartNodePoisonAsync().

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

Specifies a metric for a stateful service.

Describes the stateful service type.

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

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

Specifies a metric for a stateless service.

Describes the type of stateless service.

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

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

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

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

Represents the query input used by UpdatePartitionMoveCostAsync(UpdatePartitionMoveCostQueryDescription, TimeSpan, CancellationToken).

Describes the upgrade policy of the fabric or application upgrade.

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.

Represents a class to encapsulate a Service Fabric upgrade validation result.

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

Enumerates the options for the cleanup of application package policy.

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

Enumerates the possible types of entry points.

Reserved for future use.

Reserved for future use.

Enumerates the kinds of endpoint protocols.

Enumerates the kinds of endpoint types.

Enumerates the possible start folder types.

Enumerates the ways that a service can be partitioned.

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

Enumerates the available mechanisms for scaling.

Enumerates the available triggers for scaling.

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

Enumerates the kinds of service descriptions.

Represents a class to encapsulate a service host upgrade impact.

Describes the weight of a metric.

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.

Indicates the type of the specific ServicePlacementPolicyDescription.

Enumerates the possible kinds of upgrade.