System.Fabric.Description Namespace

Contains classes that support access to attributes of Service Fabric resources.

Classes

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.

ApplicationParameter

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

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

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.

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.

DataPackageDescription

Describes a data package.

DeleteApplicationDescription

Describes an application to be deleted by using DeleteApplicationAsync(DeleteApplicationDescription, 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).

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.

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

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.

NodeHealthQueryDescription

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

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

PartitionHealthQueryDescription

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

PartitionSchemeDescription

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

ProvisionApplicationTypeDescription

Describes an application type to be provisioned by using ProvisionApplicationAsync(ProvisionApplicationTypeDescription, TimeSpan, CancellationToken).

ReplicaHealthQueryDescription

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

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.

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

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

ServiceTypeDescription

Describes the service type.

ServiceUpdateDescription

Modifies 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

Represents the StatefulServiceUpdateDescription that is used to modify the StatefulServiceDescription of a running service via UpdateServiceAsync(Uri, ServiceUpdateDescription). The properties specified will be applied to the running service.

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

Represents the StatelessServiceDescription of a running service 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).

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.

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.

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.